| blob | 8ffeee179e6e80d607b4974d359d6894cf99134c |
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
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
81 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
93 ;; Other stuff we need.
111 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
116 ;; babel
125 ;; load languages based on value of `org-babel-load-languages'
127 ;;;###autoload
129 "Load the languages defined in `org-babel-load-languages'."
141 org-babel-load-languages))
144 "Languages which can be evaluated in Org-mode buffers.
145 This list can be used to load support for any of the languages
146 below, note that each language will depend on a different set of
147 system executables and/or Emacs modes. When a language is
149 with `org-babel-execute-src-block' bound by default to C-c
150 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
151 be set to remove code block evaluation from the C-c C-c
152 keybinding. By default only Emacs Lisp (which has no
153 requirements) is loaded."
158 :key-type
200 ;;;; Customization variables
202 "Remove ID property of clones of a subtree.
203 When non-nil, clones of a subtree don't inherit the ID property.
204 Otherwise they inherit the ID property with a new unique
205 identifier."
210 ;;; Version
213 ;;;###autoload
215 "Show the org-mode version in the echo area.
216 With prefix arg HERE, insert it at point."
223 version
224 git-version
229 version)))
231 ;;; Compatibility constants
233 ;;; The custom variables
236 "Outline-based notes management and organizer."
242 "Mode hook for Org-mode, run after the mode was turned on."
247 "Hook that is run after org.el has been loaded."
252 "Hook that is run after an Org log buffer is created."
262 "Load all extensions listed in `org-modules'."
267 org-modules)
271 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
280 (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)
281 "Modules that should always be loaded together with org.el.
282 If a description starts with <C>, the file is not part of Emacs
283 and loading it will require that you have downloaded and properly installed
284 the org-mode distribution.
286 You can also use this system to load external packages (i.e. neither Org
287 core modules, nor modules from the CONTRIB directory). Just add symbols
288 to the end of the list. If the package is called org-xyz.el, then you need
289 to add the symbol `xyz', and the package must have a call to
291 (provide 'org-xyz)"
294 :type
325 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
334 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
343 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
359 "Non-nil means make shift-cursor commands select text when possible.
361 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
362 start selecting a region, or enlarge regions started in this way.
363 In Org-mode, in special contexts, these same keys are used for
364 other purposes, important enough to compete with shift selection.
365 Org tries to balance these needs by supporting `shift-select-mode'
366 outside these special contexts, under control of this variable.
368 The default of this variable is nil, to avoid confusing behavior. Shifted
369 cursor keys will then execute Org commands in the following contexts:
370 - on a headline, changing TODO state (left/right) and priority (up/down)
371 - on a time stamp, changing the time
372 - in a plain list item, changing the bullet type
373 - in a property definition line, switching between allowed values
374 - in the BEGIN line of a clock table (changing the time block).
375 Outside these contexts, the commands will throw an error.
377 When this variable is t and the cursor is not in a special
378 context, Org-mode will support shift-selection for making and
379 enlarging regions. To make this more effective, the bullet
380 cycling will no longer happen anywhere in an item line, but only
381 if the cursor is exactly on the bullet.
383 If you set this variable to the symbol `always', then the keys
384 will not be special in headlines, property lines, and item lines,
385 to make shift selection work there as well. If this is what you
386 want, you can use the following alternative commands: `C-c C-t'
387 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
388 can be used to switch TODO sets, `C-c -' to cycle item bullet
389 types, and properties can be edited by hand or in column view.
391 However, when the cursor is on a timestamp, shift-cursor commands
392 will still edit the time stamp - this is just too good to give up.
394 XEmacs user should have this variable set to nil, because
395 `shift-select-mode' is in Emacs 23 or later only."
403 "Shall some commands act upon headlines in the active region?
405 When set to `t', some commands will be performed in all headlines
406 within the active region.
408 When set to `start-level', some commands will be performed in all
409 headlines within the active region, provided that these headlines
410 are of the same level than the first one.
412 When set to a string, those commands will be performed on the
413 matching headlines within the active region. Such string must be
414 a tags/property/todo match as it is used in the agenda tags view.
416 The list of commands is: `org-schedule', `org-deadline',
417 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
418 `org-archive-to-archive-sibling'. The archiving commands skip
419 already archived entries."
429 "Options concerning startup of Org-mode."
434 "Non-nil means entering Org-mode will switch to OVERVIEW.
435 This can also be configured on a per-file basis by adding one of
436 the following lines anywhere in the buffer:
438 #+STARTUP: fold (or `overview', this is equivalent)
439 #+STARTUP: nofold (or `showall', this is equivalent)
440 #+STARTUP: content
441 #+STARTUP: showeverything"
450 "Non-nil means entering Org-mode will set `truncate-lines'.
451 This is useful since some lines containing links can be very long and
452 uninteresting. Also tables look terrible when wrapped."
457 "Non-nil means turn on `org-indent-mode' on startup.
458 This can also be configured on a per-file basis by adding one of
459 the following lines anywhere in the buffer:
461 #+STARTUP: indent
462 #+STARTUP: noindent"
470 When this option is turned on, you can use TeX-like syntax for sub- and
472 considered as a single item - so grouping with {} is normally not
473 needed. For example, the following things will be parsed as single
474 sub- or superscripts.
476 10^24 or 10^tau several digits will be considered 1 item.
477 10^-12 or 10^-tau a leading sign with digits or a word
478 x^2-y^3 will be read as x^2 - y^3, because items are
479 terminated by almost any nonword/nondigit char.
480 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
482 Still, ambiguity is possible - so when in doubt use {} to enclose the
483 sub/superscript. If you set this variable to the symbol `{}',
484 the braces are *required* in order to trigger interpretations as
486 frequently in plain text.
488 Not all export backends support this, but HTML does.
504 "Non-nil means turn on `org-beamer-mode' on startup.
505 This can also be configured on a per-file basis by adding one of
506 the following lines anywhere in the buffer:
508 #+STARTUP: beamer"
514 "Non-nil means align all tables when visiting a file.
515 This is useful when the column width in tables is forced with <N> cookies
516 in table fields. Such tables will look correct only after the first re-align.
517 This can also be configured on a per-file basis by adding one of
518 the following lines anywhere in the buffer:
519 #+STARTUP: align
520 #+STARTUP: noalign"
525 "Non-nil means show inline images when loading a new Org file.
526 This can also be configured on a per-file basis by adding one of
527 the following lines anywhere in the buffer:
528 #+STARTUP: inlineimages
529 #+STARTUP: noinlineimages"
535 "Non-nil means insert the first line setting Org-mode in empty files.
536 When the function `org-mode' is called interactively in an empty file, this
537 normally means that the file name does not automatically trigger Org-mode.
538 To ensure that the file will always be in Org-mode in the future, a
539 line enforcing Org-mode will be inserted into the buffer, if this option
540 has been set."
545 "Non-nil means use alternative key bindings for some keys.
546 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
547 These keys are also used by other packages like shift-selection-mode'
548 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
549 If you want to use Org-mode together with one of these other modes,
550 or more generally if you would like to move some Org-mode commands to
551 other keys, set this variable and configure the keys with the variable
552 `org-disputed-keys'.
554 This option is only relevant at load-time of Org-mode, and must be set
555 *before* org.el is loaded. Changing it requires a restart of Emacs to
556 become effective."
561 "Non-nil means use extra key sequence definitions for certain commands.
562 This happens automatically if you run XEmacs or if `window-system'
563 is nil. This variable lets you do the same manually. You must
564 set it before loading org.
566 Example: on Carbon Emacs 22 running graphically, with an external
567 keyboard on a Powerbook, the default way of setting M-left might
568 not work for either Alt or ESC. Setting this variable will make
569 it work for ESC."
583 "Keys for which Org-mode and other modes compete.
584 This is an alist, cars are the default keys, second element specifies
585 the alternative to use when `org-replace-disputed-keys' is t.
587 Keys can be specified in any syntax supported by `define-key'.
588 The value of this option takes effect only at Org-mode's startup,
589 therefore you'll have to restart Emacs to apply it after changing."
594 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
595 Or return the original if not disputed.
596 Also apply the translations defined in `org-xemacs-key-equivalents'."
601 org-disputed-keys)))
605 key)
615 "Define a key, possibly translated, as returned by `org-key'."
619 "The ellipsis to use in the Org-mode outline.
620 When nil, just use the standard three dots. When a string, use that instead,
621 When a face, use the standard 3 dots, but with the specified face.
622 The change affects only Org-mode (which will then use its own display table).
623 Changing this requires executing `M-x org-mode' in a buffer to become
624 effective."
634 "Keywords in Org-mode."
639 "String to mark deadline entries.
640 A deadline is this string, followed by a time stamp. Should be a word,
641 terminated by a colon. You can insert a schedule keyword and
643 Changes become only effective after restarting Emacs."
648 "String to mark scheduled TODO entries.
649 A schedule is this string, followed by a time stamp. Should be a word,
650 terminated by a colon. You can insert a schedule keyword and
652 Changes become only effective after restarting Emacs."
657 "String used as the prefix for timestamps logging closing a TODO entry."
662 "String used as prefix for timestamps clocking work hours on an item."
667 "Entries starting with this keyword will never be exported.
668 An entry can be toggled between COMMENT and normal with
670 Changes become only effective after restarting Emacs."
675 "Entries starting with this keyword will be exported in fixed-width font.
676 Quoting applies only to the text in the entry following the headline, and does
677 not extend beyond the next headline, even if that is lower level.
678 An entry can be toggled between QUOTE and normal with
685 "Regular expression for specifying repeated events.
689 "Options concerning the general structure of Org-mode files."
694 "Options about how to make context of a location visible."
718 "Non-nil means show full hierarchy when revealing a location.
719 Org-mode often shows locations in an org-mode file which might have
720 been invisible before. When this is set, the hierarchy of headings
721 above the exposed location is shown.
722 Turning this off for example for sparse trees makes them very compact.
723 Instead of t, this can also be an alist specifying this option for different
724 contexts. Valid contexts are
725 agenda when exposing an entry from the agenda
726 org-goto when using the command `org-goto' on key C-c C-j
727 occur-tree when using the command `org-occur' on key C-c /
728 tags-tree when constructing a sparse tree based on tags matches
729 link-search when exposing search matches associated with a link
730 mark-goto when exposing the jump goal of a mark
731 bookmark-jump when exposing a bookmark location
732 isearch when exiting from an incremental search
733 default default for all contexts not set explicitly"
738 "Non-nil means show following heading when revealing a location.
739 Org-mode often shows locations in an org-mode file which might have
740 been invisible before. When this is set, the heading following the
741 match is shown.
742 Turning this off for example for sparse trees makes them very compact,
743 but makes it harder to edit the location of the match. In such a case,
745 Instead of t, this can also be an alist specifying this option for different
746 contexts. See `org-show-hierarchy-above' for valid contexts."
751 "Non-nil means show all sibling heading when revealing a location.
752 Org-mode often shows locations in an org-mode file which might have
753 been invisible before. When this is set, the sibling of the current entry
754 heading are all made visible. If `org-show-hierarchy-above' is t,
755 the same happens on each level of the hierarchy above the current entry.
757 By default this is on for the isearch context, off for all other contexts.
758 Turning this off for example for sparse trees makes them very compact,
759 but makes it harder to edit the location of the match. In such a case,
761 Instead of t, this can also be an alist specifying this option for different
762 contexts. See `org-show-hierarchy-above' for valid contexts."
767 "Non-nil means show the entry below a headline when revealing a location.
768 Org-mode often shows locations in an org-mode file which might have
769 been invisible before. When this is set, the text below the headline that is
770 exposed is also shown.
772 By default this is off for all contexts.
773 Instead of t, this can also be an alist specifying this option for different
774 contexts. See `org-show-hierarchy-above' for valid contexts."
779 "How should indirect tree buffers be displayed?
780 This applies to indirect buffers created with the commands
782 Valid values are:
783 current-window Display in the current window
784 other-window Just display in another window.
785 dedicated-frame Create one new frame, and re-use it each time.
786 new-frame Make a new frame each time. Note that in this case
787 previously-made indirect buffers are kept, and you need to
788 kill these buffers yourself."
798 "Non-nil means activate single letter commands at beginning of a headline.
799 This may also be a function to test for appropriate locations where speed
800 commands should be active."
808 "Alist of additional speed commands.
809 This list will be checked before `org-speed-commands-default'
810 when the variable `org-use-speed-commands' is non-nil
811 and when the cursor is at the beginning of a headline.
812 The car if each entry is a string with a single letter, which must
813 be assigned to `self-insert-command' in the global map.
814 The cdr is either a command to be called interactively, a function
815 to be called, or a form to be evaluated.
816 An entry that is just a list with a single string will be interpreted
817 as a descriptive headline that will be added when listing the speed
818 commands in the Help buffer using the `?' speed command."
830 "Options concerning visibility cycling in Org-mode."
835 "Non-nil means skip CHILDREN state in entries that don't have any."
840 "Maximum level which should still be subject to visibility cycling.
841 Levels higher than this will, for cycling, be treated as text, not a headline.
842 When `org-odd-levels-only' is set, a value of N in this variable actually
843 means 2N-1 stars as the limiting headline.
844 When nil, cycle all levels.
845 Note that the limiting level of cycling is also influenced by
846 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
847 `org-inlinetask-min-level' is, cycling will be limited to levels one less
848 than its value."
855 "Names of drawers. Drawers are not opened by cycling on the headline above.
856 Drawers only open with a TAB on the drawer line itself. A drawer looks like
857 this:
858 :DRAWERNAME:
859 .....
860 :END:
862 the property API.
864 Drawers can be defined on the per-file basis with a line like:
866 #+DRAWERS: HIDDEN STATE PROPERTIES"
872 "Non-nil means entering Org-mode will fold all blocks.
873 This can also be set in on a per-file basis with
875 #+STARTUP: hideblocks
876 #+STARTUP: showblocks"
882 "Cycle globally if cursor is at beginning of buffer and not at a headline.
883 This makes it possible to do global cycling without having to use S-TAB or
885 of the buffer
886 must not be a headline - it may be empty or some other text. When used in
887 this way, `org-cycle-hook' is disables temporarily, to make sure the
888 cursor stays at the beginning of the buffer.
889 When this option is nil, don't do anything special at the beginning
890 of the buffer."
895 "Non-nil means cycle entry level or item indentation in new empty entries.
897 When the cursor is at the end of an empty headline, i.e with only stars
898 and maybe a TODO keyword, TAB will then switch the entry to become a child,
899 and then all possible ancestor states, before returning to the original state.
900 This makes data entry extremely fast: M-RET to create a new headline,
901 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
903 When the cursor is at the end of an empty plain list item, one TAB will
904 make it a subitem, two or more tabs will back up to make this an item
905 higher up in the item hierarchy."
910 "Where should `org-cycle' emulate TAB.
911 nil Never
912 white Only in completely white lines
913 whitestart Only at the beginning of lines, before the first non-white char
914 t Everywhere except in headlines
915 exc-hl-bol Everywhere except at the start of a headline
916 If TAB is used in a place where it does not emulate TAB, the current subtree
917 visibility is cycled."
924 ))
927 "Number of empty lines needed to keep an empty line between collapsed trees.
928 If you leave an empty line between the end of a subtree and the following
929 headline, this empty line is hidden when the subtree is folded.
930 Org-mode will leave (exactly) one empty line visible if the number of
931 empty lines is equal or larger to the number given in this variable.
932 So the default 2 means at least 2 empty lines after the end of a subtree
933 are needed to produce free space between a collapsed subtree and the
934 following headline.
936 If the number is negative, and the number of empty lines is at least -N,
937 all empty lines are shown.
939 Special case: when 0, never leave empty lines in collapsed view."
945 "Hook that is run before visibility cycling is happening.
946 The function(s) in this hook must accept a single argument which indicates
947 the new state that will be set right after running this hook. The
948 argument is a symbol. Before a global state change, it can have the values
949 `overview', `content', or `all'. Before a local state change, it can have
950 the values `folded', `children', or `subtree'."
955 org-cycle-hide-drawers
956 org-cycle-show-empty-lines
957 org-optimize-window-after-visibility-change)
958 "Hook that is run after `org-cycle' has changed the buffer visibility.
959 The function(s) in this hook must accept a single argument which indicates
960 the new state that was set by the most recent `org-cycle' command. The
961 argument is a symbol. After a global state change, it can have the values
962 `overview', `content', or `all'. After a local state change, it can have
963 the values `folded', `children', or `subtree'."
968 "Options concerning structure editing in Org-mode."
973 "Non-nil means skip even levels and only use odd levels for the outline.
974 This has the effect that two stars are being added/taken away in
975 promotion/demotion commands. It also influences how levels are
976 handled by the exporters.
977 Changing it requires restart of `font-lock-mode' to become effective
978 for fontification also in regions already fontified.
979 You may also set this on a per-file basis by adding one of the following
980 lines to the buffer:
982 #+STARTUP: odd
983 #+STARTUP: oddeven"
989 "Non-nil means adapt indentation to outline node level.
991 When this variable is set, Org assumes that you write outlines by
992 indenting text in each node to align with the headline (after the stars).
993 The following issues are influenced by this variable:
995 - When this is set and the *entire* text in an entry is indented, the
996 indentation is increased by one space in a demotion command, and
997 decreased by one in a promotion command. If any line in the entry
998 body starts with text at column 0, indentation is not changed at all.
1000 - Property drawers and planning information is inserted indented when
1001 this variable s set. When nil, they will not be indented.
1003 - TAB indents a line relative to context. The lines below a headline
1004 will be indented when this variable is set.
1006 Note that this is all about true indentation, by adding and removing
1007 space characters. See also `org-indent.el' which does level-dependent
1008 indentation in a virtual way, i.e. at display time in Emacs."
1013 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1015 When t, `C-a' will bring back the cursor to the beginning of the
1016 headline text, i.e. after the stars and after a possible TODO
1017 keyword. In an item, this will be the position after bullet and
1018 check-box, if any. When the cursor is already at that position,
1019 another `C-a' will bring it to the beginning of the line.
1021 `C-e' will jump to the end of the headline, ignoring the presence
1022 of tags in the headline. A second `C-e' will then jump to the
1023 true end of the line, after any tags. This also means that, when
1024 this variable is non-nil, `C-e' also will never jump beyond the
1025 end of the heading of a folded section, i.e. not after the
1026 ellipses.
1028 When set to the symbol `reversed', the first `C-a' or `C-e' works
1029 normally, going to the true line boundary first. Only a directly
1030 following, identical keypress will bring the cursor to the
1031 special positions.
1033 This may also be a cons cell where the behavior for `C-a' and
1034 `C-e' is set separately."
1053 "Non-nil means `C-k' will behave specially in headlines.
1054 When nil, `C-k' will call the default `kill-line' command.
1055 When t, the following will happen while the cursor is in the headline:
1057 - When the cursor is at the beginning of a headline, kill the entire
1058 line and possible the folded subtree below the line.
1059 - When in the middle of the headline text, kill the headline up to the tags.
1060 - When after the headline text, kill the tags."
1065 "Non-nil means, do not delete a hidden subtree with C-k.
1066 When set to the symbol `error', simply throw an error when C-k is
1067 used to kill (part-of) a headline that has hidden text behind it.
1068 Any other non-nil value will result in a query to the user, if it is
1069 OK to kill that hidden subtree. When nil, kill without remorse."
1078 "Check if in invisible region before inserting or deleting a character.
1079 Valid values are:
1081 nil Do not check, so just do invisible edits.
1082 error Throw an error and do nothing.
1083 show Make point visible, and do the requested edit.
1084 show-and-error Make point visible, then throw an error and abort the edit.
1085 smart Make point visible, and do insertion/deletion if it is
1086 adjacent to visible text and the change feels predictable.
1087 Never delete a previously invisible character or add in the
1088 middle or right after an invisible region. Basically, this
1089 allows insertion and backward-delete right before ellipses.
1090 FIXME: maybe in this case we should not even show?"
1101 "Non-nil means when yanking subtrees, fold them.
1102 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1103 it starts with a heading and all other headings in it are either children
1104 or siblings, then fold all the subtrees. However, do this only if no
1105 text after the yank would be swallowed into a folded tree by this action."
1110 "Non-nil means when yanking subtrees, adjust the level.
1111 With this setting, `org-paste-subtree' is used to insert the subtree, see
1112 this function for details."
1117 "Non-nil means M-RET will split the line at the cursor position.
1118 When nil, it will go to the end of the line before making a
1119 new line.
1120 You may also set this option in a different way for different
1121 contexts. Valid contexts are:
1123 headline when creating a new headline
1124 item when creating a new item
1125 table in a table field
1126 default the value to be used for all contexts not explicitly
1127 customized"
1144 "Non-nil means insert new headings after the current subtree.
1145 When nil, the new heading is created directly after the current line.
1148 for the duration of the command."
1154 "Should `org-insert-heading' leave a blank line before new heading/item?
1155 The value is an alist, with `heading' and `plain-list-item' as CAR,
1156 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1157 which case Org will look at the surrounding headings/items and try to
1158 make an intelligent decision whether to insert a blank line or not.
1160 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1161 set, the setting here is ignored and no empty line is inserted, to avoid
1162 breaking the list structure."
1175 "Hook being run after inserting a new heading."
1181 This currently only means they are never auto-wrapped.
1182 When nil, such lines will be treated like ordinary lines.
1183 See also the QUOTE keyword."
1188 "Non-nil means typing characters in `org-goto' starts incremental search."
1193 "Options concerning sparse trees in Org-mode."
1198 "Non-nil means highlight all matches that define a sparse tree.
1199 The highlights will automatically disappear the next time the buffer is
1200 changed by an edit command."
1205 "Non-nil means any change to the buffer will remove temporary highlights.
1206 Such highlights are created by `org-occur' and `org-clock-display'.
1207 When nil, `C-c C-c needs to be used to get rid of the highlights.
1208 The highlights created by `org-preview-latex-fragment' always need
1209 `C-c C-c' to be removed."
1216 "Hook that is run after `org-occur' has constructed a sparse tree.
1217 This can be used to recenter the window to show as much of the structure
1218 as possible."
1223 "Options concerning imenu and speedbar in Org-mode."
1228 "The maximum level for Imenu access to Org-mode headlines.
1229 This also applied for speedbar access."
1234 "Options concerning tables in Org-mode."
1240 When nil, such lines will be treated like ordinary lines.
1242 When equal to the symbol `optimized', the table editor will be optimized to
1243 do the following:
1244 - Automatic overwrite mode in front of whitespace in table fields.
1245 This makes the structure of the table stay in tact as long as the edited
1246 field does not exceed the column width.
1247 - Minimize the number of realigns. Normally, the table is aligned each time
1248 TAB or RET are pressed to move to another field. With optimization this
1249 happens only if changes to a field might have changed the column width.
1250 Optimization requires replacing the functions `self-insert-command',
1251 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1252 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1253 very good at guessing when a re-align will be necessary, but you can always
1256 If you would like to use the optimized version in Org-mode, but the
1257 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1259 This variable can be used to turn on and off the table editor during a session,
1260 but in order to toggle optimization, a restart is required.
1262 See also the variable `org-table-auto-blank-field'."
1270 "Non-nil means cluster self-insert commands for undo when possible.
1271 If this is set, then, like in the Emacs command loop, 20 consecutive
1272 characters will be undone together.
1273 This is configurable, because there is some impact on typing performance."
1278 "Non-nil means TAB will automatically notice a table.el table.
1279 When it sees such a table, it moves point into it and - if necessary -
1280 calls `table-recognize-table'."
1285 "Options concerning links in Org-mode."
1290 "Buffer-local version of `org-link-abbrev-alist', which see.
1295 "Alist of link abbreviations.
1296 The car of each element is a string, to be replaced at the start of a link.
1298 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1300 [[linkkey:tag][description]]
1302 The 'linkkey' must be a word word, starting with a letter, followed
1303 by letters, numbers, '-' or '_'.
1305 If REPLACE is a string, the tag will simply be appended to create the link.
1308 be inserted at that point (see the function `url-hexify-string').
1310 REPLACE may also be a function that will be called with the tag as the
1311 only argument to create the link, which should be returned as a string.
1313 See the manual for examples."
1323 "Non-nil means Org will display descriptive links.
1324 E.g. [[http://orgmode.org][Org website]] will be displayed as
1326 description. When set to `nil', Org will display the full links
1327 literally.
1329 You can interactively set the value of this variable by calling
1330 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1335 "How the path name in file links should be stored.
1336 Valid values are:
1338 relative Relative to the current directory, i.e. the directory of the file
1339 into which the link is being inserted.
1340 absolute Absolute path, if possible with ~ for home directory.
1341 noabbrev Absolute path, no abbreviation of home directory.
1342 adaptive Use relative path for files in the current directory and sub-
1343 directories of it. For other files, use an absolute path."
1352 "Types of links that should be activated in Org-mode files.
1353 This is a list of symbols, each leading to the activation of a certain link
1354 type. In principle, it does not hurt to turn on most link types - there may
1355 be a small gain when turning off unused link types. The types are:
1357 bracket The recommended [[link][description]] or [[link]] links with hiding.
1358 angle Links in angular brackets that may contain whitespace like
1359 <bbdb:Carsten Dominik>.
1360 plain Plain links in normal text, no whitespace, like http://google.com.
1361 radio Text that is matched by a radio target, see manual for details.
1362 tag Tag settings in a headline (link to tag search).
1363 date Time stamps (link to calendar).
1364 footnote Footnote labels.
1366 Changing this variable requires a restart of Emacs to become effective."
1378 "Function to use to generate link descriptions from links.
1379 If nil the link location will be used. This function must take
1380 two parameters; the first is the link and the second the
1381 description `org-insert-link' has generated, and should return the
1382 description to use."
1387 "Options concerning storing links in Org-mode."
1392 "Format of the description part of a link to an email or usenet message.
1393 The following %-escapes will be replaced by corresponding information:
1401 %s subject
1402 %d date
1403 %m message-id.
1405 You may use normal field width specification between the % and the letter.
1406 This is for example useful to limit the length of the subject.
1420 It should match if the message is from the user him/herself."
1425 "Non-nil means storing a link to an Org file will use entry IDs.
1427 Note that before this variable is even considered, org-id must be loaded,
1428 so please customize `org-modules' and turn it on.
1430 The variable can have the following values:
1432 t Create an ID if needed to make a link to the current entry.
1434 create-if-interactive
1435 If `org-store-link' is called directly (interactively, as a user
1436 command), do create an ID to support the link. But when doing the
1437 job for remember, only use the ID if it already exists. The
1438 purpose of this setting is to avoid proliferation of unwanted
1439 IDs, just because you happen to be in an Org file when you
1440 call `org-remember' that automatically and preemptively
1441 creates a link. If you do want to get an ID link in a remember
1442 template to an entry not having an ID, create it first by
1443 explicitly creating a link to it, using `C-c C-l' first.
1445 create-if-interactive-and-no-custom-id
1446 Like create-if-interactive, but do not create an ID if there is
1447 a CUSTOM_ID property defined in the entry. This is the default.
1449 use-existing
1450 Use existing ID, do not create one.
1452 nil Never use an ID to make a link, instead link using a text search for
1453 the headline text."
1458 create-if-interactive)
1460 create-if-interactive-and-no-custom-id)
1465 "Non-nil means file links from `org-store-link' contain context.
1466 A search string will be added to the file name with :: as separator and
1467 used to find the context when the link is activated by the command
1468 `org-open-at-point'. When this option is t, the entire active region
1469 will be placed in the search string of the file link. If set to a
1470 positive integer, only the first n lines of context will be stored.
1473 negates this setting for the duration of the command."
1478 "Non-nil means keep link in list for entire session.
1480 The command `org-store-link' adds a link pointing to the current
1481 location to an internal list. These links accumulate during a session.
1482 The command `org-insert-link' can be used to insert links into any
1483 Org-mode file (offering completion for all stored links). When this
1485 will be removed from the list, to make completing the unused links
1486 more efficient."
1491 "Options concerning following links in Org-mode."
1496 "Function to translate links with different syntax to Org syntax.
1497 This can be used to translate links created for example by the Planner
1498 or emacs-wiki packages to Org syntax.
1499 The function must accept two parameters, a TYPE containing the link
1501 which is everything after the link protocol. It should return a cons
1502 with possibly modified values of type and path.
1503 Org contains a function for this, so if you set this variable to
1504 `org-translate-link-from-planner', you should be able follow many
1505 links created by planner."
1510 "Hook that is run after a link has been followed."
1515 "Non-nil means on links TAB will follow the link.
1516 Needs to be set before org.el is loaded.
1517 This really should not be used, it does not make sense, and the
1518 implementation is bad."
1523 "Non-nil means on links RET will follow the link."
1529 "Non-nil means mouse-1 on a link will follow the link.
1530 A longer mouse click will still set point. Does not work on XEmacs.
1531 Needs to be set before org.el is loaded."
1536 "Number of different positions to be recorded in the ring.
1537 Changing this requires a restart of Emacs to work correctly."
1542 "Non-nil means internal links in Org files must exactly match a headline.
1543 When nil, the link search tries to match a phrase with all words
1544 in the search text."
1551 query-to-create)))
1559 "Setup the frame configuration for following links.
1560 When following a link with Emacs, it may often be useful to display
1561 this link in another window or frame. This variable can be used to
1562 set this up for the different types of links.
1563 For VM, use any of
1564 `vm-visit-folder'
1565 `vm-visit-folder-other-window'
1566 `vm-visit-folder-other-frame'
1567 For Gnus, use any of
1568 `gnus'
1569 `gnus-other-frame'
1570 `org-gnus-no-new-news'
1571 For FILE, use any of
1572 `find-file'
1573 `find-file-other-window'
1574 `find-file-other-frame'
1575 For Wanderlust use any of
1576 `wl'
1577 `wl-other-frame'
1578 For the calendar, use the variable `calendar-setup'.
1579 For BBDB, it is currently only possible to display the matches in
1580 another window."
1604 "Non-nil means use indirect buffer to display infile links.
1605 Activating internal links (from one location in a file to another location
1606 in the same file) normally just jumps to the location. When the link is
1608 is displayed in
1609 another window. When this option is set, the other window actually displays
1610 an indirect buffer clone of the current buffer, to avoid any visibility
1611 changes to the current buffer."
1616 "Non-nil means `org-open-file' will open non-existing files.
1617 When nil, an error will be generated.
1618 This variable applies only to external applications because they
1619 might choke on non-existing files. If the link is to a file that
1620 will be opened in Emacs, the variable is ignored."
1625 "Non-nil means a link to a directory really means to index.org.
1626 When nil, following a directory link will run dired or open a finder/explorer
1627 window on that directory."
1632 "Function and arguments to call for following mailto links.
1633 This is a list with the first element being a Lisp function, and the
1634 remaining elements being arguments to the function. In string arguments,
1635 %a will be replaced by the address, and %s will be replaced by the subject
1636 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1645 "Non-nil means ask for confirmation before executing shell links.
1646 Shell links can be dangerous: just think about a link
1648 [[shell:rm -rf ~/*][Google Search]]
1651 but really it would remove your entire home directory.
1652 Therefore we advise against setting this variable to nil.
1653 Just change it to `y-or-n-p' if you want to confirm with a
1661 'safe-local-variable
1665 "A regexp to skip confirmation for shell links."
1671 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1672 Elisp links can be dangerous: just think about a link
1677 but really it would remove your entire home directory.
1678 Therefore we advise against setting this variable to nil.
1679 Just change it to `y-or-n-p' if you want to confirm with a
1687 'safe-local-variable
1691 "A regexp to skip confirmation for Elisp links."
1700 "Default file applications on a UNIX or GNU/Linux system.
1711 "Default file applications on a MacOS X system.
1713 for some files for which the OS does not have a good default.
1721 'mswindows-shell-execute
1726 'mswindows-shell-execute
1729 "Default file applications on a Windows NT system.
1734 '(
1739 )
1740 "External applications for opening `file:path' items in a document.
1741 Org-mode uses system defaults for different file types, but
1742 you can use this variable to set the application for a given file
1743 extension. The entries in this list are cons cells where the car identifies
1744 files and the cdr the corresponding command. Possible values for the
1745 file identifier are
1747 ways, depending on its contents:
1749 - Alphanumeric characters only:
1750 Match links with this file extension.
1752 to open PDFs with evince.
1754 - Regular expression: Match links where the
1755 filename matches the regexp. If you want to
1756 use groups here, use shy groups.
1760 to open *.html and *.xhtml with firefox.
1762 - Regular expression which contains (non-shy) groups:
1764 anything after that, matches the regexp.
1765 In a custom command string, %1, %2, etc. are replaced with
1766 the parts of the link that were matched by the groups.
1767 For backwards compatibility, if a command string is given
1768 that does not use any of the group matches, this case is
1769 handled identically to the second one (i.e. match against
1770 file name only).
1771 In a custom lisp form, you can access the group matches with
1772 (match-string n link).
1775 to open [[file:document.pdf::5]] with evince at page 5.
1777 `directory' Matches a directory
1778 `remote' Matches a remote file, accessible through tramp or efs.
1779 Remote files most likely should be visited through Emacs
1780 because external applications cannot handle such paths.
1781 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1782 so all files Emacs knows how to handle. Using this with
1783 command `emacs' will open most files in Emacs. Beware that this
1784 will also open html files inside Emacs, unless you add
1786 t Default for files not matched by any of the other options.
1787 `system' The system command to open files, like `open' on Windows
1788 and Mac OS X, and mailcap under GNU/Linux. This is the command
1789 that will be selected if you call `C-c C-o' with a double
1792 Possible values for the command are:
1793 `emacs' The file will be visited by the current Emacs process.
1794 `default' Use the default application for this file type, which is the
1795 association for t in the list, most likely in the system-specific
1796 part.
1797 This can be used to overrule an unwanted setting in the
1798 system-specific variable.
1800 This command is specified by the entry whose car is `system'.
1801 Most likely, the system-specific version of this variable
1802 does define this command, but you can overrule/replace it
1803 here.
1804 string A command to be executed by a shell; %s will be replaced
1805 by the path to the file.
1806 sexp A Lisp form which will be evaluated. The file path will
1807 be available in the Lisp variable `file'.
1808 For more examples, see the system specific constants
1809 `org-file-apps-defaults-macosx'
1810 `org-file-apps-defaults-windowsnt'
1811 `org-file-apps-defaults-gnu'."
1821 auto-mode))
1832 "Options concerning refiling entries in Org-mode."
1837 "Directory with org files.
1838 This is just a default location to look for Org files. There is no need
1839 at all to put your files into this directory. It is only used in the
1840 following situations:
1842 1. When a remember template specifies a target file that is not an
1843 absolute path. The path will then be interpreted relative to
1844 `org-directory'
1845 2. When a remember note is filed away in an interactive way (when exiting the
1846 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1847 with `org-directory' as the default path."
1853 "Default target for storing notes.
1854 Used as a fall back file for org-remember.el and org-capture.el, for
1855 templates that do not specify a target file."
1860 file))
1863 "The default interface to be used for `org-goto'.
1864 Allowed values are:
1865 outline The interface shows an outline of the relevant file
1866 and the correct heading is found by moving through
1867 the outline or by searching with incremental search.
1868 outline-path-completion Headlines in the current buffer are offered via
1869 completion. This is the interface also used by
1870 the refile command."
1877 "Maximum target level when running `org-goto' with refile interface."
1882 "Non-nil means store new notes at the beginning of a file or entry.
1883 When nil, new notes will be filed to the end of a file or entry.
1884 This can also be a list with cons cells of regular expressions that
1885 are matched against file names, and values."
1895 "Information to record when a task is refiled.
1897 Possible values are:
1899 nil Don't add anything
1900 time Add a time stamp to the task
1901 note Prompt for a note and add it with template `org-log-note-headings'
1903 This option can also be set with on a per-file-basis with
1905 #+STARTUP: nologrefile
1906 #+STARTUP: logrefile
1907 #+STARTUP: lognoterefile
1909 You can have local logging settings for a subtree by setting the LOGGING
1910 property to one or more of these keywords.
1912 When bulk-refiling from the agenda, the value `note' is forbidden and
1913 will temporarily be changed to `time'."
1924 This is a list of cons cells. Each cell contains:
1925 - a specification of the files to be considered, either a list of files,
1926 or a symbol whose function or variable value will be used to retrieve
1927 a file name or a list of file names. If you use `org-agenda-files' for
1928 that, all agenda files will be scanned for targets. Nil means consider
1929 headings in the current buffer.
1930 - A specification of how to find candidate refile targets. This may be
1931 any of:
1933 This tag has to be present in all target headlines, inheritance will
1934 not be considered.
1936 todo keyword.
1938 headlines that are refiling targets.
1939 - a cons cell (:level . N). Any headline of level N is considered a target.
1940 Note that, when `org-odd-levels-only' is set, level corresponds to
1941 order in hierarchy, not to the number of stars.
1942 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1943 Note that, when `org-odd-levels-only' is set, level corresponds to
1944 order in hierarchy, not to the number of stars.
1946 Each element of this list generates a set of possible targets.
1947 The union of these sets is presented (with completion) to
1948 the user by `org-refile'.
1950 You can set the variable `org-refile-target-verify-function' to a function
1951 to verify each headline found by the simple criteria above.
1953 When this variable is nil, all top-level headlines in the current buffer
1954 are used, equivalent to the value `((nil . (:level . 1))'."
1970 "Function to verify if the headline at point should be a refile target.
1971 The function will be called without arguments, with point at the
1972 beginning of the headline. It should return t and leave point
1973 where it is if the headline is a valid target for refiling.
1975 If the target should not be selected, the function must return nil.
1976 In addition to this, it may move point to a place from where the search
1977 should be continued. For example, the function may decide that the entire
1978 subtree of the current entry should be excluded and move point to the end
1979 of the subtree."
1984 "Non-nil means cache refile targets to speed up the process.
1985 The cache for a particular file will be updated automatically when
1986 the buffer has been killed, or when any of the marker used for flagging
1987 refile targets no longer points at a live buffer.
1988 If you have added new entries to a buffer that might themselves be targets,
1989 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1990 find that easier, `C-u C-u C-u C-c C-w'."
1996 "Non-nil means provide refile targets as paths.
1997 So a level 3 headline will be available as level1/level2/level3.
1999 When the value is `file', also include the file name (without directory)
2000 into the path. In this case, you can also stop the completion after
2001 the file name, to get entries inserted as top level in the file.
2003 When `full-file-path', include the full file path."
2012 "Non-nil means complete the outline path in hierarchical steps.
2013 When Org-mode uses the refile interface to select an outline path
2014 \(see variable `org-refile-use-outline-path'), the completion of
2015 the path can be done is a single go, or if can be done in steps down
2016 the headline hierarchy. Going in steps is probably the best if you
2017 do not use a special completion package like `ido' or `icicles'.
2018 However, when using these packages, going in one step can be very
2019 fast, while still showing the whole path to the entry."
2024 "Non-nil means allow to create new nodes as refile targets.
2026 of an existing node. When the value of this variable is `confirm',
2027 new node creation must be confirmed by the user (recommended)
2028 When nil, the completion must match an existing entry.
2030 Note that, if the new heading is not seen by the criteria
2031 listed in `org-refile-targets', multiple instances of the same
2032 heading would be created by trying again to file under the new
2033 heading."
2041 "Non-nil means also refile active region within a subtree.
2043 By default `org-refile' doesn't allow refiling regions if they
2044 don't contain a set of subtrees, but it might be convenient to
2045 do so sometimes: in that case, the first line of the region is
2046 converted to a headline before refiling."
2052 "Options concerning TODO items in Org-mode."
2057 "Options concerning Progress logging in Org-mode."
2064 "The available interpretation symbols for customizing `org-todo-keywords'.
2068 "List of TODO entry keyword sequences and their interpretation.
2071 Each sequence starts with a symbol, either `sequence' or `type',
2072 indicating if the keywords should be interpreted as a sequence of
2073 action steps, or as different types of TODO items. The first
2074 keywords are states requiring action - these states will select a headline
2075 for inclusion into the global TODO list Org-mode produces. If one of
2078 the last keyword is treated as the only DONE state of the sequence.
2081 additional state where no keyword is present. For details about this
2082 cycling, see the manual.
2084 TODO keywords and interpretation can also be set on a per-file basis with
2085 the special #+SEQ_TODO and #+TYP_TODO lines.
2087 Each keyword can optionally specify a character for fast state selection
2088 \(in combination with the variable `org-use-fast-todo-selection')
2089 and specifiers for state change logging, using the same syntax
2092 indicates to record a time stamp each time this state is selected.
2094 Each keyword may also specify if a timestamp or a note should be
2095 recorded when entering or leaving the state, by adding additional
2096 characters in the parenthesis after the keyword. This looks like this:
2098 record only the time of the state change. With X and Y being either
2100 Y when leaving the state if and only if the *target* state does not
2101 define X. You may omit any of the fast-selection key or X or /Y,
2102 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2104 For backward compatibility, this variable may also be just a list
2105 of keywords - in this case the interpretation (sequence or type) will be
2106 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2116 ;;Quick and dirty way to see
2117 ;;`org-todo-interpretations'. This takes the
2118 ;;place of item arguments
2119 :convert-widget
2126 org-todo-interpretation-widgets))
2127 widget))
2158 "Controls how TODO keywords are interpreted.
2159 This variable is in principle obsolete and is only used for
2160 backward compatibility, if the interpretation of todo keywords is
2161 not given already in `org-todo-keywords'. See that variable for
2162 more information."
2169 "Non-nil means use the fast todo selection scheme with C-c C-t.
2170 This variable describes if and under what circumstances the cycling
2171 mechanism for TODO keywords will be replaced by a single-key, direct
2172 selection scheme.
2174 When nil, fast selection is never used.
2176 When the symbol `prefix', it will be used when `org-todo' is called with
2177 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2178 in an agenda buffer.
2180 When t, fast selection is used by default. In this case, the prefix
2181 argument forces cycling instead.
2183 In all cases, the special interface is only used if access keys have actually
2184 been assigned by the user, i.e. if keywords in the configuration are followed
2185 by a letter in parenthesis, like TODO(t)."
2193 "Non-nil means update todo statistics after insert and toggle.
2194 ALL-HEADLINES means update todo statistics by including headlines
2195 with no TODO keyword as well, counting them as not done.
2196 A list of TODO keywords means the same, but skip keywords that are
2197 not in this list.
2199 When this is set, todo statistics is updated in the parent of the
2200 current entry each time a todo state is changed."
2210 "Non-nil means TODO statistics covers just direct children.
2211 When nil, all entries in the subtree are considered.
2212 This has only an effect if `org-provide-todo-statistics' is set.
2213 To set this to nil for only a single subtree, use a COOKIE_DATA
2219 "Hook which is run after the state of a TODO item was changed.
2220 The new state (a string with a TODO keyword, or nil) is available in the
2221 Lisp variable `org-state'."
2226 "Hook for functions that are allowed to block a state change.
2228 Each function gets as its single argument a property list, see
2229 `org-trigger-hook' for more information about this list.
2231 If any of the functions in this hook returns nil, the state change
2235 "Hook for functions that are triggered by a state change.
2237 Each function gets as its single argument a property list with at least
2238 the following elements:
2240 (:type type-of-change :position pos-at-entry-start
2241 :from old-state :to new-state)
2243 Depending on the type, more properties may be present.
2245 This mechanism is currently implemented for:
2247 TODO state changes
2248 ------------------
2249 :type todo-state-change
2250 :from previous state (keyword as a string), or nil, or a symbol
2251 'todo' or 'done', to indicate the general type of state.
2255 "Non-nil means undone TODO entries will block switching the parent to DONE.
2256 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2257 be blocked if any prior sibling is not yet done.
2258 Finally, if the parent is blocked because of ordered siblings of its own,
2259 the child will also be blocked."
2271 "Non-nil means unchecked boxes will block switching the parent to DONE.
2272 When this is nil, checkboxes have no influence on switching TODO states.
2273 When non-nil, you first need to check off all check boxes before the TODO
2274 entry can be switched to DONE.
2275 This variable needs to be set before org.el is loaded, and you need to
2276 restart Emacs after a change to make the change effective. The only way
2277 to change is while Emacs is running is through the customize interface."
2289 "Non-nil means inserting a TODO heading is treated as state change.
2291 logging will apply if appropriate. When nil, the new TODO item will
2292 be inserted directly, and no logging will take place."
2297 "Non-nil means switching TODO states with S-cursor counts as state change.
2298 This is the default behavior. However, setting this to nil allows a
2299 convenient way to select a TODO state and bypass any logging associated
2300 with that."
2305 "Tag changes that should be triggered by TODO state changes.
2306 This is a list. Each entry is
2308 (state-change (tag . flag) .......)
2310 State-change can be a string with a state, and empty string to indicate the
2311 state that has no TODO keyword, or it can be one of the symbols `todo'
2312 or `done', meaning any not-done or done state, respectively."
2326 "Information to record when a task moves to the DONE state.
2328 Possible values are:
2330 nil Don't add anything, just change the keyword
2331 time Add a time stamp to the task
2332 note Prompt for a note and add it with template `org-log-note-headings'
2334 This option can also be set with on a per-file-basis with
2336 #+STARTUP: nologdone
2337 #+STARTUP: logdone
2338 #+STARTUP: lognotedone
2340 You can have local logging settings for a subtree by setting the LOGGING
2341 property to one or more of these keywords."
2349 ;; Normalize old uses of org-log-done.
2356 "Information to record when the scheduling date of a tasks is modified.
2358 Possible values are:
2360 nil Don't add anything, just change the date
2361 time Add a time stamp to the task
2362 note Prompt for a note and add it with template `org-log-note-headings'
2364 This option can also be set with on a per-file-basis with
2366 #+STARTUP: nologreschedule
2367 #+STARTUP: logreschedule
2368 #+STARTUP: lognotereschedule"
2377 "Information to record when the deadline date of a tasks is modified.
2379 Possible values are:
2381 nil Don't add anything, just change the date
2382 time Add a time stamp to the task
2383 note Prompt for a note and add it with template `org-log-note-headings'
2385 This option can also be set with on a per-file-basis with
2387 #+STARTUP: nologredeadline
2388 #+STARTUP: logredeadline
2389 #+STARTUP: lognoteredeadline
2391 You can have local logging settings for a subtree by setting the LOGGING
2392 property to one or more of these keywords."
2401 "Non-nil means record a note when clocking out of an item.
2402 This can also be configured on a per-file basis by adding one of
2403 the following lines anywhere in the buffer:
2405 #+STARTUP: lognoteclock-out
2406 #+STARTUP: nolognoteclock-out"
2412 "Non-nil means the CLOSED time stamp will contain date and time.
2413 When nil, only the date will be recorded."
2427 "Headings for notes added to entries.
2428 The value is an alist, with the car being a symbol indicating the note
2429 context, and the cdr is the heading to be used. The heading may also be the
2430 empty string.
2431 %t in the heading will be replaced by a time stamp.
2432 %T will be an active time stamp instead the default inactive one
2433 %d will be replaced by a short-format time stamp.
2434 %D will be replaced by an active short-format time stamp.
2435 %s will be replaced by the new TODO state, in double quotes.
2436 %S will be replaced by the old TODO state, in double quotes.
2437 %u will be replaced by the user name.
2438 %U will be replaced by the full user name.
2440 In fact, it is not a good idea to change the `state' entry, because
2441 agenda log mode depends on the format of these entries."
2447 "Heading when changing todo state (todo sequence only)"
2461 "Non-nil means insert state change notes and time stamps into a drawer.
2462 When nil, state changes notes will be inserted after the headline and
2463 any scheduling and clock lines, but not inside a drawer.
2465 The value of this variable should be the name of the drawer to use.
2466 LOGBOOK is proposed as the default drawer for this purpose, you can
2467 also set this to a string to define the drawer of your choice.
2471 If this variable is set, `org-log-state-notes-insert-after-drawers'
2472 will be ignored.
2474 You can set the property LOG_INTO_DRAWER to overrule this setting for
2475 a subtree."
2487 "Return the value of `org-log-into-drawer', but let properties overrule.
2488 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2489 used instead of the default value."
2497 "Non-nil means insert state change notes after any drawers in entry.
2498 Only the drawers that *immediately* follow the headline and the
2499 deadline/scheduled line are skipped.
2500 When nil, insert notes right after the heading and perhaps the line
2501 with deadline/scheduling if present.
2503 This variable will have no effect if `org-log-into-drawer' is
2504 set."
2510 "Non-nil means the latest state note will be directly after heading.
2511 When nil, the state change notes will be ordered according to time."
2517 "The TODO state to which a repeater should return the repeating task.
2518 By default this is the first task in a TODO sequence, or the previous state
2519 in a TODO_TYP set. But you can specify another task here.
2520 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2527 "Non-nil means record moving through the DONE state when triggering repeat.
2528 An auto-repeating task is immediately switched back to TODO when
2531 record a closing note, there will be no record of the task moving
2532 through DONE. This variable forces taking a note anyway.
2534 nil Don't force a record
2535 time Record a time stamp
2536 note Record a note
2538 This option can also be set with on a per-file-basis with
2540 #+STARTUP: logrepeat
2541 #+STARTUP: lognoterepeat
2542 #+STARTUP: nologrepeat
2544 You can have local logging settings for a subtree by setting the LOGGING
2545 property to one or more of these keywords."
2555 "Priorities in Org-mode."
2560 "Non-nil means priority commands are active.
2561 When nil, these commands will be disabled, so that you never accidentally
2562 set a priority."
2567 "The highest priority of TODO items. A character like ?A, ?B etc.
2568 Must have a smaller ASCII number than `org-lowest-priority'."
2573 "The lowest priority of TODO items. A character like ?A, ?B etc.
2574 Must have a larger ASCII number than `org-highest-priority'."
2579 "The default priority of TODO items.
2580 This is the priority an item gets if no explicit priority is given.
2581 When starting to cycle on an empty priority the first step in the cycle
2582 depends on `org-priority-start-cycle-with-default'. The resulting first
2583 step priority must not exceed the range from `org-highest-priority' to
2584 `org-lowest-priority' which means that `org-default-priority' has to be
2585 in this range exclusive or inclusive the range boundaries. Else the
2586 first step refuses to set the default and the second will fall back
2587 to (depending on the command used) the highest or lowest priority."
2592 "Non-nil means start with default priority when starting to cycle.
2593 When this is nil, the first step in the cycle will be (depending on the
2594 command used) one higher or lower than the default priority.
2595 See also `org-default-priority'."
2600 "Function to extract the priority from a string.
2601 The string is normally the headline. If this is nil Org computes the
2602 priority from the priority cookie like [#A] in the headline. It returns
2603 an integer, increasing by 1000 for each priority level.
2604 The user can set a different function here, which should take a string
2605 as an argument and return the numeric priority."
2611 "Options concerning time stamps and deadlines in Org-mode."
2616 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2617 When nil, these labeled time stamps are forces into the second line of an
2618 entry, just after the headline. When scheduling from the global TODO list,
2619 the time stamp will always be forced into the second line."
2624 "Formats for `format-time-string' which are used for time stamps.
2628 "Number of minutes to round time stamps to.
2629 These are two values, the first applies when first creating a time stamp.
2630 The second applies when changing it with the commands `S-up' and `S-down'.
2631 When changing the time stamp, this means that it will change in steps
2632 of N minutes, as given by the second value.
2634 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2635 numbers should be factors of 60, so for example 5, 10, 15.
2637 When this is larger than 1, you can still force an exact time stamp by using
2638 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2639 and by using a prefix arg to `S-up/down' to specify the exact number
2640 of minutes to shift."
2650 ;; Normalize old customizations of this variable.
2654 org-time-stamp-rounding-minutes)))
2657 "Non-nil means overlay custom formats over all time stamps.
2658 The formats are defined through the variable `org-time-stamp-custom-formats'.
2659 To turn this on on a per-file basis, insert anywhere in the file:
2660 #+STARTUP: customtime"
2668 "Custom formats for time stamps. See `format-time-string' for the syntax.
2669 These are overlaid over the default ISO format if the variable
2670 `org-display-custom-times' is set. Time like %H:%M should be at the
2671 end of the second format. The custom formats are also honored by export
2672 commands, if custom time display is turned on at the time of export."
2677 "Get the right format for a time string."
2682 f)))
2685 "The format string used when creating CLOCKSUM lines.
2686 This is also used when org-mode generates a time duration."
2692 org-mode generates a time duration."
2697 "The format string used when creating CLOCKSUM lines, or when
2698 org-mode generates a time duration."
2703 "No. of days before expiration during which a deadline becomes active.
2704 This variable governs the display in sparse trees and in the agenda.
2705 When 0 or negative, it means use this number (the absolute value of it)
2706 even if a deadline has a different individual lead time specified.
2708 Custom commands can set this variable in the options section."
2714 "Non-nil means assume future for incomplete date input from user.
2715 This affects the following situations:
2716 1. The user gives a month but not a year.
2719 2. The user gives a day, but no month.
2722 it will be considered as *this* month.
2724 If you set this variable to the symbol `time', then also the following
2725 will work:
2727 3. If the user gives a time, but no day. If the time is before now,
2728 to will be interpreted as tomorrow.
2730 Currently none of this works for ISO week specifications.
2732 When this option is nil, the current day, month and year will always be
2733 used as defaults.
2735 See also `org-agenda-jump-prefer-future'."
2743 "Should the agenda jump command prefer the future for incomplete dates?
2744 The default is to do the same as configured in `org-read-date-prefer-future'.
2745 But you can also set a deviating value here.
2746 This may t or nil, or the symbol `org-read-date-prefer-future'."
2752 org-read-date-prefer-future)
2757 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2759 Depending on the system Emacs is running on, certain dates cannot
2760 be represented with the type used internally to represent time.
2761 Dates between 1970-1-1 and 2038-1-1 can always be represented
2762 correctly. Some systems allow for earlier dates, some for later,
2763 some for both. One way to find out it to insert any date into an
2764 Org buffer, putting the cursor on the year and hitting S-up and
2765 S-down to test the range.
2767 When this variable is set to t, the date/time prompt will not let
2768 you specify dates outside the 1970-2037 range, so it is certain that
2769 these dates will work in whatever version of Emacs you are
2770 running, and also that you can move a file from one Emacs implementation
2771 to another. WHenever Org is forcing the year for you, it will display
2772 a message and beep.
2774 When this variable is nil, Org will check if the date is
2775 representable in the specific Emacs implementation you are using.
2776 If not, it will force a year, usually the current year, and beep
2777 to remind you. Currently this setting is not recommended because
2778 the likelihood that you will open your Org files in an Emacs that
2779 has limited date range is not negligible.
2781 A workaround for this problem is to use diary sexp dates for time
2782 stamps outside of this range."
2788 "Non-nil means display current interpretation of date prompt live.
2789 This display will be in an overlay, in the minibuffer."
2794 "Non-nil means pop up a calendar when prompting for a date.
2795 In the calendar, the date can be selected with mouse-1. However, the
2796 minibuffer will also be active, and you can simply enter the date as well.
2797 When nil, only the minibuffer will be available."
2805 "Hook to be used to set up keys for the date/time interface.
2806 Add key definitions to `minibuffer-local-map', which will be a temporary
2807 copy."
2812 "The hour when your day really ends. Must be an integer.
2813 This has influence for the following applications:
2815 the time given here, the day recognized as TODAY is actually yesterday.
2816 - When a date is read from the user and it is still before the time given
2817 here, the current date and time will be assumed to be yesterday, 23:59.
2818 Also, timestamps inserted in remember templates follow this rule.
2820 IMPORTANT: This is a feature whose implementation is and likely will
2821 remain incomplete. Really, it is only here because past midnight seems to
2822 be the favorite working time of John Wiegley :-)"
2827 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2828 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2830 23:59 of the previous day."
2836 "Non-nil means S-down will increase the time in a time stamp.
2837 When nil, S-up will increase."
2842 "Non-nil means make the calendar window follow timestamp changes.
2843 When a timestamp is modified and the calendar window is visible, it will be
2844 moved to the new date."
2849 "Options concerning tags in Org-mode."
2854 "List of tags allowed in Org-mode files.
2855 When this list is nil, Org-mode will base TAG input on what is already in the
2856 buffer.
2857 The value of this variable is an alist, the car of each entry must be a
2858 keyword as a string, the cdr may be a character that is used to select
2859 that tag through the fast-tag-selection interface.
2860 See the manual for details."
2875 "List of tags that will always appear in all Org-mode files.
2876 This is in addition to any in buffer settings or customizations
2877 of `org-tag-alist'.
2878 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2879 The value of this variable is an alist, the car of each entry must be a
2880 keyword as a string, the cdr may be a character that is used to select
2881 that tag through the fast-tag-selection interface.
2882 See the manual for details.
2883 To disable these tags on a per-file basis, insert anywhere in the file:
2884 #+STARTUP: noptag"
2895 "If non-nil, always offer completion for all tags of all agenda files.
2896 Instead of customizing this variable directly, you might want to
2897 set it locally for capture buffers, because there no list of
2898 tags in that file can be created dynamically (there are none).
2900 (add-hook 'org-capture-mode-hook
2901 (lambda ()
2902 (set (make-local-variable
2903 'org-complete-tags-always-offer-all-agenda-tags)
2904 t)))"
2910 "List of tags that can be inherited by all entries in the file.
2911 The tags will be inherited if the variable `org-use-tag-inheritance'
2912 says they should be.
2916 "Non-nil means use fast tag selection scheme.
2917 This is a special interface to select and deselect tags with single keys.
2918 When nil, fast selection is never used.
2919 When the symbol `auto', fast selection is used if and only if selection
2920 characters for tags have been configured, either through the variable
2921 `org-tag-alist' or through a #+TAGS line in the buffer.
2922 When t, fast selection is always used and selection keys are assigned
2923 automatically if necessary."
2931 "Non-nil means fast tag selection exits after first change.
2932 When nil, you have to press RET to exit it.
2933 During fast tag selection, you can toggle this flag with `C-c'.
2934 This variable can also have the value `expert'. In this case, the window
2935 displaying the tags menu is not even shown, until you press C-c again."
2943 "Non-nil means fast tags selection interface will also offer TODO states.
2947 "The column to which tags should be indented in a headline.
2948 If this number is positive, it specifies the column. If it is negative,
2949 it means that the tags should be flushright to that column. For example,
2950 -80 works well for a normal 80 character screen.
2951 When 0, place tags directly after headline text, with only one space in
2952 between."
2957 "Non-nil keeps tags aligned when modifying headlines.
2958 Some operations (i.e. demoting) change the length of a headline and
2959 therefore shift the tags around. With this option turned on, after
2960 each such operation the tags are again aligned to `org-tags-column'."
2965 "Non-nil means tags in levels apply also for sublevels.
2966 When nil, only the tags directly given in a specific line apply there.
2967 This may also be a list of tags that should be inherited, or a regexp that
2968 matches tags that should be inherited. Additional control is possible
2969 with the variable `org-tags-exclude-from-inheritance' which gives an
2970 explicit list of tags to be excluded from inheritance., even if the value of
2971 `org-use-tag-inheritance' would select it for inheritance.
2973 If this option is t, a match early-on in a tree can lead to a large
2974 number of matches in the subtree when constructing the agenda or creating
2975 a sparse tree. If you only want to see the first match in a tree during
2976 a search, check out the variable `org-tags-match-list-sublevels'."
2985 "List of tags that should never be inherited.
2986 This is a way to exclude a few tags from inheritance. For way to do
2987 the opposite, to actively allow inheritance for selected tags,
2988 see the variable `org-use-tag-inheritance'."
2993 "Check if TAG is one that should be inherited."
3005 "Non-nil means list also sublevels of headlines matching a search.
3006 This variable applies to tags/property searches, and also to stuck
3007 projects because this search is based on a tags match as well.
3009 When set to the symbol `indented', sublevels are indented with
3010 leading dots.
3012 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3013 the sublevels of a headline matching a tag search often also match
3014 the same search. Listing all of them can create very long lists.
3015 Setting this variable to nil causes subtrees of a match to be skipped.
3017 This variable is semi-obsolete and probably should always be true. It
3018 is better to limit inheritance to certain tags using the variables
3019 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3027 "When set, tags are sorted using this function as a comparator."
3043 "Options concerning properties in Org-mode."
3048 "How property key/value pairs should be formatted by `indent-line'.
3049 When `indent-line' hits a property definition, it will format the line
3050 according to this format, mainly to make sure that the values are
3051 lined-up with respect to each other."
3056 "Alist of properties and functions to adjust inserted values.
3057 Elements of this alist must be of the form
3059 ([string] [function])
3061 where [string] must be a property name and [function] must be a
3062 lambda expression: this lambda expression must take one argument,
3063 the value to adjust, and return the new value as a string.
3067 and the clock summary:
3070 (let ((clocksum (org-clock-sum-current-item))
3071 (effort (org-duration-string-to-minutes
3073 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3080 "Non-nil means properties apply also for sublevels.
3082 This setting is chiefly used during property searches. Turning it on can
3083 cause significant overhead when doing a search, which is why it is not
3084 on by default.
3086 When nil, only the properties directly given in the current entry count.
3087 When t, every property is inherited. The value may also be a list of
3088 properties that should have inheritance, or a regular expression matching
3089 properties that should be inherited.
3091 However, note that some special properties use inheritance under special
3092 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3094 for valid values of a property.
3096 Note for programmers:
3097 When querying an entry with `org-entry-get', you can control if inheritance
3098 should be used. By default, `org-entry-get' looks only at the local
3099 properties. You can request inheritance by setting the inherit argument
3100 to t (to force inheritance) or to `selective' (to respect the setting
3101 in this variable)."
3110 "Check if PROPERTY is one that should be inherited."
3121 "The default column format, if no other format has been defined.
3122 This variable can be set on the per-file basis by inserting a line
3124 #+COLUMNS: %25ITEM ....."
3129 "The ellipses to be used when a field in column view is truncated.
3130 When this is the empty string, as many characters as possible are shown,
3131 but then there will be no visual indication that the field has been truncated.
3132 When this is a string of length N, the last N characters of a truncated
3133 field are replaced by this string. If the column is narrower than the
3134 ellipses string, only part of the ellipses string will be shown."
3139 "Function that modifies values for display in column view.
3140 For example, it can be used to cut out a certain part from a time stamp.
3141 The function must take 2 arguments:
3143 column-title The title of the column (*not* the property name)
3144 value The value that should be modified.
3146 The function should return the value that should be displayed,
3147 or nil if the normal value should be used."
3152 "The property that is being used to keep track of effort estimates.
3153 Effort estimates given in this property need to have the format H:MM."
3161 "List of property/value pairs that can be inherited by any entry.
3163 These are fixed values, for the preset properties. The user variable
3164 that can be used to add to this list is `org-global-properties'.
3166 The entries in this list are cons cells where the car is a property
3167 name and cdr is a string with the value. If the value represents
3172 "List of property/value pairs that can be inherited by any entry.
3174 This list will be combined with the constant `org-global-properties-fixed'.
3176 The entries in this list are cons cells where the car is a property
3177 name and cdr is a string with the value.
3179 You can set buffer-local values for the same purpose in the variable
3180 `org-file-properties' this by adding lines like
3182 #+PROPERTY: NAME VALUE"
3189 "List of property/value pairs that can be inherited by any entry.
3190 Valid for the current buffer.
3195 "Options concerning agenda views in Org-mode."
3200 "Variable used by org files to set a category for agenda display.
3201 Such files should use a file variable to set it, for example
3205 or contain a special line
3207 #+CATEGORY: ELisp
3209 If the file does not specify a category, then file's base name
3215 "The files to be used for agenda display.
3219 If an entry is a directory, all files in that directory that are matched by
3220 `org-agenda-file-regexp' will be part of the file list.
3222 If the value of the variable is not a list but a single file name, then
3223 the list of agenda files is actually stored and maintained in that file, one
3224 agenda file per line. In this file paths can be given relative to
3225 `org-directory'. Tilde expansion and environment variable substitution
3226 are also made."
3233 "Regular expression to match files for `org-agenda-files'.
3234 If any element in the list in that variable contains a directory instead
3235 of a normal file, all files in that directory that are matched by this
3236 regular expression will be included."
3241 "List of extra files to be searched by text search commands.
3242 These files will be search in addition to the agenda files by the
3243 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3244 Note that these files will only be searched for text search commands,
3245 not for the other agenda views like todo lists, tag searches or the weekly
3246 agenda. This variable is intended to list notes and possibly archive files
3247 that should also be searched by these two commands.
3248 In fact, if the first element in the list is the symbol `agenda-archives',
3249 than all archive files of all agenda files will be added to the search
3250 scope."
3261 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3262 A nil value means to remove them, after a query, from the list."
3267 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3268 The command `org-calendar-goto-agenda' will be bound to this key. The
3269 default is the character `c' because then `c' can be used to switch back and
3270 forth between agenda and calendar."
3275 "The key to be installed in `calendar-mode-map' for agenda-action.
3276 The command `org-agenda-action' will be bound to this key. The
3277 default is the character `k' because we use the same key in the agenda."
3282 "The key to be installed in `calendar-mode-map' for adding diary entries.
3283 This option is irrelevant until `org-agenda-diary-file' has been configured
3284 to point to an Org-mode file. When that is the case, the command
3285 `org-agenda-diary-entry' will be bound to the key given here, by default
3286 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3287 if you want to continue doing this, you need to change this to a different
3288 key."
3293 "File to which to add new entries with the `i' key in agenda and calendar.
3294 When this is the symbol `diary-file', the functionality in the Emacs
3295 calendar will be used to add entries to the `diary-file'. But when this
3296 points to a file, `org-agenda-diary-entry' will be used instead."
3312 org-calendar-insert-diary-entry-key
3316 "Options for embedding LaTeX code into Org-mode."
3324 "Options for creating images from LaTeX fragments.
3325 This is a property list with the following properties:
3327 `default' means use the foreground of the default face.
3329 `default' means use the background of the default face.
3330 :scale a scaling factor for the size of the images, to get more pixels
3331 :html-foreground, :html-background, :html-scale
3332 the same numbers for HTML export.
3333 :matchers a list indicating which matchers should be used to
3334 find LaTeX fragments. Valid members of this list are:
3345 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3346 When nil, just push out a message."
3353 Use this to specify additional executable file say a jar file.
3355 When using MathToWeb as the converter, specify the full-path to
3356 your mathtoweb.jar file."
3364 "Command to convert LaTeX fragments to MathML.
3365 Replace format-specifiers in the command as noted below and use
3366 `shell-command' to convert LaTeX to MathML.
3367 %j: Executable file in fully expanded form as specified by
3368 `org-latex-to-mathml-jar-file'.
3369 %I: Input LaTeX file in fully expanded form
3370 %o: Output MathML file
3371 This command is used by `org-create-math-formula'.
3373 When using MathToWeb as the converter, set this to
3382 "Program to convert LaTeX fragments with.
3384 dvipng Process the LaTeX fragments to dvi file, then convert
3385 dvi files to png files using dvipng.
3386 This will also include processing of non-math environments.
3387 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3388 to convert pdf files to png files"
3396 "Return t if `org-latex-to-mathml-convert-command' is usable."
3399 org-latex-to-mathml-convert-command)
3401 org-latex-to-mathml-convert-command))))
3406 t))))))
3413 \[PACKAGES]
3414 \[DEFAULT-PACKAGES]
3415 % The settings below are copied from fullpage.sty
3428 "The document header used for processing LaTeX fragments.
3429 It is imperative that this header make sure that no page number
3430 appears on the page. The package defined in the variables
3431 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3433 will be appended."
3440 "Set the packages alist and make sure it has 3 elements per entry."
3444 x))
3445 val)))
3449 "Get the packages alist and make sure it has 3 elements per entry."
3453 x))
3456 ;; The following variables are defined here because is it also used
3457 ;; when formatting latex fragments. Originally it was part of the
3458 ;; LaTeX exporter, which is why the name includes "export".
3475 )
3476 "Alist of default packages to be inserted in the header.
3477 Change this only if one of the packages here causes an incompatibility
3478 with another package you are using.
3479 The packages in this list are needed by one part or another of Org-mode
3480 to function properly.
3482 - inputenc, fontenc: for basic font and character selection
3483 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3484 for interpreting the entities in `org-entities'. You can skip some of these
3485 packages if you don't use any of the symbols in it.
3486 - graphicx: for including images
3487 - float, wrapfig: for figure placement
3488 - longtable: for long tables
3489 - hyperref: for cross references
3491 Therefore you should not modify this variable unless you know what you
3492 are doing. The one reason to change it anyway is that you might be loading
3493 some other package that conflicts with one of the default packages.
3495 If SNIPPET-FLAG is t, the package also needs to be included when
3496 compiling LaTeX snippets into images for inclusion into HTML."
3510 "Alist of packages to be inserted in every LaTeX header.
3511 These will be inserted after `org-export-latex-default-packages-alist'.
3513 SNIPPET-FLAG, when t, indicates that this package is also needed when
3514 turning LaTeX snippets into images for inclusion into HTML.
3515 Make sure that you only list packages here which:
3516 - you want in every file
3517 - do not conflict with the default packages in
3518 `org-export-latex-default-packages-alist'
3519 - do not conflict with the setup in `org-format-latex-header'."
3533 "Settings for Org-mode appearance."
3538 "Non-nil means fontify only the stars in each headline.
3539 When nil, the entire headline is fontified.
3540 Changing it requires restart of `font-lock-mode' to become effective
3541 also in regions already fontified."
3546 "Non-nil means hide the first N-1 stars in a headline.
3547 This works by using the face `org-hide' for these stars. This
3548 face is white for a light background, and black for a dark
3549 background. You may have to customize the face `org-hide' to
3550 make this work.
3551 Changing it requires restart of `font-lock-mode' to become effective
3552 also in regions already fontified.
3553 You may also set this on a per-file basis by adding one of the following
3554 lines to the buffer:
3556 #+STARTUP: hidestars
3557 #+STARTUP: showstars"
3562 "List of symbols corresponding to keywords to be hidden the org buffer.
3563 For example, a value '(title) for this list will make the document's title
3564 appear in the buffer without the initial #+TITLE: keyword."
3573 "Non-nil means change the face of a headline if it is marked DONE.
3574 Normally, only the TODO/DONE keyword indicates the state of a headline.
3575 When this is non-nil, the headline after the keyword is set to the
3576 `org-headline-done' as an additional indication."
3581 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3582 Changing this variable requires a restart of Emacs to take effect."
3587 "Non-nil means fontify the whole line for headings.
3588 This is useful when setting a background color for the
3589 org-level-* faces."
3594 "Non-nil means fontify what is treated specially by the exporters."
3599 "Non-nil mean font-lock should hide the emphasis marker characters."
3604 "Non-nil means show entities as UTF8 characters.
3611 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3617 "Regular expression for matching emphasis.
3618 After a match, the match groups contain these elements:
3619 0 The match of the full regular expression, including the characters
3620 before and after the proper match
3621 1 The character before the proper match, or empty at beginning of line
3622 2 The proper match, including the leading and trailing markers
3623 3 The leading marker like * or /, indicating the type of highlighting
3624 4 The text between the emphasis markers, not including the markers
3631 "Set variable and compute the emphasis regular expression."
3635 org-emphasis-alist org-emphasis-regexp-components)
3647 ;; make sure special characters appear at the right position in the class
3659 ;; Make the regexp
3667 body1
3679 body1
3687 "Components used to build the regular expression for emphasis.
3688 This is a list with five entries. Terminology: In an emphasis string
3692 specify what is allowed/forbidden in each part:
3694 pre Chars allowed as prematch. Beginning of line will be allowed too.
3695 post Chars allowed as postmatch. End of line will be allowed too.
3696 border The chars *forbidden* as border characters.
3698 non-shy groups here, and don't allow newline here.
3699 newline The maximum number of newlines allowed in an emphasis exp.
3701 Use customize to modify this, or restart Emacs after changing it."
3720 )
3721 "Special syntax for emphasized text.
3722 Text starting and ending with a special character will be emphasized, for
3723 example *bold*, _underlined_ and /italic/. This variable sets the marker
3724 characters, the face to be used by font-lock for highlighting in Org-mode
3725 Emacs buffers, and the HTML tags to be used for this.
3726 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3727 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3728 Use customize to modify this, or restart Emacs after changing it."
3743 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3746 ;;; Miscellaneous options
3749 "Completion in Org-mode."
3754 "Non-nil means use ido completion wherever possible.
3755 Note that `ido-mode' must be active for this variable to be relevant.
3756 If you decide to turn this variable on, you might well want to turn off
3757 `org-outline-path-complete-in-steps'.
3758 See also `org-completion-use-iswitchb'."
3763 "Non-nil means use iswitchb completion wherever possible.
3764 Note that `iswitchb-mode' must be active for this variable to be relevant.
3765 If you decide to turn this variable on, you might well want to turn off
3766 `org-outline-path-complete-in-steps'.
3767 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3773 Normal means, no org-mode-specific context."
3777 ;;; Functions and variables from their packages
3778 ;; Declared here to avoid compiler warnings
3780 ;; XEmacs only
3786 ;; Emacs only
3789 ;; Various packages
3808 org-agenda-format-item "org-agenda"
3839 ;;; Autoload and prepare some org modules
3841 ;; Some table stuff that needs to be defined here, because it is used
3842 ;; by the functions setting up org-mode or checking for table context.
3855 "Detect the first line outside a table when searching from within it.
3858 ;; Autoload the functions in org-table.el that are needed by functions here.
3863 org-table-convert org-table-convert-region org-table-copy-down
3864 org-table-copy-region org-table-create
3865 org-table-create-or-convert-from-region
3866 org-table-create-with-table.el org-table-current-dline
3867 org-table-cut-region org-table-delete-column org-table-edit-field
3868 org-table-edit-formulas org-table-end org-table-eval-formula
3869 org-table-export org-table-field-info
3870 org-table-get-stored-formulas org-table-goto-column
3871 org-table-hline-and-move org-table-import org-table-insert-column
3872 org-table-insert-hline org-table-insert-row org-table-iterate
3873 org-table-justify-field-maybe org-table-kill-row
3874 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3875 org-table-move-column org-table-move-column-left
3876 org-table-move-column-right org-table-move-row
3877 org-table-move-row-down org-table-move-row-up
3878 org-table-next-field org-table-next-row org-table-paste-rectangle
3879 org-table-previous-field org-table-recalculate
3880 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3881 org-table-toggle-coordinate-overlays
3882 org-table-toggle-formula-debugger org-table-wrap-region
3883 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3884 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3885 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3888 "Return t if the cursor is inside an org-type table.
3889 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3894 org-table-line-regexp)))
3895 nil))
3899 "Return t if and only if we are at a table.el table."
3905 "If there is a table.el table nearby, recognize it and move into it."
3911 nil
3921 t
3926 t)
3927 nil)
3928 nil))
3931 "Return t if the cursor is inside a hline in a table."
3936 nil))
3941 "Apply FUNCTION to the start of all tables in the buffer."
3951 ;; Exclude tables in src/example/verbatim/clocktable blocks
3959 ;; Declare and autoload functions from org-exp.el & Co
3967 org-insert-export-options-template
3968 org-table-clean-before-export))
3971 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3972 org-export-region-as-ascii))
3975 org-replace-region-by-latex org-export-region-as-latex
3976 org-export-as-latex org-export-as-pdf
3977 org-export-as-pdf-and-open))
3980 org-export-as-html-batch org-export-as-html-to-buffer
3981 org-replace-region-by-html org-export-region-as-html
3982 org-export-as-html))
3985 org-replace-region-by-docbook org-export-region-as-docbook
3986 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3987 org-export-as-docbook))
3990 org-export-icalendar-all-agenda-files
3991 org-export-icalendar-combine-agenda-files))
3995 ;; Declare and autoload functions from org-agenda.el
4000 org-todo-list org-tags-view org-agenda-list-stuck-projects
4001 org-diary org-agenda-to-appt
4002 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
4004 ;; Autoload org-remember
4009 org-remember-apply-template org-remember org-remember-handler)))
4014 org-capture-import-remember-templates)))
4016 ;; Autoload org-clock.el
4031 "Return non-nil if clock is currently running.
4032 The return value is actually the clock marker."
4037 "org-clock"
4039 org-clock-goto org-clock-sum org-clock-display
4040 org-clock-remove-overlays org-clock-report
4041 org-clocktable-shift org-dblock-write:clocktable
4042 org-get-clocktable org-resolve-clocks)))
4045 "If this is a CLOCK line, update it and return t.
4046 Otherwise, return nil."
4055 ts te h m s neg)
4058 nil)
4063 ;; The clock is running here
4084 t))))))
4087 "Check if the current buffer contains the running clock.
4088 If yes, offer to stop it and to save the buffer with the changes."
4097 "Check if this line starts a clock table, if yes, shift the time block."
4101 ;; Autoload org-timer.el
4105 "org-timer"
4107 org-timer-change-times-in-region
4108 org-timer-set-timer
4109 org-timer-reset-timers
4110 org-timer-show-remaining-time)))
4112 ;; Autoload org-feed.el
4116 "org-feed"
4120 ;; Autoload org-indent.el
4122 ;; Define the variable already here, to make sure we have it.
4124 "Non-nil if Org-Indent mode is enabled.
4129 "org-indent"
4132 ;; Autoload org-mobile.el
4136 "org-mobile"
4139 ;; Autoload archiving code
4140 ;; The stuff that is needed for cycling and tags has to be defined here.
4143 "Options concerning archiving in Org-mode."
4148 "The location where subtrees should be archived.
4150 The value of this variable is a string, consisting of two parts,
4151 separated by a double-colon. The first part is a filename and
4152 the second part is a headline.
4154 When the filename is omitted, archiving happens in the same file.
4155 %s in the filename will be replaced by the current file
4156 name (without the directory part). Archiving to a different file
4157 is useful to keep archived entries from contributing to the
4158 Org-mode Agenda.
4160 The archived entries will be filed as subtrees of the specified
4161 headline. When the headline is omitted, the subtrees are simply
4162 filed away at the end of the file, as top-level entries. Also in
4163 the heading you can use %s to represent the file name, this can be
4164 useful when using the same archive for a number of different files.
4166 Here are a few examples:
4168 If the current file is Projects.org, archive in file
4169 Projects.org_archive, as top-level trees. This is the default.
4172 Archive in the current file, under the top-level headline
4176 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4179 Archive in file ~/org/archive.org (absolute path), under headlines
4184 items to the datetree. Items are placed in either the CLOSED
4185 date of the item, or the current date if there is no CLOSED date.
4186 The heading will be a subentry to the current date. There doesn't
4187 need to be a heading, but there always needs to be a slash after
4188 datetree. For example, to store archived items directly in the
4192 Archive in file ./basement (relative path), as level 3 trees
4195 You may set this option on a per-file basis by adding to the buffer a
4196 line like
4198 #+ARCHIVE: basement::** Finished Tasks
4200 You may also define it locally for a subtree by setting an ARCHIVE property
4201 in the entry. If such a property is found in an entry, or anywhere up
4202 the hierarchy, it will be used."
4207 "The tag that marks a subtree as archived.
4208 An archived subtree does not open during visibility cycling, and does
4209 not contribute to the agenda listings.
4210 After changing this, font-lock must be restarted in the relevant buffers to
4211 get the proper fontification."
4217 "Non-nil means the agenda will skip any items located in archived trees.
4218 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4219 variable is no longer recommended, you should leave it at the value t.
4220 Instead, use the key `v' to cycle the archives-mode in the agenda."
4226 "Non-nil means ignore archived trees when creating column view."
4232 "Non-nil means `org-cycle' will open archived trees.
4233 An archived tree is a tree marked with the tag ARCHIVE.
4234 When nil, archived trees will stay folded. You can still open them with
4235 normal outline commands like `show-all', but not with the cycling commands."
4241 "Non-nil means sparse tree construction shows matches in archived trees.
4242 When nil, matches in these trees are highlighted, but the trees are kept in
4243 collapsed state."
4249 "Re-hide all archived subtrees after a visibility state change."
4260 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4263 "Cycle subtree even if it is archived."
4270 "Re-hide all archived subtrees after a visibility state change."
4285 flag)))
4292 org-archive-to-archive-sibling org-toggle-archive-tag
4293 org-archive-subtree-default
4294 org-archive-subtree-default-with-confirmation)))
4296 ;; Autoload Column View Code
4304 org-columns-compute org-agenda-columns org-columns-remove-overlays
4307 ;; Autoload ID code
4315 org-id-get-with-outline-path-completion
4316 org-id-get-with-outline-drilling org-id-store-link
4317 org-id-goto org-id-find org-id-store-link))
4319 ;; Autoload Plotting Code
4324 ;;; Variables for pre-computed regular expressions, all buffer local
4342 "Matches a headline and puts everything into groups:
4343 group 1: the stars
4344 group 2: The todo keyword, maybe
4345 group 3: Priority cookie
4346 group 4: True headline
4350 "Printf format to make regexp to match an exact headline.
4351 This regexp will match the headline of any node which has the
4352 exact headline text that is put into the format, but may have any
4356 "Matches a headline and puts TODO state into group 2 if present.
4405 "Regular expression to match a plain time or time range.
4406 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4407 groups carry important information:
4408 0 the full match
4409 1 the first time, range or not
4417 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4418 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4419 groups carry important information:
4420 0 the full match
4421 7 hours of duration
4430 "Regular expression to match a timestamp time or time range.
4431 After a match, the following groups carry important information:
4432 0 the full match
4433 1 date plus weekday, for back referencing to make sure both times are on the same day
4434 2 the first time, range or not
4489 "Variable associated with STARTUP options for org-mode.
4490 Each element is a list of three items: The startup options as written
4491 in the #+STARTUP line, the corresponding variable, and the value to
4492 set this variable to if the option is found. An optional forth element PUSH
4496 "Update PROPS with KEY and VAL."
4510 "Printf format for a regexp matching an headline with some keyword.
4511 This regexp will match the headline of any node which has the
4512 exact keyword that is put into the format. The keyword isn't in
4516 "Printf format for a regexp matching an headline, possibly with some keyword.
4517 This regexp can match any headline with the specified keyword, or
4518 without a keyword. The keyword isn't in any group by default,
4522 "Precompute regular expressions for current buffer."
4542 kwds kws0 kwsa key log value cat arch tags const links hw dws
4543 tail sep kws1 prio props ftags drawers beamer-p
4565 ;; general TODO-like setup
4577 links)))
4584 props))))
4589 ftags
4599 l var val)
4629 ;; search for property blocks
4638 props)))))))
4655 ;; Process the TODO keywords
4657 ;; Use the global values as if they had been given locally.
4669 kws)))
4672 kwsa nil
4675 ;; 1 2
4683 kw)
4685 kws0)
4702 ;; Process the constants
4710 ;; Process the tags.
4721 tgs))
4729 ;; Compute the regular expressions and other local variables.
4730 ;; Using `org-outline-regexp-bol' would complicate them much,
4731 ;; because of the fixed white space at the end of that string.
4739 org-drawer-regexp
4743 org-not-done-keywords
4745 org-todo-regexp
4749 org-not-done-regexp
4753 org-not-done-heading-regexp
4755 org-todo-line-regexp
4757 org-complex-heading-regexp
4764 org-complex-heading-regexp-format
4769 ;; Stats cookies can be stuck to body.
4776 org-todo-line-tags-regexp
4783 org-deadline-time-regexp
4785 org-deadline-line-regexp
4787 org-scheduled-regexp
4789 org-scheduled-time-regexp
4791 org-closed-time-regexp
4793 org-keyword-time-regexp
4799 org-keyword-time-not-clock-regexp
4805 org-maybe-keyword-time-regexp
4811 org-planning-or-clock-line-re
4817 org-all-time-keywords
4820 org-clock-string org-closed-string))
4821 )
4826 "Return the contents of FILE, as a string."
4840 "Extract the log state setting from a TODO keyword string.
4854 "Remove a pair of parenthesis at the end of each string in LIST."
4858 x))
4859 list))
4862 "Assign fast keys to a keyword-key alist.
4863 Respect keys that are already there."
4881 ;;; Some variables used in various places
4888 "Function to be called when `C-c C-c' is used.
4892 ;; FIXME: Occasionally check by commenting these, to make sure
4893 ;; no other functions uses these, forgetting to let-bind them.
4898 ;; Defined somewhere in this file, but used before definition.
4904 ;;;; Define the Org-mode
4907 (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"))
4910 ;; We use a before-change function to check if a table might need
4911 ;; an update.
4913 "Indicates that a table might need an update.
4914 This variable is set by `org-before-change-function'.
4917 "Every change indicates that a table might need an update."
4927 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4928 ;; some places -- e.g. see the macro org-with-limited-levels.
4929 ;;
4930 ;; In Org buffers, the value of `outline-regexp' is that of
4931 ;; `org-outline-regexp'. The only function still directly relying on
4932 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4933 ;; job when `orgstruct-mode' is active.
4937 "Regexp to match Org headlines.
4938 This is similar to `org-outline-regexp' but additionally makes
4942 "Matches an headline, putting stars and text into groups.
4948 ;;;###autoload
4950 "Outline-based notes management and organizer, alias
4953 Org-mode develops organizational tasks around a NOTES file which
4954 contains information about projects as plain text. Org-mode is
4955 implemented on top of outline-mode, which is ideal to keep the content
4956 of large files well structured. It supports ToDo items, deadlines and
4957 time stamps, which magically appear in the diary listing of the Emacs
4958 calendar. Tables are easily created with a built-in table editor.
4959 Plain text URL-like links connect to websites, emails (VM), Usenet
4960 messages (Gnus), BBDB entries, and any files related to the project.
4961 For printing and sharing of notes, an Org-mode file (or a part of it)
4962 can be exported as a structured ASCII or HTML file.
4964 The following commands are available:
4968 ;; Get rid of Outline menus, they are not needed
4969 ;; Need to do this here because define-derived-mode sets up
4970 ;; the keymap so late. Still, it is a waste to call this each time
4971 ;; we switch another buffer into org-mode.
4974 ;; Assume this is Greg's port, it uses easymenu
5000 org-display-table 4
5003 org-ellipsis)))
5008 ;; tag faces set outside customize.... force initialization.
5010 ;; Calc embedded
5016 ;; Activate before-change-function
5020 ;; Check for running clock before killing a buffer
5022 ;; Paragraphs and auto-filling
5026 ;; Beginning/end of defun
5029 ;; Next error for sparse trees
5031 ;; Make sure dependence stuff works reliably, even for users who set it
5032 ;; too late :-(
5044 ;; Comment characters
5048 ;; Align options lines
5050 'align-mode-rules-list
5055 ;; Imenu
5059 ;; Make isearch reveal context
5062 ;; Emacs 21 and XEmacs make use of the hook
5064 ;; Emacs 22 deals with this through a special variable
5068 ;; Turn on org-beamer-mode?
5071 ;; Setup the pcomplete hooks
5084 ;; If empty file that did not turn on org-mode automatically, make it to.
5109 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5119 "Return today date, considering `org-extend-today-until'."
5124 ;;;; Font-Lock stuff, including the activators
5155 "Regular expression used to analyze links.
5156 Here is what the match groups contain after a match:
5157 1: http:
5158 2: http
5159 3: path
5160 4: [desc]
5168 "Number of stacked braces for sub/superscript matching.
5169 This has to be set before loading org.el to be effective."
5174 "Create a regular expression which will match a balanced sexp.
5175 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5176 as single character strings.
5177 The regexp returned will match the entire expression including the
5178 delimiters. It will also define a single group which contains the
5179 match except for the outermost delimiters. The maximum depth of
5180 stacked delimiters is N. Escaping delimiters is not possible."
5209 "Update the link regular expressions.
5210 This should be called after the variable `org-link-types' has changed."
5214 org-link-re-with-space
5220 org-link-re-with-space2
5226 org-link-re-with-space3
5231 org-angle-link-re
5237 org-plain-link-re
5241 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5242 org-bracket-link-regexp
5244 org-bracket-link-analytic-regexp
5252 org-bracket-link-analytic-regexp++
5260 org-any-link-re
5269 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5272 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5273 "Regular expression matching time strings for analysis.
5274 This one does not require the space after the date, so it can be used
5276 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5292 "Regular expression matching a time stamp or time stamp range.
5298 "Run through the buffer and add overlays to emphasized strings."
5307 'face
5320 rtn))
5323 "Insert or change an emphasis, i.e. a font like bold or italic.
5324 If there is an active region, change that region to a new emphasis.
5325 If there is no region, just insert the marker characters and position
5326 the cursor between them.
5327 CHAR should be either the marker character, or the first character of the
5328 HTML tag associated with that emphasis. If CHAR is a space, the means
5329 to remove the emphasis of the selected region.
5330 If char is not given (for example in an interactive call) it
5331 will be prompted for."
5382 "Run through the buffer and add overlays to links."
5391 nil
5397 t)))))
5405 t)))
5408 "When non-nil, fontify code in code blocks."
5415 "When non-nil, prevent auto-filling in src blocks."
5427 "Fontify #+ lines and blocks, in the correct ways."
5430 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5431 limit t)
5439 end end1 quoting block-type ovl)
5442 ;; a single line of backend-specific content
5450 ; for backend-specific code
5451 t)
5453 ;; Truly a block
5466 beg end
5474 ;; remove old background overlays
5479 ;; add a background overlay
5494 t))
5507 ;; just any other in-buffer setting, but not indented
5511 t)
5519 t)
5527 "Strip protective commas between BEG and END in the current buffer."
5543 "Run through the buffer and add overlays to links."
5551 t)))
5554 "Run through the buffer and add overlays to footnotes."
5561 'keymap org-mouse-map
5562 'help-echo
5564 "Footnote definition"
5566 'font-lock-fontified t
5567 'font-lock-multiline t
5571 "Run through the buffer and add overlays to bracketed links."
5575 ;; FIXME: above we should remove the escapes.
5576 ;; but that requires another match, protecting match data,
5577 ;; a lot of overhead for font-lock.
5584 ;; We need to remove the invisible property here. Table narrowing
5585 ;; may have made some of this invisible.
5603 t)))
5606 "Run through the buffer and add overlays to dates."
5618 t)))
5627 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5631 "Run through the buffer and add overlays to target matches."
5639 'keymap org-mouse-map
5643 t)))))
5646 "Find all radio targets in this file and update the regular expression."
5661 t)))
5668 ;; This should be with the exporter code, but we also use if for font-locking
5678 "Compute regular expression for stuff treated specially by exporters."
5685 org-latex-regexps)))
5713 org-entities)))
5717 org-latex-entities)
5718 nil))
5720 ))
5721 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5724 org-export-html-special-string-regexps)))
5729 ))))
5731 'org-latex-and-specials-regexp
5736 "Run through the buffer and add overlays to links."
5740 limit t))
5754 rtn)))
5757 "Restart `font-lock-mode', to force refontification."
5763 "Return a list of all targets in this file.
5764 With optional argument RADIO, only find radio targets."
5766 rtn)
5771 rtn)))
5774 "Make regular expression matching all strings in TARGETS.
5775 The regular expression finds the targets also if there is a line break
5776 between words."
5785 x)
5786 targets
5798 t)))
5801 "Compute the outline level of the heading at point.
5802 This function assumes that the cursor is at the beginning of a line matched
5803 by `outline-regexp'. Otherwise it returns garbage.
5804 If this is called at a normal headline, the level is the number of stars.
5805 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5812 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5819 "Functions that can manipulate `org-font-lock-extra-keywords'.
5820 This is called after `org-font-lock-extra-keywords' is defined, but before
5821 it is installed to be used by font lock. This can be useful if something
5832 ;; Call the hook
5834 ;; Headlines
5841 ;; Table lines
5844 ;; Table internals
5849 ;; Drawers
5852 ;; Properties
5856 ;; Links
5866 ;; TODO keyword
5868 org-todo-regexp)
5870 ;; DONE
5878 nil)
5879 ;; Priorities
5881 ;; Tags
5883 ;; Special keywords
5888 ;; Emphasis
5893 ;; Checkboxes
5894 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5899 ;; Description list items
5902 ;; ARCHIVEd headings
5904 org-outline-regexp-bol
5907 ;; Specials
5911 ;; Code
5913 ;; COMMENT
5920 ;; Blocks and meta lines
5922 )))
5925 ;; Now set the full font-lock-keywords
5932 "Toggle the composition display of entities as UTF8 characters."
5944 "Find an entity to fontify."
5950 limit t)
5965 nil))))
5968 "Fontify string S like in Org-mode."
5980 "Get the right face for match N in font-lock matching of headlines."
5993 "Get the right face for a TODO keyword KWD.
5994 If KWD is a number, get the corresponding match group."
6002 "Create a face list that inherits INHERIT, but sets the foreground color.
6003 When FACE-OR-COLOR is not a string, just return it."
6007 face-or-color)
6008 face-or-color))
6011 "Add the special tag faces."
6020 "Add the special priority faces."
6027 org-priority-faces)))
6032 "Get the right face for a TODO keyword KWD.
6033 If KWD is a number, get the corresponding match group."
6040 "Remove fontification and activation overlays from links."
6045 deactivate-mark buffer-file-name buffer-file-truename)
6049 invisible t intangible t
6050 org-no-flyspell t org-emphasis t))
6060 "Remove specific display properties that have been added by font lock.
6061 The will remove the raise properties that are used to show superscripts
6062 and subscripts."
6072 "Add raise properties to sub/superscripts."
6076 org-match-substring-regexp
6077 org-match-substring-with-braces-regexp)
6078 limit t)
6088 ;; FIXME: Should we go back one character here, for a_b^c
6089 ;; (goto-char (1- pos)) ;????????????????????
6091 t
6093 'display
6109 t)))))
6111 ;;;; Visibility cycling, including org-goto and indirect buffer
6113 ;;; Cycling
6120 ;;;###autoload
6125 "TAB-action and visibility cycling for Org-mode.
6127 This is the command invoked in Org-mode by the TAB key. Its main purpose
6128 is outline visibility cycling, but it also invokes other actions
6129 in special contexts.
6131 - When this function is called with a prefix argument, rotate the entire
6132 buffer through 3 states (global cycling)
6133 1. OVERVIEW: Show only top-level headlines.
6134 2. CONTENTS: Show all headlines of all levels, but no body text.
6135 3. SHOW ALL: Show everything.
6136 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6137 determined by the variable `org-startup-folded', and by any VISIBILITY
6138 properties in the buffer.
6139 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6140 including any drawers.
6142 - When inside a table, re-align the table and move to the next field.
6144 - When point is at the beginning of a headline, rotate the subtree started
6145 by this line through 3 different states (local cycling)
6146 1. FOLDED: Only the main headline is shown.
6147 2. CHILDREN: The main headline and the direct children are shown.
6148 From this state, you can move to one of the children
6149 and zoom in further.
6150 3. SUBTREE: Show the entire subtree, including body text.
6151 If there is no subtree, switch directly from CHILDREN to FOLDED.
6153 - When point is at the beginning of an empty headline and the variable
6154 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6155 of the headline by demoting and promoting it to likely levels. This
6156 speeds up creation document structure by pressing TAB once or several
6157 times right after creating a new headline.
6159 - When there is a numeric prefix, go up to a heading with level ARG, do
6160 a `show-subtree' and return to the previous cursor position. If ARG
6161 is negative, go up that many levels.
6163 - When point is not at the beginning of a headline, execute the global
6164 binding for TAB, which is re-indenting the line. See the option
6165 `org-cycle-emulate-tab' for details.
6167 - Special case: if point is at the beginning of the buffer and there is
6168 no headline in line 1, this function will act as if called with prefix arg
6169 (C-u TAB, same as S-TAB) also when called without prefix arg.
6170 But only if also the variable `org-cycle-global-at-bob' is t."
6180 org-inlinetask-min-level
6185 limit-level)))
6188 outline-regexp
6196 org-cycle-hook))
6200 ;; special case: use global cycling
6214 ;; Table: enter it or move to the next field.
6225 ;; Global cycling: delegate to `org-cycle-internal-global'.
6228 ;; Drawers: delegate to `org-flag-drawer'.
6236 ;; Show-subtree, ARG levels up from here.
6244 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6252 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6259 ;; From there: TAB emulation and template completion.
6281 t
6290 "Do the global cycling action."
6291 ;; Hack to avoid display of messages for .org attachments in Gnus
6296 ;; We just created the overview - now do table of contents
6297 ;; This can be slow in very large buffers, so indicate action
6307 ;; We just showed the table of contents - now show everything
6315 ;; Default action: go to overview
6323 "Do the local cycling action."
6325 ;; First, determine end of headline (EOH), end of subtree or item
6326 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6350 ;; Determine end invisible part of buffer (EOL)
6352 ;; XEmacs doesn't have `next-single-char-property-change'
6362 ;; Find out what to do next and set `this-command'
6365 ;; Nothing is hidden behind this heading
6377 org-cycle-skip-children-state-if-no-children))))
6378 ;; Entire subtree is hidden in one line: children view
6384 ;; FIXME: This slows down the func way too much.
6385 ;; How keep drawers hidden in subtree anyway?
6386 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6387 ;; (org-cycle-hide-drawers 'subtree))
6389 ;; Fold every list in subtree to top-level items.
6411 ;; We just showed the children, or no children are there,
6412 ;; now show everything.
6419 ;; Default action: hide the subtree.
6426 ;;;###autoload
6428 "Cycle the global visibility. For details see `org-cycle'.
6430 With a numeric prefix, show all headlines up to that level."
6446 "Set the visibility required by startup options and properties."
6461 "Switch subtree visibilities according to :VISIBILITY: property."
6468 nil t)
6492 ;; This function uses outline-regexp instead of the more fundamental
6493 ;; org-outline-regexp so that org-cycle-global works outside of Org
6494 ;; buffers, where outline-regexp is needed.
6496 "Switch to overview mode, showing only top-level headlines.
6497 Really, this shows all headlines with level equal or greater than the level
6498 of the first headline in the buffer. This is important, because if the
6499 first headline is not level one, then (hide-sublevels 1) gives confusing
6500 results."
6511 "Show all headlines in the buffer, like a table of contents.
6512 With numerical argument N, show content up to level N."
6515 ;; Visit all headings and show their offspring
6522 t)
6531 "Adjust the window after a change in outline visibility.
6532 This function is the default value of the hook `org-cycle-hook'."
6542 "Remove outline overlays that do not contain non-white stuff."
6552 "Fix visibility issues after moving a subtree."
6553 ;; First, find a reasonable region to look at:
6554 ;; Start two siblings above, end three below
6572 ;; Properly fold already folded siblings
6583 "Show empty lines above all visible headlines.
6584 The region to be covered depends on STATE when called through
6585 `org-cycle-hook'. Lisp program can use t for STATE to get the
6586 entire buffer covered. Note that an empty line is only shown if there
6587 are at least `org-cycle-separator-lines' empty lines before the headline."
6597 beg end b e)
6621 ;; Never hide empty lines at the end of the file.
6631 "Move to the parent and re-show empty lines before visible headlines."
6637 "Return `org-agenda-files' list, plus all open org-mode files.
6638 This is useful for operations that need to scan all of a user's
6639 open and agenda-wise Org files."
6647 files))
6650 "Return the beginning position of the current entry."
6654 "Return the end position of the current entry."
6658 "Re-hide all drawers after a visibility state change."
6684 "Is the end of the current subtree visible?"
6689 "Move cursor to the first headline and recenter the headline.
6690 Optional argument N means put the headline into the Nth line of the window."
6696 ;;; Saving and restoring visibility
6699 "Return a list of the locations of all outline overlays.
6700 These are overlays with the `invisible' property value `outline'.
6701 The return value is a list of cons cells, with start and stop
6702 positions for each overlay.
6703 If USE-MARKERS is set, return the positions as markers."
6721 "Create visibility overlays for all positions in DATA.
6722 DATA should have been made by `org-outline-overlay-data'."
6730 data)))))
6732 ;;; Folding of blocks
6739 "Call FUNCTION at the head of all source blocks in the current buffer.
6740 Optional arguments START and END can be used to limit the range."
6752 "Toggle the visibility of all blocks in the current buffer."
6756 "Fold all blocks in the current buffer."
6762 "Unfold all blocks in the current buffer."
6768 "Toggle visibility of block at point."
6779 "Toggle the visibility of the current block."
6786 ov)
6802 ;; make the block accessible to isearch
6804 ov 'isearch-open-invisible
6815 ;; org-tab-after-check-for-cycling-hook
6817 ;; Remove overlays when changing major mode
6822 ;;; Org-goto
6828 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6844 nil)
6845 (org-defkey map "q" 'org-goto-quit)
6846 (org-defkey map "n" 'outline-next-visible-heading)
6847 (org-defkey map "p" 'outline-previous-visible-heading)
6848 (org-defkey map "f" 'outline-forward-same-level)
6849 (org-defkey map "b" 'outline-backward-same-level)
6850 (org-defkey map "u" 'outline-up-heading))
6851 (org-defkey map "/" 'org-occur)
6852 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6853 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6854 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6855 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6856 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6857 map))
6859 (defconst org-goto-help
6860 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6861 RET=jump to location [Q]uit and return to previous location
6862 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6864 (defvar org-goto-start-pos) ; dynamically scoped parameter
6866 ;; FIXME: Docstring does not mention both interfaces
6867 (defun org-goto (&optional alternative-interface)
6868 "Look up a different location in the current file, keeping current visibility.
6870 When you want look-up or go to a different location in a
6871 document, the fastest way is often to fold the entire buffer and
6872 then dive into the tree. This method has the disadvantage, that
6873 the previous location will be folded, which may not be what you
6874 want.
6876 This command works around this by showing a copy of the current
6877 buffer in an indirect buffer, in overview mode. You can dive
6878 into the tree in that copy, use org-occur and incremental search
6879 to find a location. When pressing RET or `Q', the command
6880 returns to the original buffer in which the visibility is still
6881 unchanged. After RET it will also jump to the location selected
6882 in the indirect buffer and expose the headline hierarchy above.
6884 With a prefix argument, use the alternative interface: e.g. if
6885 `org-goto-interface' is 'outline use 'outline-path-completion."
6886 (interactive "P")
6887 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6888 (org-refile-use-outline-path t)
6889 (org-refile-target-verify-function nil)
6890 (interface
6891 (if (not alternative-interface)
6892 org-goto-interface
6893 (if (eq org-goto-interface 'outline)
6894 'outline-path-completion
6895 'outline)))
6896 (org-goto-start-pos (point))
6897 (selected-point
6898 (if (eq interface 'outline)
6899 (car (org-get-location (current-buffer) org-goto-help))
6900 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6901 (org-refile-check-position pa)
6902 (nth 3 pa)))))
6903 (if selected-point
6904 (progn
6905 (org-mark-ring-push org-goto-start-pos)
6906 (goto-char selected-point)
6907 (if (or (outline-invisible-p) (org-invisible-p2))
6908 (org-show-context 'org-goto)))
6909 (message "Quit"))))
6911 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6912 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6913 (defvar org-goto-local-auto-isearch-map) ; defined below
6915 (defun org-get-location (buf help)
6916 "Let the user select a location in the Org-mode buffer BUF.
6917 This function uses a recursive edit. It returns the selected position
6918 or nil."
6919 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6920 (isearch-hide-immediately nil)
6921 (isearch-search-fun-function
6922 (lambda () 'org-goto-local-search-headings))
6923 (org-goto-selected-point org-goto-exit-command)
6924 (pop-up-frames nil)
6925 (special-display-buffer-names nil)
6926 (special-display-regexps nil)
6927 (special-display-function nil))
6928 (save-excursion
6929 (save-window-excursion
6930 (delete-other-windows)
6931 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6932 (org-pop-to-buffer-same-window
6933 (condition-case nil
6934 (make-indirect-buffer (current-buffer) "*org-goto*")
6935 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6936 (with-output-to-temp-buffer "*Help*"
6937 (princ help))
6938 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6939 (setq buffer-read-only nil)
6940 (let ((org-startup-truncated t)
6941 (org-startup-folded nil)
6942 (org-startup-align-all-tables nil))
6943 (org-mode)
6944 (org-overview))
6945 (setq buffer-read-only t)
6946 (if (and (boundp 'org-goto-start-pos)
6947 (integer-or-marker-p org-goto-start-pos))
6948 (let ((org-show-hierarchy-above t)
6949 (org-show-siblings t)
6950 (org-show-following-heading t))
6951 (goto-char org-goto-start-pos)
6952 (and (outline-invisible-p) (org-show-context)))
6953 (goto-char (point-min)))
6954 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6955 (message "Select location and press RET")
6956 (use-local-map org-goto-map)
6957 (recursive-edit)
6958 ))
6959 (kill-buffer "*org-goto*")
6960 (cons org-goto-selected-point org-goto-exit-command)))
6962 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6963 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6964 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6965 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6967 (defun org-goto-local-search-headings (string bound noerror)
6968 "Search and make sure that any matches are in headlines."
6969 (catch 'return
6970 (while (if isearch-forward
6971 (search-forward string bound noerror)
6972 (search-backward string bound noerror))
6973 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6974 (and (member :headline context)
6975 (not (member :tags context))))
6976 (throw 'return (point))))))
6978 (defun org-goto-local-auto-isearch ()
6979 "Start isearch."
6980 (interactive)
6981 (goto-char (point-min))
6982 (let ((keys (this-command-keys)))
6983 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6984 (isearch-mode t)
6985 (isearch-process-search-char (string-to-char keys)))))
6987 (defun org-goto-ret (&optional arg)
6988 "Finish `org-goto' by going to the new location."
6989 (interactive "P")
6990 (setq org-goto-selected-point (point)
6991 org-goto-exit-command 'return)
6992 (throw 'exit nil))
6994 (defun org-goto-left ()
6995 "Finish `org-goto' by going to the new location."
6996 (interactive)
6997 (if (org-at-heading-p)
6998 (progn
6999 (beginning-of-line 1)
7000 (setq org-goto-selected-point (point)
7001 org-goto-exit-command 'left)
7002 (throw 'exit nil))
7003 (error "Not on a heading")))
7005 (defun org-goto-right ()
7006 "Finish `org-goto' by going to the new location."
7007 (interactive)
7008 (if (org-at-heading-p)
7009 (progn
7010 (setq org-goto-selected-point (point)
7011 org-goto-exit-command 'right)
7012 (throw 'exit nil))
7013 (error "Not on a heading")))
7015 (defun org-goto-quit ()
7016 "Finish `org-goto' without cursor motion."
7017 (interactive)
7018 (setq org-goto-selected-point nil)
7019 (setq org-goto-exit-command 'quit)
7020 (throw 'exit nil))
7022 ;;; Indirect buffer display of subtrees
7024 (defvar org-indirect-dedicated-frame nil
7025 "This is the frame being used for indirect tree display.")
7026 (defvar org-last-indirect-buffer nil)
7028 (defun org-tree-to-indirect-buffer (&optional arg)
7029 "Create indirect buffer and narrow it to current subtree.
7030 With numerical prefix ARG, go up to this level and then take that tree.
7031 If ARG is negative, go up that many levels.
7032 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7033 indirect buffer previously made with this command, to avoid proliferation of
7034 indirect buffers. However, when you call the command with a \
7036 when `org-indirect-buffer-display' is `new-frame', the last buffer
7037 is kept so that you can work with several indirect buffers at the same time.
7038 If `org-indirect-buffer-display' is `dedicated-frame', the \
7040 requests that a new frame be made for the new buffer, so that the dedicated
7041 frame is not changed."
7042 (interactive "P")
7043 (let ((cbuf (current-buffer))
7044 (cwin (selected-window))
7045 (pos (point))
7046 beg end level heading ibuf)
7047 (save-excursion
7048 (org-back-to-heading t)
7049 (when (numberp arg)
7050 (setq level (org-outline-level))
7051 (if (< arg 0) (setq arg (+ level arg)))
7052 (while (> (setq level (org-outline-level)) arg)
7053 (outline-up-heading 1 t)))
7054 (setq beg (point)
7055 heading (org-get-heading))
7056 (org-end-of-subtree t t)
7057 (if (org-at-heading-p) (backward-char 1))
7058 (setq end (point)))
7059 (if (and (buffer-live-p org-last-indirect-buffer)
7060 (not (eq org-indirect-buffer-display 'new-frame))
7061 (not arg))
7062 (kill-buffer org-last-indirect-buffer))
7063 (setq ibuf (org-get-indirect-buffer cbuf)
7064 org-last-indirect-buffer ibuf)
7065 (cond
7066 ((or (eq org-indirect-buffer-display 'new-frame)
7067 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7068 (select-frame (make-frame))
7069 (delete-other-windows)
7070 (org-pop-to-buffer-same-window ibuf)
7071 (org-set-frame-title heading))
7072 ((eq org-indirect-buffer-display 'dedicated-frame)
7073 (raise-frame
7074 (select-frame (or (and org-indirect-dedicated-frame
7075 (frame-live-p org-indirect-dedicated-frame)
7076 org-indirect-dedicated-frame)
7077 (setq org-indirect-dedicated-frame (make-frame)))))
7078 (delete-other-windows)
7079 (org-pop-to-buffer-same-window ibuf)
7080 (org-set-frame-title (concat "Indirect: " heading)))
7081 ((eq org-indirect-buffer-display 'current-window)
7082 (org-pop-to-buffer-same-window ibuf))
7083 ((eq org-indirect-buffer-display 'other-window)
7084 (pop-to-buffer ibuf))
7085 (t (error "Invalid value")))
7086 (if (featurep 'xemacs)
7087 (save-excursion (org-mode) (turn-on-font-lock)))
7088 (narrow-to-region beg end)
7089 (show-all)
7090 (goto-char pos)
7091 (run-hook-with-args 'org-cycle-hook 'all)
7092 (and (window-live-p cwin) (select-window cwin))))
7094 (defun org-get-indirect-buffer (&optional buffer)
7095 (setq buffer (or buffer (current-buffer)))
7096 (let ((n 1) (base (buffer-name buffer)) bname)
7097 (while (buffer-live-p
7098 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7099 (setq n (1+ n)))
7100 (condition-case nil
7101 (make-indirect-buffer buffer bname 'clone)
7102 (error (make-indirect-buffer buffer bname)))))
7104 (defun org-set-frame-title (title)
7105 "Set the title of the current frame to the string TITLE."
7106 ;; FIXME: how to name a single frame in XEmacs???
7107 (unless (featurep 'xemacs)
7108 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7110 ;;;; Structure editing
7112 ;;; Inserting headlines
7114 (defun org-previous-line-empty-p ()
7115 (save-excursion
7116 (and (not (bobp))
7117 (or (beginning-of-line 0) t)
7118 (save-match-data
7121 (defun org-insert-heading (&optional force-heading invisible-ok)
7122 "Insert a new heading or item with same depth at point.
7123 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7124 If point is at the beginning of a headline, insert a sibling before the
7125 current headline. If point is not at the beginning, split the line,
7126 create the new headline with the text in the current line after point
7127 \(but see also the variable `org-M-RET-may-split-line').
7129 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7130 This is important for non-interactive uses of the command."
7131 (interactive "P")
7132 (if (or (= (buffer-size) 0)
7133 (and (not (save-excursion
7134 (and (ignore-errors (org-back-to-heading invisible-ok))
7135 (org-at-heading-p))))
7136 (or force-heading (not (org-in-item-p)))))
7137 (progn
7139 (run-hooks 'org-insert-heading-hook))
7140 (when (or force-heading (not (org-insert-item)))
7141 (let* ((empty-line-p nil)
7142 (level nil)
7143 (on-heading (org-at-heading-p))
7144 (head (save-excursion
7145 (condition-case nil
7146 (progn
7147 (org-back-to-heading invisible-ok)
7148 (when (and (not on-heading)
7149 (featurep 'org-inlinetask)
7150 (integerp org-inlinetask-min-level)
7151 (>= (length (match-string 0))
7152 org-inlinetask-min-level))
7153 ;; Find a heading level before the inline task
7154 (while (and (setq level (org-up-heading-safe))
7155 (>= level org-inlinetask-min-level)))
7156 (if (org-at-heading-p)
7157 (org-back-to-heading invisible-ok)
7158 (error "This should not happen")))
7159 (setq empty-line-p (org-previous-line-empty-p))
7160 (match-string 0))
7161 (error "*"))))
7162 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7163 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7164 pos hide-previous previous-pos)
7165 (cond
7166 ((and (org-at-heading-p) (bolp)
7167 (or (bobp)
7168 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7169 ;; insert before the current line
7170 (open-line (if blank 2 1)))
7171 ((and (bolp)
7172 (not org-insert-heading-respect-content)
7173 (or (bobp)
7174 (save-excursion
7175 (backward-char 1) (not (outline-invisible-p)))))
7176 ;; insert right here
7177 nil)
7178 (t
7179 ;; somewhere in the line
7180 (save-excursion
7181 (setq previous-pos (point-at-bol))
7182 (end-of-line)
7183 (setq hide-previous (outline-invisible-p)))
7184 (and org-insert-heading-respect-content (org-show-subtree))
7185 (let ((split
7186 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7187 (save-excursion
7188 (let ((p (point)))
7189 (goto-char (point-at-bol))
7190 (and (looking-at org-complex-heading-regexp)
7191 (match-beginning 4)
7192 (> p (match-beginning 4)))))))
7193 tags pos)
7194 (cond
7195 (org-insert-heading-respect-content
7196 (org-end-of-subtree nil t)
7197 (when (featurep 'org-inlinetask)
7198 (while (and (not (eobp))
7200 (>= (length (match-string 1))
7201 org-inlinetask-min-level))
7202 (org-end-of-subtree nil t)))
7203 (or (bolp) (newline))
7204 (or (org-previous-line-empty-p)
7205 (and blank (newline)))
7206 (open-line 1))
7207 ((org-at-heading-p)
7208 (when hide-previous
7209 (show-children)
7210 (org-show-entry))
7212 (setq tags (and (match-end 2) (match-string 2)))
7213 (and (match-end 1)
7214 (delete-region (match-beginning 1) (match-end 1)))
7215 (setq pos (point-at-bol))
7216 (or split (end-of-line 1))
7217 (delete-horizontal-space)
7219 (buffer-substring (point-at-bol) (point)))
7220 (insert " "))
7221 (newline (if blank 2 1))
7222 (when tags
7223 (save-excursion
7224 (goto-char pos)
7225 (end-of-line 1)
7226 (insert " " tags)
7227 (org-set-tags nil 'align))))
7228 (t
7229 (or split (end-of-line 1))
7230 (newline (if blank 2 1)))))))
7231 (insert head) (just-one-space)
7232 (setq pos (point))
7233 (end-of-line 1)
7234 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7235 (when (and org-insert-heading-respect-content hide-previous)
7236 (save-excursion
7237 (goto-char previous-pos)
7238 (hide-subtree)))
7239 (run-hooks 'org-insert-heading-hook)))))
7241 (defun org-get-heading (&optional no-tags no-todo)
7242 "Return the heading of the current entry, without the stars.
7243 When NO-TAGS is non-nil, don't include tags.
7244 When NO-TODO is non-nil, don't include TODO keywords."
7245 (save-excursion
7246 (org-back-to-heading t)
7247 (cond
7248 ((and no-tags no-todo)
7249 (looking-at org-complex-heading-regexp)
7250 (match-string 4))
7251 (no-tags
7252 (looking-at (concat org-outline-regexp
7255 (match-string 1))
7256 (no-todo
7257 (looking-at org-todo-line-regexp)
7258 (match-string 3))
7259 (t (looking-at org-heading-regexp)
7260 (match-string 2)))))
7262 (defun org-heading-components ()
7263 "Return the components of the current heading.
7264 This is a list with the following elements:
7265 - the level as an integer
7266 - the reduced level, different if `org-odd-levels-only' is set.
7267 - the TODO keyword, or nil
7268 - the priority character, like ?A, or nil if no priority is given
7269 - the headline text itself, or the tags string if no headline text
7270 - the tags string, or nil."
7271 (save-excursion
7272 (org-back-to-heading t)
7273 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7274 (list (length (match-string 1))
7275 (org-reduced-level (length (match-string 1)))
7276 (org-match-string-no-properties 2)
7277 (and (match-end 3) (aref (match-string 3) 2))
7278 (org-match-string-no-properties 4)
7279 (org-match-string-no-properties 5)))))
7281 (defun org-get-entry ()
7282 "Get the entry text, after heading, entire subtree."
7283 (save-excursion
7284 (org-back-to-heading t)
7285 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7287 (defun org-insert-heading-after-current ()
7288 "Insert a new heading with same level as current, after current subtree."
7289 (interactive)
7290 (org-back-to-heading)
7291 (org-insert-heading)
7292 (org-move-subtree-down)
7293 (end-of-line 1))
7295 (defun org-insert-heading-respect-content ()
7296 (interactive)
7297 (let ((org-insert-heading-respect-content t))
7298 (org-insert-heading t)))
7300 (defun org-insert-todo-heading-respect-content (&optional force-state)
7301 (interactive "P")
7302 (let ((org-insert-heading-respect-content t))
7303 (org-insert-todo-heading force-state t)))
7305 (defun org-insert-todo-heading (arg &optional force-heading)
7306 "Insert a new heading with the same level and TODO state as current heading.
7307 If the heading has no TODO state, or if the state is DONE, use the first
7308 state (TODO by default). Also with prefix arg, force first state."
7309 (interactive "P")
7310 (when (or force-heading (not (org-insert-item 'checkbox)))
7311 (org-insert-heading force-heading)
7312 (save-excursion
7313 (org-back-to-heading)
7314 (outline-previous-heading)
7315 (looking-at org-todo-line-regexp))
7316 (let*
7317 ((new-mark-x
7318 (if (or arg
7319 (not (match-beginning 2))
7320 (member (match-string 2) org-done-keywords))
7321 (car org-todo-keywords-1)
7322 (match-string 2)))
7323 (new-mark
7324 (or
7325 (run-hook-with-args-until-success
7326 'org-todo-get-default-hook new-mark-x nil)
7327 new-mark-x)))
7328 (beginning-of-line 1)
7329 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7330 (if org-treat-insert-todo-heading-as-state-change
7331 (org-todo new-mark)
7332 (insert new-mark " "))))
7333 (when org-provide-todo-statistics
7334 (org-update-parent-todo-statistics))))
7336 (defun org-insert-subheading (arg)
7337 "Insert a new subheading and demote it.
7338 Works for outline headings and for plain lists alike."
7339 (interactive "P")
7340 (org-insert-heading arg)
7341 (cond
7342 ((org-at-heading-p) (org-do-demote))
7343 ((org-at-item-p) (org-indent-item))))
7345 (defun org-insert-todo-subheading (arg)
7346 "Insert a new subheading with TODO keyword or checkbox and demote it.
7347 Works for outline headings and for plain lists alike."
7348 (interactive "P")
7349 (org-insert-todo-heading arg)
7350 (cond
7351 ((org-at-heading-p) (org-do-demote))
7352 ((org-at-item-p) (org-indent-item))))
7354 ;;; Promotion and Demotion
7356 (defvar org-after-demote-entry-hook nil
7357 "Hook run after an entry has been demoted.
7358 The cursor will be at the beginning of the entry.
7359 When a subtree is being demoted, the hook will be called for each node.")
7361 (defvar org-after-promote-entry-hook nil
7362 "Hook run after an entry has been promoted.
7363 The cursor will be at the beginning of the entry.
7364 When a subtree is being promoted, the hook will be called for each node.")
7366 (defun org-promote-subtree ()
7367 "Promote the entire subtree.
7368 See also `org-promote'."
7369 (interactive)
7370 (save-excursion
7371 (org-with-limited-levels (org-map-tree 'org-promote)))
7372 (org-fix-position-after-promote))
7374 (defun org-demote-subtree ()
7375 "Demote the entire subtree. See `org-demote'.
7376 See also `org-promote'."
7377 (interactive)
7378 (save-excursion
7379 (org-with-limited-levels (org-map-tree 'org-demote)))
7380 (org-fix-position-after-promote))
7383 (defun org-do-promote ()
7384 "Promote the current heading higher up the tree.
7385 If the region is active in `transient-mark-mode', promote all headings
7386 in the region."
7387 (interactive)
7388 (save-excursion
7389 (if (org-region-active-p)
7390 (org-map-region 'org-promote (region-beginning) (region-end))
7391 (org-promote)))
7392 (org-fix-position-after-promote))
7394 (defun org-do-demote ()
7395 "Demote the current heading lower down the tree.
7396 If the region is active in `transient-mark-mode', demote all headings
7397 in the region."
7398 (interactive)
7399 (save-excursion
7400 (if (org-region-active-p)
7401 (org-map-region 'org-demote (region-beginning) (region-end))
7402 (org-demote)))
7403 (org-fix-position-after-promote))
7405 (defun org-fix-position-after-promote ()
7406 "Make sure that after pro/demotion cursor position is right."
7407 (let ((pos (point)))
7408 (when (save-excursion
7409 (beginning-of-line 1)
7410 (looking-at org-todo-line-regexp)
7411 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7412 (cond ((eobp) (insert " "))
7413 ((eolp) (insert " "))
7414 ((equal (char-after) ?\ ) (forward-char 1))))))
7416 (defun org-current-level ()
7417 "Return the level of the current entry, or nil if before the first headline.
7418 The level is the number of stars at the beginning of the headline."
7419 (save-excursion
7420 (org-with-limited-levels
7421 (if (ignore-errors (org-back-to-heading t))
7422 (funcall outline-level)))))
7424 (defun org-get-previous-line-level ()
7425 "Return the outline depth of the last headline before the current line.
7426 Returns 0 for the first headline in the buffer, and nil if before the
7427 first headline."
7428 (let ((current-level (org-current-level))
7429 (prev-level (when (> (line-number-at-pos) 1)
7430 (save-excursion
7431 (beginning-of-line 0)
7432 (org-current-level)))))
7433 (cond ((null current-level) nil) ; Before first headline
7434 ((null prev-level) 0) ; At first headline
7435 (prev-level))))
7437 (defun org-reduced-level (l)
7438 "Compute the effective level of a heading.
7439 This takes into account the setting of `org-odd-levels-only'."
7440 (cond
7441 ((zerop l) 0)
7442 (org-odd-levels-only (1+ (floor (/ l 2))))
7443 (t l)))
7445 (defun org-level-increment ()
7446 "Return the number of stars that will be added or removed at a
7447 time to headlines when structure editing, based on the value of
7448 `org-odd-levels-only'."
7449 (if org-odd-levels-only 2 1))
7451 (defun org-get-valid-level (level &optional change)
7452 "Rectify a level change under the influence of `org-odd-levels-only'
7453 LEVEL is a current level, CHANGE is by how much the level should be
7454 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7455 even level numbers will become the next higher odd number."
7456 (if org-odd-levels-only
7457 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7458 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7459 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7460 (max 1 (+ level (or change 0)))))
7462 (if (boundp 'define-obsolete-function-alias)
7463 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7464 (define-obsolete-function-alias 'org-get-legal-level
7465 'org-get-valid-level)
7466 (define-obsolete-function-alias 'org-get-legal-level
7467 'org-get-valid-level "23.1")))
7469 (defun org-promote ()
7470 "Promote the current heading higher up the tree.
7471 If the region is active in `transient-mark-mode', promote all headings
7472 in the region."
7473 (org-back-to-heading t)
7474 (let* ((level (save-match-data (funcall outline-level)))
7475 (after-change-functions (remove 'flyspell-after-change-function
7476 after-change-functions))
7477 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7478 (diff (abs (- level (length up-head) -1))))
7479 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7480 (replace-match up-head nil t)
7481 ;; Fixup tag positioning
7482 (and org-auto-align-tags (org-set-tags nil t))
7483 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7484 (run-hooks 'org-after-promote-entry-hook)))
7486 (defun org-demote ()
7487 "Demote the current heading lower down the tree.
7488 If the region is active in `transient-mark-mode', demote all headings
7489 in the region."
7490 (org-back-to-heading t)
7491 (let* ((level (save-match-data (funcall outline-level)))
7492 (after-change-functions (remove 'flyspell-after-change-function
7493 after-change-functions))
7494 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7495 (diff (abs (- level (length down-head) -1))))
7496 (replace-match down-head nil t)
7497 ;; Fixup tag positioning
7498 (and org-auto-align-tags (org-set-tags nil t))
7499 (if org-adapt-indentation (org-fixup-indentation diff))
7500 (run-hooks 'org-after-demote-entry-hook)))
7502 (defun org-cycle-level ()
7503 "Cycle the level of an empty headline through possible states.
7504 This goes first to child, then to parent, level, then up the hierarchy.
7505 After top level, it switches back to sibling level."
7506 (interactive)
7507 (let ((org-adapt-indentation nil))
7508 (when (org-point-at-end-of-empty-headline)
7509 (setq this-command 'org-cycle-level) ; Only needed for caching
7510 (let ((cur-level (org-current-level))
7511 (prev-level (org-get-previous-line-level)))
7512 (cond
7513 ;; If first headline in file, promote to top-level.
7514 ((= prev-level 0)
7515 (loop repeat (/ (- cur-level 1) (org-level-increment))
7516 do (org-do-promote)))
7517 ;; If same level as prev, demote one.
7518 ((= prev-level cur-level)
7519 (org-do-demote))
7520 ;; If parent is top-level, promote to top level if not already.
7521 ((= prev-level 1)
7522 (loop repeat (/ (- cur-level 1) (org-level-increment))
7523 do (org-do-promote)))
7524 ;; If top-level, return to prev-level.
7525 ((= cur-level 1)
7526 (loop repeat (/ (- prev-level 1) (org-level-increment))
7527 do (org-do-demote)))
7528 ;; If less than prev-level, promote one.
7529 ((< cur-level prev-level)
7530 (org-do-promote))
7531 ;; If deeper than prev-level, promote until higher than
7532 ;; prev-level.
7533 ((> cur-level prev-level)
7534 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7535 do (org-do-promote))))
7536 t))))
7538 (defun org-map-tree (fun)
7539 "Call FUN for every heading underneath the current one."
7540 (org-back-to-heading)
7541 (let ((level (funcall outline-level)))
7542 (save-excursion
7543 (funcall fun)
7544 (while (and (progn
7545 (outline-next-heading)
7546 (> (funcall outline-level) level))
7547 (not (eobp)))
7548 (funcall fun)))))
7550 (defun org-map-region (fun beg end)
7551 "Call FUN for every heading between BEG and END."
7552 (let ((org-ignore-region t))
7553 (save-excursion
7554 (setq end (copy-marker end))
7555 (goto-char beg)
7556 (if (and (re-search-forward org-outline-regexp-bol nil t)
7557 (< (point) end))
7558 (funcall fun))
7559 (while (and (progn
7560 (outline-next-heading)
7561 (< (point) end))
7562 (not (eobp)))
7563 (funcall fun)))))
7565 (defvar org-property-end-re) ; silence byte-compiler
7566 (defun org-fixup-indentation (diff)
7567 "Change the indentation in the current entry by DIFF.
7568 However, if any line in the current entry has no indentation, or if it
7569 would end up with no indentation after the change, nothing at all is done."
7570 (save-excursion
7571 (let ((end (save-excursion (outline-next-heading)
7572 (point-marker)))
7573 (prohibit (if (> diff 0)
7576 col)
7577 (unless (save-excursion (end-of-line 1)
7578 (re-search-forward prohibit end t))
7579 (while (and (< (point) end)
7581 (goto-char (match-end 0))
7582 (setq col (current-column))
7583 (if (< diff 0) (replace-match ""))
7584 (org-indent-to-column (+ diff col))))
7585 (move-marker end nil))))
7587 (defun org-convert-to-odd-levels ()
7588 "Convert an org-mode file with all levels allowed to one with odd levels.
7589 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7590 level 5 etc."
7591 (interactive)
7592 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7593 (let ((outline-level 'org-outline-level)
7594 (org-odd-levels-only nil) n)
7595 (save-excursion
7596 (goto-char (point-min))
7598 (setq n (- (length (match-string 0)) 2))
7599 (while (>= (setq n (1- n)) 0)
7600 (org-demote))
7601 (end-of-line 1))))))
7603 (defun org-convert-to-oddeven-levels ()
7604 "Convert an org-mode file with only odd levels to one with odd/even levels.
7605 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7606 file contains a section with an even level, conversion would
7607 destroy the structure of the file. An error is signaled in this
7608 case."
7609 (interactive)
7610 (goto-char (point-min))
7611 ;; First check if there are no even levels
7613 (org-show-context t)
7614 (error "Not all levels are odd in this file. Conversion not possible"))
7615 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7616 (let ((outline-regexp org-outline-regexp)
7617 (outline-level 'org-outline-level)
7618 (org-odd-levels-only nil) n)
7619 (save-excursion
7620 (goto-char (point-min))
7622 (setq n (/ (1- (length (match-string 0))) 2))
7623 (while (>= (setq n (1- n)) 0)
7624 (org-promote))
7625 (end-of-line 1))))))
7627 (defun org-tr-level (n)
7628 "Make N odd if required."
7629 (if org-odd-levels-only (1+ (/ n 2)) n))
7631 ;;; Vertical tree motion, cutting and pasting of subtrees
7633 (defun org-move-subtree-up (&optional arg)
7634 "Move the current subtree up past ARG headlines of the same level."
7635 (interactive "p")
7636 (org-move-subtree-down (- (prefix-numeric-value arg))))
7638 (defun org-move-subtree-down (&optional arg)
7639 "Move the current subtree down past ARG headlines of the same level."
7640 (interactive "p")
7641 (setq arg (prefix-numeric-value arg))
7642 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7643 'org-get-last-sibling))
7644 (ins-point (make-marker))
7645 (cnt (abs arg))
7646 (col (current-column))
7647 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7648 ;; Select the tree
7649 (org-back-to-heading)
7650 (setq beg0 (point))
7651 (save-excursion
7652 (setq ne-beg (org-back-over-empty-lines))
7653 (setq beg (point)))
7654 (save-match-data
7655 (save-excursion (outline-end-of-heading)
7656 (setq folded (outline-invisible-p)))
7657 (outline-end-of-subtree))
7658 (outline-next-heading)
7659 (setq ne-end (org-back-over-empty-lines))
7660 (setq end (point))
7661 (goto-char beg0)
7662 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7663 ;; include less whitespace
7664 (save-excursion
7665 (goto-char beg)
7666 (forward-line (- ne-beg ne-end))
7667 (setq beg (point))))
7668 ;; Find insertion point, with error handling
7669 (while (> cnt 0)
7670 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7671 (progn (goto-char beg0)
7672 (error "Cannot move past superior level or buffer limit")))
7673 (setq cnt (1- cnt)))
7674 (if (> arg 0)
7675 ;; Moving forward - still need to move over subtree
7676 (progn (org-end-of-subtree t t)
7677 (save-excursion
7678 (org-back-over-empty-lines)
7679 (or (bolp) (newline)))))
7680 (setq ne-ins (org-back-over-empty-lines))
7681 (move-marker ins-point (point))
7682 (setq txt (buffer-substring beg end))
7683 (org-save-markers-in-region beg end)
7684 (delete-region beg end)
7685 (org-remove-empty-overlays-at beg)
7686 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7687 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7689 (let ((bbb (point)))
7690 (insert-before-markers txt)
7691 (org-reinstall-markers-in-region bbb)
7692 (move-marker ins-point bbb))
7694 (setq ins-end (point))
7695 (goto-char ins-point)
7696 (org-skip-whitespace)
7697 (when (and (< arg 0)
7698 (org-first-sibling-p)
7699 (> ne-ins ne-beg))
7700 ;; Move whitespace back to beginning
7701 (save-excursion
7702 (goto-char ins-end)
7703 (let ((kill-whole-line t))
7704 (kill-line (- ne-ins ne-beg)) (point)))
7706 (move-marker ins-point nil)
7707 (if folded
7708 (hide-subtree)
7709 (org-show-entry)
7710 (show-children)
7711 (org-cycle-hide-drawers 'children))
7712 (org-clean-visibility-after-subtree-move)
7713 ;; move back to the initial column we were at
7714 (move-to-column col)))
7716 (defvar org-subtree-clip ""
7717 "Clipboard for cut and paste of subtrees.
7718 This is actually only a copy of the kill, because we use the normal kill
7719 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7721 (defvar org-subtree-clip-folded nil
7722 "Was the last copied subtree folded?
7723 This is used to fold the tree back after pasting.")
7725 (defun org-cut-subtree (&optional n)
7726 "Cut the current subtree into the clipboard.
7727 With prefix arg N, cut this many sequential subtrees.
7728 This is a short-hand for marking the subtree and then cutting it."
7729 (interactive "p")
7730 (org-copy-subtree n 'cut))
7732 (defun org-copy-subtree (&optional n cut force-store-markers)
7733 "Cut the current subtree into the clipboard.
7734 With prefix arg N, cut this many sequential subtrees.
7735 This is a short-hand for marking the subtree and then copying it.
7736 If CUT is non-nil, actually cut the subtree.
7737 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7738 of some markers in the region, even if CUT is non-nil. This is
7739 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7740 (interactive "p")
7741 (let (beg end folded (beg0 (point)))
7742 (if (org-called-interactively-p 'any)
7743 (org-back-to-heading nil) ; take what looks like a subtree
7744 (org-back-to-heading t)) ; take what is really there
7745 (org-back-over-empty-lines)
7746 (setq beg (point))
7748 (save-match-data
7749 (save-excursion (outline-end-of-heading)
7750 (setq folded (outline-invisible-p)))
7751 (condition-case nil
7752 (org-forward-same-level (1- n) t)
7753 (error nil))
7754 (org-end-of-subtree t t))
7755 (org-back-over-empty-lines)
7756 (setq end (point))
7757 (goto-char beg0)
7758 (when (> end beg)
7759 (setq org-subtree-clip-folded folded)
7760 (when (or cut force-store-markers)
7761 (org-save-markers-in-region beg end))
7762 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7763 (setq org-subtree-clip (current-kill 0))
7764 (message "%s: Subtree(s) with %d characters"
7765 (if cut "Cut" "Copied")
7766 (length org-subtree-clip)))))
7768 (defun org-paste-subtree (&optional level tree for-yank)
7769 "Paste the clipboard as a subtree, with modification of headline level.
7770 The entire subtree is promoted or demoted in order to match a new headline
7771 level.
7773 If the cursor is at the beginning of a headline, the same level as
7774 that headline is used to paste the tree
7776 If not, the new level is derived from the *visible* headings
7777 before and after the insertion point, and taken to be the inferior headline
7778 level of the two. So if the previous visible heading is level 3 and the
7779 next is level 4 (or vice versa), level 4 will be used for insertion.
7780 This makes sure that the subtree remains an independent subtree and does
7781 not swallow low level entries.
7783 You can also force a different level, either by using a numeric prefix
7784 argument, or by inserting the heading marker by hand. For example, if the
7787 If optional TREE is given, use this text instead of the kill ring.
7789 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7790 move back over whitespace before inserting, and move point to the end of
7791 the inserted text when done."
7792 (interactive "P")
7793 (setq tree (or tree (and kill-ring (current-kill 0))))
7794 (unless (org-kill-is-subtree-p tree)
7795 (error "%s"
7796 (substitute-command-keys
7798 (org-with-limited-levels
7799 (let* ((visp (not (outline-invisible-p)))
7800 (txt tree)
7802 (old-level (if (string-match org-outline-regexp-bol txt)
7803 (- (match-end 0) (match-beginning 0) 1)
7804 -1))
7805 (force-level (cond (level (prefix-numeric-value level))
7807 (string-match
7809 (point-at-bol) (point))))
7810 (- (match-end 1) (match-beginning 1)))
7811 ((and (bolp)
7812 (looking-at org-outline-regexp))
7813 (- (match-end 0) (point) 1))
7814 (t nil)))
7815 (previous-level (save-excursion
7816 (condition-case nil
7817 (progn
7818 (outline-previous-visible-heading 1)
7819 (if (looking-at ^re_)
7820 (- (match-end 0) (match-beginning 0) 1)
7821 1))
7822 (error 1))))
7823 (next-level (save-excursion
7824 (condition-case nil
7825 (progn
7826 (or (looking-at org-outline-regexp)
7827 (outline-next-visible-heading 1))
7828 (if (looking-at ^re_)
7829 (- (match-end 0) (match-beginning 0) 1)
7830 1))
7831 (error 1))))
7832 (new-level (or force-level (max previous-level next-level)))
7833 (shift (if (or (= old-level -1)
7834 (= new-level -1)
7835 (= old-level new-level))
7836 0
7837 (- new-level old-level)))
7838 (delta (if (> shift 0) -1 1))
7839 (func (if (> shift 0) 'org-demote 'org-promote))
7840 (org-odd-levels-only nil)
7841 beg end newend)
7842 ;; Remove the forced level indicator
7843 (if force-level
7844 (delete-region (point-at-bol) (point)))
7845 ;; Paste
7846 (beginning-of-line (if (bolp) 1 2))
7847 (unless for-yank (org-back-over-empty-lines))
7848 (setq beg (point))
7849 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7850 (insert-before-markers txt)
7852 (setq newend (point))
7853 (org-reinstall-markers-in-region beg)
7854 (setq end (point))
7855 (goto-char beg)
7857 (setq beg (point))
7858 (if (and (outline-invisible-p) visp)
7859 (save-excursion (outline-show-heading)))
7860 ;; Shift if necessary
7861 (unless (= shift 0)
7862 (save-restriction
7863 (narrow-to-region beg end)
7864 (while (not (= shift 0))
7865 (org-map-region func (point-min) (point-max))
7866 (setq shift (+ delta shift)))
7867 (goto-char (point-min))
7868 (setq newend (point-max))))
7869 (when (or (org-called-interactively-p 'interactive) for-yank)
7870 (message "Clipboard pasted as level %d subtree" new-level))
7871 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7872 kill-ring
7873 (eq org-subtree-clip (current-kill 0))
7874 org-subtree-clip-folded)
7875 ;; The tree was folded before it was killed/copied
7876 (hide-subtree))
7877 (and for-yank (goto-char newend)))))
7879 (defun org-kill-is-subtree-p (&optional txt)
7880 "Check if the current kill is an outline subtree, or a set of trees.
7881 Returns nil if kill does not start with a headline, or if the first
7882 headline level is not the largest headline level in the tree.
7883 So this will actually accept several entries of equal levels as well,
7884 which is OK for `org-paste-subtree'.
7885 If optional TXT is given, check this string instead of the current kill."
7886 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7887 (re (org-get-limited-outline-regexp))
7888 (^re (concat "^" re))
7889 (start-level (and kill
7890 (string-match
7892 kill)
7893 (- (match-end 2) (match-beginning 2) 1)))
7894 (start (1+ (or (match-beginning 2) -1))))
7895 (if (not start-level)
7896 (progn
7897 nil) ;; does not even start with a heading
7898 (catch 'exit
7899 (while (setq start (string-match ^re kill (1+ start)))
7900 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7901 (throw 'exit nil)))
7902 t))))
7904 (defvar org-markers-to-move nil
7905 "Markers that should be moved with a cut-and-paste operation.
7906 Those markers are stored together with their positions relative to
7907 the start of the region.")
7909 (defun org-save-markers-in-region (beg end)
7910 "Check markers in region.
7911 If these markers are between BEG and END, record their position relative
7912 to BEG, so that after moving the block of text, we can put the markers back
7913 into place.
7914 This function gets called just before an entry or tree gets cut from the
7915 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7916 called immediately, to move the markers with the entries."
7917 (setq org-markers-to-move nil)
7918 (when (featurep 'org-clock)
7919 (org-clock-save-markers-for-cut-and-paste beg end))
7920 (when (featurep 'org-agenda)
7921 (org-agenda-save-markers-for-cut-and-paste beg end)))
7923 (defun org-check-and-save-marker (marker beg end)
7924 "Check if MARKER is between BEG and END.
7925 If yes, remember the marker and the distance to BEG."
7926 (when (and (marker-buffer marker)
7927 (equal (marker-buffer marker) (current-buffer)))
7928 (if (and (>= marker beg) (< marker end))
7929 (push (cons marker (- marker beg)) org-markers-to-move))))
7931 (defun org-reinstall-markers-in-region (beg)
7932 "Move all remembered markers to their position relative to BEG."
7933 (mapc (lambda (x)
7934 (move-marker (car x) (+ beg (cdr x))))
7935 org-markers-to-move)
7936 (setq org-markers-to-move nil))
7938 (defun org-narrow-to-subtree ()
7939 "Narrow buffer to the current subtree."
7940 (interactive)
7941 (save-excursion
7942 (save-match-data
7943 (org-with-limited-levels
7944 (narrow-to-region
7945 (progn (org-back-to-heading t) (point))
7946 (progn (org-end-of-subtree t t)
7947 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7948 (point)))))))
7950 (defun org-narrow-to-block ()
7951 "Narrow buffer to the current block."
7952 (interactive)
7953 (let* ((case-fold-search t)
7956 (if blockp
7957 (narrow-to-region (car blockp) (cdr blockp))
7958 (error "Not in a block"))))
7960 (eval-when-compile
7961 (defvar org-property-drawer-re))
7963 (defvar org-property-start-re) ;; defined below
7964 (defun org-clone-subtree-with-time-shift (n &optional shift)
7965 "Clone the task (subtree) at point N times.
7966 The clones will be inserted as siblings.
7968 In interactive use, the user will be prompted for the number of
7969 clones to be produced, and for a time SHIFT, which may be a
7970 repeater as used in time stamps, for example `+3d'.
7972 When a valid repeater is given and the entry contains any time
7973 stamps, the clones will become a sequence in time, with time
7974 stamps in the subtree shifted for each clone produced. If SHIFT
7975 is nil or the empty string, time stamps will be left alone. The
7976 ID property of the original subtree is removed.
7978 If the original subtree did contain time stamps with a repeater,
7979 the following will happen:
7980 - the repeater will be removed in each clone
7981 - an additional clone will be produced, with the current, unshifted
7982 date(s) in the entry.
7983 - the original entry will be placed *after* all the clones, with
7984 repeater intact.
7985 - the start days in the repeater in the original entry will be shifted
7986 to past the last clone.
7987 In this way you can spell out a number of instances of a repeating task,
7988 and still retain the repeater to cover future instances of the task."
7989 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7990 (let (beg end template task idprop
7991 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7992 (drawer-re org-drawer-regexp))
7993 (if (not (and (integerp n) (> n 0)))
7994 (error "Invalid number of replications %s" n))
7997 shift)))
7998 (error "Invalid shift specification %s" shift))
7999 (when doshift
8000 (setq shift-n (string-to-number (match-string 1 shift))
8001 shift-what (cdr (assoc (match-string 2 shift)
8002 '(("d" . day) ("w" . week)
8003 ("m" . month) ("y" . year))))))
8004 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8005 (setq nmin 1 nmax n)
8006 (org-back-to-heading t)
8007 (setq beg (point))
8008 (setq idprop (org-entry-get nil "ID"))
8009 (org-end-of-subtree t t)
8011 (setq end (point))
8012 (setq template (buffer-substring beg end))
8013 (when (and doshift
8015 (delete-region beg end)
8016 (setq end beg)
8017 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8018 (goto-char end)
8019 (loop for n from nmin to nmax do
8020 ;; prepare clone
8021 (with-temp-buffer
8022 (insert template)
8023 (org-mode)
8024 (goto-char (point-min))
8025 (org-show-subtree)
8026 (and idprop (if org-clone-delete-id
8027 (org-entry-delete nil "ID")
8028 (org-id-get-create t)))
8029 (unless (= n 0)
8031 (kill-whole-line))
8032 (goto-char (point-min))
8033 (while (re-search-forward drawer-re nil t)
8034 (mapc (lambda (d)
8035 (org-remove-empty-drawer-at d (point))) org-drawers)))
8036 (goto-char (point-min))
8037 (when doshift
8038 (while (re-search-forward org-ts-regexp-both nil t)
8039 (org-timestamp-change (* n shift-n) shift-what))
8040 (unless (= n n-no-remove)
8041 (goto-char (point-min))
8042 (while (re-search-forward org-ts-regexp nil t)
8043 (save-excursion
8044 (goto-char (match-beginning 0))
8046 (delete-region (match-beginning 1) (match-end 1)))))))
8047 (setq task (buffer-string)))
8048 (insert task))
8049 (goto-char beg)))
8051 ;;; Outline Sorting
8053 (defun org-sort (with-case)
8054 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8055 Optional argument WITH-CASE means sort case-sensitively."
8056 (interactive "P")
8057 (cond
8058 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8059 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8060 (t
8061 (org-call-with-arg 'org-sort-entries with-case))))
8063 (defun org-sort-remove-invisible (s)
8064 (remove-text-properties 0 (length s) org-rm-props s)
8065 (while (string-match org-bracket-link-regexp s)
8066 (setq s (replace-match (if (match-end 2)
8067 (match-string 3 s)
8068 (match-string 1 s)) t t s)))
8069 s)
8071 (defvar org-priority-regexp) ; defined later in the file
8073 (defvar org-after-sorting-entries-or-items-hook nil
8074 "Hook that is run after a bunch of entries or items have been sorted.
8075 When children are sorted, the cursor is in the parent line when this
8076 hook gets called. When a region or a plain list is sorted, the cursor
8077 will be in the first entry of the sorted region/list.")
8079 (defun org-sort-entries
8080 (&optional with-case sorting-type getkey-func compare-func property)
8081 "Sort entries on a certain level of an outline tree.
8082 If there is an active region, the entries in the region are sorted.
8083 Else, if the cursor is before the first entry, sort the top-level items.
8084 Else, the children of the entry at point are sorted.
8086 Sorting can be alphabetically, numerically, by date/time as given by
8087 a time stamp, by a property or by priority.
8089 The command prompts for the sorting type unless it has been given to the
8090 function through the SORTING-TYPE argument, which needs to be a character,
8091 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8092 precise meaning of each character:
8094 n Numerically, by converting the beginning of the entry/item to a number.
8095 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8096 t By date/time, either the first active time stamp in the entry, or, if
8097 none exist, by the first inactive one.
8098 s By the scheduled date/time.
8099 d By deadline date/time.
8100 c By creation time, which is assumed to be the first inactive time stamp
8101 at the beginning of a line.
8102 p By priority according to the cookie.
8103 r By the value of a property.
8105 Capital letters will reverse the sort order.
8107 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8108 called with point at the beginning of the record. It must return either
8109 a string or a number that should serve as the sorting key for that record.
8111 Comparing entries ignores case by default. However, with an optional argument
8112 WITH-CASE, the sorting considers case as well."
8113 (interactive "P")
8114 (let ((case-func (if with-case 'identity 'downcase))
8115 start beg end stars re re2
8116 txt what tmp)
8117 ;; Find beginning and end of region to sort
8118 (cond
8119 ((org-region-active-p)
8120 ;; we will sort the region
8121 (setq end (region-end)
8122 what "region")
8123 (goto-char (region-beginning))
8124 (if (not (org-at-heading-p)) (outline-next-heading))
8125 (setq start (point)))
8126 ((or (org-at-heading-p)
8127 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8128 ;; we will sort the children of the current headline
8129 (org-back-to-heading)
8130 (setq start (point)
8131 end (progn (org-end-of-subtree t t)
8133 (org-back-over-empty-lines)
8134 (point))
8135 what "children")
8136 (goto-char start)
8137 (show-subtree)
8138 (outline-next-heading))
8139 (t
8140 ;; we will sort the top-level entries in this file
8141 (goto-char (point-min))
8142 (or (org-at-heading-p) (outline-next-heading))
8143 (setq start (point))
8144 (goto-char (point-max))
8145 (beginning-of-line 1)
8147 ;; File ends in a non-white line
8148 (end-of-line 1)
8150 (setq end (point-max))
8151 (setq what "top-level")
8152 (goto-char start)
8153 (show-all)))
8155 (setq beg (point))
8156 (if (>= beg end) (error "Nothing to sort"))
8159 (setq stars (match-string 1)
8160 re (concat "^" (regexp-quote stars) " +")
8162 txt (buffer-substring beg end))
8164 (if (and (not (equal stars "*")) (string-match re2 txt))
8165 (error "Region to sort contains a level above the first entry"))
8167 (unless sorting-type
8168 (message
8169 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8171 A/N/T/S/D/C/P/O/F means reversed:"
8172 what)
8173 (setq sorting-type (read-char-exclusive))
8175 (and (= (downcase sorting-type) ?f)
8176 (setq getkey-func
8177 (org-icompleting-read "Sort using function: "
8178 obarray 'fboundp t nil nil))
8179 (setq getkey-func (intern getkey-func)))
8181 (and (= (downcase sorting-type) ?r)
8182 (setq property
8183 (org-icompleting-read "Property: "
8184 (mapcar 'list (org-buffer-property-keys t))
8185 nil t))))
8187 (message "Sorting entries...")
8189 (save-restriction
8190 (narrow-to-region start end)
8191 (let ((dcst (downcase sorting-type))
8192 (case-fold-search nil)
8193 (now (current-time)))
8194 (sort-subr
8195 (/= dcst sorting-type)
8196 ;; This function moves to the beginning character of the "record" to
8197 ;; be sorted.
8198 (lambda nil
8199 (if (re-search-forward re nil t)
8200 (goto-char (match-beginning 0))
8201 (goto-char (point-max))))
8202 ;; This function moves to the last character of the "record" being
8203 ;; sorted.
8204 (lambda nil
8205 (save-match-data
8206 (condition-case nil
8207 (outline-forward-same-level 1)
8208 (error
8209 (goto-char (point-max))))))
8210 ;; This function returns the value that gets sorted against.
8211 (lambda nil
8212 (cond
8213 ((= dcst ?n)
8214 (if (looking-at org-complex-heading-regexp)
8215 (string-to-number (match-string 4))
8216 nil))
8217 ((= dcst ?a)
8218 (if (looking-at org-complex-heading-regexp)
8219 (funcall case-func (match-string 4))
8220 nil))
8221 ((= dcst ?t)
8222 (let ((end (save-excursion (outline-next-heading) (point))))
8223 (if (or (re-search-forward org-ts-regexp end t)
8224 (re-search-forward org-ts-regexp-both end t))
8225 (org-time-string-to-seconds (match-string 0))
8226 (org-float-time now))))
8227 ((= dcst ?c)
8228 (let ((end (save-excursion (outline-next-heading) (point))))
8229 (if (re-search-forward
8231 end t)
8232 (org-time-string-to-seconds (match-string 0))
8233 (org-float-time now))))
8234 ((= dcst ?s)
8235 (let ((end (save-excursion (outline-next-heading) (point))))
8236 (if (re-search-forward org-scheduled-time-regexp end t)
8237 (org-time-string-to-seconds (match-string 1))
8238 (org-float-time now))))
8239 ((= dcst ?d)
8240 (let ((end (save-excursion (outline-next-heading) (point))))
8241 (if (re-search-forward org-deadline-time-regexp end t)
8242 (org-time-string-to-seconds (match-string 1))
8243 (org-float-time now))))
8244 ((= dcst ?p)
8245 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8246 (string-to-char (match-string 2))
8247 org-default-priority))
8248 ((= dcst ?r)
8249 (or (org-entry-get nil property) ""))
8250 ((= dcst ?o)
8251 (if (looking-at org-complex-heading-regexp)
8252 (- 9999 (length (member (match-string 2)
8253 org-todo-keywords-1)))))
8254 ((= dcst ?f)
8255 (if getkey-func
8256 (progn
8257 (setq tmp (funcall getkey-func))
8258 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8259 tmp)
8260 (error "Invalid key function `%s'" getkey-func)))
8261 (t (error "Invalid sorting type `%c'" sorting-type))))
8262 nil
8263 (cond
8264 ((= dcst ?a) 'string<)
8265 ((= dcst ?f) compare-func)
8266 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8267 (t nil)))))
8268 (run-hooks 'org-after-sorting-entries-or-items-hook)
8269 (message "Sorting entries...done")))
8271 (defun org-do-sort (table what &optional with-case sorting-type)
8272 "Sort TABLE of WHAT according to SORTING-TYPE.
8273 The user will be prompted for the SORTING-TYPE if the call to this
8274 function does not specify it. WHAT is only for the prompt, to indicate
8275 what is being sorted. The sorting key will be extracted from
8276 the car of the elements of the table.
8277 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8278 (unless sorting-type
8279 (message
8280 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8281 what)
8282 (setq sorting-type (read-char-exclusive)))
8283 (let ((dcst (downcase sorting-type))
8284 extractfun comparefun)
8285 ;; Define the appropriate functions
8286 (cond
8287 ((= dcst ?n)
8288 (setq extractfun 'string-to-number
8289 comparefun (if (= dcst sorting-type) '< '>)))
8290 ((= dcst ?a)
8291 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8292 (lambda(x) (downcase (org-sort-remove-invisible x))))
8293 comparefun (if (= dcst sorting-type)
8294 'string<
8295 (lambda (a b) (and (not (string< a b))
8296 (not (string= a b)))))))
8297 ((= dcst ?t)
8298 (setq extractfun
8299 (lambda (x)
8300 (if (or (string-match org-ts-regexp x)
8301 (string-match org-ts-regexp-both x))
8302 (org-float-time
8303 (org-time-string-to-time (match-string 0 x)))
8304 0))
8305 comparefun (if (= dcst sorting-type) '< '>)))
8306 (t (error "Invalid sorting type `%c'" sorting-type)))
8308 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8309 table)
8310 (lambda (a b) (funcall comparefun (car a) (car b))))))
8313 ;;; The orgstruct minor mode
8315 ;; Define a minor mode which can be used in other modes in order to
8316 ;; integrate the org-mode structure editing commands.
8318 ;; This is really a hack, because the org-mode structure commands use
8319 ;; keys which normally belong to the major mode. Here is how it
8320 ;; works: The minor mode defines all the keys necessary to operate the
8321 ;; structure commands, but wraps the commands into a function which
8322 ;; tests if the cursor is currently at a headline or a plain list
8323 ;; item. If that is the case, the structure command is used,
8324 ;; temporarily setting many Org-mode variables like regular
8325 ;; expressions for filling etc. However, when any of those keys is
8326 ;; used at a different location, function uses `key-binding' to look
8327 ;; up if the key has an associated command in another currently active
8328 ;; keymap (minor modes, major mode, global), and executes that
8329 ;; command. There might be problems if any of the keys is otherwise
8330 ;; used as a prefix key.
8332 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8333 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8334 ;; addresses this by checking explicitly for both bindings.
8336 (defvar orgstruct-mode-map (make-sparse-keymap)
8337 "Keymap for the minor `orgstruct-mode'.")
8339 (defvar org-local-vars nil
8340 "List of local variables, for use by `orgstruct-mode'.")
8342 ;;;###autoload
8343 (define-minor-mode orgstruct-mode
8344 "Toggle the minor mode `orgstruct-mode'.
8345 This mode is for using Org-mode structure commands in other
8346 modes. The following keys behave as if Org-mode were active, if
8347 the cursor is on a headline, or on a plain list item (both as
8348 defined by Org-mode).
8350 M-up Move entry/item up
8351 M-down Move entry/item down
8352 M-left Promote
8353 M-right Demote
8354 M-S-up Move entry/item up
8355 M-S-down Move entry/item down
8356 M-S-left Promote subtree
8357 M-S-right Demote subtree
8358 M-q Fill paragraph and items like in Org-mode
8359 C-c ^ Sort entries
8360 C-c - Cycle list bullet
8361 TAB Cycle item visibility
8362 M-RET Insert new heading/item
8363 S-M-RET Insert new TODO heading / Checkbox item
8364 C-c C-c Set tags / toggle checkbox"
8365 nil " OrgStruct" nil
8366 (org-load-modules-maybe)
8367 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8369 ;;;###autoload
8370 (defun turn-on-orgstruct ()
8371 "Unconditionally turn on `orgstruct-mode'."
8372 (orgstruct-mode 1))
8374 (defvar org-fb-vars nil)
8375 (make-variable-buffer-local 'org-fb-vars)
8376 (defun orgstruct++-mode (&optional arg)
8377 "Toggle `orgstruct-mode', the enhanced version of it.
8378 In addition to setting orgstruct-mode, this also exports all
8379 indentation and autofilling variables from org-mode into the
8380 buffer. It will also recognize item context in multiline items."
8381 (interactive "P")
8382 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8383 (if (< arg 1)
8384 (progn (orgstruct-mode -1)
8385 (mapc (lambda(v)
8386 (org-set-local (car v)
8387 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8388 org-fb-vars))
8389 (orgstruct-mode 1)
8390 (setq org-fb-vars nil)
8391 (let (var val)
8392 (mapc
8393 (lambda (x)
8394 (when (string-match
8396 (symbol-name (car x)))
8397 (setq var (car x) val (nth 1 x))
8398 (push (list var `(quote ,(eval var))) org-fb-vars)
8399 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8400 org-local-vars)
8401 (org-set-local 'orgstruct-is-++ t))))
8403 (defvar orgstruct-is-++ nil
8404 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8405 (make-variable-buffer-local 'orgstruct-is-++)
8407 ;;;###autoload
8408 (defun turn-on-orgstruct++ ()
8409 "Unconditionally turn on `orgstruct++-mode'."
8410 (orgstruct++-mode 1))
8412 (defun orgstruct-error ()
8413 "Error when there is no default binding for a structure key."
8414 (interactive)
8415 (error "This key has no function outside structure elements"))
8417 (defun orgstruct-setup ()
8418 "Setup orgstruct keymaps."
8419 (let ((nfunc 0)
8420 (bindings
8421 (list
8422 '([(meta up)] org-metaup)
8423 '([(meta down)] org-metadown)
8424 '([(meta left)] org-metaleft)
8425 '([(meta right)] org-metaright)
8426 '([(meta shift up)] org-shiftmetaup)
8427 '([(meta shift down)] org-shiftmetadown)
8428 '([(meta shift left)] org-shiftmetaleft)
8429 '([(meta shift right)] org-shiftmetaright)
8430 '([?\e (up)] org-metaup)
8431 '([?\e (down)] org-metadown)
8432 '([?\e (left)] org-metaleft)
8433 '([?\e (right)] org-metaright)
8434 '([?\e (shift up)] org-shiftmetaup)
8435 '([?\e (shift down)] org-shiftmetadown)
8436 '([?\e (shift left)] org-shiftmetaleft)
8437 '([?\e (shift right)] org-shiftmetaright)
8438 '([(shift up)] org-shiftup)
8439 '([(shift down)] org-shiftdown)
8440 '([(shift left)] org-shiftleft)
8441 '([(shift right)] org-shiftright)
8442 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8443 '("\M-q" fill-paragraph)
8444 '("\C-c^" org-sort)
8445 '("\C-c-" org-cycle-list-bullet)))
8446 elt key fun cmd)
8447 (while (setq elt (pop bindings))
8448 (setq nfunc (1+ nfunc))
8449 (setq key (org-key (car elt))
8450 fun (nth 1 elt)
8451 cmd (orgstruct-make-binding fun nfunc key))
8452 (org-defkey orgstruct-mode-map key cmd))
8454 ;; Special treatment needed for TAB and RET
8455 (org-defkey orgstruct-mode-map [(tab)]
8456 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8457 (org-defkey orgstruct-mode-map "\C-i"
8458 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8460 (org-defkey orgstruct-mode-map "\M-\C-m"
8461 (orgstruct-make-binding 'org-insert-heading 105
8462 "\M-\C-m" [(meta return)]))
8463 (org-defkey orgstruct-mode-map [(meta return)]
8464 (orgstruct-make-binding 'org-insert-heading 106
8465 [(meta return)] "\M-\C-m"))
8467 (org-defkey orgstruct-mode-map [(shift meta return)]
8468 (orgstruct-make-binding 'org-insert-todo-heading 107
8469 [(meta return)] "\M-\C-m"))
8471 (org-defkey orgstruct-mode-map "\e\C-m"
8472 (orgstruct-make-binding 'org-insert-heading 108
8473 "\e\C-m" [?\e (return)]))
8474 (org-defkey orgstruct-mode-map [?\e (return)]
8475 (orgstruct-make-binding 'org-insert-heading 109
8476 [?\e (return)] "\e\C-m"))
8477 (org-defkey orgstruct-mode-map [?\e (shift return)]
8478 (orgstruct-make-binding 'org-insert-todo-heading 110
8479 [?\e (return)] "\e\C-m"))
8481 (unless org-local-vars
8482 (setq org-local-vars (org-get-local-variables)))
8484 t))
8486 (defun orgstruct-make-binding (fun n &rest keys)
8487 "Create a function for binding in the structure minor mode.
8488 FUN is the command to call inside a table. N is used to create a unique
8489 command name. KEYS are keys that should be checked in for a command
8490 to execute outside of tables."
8491 (eval
8492 (list 'defun
8493 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8494 '(arg)
8496 "Outside of structure, run the binding of `"
8497 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8498 "'.")
8499 '(interactive "p")
8500 (list 'if
8501 `(org-context-p 'headline 'item
8502 (and orgstruct-is-++
8503 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8504 'item-body))
8505 (list 'org-run-like-in-org-mode (list 'quote fun))
8506 (list 'let '(orgstruct-mode)
8507 (list 'call-interactively
8508 (append '(or)
8509 (mapcar (lambda (k)
8510 (list 'key-binding k))
8511 keys)
8512 '('orgstruct-error))))))))
8514 (defun org-context-p (&rest contexts)
8515 "Check if local context is any of CONTEXTS.
8516 Possible values in the list of contexts are `table', `headline', and `item'."
8517 (let ((pos (point)))
8518 (goto-char (point-at-bol))
8519 (prog1 (or (and (memq 'table contexts)
8521 (and (memq 'headline contexts)
8522 (looking-at org-outline-regexp))
8523 (and (memq 'item contexts)
8525 (and (memq 'item-body contexts)
8526 (org-in-item-p)))
8527 (goto-char pos))))
8529 (defun org-get-local-variables ()
8530 "Return a list of all local variables in an org-mode buffer."
8531 (let (varlist)
8532 (with-current-buffer (get-buffer-create "*Org tmp*")
8533 (erase-buffer)
8534 (org-mode)
8535 (setq varlist (buffer-local-variables)))
8536 (kill-buffer "*Org tmp*")
8537 (delq nil
8538 (mapcar
8539 (lambda (x)
8540 (setq x
8541 (if (symbolp x)
8542 (list x)
8543 (list (car x) (list 'quote (cdr x)))))
8544 (if (string-match
8545 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8546 (symbol-name (car x)))
8547 x nil))
8548 varlist))))
8550 (defun org-clone-local-variables (from-buffer &optional regexp)
8551 "Clone local variables from FROM-BUFFER.
8552 Optional argument REGEXP selects variables to clone."
8553 (mapc
8554 (lambda (pair)
8555 (and (symbolp (car pair))
8556 (or (null regexp)
8557 (string-match regexp (symbol-name (car pair))))
8558 (set (make-local-variable (car pair))
8559 (cdr pair))))
8560 (buffer-local-variables from-buffer)))
8562 ;;;###autoload
8563 (defun org-run-like-in-org-mode (cmd)
8564 "Run a command, pretending that the current buffer is in Org-mode.
8565 This will temporarily bind local variables that are typically bound in
8566 Org-mode to the values they have in Org-mode, and then interactively
8567 call CMD."
8568 (org-load-modules-maybe)
8569 (unless org-local-vars
8570 (setq org-local-vars (org-get-local-variables)))
8571 (eval (list 'let org-local-vars
8572 (list 'call-interactively (list 'quote cmd)))))
8574 ;;;; Archiving
8576 (defun org-get-category (&optional pos force-refresh)
8577 "Get the category applying to position POS."
8578 (save-match-data
8579 (if force-refresh (org-refresh-category-properties))
8580 (let ((pos (or pos (point))))
8581 (or (get-text-property pos 'org-category)
8582 (progn (org-refresh-category-properties)
8583 (get-text-property pos 'org-category))))))
8585 (defun org-refresh-category-properties ()
8586 "Refresh category text properties in the buffer."
8587 (let ((inhibit-read-only t)
8588 (def-cat (cond
8589 ((null org-category)
8590 (if buffer-file-name
8591 (file-name-sans-extension
8592 (file-name-nondirectory buffer-file-name))
8593 "???"))
8594 ((symbolp org-category) (symbol-name org-category))
8595 (t org-category)))
8596 beg end cat pos optionp)
8597 (org-unmodified
8598 (save-excursion
8599 (save-restriction
8600 (widen)
8601 (goto-char (point-min))
8602 (put-text-property (point) (point-max) 'org-category def-cat)
8603 (while (re-search-forward
8605 (setq pos (match-end 0)
8606 optionp (equal (char-after (match-beginning 0)) ?#)
8607 cat (org-trim (match-string 2)))
8608 (if optionp
8609 (setq beg (point-at-bol) end (point-max))
8610 (org-back-to-heading t)
8611 (setq beg (point) end (org-end-of-subtree t t)))
8612 (put-text-property beg end 'org-category cat)
8613 (put-text-property beg end 'org-category-position beg)
8614 (goto-char pos)))))))
8617 ;;;; Link Stuff
8619 ;;; Link abbreviations
8621 (defun org-link-expand-abbrev (link)
8622 "Apply replacements as defined in `org-link-abbrev-alist'."
8624 (let* ((key (match-string 1 link))
8625 (as (or (assoc key org-link-abbrev-alist-local)
8626 (assoc key org-link-abbrev-alist)))
8627 (tag (and (match-end 2) (match-string 3 link)))
8628 rpl)
8629 (if (not as)
8630 link
8631 (setq rpl (cdr as))
8632 (cond
8633 ((symbolp rpl) (funcall rpl tag))
8634 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8635 ((string-match "%h" rpl)
8636 (replace-match (url-hexify-string (or tag "")) t t rpl))
8637 (t (concat rpl tag)))))
8638 link))
8640 ;;; Storing and inserting links
8642 (defvar org-insert-link-history nil
8643 "Minibuffer history for links inserted with `org-insert-link'.")
8645 (defvar org-stored-links nil
8646 "Contains the links stored with `org-store-link'.")
8648 (defvar org-store-link-plist nil
8649 "Plist with info about the most recently link created with `org-store-link'.")
8651 (defvar org-link-protocols nil
8652 "Link protocols added to Org-mode using `org-add-link-type'.")
8654 (defvar org-store-link-functions nil
8655 "List of functions that are called to create and store a link.
8656 Each function will be called in turn until one returns a non-nil
8657 value. Each function should check if it is responsible for creating
8658 this link (for example by looking at the major mode).
8659 If not, it must exit and return nil.
8660 If yes, it should return a non-nil value after a calling
8661 `org-store-link-props' with a list of properties and values.
8662 Special properties are:
8666 This is obligatory as well.
8667 :description Optional default description for the second pair
8668 of brackets in an Org-mode link. The user can still change
8669 this when inserting this link into an Org-mode buffer.
8671 In addition to these, any additional properties can be specified
8672 and then used in remember templates.")
8674 (defun org-add-link-type (type &optional follow export)
8675 "Add TYPE to the list of `org-link-types'.
8676 Re-compute all regular expressions depending on `org-link-types'
8678 FOLLOW and EXPORT are two functions.
8680 FOLLOW should take the link path as the single argument and do whatever
8681 is necessary to follow the link, for example find a file or display
8682 a mail message.
8684 EXPORT should format the link path for export to one of the export formats.
8685 It should be a function accepting three arguments:
8688 desc the description of the link, if any, or a description added by
8689 org-export-normalize-links if there is none
8690 format the export format, a symbol like `html' or `latex' or `ascii'..
8692 The function may use the FORMAT information to return different values
8693 depending on the format. The return value will be put literally into
8694 the exported file. If the return value is nil, this means Org should
8695 do what it normally does with links which do not have EXPORT defined.
8697 Org-mode has a built-in default for exporting links. If you are happy with
8698 this default, there is no need to define an export function for the link
8699 type. For a simple example of an export function, see `org-bbdb.el'."
8700 (add-to-list 'org-link-types type t)
8701 (org-make-link-regexps)
8702 (if (assoc type org-link-protocols)
8703 (setcdr (assoc type org-link-protocols) (list follow export))
8704 (push (list type follow export) org-link-protocols)))
8706 (defvar org-agenda-buffer-name)
8708 ;;;###autoload
8709 (defun org-store-link (arg)
8711 This link is added to `org-stored-links' and can later be inserted
8714 For some link types, a prefix arg is interpreted:
8715 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8716 For file links, arg negates `org-context-in-file-links'."
8717 (interactive "P")
8718 (org-load-modules-maybe)
8719 (setq org-store-link-plist nil) ; reset
8720 (org-with-limited-levels
8721 (let (link cpltxt desc description search txt custom-id agenda-link)
8722 (cond
8724 ((run-hook-with-args-until-success 'org-store-link-functions)
8725 (setq link (plist-get org-store-link-plist :link)
8726 desc (or (plist-get org-store-link-plist :description) link)))
8728 ((org-src-edit-buffer-p)
8729 (let (label gc)
8730 (while (or (not label)
8731 (save-excursion
8732 (save-restriction
8733 (widen)
8734 (goto-char (point-min))
8735 (re-search-forward
8736 (regexp-quote (format org-coderef-label-format label))
8737 nil t))))
8738 (when label (message "Label exists already") (sit-for 2))
8739 (setq label (read-string "Code line label: " label)))
8740 (end-of-line 1)
8741 (setq link (format org-coderef-label-format label))
8742 (setq gc (- 79 (length link)))
8743 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8744 (insert link)
8745 (setq link (concat "(" label ")") desc nil)))
8747 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8748 ;; We are in the agenda, link to referenced location
8749 (let ((m (or (get-text-property (point) 'org-hd-marker)
8750 (get-text-property (point) 'org-marker))))
8751 (when m
8752 (org-with-point-at m
8753 (setq agenda-link
8754 (if (org-called-interactively-p 'any)
8755 (call-interactively 'org-store-link)
8756 (org-store-link nil)))))))
8758 ((eq major-mode 'calendar-mode)
8759 (let ((cd (calendar-cursor-to-date)))
8760 (setq link
8761 (format-time-string
8762 (car org-time-stamp-formats)
8763 (apply 'encode-time
8764 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8765 nil nil nil))))
8766 (org-store-link-props :type "calendar" :date cd)))
8768 ((eq major-mode 'w3-mode)
8769 (setq cpltxt (if (and (buffer-name)
8770 (not (string-match "Untitled" (buffer-name))))
8771 (buffer-name)
8772 (url-view-url t))
8773 link (org-make-link (url-view-url t)))
8774 (org-store-link-props :type "w3" :url (url-view-url t)))
8776 ((eq major-mode 'w3m-mode)
8777 (setq cpltxt (or w3m-current-title w3m-current-url)
8778 link (org-make-link w3m-current-url))
8779 (org-store-link-props :type "w3m" :url (url-view-url t)))
8781 ((setq search (run-hook-with-args-until-success
8782 'org-create-file-search-functions))
8783 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8784 "::" search))
8785 (setq cpltxt (or description link)))
8787 ((eq major-mode 'image-mode)
8788 (setq cpltxt (concat "file:"
8789 (abbreviate-file-name buffer-file-name))
8790 link (org-make-link cpltxt))
8791 (org-store-link-props :type "image" :file buffer-file-name))
8793 ((eq major-mode 'dired-mode)
8794 ;; link to the file in the current line
8795 (let ((file (dired-get-filename nil t)))
8796 (setq file (if file
8797 (abbreviate-file-name
8798 (expand-file-name (dired-get-filename nil t)))
8799 ;; otherwise, no file so use current directory.
8800 default-directory))
8801 (setq cpltxt (concat "file:" file)
8802 link (org-make-link cpltxt))))
8804 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
8805 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8806 (cond
8808 (setq cpltxt
8809 (concat "file:"
8810 (abbreviate-file-name
8811 (buffer-file-name (buffer-base-buffer)))
8812 "::" (match-string 1))
8813 link (org-make-link cpltxt)))
8814 ((and (featurep 'org-id)
8815 (or (eq org-link-to-org-use-id t)
8816 (and (eq org-link-to-org-use-id 'create-if-interactive)
8817 (org-called-interactively-p 'any))
8818 (and (eq org-link-to-org-use-id
8819 'create-if-interactive-and-no-custom-id)
8820 (org-called-interactively-p 'any)
8821 (not custom-id))
8822 (and org-link-to-org-use-id
8823 (org-entry-get nil "ID"))))
8824 ;; We can make a link using the ID.
8825 (setq link (condition-case nil
8826 (prog1 (org-id-store-link)
8827 (setq desc (plist-get org-store-link-plist
8828 :description)))
8829 (error
8830 ;; probably before first headline, link to file only
8831 (concat "file:"
8832 (abbreviate-file-name
8833 (buffer-file-name (buffer-base-buffer))))))))
8834 (t
8835 ;; Just link to current headline
8836 (setq cpltxt (concat "file:"
8837 (abbreviate-file-name
8838 (buffer-file-name (buffer-base-buffer)))))
8839 ;; Add a context search string
8840 (when (org-xor org-context-in-file-links arg)
8841 (setq txt (cond
8842 ((org-at-heading-p) nil)
8843 ((org-region-active-p)
8844 (buffer-substring (region-beginning) (region-end)))
8845 (t nil)))
8847 (setq cpltxt
8848 (concat cpltxt "::"
8849 (condition-case nil
8850 (org-make-org-heading-search-string txt)
8851 (error "")))
8852 desc (or (nth 4 (ignore-errors
8853 (org-heading-components))) "NONE"))))
8855 (setq cpltxt (substring cpltxt 0 -2)))
8856 (setq link (org-make-link cpltxt)))))
8858 ((buffer-file-name (buffer-base-buffer))
8859 ;; Just link to this file here.
8860 (setq cpltxt (concat "file:"
8861 (abbreviate-file-name
8862 (buffer-file-name (buffer-base-buffer)))))
8863 ;; Add a context string
8864 (when (org-xor org-context-in-file-links arg)
8865 (setq txt (if (org-region-active-p)
8866 (buffer-substring (region-beginning) (region-end))
8867 (buffer-substring (point-at-bol) (point-at-eol))))
8868 ;; Only use search option if there is some text.
8870 (setq cpltxt
8871 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8872 desc "NONE")))
8873 (setq link (org-make-link cpltxt)))
8875 ((org-called-interactively-p 'interactive)
8876 (error "Cannot link to a buffer which is not visiting a file"))
8878 (t (setq link nil)))
8880 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8881 (setq link (or link cpltxt)
8882 desc (or desc cpltxt))
8883 (if (equal desc "NONE") (setq desc nil))
8885 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8886 (progn
8887 (setq org-stored-links
8888 (cons (list link desc) org-stored-links))
8889 (message "Stored: %s" (or desc link))
8890 (when custom-id
8891 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8892 "::#" custom-id))
8893 (setq org-stored-links
8894 (cons (list link desc) org-stored-links))))
8895 (or agenda-link (and link (org-make-link-string link desc)))))))
8897 (defun org-store-link-props (&rest plist)
8898 "Store link properties, extract names and addresses."
8899 (let (x adr)
8900 (when (setq x (plist-get plist :from))
8901 (setq adr (mail-extract-address-components x))
8902 (setq plist (plist-put plist :fromname (car adr)))
8903 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8904 (when (setq x (plist-get plist :to))
8905 (setq adr (mail-extract-address-components x))
8906 (setq plist (plist-put plist :toname (car adr)))
8907 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8908 (let ((from (plist-get plist :from))
8909 (to (plist-get plist :to)))
8910 (when (and from to org-from-is-user-regexp)
8911 (setq plist
8912 (plist-put plist :fromto
8913 (if (string-match org-from-is-user-regexp from)
8914 (concat "to %t")
8915 (concat "from %f"))))))
8916 (setq org-store-link-plist plist))
8918 (defun org-add-link-props (&rest plist)
8919 "Add these properties to the link property list."
8920 (let (key value)
8921 (while plist
8922 (setq key (pop plist) value (pop plist))
8923 (setq org-store-link-plist
8924 (plist-put org-store-link-plist key value)))))
8926 (defun org-email-link-description (&optional fmt)
8927 "Return the description part of an email link.
8928 This takes information from `org-store-link-plist' and formats it
8929 according to FMT (default from `org-email-link-description-format')."
8930 (setq fmt (or fmt org-email-link-description-format))
8931 (let* ((p org-store-link-plist)
8932 (to (plist-get p :toaddress))
8933 (from (plist-get p :fromaddress))
8934 (table
8935 (list
8936 (cons "%c" (plist-get p :fromto))
8937 (cons "%F" (plist-get p :from))
8938 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8939 (cons "%T" (plist-get p :to))
8940 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8941 (cons "%s" (plist-get p :subject))
8942 (cons "%d" (plist-get p :date))
8943 (cons "%m" (plist-get p :message-id)))))
8944 (when (string-match "%c" fmt)
8945 ;; Check if the user wrote this message
8946 (if (and org-from-is-user-regexp from to
8947 (save-match-data (string-match org-from-is-user-regexp from)))
8948 (setq fmt (replace-match "to %t" t t fmt))
8949 (setq fmt (replace-match "from %f" t t fmt))))
8950 (org-replace-escapes fmt table)))
8952 (defun org-make-org-heading-search-string (&optional string heading)
8953 "Make search string for STRING or current headline."
8954 (interactive)
8955 (let ((s (or string (org-get-heading)))
8956 (lines org-context-in-file-links))
8957 (unless (and string (not heading))
8958 ;; We are using a headline, clean up garbage in there.
8959 (if (string-match org-todo-regexp s)
8960 (setq s (replace-match "" t t s)))
8962 (setq s (replace-match "" t t s)))
8963 (setq s (org-trim s))
8966 (setq s (replace-match "" t t s)))
8967 (while (string-match org-ts-regexp s)
8968 (setq s (replace-match "" t t s))))
8969 (or string (setq s (concat "*" s))) ; Add * for headlines
8970 (when (and string (integerp lines) (> lines 0))
8972 (when (< lines (length slines))
8973 (setq s (mapconcat
8974 'identity
8975 (reverse (nthcdr (- (length slines) lines)
8979 (defun org-make-link (&rest strings)
8980 "Concatenate STRINGS."
8981 (apply 'concat strings))
8983 (defun org-make-link-string (link &optional description)
8984 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8986 (error "Empty link"))
8987 (when (and description
8988 (stringp description)
8990 (setq description nil))
8991 (when (stringp description)
8992 ;; Remove brackets from the description, they are fatal.
8994 (setq description (replace-match "{" t t description)))
8996 (setq description (replace-match "}" t t description))))
8997 (when (equal link description)
8998 ;; No description needed, it is identical
8999 (setq description nil))
9000 (when (and (not description)
9001 (not (string-match (org-image-file-name-regexp) link))
9002 (not (equal link (org-link-escape link))))
9003 (setq description (org-extract-attributes link)))
9004 (setq link
9005 (cond ((string-match (org-image-file-name-regexp) link) link)
9006 ((string-match org-link-types-re link)
9007 (concat (match-string 1 link)
9008 (org-link-escape (substring link (match-end 1)))))
9009 (t (org-link-escape link))))
9010 (concat "[[" link "]"
9011 (if description (concat "[" description "]") "")
9012 "]"))
9014 (defconst org-link-escape-chars
9015 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9016 "List of characters that should be escaped in link.
9017 This is the list that is used for internal purposes.")
9019 (defvar org-url-encoding-use-url-hexify nil)
9021 (defconst org-link-escape-chars-browser
9022 '(?\ )
9023 "List of escapes for characters that are problematic in links.
9024 This is the list that is used before handing over to the browser.")
9026 (defun org-link-escape (text &optional table merge)
9027 "Return percent escaped representation of TEXT.
9028 TEXT is a string with the text to escape.
9029 Optional argument TABLE is a list with characters that should be
9030 escaped. When nil, `org-link-escape-chars' is used.
9031 If optional argument MERGE is set, merge TABLE into
9032 `org-link-escape-chars'."
9033 (if (and org-url-encoding-use-url-hexify (not table))
9034 (url-hexify-string text)
9035 (cond
9036 ((and table merge)
9037 (mapc (lambda (defchr)
9038 (unless (member defchr table)
9039 (setq table (cons defchr table)))) org-link-escape-chars))
9040 ((null table)
9041 (setq table org-link-escape-chars)))
9042 (mapconcat
9043 (lambda (char)
9044 (if (or (member char table)
9045 (< char 32) (= char 37) (> char 126))
9046 (mapconcat (lambda (sequence-element)
9047 (format "%%%.2X" sequence-element))
9048 (or (encode-coding-char char 'utf-8)
9049 (error "Unable to percent escape character: %s"
9050 (char-to-string char))) "")
9051 (char-to-string char))) text "")))
9053 (defun org-link-unescape (str)
9054 "Unhex hexified Unicode strings as returned from the JavaScript function
9055 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
9056 (unless (and (null str) (string= "" str))
9057 (let ((pos 0) (case-fold-search t) unhexed)
9059 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9060 (setq str (replace-match unhexed t t str))
9061 (setq pos (+ pos (length unhexed))))))
9062 str)
9064 (defun org-link-unescape-compound (hex)
9065 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
9066 Note: this function also decodes single byte encodings like
9068 (save-match-data
9069 (let* ((bytes (cdr (split-string hex "%")))
9070 (ret "")
9071 (eat 0)
9072 (sum 0))
9073 (while bytes
9074 (let* ((val (string-to-number (pop bytes) 16))
9075 (shift-xor
9076 (if (= 0 eat)
9077 (cond
9078 ((>= val 252) (cons 6 252))
9079 ((>= val 248) (cons 5 248))
9080 ((>= val 240) (cons 4 240))
9081 ((>= val 224) (cons 3 224))
9082 ((>= val 192) (cons 2 192))
9083 (t (cons 0 0)))
9084 (cons 6 128))))
9085 (if (>= val 192) (setq eat (car shift-xor)))
9086 (setq val (logxor val (cdr shift-xor)))
9087 (setq sum (+ (lsh sum (car shift-xor)) val))
9088 (if (> eat 0) (setq eat (- eat 1)))
9089 (cond
9090 ((= 0 eat) ;multi byte
9091 (setq ret (concat ret (org-char-to-string sum)))
9092 (setq sum 0))
9093 ((not bytes) ; single byte(s)
9094 (setq ret (org-link-unescape-single-byte-sequence hex))))
9095 )) ;; end (while bytes
9096 ret )))
9098 (defun org-link-unescape-single-byte-sequence (hex)
9099 "Unhexify hex-encoded single byte character sequences."
9100 (mapconcat (lambda (byte)
9101 (char-to-string (string-to-number byte 16)))
9102 (cdr (split-string hex "%")) ""))
9104 (defun org-xor (a b)
9105 "Exclusive or."
9106 (if a (not b) b))
9108 (defun org-fixup-message-id-for-http (s)
9109 "Replace special characters in a message id, so it can be used in an http query."
9110 (when (string-match "%" s)
9111 (setq s (mapconcat (lambda (c)
9112 (if (eq c ?%)
9113 "%25"
9114 (char-to-string c)))
9115 s "")))
9116 (while (string-match "<" s)
9117 (setq s (replace-match "%3C" t t s)))
9118 (while (string-match ">" s)
9119 (setq s (replace-match "%3E" t t s)))
9120 (while (string-match "@" s)
9121 (setq s (replace-match "%40" t t s)))
9122 s)
9124 (defun org-link-prettify (link)
9125 "Return a human-readable representation of LINK.
9126 The car of LINK must be a raw link the cdr of LINK must be either
9127 a link description or nil."
9128 (let ((desc (or (cadr link) "<no description>")))
9129 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9130 "[[" (car link) "]]")))
9132 ;;;###autoload
9133 (defun org-insert-link-global ()
9134 "Insert a link like Org-mode does.
9135 This command can be called in any mode to insert a link in Org-mode syntax."
9136 (interactive)
9137 (org-load-modules-maybe)
9138 (org-run-like-in-org-mode 'org-insert-link))
9140 (defun org-insert-link (&optional complete-file link-location default-description)
9141 "Insert a link. At the prompt, enter the link.
9143 Completion can be used to insert any of the link protocol prefixes like
9144 http or ftp in use.
9146 The history can be used to select a link previously stored with
9147 `org-store-link'. When the empty string is entered (i.e. if you just
9148 press RET at the prompt), the link defaults to the most recently
9149 stored link. As SPC triggers completion in the minibuffer, you need to
9150 use M-SPC or C-q SPC to force the insertion of a space character.
9152 You will also be prompted for a description, and if one is given, it will
9153 be displayed in the buffer instead of the link.
9155 If there is already a link at point, this command will allow you to edit link
9156 and description parts.
9159 be selected using completion. The path to the file will be relative to the
9160 current directory if the file is in the current directory or a subdirectory.
9161 Otherwise, the link will be the absolute path as completed in the minibuffer
9162 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9163 option `org-link-file-path-type'.
9166 the current directory or below.
9169 `org-keep-stored-link-after-insertion'.
9171 If `org-make-link-description-function' is non-nil, this function will be
9172 called with the link target, and the result will be the default
9173 link description.
9175 If the LINK-LOCATION parameter is non-nil, this value will be
9176 used as the link location instead of reading one interactively.
9178 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9179 be used as the default description."
9180 (interactive "P")
9181 (let* ((wcf (current-window-configuration))
9182 (region (if (org-region-active-p)
9183 (buffer-substring (region-beginning) (region-end))))
9184 (remove (and region (list (region-beginning) (region-end))))
9185 (desc region)
9186 tmphist ; byte-compile incorrectly complains about this
9187 (link link-location)
9188 entry file all-prefixes)
9189 (cond
9190 (link-location) ; specified by arg, just use it.
9191 ((org-in-regexp org-bracket-link-regexp 1)
9192 ;; We do have a link at point, and we are going to edit it.
9193 (setq remove (list (match-beginning 0) (match-end 0)))
9194 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9195 (setq link (read-string "Link: "
9196 (org-link-unescape
9197 (org-match-string-no-properties 1)))))
9198 ((or (org-in-regexp org-angle-link-re)
9199 (org-in-regexp org-plain-link-re))
9200 ;; Convert to bracket link
9201 (setq remove (list (match-beginning 0) (match-end 0))
9202 link (read-string "Link: "
9203 (org-remove-angle-brackets (match-string 0)))))
9204 ((member complete-file '((4) (16)))
9205 ;; Completing read for file names.
9206 (setq link (org-file-complete-link complete-file)))
9207 (t
9208 ;; Read link, with completion for stored links.
9209 (with-output-to-temp-buffer "*Org Links*"
9210 (princ "Insert a link.
9212 (when org-stored-links
9214 (princ (mapconcat 'org-link-prettify
9216 (let ((cw (selected-window)))
9217 (select-window (get-buffer-window "*Org Links*" 'visible))
9218 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9219 (unless (pos-visible-in-window-p (point-max))
9220 (org-fit-window-to-buffer))
9221 (and (window-live-p cw) (select-window cw)))
9222 ;; Fake a link history, containing the stored links.
9223 (setq tmphist (append (mapcar 'car org-stored-links)
9224 org-insert-link-history))
9225 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9226 (mapcar 'car org-link-abbrev-alist)
9227 org-link-types))
9228 (unwind-protect
9229 (progn
9230 (setq link
9231 (let ((org-completion-use-ido nil)
9232 (org-completion-use-iswitchb nil))
9233 (org-completing-read
9234 "Link: "
9235 (append
9236 (mapcar (lambda (x) (list (concat x ":")))
9237 all-prefixes)
9238 (mapcar 'car org-stored-links))
9239 nil nil nil
9240 'tmphist
9241 (car (car org-stored-links)))))
9243 (error "No link selected"))
9244 (if (or (member link all-prefixes)
9245 (and (equal ":" (substring link -1))
9246 (member (substring link 0 -1) all-prefixes)
9247 (setq link (substring link 0 -1))))
9248 (setq link (org-link-try-special-completion link))))
9249 (set-window-configuration wcf)
9250 (kill-buffer "*Org Links*"))
9251 (setq entry (assoc link org-stored-links))
9252 (or entry (push link org-insert-link-history))
9253 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9254 (not org-keep-stored-link-after-insertion))
9255 (setq org-stored-links (delq (assoc link org-stored-links)
9256 org-stored-links)))
9257 (setq desc (or desc (nth 1 entry)))))
9259 (if (string-match org-plain-link-re link)
9260 ;; URL-like link, normalize the use of angular brackets.
9261 (setq link (org-make-link (org-remove-angle-brackets link))))
9263 ;; Check if we are linking to the current file with a search option
9264 ;; If yes, simplify the link by using only the search option.
9265 (when (and buffer-file-name
9267 (let* ((path (match-string 1 link))
9268 (case-fold-search nil)
9269 (search (match-string 2 link)))
9270 (save-match-data
9271 (if (equal (file-truename buffer-file-name) (file-truename path))
9272 ;; We are linking to this same file, with a search option
9273 (setq link search)))))
9275 ;; Check if we can/should use a relative path. If yes, simplify the link
9277 (let* ((type (match-string 1 link))
9278 (path (match-string 2 link))
9279 (origpath path)
9280 (case-fold-search nil))
9281 (cond
9282 ((or (eq org-link-file-path-type 'absolute)
9283 (equal complete-file '(16)))
9284 (setq path (abbreviate-file-name (expand-file-name path))))
9285 ((eq org-link-file-path-type 'noabbrev)
9286 (setq path (expand-file-name path)))
9287 ((eq org-link-file-path-type 'relative)
9288 (setq path (file-relative-name path)))
9289 (t
9290 (save-match-data
9291 (if (string-match (concat "^" (regexp-quote
9292 (expand-file-name
9293 (file-name-as-directory
9294 default-directory))))
9295 (expand-file-name path))
9296 ;; We are linking a file with relative path name.
9297 (setq path (substring (expand-file-name path)
9298 (match-end 0)))
9299 (setq path (abbreviate-file-name (expand-file-name path)))))))
9300 (setq link (concat type path))
9301 (if (equal desc origpath)
9302 (setq desc path))))
9304 (if org-make-link-description-function
9305 (setq desc (funcall org-make-link-description-function link desc))
9306 (if default-description (setq desc default-description)))
9308 (setq desc (read-string "Description: " desc))
9310 (if remove (apply 'delete-region remove))
9311 (insert (org-make-link-string link desc))))
9313 (defun org-link-try-special-completion (type)
9314 "If there is completion support for link type TYPE, offer it."
9315 (let ((fun (intern (concat "org-" type "-complete-link"))))
9316 (if (functionp fun)
9317 (funcall fun)
9318 (read-string "Link (no completion support): " (concat type ":")))))
9320 (defun org-file-complete-link (&optional arg)
9321 "Create a file link using completion."
9322 (let (file link)
9323 (setq file (read-file-name "File: "))
9324 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9325 (pwd1 (file-name-as-directory (abbreviate-file-name
9326 (expand-file-name ".")))))
9327 (cond
9328 ((equal arg '(16))
9329 (setq link (org-make-link
9330 "file:"
9331 (abbreviate-file-name (expand-file-name file)))))
9333 (setq link (org-make-link "file:" (match-string 1 file))))
9335 (expand-file-name file))
9336 (setq link (org-make-link
9337 "file:" (match-string 1 (expand-file-name file)))))
9338 (t (setq link (org-make-link "file:" file)))))
9339 link))
9341 (defun org-completing-read (&rest args)
9342 "Completing-read with SPACE being a normal character."
9343 (let ((enable-recursive-minibuffers t)
9344 (minibuffer-local-completion-map
9345 (copy-keymap minibuffer-local-completion-map)))
9346 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9347 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9348 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9349 (apply 'org-icompleting-read args)))
9351 (defun org-completing-read-no-i (&rest args)
9352 (let (org-completion-use-ido org-completion-use-iswitchb)
9353 (apply 'org-completing-read args)))
9355 (defun org-iswitchb-completing-read (prompt choices &rest args)
9356 "Use iswitch as a completing-read replacement to choose from choices.
9357 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9358 from."
9359 (let* ((iswitchb-use-virtual-buffers nil)
9360 (iswitchb-make-buflist-hook
9361 (lambda ()
9362 (setq iswitchb-temp-buflist choices))))
9363 (iswitchb-read-buffer prompt)))
9365 (defun org-icompleting-read (&rest args)
9366 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9367 (org-without-partial-completion
9368 (if (and org-completion-use-ido
9369 (fboundp 'ido-completing-read)
9370 (boundp 'ido-mode) ido-mode
9371 (listp (second args)))
9372 (let ((ido-enter-matching-directory nil))
9373 (apply 'ido-completing-read (concat (car args))
9374 (if (consp (car (nth 1 args)))
9375 (mapcar 'car (nth 1 args))
9376 (nth 1 args))
9377 (cddr args)))
9378 (if (and org-completion-use-iswitchb
9379 (boundp 'iswitchb-mode) iswitchb-mode
9380 (listp (second args)))
9381 (apply 'org-iswitchb-completing-read (concat (car args))
9382 (if (consp (car (nth 1 args)))
9383 (mapcar 'car (nth 1 args))
9384 (nth 1 args))
9385 (cddr args))
9386 (apply 'completing-read args)))))
9388 (defun org-extract-attributes (s)
9389 "Extract the attributes cookie from a string and set as text property."
9390 (let (a attr (start 0) key value)
9391 (save-match-data
9393 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9395 (setq key (match-string 1 a) value (match-string 2 a)
9396 start (match-end 0)
9397 attr (plist-put attr (intern key) value))))
9398 (org-add-props s nil 'org-attr attr))
9399 s))
9401 (defun org-extract-attributes-from-string (tag)
9402 (let (key value attr)
9404 (setq key (match-string 1 tag) value (match-string 2 tag)
9405 tag (replace-match "" t t tag)
9406 attr (plist-put attr (intern key) value)))
9407 (cons tag attr)))
9409 (defun org-attributes-to-string (plist)
9410 "Format a property list into an HTML attribute list."
9411 (let ((s "") key value)
9412 (while plist
9413 (setq key (pop plist) value (pop plist))
9414 (and value
9416 s))
9418 ;;; Opening/following a link
9420 (defvar org-link-search-failed nil)
9422 (defvar org-open-link-functions nil
9423 "Hook for functions finding a plain text link.
9424 These functions must take a single argument, the link content.
9425 They will be called for links that look like [[link text][description]]
9429 These functions will be called *before* Org attempts to resolve the
9430 link by doing text searches in the current buffer - so if you want a
9432 handle this as a special case.
9434 When the function does handle the link, it must return a non-nil value.
9435 If it decides that it is not responsible for this link, it must return
9436 nil to indicate that that Org-mode can continue with other options
9437 like exact and fuzzy text search.")
9439 (defun org-next-link ()
9440 "Move forward to the next link.
9441 If the link is in hidden text, expose it."
9442 (interactive)
9443 (when (and org-link-search-failed (eq this-command last-command))
9444 (goto-char (point-min))
9445 (message "Link search wrapped back to beginning of buffer"))
9446 (setq org-link-search-failed nil)
9447 (let* ((pos (point))
9448 (ct (org-context))
9449 (a (assoc :link ct)))
9450 (if a (goto-char (nth 2 a)))
9451 (if (re-search-forward org-any-link-re nil t)
9452 (progn
9453 (goto-char (match-beginning 0))
9454 (if (outline-invisible-p) (org-show-context)))
9455 (goto-char pos)
9456 (setq org-link-search-failed t)
9457 (error "No further link found"))))
9459 (defun org-previous-link ()
9460 "Move backward to the previous link.
9461 If the link is in hidden text, expose it."
9462 (interactive)
9463 (when (and org-link-search-failed (eq this-command last-command))
9464 (goto-char (point-max))
9465 (message "Link search wrapped back to end of buffer"))
9466 (setq org-link-search-failed nil)
9467 (let* ((pos (point))
9468 (ct (org-context))
9469 (a (assoc :link ct)))
9470 (if a (goto-char (nth 1 a)))
9471 (if (re-search-backward org-any-link-re nil t)
9472 (progn
9473 (goto-char (match-beginning 0))
9474 (if (outline-invisible-p) (org-show-context)))
9475 (goto-char pos)
9476 (setq org-link-search-failed t)
9477 (error "No further link found"))))
9479 (defun org-translate-link (s)
9480 "Translate a link string if a translation function has been defined."
9481 (if (and org-link-translation-function
9482 (fboundp org-link-translation-function)
9484 (progn
9485 (setq s (funcall org-link-translation-function
9486 (match-string 1 s) (match-string 2 s)))
9487 (concat (car s) ":" (cdr s)))
9488 s))
9490 (defun org-translate-link-from-planner (type path)
9491 "Translate a link from Emacs Planner syntax so that Org can follow it.
9492 This is still an experimental function, your mileage may vary."
9493 (cond
9494 ((member type '("http" "https" "news" "ftp"))
9495 ;; standard Internet links are the same.
9496 nil)
9497 ((and (equal type "irc") (string-match "^//" path))
9498 ;; Planner has two / at the beginning of an irc link, we have 1.
9499 ;; We should have zero, actually....
9500 (setq path (substring path 1)))
9501 ((and (equal type "lisp") (string-match "^/" path))
9502 ;; Planner has a slash, we do not.
9503 (setq type "elisp" path (substring path 1)))
9505 ;; A typical message link. Planner has the id after the final slash,
9506 ;; we separate it with a hash mark
9507 (setq path (concat (match-string 1 path) "#"
9508 (org-remove-angle-brackets (match-string 2 path)))))
9509 )
9510 (cons type path))
9512 (defun org-find-file-at-mouse (ev)
9513 "Open file link or URL at mouse."
9514 (interactive "e")
9515 (mouse-set-point ev)
9516 (org-open-at-point 'in-emacs))
9518 (defun org-open-at-mouse (ev)
9519 "Open file link or URL at mouse.
9520 See the docstring of `org-open-file' for details."
9521 (interactive "e")
9522 (mouse-set-point ev)
9523 (if (eq major-mode 'org-agenda-mode)
9524 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9525 (org-open-at-point))
9527 (defvar org-window-config-before-follow-link nil
9528 "The window configuration before following a link.
9529 This is saved in case the need arises to restore it.")
9531 (defvar org-open-link-marker (make-marker)
9532 "Marker pointing to the location where `org-open-at-point; was called.")
9534 ;;;###autoload
9535 (defun org-open-at-point-global ()
9536 "Follow a link like Org-mode does.
9537 This command can be called in any mode to follow a link that has
9538 Org-mode syntax."
9539 (interactive)
9540 (org-run-like-in-org-mode 'org-open-at-point))
9542 ;;;###autoload
9543 (defun org-open-link-from-string (s &optional arg reference-buffer)
9544 "Open a link in the string S, as if it was in Org-mode."
9546 (let ((reference-buffer (or reference-buffer (current-buffer))))
9547 (with-temp-buffer
9548 (let ((org-inhibit-startup (not reference-buffer)))
9549 (org-mode)
9550 (insert s)
9551 (goto-char (point-min))
9552 (when reference-buffer
9553 (setq org-link-abbrev-alist-local
9554 (with-current-buffer reference-buffer
9555 org-link-abbrev-alist-local)))
9556 (org-open-at-point arg reference-buffer)))))
9558 (defvar org-open-at-point-functions nil
9559 "Hook that is run when following a link at point.
9561 Functions in this hook must return t if they identify and follow
9562 a link at point. If they don't find anything interesting at point,
9563 they must return nil.")
9565 (defun org-open-at-point (&optional arg reference-buffer)
9566 "Open link at or after point.
9567 If there is no link at point, this function will search forward up to
9568 the end of the current line.
9569 Normally, files will be opened by an appropriate application. If the
9570 optional prefix argument ARG is non-nil, Emacs will visit the file.
9571 With a double prefix argument, try to open outside of Emacs, in the
9572 application the system uses for this file type."
9573 (interactive "P")
9574 ;; if in a code block, then open the block's results
9575 (unless (call-interactively #'org-babel-open-src-block-result)
9576 (org-load-modules-maybe)
9577 (move-marker org-open-link-marker (point))
9578 (setq org-window-config-before-follow-link (current-window-configuration))
9579 (org-remove-occur-highlights nil nil t)
9580 (cond
9581 ((and (org-at-heading-p)
9582 (not (org-in-regexp
9587 (not (get-text-property (point) 'org-linked-text)))
9588 (or (org-offer-links-in-entry arg)
9589 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9590 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9591 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9592 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9593 (not (org-in-regexp org-bracket-link-regexp)))
9594 (org-footnote-action))
9595 (t
9596 (let (type path link line search (pos (point)))
9597 (catch 'match
9598 (save-excursion
9600 (when (org-in-regexp org-bracket-link-regexp 1)
9601 (setq link (org-extract-attributes
9602 (org-link-unescape (org-match-string-no-properties 1))))
9604 (setq link (replace-match " " t t link)))
9605 (setq link (org-link-expand-abbrev link))
9606 (cond
9607 ((or (file-name-absolute-p link)
9609 (setq type "file" path link))
9610 ((string-match org-link-re-with-space3 link)
9611 (setq type (match-string 1 link) path (match-string 2 link)))
9612 (t (setq type "thisfile" path link)))
9613 (throw 'match t)))
9615 (when (get-text-property (point) 'org-linked-text)
9616 (setq type "thisfile"
9617 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9618 (1+ (point)) (point))
9619 path (buffer-substring
9620 (or (previous-single-property-change pos 'org-linked-text)
9621 (point-min))
9622 (or (next-single-property-change pos 'org-linked-text)
9623 (point-max))))
9624 (throw 'match t))
9626 (save-excursion
9627 (when (or (org-in-regexp org-angle-link-re)
9628 (org-in-regexp org-plain-link-re))
9629 (setq type (match-string 1)
9630 path (org-link-unescape (match-string 2)))
9631 (throw 'match t)))
9632 (save-excursion
9634 (setq type "tags"
9635 path (match-string 1))
9636 (while (string-match ":" path)
9637 (setq path (replace-match "+" t t path)))
9638 (throw 'match t)))
9640 (setq type "tree-match"
9641 path (match-string 1))
9642 (throw 'match t)))
9643 (unless path
9644 (error "No link found"))
9646 ;; switch back to reference buffer
9647 ;; needed when if called in a temporary buffer through
9648 ;; org-open-link-from-string
9649 (with-current-buffer (or reference-buffer (current-buffer))
9651 ;; Remove any trailing spaces in path
9653 (setq path (replace-match "" t t path)))
9654 (if (and org-link-translation-function
9655 (fboundp org-link-translation-function))
9656 ;; Check if we need to translate the link
9657 (let ((tmp (funcall org-link-translation-function type path)))
9658 (setq type (car tmp) path (cdr tmp))))
9660 (cond
9662 ((assoc type org-link-protocols)
9663 (funcall (nth 1 (assoc type org-link-protocols)) path))
9665 ((equal type "mailto")
9666 (let ((cmd (car org-link-mailto-program))
9667 (args (cdr org-link-mailto-program)) args1
9668 (address path) (subject "") a)
9670 (setq address (match-string 1 path)
9671 subject (org-link-escape (match-string 2 path))))
9672 (while args
9673 (cond
9674 ((not (stringp (car args))) (push (pop args) args1))
9675 (t (setq a (pop args))
9676 (if (string-match "%a" a)
9677 (setq a (replace-match address t t a)))
9678 (if (string-match "%s" a)
9679 (setq a (replace-match subject t t a)))
9680 (push a args1))))
9681 (apply cmd (nreverse args1))))
9683 ((member type '("http" "https" "ftp" "news"))
9684 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9685 (org-link-escape
9686 path org-link-escape-chars-browser)
9687 path))))
9689 ((string= type "doi")
9690 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9691 (org-link-escape
9692 path org-link-escape-chars-browser)
9693 path))))
9695 ((member type '("message"))
9696 (browse-url (concat type ":" path)))
9698 ((string= type "tags")
9699 (org-tags-view arg path))
9701 ((string= type "tree-match")
9704 ((string= type "file")
9706 (setq line (string-to-number (match-string 1 path))
9707 path (substring path 0 (match-beginning 0)))
9709 (setq search (match-string 1 path)
9710 path (substring path 0 (match-beginning 0)))))
9711 (if (string-match "[*?{]" (file-name-nondirectory path))
9712 (dired path)
9713 (org-open-file path arg line search)))
9715 ((string= type "shell")
9716 (let ((cmd path))
9717 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9718 (string-match org-confirm-shell-link-not-regexp cmd))
9719 (not org-confirm-shell-link-function)
9720 (funcall org-confirm-shell-link-function
9722 (org-add-props cmd nil
9723 'face 'org-warning))))
9724 (progn
9725 (message "Executing %s" cmd)
9726 (shell-command cmd))
9727 (error "Abort"))))
9729 ((string= type "elisp")
9730 (let ((cmd path))
9731 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9732 (string-match org-confirm-elisp-link-not-regexp cmd))
9733 (not org-confirm-elisp-link-function)
9734 (funcall org-confirm-elisp-link-function
9736 (org-add-props cmd nil
9737 'face 'org-warning))))
9738 (message "%s => %s" cmd
9739 (if (equal (string-to-char cmd) ?\()
9740 (eval (read cmd))
9741 (call-interactively (read cmd))))
9742 (error "Abort"))))
9744 ((and (string= type "thisfile")
9745 (run-hook-with-args-until-success
9746 'org-open-link-functions path)))
9748 ((string= type "thisfile")
9749 (if arg
9750 (switch-to-buffer-other-window
9751 (org-get-buffer-for-internal-link (current-buffer)))
9752 (org-mark-ring-push))
9753 (let ((cmd `(org-link-search
9754 ,path
9755 ,(cond ((equal arg '(4)) ''occur)
9756 ((equal arg '(16)) ''org-occur)
9757 (t nil))
9758 ,pos)))
9759 (condition-case nil (let ((org-link-search-inhibit-query t))
9760 (eval cmd))
9761 (error (progn (widen) (eval cmd))))))
9763 (t
9764 (browse-url-at-point)))))))
9765 (move-marker org-open-link-marker nil)
9766 (run-hook-with-args 'org-follow-link-hook)))
9768 (defun org-offer-links-in-entry (&optional nth zero)
9769 "Offer links in the current entry and follow the selected link.
9770 If there is only one link, follow it immediately as well.
9771 If NTH is an integer, immediately pick the NTH link found.
9772 If ZERO is a string, check also this string for a link, and if
9773 there is one, offer it as link number zero."
9777 (cnt ?0)
9778 (in-emacs (if (integerp nth) nil nth))
9779 have-zero end links link c)
9780 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9781 (push (match-string 0 zero) links)
9782 (setq cnt (1- cnt) have-zero t))
9783 (save-excursion
9784 (org-back-to-heading t)
9785 (setq end (save-excursion (outline-next-heading) (point)))
9786 (while (re-search-forward re end t)
9787 (push (match-string 0) links))
9788 (setq links (org-uniquify (reverse links))))
9790 (cond
9791 ((null links)
9792 (message "No links"))
9793 ((equal (length links) 1)
9794 (setq link (list (car links))))
9795 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9796 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9797 (t ; we have to select a link
9798 (save-excursion
9799 (save-window-excursion
9800 (delete-other-windows)
9801 (with-output-to-temp-buffer "*Select Link*"
9802 (mapc (lambda (l)
9803 (if (not (string-match org-bracket-link-regexp l))
9805 (org-remove-angle-brackets l)))
9806 (if (match-end 3)
9808 (match-string 3 l) (match-string 1 l)))
9810 (match-string 1 l))))))
9811 links))
9812 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9813 (message "Select link to open, RET to open all:")
9814 (setq c (read-char-exclusive))
9815 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9816 (when (equal c ?q) (error "Abort"))
9817 (if (equal c ?\C-m)
9818 (setq link links)
9819 (setq nth (- c ?0))
9820 (if have-zero (setq nth (1+ nth)))
9821 (unless (and (integerp nth) (>= (length links) nth))
9822 (error "Invalid link selection"))
9823 (setq link (list (nth (1- nth) links))))))
9824 (if link
9825 (let ((buf (current-buffer)))
9826 (dolist (l link)
9827 (org-open-link-from-string l in-emacs buf))
9828 t)
9829 nil)))
9831 ;; Add special file links that specify the way of opening
9833 (org-add-link-type "file+sys" 'org-open-file-with-system)
9834 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9835 (defun org-open-file-with-system (path)
9836 "Open file at PATH using the system way of opening it."
9837 (org-open-file path 'system))
9838 (defun org-open-file-with-emacs (path)
9839 "Open file at PATH in Emacs."
9840 (org-open-file path 'emacs))
9841 (defun org-remove-file-link-modifiers ()
9842 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9843 (goto-char (point-min))
9845 (org-if-unprotected
9846 (replace-match "file:" t t))))
9847 (eval-after-load "org-exp"
9848 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9849 'org-remove-file-link-modifiers))
9851 ;;;; Time estimates
9853 (defun org-get-effort (&optional pom)
9854 "Get the effort estimate for the current entry."
9855 (org-entry-get pom org-effort-property))
9857 ;;; File search
9859 (defvar org-create-file-search-functions nil
9860 "List of functions to construct the right search string for a file link.
9861 These functions are called in turn with point at the location to
9862 which the link should point.
9864 A function in the hook should first test if it would like to
9865 handle this file type, for example by checking the `major-mode'
9866 or the file extension. If it decides not to handle this file, it
9867 should just return nil to give other functions a chance. If it
9868 does handle the file, it must return the search string to be used
9869 when following the link. The search string will be part of the
9870 file link, given after a double colon, and `org-open-at-point'
9871 will automatically search for it. If special measures must be
9872 taken to make the search successful, another function should be
9873 added to the companion hook `org-execute-file-search-functions',
9874 which see.
9876 A function in this hook may also use `setq' to set the variable
9877 `description' to provide a suggestion for the descriptive text to
9878 be used for this link when it gets inserted into an Org-mode
9881 (defvar org-execute-file-search-functions nil
9882 "List of functions to execute a file search triggered by a link.
9884 Functions added to this hook must accept a single argument, the
9885 search string that was part of the file link, the part after the
9886 double colon. The function must first check if it would like to
9887 handle this search, for example by checking the `major-mode' or
9888 the file extension. If it decides not to handle this search, it
9889 should just return nil to give other functions a chance. If it
9890 does handle the search, it must return a non-nil value to keep
9891 other functions from trying.
9893 Each function can access the current prefix argument through the
9894 variable `current-prefix-argument'. Note that a single prefix is
9895 used to force opening a link in Emacs, so it may be good to only
9896 use a numeric or double prefix to guide the search function.
9898 In case this is needed, a function in this hook can also restore
9899 the window configuration before `org-open-at-point' was called using:
9901 (set-window-configuration org-window-config-before-follow-link)")
9903 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9904 (defun org-link-search (s &optional type avoid-pos stealth)
9905 "Search for a link search option.
9906 If S is surrounded by forward slashes, it is interpreted as a
9907 regular expression. In org-mode files, this will create an `org-occur'
9908 sparse tree. In ordinary files, `occur' will be used to list matches.
9909 If the current buffer is in `dired-mode', grep will be used to search
9910 in all files. If AVOID-POS is given, ignore matches near that position.
9912 When optional argument STEALTH is non-nil, do not modify
9913 visibility around point, thus ignoring
9914 `org-show-hierarchy-above', `org-show-following-heading' and
9915 `org-show-siblings' variables."
9916 (let ((case-fold-search t)
9920 org-emphasis-alist)
9922 (pos (point))
9923 (pre nil) (post nil)
9924 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9925 (cond
9926 ;; First check if there are any special search functions
9927 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9928 ;; Now try the builtin stuff
9929 ((and (equal (string-to-char s0) ?#)
9930 (> (length s0) 1)
9931 (save-excursion
9932 (goto-char (point-min))
9933 (and
9934 (re-search-forward
9936 (setq type 'dedicated
9937 pos (match-beginning 0))))
9938 ;; There is an exact target for this
9939 (goto-char pos)
9940 (org-back-to-heading t)))
9941 ((save-excursion
9942 (goto-char (point-min))
9943 (and
9944 (re-search-forward
9945 (concat "<<" (regexp-quote s0) ">>") nil t)
9946 (setq type 'dedicated
9947 pos (match-beginning 0))))
9948 ;; There is an exact target for this
9949 (goto-char pos))
9950 ((save-excursion
9951 (goto-char (point-min))
9952 (and
9953 (re-search-forward
9955 (setq type 'dedicated pos (match-beginning 0))))
9956 ;; Found an invisible target.
9957 (goto-char pos))
9958 ((save-excursion
9959 (goto-char (point-min))
9960 (and
9961 (re-search-forward
9963 (setq type 'dedicated pos (match-beginning 0))))
9964 ;; Found an element with a matching #+name affiliated keyword.
9965 (goto-char pos))
9967 (save-excursion
9968 (goto-char (point-min))
9969 (and
9970 (re-search-forward
9971 (concat "[^[]" (regexp-quote
9972 (format org-coderef-label-format
9973 (match-string 1 s0))))
9974 nil t)
9975 (setq type 'dedicated
9976 pos (1+ (match-beginning 0))))))
9977 ;; There is a coderef target for this
9978 (goto-char pos))
9980 ;; A regular expression
9981 (cond
9982 ((derived-mode-p 'org-mode)
9983 (org-occur (match-string 1 s)))
9984 ;;((eq major-mode 'dired-mode)
9985 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9986 (t (org-do-occur (match-string 1 s)))))
9987 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
9988 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9989 (goto-char (point-min))
9990 (cond
9991 ((let (case-fold-search)
9992 (re-search-forward (format org-complex-heading-regexp-format
9993 (regexp-quote s))
9994 nil t))
9995 ;; OK, found a match
9996 (setq type 'dedicated)
9997 (goto-char (match-beginning 0)))
9998 ((and (not org-link-search-inhibit-query)
9999 (eq org-link-search-must-match-exact-headline 'query-to-create)
10000 (y-or-n-p "No match - create this as a new heading? "))
10001 (goto-char (point-max))
10002 (or (bolp) (newline))
10004 (beginning-of-line 0))
10005 (t
10006 (goto-char pos)
10007 (error "No match"))))
10008 (t
10009 ;; A normal search string
10010 (when (equal (string-to-char s) ?*)
10011 ;; Anchor on headlines, post may include tags.
10014 s (substring s 1)))
10015 (remove-text-properties
10016 0 (length s)
10017 '(face nil mouse-face nil keymap nil fontified nil) s)
10018 ;; Make a series of regular expressions to find a match
10027 re4 (concat "[^a-zA-Z_]" re4_)
10029 re1 (concat pre re2 post)
10030 re3 (concat pre (if pre re4_ re4) post)
10031 re5 (concat pre ".*" re4)
10032 re2 (concat pre re2)
10033 re2a (concat pre (if pre re2a_ re2a))
10034 re4 (concat pre (if pre re4_ re4))
10038 ))
10039 (cond
10040 ((eq type 'org-occur) (org-occur reall))
10041 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10042 (t (goto-char (point-min))
10043 (setq type 'fuzzy)
10044 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10045 (org-search-not-self 1 re1 nil t)
10046 (org-search-not-self 1 re2 nil t)
10047 (org-search-not-self 1 re2a nil t)
10048 (org-search-not-self 1 re3 nil t)
10049 (org-search-not-self 1 re4 nil t)
10050 (org-search-not-self 1 re5 nil t)
10051 )
10052 (goto-char (match-beginning 1))
10053 (goto-char pos)
10054 (error "No match"))))))
10055 (and (derived-mode-p 'org-mode)
10056 (not stealth)
10057 (org-show-context 'link-search))
10058 type))
10060 (defun org-search-not-self (group &rest args)
10061 "Execute `re-search-forward', but only accept matches that do not
10062 enclose the position of `org-open-link-marker'."
10063 (let ((m org-open-link-marker))
10064 (catch 'exit
10065 (while (apply 're-search-forward args)
10066 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10067 (goto-char (match-end group))
10068 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10069 (> (match-beginning 0) (marker-position m))
10070 (< (match-end 0) (marker-position m)))
10071 (save-match-data
10072 (or (not (org-in-regexp
10073 org-bracket-link-analytic-regexp 1))
10074 (not (match-end 4)) ; no description
10075 (and (<= (match-beginning 4) (point))
10076 (>= (match-end 4) (point))))))
10077 (throw 'exit (point))))))))
10079 (defun org-get-buffer-for-internal-link (buffer)
10080 "Return a buffer to be used for displaying the link target of internal links."
10081 (cond
10082 ((not org-display-internal-link-with-indirect-buffer)
10083 buffer)
10084 ((string-match "(Clone)$" (buffer-name buffer))
10085 (message "Buffer is already a clone, not making another one")
10086 ;; we also do not modify visibility in this case
10087 buffer)
10088 (t ; make a new indirect buffer for displaying the link
10089 (let* ((bn (buffer-name buffer))
10090 (ibn (concat bn "(Clone)"))
10091 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10092 (with-current-buffer ib (org-overview))
10093 ib))))
10095 (defun org-do-occur (regexp &optional cleanup)
10096 "Call the Emacs command `occur'.
10097 If CLEANUP is non-nil, remove the printout of the regular expression
10098 in the *Occur* buffer. This is useful if the regex is long and not useful
10099 to read."
10100 (occur regexp)
10101 (when cleanup
10102 (let ((cwin (selected-window)) win beg end)
10103 (when (setq win (get-buffer-window "*Occur*"))
10104 (select-window win))
10105 (goto-char (point-min))
10106 (when (re-search-forward "match[a-z]+" nil t)
10107 (setq beg (match-end 0))
10109 (setq end (1- (match-beginning 0)))))
10110 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10111 (goto-char (point-min))
10112 (select-window cwin))))
10114 ;;; The mark ring for links jumps
10116 (defvar org-mark-ring nil
10117 "Mark ring for positions before jumps in Org-mode.")
10118 (defvar org-mark-ring-last-goto nil
10119 "Last position in the mark ring used to go back.")
10120 ;; Fill and close the ring
10121 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10122 (loop for i from 1 to org-mark-ring-length do
10123 (push (make-marker) org-mark-ring))
10124 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10125 org-mark-ring)
10127 (defun org-mark-ring-push (&optional pos buffer)
10128 "Put the current position or POS into the mark ring and rotate it."
10129 (interactive)
10130 (setq pos (or pos (point)))
10131 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10132 (move-marker (car org-mark-ring)
10133 (or pos (point))
10134 (or buffer (current-buffer)))
10135 (message "%s"
10136 (substitute-command-keys
10139 (defun org-mark-ring-goto (&optional n)
10140 "Jump to the previous position in the mark ring.
10141 With prefix arg N, jump back that many stored positions. When
10142 called several times in succession, walk through the entire ring.
10143 Org-mode commands jumping to a different position in the current file,
10144 or to another Org-mode file, automatically push the old position
10145 onto the ring."
10146 (interactive "p")
10147 (let (p m)
10148 (if (eq last-command this-command)
10149 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10150 (setq p org-mark-ring))
10151 (setq org-mark-ring-last-goto p)
10152 (setq m (car p))
10153 (org-pop-to-buffer-same-window (marker-buffer m))
10154 (goto-char m)
10155 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10157 (defun org-remove-angle-brackets (s)
10158 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10159 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10160 s)
10161 (defun org-add-angle-brackets (s)
10162 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10163 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10164 s)
10165 (defun org-remove-double-quotes (s)
10168 s)
10170 ;;; Following specific links
10172 (defun org-follow-timestamp-link ()
10173 (cond
10174 ((org-at-date-range-p t)
10175 (let ((org-agenda-start-on-weekday)
10176 (t1 (match-string 1))
10177 (t2 (match-string 2)))
10178 (setq t1 (time-to-days (org-time-string-to-time t1))
10179 t2 (time-to-days (org-time-string-to-time t2)))
10180 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10181 ((org-at-timestamp-p t)
10182 (org-agenda-list nil (time-to-days (org-time-string-to-time
10183 (substring (match-string 1) 0 10)))
10184 1))
10185 (t (error "This should not happen"))))
10188 ;;; Following file links
10189 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10190 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10191 (declare-function mailcap-mime-info
10192 "mailcap" (string &optional request no-decode))
10193 (defvar org-wait nil)
10194 (defun org-open-file (path &optional in-emacs line search)
10195 "Open the file at PATH.
10196 First, this expands any special file name abbreviations. Then the
10197 configuration variable `org-file-apps' is checked if it contains an
10198 entry for this file type, and if yes, the corresponding command is launched.
10200 If no application is found, Emacs simply visits the file.
10202 With optional prefix argument IN-EMACS, Emacs will visit the file.
10204 prefix arg, Org tries to avoid opening in Emacs
10205 and to use an external application to visit the file.
10207 Optional LINE specifies a line to go to, optional SEARCH a string
10208 to search for. If LINE or SEARCH is given, the file will be
10209 opened in Emacs, unless an entry from org-file-apps that makes
10210 use of groups in a regexp matches.
10212 If you want to change the way frames are used when following a
10213 link, please customize `org-link-frame-setup'.
10215 If the file does not exist, an error is thrown."
10216 (let* ((file (if (equal path "")
10217 buffer-file-name
10218 (substitute-in-file-name (expand-file-name path))))
10219 (file-apps (append org-file-apps (org-default-apps)))
10220 (apps (org-remove-if
10221 'org-file-apps-entry-match-against-dlink-p file-apps))
10222 (apps-dlink (org-remove-if-not
10223 'org-file-apps-entry-match-against-dlink-p file-apps))
10224 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10225 (dirp (if remp nil (file-directory-p file)))
10226 (file (if (and dirp org-open-directory-means-index-dot-org)
10227 (concat (file-name-as-directory file) "index.org")
10228 file))
10229 (a-m-a-p (assq 'auto-mode apps))
10230 (dfile (downcase file))
10231 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10232 (link (cond ((and (eq line nil)
10233 (eq search nil))
10234 file)
10235 (line
10236 (concat file "::" (number-to-string line)))
10237 (search
10238 (concat file "::" search))))
10239 (dlink (downcase link))
10240 (old-buffer (current-buffer))
10241 (old-pos (point))
10242 (old-mode major-mode)
10243 ext cmd link-match-data)
10245 (setq ext (match-string 1 dfile))
10247 (setq ext (match-string 1 dfile))))
10248 (cond
10249 ((member in-emacs '((16) system))
10250 (setq cmd (cdr (assoc 'system apps))))
10251 (in-emacs (setq cmd 'emacs))
10252 (t
10253 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10254 (and dirp (cdr (assoc 'directory apps)))
10255 ; first, try matching against apps-dlink
10256 ; if we get a match here, store the match data for later
10257 (let ((match (assoc-default dlink apps-dlink
10258 'string-match)))
10259 (if match
10260 (progn (setq link-match-data (match-data))
10261 match)
10262 (progn (setq in-emacs (or in-emacs line search))
10263 nil))) ; if we have no match in apps-dlink,
10264 ; always open the file in emacs if line or search
10265 ; is given (for backwards compatibility)
10266 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10267 'string-match)
10268 (cdr (assoc ext apps))
10269 (cdr (assoc t apps))))))
10270 (when (eq cmd 'system)
10271 (setq cmd (cdr (assoc 'system apps))))
10272 (when (eq cmd 'default)
10273 (setq cmd (cdr (assoc t apps))))
10274 (when (eq cmd 'mailcap)
10275 (require 'mailcap)
10276 (mailcap-parse-mailcaps)
10277 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10278 (command (mailcap-mime-info mime-type)))
10279 (if (stringp command)
10280 (setq cmd command)
10281 (setq cmd 'emacs))))
10282 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10283 (not (file-exists-p file))
10284 (not org-open-non-existing-files))
10285 (error "No such file: %s" file))
10286 (cond
10288 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10290 (setq cmd (replace-match "%s" t t cmd)))
10291 (while (string-match "%s" cmd)
10292 (setq cmd (replace-match
10293 (save-match-data
10294 (shell-quote-argument
10295 (convert-standard-filename file)))
10296 t t cmd)))
10298 ;; Replace "%1", "%2" etc. in command with group matches from regex
10299 (save-match-data
10300 (let ((match-index 1)
10301 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10302 (set-match-data link-match-data)
10303 (while (<= match-index number-of-groups)
10304 (let ((regex (concat "%" (number-to-string match-index)))
10305 (replace-with (match-string match-index dlink)))
10306 (while (string-match regex cmd)
10307 (setq cmd (replace-match replace-with t t cmd))))
10308 (setq match-index (+ match-index 1)))))
10310 (save-window-excursion
10311 (start-process-shell-command cmd nil cmd)
10312 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10313 ))
10314 ((or (stringp cmd)
10315 (eq cmd 'emacs))
10316 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10317 (widen)
10318 (if line (org-goto-line line)
10319 (if search (org-link-search search))))
10320 ((consp cmd)
10321 (let ((file (convert-standard-filename file)))
10322 (save-match-data
10323 (set-match-data link-match-data)
10324 (eval cmd))))
10325 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10326 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10327 (or (not (equal old-buffer (current-buffer)))
10328 (not (equal old-pos (point))))
10329 (org-mark-ring-push old-pos old-buffer))))
10331 (defun org-file-apps-entry-match-against-dlink-p (entry)
10332 "This function returns non-nil if `entry' uses a regular
10333 expression which should be matched against the whole link by
10334 org-open-file.
10336 It assumes that is the case when the entry uses a regular
10337 expression which has at least one grouping construct and the
10338 action is either a lisp form or a command string containing
10339 '%1', i.e. using at least one subexpression match as a
10340 parameter."
10341 (let ((selector (car entry))
10342 (action (cdr entry)))
10343 (if (stringp selector)
10344 (and (> (regexp-opt-depth selector) 0)
10345 (or (and (stringp action)
10346 (string-match "%[0-9]" action))
10347 (consp action)))
10348 nil)))
10350 (defun org-default-apps ()
10351 "Return the default applications for this operating system."
10352 (cond
10353 ((eq system-type 'darwin)
10354 org-file-apps-defaults-macosx)
10355 ((eq system-type 'windows-nt)
10356 org-file-apps-defaults-windowsnt)
10357 (t org-file-apps-defaults-gnu)))
10359 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10360 "Convert extensions to regular expressions in the cars of LIST.
10361 Also, weed out any non-string entries, because the return value is used
10362 only for regexp matching.
10363 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10364 point to the symbol `emacs', indicating that the file should
10365 be opened in Emacs."
10366 (append
10367 (delq nil
10368 (mapcar (lambda (x)
10369 (if (not (stringp (car x)))
10370 nil
10372 x
10374 list))
10375 (if add-auto-mode
10376 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10378 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10379 (defun org-file-remote-p (file)
10380 "Test whether FILE specifies a location on a remote system.
10381 Return non-nil if the location is indeed remote.
10385 (cond ((fboundp 'file-remote-p)
10386 (file-remote-p file))
10387 ((fboundp 'tramp-handle-file-remote-p)
10388 (tramp-handle-file-remote-p file))
10389 ((and (boundp 'ange-ftp-name-format)
10390 (string-match (car ange-ftp-name-format) file))
10391 t)
10392 (t nil)))
10395 ;;;; Refiling
10397 (defun org-get-org-file ()
10398 "Read a filename, with default directory `org-directory'."
10399 (let ((default (or org-default-notes-file remember-data-file)))
10400 (read-file-name (format "File name [%s]: " default)
10401 (file-name-as-directory org-directory)
10402 default)))
10404 (defun org-notes-order-reversed-p ()
10405 "Check if the current file should receive notes in reversed order."
10406 (cond
10407 ((not org-reverse-note-order) nil)
10408 ((eq t org-reverse-note-order) t)
10409 ((not (listp org-reverse-note-order)) nil)
10410 (t (catch 'exit
10411 (let ((all org-reverse-note-order)
10412 entry)
10413 (while (setq entry (pop all))
10414 (if (string-match (car entry) buffer-file-name)
10415 (throw 'exit (cdr entry))))
10416 nil)))))
10418 (defvar org-refile-target-table nil
10419 "The list of refile targets, created by `org-refile'.")
10421 (defvar org-agenda-new-buffers nil
10422 "Buffers created to visit agenda files.")
10424 (defvar org-refile-cache nil
10425 "Cache for refile targets.")
10427 (defvar org-refile-markers nil
10428 "All the markers used for caching refile locations.")
10430 (defun org-refile-marker (pos)
10431 "Get a new refile marker, but only if caching is in use."
10432 (if (not org-refile-use-cache)
10433 pos
10434 (let ((m (make-marker)))
10435 (move-marker m pos)
10436 (push m org-refile-markers)
10437 m)))
10439 (defun org-refile-cache-clear ()
10440 "Clear the refile cache and disable all the markers."
10441 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10442 (setq org-refile-markers nil)
10443 (setq org-refile-cache nil)
10444 (message "Refile cache has been cleared"))
10446 (defun org-refile-cache-check-set (set)
10447 "Check if all the markers in the cache still have live buffers."
10448 (let (marker)
10449 (catch 'exit
10450 (while (and set (setq marker (nth 3 (pop set))))
10451 ;; if org-refile-use-outline-path is 'file, marker may be nil
10452 (when (and marker (null (marker-buffer marker)))
10453 (message "not found") (sit-for 3)
10454 (throw 'exit nil)))
10455 t)))
10457 (defun org-refile-cache-put (set &rest identifiers)
10458 "Push the refile targets SET into the cache, under IDENTIFIERS."
10459 (let* ((key (sha1 (prin1-to-string identifiers)))
10460 (entry (assoc key org-refile-cache)))
10461 (if entry
10462 (setcdr entry set)
10463 (push (cons key set) org-refile-cache))))
10465 (defun org-refile-cache-get (&rest identifiers)
10466 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10467 (cond
10468 ((not org-refile-cache) nil)
10469 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10470 (t
10471 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10472 org-refile-cache))))
10473 (and set (org-refile-cache-check-set set) set)))))
10475 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10476 "Produce a table with refile targets."
10477 (let ((case-fold-search nil)
10478 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10479 (entries (or org-refile-targets '((nil . (:level . 1)))))
10480 targets tgs txt re files f desc descre fast-path-p level pos0)
10481 (message "Getting targets...")
10482 (with-current-buffer (or default-buffer (current-buffer))
10483 (while (setq entry (pop entries))
10484 (setq files (car entry) desc (cdr entry))
10485 (setq fast-path-p nil)
10486 (cond
10487 ((null files) (setq files (list (current-buffer))))
10488 ((eq files 'org-agenda-files)
10489 (setq files (org-agenda-files 'unrestricted)))
10490 ((and (symbolp files) (fboundp files))
10491 (setq files (funcall files)))
10492 ((and (symbolp files) (boundp files))
10493 (setq files (symbol-value files))))
10494 (if (stringp files) (setq files (list files)))
10495 (cond
10496 ((eq (car desc) :tag)
10498 ((eq (car desc) :todo)
10500 ((eq (car desc) :regexp)
10501 (setq descre (cdr desc)))
10502 ((eq (car desc) :level)
10504 (if org-odd-levels-only
10505 (1- (* 2 (cdr desc)))
10506 (cdr desc)))
10508 ((eq (car desc) :maxlevel)
10509 (setq fast-path-p t)
10511 (if org-odd-levels-only
10512 (1- (* 2 (cdr desc)))
10513 (cdr desc)))
10515 (t (error "Bad refiling target description %s" desc)))
10516 (while (setq f (pop files))
10517 (with-current-buffer
10518 (if (bufferp f) f (org-get-agenda-file-buffer f))
10519 (or
10520 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10521 (progn
10522 (if (bufferp f) (setq f (buffer-file-name
10523 (buffer-base-buffer f))))
10524 (setq f (and f (expand-file-name f)))
10525 (if (eq org-refile-use-outline-path 'file)
10526 (push (list (file-name-nondirectory f) f nil nil) tgs))
10527 (save-excursion
10528 (save-restriction
10529 (widen)
10530 (goto-char (point-min))
10531 (while (re-search-forward descre nil t)
10532 (goto-char (setq pos0 (point-at-bol)))
10533 (catch 'next
10534 (when org-refile-target-verify-function
10535 (save-match-data
10536 (or (funcall org-refile-target-verify-function)
10537 (throw 'next t))))
10538 (when (and (looking-at org-complex-heading-regexp)
10539 (not (member (match-string 4) excluded-entries))
10540 (match-string 4))
10541 (setq level (org-reduced-level
10542 (- (match-end 1) (match-beginning 1)))
10543 txt (org-link-display-format (match-string 4))
10545 re (format org-complex-heading-regexp-format
10546 (regexp-quote (match-string 4))))
10547 (when org-refile-use-outline-path
10548 (setq txt (mapconcat
10549 'org-protect-slash
10550 (append
10551 (if (eq org-refile-use-outline-path
10552 'file)
10553 (list (file-name-nondirectory
10554 (buffer-file-name
10555 (buffer-base-buffer))))
10556 (if (eq org-refile-use-outline-path
10557 'full-file-path)
10558 (list (buffer-file-name
10559 (buffer-base-buffer)))))
10560 (org-get-outline-path fast-path-p
10561 level txt)
10562 (list txt))
10563 "/")))
10564 (push (list txt f re (org-refile-marker (point)))
10565 tgs)))
10566 (when (= (point) pos0)
10567 ;; verification function has not moved point
10568 (goto-char (point-at-eol))))))))
10569 (when org-refile-use-cache
10570 (org-refile-cache-put tgs (buffer-file-name) descre))
10571 (setq targets (append tgs targets))
10572 ))))
10573 (message "Getting targets...done")
10574 (nreverse targets)))
10576 (defun org-protect-slash (s)
10577 (while (string-match "/" s)
10579 s)
10581 (defvar org-olpa (make-vector 20 nil))
10583 (defun org-get-outline-path (&optional fastp level heading)
10584 "Return the outline path to the current entry, as a list.
10586 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10587 routine which makes outline path derivations for an entire file,
10588 avoiding backtracing. Refile target collection makes use of that."
10589 (if fastp
10590 (progn
10591 (if (> level 19)
10592 (error "Outline path failure, more than 19 levels"))
10593 (loop for i from level upto 19 do
10594 (aset org-olpa i nil))
10595 (prog1
10596 (delq nil (append org-olpa nil))
10597 (aset org-olpa level heading)))
10598 (let (rtn case-fold-search)
10599 (save-excursion
10600 (save-restriction
10601 (widen)
10602 (while (org-up-heading-safe)
10603 (when (looking-at org-complex-heading-regexp)
10604 (push (org-match-string-no-properties 4) rtn)))
10605 rtn)))))
10607 (defun org-format-outline-path (path &optional width prefix)
10608 "Format the outline path PATH for display.
10609 Width is the maximum number of characters that is available.
10610 Prefix is a prefix to be included in the returned string,
10611 such as the file name."
10612 (setq width (or width 79))
10613 (if prefix (setq width (- width (length prefix))))
10614 (if (not path)
10615 (or prefix "")
10616 (let* ((nsteps (length path))
10617 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10618 (maxwidth (if (<= total-width width)
10619 10000 ;; everything fits
10620 ;; we need to shorten the level headings
10621 (/ (- width nsteps) nsteps)))
10622 (org-odd-levels-only nil)
10623 (n 0)
10624 (total (1+ (length prefix))))
10625 (setq maxwidth (max maxwidth 10))
10626 (concat prefix
10627 (mapconcat
10628 (lambda (h)
10629 (setq n (1+ n))
10630 (if (and (= n nsteps) (< maxwidth 10000))
10631 (setq maxwidth (- total-width total)))
10632 (if (< (length h) maxwidth)
10633 (progn (setq total (+ total (length h) 1)) h)
10634 (setq h (substring h 0 (- maxwidth 2))
10635 total (+ total maxwidth 1))
10637 (setq h (substring h 0 (match-beginning 0))))
10638 (setq h (concat h "..")))
10639 (org-add-props h nil 'face
10640 (nth (% (1- n) org-n-level-faces)
10641 org-level-faces))
10642 h)
10643 path "/")))))
10645 (defun org-display-outline-path (&optional file current)
10646 "Display the current outline path in the echo area."
10647 (interactive "P")
10648 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10649 (case-fold-search nil)
10650 (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
10651 (if current (setq path (append path
10652 (save-excursion
10653 (org-back-to-heading t)
10654 (if (looking-at org-complex-heading-regexp)
10655 (list (match-string 4)))))))
10656 (message "%s"
10657 (org-format-outline-path
10658 path
10659 (1- (frame-width))
10660 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10662 (defvar org-refile-history nil
10663 "History for refiling operations.")
10665 (defvar org-after-refile-insert-hook nil
10666 "Hook run after `org-refile' has inserted its stuff at the new location.
10667 Note that this is still *before* the stuff will be removed from
10668 the *old* location.")
10670 (defvar org-capture-last-stored-marker)
10671 (defun org-refile (&optional goto default-buffer rfloc)
10672 "Move the entry or entries at point to another heading.
10673 The list of target headings is compiled using the information in
10674 `org-refile-targets', which see.
10676 At the target location, the entry is filed as a subitem of the target
10677 heading. Depending on `org-reverse-note-order', the new subitem will
10678 either be the first or the last subitem.
10680 If there is an active region, all entries in that region will be moved.
10681 However, the region must fulfill the requirement that the first heading
10682 is the first one sets the top-level of the moved text - at most siblings
10683 below it are allowed.
10685 With prefix arg GOTO, the command will only visit the target location
10686 and not actually move anything.
10689 go to the location where the last refiling operation has put the subtree.
10690 With a prefix argument of `2', refile to the running clock.
10692 RFLOC can be a refile location obtained in a different way.
10694 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10696 If you are using target caching (see `org-refile-use-cache'),
10697 you have to clear the target cache in order to find new targets.
10698 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10699 prefix argument (`C-u C-u C-u C-c C-w')."
10701 (interactive "P")
10702 (if (member goto '(0 (64)))
10703 (org-refile-cache-clear)
10704 (let* ((cbuf (current-buffer))
10705 (regionp (org-region-active-p))
10706 (region-start (and regionp (region-beginning)))
10707 (region-end (and regionp (region-end)))
10708 (region-length (and regionp (- region-end region-start)))
10709 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10710 pos it nbuf file re level reversed)
10711 (setq last-command nil)
10712 (when regionp
10713 (goto-char region-start)
10714 (or (bolp) (goto-char (point-at-bol)))
10715 (setq region-start (point))
10716 (unless (or (org-kill-is-subtree-p
10717 (buffer-substring region-start region-end))
10718 (prog1 org-refile-active-region-within-subtree
10719 (org-toggle-heading)))
10720 (error "The region is not a (sequence of) subtree(s)")))
10721 (if (equal goto '(16))
10722 (org-refile-goto-last-stored)
10723 (when (or
10724 (and (equal goto 2)
10725 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10726 (prog1
10727 (setq it (list (or org-clock-heading "running clock")
10728 (buffer-file-name
10729 (marker-buffer org-clock-hd-marker))
10730 ""
10731 (marker-position org-clock-hd-marker)))
10732 (setq goto nil)))
10733 (setq it (or rfloc
10734 (let (heading-text)
10735 (save-excursion
10736 (unless goto
10737 (org-back-to-heading t)
10738 (setq heading-text
10739 (nth 4 (org-heading-components))))
10740 (org-refile-get-location
10741 (cond (goto "Goto")
10742 (regionp "Refile region to")
10745 default-buffer
10746 (and (not (equal '(4) goto))
10747 org-refile-allow-creating-parent-nodes)
10748 goto))))))
10749 (setq file (nth 1 it)
10750 re (nth 2 it)
10751 pos (nth 3 it))
10752 (if (and (not goto)
10753 pos
10754 (equal (buffer-file-name) file)
10755 (if regionp
10756 (and (>= pos region-start)
10757 (<= pos region-end))
10758 (and (>= pos (point))
10759 (< pos (save-excursion
10760 (org-end-of-subtree t t))))))
10761 (error "Cannot refile to position inside the tree or region"))
10763 (setq nbuf (or (find-buffer-visiting file)
10764 (find-file-noselect file)))
10765 (if goto
10766 (progn
10767 (org-pop-to-buffer-same-window nbuf)
10768 (goto-char pos)
10769 (org-show-context 'org-goto))
10770 (if regionp
10771 (progn
10772 (org-kill-new (buffer-substring region-start region-end))
10773 (org-save-markers-in-region region-start region-end))
10774 (org-copy-subtree 1 nil t))
10775 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10776 (find-file-noselect file)))
10777 (setq reversed (org-notes-order-reversed-p))
10778 (save-excursion
10779 (save-restriction
10780 (widen)
10781 (if pos
10782 (progn
10783 (goto-char pos)
10784 (looking-at org-outline-regexp)
10785 (setq level (org-get-valid-level (funcall outline-level) 1))
10786 (goto-char
10787 (if reversed
10788 (or (outline-next-heading) (point-max))
10789 (or (save-excursion (org-get-next-sibling))
10790 (org-end-of-subtree t t)
10791 (point-max)))))
10792 (setq level 1)
10793 (if (not reversed)
10794 (goto-char (point-max))
10795 (goto-char (point-min))
10796 (or (outline-next-heading) (goto-char (point-max)))))
10797 (if (not (bolp)) (newline))
10798 (org-paste-subtree level)
10799 (when org-log-refile
10800 (org-add-log-setup 'refile nil nil 'findpos
10801 org-log-refile)
10802 (unless (eq org-log-refile 'note)
10803 (save-excursion (org-add-log-note))))
10804 (and org-auto-align-tags (org-set-tags nil t))
10805 (bookmark-set "org-refile-last-stored")
10806 ;; If we are refiling for capture, make sure that the
10807 ;; last-capture pointers point here
10808 (when (org-bound-and-true-p org-refile-for-capture)
10809 (bookmark-set "org-capture-last-stored-marker")
10810 (move-marker org-capture-last-stored-marker (point)))
10811 (if (fboundp 'deactivate-mark) (deactivate-mark))
10812 (run-hooks 'org-after-refile-insert-hook))))
10813 (if regionp
10814 (delete-region (point) (+ (point) region-length))
10815 (org-cut-subtree))
10816 (when (featurep 'org-inlinetask)
10817 (org-inlinetask-remove-END-maybe))
10818 (setq org-markers-to-move nil)
10821 (defun org-refile-goto-last-stored ()
10822 "Go to the location where the last refile was stored."
10823 (interactive)
10824 (bookmark-jump "org-refile-last-stored")
10825 (message "This is the location of the last refile"))
10827 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10828 no-exclude)
10829 "Prompt the user for a refile location, using PROMPT.
10830 PROMPT should not be suffixed with a colon and a space, because
10831 this function appends the default value from
10832 `org-refile-history' automatically, if that is not empty.
10833 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10834 this is used for the GOTO interface."
10835 (let ((org-refile-targets org-refile-targets)
10836 (org-refile-use-outline-path org-refile-use-outline-path)
10837 excluded-entries)
10838 (when (and (derived-mode-p 'org-mode)
10839 (not org-refile-use-cache)
10840 (not no-exclude))
10841 (org-map-tree
10842 (lambda()
10843 (setq excluded-entries
10844 (append excluded-entries (list (org-get-heading t t)))))))
10845 (setq org-refile-target-table
10846 (org-refile-get-targets default-buffer excluded-entries)))
10847 (unless org-refile-target-table
10848 (error "No refile targets"))
10849 (let* ((prompt (concat prompt
10850 (and (car org-refile-history)
10851 (concat " (default " (car org-refile-history) ")"))
10852 ": "))
10853 (cbuf (current-buffer))
10854 (partial-completion-mode nil)
10855 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10856 (cfunc (if (and org-refile-use-outline-path
10857 org-outline-path-complete-in-steps)
10858 'org-olpath-completing-read
10859 'org-icompleting-read))
10860 (extra (if org-refile-use-outline-path "/" ""))
10861 (filename (and cfn (expand-file-name cfn)))
10862 (tbl (mapcar
10863 (lambda (x)
10864 (if (and (not (member org-refile-use-outline-path
10865 '(file full-file-path)))
10866 (not (equal filename (nth 1 x))))
10867 (cons (concat (car x) extra " ("
10868 (file-name-nondirectory (nth 1 x)) ")")
10869 (cdr x))
10870 (cons (concat (car x) extra) (cdr x))))
10871 org-refile-target-table))
10872 (completion-ignore-case t)
10873 pa answ parent-target child parent old-hist)
10874 (setq old-hist org-refile-history)
10875 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10876 nil 'org-refile-history (car org-refile-history)))
10877 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10878 (org-refile-check-position pa)
10879 (if pa
10880 (progn
10881 (when (or (not org-refile-history)
10882 (not (eq old-hist org-refile-history))
10883 (not (equal (car pa) (car org-refile-history))))
10884 (setq org-refile-history
10885 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10886 org-refile-history
10887 (cdr org-refile-history))))
10888 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10889 (pop org-refile-history)))
10890 pa)
10892 (progn
10893 (setq parent (match-string 1 answ)
10894 child (match-string 2 answ))
10895 (setq parent-target (or (assoc parent tbl)
10896 (assoc (concat parent "/") tbl)))
10897 (when (and parent-target
10898 (or (eq new-nodes t)
10899 (and (eq new-nodes 'confirm)
10901 child)))))
10902 (org-refile-new-child parent-target child)))
10903 (error "Invalid target location")))))
10905 (declare-function org-string-nw-p "org-macs.el" (s))
10906 (defun org-refile-check-position (refile-pointer)
10907 "Check if the refile pointer matches the readline to which it points."
10908 (let* ((file (nth 1 refile-pointer))
10909 (re (nth 2 refile-pointer))
10910 (pos (nth 3 refile-pointer))
10911 buffer)
10912 (when (org-string-nw-p re)
10913 (setq buffer (if (markerp pos)
10914 (marker-buffer pos)
10915 (or (find-buffer-visiting file)
10916 (find-file-noselect file))))
10917 (with-current-buffer buffer
10918 (save-excursion
10919 (save-restriction
10920 (widen)
10921 (goto-char pos)
10922 (beginning-of-line 1)
10923 (unless (org-looking-at-p re)
10924 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10926 (defun org-refile-new-child (parent-target child)
10927 "Use refile target PARENT-TARGET to add new CHILD below it."
10928 (unless parent-target
10929 (error "Cannot find parent for new node"))
10930 (let ((file (nth 1 parent-target))
10931 (pos (nth 3 parent-target))
10932 level)
10933 (with-current-buffer (or (find-buffer-visiting file)
10934 (find-file-noselect file))
10935 (save-excursion
10936 (save-restriction
10937 (widen)
10938 (if pos
10939 (goto-char pos)
10940 (goto-char (point-max))
10941 (if (not (bolp)) (newline)))
10942 (when (looking-at org-outline-regexp)
10943 (setq level (funcall outline-level))
10944 (org-end-of-subtree t t))
10945 (org-back-over-empty-lines)
10947 (if pos (org-get-valid-level level 1) 1) ?*)
10949 (beginning-of-line 0)
10950 (list (concat (car parent-target) "/" child) file "" (point)))))))
10952 (defun org-olpath-completing-read (prompt collection &rest args)
10953 "Read an outline path like a file name."
10954 (let ((thetable collection)
10955 (org-completion-use-ido nil) ; does not work with ido.
10956 (org-completion-use-iswitchb nil)) ; or iswitchb
10957 (apply
10958 'org-icompleting-read prompt
10959 (lambda (string predicate &optional flag)
10960 (let (rtn r f (l (length string)))
10961 (cond
10962 ((eq flag nil)
10963 ;; try completion
10964 (try-completion string thetable))
10965 ((eq flag t)
10966 ;; all-completions
10967 (setq rtn (all-completions string thetable predicate))
10968 (mapcar
10969 (lambda (x)
10970 (setq r (substring x l))
10971 (if (string-match " ([^)]*)$" x)
10972 (setq f (match-string 0 x))
10973 (setq f ""))
10974 (if (string-match "/" r)
10975 (concat string (substring r 0 (match-end 0)) f)
10976 x))
10977 rtn))
10978 ((eq flag 'lambda)
10979 ;; exact match?
10980 (assoc string thetable)))))
10981 args)))
10983 ;;;; Dynamic blocks
10985 (defun org-find-dblock (name)
10986 "Find the first dynamic block with name NAME in the buffer.
10987 If not found, stay at current position and return nil."
10988 (let (pos)
10989 (save-excursion
10990 (goto-char (point-min))
10992 nil t)
10993 (match-beginning 0))))
10994 (if pos (goto-char pos))
10995 pos))
10997 (defconst org-dblock-start-re
10999 "Matches the start line of a dynamic block, with parameters.")
11002 "Matches the end of a dynamic block.")
11004 (defun org-create-dblock (plist)
11005 "Create a dynamic block section, with parameters taken from PLIST.
11006 PLIST must contain a :name entry which is used as name of the block."
11008 (end-of-line 1)
11009 (newline))
11010 (let ((col (current-column))
11011 (name (plist-get plist :name)))
11012 (insert "#+BEGIN: " name)
11013 (while plist
11014 (if (eq (car plist) :name)
11015 (setq plist (cddr plist))
11016 (insert " " (prin1-to-string (pop plist)))))
11018 (beginning-of-line -2)))
11020 (defun org-prepare-dblock ()
11021 "Prepare dynamic block for refresh.
11022 This empties the block, puts the cursor at the insert position and returns
11023 the property list including an extra property :name with the block name."
11024 (unless (looking-at org-dblock-start-re)
11025 (error "Not at a dynamic block"))
11026 (let* ((begdel (1+ (match-end 0)))
11027 (name (org-no-properties (match-string 1)))
11028 (params (append (list :name name)
11029 (read (concat "(" (match-string 3) ")")))))
11030 (save-excursion
11031 (beginning-of-line 1)
11033 (setq params (plist-put params :indentation-column (current-column))))
11034 (unless (re-search-forward org-dblock-end-re nil t)
11035 (error "Dynamic block not terminated"))
11036 (setq params
11037 (append params
11038 (list :content (buffer-substring
11039 begdel (match-beginning 0)))))
11040 (delete-region begdel (match-beginning 0))
11041 (goto-char begdel)
11042 (open-line 1)
11043 params))
11045 (defun org-map-dblocks (&optional command)
11046 "Apply COMMAND to all dynamic blocks in the current buffer.
11047 If COMMAND is not given, use `org-update-dblock'."
11048 (let ((cmd (or command 'org-update-dblock)))
11049 (save-excursion
11050 (goto-char (point-min))
11051 (while (re-search-forward org-dblock-start-re nil t)
11052 (goto-char (match-beginning 0))
11053 (save-excursion
11054 (condition-case nil
11055 (funcall cmd)
11056 (error (message "Error during update of dynamic block"))))
11057 (unless (re-search-forward org-dblock-end-re nil t)
11058 (error "Dynamic block not terminated"))))))
11060 (defun org-dblock-update (&optional arg)
11061 "User command for updating dynamic blocks.
11062 Update the dynamic block at point. With prefix ARG, update all dynamic
11063 blocks in the buffer."
11064 (interactive "P")
11065 (if arg
11066 (org-update-all-dblocks)
11067 (or (looking-at org-dblock-start-re)
11068 (org-beginning-of-dblock))
11069 (org-update-dblock)))
11071 (defun org-update-dblock ()
11072 "Update the dynamic block at point.
11073 This means to empty the block, parse for parameters and then call
11074 the correct writing function."
11075 (interactive)
11076 (save-window-excursion
11077 (let* ((pos (point))
11078 (line (org-current-line))
11079 (params (org-prepare-dblock))
11080 (name (plist-get params :name))
11081 (indent (plist-get params :indentation-column))
11082 (cmd (intern (concat "org-dblock-write:" name))))
11083 (message "Updating dynamic block `%s' at line %d..." name line)
11084 (funcall cmd params)
11085 (message "Updating dynamic block `%s' at line %d...done" name line)
11086 (goto-char pos)
11087 (when (and indent (> indent 0))
11088 (setq indent (make-string indent ?\ ))
11089 (save-excursion
11090 (org-beginning-of-dblock)
11091 (forward-line 1)
11092 (while (not (looking-at org-dblock-end-re))
11093 (insert indent)
11094 (beginning-of-line 2))
11095 (when (looking-at org-dblock-end-re)
11097 (replace-match ""))
11098 (insert indent)))))))
11100 (defun org-beginning-of-dblock ()
11101 "Find the beginning of the dynamic block at point.
11102 Error if there is no such block at point."
11103 (let ((pos (point))
11104 beg)
11105 (end-of-line 1)
11106 (if (and (re-search-backward org-dblock-start-re nil t)
11107 (setq beg (match-beginning 0))
11108 (re-search-forward org-dblock-end-re nil t)
11109 (> (match-end 0) pos))
11110 (goto-char beg)
11111 (goto-char pos)
11112 (error "Not in a dynamic block"))))
11114 ;;;###autoload
11115 (defun org-update-all-dblocks ()
11116 "Update all dynamic blocks in the buffer.
11117 This function can be used in a hook."
11118 (interactive)
11119 (when (derived-mode-p 'org-mode)
11120 (org-map-dblocks 'org-update-dblock)))
11123 ;;;; Completion
11125 (defconst org-additional-option-like-keywords
11126 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11127 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11128 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11129 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11130 "BEGIN:" "END:"
11131 "ORGTBL" "TBLFM:" "TBLNAME:"
11132 "BEGIN_EXAMPLE" "END_EXAMPLE"
11133 "BEGIN_QUOTE" "END_QUOTE"
11134 "BEGIN_VERSE" "END_VERSE"
11135 "BEGIN_CENTER" "END_CENTER"
11136 "BEGIN_SRC" "END_SRC"
11137 "BEGIN_RESULT" "END_RESULT"
11138 "NAME:" "RESULTS:"
11139 "HEADER:" "HEADERS:"
11140 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11141 "CAPTION:" "LABEL:"
11142 "SETUPFILE:"
11143 "INCLUDE:"
11144 "BIND:"
11145 "MACRO:"))
11147 (defcustom org-structure-template-alist
11148 '(
11161 ("L" "#+LaTeX: "
11165 ("H" "#+HTML: "
11168 ("A" "#+ASCII: ")
11169 ("i" "#+INDEX: ?"
11170 "#+INDEX: ?")
11171 ("I" "#+INCLUDE %file ?"
11173 )
11174 "Structure completion elements.
11175 This is a list of abbreviation keys and values. The value gets inserted
11176 if you type `<' followed by the key and then press the completion key,
11177 usually `M-TAB'. %file will be replaced by a file name after prompting
11178 for the file using completion. The cursor will be placed at the position
11179 of the `?` in the template.
11180 There are two templates for each key, the first uses the original Org syntax,
11181 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11182 the default when the /org-mtags.el/ module has been loaded. See also the
11183 variable `org-mtags-prefer-muse-templates'."
11184 :group 'org-completion
11185 :type '(repeat
11186 (string :tag "Key")
11187 (string :tag "Template")
11188 (string :tag "Muse Template")))
11190 (defun org-try-structure-completion ()
11191 "Try to complete a structure template before point.
11193 expands them."
11194 (let ((l (buffer-substring (point-at-bol) (point)))
11195 a)
11198 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11199 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11200 (match-beginning 1)) a)
11201 t)))
11203 (defun org-complete-expand-structure-template (start cell)
11204 "Expand a structure template."
11205 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11206 (rpl (nth (if musep 2 1) cell))
11207 (ind ""))
11208 (delete-region start (point))
11210 (cond
11211 ((bolp))
11213 (setq ind (buffer-substring (point-at-bol) (point))))
11214 (t (newline))))
11215 (setq start (point))
11216 (if (string-match "%file" rpl)
11217 (setq rpl (replace-match
11218 (concat
11220 (save-match-data
11221 (abbreviate-file-name (read-file-name "Include file: ")))
11223 t t rpl)))
11226 (insert rpl)
11229 ;;;; TODO, DEADLINE, Comments
11231 (defun org-toggle-comment ()
11232 "Change the COMMENT state of an entry."
11233 (interactive)
11234 (save-excursion
11235 (org-back-to-heading)
11236 (let (case-fold-search)
11237 (cond
11238 ((looking-at (format org-heading-keyword-regexp-format
11239 org-comment-string))
11240 (goto-char (match-end 1))
11241 (looking-at (concat " +" org-comment-string))
11242 (replace-match "" t t)
11243 (when (eolp) (insert " ")))
11244 ((looking-at org-outline-regexp)
11245 (goto-char (match-end 0))
11246 (insert org-comment-string " "))))))
11248 (defvar org-last-todo-state-is-todo nil
11249 "This is non-nil when the last TODO state change led to a TODO state.
11250 If the last change removed the TODO tag or switched to DONE, then
11251 this is nil.")
11253 (defvar org-setting-tags nil) ; dynamically skipped
11255 (defvar org-todo-setup-filter-hook nil
11256 "Hook for functions that pre-filter todo specs.
11257 Each function takes a todo spec and returns either nil or the spec
11258 transformed into canonical form." )
11260 (defvar org-todo-get-default-hook nil
11261 "Hook for functions that get a default item for todo.
11262 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11263 nil or a string to be used for the todo mark." )
11265 (defvar org-agenda-headline-snapshot-before-repeat)
11267 (defun org-current-effective-time ()
11268 "Return current time adjusted for `org-extend-today-until' variable"
11269 (let* ((ct (org-current-time))
11270 (dct (decode-time ct))
11271 (ct1
11272 (if (and org-use-effective-time
11273 (< (nth 2 dct) org-extend-today-until))
11274 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11275 ct)))
11276 ct1))
11278 (defun org-todo-yesterday (&optional arg)
11279 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11280 (interactive "P")
11281 (if (eq major-mode 'org-agenda-mode)
11282 (apply 'org-agenda-todo-yesterday arg)
11283 (let* ((hour (third (decode-time
11284 (org-current-time))))
11285 (org-extend-today-until (1+ hour)))
11286 (org-todo arg))))
11288 (defun org-todo (&optional arg)
11289 "Change the TODO state of an item.
11290 The state of an item is given by a keyword at the start of the heading,
11291 like
11292 *** TODO Write paper
11293 *** DONE Call mom
11295 The different keywords are specified in the variable `org-todo-keywords'.
11297 So for this example: when the item starts with TODO, it is changed to DONE.
11298 When it starts with DONE, the DONE is removed. And when neither TODO nor
11299 DONE are present, add TODO at the beginning of the heading.
11302 state.
11303 With numeric prefix arg, switch to that state.
11305 keywords (nextset).
11307 With a numeric prefix arg of 0, inhibit note taking for the change.
11309 For calling through lisp, arg is also interpreted in the following way:
11310 'none -> empty state
11312 'done -> switch to DONE
11313 'nextset -> switch to the next set of keywords
11314 'previousset -> switch to the previous set of keywords
11316 really is a member of `org-todo-keywords'."
11317 (interactive "P")
11318 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11319 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11320 'region-start-level 'region))
11321 org-loop-over-headlines-in-active-region)
11322 (org-map-entries
11323 `(org-todo ,arg)
11324 org-loop-over-headlines-in-active-region
11325 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11326 (if (equal arg '(16)) (setq arg 'nextset))
11327 (let ((org-blocker-hook org-blocker-hook)
11328 (case-fold-search nil))
11329 (when (equal arg '(64))
11330 (setq arg nil org-blocker-hook nil))
11331 (when (and org-blocker-hook
11332 (or org-inhibit-blocking
11333 (org-entry-get nil "NOBLOCKING")))
11334 (setq org-blocker-hook nil))
11335 (save-excursion
11336 (catch 'exit
11337 (org-back-to-heading t)
11338 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11341 (let* ((match-data (match-data))
11342 (startpos (point-at-bol))
11343 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11344 (org-log-done org-log-done)
11345 (org-log-repeat org-log-repeat)
11346 (org-todo-log-states org-todo-log-states)
11347 (org-inhibit-logging
11348 (if (equal arg 0)
11349 (progn (setq arg nil) 'note) org-inhibit-logging))
11350 (this (match-string 1))
11351 (hl-pos (match-beginning 0))
11352 (head (org-get-todo-sequence-head this))
11353 (ass (assoc head org-todo-kwd-alist))
11354 (interpret (nth 1 ass))
11355 (done-word (nth 3 ass))
11356 (final-done-word (nth 4 ass))
11357 (org-last-state (or this ""))
11358 (completion-ignore-case t)
11359 (member (member this org-todo-keywords-1))
11360 (tail (cdr member))
11361 (org-state (cond
11362 ((and org-todo-key-trigger
11363 (or (and (equal arg '(4))
11364 (eq org-use-fast-todo-selection 'prefix))
11365 (and (not arg) org-use-fast-todo-selection
11366 (not (eq org-use-fast-todo-selection
11367 'prefix)))))
11368 ;; Use fast selection
11369 (org-fast-todo-selection))
11370 ((and (equal arg '(4))
11371 (or (not org-use-fast-todo-selection)
11372 (not org-todo-key-trigger)))
11373 ;; Read a state with completion
11374 (org-icompleting-read
11375 "State: " (mapcar (lambda(x) (list x))
11376 org-todo-keywords-1)
11377 nil t))
11378 ((eq arg 'right)
11379 (if this
11380 (if tail (car tail) nil)
11381 (car org-todo-keywords-1)))
11382 ((eq arg 'left)
11383 (if (equal member org-todo-keywords-1)
11384 nil
11385 (if this
11386 (nth (- (length org-todo-keywords-1)
11387 (length tail) 2)
11388 org-todo-keywords-1)
11389 (org-last org-todo-keywords-1))))
11390 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11391 (setq arg nil))) ; hack to fall back to cycling
11392 (arg
11393 ;; user or caller requests a specific state
11394 (cond
11395 ((equal arg "") nil)
11396 ((eq arg 'none) nil)
11397 ((eq arg 'done) (or done-word (car org-done-keywords)))
11398 ((eq arg 'nextset)
11399 (or (car (cdr (member head org-todo-heads)))
11400 (car org-todo-heads)))
11401 ((eq arg 'previousset)
11402 (let ((org-todo-heads (reverse org-todo-heads)))
11403 (or (car (cdr (member head org-todo-heads)))
11404 (car org-todo-heads))))
11405 ((car (member arg org-todo-keywords-1)))
11406 ((stringp arg)
11407 (error "State `%s' not valid in this file" arg))
11408 ((nth (1- (prefix-numeric-value arg))
11409 org-todo-keywords-1))))
11410 ((null member) (or head (car org-todo-keywords-1)))
11411 ((equal this final-done-word) nil) ;; -> make empty
11412 ((null tail) nil) ;; -> first entry
11413 ((memq interpret '(type priority))
11414 (if (eq this-command last-command)
11415 (car tail)
11416 (if (> (length tail) 0)
11417 (or done-word (car org-done-keywords))
11418 nil)))
11419 (t
11420 (car tail))))
11421 (org-state (or
11422 (run-hook-with-args-until-success
11423 'org-todo-get-default-hook org-state org-last-state)
11424 org-state))
11425 (next (if org-state (concat " " org-state " ") " "))
11426 (change-plist (list :type 'todo-state-change :from this :to org-state
11427 :position startpos))
11428 dolog now-done-p)
11429 (when org-blocker-hook
11430 (setq org-last-todo-state-is-todo
11431 (not (member this org-done-keywords)))
11432 (unless (save-excursion
11433 (save-match-data
11434 (org-with-wide-buffer
11435 (run-hook-with-args-until-failure
11436 'org-blocker-hook change-plist))))
11437 (if (org-called-interactively-p 'interactive)
11438 (error "TODO state change from %s to %s blocked" this org-state)
11439 ;; fail silently
11440 (message "TODO state change from %s to %s blocked" this org-state)
11441 (throw 'exit nil))))
11442 (store-match-data match-data)
11443 (replace-match next t t)
11444 (unless (pos-visible-in-window-p hl-pos)
11445 (message "TODO state changed to %s" (org-trim next)))
11446 (unless head
11447 (setq head (org-get-todo-sequence-head org-state)
11448 ass (assoc head org-todo-kwd-alist)
11449 interpret (nth 1 ass)
11450 done-word (nth 3 ass)
11451 final-done-word (nth 4 ass)))
11452 (when (memq arg '(nextset previousset))
11453 (message "Keyword-Set %d/%d: %s"
11454 (- (length org-todo-sets) -1
11455 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11456 (length org-todo-sets)
11457 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11458 (setq org-last-todo-state-is-todo
11459 (not (member org-state org-done-keywords)))
11460 (setq now-done-p (and (member org-state org-done-keywords)
11461 (not (member this org-done-keywords))))
11462 (and logging (org-local-logging logging))
11463 (when (and (or org-todo-log-states org-log-done)
11464 (not (eq org-inhibit-logging t))
11465 (not (memq arg '(nextset previousset))))
11466 ;; we need to look at recording a time and note
11467 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11468 (nth 2 (assoc this org-todo-log-states))))
11469 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11470 (setq dolog 'time))
11471 (when (and org-state
11472 (member org-state org-not-done-keywords)
11473 (not (member this org-not-done-keywords)))
11474 ;; This is now a todo state and was not one before
11475 ;; If there was a CLOSED time stamp, get rid of it.
11476 (org-add-planning-info nil nil 'closed))
11477 (when (and now-done-p org-log-done)
11478 ;; It is now done, and it was not done before
11479 (org-add-planning-info 'closed (org-current-effective-time))
11480 (if (and (not dolog) (eq 'note org-log-done))
11481 (org-add-log-setup 'done org-state this 'findpos 'note)))
11482 (when (and org-state dolog)
11483 ;; This is a non-nil state, and we need to log it
11484 (org-add-log-setup 'state org-state this 'findpos dolog)))
11485 ;; Fixup tag positioning
11486 (org-todo-trigger-tag-changes org-state)
11487 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11488 (when org-provide-todo-statistics
11489 (org-update-parent-todo-statistics))
11490 (run-hooks 'org-after-todo-state-change-hook)
11491 (if (and arg (not (member org-state org-done-keywords)))
11492 (setq head (org-get-todo-sequence-head org-state)))
11493 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11494 ;; Do we need to trigger a repeat?
11495 (when now-done-p
11496 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11497 ;; This is for the agenda, take a snapshot of the headline.
11498 (save-match-data
11499 (setq org-agenda-headline-snapshot-before-repeat
11500 (org-get-heading))))
11501 (org-auto-repeat-maybe org-state))
11502 ;; Fixup cursor location if close to the keyword
11503 (if (and (outline-on-heading-p)
11504 (not (bolp))
11505 (save-excursion (beginning-of-line 1)
11506 (looking-at org-todo-line-regexp))
11507 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11508 (progn
11509 (goto-char (or (match-end 2) (match-end 1)))
11510 (and (looking-at " ") (just-one-space))))
11511 (when org-trigger-hook
11512 (save-excursion
11513 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11515 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11516 "Block turning an entry into a TODO, using the hierarchy.
11517 This checks whether the current task should be blocked from state
11518 changes. Such blocking occurs when:
11520 1. The task has children which are not all in a completed state.
11522 2. A task has a parent with the property :ORDERED:, and there
11523 are siblings prior to the current task with incomplete
11524 status.
11526 3. The parent of the task is blocked because it has siblings that should
11527 be done first, or is child of a block grandparent TODO entry."
11529 (if (not org-enforce-todo-dependencies)
11530 t ; if locally turned off don't block
11531 (catch 'dont-block
11532 ;; If this is not a todo state change, or if this entry is already DONE,
11533 ;; do not block
11534 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11535 (member (plist-get change-plist :from)
11536 (cons 'done org-done-keywords))
11537 (member (plist-get change-plist :to)
11538 (cons 'todo org-not-done-keywords))
11539 (not (plist-get change-plist :to)))
11540 (throw 'dont-block t))
11541 ;; If this task has children, and any are undone, it's blocked
11542 (save-excursion
11543 (org-back-to-heading t)
11544 (let ((this-level (funcall outline-level)))
11545 (outline-next-heading)
11546 (let ((child-level (funcall outline-level)))
11547 (while (and (not (eobp))
11548 (> child-level this-level))
11549 ;; this todo has children, check whether they are all
11550 ;; completed
11551 (if (and (not (org-entry-is-done-p))
11552 (org-entry-is-todo-p))
11553 (throw 'dont-block nil))
11554 (outline-next-heading)
11555 (setq child-level (funcall outline-level))))))
11556 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11557 ;; any previous siblings are undone, it's blocked
11558 (save-excursion
11559 (org-back-to-heading t)
11560 (let* ((pos (point))
11561 (parent-pos (and (org-up-heading-safe) (point))))
11562 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11563 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11564 (forward-line 1)
11565 (re-search-forward org-not-done-heading-regexp pos t))
11566 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11567 ;; Search further up the hierarchy, to see if an ancestor is blocked
11568 (while t
11569 (goto-char parent-pos)
11570 (if (not (looking-at org-not-done-heading-regexp))
11571 (throw 'dont-block t)) ; do not block, parent is not a TODO
11572 (setq pos (point))
11573 (setq parent-pos (and (org-up-heading-safe) (point)))
11574 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11575 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11576 (forward-line 1)
11577 (re-search-forward org-not-done-heading-regexp pos t))
11578 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11580 (defcustom org-track-ordered-property-with-tag nil
11581 "Should the ORDERED property also be shown as a tag?
11582 The ORDERED property decides if an entry should require subtasks to be
11583 completed in sequence. Since a property is not very visible, setting
11584 this option means that toggling the ORDERED property with the command
11585 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11586 not relevant for the behavior, but it makes things more visible.
11588 Note that toggling the tag with tags commands will not change the property
11589 and therefore not influence behavior!
11591 This can be t, meaning the tag ORDERED should be used, It can also be a
11592 string to select a different tag for this task."
11593 :group 'org-todo
11594 :type '(choice
11595 (const :tag "No tracking" nil)
11596 (const :tag "Track with ORDERED tag" t)
11597 (string :tag "Use other tag")))
11599 (defun org-toggle-ordered-property ()
11600 "Toggle the ORDERED property of the current entry.
11601 For better visibility, you can track the value of this property with a tag.
11602 See variable `org-track-ordered-property-with-tag'."
11603 (interactive)
11604 (let* ((t1 org-track-ordered-property-with-tag)
11605 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11606 (save-excursion
11607 (org-back-to-heading)
11608 (if (org-entry-get nil "ORDERED")
11609 (progn
11610 (org-delete-property "ORDERED")
11611 (and tag (org-toggle-tag tag 'off))
11612 (message "Subtasks can be completed in arbitrary order"))
11613 (org-entry-put nil "ORDERED" "t")
11614 (and tag (org-toggle-tag tag 'on))
11615 (message "Subtasks must be completed in sequence")))))
11617 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11618 (defun org-block-todo-from-checkboxes (change-plist)
11619 "Block turning an entry into a TODO, using checkboxes.
11620 This checks whether the current task should be blocked from state
11621 changes because there are unchecked boxes in this entry."
11622 (if (not org-enforce-todo-checkbox-dependencies)
11623 t ; if locally turned off don't block
11624 (catch 'dont-block
11625 ;; If this is not a todo state change, or if this entry is already DONE,
11626 ;; do not block
11627 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11628 (member (plist-get change-plist :from)
11629 (cons 'done org-done-keywords))
11630 (member (plist-get change-plist :to)
11631 (cons 'todo org-not-done-keywords))
11632 (not (plist-get change-plist :to)))
11633 (throw 'dont-block t))
11634 ;; If this task has checkboxes that are not checked, it's blocked
11635 (save-excursion
11636 (org-back-to-heading t)
11637 (let ((beg (point)) end)
11638 (outline-next-heading)
11639 (setq end (point))
11640 (goto-char beg)
11641 (if (org-list-search-forward
11642 (concat (org-item-beginning-re)
11645 end t)
11646 (progn
11647 (if (boundp 'org-blocked-by-checkboxes)
11648 (setq org-blocked-by-checkboxes t))
11649 (throw 'dont-block nil)))))
11650 t))) ; do not block
11652 (defun org-entry-blocked-p ()
11653 "Is the current entry blocked?"
11654 (if (org-entry-get nil "NOBLOCKING")
11655 nil ;; Never block this entry
11656 (not
11657 (run-hook-with-args-until-failure
11658 'org-blocker-hook
11659 (list :type 'todo-state-change
11660 :position (point)
11661 :from 'todo
11662 :to 'done)))))
11664 (defun org-update-statistics-cookies (all)
11665 "Update the statistics cookie, either from TODO or from checkboxes.
11666 This should be called with the cursor in a line with a statistics cookie."
11667 (interactive "P")
11668 (if all
11669 (progn
11670 (org-update-checkbox-count 'all)
11671 (org-map-entries 'org-update-parent-todo-statistics))
11672 (if (not (org-at-heading-p))
11673 (org-update-checkbox-count)
11674 (let ((pos (move-marker (make-marker) (point)))
11675 end l1 l2)
11676 (ignore-errors (org-back-to-heading t))
11677 (if (not (org-at-heading-p))
11678 (org-update-checkbox-count)
11679 (setq l1 (org-outline-level))
11680 (setq end (save-excursion
11681 (outline-next-heading)
11682 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11683 (point)))
11684 (if (and (save-excursion
11685 (re-search-forward
11687 (not (save-excursion (re-search-forward
11689 (org-update-checkbox-count)
11690 (if (and l2 (> l2 l1))
11691 (progn
11692 (goto-char end)
11693 (org-update-parent-todo-statistics))
11694 (goto-char pos)
11695 (beginning-of-line 1)
11696 (while (re-search-forward
11698 (point-at-eol) t)
11699 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11700 (goto-char pos)
11701 (move-marker pos nil)))))
11703 (defvar org-entry-property-inherited-from) ;; defined below
11704 (defun org-update-parent-todo-statistics ()
11705 "Update any statistics cookie in the parent of the current headline.
11706 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11707 the entire subtree and this will travel up the hierarchy and update
11708 statistics everywhere."
11709 (let* ((prop (save-excursion (org-up-heading-safe)
11710 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11711 (recursive (or (not org-hierarchical-todo-statistics)
11713 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11714 0))
11715 (first t)
11717 level ltoggle l1 new ndel
11718 (cnt-all 0) (cnt-done 0) is-percent kwd
11719 checkbox-beg ov ovs ove cookie-present)
11720 (catch 'exit
11721 (save-excursion
11722 (beginning-of-line 1)
11723 (setq ltoggle (funcall outline-level))
11724 ;; Three situations are to consider:
11726 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11727 ;; to the top-level ancestor on the headline;
11729 ;; 2. If parent has "recursive" property, repeat up to the
11730 ;; headline setting that property, taking inheritance into
11731 ;; account;
11733 ;; 3. Else, move up to direct parent and proceed only once.
11734 (while (and (setq level (org-up-heading-safe))
11735 (or recursive first)
11736 (>= (point) lim))
11737 (setq first nil cookie-present nil)
11738 (unless (and level
11739 (not (string-match
11741 (downcase (or (org-entry-get nil "COOKIE_DATA")
11742 "")))))
11743 (throw 'exit nil))
11744 (while (re-search-forward box-re (point-at-eol) t)
11745 (setq cnt-all 0 cnt-done 0 cookie-present t)
11746 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11747 (save-match-data
11748 (unless (outline-next-heading) (throw 'exit nil))
11749 (while (and (looking-at org-complex-heading-regexp)
11750 (> (setq l1 (length (match-string 1))) level))
11751 (setq kwd (and (or recursive (= l1 ltoggle))
11752 (match-string 2)))
11753 (if (or (eq org-provide-todo-statistics 'all-headlines)
11754 (and (listp org-provide-todo-statistics)
11755 (or (member kwd org-provide-todo-statistics)
11756 (member kwd org-done-keywords))))
11757 (setq cnt-all (1+ cnt-all))
11758 (if (eq org-provide-todo-statistics t)
11759 (and kwd (setq cnt-all (1+ cnt-all)))))
11760 (and (member kwd org-done-keywords)
11761 (setq cnt-done (1+ cnt-done)))
11762 (outline-next-heading)))
11763 (setq new
11764 (if is-percent
11765 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11766 (format "[%d/%d]" cnt-done cnt-all))
11767 ndel (- (match-end 0) checkbox-beg))
11768 ;; handle overlays when updating cookie from column view
11769 (when (setq ov (car (overlays-at checkbox-beg)))
11770 (setq ovs (overlay-start ov) ove (overlay-end ov))
11771 (delete-overlay ov))
11772 (goto-char checkbox-beg)
11773 (insert new)
11774 (delete-region (point) (+ (point) ndel))
11775 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11776 (when ov (move-overlay ov ovs ove)))
11777 (when cookie-present
11778 (run-hook-with-args 'org-after-todo-statistics-hook
11779 cnt-done (- cnt-all cnt-done))))))
11780 (run-hooks 'org-todo-statistics-hook)))
11782 (defvar org-after-todo-statistics-hook nil
11783 "Hook that is called after a TODO statistics cookie has been updated.
11784 Each function is called with two arguments: the number of not-done entries
11785 and the number of done entries.
11787 For example, the following function, when added to this hook, will switch
11788 an entry to DONE when all children are done, and back to TODO when new
11789 entries are set to a TODO status. Note that this hook is only called
11790 when there is a statistics cookie in the headline!
11792 (defun org-summary-todo (n-done n-not-done)
11794 (let (org-log-done org-log-states) ; turn off logging
11796 ")
11798 (defvar org-todo-statistics-hook nil
11799 "Hook that is run whenever Org thinks TODO statistics should be updated.
11800 This hook runs even if there is no statistics cookie present, in which case
11801 `org-after-todo-statistics-hook' would not run.")
11803 (defun org-todo-trigger-tag-changes (state)
11804 "Apply the changes defined in `org-todo-state-tags-triggers'."
11805 (let ((l org-todo-state-tags-triggers)
11806 changes)
11807 (when (or (not state) (equal state ""))
11808 (setq changes (append changes (cdr (assoc "" l)))))
11809 (when (and (stringp state) (> (length state) 0))
11810 (setq changes (append changes (cdr (assoc state l)))))
11811 (when (member state org-not-done-keywords)
11812 (setq changes (append changes (cdr (assoc 'todo l)))))
11813 (when (member state org-done-keywords)
11814 (setq changes (append changes (cdr (assoc 'done l)))))
11815 (dolist (c changes)
11816 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11818 (defun org-local-logging (value)
11819 "Get logging settings from a property VALUE."
11820 (let* (words w a)
11821 ;; directly set the variables, they are already local.
11822 (setq org-log-done nil
11823 org-log-repeat nil
11824 org-todo-log-states nil)
11825 (setq words (org-split-string value))
11826 (while (setq w (pop words))
11827 (cond
11828 ((setq a (assoc w org-startup-options))
11829 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11830 (set (nth 1 a) (nth 2 a))))
11831 ((setq a (org-extract-log-state-settings w))
11832 (and (member (car a) org-todo-keywords-1)
11833 (push a org-todo-log-states)))))))
11835 (defun org-get-todo-sequence-head (kwd)
11836 "Return the head of the TODO sequence to which KWD belongs.
11837 If KWD is not set, check if there is a text property remembering the
11838 right sequence."
11839 (let (p)
11840 (cond
11841 ((not kwd)
11842 (or (get-text-property (point-at-bol) 'org-todo-head)
11843 (progn
11844 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11845 nil (point-at-eol)))
11846 (get-text-property p 'org-todo-head))))
11847 ((not (member kwd org-todo-keywords-1))
11848 (car org-todo-keywords-1))
11849 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11851 (defun org-fast-todo-selection ()
11852 "Fast TODO keyword selection with single keys.
11853 Returns the new TODO keyword, or nil if no state change should occur."
11854 (let* ((fulltable org-todo-key-alist)
11855 (done-keywords org-done-keywords) ;; needed for the faces.
11856 (maxlen (apply 'max (mapcar
11857 (lambda (x)
11858 (if (stringp (car x)) (string-width (car x)) 0))
11859 fulltable)))
11860 (expert nil)
11861 (fwidth (+ maxlen 3 1 3))
11862 (ncol (/ (- (window-width) 4) fwidth))
11863 tg cnt e c tbl
11864 groups ingroup)
11865 (save-excursion
11866 (save-window-excursion
11867 (if expert
11868 (set-buffer (get-buffer-create " *Org todo*"))
11869 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11870 (erase-buffer)
11871 (org-set-local 'org-done-keywords done-keywords)
11872 (setq tbl fulltable cnt 0)
11873 (while (setq e (pop tbl))
11874 (cond
11875 ((equal e '(:startgroup))
11876 (push '() groups) (setq ingroup t)
11877 (when (not (= cnt 0))
11878 (setq cnt 0)
11880 (insert "{ "))
11881 ((equal e '(:endgroup))
11882 (setq ingroup nil cnt 0)
11884 ((equal e '(:newline))
11885 (when (not (= cnt 0))
11886 (setq cnt 0)
11888 (setq e (car tbl))
11889 (while (equal (car tbl) '(:newline))
11891 (setq tbl (cdr tbl)))))
11892 (t
11893 (setq tg (car e) c (cdr e))
11894 (if ingroup (push tg (car groups)))
11895 (setq tg (org-add-props tg nil 'face
11896 (org-get-todo-face tg)))
11897 (if (and (= cnt 0) (not ingroup)) (insert " "))
11898 (insert "[" c "] " tg (make-string
11899 (- fwidth 4 (length tg)) ?\ ))
11900 (when (= (setq cnt (1+ cnt)) ncol)
11902 (if ingroup (insert " "))
11903 (setq cnt 0)))))
11905 (goto-char (point-min))
11906 (if (not expert) (org-fit-window-to-buffer))
11907 (message "[a-z..]:Set [SPC]:clear")
11908 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11909 (cond
11910 ((or (= c ?\C-g)
11911 (and (= c ?q) (not (rassoc c fulltable))))
11912 (setq quit-flag t))
11913 ((= c ?\ ) nil)
11914 ((setq e (rassoc c fulltable) tg (car e))
11915 tg)
11916 (t (setq quit-flag t)))))))
11918 (defun org-entry-is-todo-p ()
11919 (member (org-get-todo-state) org-not-done-keywords))
11921 (defun org-entry-is-done-p ()
11922 (member (org-get-todo-state) org-done-keywords))
11924 (defun org-get-todo-state ()
11925 (save-excursion
11926 (org-back-to-heading t)
11927 (and (looking-at org-todo-line-regexp)
11928 (match-end 2)
11929 (match-string 2))))
11931 (defun org-at-date-range-p (&optional inactive-ok)
11932 "Is the cursor inside a date range?"
11933 (interactive)
11934 (save-excursion
11935 (catch 'exit
11936 (let ((pos (point)))
11938 (skip-chars-backward "<[")
11939 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11940 (>= (match-end 0) pos)
11941 (throw 'exit t))
11943 (skip-chars-backward "<[")
11944 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11945 (>= (match-end 0) pos)
11946 (throw 'exit t)))
11947 nil)))
11949 (defun org-get-repeat (&optional tagline)
11950 "Check if there is a deadline/schedule with repeater in this entry."
11951 (save-match-data
11952 (save-excursion
11953 (org-back-to-heading t)
11954 (and (re-search-forward (if tagline
11956 org-repeat-re)
11957 (org-entry-end-position) t)
11958 (match-string-no-properties 1)))))
11960 (defvar org-last-changed-timestamp)
11961 (defvar org-last-inserted-timestamp)
11962 (defvar org-log-post-message)
11963 (defvar org-log-note-purpose)
11964 (defvar org-log-note-how)
11965 (defvar org-log-note-extra)
11966 (defun org-auto-repeat-maybe (done-word)
11967 "Check if the current headline contains a repeated deadline/schedule.
11968 If yes, set TODO state back to what it was and change the base date
11969 of repeating deadline/scheduled time stamps to new date.
11970 This function is run automatically after each state change to a DONE state."
11971 ;; last-state is dynamically scoped into this function
11972 (let* ((repeat (org-get-repeat))
11973 (aa (assoc org-last-state org-todo-kwd-alist))
11974 (interpret (nth 1 aa))
11975 (head (nth 2 aa))
11976 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
11977 (msg "Entry repeats: ")
11978 (org-log-done nil)
11979 (org-todo-log-states nil)
11980 re type n what ts time to-state)
11981 (when repeat
11982 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11983 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11984 org-todo-repeat-to-state))
11985 (unless (and to-state (member to-state org-todo-keywords-1))
11986 (setq to-state (if (eq interpret 'type) org-last-state head)))
11987 (org-todo to-state)
11988 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11989 (org-entry-put nil "LAST_REPEAT" (format-time-string
11990 (org-time-stamp-format t t))))
11991 (when org-log-repeat
11992 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11993 (memq 'org-add-log-note post-command-hook))
11994 ;; OK, we are already setup for some record
11995 (if (eq org-log-repeat 'note)
11996 ;; make sure we take a note, not only a time stamp
11997 (setq org-log-note-how 'note))
11998 ;; Set up for taking a record
11999 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12000 org-last-state
12001 'findpos org-log-repeat)))
12002 (org-back-to-heading t)
12003 (org-add-planning-info nil nil 'closed)
12007 (while (re-search-forward
12008 re (save-excursion (outline-next-heading) (point)) t)
12009 (setq type (if (match-end 1) org-scheduled-string
12010 (if (match-end 3) org-deadline-string "Plain:"))
12011 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12013 (setq n (string-to-number (match-string 2 ts))
12014 what (match-string 3 ts))
12015 (if (equal what "w") (setq n (* n 7) what "d"))
12017 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12018 ;; Preparation, see if we need to modify the start date for the change
12019 (when (match-end 1)
12020 (setq time (save-match-data (org-time-string-to-time ts)))
12021 (cond
12022 ((equal (match-string 1 ts) ".")
12023 ;; Shift starting date to today
12024 (org-timestamp-change
12025 (- (org-today) (time-to-days time))
12026 'day))
12027 ((equal (match-string 1 ts) "+")
12028 (let ((nshiftmax 10) (nshift 0))
12029 (while (or (= nshift 0)
12030 (<= (time-to-days time)
12031 (time-to-days (current-time))))
12032 (when (= (incf nshift) nshiftmax)
12033 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12034 (error "Abort")))
12035 (org-timestamp-change n (cdr (assoc what whata)))
12036 (org-at-timestamp-p t)
12037 (setq ts (match-string 1))
12038 (setq time (save-match-data (org-time-string-to-time ts)))))
12039 (org-timestamp-change (- n) (cdr (assoc what whata)))
12040 ;; rematch, so that we have everything in place for the real shift
12041 (org-at-timestamp-p t)
12042 (setq ts (match-string 1))
12044 (org-timestamp-change n (cdr (assoc what whata)))
12045 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12046 (setq org-log-post-message msg)
12047 (message "%s" msg))))
12049 (defun org-show-todo-tree (arg)
12050 "Make a compact tree which shows all headlines marked with TODO.
12051 The tree will show the lines where the regexp matches, and all higher
12052 headlines above the match.
12054 With a numeric prefix N, construct a sparse tree for the Nth element
12055 of `org-todo-keywords-1'."
12056 (interactive "P")
12057 (let ((case-fold-search nil)
12058 (kwd-re
12059 (cond ((null arg) org-not-done-regexp)
12060 ((equal arg '(4))
12061 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12062 (mapcar 'list org-todo-keywords-1))))
12066 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12067 (regexp-quote (nth (1- (prefix-numeric-value arg))
12068 org-todo-keywords-1)))
12069 (t (error "Invalid prefix argument: %s" arg)))))
12070 (message "%d TODO entries found"
12071 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12073 (defun org-deadline (&optional remove time)
12075 With argument REMOVE, remove any deadline from the item.
12076 With argument TIME, set the deadline at the corresponding date. TIME
12078 (interactive "P")
12079 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12080 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12081 'region-start-level 'region))
12082 org-loop-over-headlines-in-active-region)
12083 (org-map-entries
12084 `(org-deadline ',remove ,time)
12085 org-loop-over-headlines-in-active-region
12086 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12087 (let* ((old-date (org-entry-get nil "DEADLINE"))
12088 (repeater (and old-date
12089 (string-match
12091 old-date)
12092 (match-string 1 old-date))))
12093 (if remove
12094 (progn
12095 (when (and old-date org-log-redeadline)
12096 (org-add-log-setup 'deldeadline nil old-date 'findpos
12097 org-log-redeadline))
12098 (org-remove-timestamp-with-keyword org-deadline-string)
12099 (message "Item no longer has a deadline."))
12100 (org-add-planning-info 'deadline time 'closed)
12101 (when (and old-date org-log-redeadline
12102 (not (equal old-date
12103 (substring org-last-inserted-timestamp 1 -1))))
12104 (org-add-log-setup 'redeadline nil old-date 'findpos
12105 org-log-redeadline))
12106 (when repeater
12107 (save-excursion
12108 (org-back-to-heading t)
12109 (when (re-search-forward (concat org-deadline-string " "
12110 org-last-inserted-timestamp)
12111 (save-excursion
12112 (outline-next-heading) (point)) t)
12113 (goto-char (1- (match-end 0)))
12114 (insert " " repeater)
12115 (setq org-last-inserted-timestamp
12116 (concat (substring org-last-inserted-timestamp 0 -1)
12117 " " repeater
12118 (substring org-last-inserted-timestamp -1))))))
12119 (message "Deadline on %s" org-last-inserted-timestamp)))))
12121 (defun org-schedule (&optional remove time)
12122 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12123 With argument REMOVE, remove any scheduling date from the item.
12124 With argument TIME, scheduled at the corresponding date. TIME can
12126 (interactive "P")
12127 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12128 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12129 'region-start-level 'region))
12130 org-loop-over-headlines-in-active-region)
12131 (org-map-entries
12132 `(org-schedule ',remove ,time)
12133 org-loop-over-headlines-in-active-region
12134 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12135 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12136 (repeater (and old-date
12137 (string-match
12139 old-date)
12140 (match-string 1 old-date))))
12141 (if remove
12142 (progn
12143 (when (and old-date org-log-reschedule)
12144 (org-add-log-setup 'delschedule nil old-date 'findpos
12145 org-log-reschedule))
12146 (org-remove-timestamp-with-keyword org-scheduled-string)
12147 (message "Item is no longer scheduled."))
12148 (org-add-planning-info 'scheduled time 'closed)
12149 (when (and old-date org-log-reschedule
12150 (not (equal old-date
12151 (substring org-last-inserted-timestamp 1 -1))))
12152 (org-add-log-setup 'reschedule nil old-date 'findpos
12153 org-log-reschedule))
12154 (when repeater
12155 (save-excursion
12156 (org-back-to-heading t)
12157 (when (re-search-forward (concat org-scheduled-string " "
12158 org-last-inserted-timestamp)
12159 (save-excursion
12160 (outline-next-heading) (point)) t)
12161 (goto-char (1- (match-end 0)))
12162 (insert " " repeater)
12163 (setq org-last-inserted-timestamp
12164 (concat (substring org-last-inserted-timestamp 0 -1)
12165 " " repeater
12166 (substring org-last-inserted-timestamp -1))))))
12167 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12169 (defun org-get-scheduled-time (pom &optional inherit)
12170 "Get the scheduled time as a time tuple, of a format suitable
12171 for calling org-schedule with, or if there is no scheduling,
12172 returns nil."
12173 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12174 (when time
12175 (apply 'encode-time (org-parse-time-string time)))))
12177 (defun org-get-deadline-time (pom &optional inherit)
12178 "Get the deadline as a time tuple, of a format suitable for
12179 calling org-deadline with, or if there is no scheduling, returns
12180 nil."
12181 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12182 (when time
12183 (apply 'encode-time (org-parse-time-string time)))))
12185 (defun org-remove-timestamp-with-keyword (keyword)
12186 "Remove all time stamps with KEYWORD in the current entry."
12188 beg)
12189 (save-excursion
12190 (org-back-to-heading t)
12191 (setq beg (point))
12192 (outline-next-heading)
12193 (while (re-search-backward re beg t)
12194 (replace-match "")
12196 (equal (char-before) ?\ ))
12197 (backward-delete-char 1)
12199 (point-at-bol) (point-at-eol)))
12200 (delete-region (point-at-bol)
12201 (min (point-max) (1+ (point-at-eol))))))))))
12203 (defun org-add-planning-info (what &optional time &rest remove)
12204 "Insert new timestamp with keyword in the line directly after the headline.
12205 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12206 If non is given, the user is prompted for a date.
12207 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12208 be removed."
12209 (interactive)
12210 (let (org-time-was-given org-end-time-was-given ts
12211 end default-time default-input)
12213 (catch 'exit
12214 (when (and (memq what '(scheduled deadline))
12215 (or (not time)
12216 (and (stringp time)
12217 (string-match "^[-+]+[0-9]" time))))
12218 ;; Try to get a default date/time from existing timestamp
12219 (save-excursion
12220 (org-back-to-heading t)
12221 (setq end (save-excursion (outline-next-heading) (point)))
12222 (when (re-search-forward (if (eq what 'scheduled)
12223 org-scheduled-time-regexp
12224 org-deadline-time-regexp)
12225 end t)
12226 (setq ts (match-string 1)
12227 default-time
12228 (apply 'encode-time (org-parse-time-string ts))
12229 default-input (and ts (org-get-compact-tod ts))))))
12230 (when what
12231 (setq time
12232 (if (stringp time)
12233 ;; This is a string (relative or absolute), set proper date
12234 (apply 'encode-time
12235 (org-read-date-analyze
12236 time default-time (decode-time default-time)))
12237 ;; If necessary, get the time from the user
12238 (or time (org-read-date nil 'to-time nil nil
12239 default-time default-input)))))
12241 (when (and org-insert-labeled-timestamps-at-point
12242 (member what '(scheduled deadline)))
12243 (insert
12244 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12245 (org-insert-time-stamp time org-time-was-given
12246 nil nil nil (list org-end-time-was-given))
12247 (setq what nil))
12248 (save-excursion
12249 (save-restriction
12250 (let (col list elt ts buffer-invisibility-spec)
12251 (org-back-to-heading t)
12253 (goto-char (match-end 1))
12254 (setq col (current-column))
12255 (goto-char (match-end 0))
12257 (when (and (not what)
12258 (not (looking-at
12260 org-keyword-time-not-clock-regexp))))
12261 ;; Nothing to add, nothing to remove...... :-)
12262 (throw 'exit nil))
12263 (if (and (not (looking-at org-outline-regexp))
12266 (not (equal (match-string 1) org-clock-string)))
12267 (narrow-to-region (match-beginning 0) (match-end 0))
12269 (backward-char 1)
12270 (narrow-to-region (point) (point))
12271 (and org-adapt-indentation (org-indent-to-column col)))
12272 ;; Check if we have to remove something.
12273 (setq list (cons what remove))
12274 (while list
12275 (setq elt (pop list))
12276 (when (or (and (eq elt 'scheduled)
12277 (re-search-forward org-scheduled-time-regexp nil t))
12278 (and (eq elt 'deadline)
12279 (re-search-forward org-deadline-time-regexp nil t))
12280 (and (eq elt 'closed)
12281 (re-search-forward org-closed-time-regexp nil t)))
12282 (replace-match "")
12283 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12285 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12286 (when what
12287 (insert
12288 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12289 (cond ((eq what 'scheduled) org-scheduled-string)
12290 ((eq what 'deadline) org-deadline-string)
12291 ((eq what 'closed) org-closed-string))
12292 " ")
12293 (setq ts (org-insert-time-stamp
12294 time
12295 (or org-time-was-given
12296 (and (eq what 'closed) org-log-done-with-time))
12297 (eq what 'closed)
12298 nil nil (list org-end-time-was-given)))
12299 (insert
12300 (if (not (or (bolp) (eq (char-before) ?\ )
12301 (memq (char-after) '(32 10))
12302 (eobp))) " " ""))
12303 (end-of-line 1))
12304 (goto-char (point-min))
12305 (widen)
12308 (delete-region (1- (point)) (point-at-eol)))
12309 ts))))))
12311 (defvar org-log-note-marker (make-marker))
12312 (defvar org-log-note-purpose nil)
12313 (defvar org-log-note-state nil)
12314 (defvar org-log-note-previous-state nil)
12315 (defvar org-log-note-how nil)
12316 (defvar org-log-note-extra nil)
12317 (defvar org-log-note-window-configuration nil)
12318 (defvar org-log-note-return-to (make-marker))
12319 (defvar org-log-note-effective-time nil
12320 "Remembered current time so that dynamically scoped
12321 `org-extend-today-until' affects tha timestamps in state change
12322 log")
12324 (defvar org-log-post-message nil
12325 "Message to be displayed after a log note has been stored.
12326 The auto-repeater uses this.")
12328 (defun org-add-note ()
12329 "Add a note to the current entry.
12330 This is done in the same way as adding a state change note."
12331 (interactive)
12332 (org-add-log-setup 'note nil nil 'findpos nil))
12334 (defvar org-property-end-re)
12335 (defun org-add-log-setup (&optional purpose state prev-state
12336 findpos how extra)
12337 "Set up the post command hook to take a note.
12338 If this is about to TODO state change, the new state is expected in STATE.
12339 When FINDPOS is non-nil, find the correct position for the note in
12340 the current entry. If not, assume that it can be inserted at point.
12341 HOW is an indicator what kind of note should be created.
12342 EXTRA is additional text that will be inserted into the notes buffer."
12343 (let* ((org-log-into-drawer (org-log-into-drawer))
12344 (drawer (cond ((stringp org-log-into-drawer)
12345 org-log-into-drawer)
12346 (org-log-into-drawer "LOGBOOK")
12347 (t nil))))
12348 (save-restriction
12349 (save-excursion
12350 (when findpos
12351 (org-back-to-heading t)
12352 (narrow-to-region (point) (save-excursion
12353 (outline-next-heading) (point)))
12357 (goto-char (match-end 0))
12358 (cond
12359 (drawer
12361 nil t)
12362 (progn
12363 (goto-char (match-end 0))
12364 (or org-log-states-order-reversed
12365 (and (re-search-forward org-property-end-re nil t)
12366 (goto-char (1- (match-beginning 0))))))
12368 (beginning-of-line 0)
12369 (org-indent-line-function)
12370 (beginning-of-line 2)
12371 (org-indent-line-function)
12372 (end-of-line 0)))
12373 ((and org-log-state-notes-insert-after-drawers
12374 (save-excursion
12375 (forward-line) (looking-at org-drawer-regexp)))
12376 (forward-line)
12377 (while (looking-at org-drawer-regexp)
12378 (goto-char (match-end 0))
12379 (re-search-forward org-property-end-re (point-max) t)
12380 (forward-line))
12381 (forward-line -1)))
12382 (unless org-log-states-order-reversed
12384 (org-skip-over-state-notes)
12386 (move-marker org-log-note-marker (point))
12387 (setq org-log-note-purpose purpose
12388 org-log-note-state state
12389 org-log-note-previous-state prev-state
12390 org-log-note-how how
12391 org-log-note-extra extra
12392 org-log-note-effective-time (org-current-effective-time))
12393 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12395 (defun org-skip-over-state-notes ()
12396 "Skip past the list of State notes in an entry."
12398 (when (ignore-errors (goto-char (org-in-item-p)))
12399 (let* ((struct (org-list-struct))
12400 (prevs (org-list-prevs-alist struct)))
12402 (goto-char (or (org-list-get-next-item (point) struct prevs)
12403 (org-list-get-item-end (point) struct)))))))
12405 (defun org-add-log-note (&optional purpose)
12406 "Pop up a window for taking a note, and add this note later at point."
12407 (remove-hook 'post-command-hook 'org-add-log-note)
12408 (setq org-log-note-window-configuration (current-window-configuration))
12409 (delete-other-windows)
12410 (move-marker org-log-note-return-to (point))
12411 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12412 (goto-char org-log-note-marker)
12413 (org-switch-to-buffer-other-window "*Org Note*")
12414 (erase-buffer)
12415 (if (memq org-log-note-how '(time state))
12416 (let (current-prefix-arg) (org-store-log-note))
12417 (let ((org-inhibit-startup t)) (org-mode))
12418 (insert (format "# Insert note for %s.
12420 (cond
12421 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12422 ((eq org-log-note-purpose 'done) "closed todo item")
12423 ((eq org-log-note-purpose 'state)
12425 (or org-log-note-previous-state "")
12426 (or org-log-note-state "")))
12427 ((eq org-log-note-purpose 'reschedule)
12428 "rescheduling")
12429 ((eq org-log-note-purpose 'delschedule)
12430 "no longer scheduled")
12431 ((eq org-log-note-purpose 'redeadline)
12432 "changing deadline")
12433 ((eq org-log-note-purpose 'deldeadline)
12434 "removing deadline")
12435 ((eq org-log-note-purpose 'refile)
12436 "refiling")
12437 ((eq org-log-note-purpose 'note)
12438 "this entry")
12439 (t (error "This should not happen")))))
12440 (if org-log-note-extra (insert org-log-note-extra))
12441 (org-set-local 'org-finish-function 'org-store-log-note)
12442 (run-hooks 'org-log-buffer-setup-hook)))
12444 (defvar org-note-abort nil) ; dynamically scoped
12445 (defun org-store-log-note ()
12446 "Finish taking a log note, and insert it to where it belongs."
12447 (let ((txt (buffer-string))
12448 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12449 lines ind bul)
12450 (kill-buffer (current-buffer))
12452 (setq txt (replace-match "" t t txt)))
12454 (setq txt (replace-match "" t t txt)))
12457 (setq note
12458 (org-replace-escapes
12459 note
12460 (list (cons "%u" (user-login-name))
12461 (cons "%U" user-full-name)
12462 (cons "%t" (format-time-string
12463 (org-time-stamp-format 'long 'inactive)
12464 org-log-note-effective-time))
12465 (cons "%T" (format-time-string
12466 (org-time-stamp-format 'long nil)
12467 org-log-note-effective-time))
12468 (cons "%d" (format-time-string
12469 (org-time-stamp-format nil 'inactive)
12470 org-log-note-effective-time))
12471 (cons "%D" (format-time-string
12472 (org-time-stamp-format nil nil)
12473 org-log-note-effective-time))
12474 (cons "%s" (if org-log-note-state
12476 ""))
12477 (cons "%S" (if org-log-note-previous-state
12481 (push note lines))
12482 (when (or current-prefix-arg org-note-abort)
12483 (when org-log-into-drawer
12484 (org-remove-empty-drawer-at
12485 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12486 org-log-note-marker))
12487 (setq lines nil))
12488 (when lines
12489 (with-current-buffer (marker-buffer org-log-note-marker)
12490 (save-excursion
12491 (goto-char org-log-note-marker)
12492 (move-marker org-log-note-marker nil)
12493 (end-of-line 1)
12495 (setq ind (save-excursion
12496 (if (ignore-errors (goto-char (org-in-item-p)))
12497 (let ((struct (org-list-struct)))
12498 (org-list-get-ind
12499 (org-list-get-top-point struct) struct))
12501 (cond
12502 ((and (org-at-heading-p)
12503 org-adapt-indentation)
12504 (1+ (org-current-level)))
12505 ((org-at-heading-p) 0)
12506 (t (org-get-indentation))))))
12507 (setq bul (org-list-bullet-string "-"))
12508 (org-indent-line-to ind)
12509 (insert bul (pop lines))
12510 (let ((ind-body (+ (length bul) ind)))
12511 (while lines
12513 (org-indent-line-to ind-body)
12514 (insert (pop lines))))
12515 (message "Note stored")
12516 (org-back-to-heading t)
12517 (org-cycle-hide-drawers 'children)))))
12518 (set-window-configuration org-log-note-window-configuration)
12519 (with-current-buffer (marker-buffer org-log-note-return-to)
12520 (goto-char org-log-note-return-to))
12521 (move-marker org-log-note-return-to nil)
12522 (and org-log-post-message (message "%s" org-log-post-message)))
12524 (defun org-remove-empty-drawer-at (drawer pos)
12525 "Remove an empty drawer DRAWER at position POS.
12526 POS may also be a marker."
12527 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12528 (save-excursion
12529 (save-restriction
12530 (widen)
12531 (goto-char pos)
12532 (if (org-in-regexp
12534 (replace-match ""))))))
12536 (defun org-sparse-tree (&optional arg)
12537 "Create a sparse tree, prompt for the details.
12538 This command can create sparse trees. You first need to select the type
12539 of match used to create the tree:
12541 t Show all TODO entries.
12542 T Show entries with a specific TODO keyword.
12543 m Show entries selected by a tags/property match.
12544 p Enter a property name and its value (both with completion on existing
12545 names/values) and show entries with that property.
12546 r Show entries matching a regular expression (`/' can be used as well)
12547 d Show deadlines due within `org-deadline-warning-days'.
12548 b Show deadlines and scheduled items before a date.
12549 a Show deadlines and scheduled items after a date."
12550 (interactive "P")
12551 (let (ans kwd value)
12552 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date [D]ates range")
12553 (setq ans (read-char-exclusive))
12554 (cond
12555 ((equal ans ?d)
12556 (call-interactively 'org-check-deadlines))
12557 ((equal ans ?b)
12558 (call-interactively 'org-check-before-date))
12559 ((equal ans ?a)
12560 (call-interactively 'org-check-after-date))
12561 ((equal ans ?D)
12562 (call-interactively 'org-check-dates-range))
12563 ((equal ans ?t)
12564 (org-show-todo-tree nil))
12565 ((equal ans ?T)
12566 (org-show-todo-tree '(4)))
12567 ((member ans '(?T ?m))
12568 (call-interactively 'org-match-sparse-tree))
12569 ((member ans '(?p ?P))
12570 (setq kwd (org-icompleting-read "Property: "
12571 (mapcar 'list (org-buffer-property-keys))))
12572 (setq value (org-icompleting-read "Value: "
12573 (mapcar 'list (org-property-values kwd))))
12576 (org-match-sparse-tree arg (concat kwd "=" value)))
12577 ((member ans '(?r ?R ?/))
12578 (call-interactively 'org-occur))
12581 (defvar org-occur-highlights nil
12582 "List of overlays used for occur matches.")
12583 (make-variable-buffer-local 'org-occur-highlights)
12584 (defvar org-occur-parameters nil
12585 "Parameters of the active org-occur calls.
12586 This is a list, each call to org-occur pushes as cons cell,
12587 containing the regular expression and the callback, onto the list.
12588 The list can contain several entries if `org-occur' has been called
12589 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12590 will only contain one set of parameters. When the highlights are
12591 removed (for example with `C-c C-c', or with the next edit (depending
12592 on `org-remove-highlights-with-change'), this variable is emptied
12593 as well.")
12594 (make-variable-buffer-local 'org-occur-parameters)
12596 (defun org-occur (regexp &optional keep-previous callback)
12597 "Make a compact tree which shows all matches of REGEXP.
12598 The tree will show the lines where the regexp matches, and all higher
12599 headlines above the match. It will also show the heading after the match,
12600 to make sure editing the matching entry is easy.
12601 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12602 call to `org-occur' will be kept, to allow stacking of calls to this
12603 command.
12604 If CALLBACK is non-nil, it is a function which is called to confirm
12605 that the match should indeed be shown."
12607 (when (equal regexp "")
12608 (error "Regexp cannot be empty"))
12609 (unless keep-previous
12610 (org-remove-occur-highlights nil nil t))
12611 (push (cons regexp callback) org-occur-parameters)
12612 (let ((cnt 0))
12613 (save-excursion
12614 (goto-char (point-min))
12615 (if (or (not keep-previous) ; do not want to keep
12616 (not org-occur-highlights)) ; no previous matches
12617 ;; hide everything
12618 (org-overview))
12619 (while (re-search-forward regexp nil t)
12620 (when (or (not callback)
12621 (save-match-data (funcall callback)))
12622 (setq cnt (1+ cnt))
12623 (when org-highlight-sparse-tree-matches
12624 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12625 (org-show-context 'occur-tree))))
12626 (when org-remove-highlights-with-change
12627 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12628 nil 'local))
12629 (unless org-sparse-tree-open-archived-trees
12630 (org-hide-archived-subtrees (point-min) (point-max)))
12631 (run-hooks 'org-occur-hook)
12632 (if (org-called-interactively-p 'interactive)
12633 (message "%d match(es) for regexp %s" cnt regexp))
12634 cnt))
12636 (defun org-occur-next-match (&optional n reset)
12637 "Function for `next-error-function' to find sparse tree matches.
12638 N is the number of matches to move, when negative move backwards.
12639 RESET is entirely ignored - this function always goes back to the
12640 starting point when no match is found."
12641 (let* ((limit (if (< n 0) (point-min) (point-max)))
12642 (search-func (if (< n 0)
12643 'previous-single-char-property-change
12644 'next-single-char-property-change))
12645 (n (abs n))
12646 (pos (point))
12647 p1)
12648 (catch 'exit
12649 (while (setq p1 (funcall search-func (point) 'org-type))
12650 (when (equal p1 limit)
12651 (goto-char pos)
12652 (error "No more matches"))
12653 (when (equal (get-char-property p1 'org-type) 'org-occur)
12654 (setq n (1- n))
12655 (when (= n 0)
12656 (goto-char p1)
12657 (throw 'exit (point))))
12658 (goto-char p1))
12659 (goto-char p1)
12660 (error "No more matches"))))
12662 (defun org-show-context (&optional key)
12663 "Make sure point and context are visible.
12664 How much context is shown depends upon the variables
12665 `org-show-hierarchy-above', `org-show-following-heading',
12666 `org-show-entry-below' and `org-show-siblings'."
12667 (let ((heading-p (org-at-heading-p t))
12668 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12669 (following-p (org-get-alist-option org-show-following-heading key))
12670 (entry-p (org-get-alist-option org-show-entry-below key))
12671 (siblings-p (org-get-alist-option org-show-siblings key)))
12672 (catch 'exit
12673 ;; Show heading or entry text
12674 (if (and heading-p (not entry-p))
12675 (org-flag-heading nil) ; only show the heading
12676 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12677 (org-show-hidden-entry))) ; show entire entry
12678 (when following-p
12679 ;; Show next sibling, or heading below text
12680 (save-excursion
12681 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12682 (org-flag-heading nil))))
12683 (when siblings-p (org-show-siblings))
12684 (when hierarchy-p
12685 ;; show all higher headings, possibly with siblings
12686 (save-excursion
12687 (while (and (condition-case nil
12688 (progn (org-up-heading-all 1) t)
12689 (error nil))
12690 (not (bobp)))
12691 (org-flag-heading nil)
12692 (when siblings-p (org-show-siblings))))))))
12694 (defvar org-reveal-start-hook nil
12695 "Hook run before revealing a location.")
12697 (defun org-reveal (&optional siblings)
12698 "Show current entry, hierarchy above it, and the following headline.
12699 This can be used to show a consistent set of context around locations
12700 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12701 not t for the search context.
12703 With optional argument SIBLINGS, on each level of the hierarchy all
12704 siblings are shown. This repairs the tree structure to what it would
12705 look like when opened with hierarchical calls to `org-cycle'.
12707 go to the parent and show the
12708 entire tree."
12709 (interactive "P")
12710 (run-hooks 'org-reveal-start-hook)
12711 (let ((org-show-hierarchy-above t)
12712 (org-show-following-heading t)
12713 (org-show-siblings (if siblings t org-show-siblings)))
12714 (org-show-context nil))
12715 (when (equal siblings '(16))
12716 (save-excursion
12717 (when (org-up-heading-safe)
12718 (org-show-subtree)
12719 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12721 (defun org-highlight-new-match (beg end)
12722 "Highlight from BEG to END and mark the highlight is an occur headline."
12723 (let ((ov (make-overlay beg end)))
12724 (overlay-put ov 'face 'secondary-selection)
12725 (overlay-put ov 'org-type 'org-occur)
12726 (push ov org-occur-highlights)))
12728 (defun org-remove-occur-highlights (&optional beg end noremove)
12729 "Remove the occur highlights from the buffer.
12730 BEG and END are ignored. If NOREMOVE is nil, remove this function
12731 from the `before-change-functions' in the current buffer."
12732 (interactive)
12733 (unless org-inhibit-highlight-removal
12734 (mapc 'delete-overlay org-occur-highlights)
12735 (setq org-occur-highlights nil)
12736 (setq org-occur-parameters nil)
12737 (unless noremove
12738 (remove-hook 'before-change-functions
12739 'org-remove-occur-highlights 'local))))
12741 ;;;; Priorities
12744 "Regular expression matching the priority indicator.")
12746 (defvar org-remove-priority-next-time nil)
12748 (defun org-priority-up ()
12749 "Increase the priority of the current item."
12750 (interactive)
12751 (org-priority 'up))
12753 (defun org-priority-down ()
12754 "Decrease the priority of the current item."
12755 (interactive)
12756 (org-priority 'down))
12758 (defun org-priority (&optional action)
12759 "Change the priority of an item by ARG.
12760 ACTION can be `set', `up', `down', or a character."
12761 (interactive)
12762 (unless org-enable-priority-commands
12763 (error "Priority commands are disabled"))
12764 (setq action (or action 'set))
12765 (let (current new news have remove)
12766 (save-excursion
12767 (org-back-to-heading t)
12768 (if (looking-at org-priority-regexp)
12769 (setq current (string-to-char (match-string 2))
12770 have t))
12771 (cond
12772 ((eq action 'remove)
12773 (setq remove t new ?\ ))
12774 ((or (eq action 'set)
12775 (if (featurep 'xemacs) (characterp action) (integerp action)))
12776 (if (not (eq action 'set))
12777 (setq new action)
12778 (message "Priority %c-%c, SPC to remove: "
12779 org-highest-priority org-lowest-priority)
12780 (save-match-data
12781 (setq new (read-char-exclusive))))
12782 (if (and (= (upcase org-highest-priority) org-highest-priority)
12783 (= (upcase org-lowest-priority) org-lowest-priority))
12784 (setq new (upcase new)))
12785 (cond ((equal new ?\ ) (setq remove t))
12786 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12787 (error "Priority must be between `%c' and `%c'"
12788 org-highest-priority org-lowest-priority))))
12789 ((eq action 'up)
12790 (setq new (if have
12791 (1- current) ; normal cycling
12792 ;; last priority was empty
12793 (if (eq last-command this-command)
12794 org-lowest-priority ; wrap around empty to lowest
12795 ;; default
12796 (if org-priority-start-cycle-with-default
12797 org-default-priority
12798 (1- org-default-priority))))))
12799 ((eq action 'down)
12800 (setq new (if have
12801 (1+ current) ; normal cycling
12802 ;; last priority was empty
12803 (if (eq last-command this-command)
12804 org-highest-priority ; wrap around empty to highest
12805 ;; default
12806 (if org-priority-start-cycle-with-default
12807 org-default-priority
12808 (1+ org-default-priority))))))
12809 (t (error "Invalid action")))
12810 (if (or (< (upcase new) org-highest-priority)
12811 (> (upcase new) org-lowest-priority))
12812 (if (and (memq action '(up down))
12813 (not have) (not (eq last-command this-command)))
12814 ;; `new' is from default priority
12815 (error
12816 "The default can not be set, see `org-default-priority' why")
12817 ;; normal cycling: `new' is beyond highest/lowest priority
12818 ;; and is wrapped around to the empty priority
12819 (setq remove t)))
12820 (setq news (format "%c" new))
12821 (if have
12822 (if remove
12823 (replace-match "" t t nil 1)
12824 (replace-match news t t nil 2))
12825 (if remove
12826 (error "No priority cookie found in line")
12827 (let ((case-fold-search nil))
12828 (looking-at org-todo-line-regexp))
12829 (if (match-end 2)
12830 (progn
12831 (goto-char (match-end 2))
12832 (insert " [#" news "]"))
12833 (goto-char (match-beginning 3))
12834 (insert "[#" news "] "))))
12835 (org-preserve-lc (org-set-tags nil 'align)))
12836 (if remove
12837 (message "Priority removed")
12838 (message "Priority of current item set to %s" news))))
12840 (defun org-get-priority (s)
12841 "Find priority cookie and return priority."
12842 (if (functionp org-get-priority-function)
12843 (funcall org-get-priority-function)
12844 (save-match-data
12845 (if (not (string-match org-priority-regexp s))
12846 (* 1000 (- org-lowest-priority org-default-priority))
12847 (* 1000 (- org-lowest-priority
12848 (string-to-char (match-string 2 s))))))))
12850 ;;;; Tags
12852 (defvar org-agenda-archives-mode)
12853 (defvar org-map-continue-from nil
12854 "Position from where mapping should continue.
12855 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12857 (defvar org-scanner-tags nil
12858 "The current tag list while the tags scanner is running.")
12859 (defvar org-trust-scanner-tags nil
12860 "Should `org-get-tags-at' use the tags for the scanner.
12861 This is for internal dynamical scoping only.
12862 When this is non-nil, the function `org-get-tags-at' will return the value
12863 of `org-scanner-tags' instead of building the list by itself. This
12864 can lead to large speed-ups when the tags scanner is used in a file with
12865 many entries, and when the list of tags is retrieved, for example to
12866 obtain a list of properties. Building the tags list for each entry in such
12867 a file becomes an N^2 operation - but with this variable set, it scales
12868 as N.")
12870 (defun org-scan-tags (action matcher todo-only &optional start-level)
12871 "Scan headline tags with inheritance and produce output ACTION.
12873 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12874 or `agenda' to produce an entry list for an agenda view. It can also be
12875 a Lisp form or a function that should be called at each matched headline, in
12876 this case the return value is a list of all return values from these calls.
12878 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12879 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12880 only lines with a not-done TODO keyword are included in the output.
12881 This should be the same variable that was scoped into
12882 and set by `org-make-tags-matcher' when it constructed MATCHER.
12884 START-LEVEL can be a string with asterisks, reducing the scope to
12885 headlines matching this string."
12886 (require 'org-agenda)
12887 (let* ((re (concat "^"
12888 (if start-level
12889 ;; Get the correct level to match
12891 org-outline-regexp)
12894 (org-re
12895 (if todo-only
12898 (props (list 'face 'default
12899 'done-face 'org-agenda-done
12900 'undone-face 'default
12901 'mouse-face 'highlight
12902 'org-not-done-regexp org-not-done-regexp
12903 'org-todo-regexp org-todo-regexp
12904 'org-complex-heading-regexp org-complex-heading-regexp
12905 'help-echo
12906 (format "mouse-2 or RET jump to org file %s"
12907 (abbreviate-file-name
12908 (or (buffer-file-name (buffer-base-buffer))
12909 (buffer-name (buffer-base-buffer)))))))
12910 (case-fold-search nil)
12911 (org-map-continue-from nil)
12912 lspos tags tags-list
12913 (tags-alist (list (cons 0 org-file-tags)))
12914 (llast 0) rtn rtn1 level category i txt
12915 todo marker entry priority)
12916 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12917 (setq action (list 'lambda nil action)))
12918 (save-excursion
12919 (goto-char (point-min))
12920 (when (eq action 'sparse-tree)
12921 (org-overview)
12922 (org-remove-occur-highlights))
12923 (while (re-search-forward re nil t)
12924 (setq org-map-continue-from nil)
12925 (catch :skip
12926 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12927 tags (if (match-end 4) (org-match-string-no-properties 4)))
12928 (goto-char (setq lspos (match-beginning 0)))
12929 (setq level (org-reduced-level (funcall outline-level))
12930 category (org-get-category))
12931 (setq i llast llast level)
12932 ;; remove tag lists from same and sublevels
12933 (while (>= i level)
12934 (when (setq entry (assoc i tags-alist))
12935 (setq tags-alist (delete entry tags-alist)))
12936 (setq i (1- i)))
12937 ;; add the next tags
12938 (when tags
12939 (setq tags (org-split-string tags ":")
12940 tags-alist
12941 (cons (cons level tags) tags-alist)))
12942 ;; compile tags for current headline
12943 (setq tags-list
12944 (if org-use-tag-inheritance
12945 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12946 tags)
12947 org-scanner-tags tags-list)
12948 (when org-use-tag-inheritance
12949 (setcdr (car tags-alist)
12950 (mapcar (lambda (x)
12951 (setq x (copy-sequence x))
12952 (org-add-prop-inherited x))
12953 (cdar tags-alist))))
12954 (when (and tags org-use-tag-inheritance
12955 (or (not (eq t org-use-tag-inheritance))
12956 org-tags-exclude-from-inheritance))
12957 ;; selective inheritance, remove uninherited ones
12958 (setcdr (car tags-alist)
12959 (org-remove-uninherited-tags (cdar tags-alist))))
12960 (when (and
12962 ;; eval matcher only when the todo condition is OK
12963 (and (or (not todo-only) (member todo org-not-done-keywords))
12964 (let ((case-fold-search t) (org-trust-scanner-tags t))
12965 (eval matcher)))
12967 ;; Call the skipper, but return t if it does not skip,
12968 ;; so that the `and' form continues evaluating
12969 (progn
12970 (unless (eq action 'sparse-tree) (org-agenda-skip))
12971 t)
12973 ;; Check if timestamps are deselecting this entry
12974 (or (not todo-only)
12975 (and (member todo org-not-done-keywords)
12976 (or (not org-agenda-tags-todo-honor-ignore-options)
12977 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12979 ;; Extra check for the archive tag
12980 ;; FIXME: Does the skipper already do this????
12981 (or
12982 (not (member org-archive-tag tags-list))
12983 ;; we have an archive tag, should we use this anyway?
12984 (or (not org-agenda-skip-archived-trees)
12985 (and (eq action 'agenda) org-agenda-archives-mode))))
12987 ;; select this headline
12989 (cond
12990 ((eq action 'sparse-tree)
12991 (and org-highlight-sparse-tree-matches
12992 (org-get-heading) (match-end 0)
12993 (org-highlight-new-match
12994 (match-beginning 1) (match-end 1)))
12995 (org-show-context 'tags-tree))
12996 ((eq action 'agenda)
12997 (setq txt (org-agenda-format-item
12998 ""
12999 (concat
13000 (if (eq org-tags-match-list-sublevels 'indented)
13001 (make-string (1- level) ?.) "")
13002 (org-get-heading))
13003 category
13004 tags-list)
13005 priority (org-get-priority txt))
13006 (goto-char lspos)
13007 (setq marker (org-agenda-new-marker))
13008 (org-add-props txt props
13009 'org-marker marker 'org-hd-marker marker 'org-category category
13010 'todo-state todo
13011 'priority priority 'type "tagsmatch")
13012 (push txt rtn))
13013 ((functionp action)
13014 (setq org-map-continue-from nil)
13015 (save-excursion
13016 (setq rtn1 (funcall action))
13017 (push rtn1 rtn)))
13018 (t (error "Invalid action")))
13020 ;; if we are to skip sublevels, jump to end of subtree
13021 (unless org-tags-match-list-sublevels
13022 (org-end-of-subtree t)
13023 (backward-char 1))))
13024 ;; Get the correct position from where to continue
13025 (if org-map-continue-from
13026 (goto-char org-map-continue-from)
13027 (and (= (point) lspos) (end-of-line 1)))))
13028 (when (and (eq action 'sparse-tree)
13029 (not org-sparse-tree-open-archived-trees))
13030 (org-hide-archived-subtrees (point-min) (point-max)))
13031 (nreverse rtn)))
13033 (defun org-remove-uninherited-tags (tags)
13034 "Remove all tags that are not inherited from the list TAGS."
13035 (cond
13036 ((eq org-use-tag-inheritance t)
13037 (if org-tags-exclude-from-inheritance
13038 (org-delete-all org-tags-exclude-from-inheritance tags)
13039 tags))
13040 ((not org-use-tag-inheritance) nil)
13041 ((stringp org-use-tag-inheritance)
13042 (delq nil (mapcar
13043 (lambda (x)
13044 (if (and (string-match org-use-tag-inheritance x)
13045 (not (member x org-tags-exclude-from-inheritance)))
13046 x nil))
13047 tags)))
13048 ((listp org-use-tag-inheritance)
13049 (delq nil (mapcar
13050 (lambda (x)
13051 (if (member x org-use-tag-inheritance) x nil))
13052 tags)))))
13054 (defun org-match-sparse-tree (&optional todo-only match)
13055 "Create a sparse tree according to tags string MATCH.
13056 MATCH can contain positive and negative selection of tags, like
13058 If optional argument TODO-ONLY is non-nil, only select lines that are
13059 also TODO lines."
13060 (interactive "P")
13061 (org-prepare-agenda-buffers (list (current-buffer)))
13062 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13064 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13066 (defvar org-cached-props nil)
13067 (defun org-cached-entry-get (pom property)
13068 (if (or (eq t org-use-property-inheritance)
13069 (and (stringp org-use-property-inheritance)
13070 (string-match org-use-property-inheritance property))
13071 (and (listp org-use-property-inheritance)
13072 (member property org-use-property-inheritance)))
13073 ;; Caching is not possible, check it directly
13074 (org-entry-get pom property 'inherit)
13075 ;; Get all properties, so that we can do complicated checks easily
13076 (cdr (assoc property (or org-cached-props
13077 (setq org-cached-props
13078 (org-entry-properties pom)))))))
13080 (defun org-global-tags-completion-table (&optional files)
13081 "Return the list of all tags in all agenda buffer/files.
13082 Optional FILES argument is a list of files to which can be used
13083 instead of the agenda files."
13084 (save-excursion
13085 (org-uniquify
13086 (delq nil
13087 (apply 'append
13088 (mapcar
13089 (lambda (file)
13090 (set-buffer (find-file-noselect file))
13091 (append (org-get-buffer-tags)
13092 (mapcar (lambda (x) (if (stringp (car-safe x))
13093 (list (car-safe x)) nil))
13094 org-tag-alist)))
13095 (if (and files (car files))
13096 files
13097 (org-agenda-files))))))))
13099 (defun org-make-tags-matcher (match)
13100 "Create the TAGS/TODO matcher form for the selection string MATCH.
13102 The variable `todo-only' is scoped dynamically into this function; it will be
13103 set to t if the matcher restricts matching to TODO entries,
13104 otherwise will not be touched.
13106 Returns a cons of the selection string MATCH and the constructed
13107 lisp form implementing the matcher. The matcher is to be
13108 evaluated at an Org entry, with point on the headline,
13109 and returns t if the entry matches the
13110 selection string MATCH. The returned lisp form references
13111 two variables with information about the entry, which must be
13112 bound around the form's evaluation: todo, the TODO keyword at the
13113 entry (or nil of none); and tags-list, the list of all tags at the
13114 entry including inherited ones. Additionally, the category
13115 of the entry (if any) must be specified as the text property
13116 'org-category on the headline.
13118 See also `org-scan-tags'.
13119 "
13120 (declare (special todo-only))
13121 (unless (boundp 'todo-only)
13122 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13123 (unless match
13124 ;; Get a new match request, with completion
13125 (let ((org-last-tags-completion-table
13126 (org-global-tags-completion-table)))
13127 (setq match (org-completing-read-no-i
13128 "Match: " 'org-tags-completion-function nil nil nil
13129 'org-tags-history))))
13131 ;; Parse the string and create a lisp form
13132 (let ((match0 match)
13133 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13134 minus tag mm
13135 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13136 orterms term orlist re-p str-p level-p level-op time-p
13137 prop-p pn pv po gv rest)
13138 (if (string-match "/+" match)
13139 ;; match contains also a todo-matching request
13140 (progn
13141 (setq tagsmatch (substring match 0 (match-beginning 0))
13142 todomatch (substring match (match-end 0)))
13143 (if (string-match "^!" todomatch)
13144 (setq todo-only t todomatch (substring todomatch 1)))
13146 (setq todomatch nil)))
13147 ;; only matching tags
13148 (setq tagsmatch match todomatch nil))
13150 ;; Make the tags matcher
13152 (setq tagsmatcher t)
13153 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13154 (while (setq term (pop orterms))
13156 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13157 (while (string-match re term)
13158 (setq rest (substring term (match-end 0))
13159 minus (and (match-end 1)
13160 (equal (match-string 1 term) "-"))
13161 tag (save-match-data (replace-regexp-in-string
13163 (match-string 2 term)))
13164 re-p (equal (string-to-char tag) ?{)
13165 level-p (match-end 4)
13166 prop-p (match-end 5)
13167 mm (cond
13168 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13169 (level-p
13170 (setq level-op (org-op-to-function (match-string 3 term)))
13171 `(,level-op level ,(string-to-number
13172 (match-string 4 term))))
13173 (prop-p
13174 (setq pn (match-string 5 term)
13175 po (match-string 6 term)
13176 pv (match-string 7 term)
13177 re-p (equal (string-to-char pv) ?{)
13179 time-p (save-match-data
13181 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13182 (if time-p (setq pv (org-matcher-time pv)))
13183 (setq po (org-op-to-function po (if time-p 'time str-p)))
13184 (cond
13185 ((equal pn "CATEGORY")
13186 (setq gv '(get-text-property (point) 'org-category)))
13187 ((equal pn "TODO")
13188 (setq gv 'todo))
13189 (t
13190 (setq gv `(org-cached-entry-get nil ,pn))))
13191 (if re-p
13192 (if (eq po 'org<>)
13193 `(not (string-match ,pv (or ,gv "")))
13194 `(string-match ,pv (or ,gv "")))
13195 (if str-p
13196 `(,po (or ,gv "") ,pv)
13197 `(,po (string-to-number (or ,gv ""))
13198 ,(string-to-number pv) ))))
13199 (t `(member ,tag tags-list)))
13200 mm (if minus (list 'not mm) mm)
13201 term rest)
13202 (push mm tagsmatcher))
13203 (push (if (> (length tagsmatcher) 1)
13204 (cons 'and tagsmatcher)
13205 (car tagsmatcher))
13206 orlist)
13207 (setq tagsmatcher nil))
13208 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13209 (setq tagsmatcher
13210 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13211 ;; Make the todo matcher
13213 (setq todomatcher t)
13214 (setq orterms (org-split-string todomatch "|") orlist nil)
13215 (while (setq term (pop orterms))
13216 (while (string-match re term)
13217 (setq minus (and (match-end 1)
13218 (equal (match-string 1 term) "-"))
13219 kwd (match-string 2 term)
13220 re-p (equal (string-to-char kwd) ?{)
13221 term (substring term (match-end 0))
13222 mm (if re-p
13223 `(string-match ,(substring kwd 1 -1) todo)
13224 (list 'equal 'todo kwd))
13225 mm (if minus (list 'not mm) mm))
13226 (push mm todomatcher))
13227 (push (if (> (length todomatcher) 1)
13228 (cons 'and todomatcher)
13229 (car todomatcher))
13230 orlist)
13231 (setq todomatcher nil))
13232 (setq todomatcher (if (> (length orlist) 1)
13233 (cons 'or orlist) (car orlist))))
13235 ;; Return the string and lisp forms of the matcher
13236 (setq matcher (if todomatcher
13237 (list 'and tagsmatcher todomatcher)
13238 tagsmatcher))
13239 (when todo-only
13240 (setq matcher (list 'and '(member todo org-not-done-keywords)
13241 matcher)))
13242 (cons match0 matcher)))
13244 (defun org-op-to-function (op &optional stringp)
13245 "Turn an operator into the appropriate function."
13246 (setq op
13247 (cond
13248 ((equal op "<" ) '(< string< org-time<))
13249 ((equal op ">" ) '(> org-string> org-time>))
13250 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13251 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13252 ((member op '("=" "==")) '(= string= org-time=))
13253 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13254 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13256 (defun org<> (a b) (not (= a b)))
13257 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13258 (defun org-string>= (a b) (not (string< a b)))
13259 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13260 (defun org-string<> (a b) (not (string= a b)))
13261 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13262 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13263 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13264 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13265 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13266 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13267 (defun org-2ft (s)
13268 "Convert S to a floating point time.
13269 If S is already a number, just return it. If it is a string, parse
13270 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13271 (cond
13272 ((numberp s) s)
13273 ((stringp s)
13274 (condition-case nil
13275 (float-time (apply 'encode-time (org-parse-time-string s)))
13276 (error 0.)))
13277 (t 0.)))
13279 (defun org-time-today ()
13280 "Time in seconds today at 0:00.
13281 Returns the float number of seconds since the beginning of the
13282 epoch to the beginning of today (00:00)."
13283 (float-time (apply 'encode-time
13284 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13286 (defun org-matcher-time (s)
13287 "Interpret a time comparison value."
13288 (save-match-data
13289 (cond
13290 ((string= s "<now>") (float-time))
13291 ((string= s "<today>") (org-time-today))
13292 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13293 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13295 (+ (org-time-today)
13296 (* (string-to-number (match-string 1 s))
13297 (cdr (assoc (match-string 2 s)
13298 '(("d" . 86400.0) ("w" . 604800.0)
13299 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13300 (t (org-2ft s)))))
13302 (defun org-match-any-p (re list)
13303 "Does re match any element of list?"
13304 (setq list (mapcar (lambda (x) (string-match re x)) list))
13305 (delq nil list))
13307 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13308 (defvar org-tags-overlay (make-overlay 1 1))
13309 (org-detach-overlay org-tags-overlay)
13311 (defun org-get-local-tags-at (&optional pos)
13312 "Get a list of tags defined in the current headline."
13313 (org-get-tags-at pos 'local))
13315 (defun org-get-local-tags ()
13316 "Get a list of tags defined in the current headline."
13317 (org-get-tags-at nil 'local))
13319 (defun org-get-tags-at (&optional pos local)
13320 "Get a list of all headline tags applicable at POS.
13321 POS defaults to point. If tags are inherited, the list contains
13322 the targets in the same sequence as the headlines appear, i.e.
13323 the tags of the current headline come last.
13324 When LOCAL is non-nil, only return tags from the current headline,
13325 ignore inherited ones."
13326 (interactive)
13327 (if (and org-trust-scanner-tags
13328 (or (not pos) (equal pos (point)))
13329 (not local))
13330 org-scanner-tags
13331 (let (tags ltags lastpos parent)
13332 (save-excursion
13333 (save-restriction
13334 (widen)
13335 (goto-char (or pos (point)))
13336 (save-match-data
13337 (catch 'done
13338 (condition-case nil
13339 (progn
13340 (org-back-to-heading t)
13341 (while (not (equal lastpos (point)))
13342 (setq lastpos (point))
13343 (when (looking-at
13345 (setq ltags (org-split-string
13346 (org-match-string-no-properties 1) ":"))
13347 (when parent
13348 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13349 (setq tags (append
13350 (if parent
13351 (org-remove-uninherited-tags ltags)
13352 ltags)
13353 tags)))
13354 (or org-use-tag-inheritance (throw 'done t))
13355 (if local (throw 'done t))
13356 (or (org-up-heading-safe) (error nil))
13357 (setq parent t)))
13358 (error nil)))))
13359 (if local
13360 tags
13361 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13363 (defun org-add-prop-inherited (s)
13364 (add-text-properties 0 (length s) '(inherited t) s)
13365 s)
13367 (defun org-toggle-tag (tag &optional onoff)
13368 "Toggle the tag TAG for the current line.
13369 If ONOFF is `on' or `off', don't toggle but set to this state."
13370 (let (res current)
13371 (save-excursion
13372 (org-back-to-heading t)
13374 (point-at-eol) t)
13375 (progn
13376 (setq current (match-string 1))
13377 (replace-match ""))
13378 (setq current ""))
13379 (setq current (nreverse (org-split-string current ":")))
13380 (cond
13381 ((eq onoff 'on)
13382 (setq res t)
13383 (or (member tag current) (push tag current)))
13384 ((eq onoff 'off)
13385 (or (not (member tag current)) (setq current (delete tag current))))
13386 (t (if (member tag current)
13387 (setq current (delete tag current))
13388 (setq res t)
13389 (push tag current))))
13390 (end-of-line 1)
13391 (if current
13392 (progn
13393 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13394 (org-set-tags nil t))
13395 (delete-horizontal-space))
13396 (run-hooks 'org-after-tags-change-hook))
13397 res))
13399 (defun org-align-tags-here (to-col)
13400 ;; Assumes that this is a headline
13401 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13402 (beginning-of-line 1)
13404 (< pos (match-beginning 2)))
13405 (progn
13406 (setq tags-l (- (match-end 2) (match-beginning 2)))
13407 (goto-char (match-beginning 1))
13408 (insert " ")
13409 (delete-region (point) (1+ (match-beginning 2)))
13410 (setq ncol (max (current-column)
13411 (1+ col)
13412 (if (> to-col 0)
13413 to-col
13414 (- (abs to-col) tags-l))))
13415 (setq p (point))
13416 (insert (make-string (- ncol (current-column)) ?\ ))
13417 (setq ncol (current-column))
13418 (when indent-tabs-mode (tabify p (point-at-eol)))
13419 (org-move-to-column (min ncol col) t))
13420 (goto-char pos))))
13422 (defun org-set-tags-command (&optional arg just-align)
13423 "Call the set-tags command for the current entry."
13424 (interactive "P")
13425 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13426 (org-set-tags arg just-align)
13427 (save-excursion
13428 (org-back-to-heading t)
13429 (org-set-tags arg just-align))))
13431 (defun org-set-tags-to (data)
13432 "Set the tags of the current entry to DATA, replacing the current tags.
13433 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13434 If DATA is nil or the empty string, any tags will be removed."
13435 (interactive "sTags: ")
13436 (setq data
13437 (cond
13438 ((eq data nil) "")
13439 ((equal data "") "")
13440 ((stringp data)
13441 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13442 ":"))
13443 ((listp data)
13444 (concat ":" (mapconcat 'identity data ":") ":"))
13445 (t nil)))
13446 (when data
13447 (save-excursion
13448 (org-back-to-heading t)
13449 (when (looking-at org-complex-heading-regexp)
13450 (if (match-end 5)
13451 (progn
13452 (goto-char (match-beginning 5))
13453 (insert data)
13454 (delete-region (point) (point-at-eol))
13455 (org-set-tags nil 'align))
13456 (goto-char (point-at-eol))
13457 (insert " " data)
13458 (org-set-tags nil 'align)))
13459 (beginning-of-line 1)
13461 (delete-region (match-beginning 1) (match-end 1))))))
13463 (defun org-align-all-tags ()
13464 "Align the tags i all headings."
13465 (interactive)
13466 (save-excursion
13467 (or (ignore-errors (org-back-to-heading t))
13468 (outline-next-heading))
13469 (if (org-at-heading-p)
13470 (org-set-tags t)
13471 (message "No headings"))))
13473 (defvar org-indent-indentation-per-level)
13474 (defun org-set-tags (&optional arg just-align)
13475 "Set the tags for the current headline.
13476 With prefix ARG, realign all tags in headings in the current buffer."
13477 (interactive "P")
13478 (let* ((re org-outline-regexp-bol)
13479 (current (unless arg (org-get-tags-string)))
13480 (col (current-column))
13481 (org-setting-tags t)
13482 table current-tags inherited-tags ; computed below when needed
13483 tags p0 c0 c1 rpl di tc level)
13484 (if arg
13485 (save-excursion
13486 (goto-char (point-min))
13487 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13488 (while (re-search-forward re nil t)
13489 (org-set-tags nil t)
13490 (end-of-line 1)))
13491 (message "All tags realigned to column %d" org-tags-column))
13492 (if just-align
13493 (setq tags current)
13494 ;; Get a new set of tags from the user
13495 (save-excursion
13496 (setq table (append org-tag-persistent-alist
13497 (or org-tag-alist (org-get-buffer-tags))
13498 (and
13499 org-complete-tags-always-offer-all-agenda-tags
13500 (org-global-tags-completion-table
13501 (org-agenda-files))))
13502 org-last-tags-completion-table table
13503 current-tags (org-split-string current ":")
13504 inherited-tags (nreverse
13505 (nthcdr (length current-tags)
13506 (nreverse (org-get-tags-at))))
13507 tags
13508 (if (or (eq t org-use-fast-tag-selection)
13509 (and org-use-fast-tag-selection
13510 (delq nil (mapcar 'cdr table))))
13511 (org-fast-tag-selection
13512 current-tags inherited-tags table
13513 (if org-fast-tag-selection-include-todo
13514 org-todo-key-alist))
13515 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13516 (org-trim
13517 (org-icompleting-read "Tags: "
13518 'org-tags-completion-function
13519 nil nil current 'org-tags-history))))))
13520 (while (string-match "[-+&]+" tags)
13521 ;; No boolean logic, just a list
13522 (setq tags (replace-match ":" t t tags))))
13524 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13526 (if org-tags-sort-function
13527 (setq tags (mapconcat 'identity
13528 (sort (org-split-string
13529 tags (org-re "[^[:alnum:]_@#%]+"))
13530 org-tags-sort-function) ":")))
13533 (setq tags "")
13534 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13535 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13537 ;; Insert new tags at the correct column
13538 (beginning-of-line 1)
13539 (setq level (or (and (looking-at org-outline-regexp)
13540 (- (match-end 0) (point) 1))
13541 1))
13542 (cond
13543 ((and (equal current "") (equal tags "")))
13544 ((re-search-forward
13546 (point-at-eol) t)
13547 (if (equal tags "")
13548 (setq rpl "")
13549 (goto-char (match-beginning 0))
13550 (setq c0 (current-column)
13551 ;; compute offset for the case of org-indent-mode active
13552 di (if org-indent-mode
13553 (* (1- org-indent-indentation-per-level) (1- level))
13554 0)
13555 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13556 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13557 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13558 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13559 (replace-match rpl t t)
13560 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13561 tags)
13562 (t (error "Tags alignment failed")))
13563 (org-move-to-column col)
13564 (unless just-align
13565 (run-hooks 'org-after-tags-change-hook)))))
13567 (defun org-change-tag-in-region (beg end tag off)
13568 "Add or remove TAG for each entry in the region.
13569 This works in the agenda, and also in an org-mode buffer."
13570 (interactive
13571 (list (region-beginning) (region-end)
13572 (let ((org-last-tags-completion-table
13573 (if (derived-mode-p 'org-mode)
13574 (org-get-buffer-tags)
13575 (org-global-tags-completion-table))))
13576 (org-icompleting-read
13577 "Tag: " 'org-tags-completion-function nil nil nil
13578 'org-tags-history))
13579 (progn
13581 (equal (read-char-exclusive) ?r))))
13582 (if (fboundp 'deactivate-mark) (deactivate-mark))
13583 (let ((agendap (equal major-mode 'org-agenda-mode))
13584 l1 l2 m buf pos newhead (cnt 0))
13585 (goto-char end)
13586 (setq l2 (1- (org-current-line)))
13587 (goto-char beg)
13588 (setq l1 (org-current-line))
13589 (loop for l from l1 to l2 do
13590 (org-goto-line l)
13591 (setq m (get-text-property (point) 'org-hd-marker))
13592 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
13593 (and agendap m))
13594 (setq buf (if agendap (marker-buffer m) (current-buffer))
13595 pos (if agendap m (point)))
13596 (with-current-buffer buf
13597 (save-excursion
13598 (save-restriction
13599 (goto-char pos)
13600 (setq cnt (1+ cnt))
13601 (org-toggle-tag tag (if off 'off 'on))
13602 (setq newhead (org-get-heading)))))
13603 (and agendap (org-agenda-change-all-lines newhead m))))
13604 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13606 (defun org-tags-completion-function (string predicate &optional flag)
13607 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13608 (confirm (lambda (x) (stringp (car x)))))
13610 (setq s1 (match-string 1 string)
13611 s2 (match-string 2 string))
13612 (setq s1 "" s2 string))
13613 (cond
13614 ((eq flag nil)
13615 ;; try completion
13616 (setq rtn (try-completion s2 ctable confirm))
13617 (if (stringp rtn)
13618 (setq rtn
13619 (concat s1 s2 (substring rtn (length s2))
13620 (if (and org-add-colon-after-tag-completion
13621 (assoc rtn ctable))
13622 ":" ""))))
13623 rtn)
13624 ((eq flag t)
13625 ;; all-completions
13626 (all-completions s2 ctable confirm)
13627 )
13628 ((eq flag 'lambda)
13629 ;; exact match?
13630 (assoc s2 ctable)))
13631 ))
13633 (defun org-fast-tag-insert (kwd tags face &optional end)
13634 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13635 (insert (format "%-12s" (concat kwd ":"))
13636 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13637 (or end "")))
13639 (defun org-fast-tag-show-exit (flag)
13640 (save-excursion
13641 (org-goto-line 3)
13643 (replace-match ""))
13644 (when flag
13645 (end-of-line 1)
13646 (org-move-to-column (- (window-width) 19) t)
13647 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13649 (defun org-set-current-tags-overlay (current prefix)
13650 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13651 (if (featurep 'xemacs)
13652 (org-overlay-display org-tags-overlay (concat prefix s)
13653 'secondary-selection)
13654 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13655 (org-overlay-display org-tags-overlay (concat prefix s)))))
13657 (defvar org-last-tag-selection-key nil)
13658 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13659 "Fast tag selection with single keys.
13660 CURRENT is the current list of tags in the headline, INHERITED is the
13661 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13662 possibly with grouping information. TODO-TABLE is a similar table with
13663 TODO keywords, should these have keys assigned to them.
13664 If the keys are nil, a-z are automatically assigned.
13665 Returns the new tags string, or nil to not change the current settings."
13666 (let* ((fulltable (append table todo-table))
13667 (maxlen (apply 'max (mapcar
13668 (lambda (x)
13669 (if (stringp (car x)) (string-width (car x)) 0))
13670 fulltable)))
13671 (buf (current-buffer))
13672 (expert (eq org-fast-tag-selection-single-key 'expert))
13673 (buffer-tags nil)
13674 (fwidth (+ maxlen 3 1 3))
13675 (ncol (/ (- (window-width) 4) fwidth))
13676 (i-face 'org-done)
13677 (c-face 'org-todo)
13678 tg cnt e c char c1 c2 ntable tbl rtn
13679 ov-start ov-end ov-prefix
13680 (exit-after-next org-fast-tag-selection-single-key)
13681 (done-keywords org-done-keywords)
13682 groups ingroup)
13683 (save-excursion
13684 (beginning-of-line 1)
13685 (if (looking-at
13687 (setq ov-start (match-beginning 1)
13688 ov-end (match-end 1)
13689 ov-prefix "")
13690 (setq ov-start (1- (point-at-eol))
13691 ov-end (1+ ov-start))
13693 (setq ov-prefix
13694 (concat
13695 (buffer-substring (1- (point)) (point))
13696 (if (> (current-column) org-tags-column)
13697 " "
13698 (make-string (- org-tags-column (current-column)) ?\ ))))))
13699 (move-overlay org-tags-overlay ov-start ov-end)
13700 (save-window-excursion
13701 (if expert
13702 (set-buffer (get-buffer-create " *Org tags*"))
13703 (delete-other-windows)
13704 (split-window-vertically)
13705 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13706 (erase-buffer)
13707 (org-set-local 'org-done-keywords done-keywords)
13710 (org-fast-tag-show-exit exit-after-next)
13711 (org-set-current-tags-overlay current ov-prefix)
13712 (setq tbl fulltable char ?a cnt 0)
13713 (while (setq e (pop tbl))
13714 (cond
13715 ((equal (car e) :startgroup)
13716 (push '() groups) (setq ingroup t)
13717 (when (not (= cnt 0))
13718 (setq cnt 0)
13720 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13721 ((equal (car e) :endgroup)
13722 (setq ingroup nil cnt 0)
13724 ((equal e '(:newline))
13725 (when (not (= cnt 0))
13726 (setq cnt 0)
13728 (setq e (car tbl))
13729 (while (equal (car tbl) '(:newline))
13731 (setq tbl (cdr tbl)))))
13732 (t
13733 (setq tg (copy-sequence (car e)) c2 nil)
13734 (if (cdr e)
13735 (setq c (cdr e))
13736 ;; automatically assign a character.
13737 (setq c1 (string-to-char
13738 (downcase (substring
13739 tg (if (= (string-to-char tg) ?@) 1 0)))))
13740 (if (or (rassoc c1 ntable) (rassoc c1 table))
13741 (while (or (rassoc char ntable) (rassoc char table))
13742 (setq char (1+ char)))
13743 (setq c2 c1))
13744 (setq c (or c2 char)))
13745 (if ingroup (push tg (car groups)))
13746 (setq tg (org-add-props tg nil 'face
13747 (cond
13748 ((not (assoc tg table))
13749 (org-get-todo-face tg))
13750 ((member tg current) c-face)
13751 ((member tg inherited) i-face)
13752 (t nil))))
13753 (if (and (= cnt 0) (not ingroup)) (insert " "))
13754 (insert "[" c "] " tg (make-string
13755 (- fwidth 4 (length tg)) ?\ ))
13756 (push (cons tg c) ntable)
13757 (when (= (setq cnt (1+ cnt)) ncol)
13759 (if ingroup (insert " "))
13760 (setq cnt 0)))))
13761 (setq ntable (nreverse ntable))
13763 (goto-char (point-min))
13764 (if (not expert) (org-fit-window-to-buffer))
13765 (setq rtn
13766 (catch 'exit
13767 (while t
13768 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13769 (if (not groups) "no " "")
13770 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13771 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13772 (setq org-last-tag-selection-key c)
13773 (cond
13775 ((= c ?!)
13776 (setq groups (not groups))
13777 (goto-char (point-min))
13778 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13779 ((= c ?\C-c)
13780 (if (not expert)
13781 (org-fast-tag-show-exit
13782 (setq exit-after-next (not exit-after-next)))
13783 (setq expert nil)
13784 (delete-other-windows)
13785 (set-window-buffer (split-window-vertically) " *Org tags*")
13786 (org-switch-to-buffer-other-window " *Org tags*")
13787 (org-fit-window-to-buffer)))
13788 ((or (= c ?\C-g)
13789 (and (= c ?q) (not (rassoc c ntable))))
13790 (org-detach-overlay org-tags-overlay)
13791 (setq quit-flag t))
13792 ((= c ?\ )
13793 (setq current nil)
13794 (if exit-after-next (setq exit-after-next 'now)))
13796 (condition-case nil
13797 (setq tg (org-icompleting-read
13798 "Tag: "
13799 (or buffer-tags
13800 (with-current-buffer buf
13801 (org-get-buffer-tags)))))
13802 (quit (setq tg "")))
13804 (add-to-list 'buffer-tags (list tg))
13805 (if (member tg current)
13806 (setq current (delete tg current))
13807 (push tg current)))
13808 (if exit-after-next (setq exit-after-next 'now)))
13809 ((setq e (rassoc c todo-table) tg (car e))
13810 (with-current-buffer buf
13811 (save-excursion (org-todo tg)))
13812 (if exit-after-next (setq exit-after-next 'now)))
13813 ((setq e (rassoc c ntable) tg (car e))
13814 (if (member tg current)
13815 (setq current (delete tg current))
13816 (loop for g in groups do
13817 (if (member tg g)
13818 (mapc (lambda (x)
13819 (setq current (delete x current)))
13820 g)))
13821 (push tg current))
13822 (if exit-after-next (setq exit-after-next 'now))))
13824 ;; Create a sorted list
13825 (setq current
13826 (sort current
13827 (lambda (a b)
13828 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13829 (if (eq exit-after-next 'now) (throw 'exit t))
13830 (goto-char (point-min))
13831 (beginning-of-line 2)
13832 (delete-region (point) (point-at-eol))
13833 (org-fast-tag-insert "Current" current c-face)
13834 (org-set-current-tags-overlay current ov-prefix)
13835 (while (re-search-forward
13837 (setq tg (match-string 1))
13838 (add-text-properties
13839 (match-beginning 1) (match-end 1)
13840 (list 'face
13841 (cond
13842 ((member tg current) c-face)
13843 ((member tg inherited) i-face)
13844 (t (get-text-property (match-beginning 1) 'face))))))
13845 (goto-char (point-min)))))
13846 (org-detach-overlay org-tags-overlay)
13847 (if rtn
13848 (mapconcat 'identity current ":")
13849 nil))))
13851 (defun org-get-tags-string ()
13852 "Get the TAGS string in the current headline."
13853 (unless (org-at-heading-p t)
13854 (error "Not on a heading"))
13855 (save-excursion
13856 (beginning-of-line 1)
13858 (org-match-string-no-properties 1)
13859 "")))
13861 (defun org-get-tags ()
13862 "Get the list of tags specified in the current headline."
13863 (org-split-string (org-get-tags-string) ":"))
13865 (defun org-get-buffer-tags ()
13866 "Get a table of all tags used in the buffer, for completion."
13867 (let (tags)
13868 (save-excursion
13869 (goto-char (point-min))
13870 (while (re-search-forward
13872 (when (equal (char-after (point-at-bol 0)) ?*)
13873 (mapc (lambda (x) (add-to-list 'tags x))
13874 (org-split-string (org-match-string-no-properties 1) ":")))))
13875 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13876 (mapcar 'list tags)))
13878 ;;;; The mapping API
13880 ;;;###autoload
13881 (defun org-map-entries (func &optional match scope &rest skip)
13882 "Call FUNC at each headline selected by MATCH in SCOPE.
13884 FUNC is a function or a lisp form. The function will be called without
13885 arguments, with the cursor positioned at the beginning of the headline.
13886 The return values of all calls to the function will be collected and
13887 returned as a list.
13889 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13890 does not need to preserve point. After evaluation, the cursor will be
13891 moved to the end of the line (presumably of the headline of the
13892 processed entry) and search continues from there. Under some
13893 circumstances, this may not produce the wanted results. For example,
13894 if you have removed (e.g. archived) the current (sub)tree it could
13895 mean that the next entry will be skipped entirely. In such cases, you
13896 can specify the position from where search should continue by making
13897 FUNC set the variable `org-map-continue-from' to the desired buffer
13898 position.
13900 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13901 Only headlines that are matched by this query will be considered during
13902 the iteration. When MATCH is nil or t, all headlines will be
13903 visited by the iteration.
13905 SCOPE determines the scope of this command. It can be any of:
13907 nil The current buffer, respecting the restriction if any
13908 tree The subtree started with the entry at point
13909 region The entries within the active region, if any
13910 region-start-level
13911 The entries within the active region, but only those at
13912 the same level than the first one.
13913 file The current buffer, without restriction
13914 file-with-archives
13915 The current buffer, and any archives associated with it
13916 agenda All agenda files
13917 agenda-with-archives
13918 All agenda files with any archive files associated with them
13919 \(file1 file2 ...)
13920 If this is a list, all files in the list will be scanned
13922 The remaining args are treated as settings for the skipping facilities of
13923 the scanner. The following items can be given here:
13925 archive skip trees with the archive tag.
13926 comment skip trees with the COMMENT keyword
13927 function or Emacs Lisp form:
13928 will be used as value for `org-agenda-skip-function', so whenever
13929 the function returns t, FUNC will not be called for that
13930 entry and search will continue from the point where the
13931 function leaves it.
13933 If your function needs to retrieve the tags including inherited tags
13934 at the *current* entry, you can use the value of the variable
13935 `org-scanner-tags' which will be much faster than getting the value
13936 with `org-get-tags-at'. If your function gets properties with
13937 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13938 to t around the call to `org-entry-properties' to get the same speedup.
13939 Note that if your function moves around to retrieve tags and properties at
13940 a *different* entry, you cannot use these techniques."
13941 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13942 (not (org-region-active-p)))
13943 (let* ((org-agenda-archives-mode nil) ; just to make sure
13944 (org-agenda-skip-archived-trees (memq 'archive skip))
13945 (org-agenda-skip-comment-trees (memq 'comment skip))
13946 (org-agenda-skip-function
13947 (car (org-delete-all '(comment archive) skip)))
13948 (org-tags-match-list-sublevels t)
13949 (start-level (eq scope 'region-start-level))
13950 matcher file res
13951 org-todo-keywords-for-agenda
13952 org-done-keywords-for-agenda
13953 org-todo-keyword-alist-for-agenda
13954 org-drawers-for-agenda
13955 org-tag-alist-for-agenda
13956 todo-only)
13958 (cond
13959 ((eq match t) (setq matcher t))
13960 ((eq match nil) (setq matcher t))
13961 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13963 (save-excursion
13964 (save-restriction
13965 (cond ((eq scope 'tree)
13966 (org-back-to-heading t)
13967 (org-narrow-to-subtree)
13968 (setq scope nil))
13969 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13970 (org-region-active-p))
13971 ;; If needed, set start-level to a string like "2"
13972 (when start-level
13973 (save-excursion
13974 (goto-char (region-beginning))
13975 (unless (org-at-heading-p) (outline-next-heading))
13976 (setq start-level (org-current-level))))
13977 (narrow-to-region (region-beginning)
13978 (save-excursion
13979 (goto-char (region-end))
13980 (unless (and (bolp) (org-at-heading-p))
13981 (outline-next-heading))
13982 (point)))
13983 (setq scope nil)))
13985 (if (not scope)
13986 (progn
13987 (org-prepare-agenda-buffers
13988 (list (buffer-file-name (current-buffer))))
13989 (setq res (org-scan-tags func matcher todo-only start-level)))
13990 ;; Get the right scope
13991 (cond
13992 ((and scope (listp scope) (symbolp (car scope)))
13993 (setq scope (eval scope)))
13994 ((eq scope 'agenda)
13995 (setq scope (org-agenda-files t)))
13996 ((eq scope 'agenda-with-archives)
13997 (setq scope (org-agenda-files t))
13998 (setq scope (org-add-archive-files scope)))
13999 ((eq scope 'file)
14000 (setq scope (list (buffer-file-name))))
14001 ((eq scope 'file-with-archives)
14002 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14003 (org-prepare-agenda-buffers scope)
14004 (while (setq file (pop scope))
14005 (with-current-buffer (org-find-base-buffer-visiting file)
14006 (save-excursion
14007 (save-restriction
14008 (widen)
14009 (goto-char (point-min))
14010 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14011 res)))
14013 ;;;; Properties
14015 ;;; Setting and retrieving properties
14017 (defconst org-special-properties
14018 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14019 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
14020 "The special properties valid in Org-mode.
14022 These are properties that are not defined in the property drawer,
14023 but in some other way.")
14025 (defconst org-default-properties
14026 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14027 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14028 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14029 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14030 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14031 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14032 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14033 "Some properties that are used by Org-mode for various purposes.
14034 Being in this list makes sure that they are offered for completion.")
14037 "Regular expression matching the first line of a property drawer.")
14040 "Regular expression matching the last line of a property drawer.")
14043 "Regular expression matching the first line of a property drawer.")
14046 "Regular expression matching the first line of a property drawer.")
14048 (defconst org-property-drawer-re
14051 "Matches an entire property drawer.")
14053 (defconst org-clock-drawer-re
14056 "Matches an entire clock drawer.")
14058 (defsubst org-re-property (property)
14059 "Return a regexp matching PROPERTY.
14060 Match group 1 will be set to the value "
14063 (defun org-property-action ()
14064 "Do an action on properties."
14065 (interactive)
14066 (let (c)
14067 (org-at-property-p)
14068 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14069 (setq c (read-char-exclusive))
14070 (cond
14071 ((equal c ?s)
14072 (call-interactively 'org-set-property))
14073 ((equal c ?d)
14074 (call-interactively 'org-delete-property))
14075 ((equal c ?D)
14076 (call-interactively 'org-delete-property-globally))
14077 ((equal c ?c)
14078 (call-interactively 'org-compute-property-at-point))
14079 (t (error "No such property action %c" c)))))
14081 (defun org-set-effort (&optional value)
14082 "Set the effort property of the current entry.
14083 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
14084 allowed value."
14085 (interactive "P")
14086 (if (equal value 0) (setq value 10))
14087 (let* ((completion-ignore-case t)
14088 (prop org-effort-property)
14089 (cur (org-entry-get nil prop))
14090 (allowed (org-property-get-allowed-values nil prop 'table))
14091 (existing (mapcar 'list (org-property-values prop)))
14092 rpl
14093 (val (cond
14094 ((stringp value) value)
14095 ((and allowed (integerp value))
14096 (or (car (nth (1- value) allowed))
14097 (car (org-last allowed))))
14098 (allowed
14099 (message "Select 1-9,0, [RET%s]: %s"
14100 (if cur (concat "=" cur) "")
14101 (mapconcat 'car allowed " "))
14102 (setq rpl (read-char-exclusive))
14104 cur
14105 (setq rpl (- rpl ?0))
14106 (if (equal rpl 0) (setq rpl 10))
14107 (if (and (> rpl 0) (<= rpl (length allowed)))
14108 (car (nth (1- rpl) allowed))
14109 (org-completing-read "Effort: " allowed nil))))
14110 (t
14111 (let (org-completion-use-ido org-completion-use-iswitchb)
14112 (org-completing-read
14114 (concat "[" cur "]") "")
14115 ": ")
14116 existing nil nil "" nil cur))))))
14117 (unless (equal (org-entry-get nil prop) val)
14118 (org-entry-put nil prop val))
14119 (message "%s is now %s" prop val)))
14121 (defun org-at-property-p ()
14122 "Is cursor inside a property drawer?"
14123 (save-excursion
14124 (beginning-of-line 1)
14126 (save-match-data ;; Used by calling procedures
14127 (let ((p (point))
14128 (range (unless (org-before-first-heading-p)
14129 (org-get-property-block))))
14130 (and range (<= (car range) p) (< p (cdr range))))))))
14132 (defun org-get-property-block (&optional beg end force)
14133 "Return the (beg . end) range of the body of the property drawer.
14134 BEG and END can be beginning and end of subtree, if not given
14135 they will be found.
14136 If the drawer does not exist and FORCE is non-nil, create the drawer."
14137 (catch 'exit
14138 (save-excursion
14139 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14140 (end (or end (progn (outline-next-heading) (point)))))
14141 (goto-char beg)
14142 (if (re-search-forward org-property-start-re end t)
14143 (setq beg (1+ (match-end 0)))
14144 (if force
14145 (save-excursion
14146 (org-insert-property-drawer)
14147 (setq end (progn (outline-next-heading) (point))))
14148 (throw 'exit nil))
14149 (goto-char beg)
14150 (if (re-search-forward org-property-start-re end t)
14151 (setq beg (1+ (match-end 0)))))
14152 (if (re-search-forward org-property-end-re end t)
14153 (setq end (match-beginning 0))
14154 (or force (throw 'exit nil))
14155 (goto-char beg)
14156 (setq end beg)
14157 (org-indent-line-function)
14159 (cons beg end)))))
14161 (defun org-entry-properties (&optional pom which specific)
14162 "Get all properties of the entry at point-or-marker POM.
14163 This includes the TODO keyword, the tags, time strings for deadline,
14164 scheduled, and clocking, and any additional properties defined in the
14165 entry. The return value is an alist, keys may occur multiple times
14166 if the property key was used several times.
14167 POM may also be nil, in which case the current entry is used.
14168 If WHICH is nil or `all', get all properties. If WHICH is
14169 `special' or `standard', only get that subclass. If WHICH
14170 is a string only get exactly this property. SPECIFIC can be a string, the
14171 specific property we are interested in. Specifying it can speed
14172 things up because then unnecessary parsing is avoided."
14173 (setq which (or which 'all))
14174 (org-with-point-at pom
14175 (let ((clockstr (substring org-clock-string 0 -1))
14176 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14177 (case-fold-search nil)
14178 beg end range props sum-props key key1 value string clocksum)
14179 (save-excursion
14180 (when (condition-case nil
14181 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14182 (error nil))
14183 (setq beg (point))
14184 (setq sum-props (get-text-property (point) 'org-summaries))
14185 (setq clocksum (get-text-property (point) :org-clock-minutes))
14186 (outline-next-heading)
14187 (setq end (point))
14188 (when (memq which '(all special))
14189 ;; Get the special properties, like TODO and tags
14190 (goto-char beg)
14191 (when (and (or (not specific) (string= specific "TODO"))
14192 (looking-at org-todo-line-regexp) (match-end 2))
14193 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14194 (when (and (or (not specific) (string= specific "PRIORITY"))
14195 (looking-at org-priority-regexp))
14196 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14197 (when (or (not specific) (string= specific "FILE"))
14198 (push (cons "FILE" buffer-file-name) props))
14199 (when (and (or (not specific) (string= specific "TAGS"))
14200 (setq value (org-get-tags-string))
14202 (push (cons "TAGS" value) props))
14203 (when (and (or (not specific) (string= specific "ALLTAGS"))
14204 (setq value (org-get-tags-at)))
14205 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14206 ":"))
14207 props))
14208 (when (or (not specific) (string= specific "BLOCKED"))
14209 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14210 (when (or (not specific)
14211 (member specific
14212 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14213 "TIMESTAMP" "TIMESTAMP_IA")))
14214 (catch 'match
14215 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14216 (setq key (if (match-end 1)
14217 (substring (org-match-string-no-properties 1)
14218 0 -1))
14219 string (if (equal key clockstr)
14220 (org-no-properties
14221 (org-trim
14222 (buffer-substring
14223 (match-beginning 3) (goto-char
14224 (point-at-eol)))))
14225 (substring (org-match-string-no-properties 3)
14226 1 -1)))
14227 ;; Get the correct property name from the key. This is
14228 ;; necessary if the user has configured time keywords.
14229 (setq key1 (concat key ":"))
14230 (cond
14231 ((not key)
14232 (setq key
14233 (if (= (char-after (match-beginning 3)) ?\[)
14234 "TIMESTAMP_IA" "TIMESTAMP")))
14235 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14236 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14237 ((equal key1 org-closed-string) (setq key "CLOSED"))
14238 ((equal key1 org-clock-string) (setq key "CLOCK")))
14239 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14240 (progn
14241 (push (cons key string) props)
14242 ;; no need to search further if match is found
14243 (throw 'match t))
14244 (when (or (equal key "CLOCK") (not (assoc key props)))
14245 (push (cons key string) props))))))
14246 )
14248 (when (memq which '(all standard))
14249 ;; Get the standard properties, like :PROP: ...
14250 (setq range (org-get-property-block beg end))
14251 (when range
14252 (goto-char (car range))
14253 (while (re-search-forward
14255 (cdr range) t)
14256 (setq key (org-match-string-no-properties 1)
14257 value (org-trim (or (org-match-string-no-properties 2) "")))
14258 (unless (member key excluded)
14259 (push (cons key (or value "")) props)))))
14260 (if clocksum
14261 (push (cons "CLOCKSUM"
14262 (org-columns-number-to-string (/ (float clocksum) 60.)
14263 'add_times))
14264 props))
14265 (unless (assoc "CATEGORY" props)
14266 (push (cons "CATEGORY" (org-get-category)) props))
14267 (append sum-props (nreverse props)))))))
14269 (defun org-entry-get (pom property &optional inherit literal-nil)
14270 "Get value of PROPERTY for entry at point-or-marker POM.
14271 If INHERIT is non-nil and the entry does not have the property,
14272 then also check higher levels of the hierarchy.
14273 If INHERIT is the symbol `selective', use inheritance only if the setting
14274 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14275 If the property is present but empty, the return value is the empty string.
14276 If the property is not present at all, nil is returned.
14279 do not interpret it as the list atom nil. This is used for inheritance
14281 (org-with-point-at pom
14282 (if (and inherit (if (eq inherit 'selective)
14283 (org-property-inherit-p property)
14284 t))
14285 (org-entry-get-with-inheritance property literal-nil)
14286 (if (member property org-special-properties)
14287 ;; We need a special property. Use `org-entry-properties' to
14288 ;; retrieve it, but specify the wanted property
14289 (cdr (assoc property (org-entry-properties nil 'special property)))
14290 (let ((range (unless (org-before-first-heading-p)
14291 (org-get-property-block)))
14292 (props (list (or (assoc property org-file-properties)
14293 (assoc property org-global-properties)
14294 (assoc property org-global-properties-fixed))))
14295 val)
14296 (flet ((ap (key)
14297 (when (re-search-forward
14298 (org-re-property key) (cdr range) t)
14299 (setq props
14300 (org-update-property-plist
14301 key
14302 (if (match-end 1)
14303 (org-match-string-no-properties 1) "")
14304 props)))))
14305 (when (and range (goto-char (car range)))
14306 (ap property)
14307 (goto-char (car range))
14308 (while (ap (concat property "+")))
14309 (setq val (cdr (assoc property props)))
14310 (when val (if literal-nil val (org-not-nil val))))))))))
14312 (defun org-property-or-variable-value (var &optional inherit)
14313 "Check if there is a property fixing the value of VAR.
14314 If yes, return this value. If not, return the current value of the variable."
14315 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14317 (read prop)
14318 (symbol-value var))))
14320 (defun org-entry-delete (pom property)
14321 "Delete the property PROPERTY from entry at point-or-marker POM."
14322 (org-with-point-at pom
14323 (if (member property org-special-properties)
14324 nil ; cannot delete these properties.
14325 (let ((range (org-get-property-block)))
14326 (if (and range
14327 (goto-char (car range))
14328 (re-search-forward
14329 (org-re-property property)
14330 (cdr range) t))
14331 (progn
14332 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14333 t)
14334 nil)))))
14336 ;; Multi-values properties are properties that contain multiple values
14337 ;; These values are assumed to be single words, separated by whitespace.
14338 (defun org-entry-add-to-multivalued-property (pom property value)
14339 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14340 (let* ((old (org-entry-get pom property))
14342 (setq value (org-entry-protect-space value))
14343 (unless (member value values)
14344 (setq values (cons value values))
14345 (org-entry-put pom property
14346 (mapconcat 'identity values " ")))))
14348 (defun org-entry-remove-from-multivalued-property (pom property value)
14349 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14350 (let* ((old (org-entry-get pom property))
14352 (setq value (org-entry-protect-space value))
14353 (when (member value values)
14354 (setq values (delete value values))
14355 (org-entry-put pom property
14356 (mapconcat 'identity values " ")))))
14358 (defun org-entry-member-in-multivalued-property (pom property value)
14359 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14360 (let* ((old (org-entry-get pom property))
14362 (setq value (org-entry-protect-space value))
14363 (member value values)))
14365 (defun org-entry-get-multivalued-property (pom property)
14366 "Return a list of values in a multivalued property."
14367 (let* ((value (org-entry-get pom property))
14369 (mapcar 'org-entry-restore-space values)))
14371 (defun org-entry-put-multivalued-property (pom property &rest values)
14372 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14373 VALUES should be a list of strings. Spaces will be protected."
14374 (org-entry-put pom property
14375 (mapconcat 'org-entry-protect-space values " "))
14376 (let* ((value (org-entry-get pom property))
14378 (mapcar 'org-entry-restore-space values)))
14380 (defun org-entry-protect-space (s)
14381 "Protect spaces and newline in string S."
14382 (while (string-match " " s)
14383 (setq s (replace-match "%20" t t s)))
14385 (setq s (replace-match "%0A" t t s)))
14386 s)
14388 (defun org-entry-restore-space (s)
14389 "Restore spaces and newline in string S."
14390 (while (string-match "%20" s)
14391 (setq s (replace-match " " t t s)))
14392 (while (string-match "%0A" s)
14394 s)
14396 (defvar org-entry-property-inherited-from (make-marker)
14397 "Marker pointing to the entry from where a property was inherited.
14398 Each call to `org-entry-get-with-inheritance' will set this marker to the
14399 location of the entry where the inheritance search matched. If there was
14400 no match, the marker will point nowhere.
14401 Note that also `org-entry-get' calls this function, if the INHERIT flag
14402 is set.")
14404 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14405 "Get entry property, and search higher levels if not present.
14406 The search will stop at the first ancestor which has the property defined.
14408 should be considered as undefined (this is the meaning of nil here).
14410 (move-marker org-entry-property-inherited-from nil)
14411 (let (tmp)
14412 (unless (org-before-first-heading-p)
14413 (save-excursion
14414 (save-restriction
14415 (widen)
14416 (catch 'ex
14417 (while t
14418 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14419 (org-back-to-heading t)
14420 (move-marker org-entry-property-inherited-from (point))
14421 (throw 'ex tmp))
14422 (or (org-up-heading-safe) (throw 'ex nil)))))))
14423 (setq tmp (or tmp
14424 (cdr (assoc property org-file-properties))
14425 (cdr (assoc property org-global-properties))
14426 (cdr (assoc property org-global-properties-fixed))))
14427 (if literal-nil tmp (org-not-nil tmp))))
14429 (defvar org-property-changed-functions nil
14430 "Hook called when the value of a property has changed.
14431 Each hook function should accept two arguments, the name of the property
14432 and the new value.")
14434 (defun org-entry-put (pom property value)
14435 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14436 (org-with-point-at pom
14437 (org-back-to-heading t)
14438 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14439 range)
14440 (cond
14441 ((equal property "TODO")
14443 (not (member value org-todo-keywords-1)))
14445 (if (or (not value)
14447 (setq value 'none))
14448 (org-todo value)
14449 (org-set-tags nil 'align))
14450 ((equal property "PRIORITY")
14452 (string-to-char value) ?\ ))
14453 (org-set-tags nil 'align))
14454 ((equal property "SCHEDULED")
14455 (if (re-search-forward org-scheduled-time-regexp end t)
14456 (cond
14457 ((eq value 'earlier) (org-timestamp-change -1 'day))
14458 ((eq value 'later) (org-timestamp-change 1 'day))
14459 (t (call-interactively 'org-schedule)))
14460 (call-interactively 'org-schedule)))
14461 ((equal property "DEADLINE")
14462 (if (re-search-forward org-deadline-time-regexp end t)
14463 (cond
14464 ((eq value 'earlier) (org-timestamp-change -1 'day))
14465 ((eq value 'later) (org-timestamp-change 1 'day))
14466 (t (call-interactively 'org-deadline)))
14467 (call-interactively 'org-deadline)))
14468 ((member property org-special-properties)
14469 (error "The %s property can not yet be set with `org-entry-put'"
14470 property))
14471 (t ; a non-special property
14472 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14473 (setq range (org-get-property-block beg end 'force))
14474 (goto-char (car range))
14475 (if (re-search-forward
14476 (org-re-property property) (cdr range) t)
14477 (progn
14478 (delete-region (match-beginning 0) (match-end 0))
14479 (goto-char (match-beginning 0)))
14480 (goto-char (cdr range))
14482 (backward-char 1)
14483 (org-indent-line-function))
14484 (insert ":" property ":")
14485 (and value (insert " " value))
14486 (org-indent-line-function)))))
14487 (run-hook-with-args 'org-property-changed-functions property value)))
14489 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14490 "Get all property keys in the current buffer.
14491 With INCLUDE-SPECIALS, also list the special properties that reflect things
14492 like tags and TODO state.
14493 With INCLUDE-DEFAULTS, also include properties that has special meaning
14494 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14495 and others.
14496 With INCLUDE-COLUMNS, also include property names given in COLUMN
14497 formats in the current buffer."
14498 (let (rtn range cfmt s p)
14499 (save-excursion
14500 (save-restriction
14501 (widen)
14502 (goto-char (point-min))
14503 (while (re-search-forward org-property-start-re nil t)
14504 (setq range (org-get-property-block))
14505 (goto-char (car range))
14506 (while (re-search-forward
14508 (cdr range) t)
14509 (add-to-list 'rtn (org-match-string-no-properties 1)))
14510 (outline-next-heading))))
14512 (when include-specials
14513 (setq rtn (append org-special-properties rtn)))
14515 (when include-defaults
14516 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14517 (add-to-list 'rtn org-effort-property))
14519 (when include-columns
14520 (save-excursion
14521 (save-restriction
14522 (widen)
14523 (goto-char (point-min))
14524 (while (re-search-forward
14526 nil t)
14527 (setq cfmt (match-string 2) s 0)
14529 cfmt s)
14530 (setq s (match-end 0)
14531 p (match-string 1 cfmt))
14532 (unless (or (equal p "ITEM")
14533 (member p org-special-properties))
14534 (add-to-list 'rtn (match-string 1 cfmt))))))))
14536 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14538 (defun org-property-values (key)
14539 "Return a list of all values of property KEY in the current buffer."
14540 (save-excursion
14541 (save-restriction
14542 (widen)
14543 (goto-char (point-min))
14544 (let ((re (org-re-property key))
14545 values)
14546 (while (re-search-forward re nil t)
14547 (add-to-list 'values (org-trim (match-string 1))))
14548 (delete "" values)))))
14550 (defun org-insert-property-drawer ()
14551 "Insert a property drawer into the current entry."
14552 (org-back-to-heading t)
14553 (looking-at org-outline-regexp)
14554 (let ((indent (if org-adapt-indentation
14555 (- (match-end 0) (match-beginning 0))
14556 0))
14557 (beg (point))
14559 end hiddenp)
14560 (outline-next-heading)
14561 (setq end (point))
14562 (goto-char beg)
14563 (while (re-search-forward re end t))
14564 (setq hiddenp (outline-invisible-p))
14565 (end-of-line 1)
14568 (if (member (match-string 1) '("CLOCK:" ":END:"))
14569 ;; just skip this line
14570 (beginning-of-line 2)
14571 ;; Drawer start, find the end
14573 (beginning-of-line 1)))
14574 (org-skip-over-state-notes)
14576 (if (eq (char-before) ?*) (forward-char 1))
14578 (beginning-of-line 0)
14579 (org-indent-to-column indent)
14580 (beginning-of-line 2)
14581 (org-indent-to-column indent)
14582 (beginning-of-line 0)
14583 (if hiddenp
14584 (save-excursion
14585 (org-back-to-heading t)
14586 (hide-entry))
14587 (org-flag-drawer t))))
14589 (defun org-insert-drawer (&optional arg drawer)
14590 "Insert a drawer at point.
14592 Optional argument DRAWER, when non-nil, is a string representing
14593 drawer's name. Otherwise, the user is prompted for a name.
14595 If a region is active, insert the drawer around that region
14596 instead.
14598 Point is left between drawer's boundaries."
14599 (interactive "P")
14600 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14601 "LOGBOOK"))
14602 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14603 ;; internally by Org. They are meant to be inserted
14604 ;; automatically.
14605 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14606 ;; Remove system drawers from list. Note: For some reason,
14607 ;; `org-completing-read' ignores the predicate while
14608 ;; `completing-read' handles it fine.
14609 (drawer (if arg "PROPERTIES"
14610 (or drawer
14611 (completing-read
14612 "Drawer: " org-drawers
14613 (lambda (d) (not (member d system-drawers))))))))
14614 (cond
14615 ;; With C-u, fall back on `org-insert-property-drawer'
14616 (arg (org-insert-property-drawer))
14617 ;; With an active region, insert a drawer at point.
14618 ((not (org-region-active-p))
14619 (progn
14622 (forward-line -2)))
14623 ;; Otherwise, insert the drawer at point
14624 (t
14625 (let ((rbeg (region-beginning))
14626 (rend (copy-marker (region-end))))
14627 (unwind-protect
14628 (progn
14629 (goto-char rbeg)
14630 (beginning-of-line)
14631 (when (save-excursion
14632 (re-search-forward org-outline-regexp-bol rend t))
14633 (error "Drawers cannot contain headlines"))
14634 ;; Position point at the beginning of the first
14635 ;; non-blank line in region. Insert drawer's opening
14636 ;; there, then indent it.
14637 (org-skip-whitespace)
14638 (beginning-of-line)
14640 (forward-line -1)
14641 (indent-for-tab-command)
14642 ;; Move point to the beginning of the first blank line
14643 ;; after the last non-blank line in region. Insert
14644 ;; drawer's closing, then indent it.
14645 (goto-char rend)
14648 (indent-for-tab-command)
14650 ;; Clear marker, whatever the outcome of insertion is.
14651 (set-marker rend nil)))))))
14653 (defvar org-property-set-functions-alist nil
14654 "Property set function alist.
14655 Each entry should have the following format:
14657 (PROPERTY . READ-FUNCTION)
14659 The read function will be called with the same argument as
14660 `org-completing-read'.")
14662 (defun org-set-property-function (property)
14663 "Get the function that should be used to set PROPERTY.
14664 This is computed according to `org-property-set-functions-alist'."
14665 (or (cdr (assoc property org-property-set-functions-alist))
14666 'org-completing-read))
14668 (defun org-read-property-value (property)
14669 "Read PROPERTY value from user."
14670 (let* ((completion-ignore-case t)
14671 (allowed (org-property-get-allowed-values nil property 'table))
14672 (cur (org-entry-get nil property))
14673 (prompt (concat property " value"
14675 (concat " [" cur "]") "") ": "))
14676 (set-function (org-set-property-function property))
14677 (val (if allowed
14678 (funcall set-function prompt allowed nil
14679 (not (get-text-property 0 'org-unrestricted
14680 (caar allowed))))
14681 (let (org-completion-use-ido org-completion-use-iswitchb)
14682 (funcall set-function prompt
14683 (mapcar 'list (org-property-values property))
14684 nil nil "" nil cur)))))
14685 (if (equal val "")
14686 cur
14687 val)))
14689 (defvar org-last-set-property nil)
14690 (defun org-read-property-name ()
14691 "Read a property name."
14692 (let* ((completion-ignore-case t)
14693 (keys (org-buffer-property-keys nil t t))
14694 (default-prop (or (save-excursion
14695 (save-match-data
14696 (beginning-of-line)
14698 (null (string= (match-string 1) "END"))
14699 (match-string 1))))
14700 org-last-set-property))
14701 (property (org-icompleting-read
14702 (concat "Property"
14703 (if default-prop (concat " [" default-prop "]") "")
14704 ": ")
14705 (mapcar 'list keys)
14706 nil nil nil nil
14707 default-prop
14708 )))
14709 (if (member property keys)
14710 property
14711 (or (cdr (assoc (downcase property)
14712 (mapcar (lambda (x) (cons (downcase x) x))
14713 keys)))
14714 property))))
14716 (defun org-set-property (property value)
14717 "In the current entry, set PROPERTY to VALUE.
14718 When called interactively, this will prompt for a property name, offering
14719 completion on existing and default properties. And then it will prompt
14720 for a value, offering completion either on allowed values (via an inherited
14721 xxx_ALL property) or on existing values in other instances of this property
14722 in the current file."
14723 (interactive (list nil nil))
14724 (let* ((property (or property (org-read-property-name)))
14725 (value (or value (org-read-property-value property)))
14726 (fn (cdr (assoc property org-properties-postprocess-alist))))
14727 (setq org-last-set-property property)
14728 ;; Possibly postprocess the inserted value:
14729 (when fn (setq value (funcall fn value)))
14730 (unless (equal (org-entry-get nil property) value)
14731 (org-entry-put nil property value))))
14733 (defun org-delete-property (property)
14734 "In the current entry, delete PROPERTY."
14735 (interactive
14736 (let* ((completion-ignore-case t)
14737 (prop (org-icompleting-read "Property: "
14738 (org-entry-properties nil 'standard))))
14739 (list prop)))
14740 (message "Property %s %s" property
14741 (if (org-entry-delete nil property)
14742 "deleted"
14743 "was not present in the entry")))
14745 (defun org-delete-property-globally (property)
14746 "Remove PROPERTY globally, from all entries."
14747 (interactive
14748 (let* ((completion-ignore-case t)
14749 (prop (org-icompleting-read
14750 "Globally remove property: "
14751 (mapcar 'list (org-buffer-property-keys)))))
14752 (list prop)))
14753 (save-excursion
14754 (save-restriction
14755 (widen)
14756 (goto-char (point-min))
14757 (let ((cnt 0))
14758 (while (re-search-forward
14759 (org-re-property property)
14760 nil t)
14761 (setq cnt (1+ cnt))
14762 (delete-region (match-beginning 0) (1+ (point-at-eol))))
14765 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14767 (defun org-compute-property-at-point ()
14768 "Compute the property at point.
14769 This looks for an enclosing column format, extracts the operator and
14770 then applies it to the property in the column format's scope."
14771 (interactive)
14772 (unless (org-at-property-p)
14773 (error "Not at a property"))
14774 (let ((prop (org-match-string-no-properties 2)))
14775 (org-columns-get-format-and-top-level)
14776 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14777 (error "No operator defined for property %s" prop))
14778 (org-columns-compute prop)))
14780 (defvar org-property-allowed-value-functions nil
14781 "Hook for functions supplying allowed values for a specific property.
14782 The functions must take a single argument, the name of the property, and
14784 the values, this means that these values are intended as defaults for
14785 completion, but that other values should be allowed too.
14786 The functions must return nil if they are not responsible for this
14787 property.")
14789 (defun org-property-get-allowed-values (pom property &optional table)
14790 "Get allowed values for the property PROPERTY.
14791 When TABLE is non-nil, return an alist that can directly be used for
14792 completion."
14793 (let (vals)
14794 (cond
14795 ((equal property "TODO")
14796 (setq vals (org-with-point-at pom
14797 (append org-todo-keywords-1 '("")))))
14798 ((equal property "PRIORITY")
14799 (let ((n org-lowest-priority))
14800 (while (>= n org-highest-priority)
14801 (push (char-to-string n) vals)
14802 (setq n (1- n)))))
14803 ((member property org-special-properties))
14804 ((setq vals (run-hook-with-args-until-success
14805 'org-property-allowed-value-functions property)))
14806 (t
14807 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14809 (setq vals (car (read-from-string (concat "(" vals ")"))))
14810 (setq vals (mapcar (lambda (x)
14811 (cond ((stringp x) x)
14812 ((numberp x) (number-to-string x))
14813 ((symbolp x) (symbol-name x))
14814 (t "???")))
14815 vals)))))
14816 (when (member ":ETC" vals)
14817 (setq vals (remove ":ETC" vals))
14818 (org-add-props (car vals) '(org-unrestricted t)))
14819 (if table (mapcar 'list vals) vals)))
14821 (defun org-property-previous-allowed-value (&optional previous)
14822 "Switch to the next allowed value for this property."
14823 (interactive)
14824 (org-property-next-allowed-value t))
14826 (defun org-property-next-allowed-value (&optional previous)
14827 "Switch to the next allowed value for this property."
14828 (interactive)
14829 (unless (org-at-property-p)
14830 (error "Not at a property"))
14831 (let* ((key (match-string 2))
14832 (value (match-string 3))
14833 (allowed (or (org-property-get-allowed-values (point) key)
14834 (and (member value '("[ ]" "[-]" "[X]"))
14835 '("[ ]" "[X]"))))
14836 nval)
14837 (unless allowed
14838 (error "Allowed values for this property have not been defined"))
14839 (if previous (setq allowed (reverse allowed)))
14840 (if (member value allowed)
14841 (setq nval (car (cdr (member value allowed)))))
14842 (setq nval (or nval (car allowed)))
14843 (if (equal nval value)
14844 (error "Only one allowed value for this property"))
14845 (org-at-property-p)
14846 (replace-match (concat " :" key ": " nval) t t)
14847 (org-indent-line-function)
14848 (beginning-of-line 1)
14850 (run-hook-with-args 'org-property-changed-functions key nval)))
14852 (defun org-find-olp (path &optional this-buffer)
14853 "Return a marker pointing to the entry at outline path OLP.
14854 If anything goes wrong, throw an error.
14855 You can wrap this call to catch the error like this:
14857 (condition-case msg
14858 (org-mobile-locate-entry (match-string 4))
14859 (error (nth 1 msg)))
14861 The return value will then be either a string with the error message,
14862 or a marker if everything is OK.
14864 If THIS-BUFFER is set, the outline path does not contain a file,
14865 only headings."
14866 (let* ((file (if this-buffer buffer-file-name (pop path)))
14867 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14868 (level 1)
14869 (lmin 1)
14870 (lmax 1)
14871 limit re end found pos heading cnt flevel)
14872 (unless buffer (error "File not found :%s" file))
14873 (with-current-buffer buffer
14874 (save-excursion
14875 (save-restriction
14876 (widen)
14877 (setq limit (point-max))
14878 (goto-char (point-min))
14879 (while (setq heading (pop path))
14880 (setq re (format org-complex-heading-regexp-format
14881 (regexp-quote heading)))
14882 (setq cnt 0 pos (point))
14883 (while (re-search-forward re end t)
14884 (setq level (- (match-end 1) (match-beginning 1)))
14885 (if (and (>= level lmin) (<= level lmax))
14886 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14887 (when (= cnt 0) (error "Heading not found on level %d: %s"
14888 lmax heading))
14889 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14890 lmax heading))
14891 (goto-char found)
14892 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14893 (setq end (save-excursion (org-end-of-subtree t t))))
14894 (when (org-at-heading-p)
14895 (move-marker (make-marker) (point))))))))
14897 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14898 "Find node HEADING in BUFFER.
14899 Return a marker to the heading if it was found, or nil if not.
14900 If POS-ONLY is set, return just the position instead of a marker.
14902 The heading text must match exact, but it may have a TODO keyword,
14903 a priority cookie and tags in the standard locations."
14904 (with-current-buffer (or buffer (current-buffer))
14905 (save-excursion
14906 (save-restriction
14907 (widen)
14908 (goto-char (point-min))
14909 (let (case-fold-search)
14910 (if (re-search-forward
14911 (format org-complex-heading-regexp-format
14912 (regexp-quote heading)) nil t)
14913 (if pos-only
14914 (match-beginning 0)
14915 (move-marker (make-marker) (match-beginning 0)))))))))
14917 (defun org-find-exact-heading-in-directory (heading &optional dir)
14918 "Find Org node headline HEADING in all .org files in directory DIR.
14919 When the target headline is found, return a marker to this location."
14920 (let ((files (directory-files (or dir default-directory)
14922 file visiting m buffer)
14923 (catch 'found
14924 (while (setq file (pop files))
14925 (message "trying %s" file)
14926 (setq visiting (org-find-base-buffer-visiting file))
14927 (setq buffer (or visiting (find-file-noselect file)))
14928 (setq m (org-find-exact-headline-in-buffer
14929 heading buffer))
14930 (when (and (not m) (not visiting)) (kill-buffer buffer))
14931 (and m (throw 'found m))))))
14933 (defun org-find-entry-with-id (ident)
14934 "Locate the entry that contains the ID property with exact value IDENT.
14935 IDENT can be a string, a symbol or a number, this function will search for
14936 the string representation of it.
14937 Return the position where this entry starts, or nil if there is no such entry."
14938 (interactive "sID: ")
14939 (let ((id (cond
14940 ((stringp ident) ident)
14941 ((symbol-name ident) (symbol-name ident))
14942 ((numberp ident) (number-to-string ident))
14943 (t (error "IDENT %s must be a string, symbol or number" ident))))
14944 (case-fold-search nil))
14945 (save-excursion
14946 (save-restriction
14947 (widen)
14948 (goto-char (point-min))
14949 (when (re-search-forward
14951 nil t)
14952 (org-back-to-heading t)
14953 (point))))))
14955 ;;;; Timestamps
14957 (defvar org-last-changed-timestamp nil)
14958 (defvar org-last-inserted-timestamp nil
14959 "The last time stamp inserted with `org-insert-time-stamp'.")
14960 (defvar org-time-was-given) ; dynamically scoped parameter
14961 (defvar org-end-time-was-given) ; dynamically scoped parameter
14962 (defvar org-ts-what) ; dynamically scoped parameter
14964 (defun org-time-stamp (arg &optional inactive)
14965 "Prompt for a date/time and insert a time stamp.
14966 If the user specifies a time like HH:MM, or if this command is called
14967 with a prefix argument, the time stamp will contain date and time.
14968 Otherwise, only the date will be included. All parts of a date not
14969 specified by the user will be filled in from the current date/time.
14970 So if you press just return without typing anything, the time stamp
14971 will represent the current date/time. If there is already a timestamp
14972 at the cursor, it will be modified."
14973 (interactive "P")
14974 (let* ((ts nil)
14975 (default-time
14976 ;; Default time is either today, or, when entering a range,
14977 ;; the range start.
14978 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14979 (save-excursion
14980 (re-search-backward
14982 (- (point) 20) t)))
14983 (apply 'encode-time (org-parse-time-string (match-string 1)))
14984 (current-time)))
14985 (default-input (and ts (org-get-compact-tod ts)))
14986 (repeater (save-excursion
14987 (save-match-data
14988 (beginning-of-line)
14989 (when (re-search-forward
14991 (save-excursion (progn (end-of-line) (point))) t)
14992 (match-string 0)))))
14993 org-time-was-given org-end-time-was-given time)
14994 (cond
14995 ((and (org-at-timestamp-p t)
14996 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14997 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14998 (insert "--")
14999 (setq time (let ((this-command this-command))
15000 (org-read-date arg 'totime nil nil
15001 default-time default-input inactive)))
15002 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15003 ((org-at-timestamp-p t)
15004 (setq time (let ((this-command this-command))
15005 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15006 (when (org-at-timestamp-p t) ; just to get the match data
15007 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15008 (replace-match "")
15009 (setq org-last-changed-timestamp
15010 (org-insert-time-stamp
15011 time (or org-time-was-given arg)
15012 inactive nil nil (list org-end-time-was-given)))
15013 (when repeater (goto-char (1- (point))) (insert " " repeater)
15014 (setq org-last-changed-timestamp
15015 (concat (substring org-last-inserted-timestamp 0 -1)
15016 " " repeater ">"))))
15017 (message "Timestamp updated"))
15018 (t
15019 (setq time (let ((this-command this-command))
15020 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15021 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15022 nil nil (list org-end-time-was-given))))))
15024 ;; FIXME: can we use this for something else, like computing time differences?
15025 (defun org-get-compact-tod (s)
15026 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15027 (let* ((t1 (match-string 1 s))
15028 (h1 (string-to-number (match-string 2 s)))
15029 (m1 (string-to-number (match-string 3 s)))
15030 (t2 (and (match-end 4) (match-string 5 s)))
15031 (h2 (and t2 (string-to-number (match-string 6 s))))
15032 (m2 (and t2 (string-to-number (match-string 7 s))))
15033 dh dm)
15034 (if (not t2)
15035 t1
15036 (setq dh (- h2 h1) dm (- m2 m1))
15037 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15038 (concat t1 "+" (number-to-string dh)
15039 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15041 (defun org-time-stamp-inactive (&optional arg)
15042 "Insert an inactive time stamp.
15043 An inactive time stamp is enclosed in square brackets instead of angle
15044 brackets. It is inactive in the sense that it does not trigger agenda entries,
15045 does not link to the calendar and cannot be changed with the S-cursor keys.
15046 So these are more for recording a certain time/date."
15047 (interactive "P")
15048 (org-time-stamp arg 'inactive))
15050 (defvar org-date-ovl (make-overlay 1 1))
15051 (overlay-put org-date-ovl 'face 'org-date-selected)
15052 (org-detach-overlay org-date-ovl)
15054 (defvar org-ans1) ; dynamically scoped parameter
15055 (defvar org-ans2) ; dynamically scoped parameter
15057 (defvar org-plain-time-of-day-regexp) ; defined below
15059 (defvar org-overriding-default-time nil) ; dynamically scoped
15060 (defvar org-read-date-overlay nil)
15061 (defvar org-dcst nil) ; dynamically scoped
15062 (defvar org-read-date-history nil)
15063 (defvar org-read-date-final-answer nil)
15064 (defvar org-read-date-analyze-futurep nil)
15065 (defvar org-read-date-analyze-forced-year nil)
15066 (defvar org-read-date-inactive)
15068 (defun org-read-date (&optional org-with-time to-time from-string prompt
15069 default-time default-input inactive)
15070 "Read a date, possibly a time, and make things smooth for the user.
15071 The prompt will suggest to enter an ISO date, but you can also enter anything
15072 which will at least partially be understood by `parse-time-string'.
15073 Unrecognized parts of the date will default to the current day, month, year,
15074 hour and minute. If this command is called to replace a timestamp at point,
15075 or to enter the second timestamp of a range, the default time is taken
15076 from the existing stamp. Furthermore, the command prefers the future,
15077 so if you are giving a date where the year is not given, and the day-month
15078 combination is already past in the current year, it will assume you
15079 mean next year. For details, see the manual. A few examples:
15081 3-2-5 --> 2003-02-05
15082 feb 15 --> currentyear-02-15
15083 2/15 --> currentyear-02-15
15084 sep 12 9 --> 2009-09-12
15085 12:45 --> today 12:45
15086 22 sept 0:34 --> currentyear-09-22 0:34
15087 12 --> currentyear-currentmonth-12
15088 Fri --> nearest Friday (today or later)
15089 etc.
15091 Furthermore you can specify a relative date by giving, as the *first* thing
15092 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15093 change in days weeks, months, years.
15094 With a single plus or minus, the date is relative to today. With a double
15095 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15096 +4d --> four days from today
15097 +4 --> same as above
15098 +2w --> two weeks from today
15099 ++5 --> five days from default date
15101 The function understands only English month and weekday abbreviations.
15103 While prompting, a calendar is popped up - you can also select the
15104 date with the mouse (button 1). The calendar shows a period of three
15105 months. To scroll it to other months, use the keys `>' and `<'.
15106 If you don't like the calendar, turn it off with
15107 \(setq org-read-date-popup-calendar nil)
15109 With optional argument TO-TIME, the date will immediately be converted
15110 to an internal time.
15111 With an optional argument WITH-TIME, the prompt will suggest to also
15112 insert a time. Note that when WITH-TIME is not set, you can still
15113 enter a time, and this function will inform the calling routine about
15114 this change. The calling routine may then choose to change the format
15115 used to insert the time stamp into the buffer to include the time.
15116 With optional argument FROM-STRING, read from this string instead from
15117 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15118 the time/date that is used for everything that is not specified by the
15119 user."
15120 (require 'parse-time)
15121 (let* ((org-time-stamp-rounding-minutes
15122 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15123 (org-dcst org-display-custom-times)
15124 (ct (org-current-time))
15125 (org-def (or org-overriding-default-time default-time ct))
15126 (org-defdecode (decode-time org-def))
15127 (dummy (progn
15128 (when (< (nth 2 org-defdecode) org-extend-today-until)
15129 (setcar (nthcdr 2 org-defdecode) -1)
15130 (setcar (nthcdr 1 org-defdecode) 59)
15131 (setq org-def (apply 'encode-time org-defdecode)
15132 org-defdecode (decode-time org-def)))))
15133 (calendar-frame-setup nil)
15134 (calendar-setup nil)
15135 (calendar-move-hook nil)
15136 (calendar-view-diary-initially-flag nil)
15137 (calendar-view-holidays-initially-flag nil)
15138 (timestr (format-time-string
15139 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15140 (prompt (concat (if prompt (concat prompt " ") "")
15141 (format "Date+time [%s]: " timestr)))
15142 ans (org-ans0 "") org-ans1 org-ans2 final)
15144 (cond
15145 (from-string (setq ans from-string))
15146 (org-read-date-popup-calendar
15147 (save-excursion
15148 (save-window-excursion
15149 (calendar)
15150 (org-eval-in-calendar '(setq cursor-type nil) t)
15151 (unwind-protect
15152 (progn
15153 (calendar-forward-day (- (time-to-days org-def)
15154 (calendar-absolute-from-gregorian
15155 (calendar-current-date))))
15156 (org-eval-in-calendar nil t)
15157 (let* ((old-map (current-local-map))
15158 (map (copy-keymap calendar-mode-map))
15159 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15160 (org-defkey map (kbd "RET") 'org-calendar-select)
15161 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15162 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15163 (org-defkey minibuffer-local-map [(meta shift left)]
15164 (lambda () (interactive)
15165 (org-eval-in-calendar '(calendar-backward-month 1))))
15166 (org-defkey minibuffer-local-map [(meta shift right)]
15167 (lambda () (interactive)
15168 (org-eval-in-calendar '(calendar-forward-month 1))))
15169 (org-defkey minibuffer-local-map [(meta shift up)]
15170 (lambda () (interactive)
15171 (org-eval-in-calendar '(calendar-backward-year 1))))
15172 (org-defkey minibuffer-local-map [(meta shift down)]
15173 (lambda () (interactive)
15174 (org-eval-in-calendar '(calendar-forward-year 1))))
15175 (org-defkey minibuffer-local-map [?\e (shift left)]
15176 (lambda () (interactive)
15177 (org-eval-in-calendar '(calendar-backward-month 1))))
15178 (org-defkey minibuffer-local-map [?\e (shift right)]
15179 (lambda () (interactive)
15180 (org-eval-in-calendar '(calendar-forward-month 1))))
15181 (org-defkey minibuffer-local-map [?\e (shift up)]
15182 (lambda () (interactive)
15183 (org-eval-in-calendar '(calendar-backward-year 1))))
15184 (org-defkey minibuffer-local-map [?\e (shift down)]
15185 (lambda () (interactive)
15186 (org-eval-in-calendar '(calendar-forward-year 1))))
15187 (org-defkey minibuffer-local-map [(shift up)]
15188 (lambda () (interactive)
15189 (org-eval-in-calendar '(calendar-backward-week 1))))
15190 (org-defkey minibuffer-local-map [(shift down)]
15191 (lambda () (interactive)
15192 (org-eval-in-calendar '(calendar-forward-week 1))))
15193 (org-defkey minibuffer-local-map [(shift left)]
15194 (lambda () (interactive)
15195 (org-eval-in-calendar '(calendar-backward-day 1))))
15196 (org-defkey minibuffer-local-map [(shift right)]
15197 (lambda () (interactive)
15198 (org-eval-in-calendar '(calendar-forward-day 1))))
15199 (org-defkey minibuffer-local-map ">"
15200 (lambda () (interactive)
15201 (org-eval-in-calendar '(scroll-calendar-left 1))))
15202 (org-defkey minibuffer-local-map "<"
15203 (lambda () (interactive)
15204 (org-eval-in-calendar '(scroll-calendar-right 1))))
15205 (org-defkey minibuffer-local-map "\C-v"
15206 (lambda () (interactive)
15207 (org-eval-in-calendar
15208 '(calendar-scroll-left-three-months 1))))
15209 (org-defkey minibuffer-local-map "\M-v"
15210 (lambda () (interactive)
15211 (org-eval-in-calendar
15212 '(calendar-scroll-right-three-months 1))))
15213 (run-hooks 'org-read-date-minibuffer-setup-hook)
15214 (unwind-protect
15215 (progn
15216 (use-local-map map)
15217 (setq org-read-date-inactive inactive)
15218 (add-hook 'post-command-hook 'org-read-date-display)
15219 (setq org-ans0 (read-string prompt default-input
15220 'org-read-date-history nil))
15221 ;; org-ans0: from prompt
15222 ;; org-ans1: from mouse click
15223 ;; org-ans2: from calendar motion
15224 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15225 (remove-hook 'post-command-hook 'org-read-date-display)
15226 (use-local-map old-map)
15227 (when org-read-date-overlay
15228 (delete-overlay org-read-date-overlay)
15229 (setq org-read-date-overlay nil)))))
15230 (bury-buffer "*Calendar*")))))
15232 (t ; Naked prompt only
15233 (unwind-protect
15234 (setq ans (read-string prompt default-input
15235 'org-read-date-history timestr))
15236 (when org-read-date-overlay
15237 (delete-overlay org-read-date-overlay)
15238 (setq org-read-date-overlay nil)))))
15240 (setq final (org-read-date-analyze ans org-def org-defdecode))
15242 (when org-read-date-analyze-forced-year
15243 (message "Year was forced into %s"
15244 (if org-read-date-force-compatible-dates
15245 "compatible range (1970-2037)"
15246 "range representable on this machine"))
15247 (ding))
15249 ;; One round trip to get rid of 34th of August and stuff like that....
15250 (setq final (decode-time (apply 'encode-time final)))
15252 (setq org-read-date-final-answer ans)
15254 (if to-time
15255 (apply 'encode-time final)
15256 (if (and (boundp 'org-time-was-given) org-time-was-given)
15257 (format "%04d-%02d-%02d %02d:%02d"
15258 (nth 5 final) (nth 4 final) (nth 3 final)
15259 (nth 2 final) (nth 1 final))
15260 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15262 (defvar org-def)
15263 (defvar org-defdecode)
15264 (defvar org-with-time)
15265 (defun org-read-date-display ()
15266 "Display the current date prompt interpretation in the minibuffer."
15267 (when org-read-date-display-live
15268 (when org-read-date-overlay
15269 (delete-overlay org-read-date-overlay))
15270 (when (minibufferp (current-buffer))
15271 (save-excursion
15272 (end-of-line 1)
15273 (while (not (equal (buffer-substring
15274 (max (point-min) (- (point) 4)) (point))
15275 " "))
15276 (insert " ")))
15277 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15278 " " (or org-ans1 org-ans2)))
15279 (org-end-time-was-given nil)
15280 (f (org-read-date-analyze ans org-def org-defdecode))
15281 (fmts (if org-dcst
15282 org-time-stamp-custom-formats
15283 org-time-stamp-formats))
15284 (fmt (if (or org-with-time
15285 (and (boundp 'org-time-was-given) org-time-was-given))
15286 (cdr fmts)
15287 (car fmts)))
15288 (txt (format-time-string fmt (apply 'encode-time f)))
15289 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15290 (txt (concat "=> " txt)))
15291 (when (and org-end-time-was-given
15292 (string-match org-plain-time-of-day-regexp txt))
15293 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15294 org-end-time-was-given
15295 (substring txt (match-end 0)))))
15296 (when org-read-date-analyze-futurep
15297 (setq txt (concat txt " (=>F)")))
15298 (setq org-read-date-overlay
15299 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15300 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
15302 (defun org-read-date-analyze (ans org-def org-defdecode)
15303 "Analyze the combined answer of the date prompt."
15304 ;; FIXME: cleanup and comment
15305 (let ((nowdecode (decode-time (current-time)))
15306 delta deltan deltaw deltadef year month day
15307 hour minute second wday pm h2 m2 tl wday1
15308 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15309 (setq org-read-date-analyze-futurep nil
15310 org-read-date-analyze-forced-year nil)
15312 (setq ans "+0"))
15314 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15315 (setq ans (replace-match "" t t ans)
15316 deltan (car delta)
15317 deltaw (nth 1 delta)
15318 deltadef (nth 2 delta)))
15320 ;; Check if there is an iso week date in there
15321 ;; If yes, store the info and postpone interpreting it until the rest
15322 ;; of the parsing is done
15323 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15324 (setq iso-year (if (match-end 1)
15325 (org-small-year-to-year
15326 (string-to-number (match-string 1 ans))))
15327 iso-weekday (if (match-end 3)
15328 (string-to-number (match-string 3 ans)))
15329 iso-week (string-to-number (match-string 2 ans)))
15330 (setq ans (replace-match "" t t ans)))
15332 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15333 (when (string-match
15335 (setq year (if (match-end 2)
15336 (string-to-number (match-string 2 ans))
15337 (progn (setq kill-year t)
15338 (string-to-number (format-time-string "%Y"))))
15339 month (string-to-number (match-string 3 ans))
15340 day (string-to-number (match-string 4 ans)))
15341 (if (< year 100) (setq year (+ 2000 year)))
15343 t nil ans)))
15345 ;; Help matching dotted european dates
15346 (when (string-match
15347 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15348 (setq year (if (match-end 3)
15349 (string-to-number (match-string 3 ans))
15350 (progn (setq kill-year t)
15351 (string-to-number (format-time-string "%Y"))))
15352 day (string-to-number (match-string 1 ans))
15353 month (string-to-number (match-string 2 ans))
15355 t nil ans)))
15357 ;; Help matching american dates, like 5/30 or 5/30/7
15358 (when (string-match
15359 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15360 (setq year (if (match-end 4)
15361 (string-to-number (match-string 4 ans))
15362 (progn (setq kill-year t)
15363 (string-to-number (format-time-string "%Y"))))
15364 month (string-to-number (match-string 1 ans))
15365 day (string-to-number (match-string 2 ans)))
15366 (if (< year 100) (setq year (+ 2000 year)))
15368 t nil ans)))
15369 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15370 ;; If there is a time with am/pm, and *no* time without it, we convert
15371 ;; so that matching will be successful.
15372 (loop for i from 1 to 2 do ; twice, for end time as well
15375 (setq hour (string-to-number (match-string 1 ans))
15376 minute (if (match-end 3)
15377 (string-to-number (match-string 3 ans))
15378 0)
15379 pm (equal ?p
15380 (string-to-char (downcase (match-string 4 ans)))))
15381 (if (and (= hour 12) (not pm))
15382 (setq hour 0)
15383 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15384 (setq ans (replace-match (format "%02d:%02d" hour minute)
15385 t t ans))))
15387 ;; Check if a time range is given as a duration
15388 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15389 (setq hour (string-to-number (match-string 1 ans))
15390 h2 (+ hour (string-to-number (match-string 3 ans)))
15391 minute (string-to-number (match-string 2 ans))
15392 m2 (+ minute (if (match-end 5) (string-to-number
15393 (match-string 5 ans))0)))
15394 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15395 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15396 t t ans)))
15398 ;; Check if there is a time range
15399 (when (boundp 'org-end-time-was-given)
15400 (setq org-time-was-given nil)
15401 (when (and (string-match org-plain-time-of-day-regexp ans)
15402 (match-end 8))
15403 (setq org-end-time-was-given (match-string 8 ans))
15404 (setq ans (concat (substring ans 0 (match-beginning 7))
15405 (substring ans (match-end 7))))))
15407 (setq tl (parse-time-string ans)
15408 day (or (nth 3 tl) (nth 3 org-defdecode))
15409 month (or (nth 4 tl)
15410 (if (and org-read-date-prefer-future
15411 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15412 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15413 (nth 4 org-defdecode)))
15414 year (or (and (not kill-year) (nth 5 tl))
15415 (if (and org-read-date-prefer-future
15416 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15417 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15418 (nth 5 org-defdecode)))
15419 hour (or (nth 2 tl) (nth 2 org-defdecode))
15420 minute (or (nth 1 tl) (nth 1 org-defdecode))
15421 second (or (nth 0 tl) 0)
15422 wday (nth 6 tl))
15424 (when (and (eq org-read-date-prefer-future 'time)
15425 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15426 (equal day (nth 3 nowdecode))
15427 (equal month (nth 4 nowdecode))
15428 (equal year (nth 5 nowdecode))
15429 (nth 2 tl)
15430 (or (< (nth 2 tl) (nth 2 nowdecode))
15431 (and (= (nth 2 tl) (nth 2 nowdecode))
15432 (nth 1 tl)
15433 (< (nth 1 tl) (nth 1 nowdecode)))))
15434 (setq day (1+ day)
15435 futurep t))
15437 ;; Special date definitions below
15438 (cond
15439 (iso-week
15440 ;; There was an iso week
15441 (require 'cal-iso)
15442 (setq futurep nil)
15443 (setq year (or iso-year year)
15444 day (or iso-weekday wday 1)
15445 wday nil ; to make sure that the trigger below does not match
15446 iso-date (calendar-gregorian-from-absolute
15447 (calendar-absolute-from-iso
15448 (list iso-week day year))))
15449 ; FIXME: Should we also push ISO weeks into the future?
15450 ; (when (and org-read-date-prefer-future
15451 ; (not iso-year)
15452 ; (< (calendar-absolute-from-gregorian iso-date)
15453 ; (time-to-days (current-time))))
15454 ; (setq year (1+ year)
15455 ; iso-date (calendar-gregorian-from-absolute
15456 ; (calendar-absolute-from-iso
15457 ; (list iso-week day year)))))
15458 (setq month (car iso-date)
15459 year (nth 2 iso-date)
15460 day (nth 1 iso-date)))
15461 (deltan
15462 (setq futurep nil)
15463 (unless deltadef
15464 (let ((now (decode-time (current-time))))
15465 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15466 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15467 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15468 ((equal deltaw "m") (setq month (+ month deltan)))
15469 ((equal deltaw "y") (setq year (+ year deltan)))))
15470 ((and wday (not (nth 3 tl)))
15471 (setq futurep nil)
15472 ;; Weekday was given, but no day, so pick that day in the week
15473 ;; on or after the derived date.
15474 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15475 (unless (equal wday wday1)
15476 (setq day (+ day (% (- wday wday1 -7) 7))))))
15477 (if (and (boundp 'org-time-was-given)
15478 (nth 2 tl))
15479 (setq org-time-was-given t))
15480 (if (< year 100) (setq year (+ 2000 year)))
15481 ;; Check of the date is representable
15482 (if org-read-date-force-compatible-dates
15483 (progn
15484 (if (< year 1970)
15485 (setq year 1970 org-read-date-analyze-forced-year t))
15486 (if (> year 2037)
15487 (setq year 2037 org-read-date-analyze-forced-year t)))
15488 (condition-case nil
15489 (ignore (encode-time second minute hour day month year))
15490 (error
15491 (setq year (nth 5 org-defdecode))
15492 (setq org-read-date-analyze-forced-year t))))
15493 (setq org-read-date-analyze-futurep futurep)
15494 (list second minute hour day month year)))
15496 (defvar parse-time-weekdays)
15497 (defun org-read-date-get-relative (s today default)
15498 "Check string S for special relative date string.
15499 TODAY and DEFAULT are internal times, for today and for a default.
15500 Return shift list (N what def-flag)
15502 N is the number of WHATs to shift.
15503 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15504 the DEFAULT date rather than TODAY."
15505 (require 'parse-time)
15506 (when (and
15507 (string-match
15508 (concat
15513 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15514 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15515 (string-to-char (substring (match-string 1 s) -1))
15516 ?+))
15517 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15518 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15519 (what (if (match-end 3) (match-string 3 s) "d"))
15520 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15521 (date (if rel default today))
15522 (wday (nth 6 (decode-time date)))
15523 delta)
15524 (if wday1
15525 (progn
15526 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15527 (if (= dir ?-) (setq delta (- delta 7)))
15528 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15529 (list delta "d" rel))
15530 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15532 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15533 "Turn a user-specified date into the internal representation.
15534 The internal representation needed by the calendar is (month day year).
15535 This is a wrapper to handle the brain-dead convention in calendar that
15536 user function argument order change dependent on argument order."
15537 (if (boundp 'calendar-date-style)
15538 (cond
15539 ((eq calendar-date-style 'american)
15540 (list arg1 arg2 arg3))
15541 ((eq calendar-date-style 'european)
15542 (list arg2 arg1 arg3))
15543 ((eq calendar-date-style 'iso)
15544 (list arg2 arg3 arg1)))
15545 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15546 (if (org-bound-and-true-p european-calendar-style)
15547 (list arg2 arg1 arg3)
15548 (list arg1 arg2 arg3)))))
15550 (defun org-eval-in-calendar (form &optional keepdate)
15551 "Eval FORM in the calendar window and return to current window.
15552 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
15553 otherwise stick to the current value of `org-ans2'."
15554 (let ((sf (selected-frame))
15555 (sw (selected-window)))
15556 (select-window (get-buffer-window "*Calendar*" t))
15557 (eval form)
15558 (when (and (not keepdate) (calendar-cursor-to-date))
15559 (let* ((date (calendar-cursor-to-date))
15560 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15561 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15562 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15563 (select-window sw)
15564 (org-select-frame-set-input-focus sf)))
15566 (defun org-calendar-select ()
15567 "Return to `org-read-date' with the date currently selected.
15568 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15569 (interactive)
15570 (when (calendar-cursor-to-date)
15571 (let* ((date (calendar-cursor-to-date))
15572 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15573 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15574 (if (active-minibuffer-window) (exit-minibuffer))))
15576 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15577 "Insert a date stamp for the date given by the internal TIME.
15578 WITH-HM means use the stamp format that includes the time of the day.
15579 INACTIVE means use square brackets instead of angular ones, so that the
15580 stamp will not contribute to the agenda.
15581 PRE and POST are optional strings to be inserted before and after the
15582 stamp.
15583 The command returns the inserted time stamp."
15584 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15585 stamp)
15586 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15587 (insert-before-markers (or pre ""))
15588 (when (listp extra)
15589 (setq extra (car extra))
15590 (if (and (stringp extra)
15592 (setq extra (format "-%02d:%02d"
15593 (string-to-number (match-string 1 extra))
15594 (string-to-number (match-string 2 extra))))
15595 (setq extra nil)))
15596 (when extra
15597 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15598 (insert-before-markers (setq stamp (format-time-string fmt time)))
15599 (insert-before-markers (or post ""))
15600 (setq org-last-inserted-timestamp stamp)))
15602 (defun org-toggle-time-stamp-overlays ()
15603 "Toggle the use of custom time stamp formats."
15604 (interactive)
15605 (setq org-display-custom-times (not org-display-custom-times))
15606 (unless org-display-custom-times
15607 (let ((p (point-min)) (bmp (buffer-modified-p)))
15608 (while (setq p (next-single-property-change p 'display))
15609 (if (and (get-text-property p 'display)
15610 (eq (get-text-property p 'face) 'org-date))
15611 (remove-text-properties
15612 p (setq p (next-single-property-change p 'display))
15613 '(display t))))
15614 (set-buffer-modified-p bmp)))
15615 (if (featurep 'xemacs)
15616 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15617 (org-restart-font-lock)
15618 (setq org-table-may-need-update t)
15619 (if org-display-custom-times
15620 (message "Time stamps are overlaid with custom format")
15621 (message "Time stamp overlays removed")))
15623 (defun org-display-custom-time (beg end)
15624 "Overlay modified time stamp format over timestamp between BEG and END."
15625 (let* ((ts (buffer-substring beg end))
15626 t1 w1 with-hm tf time str w2 (off 0))
15627 (save-match-data
15628 (setq t1 (org-parse-time-string ts t))
15629 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
15630 (setq off (- (match-end 0) (match-beginning 0)))))
15631 (setq end (- end off))
15632 (setq w1 (- end beg)
15633 with-hm (and (nth 1 t1) (nth 2 t1))
15634 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15635 time (org-fix-decoded-time t1)
15636 str (org-add-props
15637 (format-time-string
15638 (substring tf 1 -1) (apply 'encode-time time))
15639 nil 'mouse-face 'highlight)
15640 w2 (length str))
15641 (if (not (= w2 w1))
15642 (add-text-properties (1+ beg) (+ 2 beg)
15643 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15644 (if (featurep 'xemacs)
15645 (progn
15646 (put-text-property beg end 'invisible t)
15647 (put-text-property beg end 'end-glyph (make-glyph str)))
15648 (put-text-property beg end 'display str))))
15650 (defun org-translate-time (string)
15651 "Translate all timestamps in STRING to custom format.
15652 But do this only if the variable `org-display-custom-times' is set."
15653 (when org-display-custom-times
15654 (save-match-data
15655 (let* ((start 0)
15656 (re org-ts-regexp-both)
15657 t1 with-hm inactive tf time str beg end)
15658 (while (setq start (string-match re string start))
15659 (setq beg (match-beginning 0)
15660 end (match-end 0)
15661 t1 (save-match-data
15662 (org-parse-time-string (substring string beg end) t))
15663 with-hm (and (nth 1 t1) (nth 2 t1))
15664 inactive (equal (substring string beg (1+ beg)) "[")
15665 tf (funcall (if with-hm 'cdr 'car)
15666 org-time-stamp-custom-formats)
15667 time (org-fix-decoded-time t1)
15668 str (format-time-string
15669 (concat
15670 (if inactive "[" "<") (substring tf 1 -1)
15671 (if inactive "]" ">"))
15672 (apply 'encode-time time))
15673 string (replace-match str t t string)
15674 start (+ start (length str)))))))
15675 string)
15677 (defun org-fix-decoded-time (time)
15678 "Set 0 instead of nil for the first 6 elements of time.
15679 Don't touch the rest."
15680 (let ((n 0))
15681 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15683 (defun org-days-to-time (timestamp-string)
15684 "Difference between TIMESTAMP-STRING and now in days."
15685 (- (time-to-days (org-time-string-to-time timestamp-string))
15686 (time-to-days (current-time))))
15688 (defun org-deadline-close (timestamp-string &optional ndays)
15689 "Is the time in TIMESTAMP-STRING close to the current date?"
15690 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15691 (and (< (org-days-to-time timestamp-string) ndays)
15692 (not (org-entry-is-done-p))))
15694 (defun org-get-wdays (ts)
15695 "Get the deadline lead time appropriate for timestring TS."
15696 (cond
15697 ((<= org-deadline-warning-days 0)
15698 ;; 0 or negative, enforce this value no matter what
15699 (- org-deadline-warning-days))
15701 ;; lead time is specified.
15702 (floor (* (string-to-number (match-string 1 ts))
15703 (cdr (assoc (match-string 2 ts)
15704 '(("d" . 1) ("w" . 7)
15705 ("m" . 30.4) ("y" . 365.25)))))))
15706 ;; go for the default.
15707 (t org-deadline-warning-days)))
15709 (defun org-calendar-select-mouse (ev)
15710 "Return to `org-read-date' with the date currently selected.
15711 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15712 (interactive "e")
15713 (mouse-set-point ev)
15714 (when (calendar-cursor-to-date)
15715 (let* ((date (calendar-cursor-to-date))
15716 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15717 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15718 (if (active-minibuffer-window) (exit-minibuffer))))
15720 (defun org-check-deadlines (ndays)
15721 "Check if there are any deadlines due or past due.
15722 A deadline is considered due if it happens within `org-deadline-warning-days'
15723 days from today's date. If the deadline appears in an entry marked DONE,
15724 it is not shown. The prefix arg NDAYS can be used to test that many
15726 (interactive "P")
15727 (let* ((org-warn-days
15728 (cond
15729 ((equal ndays '(4)) 100000)
15730 (ndays (prefix-numeric-value ndays))
15731 (t (abs org-deadline-warning-days))))
15732 (case-fold-search nil)
15734 (callback
15735 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15737 (message "%d deadlines past-due or due within %d days"
15738 (org-occur regexp nil callback)
15739 org-warn-days)))
15741 (defun org-check-before-date (date)
15742 "Check if there are deadlines or scheduled entries before DATE."
15743 (interactive (list (org-read-date)))
15744 (let ((case-fold-search nil)
15748 (callback
15749 (lambda () (time-less-p
15750 (org-time-string-to-time (match-string 2))
15751 (org-time-string-to-time date)))))
15752 (message "%d entries before %s"
15753 (org-occur regexp nil callback) date)))
15755 (defun org-check-after-date (date)
15756 "Check if there are deadlines or scheduled entries after DATE."
15757 (interactive (list (org-read-date)))
15758 (let ((case-fold-search nil)
15762 (callback
15763 (lambda () (not
15764 (time-less-p
15765 (org-time-string-to-time (match-string 2))
15766 (org-time-string-to-time date))))))
15767 (message "%d entries after %s"
15768 (org-occur regexp nil callback) date)))
15770 (defun org-check-dates-range (start-date end-date)
15771 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15772 (interactive (list (org-read-date nil nil nil "Range starts")
15773 (org-read-date nil nil nil "Range end")))
15774 (let ((case-fold-search nil)
15778 (callback
15779 (lambda ()
15780 (let ((match (match-string 2)))
15781 (and
15782 (not (time-less-p
15783 (org-time-string-to-time match)
15784 (org-time-string-to-time start-date)))
15785 (time-less-p
15786 (org-time-string-to-time match)
15787 (org-time-string-to-time end-date)))))))
15788 (message "%d entries between %s and %s"
15789 (org-occur regexp nil callback) start-date end-date)))
15791 (defun org-evaluate-time-range (&optional to-buffer)
15792 "Evaluate a time range by computing the difference between start and end.
15793 Normally the result is just printed in the echo area, but with prefix arg
15794 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15795 If the time range is actually in a table, the result is inserted into the
15796 next column.
15797 For time difference computation, a year is assumed to be exactly 365
15798 days in order to avoid rounding problems."
15799 (interactive "P")
15800 (or
15801 (org-clock-update-time-maybe)
15802 (save-excursion
15803 (unless (org-at-date-range-p t)
15804 (goto-char (point-at-bol))
15805 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15806 (if (not (org-at-date-range-p t))
15807 (error "Not at a time-stamp range, and none found in current line")))
15808 (let* ((ts1 (match-string 1))
15809 (ts2 (match-string 2))
15810 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15811 (match-end (match-end 0))
15812 (time1 (org-time-string-to-time ts1))
15813 (time2 (org-time-string-to-time ts2))
15814 (t1 (org-float-time time1))
15815 (t2 (org-float-time time2))
15816 (diff (abs (- t2 t1)))
15817 (negative (< (- t2 t1) 0))
15818 ;; (ys (floor (* 365 24 60 60)))
15819 (ds (* 24 60 60))
15820 (hs (* 60 60))
15821 (fy "%dy %dd %02d:%02d")
15822 (fy1 "%dy %dd")
15823 (fd "%dd %02d:%02d")
15824 (fd1 "%dd")
15825 (fh "%02d:%02d")
15826 y d h m align)
15827 (if havetime
15828 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15829 y 0
15830 d (floor (/ diff ds)) diff (mod diff ds)
15831 h (floor (/ diff hs)) diff (mod diff hs)
15832 m (floor (/ diff 60)))
15833 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15834 y 0
15835 d (floor (+ (/ diff ds) 0.5))
15836 h 0 m 0))
15837 (if (not to-buffer)
15838 (message "%s" (org-make-tdiff-string y d h m))
15839 (if (org-at-table-p)
15840 (progn
15841 (goto-char match-end)
15842 (setq align t)
15843 (and (looking-at " *|") (goto-char (match-end 0))))
15844 (goto-char match-end))
15845 (if (looking-at
15847 (replace-match ""))
15848 (if negative (insert " -"))
15849 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15850 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15851 (insert " " (format fh h m))))
15852 (if align (org-table-align))
15853 (message "Time difference inserted")))))
15855 (defun org-make-tdiff-string (y d h m)
15856 (let ((fmt "")
15857 (l nil))
15858 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15859 l (push y l)))
15860 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15861 l (push d l)))
15862 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15863 l (push h l)))
15864 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15865 l (push m l)))
15866 (apply 'format fmt (nreverse l))))
15868 (defun org-time-string-to-time (s &optional buffer pos)
15869 (condition-case errdata
15870 (apply 'encode-time (org-parse-time-string s))
15872 s (if (not (and buffer pos))
15873 ""
15874 (format " at %d in buffer `%s'" pos buffer))
15875 (cdr errdata)))))
15877 (defun org-time-string-to-seconds (s)
15878 (org-float-time (org-time-string-to-time s)))
15880 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15881 "Convert a time stamp to an absolute day number.
15882 If there is a specifier for a cyclic time stamp, get the closest date to
15883 DAYNR.
15884 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15885 The variable date is bound by the calendar when this is called."
15886 (cond
15888 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15889 daynr
15890 (+ daynr 1000)))
15892 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15893 (time-to-days (current-time))) (match-string 0 s)
15894 prefer show-all))
15895 (t (time-to-days
15896 (condition-case errdata
15897 (apply 'encode-time (org-parse-time-string s))
15899 s (if (not (and buffer pos))
15900 ""
15901 (format " at %d in buffer `%s'" pos buffer))
15902 (cdr errdata))))))))
15904 (defun org-days-to-iso-week (days)
15905 "Return the iso week number."
15906 (require 'cal-iso)
15907 (car (calendar-iso-from-absolute days)))
15909 (defun org-small-year-to-year (year)
15910 "Convert 2-digit years into 4-digit years.
15911 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15912 The year 2000 cannot be abbreviated. Any year larger than 99
15913 is returned unchanged."
15914 (if (< year 38)
15915 (setq year (+ 2000 year))
15916 (if (< year 100)
15917 (setq year (+ 1900 year))))
15918 year)
15920 (defun org-time-from-absolute (d)
15921 "Return the time corresponding to date D.
15922 D may be an absolute day number, or a calendar-type list (month day year)."
15923 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15924 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15926 (defun org-calendar-holiday ()
15927 "List of holidays, for Diary display in Org-mode."
15928 (require 'holidays)
15929 (let ((hl (funcall
15930 (if (fboundp 'calendar-check-holidays)
15931 'calendar-check-holidays 'check-calendar-holidays) date)))
15932 (if hl (mapconcat 'identity hl "; "))))
15934 (defun org-diary-sexp-entry (sexp entry date)
15935 "Process a SEXP diary ENTRY for DATE."
15936 (require 'diary-lib)
15937 (let ((result (if calendar-debug-sexp
15938 (let ((stack-trace-on-error t))
15939 (eval (car (read-from-string sexp))))
15940 (condition-case nil
15941 (eval (car (read-from-string sexp)))
15942 (error
15943 (beep)
15944 (message "Bad sexp at line %d in %s: %s"
15945 (org-current-line)
15946 (buffer-file-name) sexp)
15947 (sleep-for 2))))))
15948 (cond ((stringp result) (split-string result "; "))
15949 ((and (consp result)
15950 (not (consp (cdr result)))
15951 (stringp (cdr result))) (cdr result))
15952 ((and (consp result)
15953 (stringp (car result))) result)
15954 (result entry)
15955 (t nil))))
15957 (defun org-diary-to-ical-string (frombuf)
15958 "Get iCalendar entries from diary entries in buffer FROMBUF.
15959 This uses the icalendar.el library."
15960 (let* ((tmpdir (if (featurep 'xemacs)
15961 (temp-directory)
15962 temporary-file-directory))
15963 (tmpfile (make-temp-name
15964 (expand-file-name "orgics" tmpdir)))
15965 buf rtn b e)
15966 (with-current-buffer frombuf
15967 (icalendar-export-region (point-min) (point-max) tmpfile)
15968 (setq buf (find-buffer-visiting tmpfile))
15969 (set-buffer buf)
15970 (goto-char (point-min))
15971 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15972 (setq b (match-beginning 0)))
15973 (goto-char (point-max))
15974 (if (re-search-backward "^END:VEVENT" nil t)
15975 (setq e (match-end 0)))
15977 (kill-buffer buf)
15978 (delete-file tmpfile)
15979 rtn))
15981 (defun org-closest-date (start current change prefer show-all)
15982 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15983 When PREFER is `past', return a date that is either CURRENT or past.
15984 When PREFER is `future', return a date that is either CURRENT or future.
15985 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15986 ;; Make the proper lists from the dates
15987 (catch 'exit
15988 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15989 dn dw sday cday n1 n2 n0
15990 d m y y1 y2 date1 date2 nmonths nm ny m2)
15992 (setq start (org-date-to-gregorian start)
15993 current (org-date-to-gregorian
15994 (if show-all
15995 current
15996 (time-to-days (current-time))))
15997 sday (calendar-absolute-from-gregorian start)
15998 cday (calendar-absolute-from-gregorian current))
16000 (if (<= cday sday) (throw 'exit sday))
16003 (setq dn (string-to-number (match-string 1 change))
16004 dw (cdr (assoc (match-string 2 change) a1)))
16005 (error "Invalid change specifier: %s" change))
16006 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16007 (cond
16008 ((eq dw 'day)
16009 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16010 n2 (+ n1 dn)))
16011 ((eq dw 'year)
16012 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16013 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16014 (setq date1 (list m d y1)
16015 n1 (calendar-absolute-from-gregorian date1)
16016 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16017 n2 (calendar-absolute-from-gregorian date2)))
16018 ((eq dw 'month)
16019 ;; approx number of month between the two dates
16020 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16021 ;; How often does dn fit in there?
16022 (setq d (nth 1 start) m (car start) y (nth 2 start)
16023 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16024 m (+ m nm)
16025 ny (floor (/ m 12))
16026 y (+ y ny)
16027 m (- m (* ny 12)))
16028 (while (> m 12) (setq m (- m 12) y (1+ y)))
16029 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16030 (setq m2 (+ m dn) y2 y)
16031 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16032 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16033 (while (<= n2 cday)
16034 (setq n1 n2 m m2 y y2)
16035 (setq m2 (+ m dn) y2 y)
16036 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16037 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
16038 ;; Make sure n1 is the earlier date
16039 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16040 (if show-all
16041 (cond
16042 ((eq prefer 'past) (if (= cday n2) n2 n1))
16043 ((eq prefer 'future) (if (= cday n1) n1 n2))
16044 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16045 (cond
16046 ((eq prefer 'past) (if (= cday n2) n2 n1))
16047 ((eq prefer 'future) (if (= cday n1) n1 n2))
16048 (t (if (= cday n1) n1 n2)))))))
16050 (defun org-date-to-gregorian (date)
16051 "Turn any specification of DATE into a Gregorian date for the calendar."
16052 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16053 ((and (listp date) (= (length date) 3)) date)
16054 ((stringp date)
16055 (setq date (org-parse-time-string date))
16056 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16057 ((listp date)
16058 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16060 (defun org-parse-time-string (s &optional nodefault)
16061 "Parse the standard Org-mode time string.
16062 This should be a lot faster than the normal `parse-time-string'.
16063 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16064 hour and minute fields will be nil if not given."
16065 (if (string-match org-ts-regexp0 s)
16066 (list 0
16067 (if (or (match-beginning 8) (not nodefault))
16068 (string-to-number (or (match-string 8 s) "0")))
16069 (if (or (match-beginning 7) (not nodefault))
16070 (string-to-number (or (match-string 7 s) "0")))
16071 (string-to-number (match-string 4 s))
16072 (string-to-number (match-string 3 s))
16073 (string-to-number (match-string 2 s))
16074 nil nil nil)
16075 (error "Not a standard Org-mode time string: %s" s)))
16077 (defun org-timestamp-up (&optional arg)
16078 "Increase the date item at the cursor by one.
16079 If the cursor is on the year, change the year. If it is on the month,
16080 the day or the time, change that.
16081 With prefix ARG, change by that many units."
16082 (interactive "p")
16083 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16085 (defun org-timestamp-down (&optional arg)
16086 "Decrease the date item at the cursor by one.
16087 If the cursor is on the year, change the year. If it is on the month,
16088 the day or the time, change that.
16089 With prefix ARG, change by that many units."
16090 (interactive "p")
16091 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16093 (defun org-timestamp-up-day (&optional arg)
16094 "Increase the date in the time stamp by one day.
16095 With prefix ARG, change that many days."
16096 (interactive "p")
16097 (if (and (not (org-at-timestamp-p t))
16098 (org-at-heading-p))
16099 (org-todo 'up)
16100 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16102 (defun org-timestamp-down-day (&optional arg)
16103 "Decrease the date in the time stamp by one day.
16104 With prefix ARG, change that many days."
16105 (interactive "p")
16106 (if (and (not (org-at-timestamp-p t))
16107 (org-at-heading-p))
16108 (org-todo 'down)
16109 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16111 (defun org-at-timestamp-p (&optional inactive-ok)
16112 "Determine if the cursor is in or at a timestamp."
16113 (interactive)
16114 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16115 (pos (point))
16116 (ans (or (looking-at tsr)
16117 (save-excursion
16119 (if (> (point) (point-min)) (backward-char 1))
16120 (and (looking-at tsr)
16121 (> (- (match-end 0) pos) -1))))))
16122 (and ans
16123 (boundp 'org-ts-what)
16124 (setq org-ts-what
16125 (cond
16126 ((= pos (match-beginning 0)) 'bracket)
16127 ;; Point is considered to be "on the bracket" whether
16128 ;; it's really on it or right after it.
16129 ((or (= pos (1- (match-end 0)))
16130 (= pos (match-end 0))) 'bracket)
16131 ((org-pos-in-match-range pos 2) 'year)
16132 ((org-pos-in-match-range pos 3) 'month)
16133 ((org-pos-in-match-range pos 7) 'hour)
16134 ((org-pos-in-match-range pos 8) 'minute)
16135 ((or (org-pos-in-match-range pos 4)
16136 (org-pos-in-match-range pos 5)) 'day)
16137 ((and (> pos (or (match-end 8) (match-end 5)))
16138 (< pos (match-end 0)))
16139 (- pos (or (match-end 8) (match-end 5))))
16140 (t 'day))))
16141 ans))
16143 (defun org-toggle-timestamp-type ()
16144 "Toggle the type (<active> or [inactive]) of a time stamp."
16145 (interactive)
16146 (when (org-at-timestamp-p t)
16147 (let ((beg (match-beginning 0)) (end (match-end 0))
16148 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16149 (save-excursion
16150 (goto-char beg)
16151 (while (re-search-forward "[][<>]" end t)
16152 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16153 t t)))
16154 (message "Timestamp is now %sactive"
16155 (if (equal (char-after beg) ?<) "" "in")))))
16157 (defun org-timestamp-change (n &optional what updown)
16158 "Change the date in the time stamp at point.
16159 The date will be changed by N times WHAT. WHAT can be `day', `month',
16160 `year', `minute', `second'. If WHAT is not given, the cursor position
16161 in the timestamp determines what will be changed."
16162 (let ((origin (point)) origin-cat
16163 with-hm inactive
16164 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16165 org-ts-what
16166 extra rem
16167 ts time time0)
16168 (if (not (org-at-timestamp-p t))
16169 (error "Not at a timestamp"))
16170 (if (and (not what) (eq org-ts-what 'bracket))
16171 (org-toggle-timestamp-type)
16172 ;; Point isn't on brackets. Remember the part of the time-stamp
16173 ;; the point was in. Indeed, size of time-stamps may change,
16174 ;; but point must be kept in the same category nonetheless.
16175 (setq origin-cat org-ts-what)
16176 (if (and (not what) (not (eq org-ts-what 'day))
16177 org-display-custom-times
16178 (get-text-property (point) 'display)
16179 (not (get-text-property (1- (point)) 'display)))
16180 (setq org-ts-what 'day))
16181 (setq org-ts-what (or what org-ts-what)
16182 inactive (= (char-after (match-beginning 0)) ?\[)
16183 ts (match-string 0))
16184 (replace-match "")
16185 (if (string-match
16187 ts)
16188 (setq extra (match-string 1 ts)))
16190 (setq with-hm t))
16191 (setq time0 (org-parse-time-string ts))
16192 (when (and updown
16193 (eq org-ts-what 'minute)
16194 (not current-prefix-arg))
16195 ;; This looks like s-up and s-down. Change by one rounding step.
16196 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16197 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16198 (setcar (cdr time0) (+ (nth 1 time0)
16199 (if (> n 0) (- rem) (- dm rem))))))
16200 (setq time
16201 (encode-time (or (car time0) 0)
16202 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16203 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16204 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16205 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16206 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16207 (nthcdr 6 time0)))
16208 (when (and (member org-ts-what '(hour minute))
16209 extra
16211 (setq extra (org-modify-ts-extra
16212 extra
16213 (if (eq org-ts-what 'hour) 2 5)
16214 n dm)))
16215 (when (integerp org-ts-what)
16216 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16217 (if (eq what 'calendar)
16218 (let ((cal-date (org-get-date-from-calendar)))
16219 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16220 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16221 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16222 (setcar time0 (or (car time0) 0))
16223 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16224 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16225 (setq time (apply 'encode-time time0))))
16226 ;; Insert the new time-stamp, and ensure point stays in the same
16227 ;; category as before (i.e. not after the last position in that
16228 ;; category).
16229 (let ((pos (point)))
16230 ;; Stay before inserted string. `save-excursion' is of no use.
16231 (setq org-last-changed-timestamp
16232 (org-insert-time-stamp time with-hm inactive nil nil extra))
16233 (goto-char pos))
16234 (save-match-data
16235 (looking-at org-ts-regexp3)
16236 (goto-char (cond
16237 ;; `day' category ends before `hour' if any, or at
16238 ;; the end of the day name.
16239 ((eq origin-cat 'day)
16240 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16241 ((eq origin-cat 'hour) (min (match-end 7) origin))
16242 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16243 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16244 ;; `year' and `month' have both fixed size: point
16245 ;; couldn't have moved into another part.
16246 (t origin))))
16247 ;; Update clock if on a CLOCK line.
16248 (org-clock-update-time-maybe)
16249 ;; Try to recenter the calendar window, if any.
16250 (if (and org-calendar-follow-timestamp-change
16251 (get-buffer-window "*Calendar*" t)
16252 (memq org-ts-what '(day month year)))
16253 (org-recenter-calendar (time-to-days time))))))
16255 (defun org-modify-ts-extra (s pos n dm)
16256 "Change the different parts of the lead-time and repeat fields in timestamp."
16257 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16258 ng h m new rem)
16259 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16260 (cond
16261 ((or (org-pos-in-match-range pos 2)
16262 (org-pos-in-match-range pos 3))
16263 (setq m (string-to-number (match-string 3 s))
16264 h (string-to-number (match-string 2 s)))
16265 (if (org-pos-in-match-range pos 2)
16266 (setq h (+ h n))
16267 (setq n (* dm (org-no-warnings (signum n))))
16268 (when (not (= 0 (setq rem (% m dm))))
16269 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16270 (setq m (+ m n)))
16271 (if (< m 0) (setq m (+ m 60) h (1- h)))
16272 (if (> m 59) (setq m (- m 60) h (1+ h)))
16273 (setq h (min 24 (max 0 h)))
16274 (setq ng 1 new (format "-%02d:%02d" h m)))
16275 ((org-pos-in-match-range pos 6)
16276 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16277 ((org-pos-in-match-range pos 5)
16278 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16280 ((org-pos-in-match-range pos 9)
16281 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16282 ((org-pos-in-match-range pos 8)
16283 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16285 (when ng
16286 (setq s (concat
16287 (substring s 0 (match-beginning ng))
16288 new
16289 (substring s (match-end ng))))))
16290 s))
16292 (defun org-recenter-calendar (date)
16293 "If the calendar is visible, recenter it to DATE."
16294 (let ((cwin (get-buffer-window "*Calendar*" t)))
16295 (when cwin
16296 (let ((calendar-move-hook nil))
16297 (with-selected-window cwin
16298 (calendar-goto-date (if (listp date) date
16299 (calendar-gregorian-from-absolute date))))))))
16301 (defun org-goto-calendar (&optional arg)
16302 "Go to the Emacs calendar at the current date.
16303 If there is a time stamp in the current line, go to that date.
16304 A prefix ARG can be used to force the current date."
16305 (interactive "P")
16306 (let ((tsr org-ts-regexp) diff
16307 (calendar-move-hook nil)
16308 (calendar-view-holidays-initially-flag nil)
16309 (calendar-view-diary-initially-flag nil))
16310 (if (or (org-at-timestamp-p)
16311 (save-excursion
16312 (beginning-of-line 1)
16313 (looking-at (concat ".*" tsr))))
16314 (let ((d1 (time-to-days (current-time)))
16315 (d2 (time-to-days
16316 (org-time-string-to-time (match-string 1)))))
16317 (setq diff (- d2 d1))))
16318 (calendar)
16319 (calendar-goto-today)
16320 (if (and diff (not arg)) (calendar-forward-day diff))))
16322 (defun org-get-date-from-calendar ()
16323 "Return a list (month day year) of date at point in calendar."
16324 (with-current-buffer "*Calendar*"
16325 (save-match-data
16326 (calendar-cursor-to-date))))
16328 (defun org-date-from-calendar ()
16329 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16330 If there is already a time stamp at the cursor position, update it."
16331 (interactive)
16332 (if (org-at-timestamp-p t)
16333 (org-timestamp-change 0 'calendar)
16334 (let ((cal-date (org-get-date-from-calendar)))
16335 (org-insert-time-stamp
16336 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16338 (defun org-minutes-to-hh:mm-string (m)
16339 "Compute H:MM from a number of minutes."
16340 (let ((h (/ m 60)))
16341 (setq m (- m (* 60 h)))
16342 (format org-time-clocksum-format h m)))
16344 (defun org-hh:mm-string-to-minutes (s)
16345 "Convert a string H:MM to a number of minutes.
16346 If the string is just a number, interpret it as minutes.
16347 In fact, the first hh:mm or number in the string will be taken,
16348 there can be extra stuff in the string.
16349 If no number is found, the return value is 0."
16350 (cond
16351 ((integerp s) s)
16353 (+ (* (string-to-number (match-string 1 s)) 60)
16354 (string-to-number (match-string 2 s))))
16356 (string-to-number (match-string 1 s)))
16357 (t 0)))
16359 (defcustom org-effort-durations
16360 `(("h" . 60)
16361 ("d" . ,(* 60 8))
16362 ("w" . ,(* 60 8 5))
16363 ("m" . ,(* 60 8 5 4))
16364 ("y" . ,(* 60 8 5 40)))
16365 "Conversion factor to minutes for an effort modifier.
16367 Each entry has the form (MODIFIER . MINUTES).
16369 In an effort string, a number followed by MODIFIER is multiplied
16370 by the specified number of MINUTES to obtain an effort in
16371 minutes.
16375 :group 'org-agenda
16376 :version "24.1"
16377 :type '(alist :key-type (string :tag "Modifier")
16378 :value-type (number :tag "Minutes")))
16380 (defun org-duration-string-to-minutes (s &optional output-to-string)
16381 "Convert a duration string S to minutes.
16383 A bare number is interpreted as minutes, modifiers can be set by
16384 customizing `org-effort-durations' (which see).
16386 Entries containing a colon are interpreted as H:MM by
16387 `org-hh:mm-string-to-minutes'."
16388 (let ((result 0)
16390 (regexp-opt (mapcar 'car org-effort-durations))
16392 (while (string-match re s)
16393 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16394 (string-to-number (match-string 1 s))))
16395 (setq s (replace-match "" nil t s)))
16396 (setq result (floor result))
16397 (incf result (org-hh:mm-string-to-minutes s))
16398 (if output-to-string (number-to-string result) result)))
16400 ;;;; Files
16402 (defun org-save-all-org-buffers ()
16403 "Save all Org-mode buffers without user confirmation."
16404 (interactive)
16405 (message "Saving all Org-mode buffers...")
16406 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
16407 (when (featurep 'org-id) (org-id-locations-save))
16408 (message "Saving all Org-mode buffers... done"))
16410 (defun org-revert-all-org-buffers ()
16411 "Revert all Org-mode buffers.
16412 Prompt for confirmation when there are unsaved changes.
16413 Be sure you know what you are doing before letting this function
16414 overwrite your changes.
16416 This function is useful in a setup where one tracks org files
16417 with a version control system, to revert on one machine after pulling
16418 changes from another. I believe the procedure must be like this:
16420 1. M-x org-save-all-org-buffers
16421 2. Pull changes from the other machine, resolve conflicts
16422 3. M-x org-revert-all-org-buffers"
16423 (interactive)
16424 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16425 (error "Abort"))
16426 (save-excursion
16427 (save-window-excursion
16428 (mapc
16429 (lambda (b)
16430 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
16431 (with-current-buffer b buffer-file-name))
16432 (org-pop-to-buffer-same-window b)
16433 (revert-buffer t 'no-confirm)))
16434 (buffer-list))
16435 (when (and (featurep 'org-id) org-id-track-globally)
16436 (org-id-locations-load)))))
16438 ;;;; Agenda files
16440 ;;;###autoload
16441 (defun org-switchb (&optional arg)
16442 "Switch between Org buffers.
16443 With one prefix argument, restrict available buffers to files.
16444 With two prefix arguments, restrict available buffers to agenda files.
16446 Defaults to `iswitchb' for buffer name completion.
16447 Set `org-completion-use-ido' to make it use ido instead."
16448 (interactive "P")
16449 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16450 ((equal arg '(16)) (org-buffer-list 'agenda))
16451 (t (org-buffer-list))))
16452 (org-completion-use-iswitchb org-completion-use-iswitchb)
16453 (org-completion-use-ido org-completion-use-ido))
16454 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16455 (setq org-completion-use-iswitchb t))
16456 (org-pop-to-buffer-same-window
16457 (org-icompleting-read "Org buffer: "
16458 (mapcar 'list (mapcar 'buffer-name blist))
16459 nil t))))
16461 ;;; Define some older names previously used for this functionality
16462 ;;;###autoload
16463 (defalias 'org-ido-switchb 'org-switchb)
16464 ;;;###autoload
16465 (defalias 'org-iswitchb 'org-switchb)
16467 (defun org-buffer-list (&optional predicate exclude-tmp)
16468 "Return a list of Org buffers.
16469 PREDICATE can be `export', `files' or `agenda'.
16471 export restrict the list to Export buffers.
16472 files restrict the list to buffers visiting Org files.
16473 agenda restrict the list to buffers visiting agenda files.
16475 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16476 (let* ((bfn nil)
16477 (agenda-files (and (eq predicate 'agenda)
16478 (mapcar 'file-truename (org-agenda-files t))))
16479 (filter
16480 (cond
16481 ((eq predicate 'files)
16482 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
16483 ((eq predicate 'export)
16484 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16485 ((eq predicate 'agenda)
16486 (lambda (b)
16487 (with-current-buffer b
16488 (and (derived-mode-p 'org-mode)
16489 (setq bfn (buffer-file-name b))
16490 (member (file-truename bfn) agenda-files)))))
16491 (t (lambda (b) (with-current-buffer b
16492 (or (derived-mode-p 'org-mode)
16493 (string-match "\*Org .*Export"
16494 (buffer-name b)))))))))
16495 (delq nil
16496 (mapcar
16497 (lambda(b)
16498 (if (and (funcall filter b)
16499 (or (not exclude-tmp)
16500 (not (string-match "tmp" (buffer-name b)))))
16501 b
16502 nil))
16503 (buffer-list)))))
16505 (defun org-agenda-files (&optional unrestricted archives)
16506 "Get the list of agenda files.
16507 Optional UNRESTRICTED means return the full list even if a restriction
16508 is currently in place.
16509 When ARCHIVES is t, include all archive files that are really being
16510 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16511 `org-agenda-archives-mode' is t."
16512 (let ((files
16513 (cond
16514 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16515 ((stringp org-agenda-files) (org-read-agenda-file-list))
16516 ((listp org-agenda-files) org-agenda-files)
16517 (t (error "Invalid value of `org-agenda-files'")))))
16518 (setq files (apply 'append
16519 (mapcar (lambda (f)
16520 (if (file-directory-p f)
16521 (directory-files
16522 f t org-agenda-file-regexp)
16523 (list f)))
16524 files)))
16525 (when org-agenda-skip-unavailable-files
16526 (setq files (delq nil
16527 (mapcar (function
16528 (lambda (file)
16529 (and (file-readable-p file) file)))
16530 files))))
16531 (when (or (eq archives t)
16532 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16533 (setq files (org-add-archive-files files)))
16534 files))
16536 (defun org-agenda-file-p (&optional file)
16537 "Return non-nil, if FILE is an agenda file.
16538 If FILE is omitted, use the file associated with the current
16539 buffer."
16540 (member (or file (buffer-file-name))
16541 (org-agenda-files t)))
16543 (defun org-edit-agenda-file-list ()
16544 "Edit the list of agenda files.
16545 Depending on setup, this either uses customize to edit the variable
16546 `org-agenda-files', or it visits the file that is holding the list. In the
16547 latter case, the buffer is set up in a way that saving it automatically kills
16548 the buffer and restores the previous window configuration."
16549 (interactive)
16550 (if (stringp org-agenda-files)
16551 (let ((cw (current-window-configuration)))
16552 (find-file org-agenda-files)
16553 (org-set-local 'org-window-configuration cw)
16554 (org-add-hook 'after-save-hook
16555 (lambda ()
16556 (set-window-configuration
16557 (prog1 org-window-configuration
16558 (kill-buffer (current-buffer))))
16559 (org-install-agenda-files-menu)
16560 (message "New agenda file list installed"))
16561 nil 'local)
16562 (message "%s" (substitute-command-keys
16564 (customize-variable 'org-agenda-files)))
16566 (defun org-store-new-agenda-file-list (list)
16567 "Set new value for the agenda file list and save it correctly."
16568 (if (stringp org-agenda-files)
16569 (let ((fe (org-read-agenda-file-list t)) b u)
16570 (while (setq b (find-buffer-visiting org-agenda-files))
16571 (kill-buffer b))
16572 (with-temp-file org-agenda-files
16573 (insert
16574 (mapconcat
16575 (lambda (f) ;; Keep un-expanded entries.
16576 (if (setq u (assoc f fe))
16577 (cdr u)
16578 f))
16581 (let ((org-mode-hook nil) (org-inhibit-startup t)
16582 (org-insert-mode-line-in-empty-file nil))
16583 (setq org-agenda-files list)
16584 (customize-save-variable 'org-agenda-files org-agenda-files))))
16586 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16587 "Read the list of agenda files from a file.
16588 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16589 filenames, used by `org-store-new-agenda-file-list' to write back
16590 un-expanded file names."
16591 (when (file-directory-p org-agenda-files)
16592 (error "`org-agenda-files' cannot be a single directory"))
16593 (when (stringp org-agenda-files)
16594 (with-temp-buffer
16595 (insert-file-contents org-agenda-files)
16596 (mapcar
16597 (lambda (f)
16598 (let ((e (expand-file-name (substitute-in-file-name f)
16599 org-directory)))
16600 (if pair-with-expansion
16601 (cons e f)
16602 e)))
16605 ;;;###autoload
16606 (defun org-cycle-agenda-files ()
16607 "Cycle through the files in `org-agenda-files'.
16608 If the current buffer visits an agenda file, find the next one in the list.
16609 If the current buffer does not, find the first agenda file."
16610 (interactive)
16611 (let* ((fs (org-agenda-files t))
16612 (files (append fs (list (car fs))))
16613 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16614 file)
16615 (unless files (error "No agenda files"))
16616 (catch 'exit
16617 (while (setq file (pop files))
16618 (if (equal (file-truename file) tcf)
16619 (when (car files)
16620 (find-file (car files))
16621 (throw 'exit t))))
16622 (find-file (car fs)))
16623 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16625 (defun org-agenda-file-to-front (&optional to-end)
16626 "Move/add the current file to the top of the agenda file list.
16627 If the file is not present in the list, it is added to the front. If it is
16628 present, it is moved there. With optional argument TO-END, add/move to the
16629 end of the list."
16630 (interactive "P")
16631 (let ((org-agenda-skip-unavailable-files nil)
16632 (file-alist (mapcar (lambda (x)
16633 (cons (file-truename x) x))
16634 (org-agenda-files t)))
16635 (ctf (file-truename buffer-file-name))
16636 x had)
16637 (setq x (assoc ctf file-alist) had x)
16639 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16640 (if to-end
16641 (setq file-alist (append (delq x file-alist) (list x)))
16642 (setq file-alist (cons x (delq x file-alist))))
16643 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16644 (org-install-agenda-files-menu)
16645 (message "File %s to %s of agenda file list"
16646 (if had "moved" "added") (if to-end "end" "front"))))
16648 (defun org-remove-file (&optional file)
16649 "Remove current file from the list of files in variable `org-agenda-files'.
16650 These are the files which are being checked for agenda entries.
16651 Optional argument FILE means use this file instead of the current."
16652 (interactive)
16653 (let* ((org-agenda-skip-unavailable-files nil)
16654 (file (or file buffer-file-name))
16655 (true-file (file-truename file))
16656 (afile (abbreviate-file-name file))
16657 (files (delq nil (mapcar
16658 (lambda (x)
16659 (if (equal true-file
16660 (file-truename x))
16661 nil x))
16662 (org-agenda-files t)))))
16663 (if (not (= (length files) (length (org-agenda-files t))))
16664 (progn
16665 (org-store-new-agenda-file-list files)
16666 (org-install-agenda-files-menu)
16667 (message "Removed file: %s" afile))
16668 (message "File was not in list: %s (not removed)" afile))))
16670 (defun org-file-menu-entry (file)
16671 (vector file (list 'find-file file) t))
16673 (defun org-check-agenda-file (file)
16674 "Make sure FILE exists. If not, ask user what to do."
16675 (when (not (file-exists-p file))
16676 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16677 (abbreviate-file-name file))
16678 (let ((r (downcase (read-char-exclusive))))
16679 (cond
16680 ((equal r ?r)
16681 (org-remove-file file)
16682 (throw 'nextfile t))
16683 (t (error "Abort"))))))
16685 (defun org-get-agenda-file-buffer (file)
16686 "Get a buffer visiting FILE. If the buffer needs to be created, add
16687 it to the list of buffers which might be released later."
16688 (let ((buf (org-find-base-buffer-visiting file)))
16689 (if buf
16690 buf ; just return it
16691 ;; Make a new buffer and remember it
16692 (setq buf (find-file-noselect file))
16693 (if buf (push buf org-agenda-new-buffers))
16694 buf)))
16696 (defun org-release-buffers (blist)
16697 "Release all buffers in list, asking the user for confirmation when needed.
16698 When a buffer is unmodified, it is just killed. When modified, it is saved
16699 \(if the user agrees) and then killed."
16700 (let (buf file)
16701 (while (setq buf (pop blist))
16702 (setq file (buffer-file-name buf))
16703 (when (and (buffer-modified-p buf)
16704 file
16705 (y-or-n-p (format "Save file %s? " file)))
16706 (with-current-buffer buf (save-buffer)))
16707 (kill-buffer buf))))
16709 (defun org-prepare-agenda-buffers (files)
16710 "Create buffers for all agenda files, protect archived trees and comments."
16711 (interactive)
16712 (let ((pa '(:org-archived t))
16713 (pc '(:org-comment t))
16714 (pall '(:org-archived t :org-comment t))
16715 (inhibit-read-only t)
16716 (rea (concat ":" org-archive-tag ":"))
16717 bmp file re)
16718 (save-excursion
16719 (save-restriction
16720 (while (setq file (pop files))
16721 (catch 'nextfile
16722 (if (bufferp file)
16723 (set-buffer file)
16724 (org-check-agenda-file file)
16725 (set-buffer (org-get-agenda-file-buffer file)))
16726 (widen)
16727 (setq bmp (buffer-modified-p))
16728 (org-refresh-category-properties)
16729 (setq org-todo-keywords-for-agenda
16730 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16731 (setq org-done-keywords-for-agenda
16732 (append org-done-keywords-for-agenda org-done-keywords))
16733 (setq org-todo-keyword-alist-for-agenda
16734 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16735 (setq org-drawers-for-agenda
16736 (append org-drawers-for-agenda org-drawers))
16737 (setq org-tag-alist-for-agenda
16738 (append org-tag-alist-for-agenda org-tag-alist))
16740 (save-excursion
16741 (remove-text-properties (point-min) (point-max) pall)
16742 (when org-agenda-skip-archived-trees
16743 (goto-char (point-min))
16744 (while (re-search-forward rea nil t)
16745 (if (org-at-heading-p t)
16746 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16747 (goto-char (point-min))
16748 (setq re (format org-heading-keyword-regexp-format
16749 org-comment-string))
16750 (while (re-search-forward re nil t)
16751 (add-text-properties
16752 (match-beginning 0) (org-end-of-subtree t) pc)))
16753 (set-buffer-modified-p bmp)))))
16754 (setq org-todo-keywords-for-agenda
16755 (org-uniquify org-todo-keywords-for-agenda))
16756 (setq org-todo-keyword-alist-for-agenda
16757 (org-uniquify org-todo-keyword-alist-for-agenda)
16758 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16760 ;;;; Embedded LaTeX
16762 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16763 "Keymap for the minor `org-cdlatex-mode'.")
16765 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16766 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16767 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16768 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16769 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16771 (defvar org-cdlatex-texmathp-advice-is-done nil
16772 "Flag remembering if we have applied the advice to texmathp already.")
16774 (define-minor-mode org-cdlatex-mode
16775 "Toggle the minor `org-cdlatex-mode'.
16776 This mode supports entering LaTeX environment and math in LaTeX fragments
16777 in Org-mode.
16779 nil " OCDL" nil
16780 (when org-cdlatex-mode
16781 (require 'cdlatex)
16782 (run-hooks 'cdlatex-mode-hook)
16783 (cdlatex-compute-tables))
16784 (unless org-cdlatex-texmathp-advice-is-done
16785 (setq org-cdlatex-texmathp-advice-is-done t)
16786 (defadvice texmathp (around org-math-always-on activate)
16787 "Always return t in org-mode buffers.
16788 This is because we want to insert math symbols without dollars even outside
16789 the LaTeX math segments. If Orgmode thinks that point is actually inside
16790 an embedded LaTeX fragment, let texmathp do its job.
16792 (interactive)
16793 (let (p)
16794 (cond
16795 ((not (derived-mode-p 'org-mode)) ad-do-it)
16796 ((eq this-command 'cdlatex-math-symbol)
16797 (setq ad-return-value t
16798 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16799 (t
16800 (let ((p (org-inside-LaTeX-fragment-p)))
16801 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16802 (setq ad-return-value t
16803 texmathp-why '("Org-mode embedded math" . 0))
16804 (if p ad-do-it)))))))))
16806 (defun turn-on-org-cdlatex ()
16807 "Unconditionally turn on `org-cdlatex-mode'."
16808 (org-cdlatex-mode 1))
16810 (defun org-inside-LaTeX-fragment-p ()
16811 "Test if point is inside a LaTeX fragment.
16813 sequence appearing also before point.
16814 Even though the matchers for math are configurable, this function assumes
16816 delimiters are skipped when they have been removed by customization.
16817 The return value is nil, or a cons cell with the delimiter and the
16818 position of this delimiter.
16820 This function does a reasonably good job, but can locally be fooled by
16821 for example currency specifications. For example it will assume being in
16823 fragments that are properly closed, but during editing, we have to live
16824 with the uncertainty caused by missing closing delimiters. This function
16825 looks only before point, not after."
16826 (catch 'exit
16827 (let ((pos (point))
16828 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16829 (lim (progn
16831 (point)))
16832 dd-on str (start 0) m re)
16833 (goto-char pos)
16834 (when dodollar
16836 re (nth 1 (assoc "$" org-latex-regexps)))
16837 (while (string-match re str start)
16838 (cond
16839 ((= (match-end 0) (length str))
16840 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16841 ((= (match-end 0) (- (length str) 5))
16842 (throw 'exit nil))
16843 (t (setq start (match-end 0))))))
16844 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16845 (goto-char pos)
16846 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16847 (and (match-beginning 2) (throw 'exit nil))
16848 ;; count $$
16850 (setq dd-on (not dd-on)))
16851 (goto-char pos)
16852 (if dd-on (cons "$$" m))))))
16854 (defun org-inside-latex-macro-p ()
16855 "Is point inside a LaTeX macro or its arguments?"
16856 (save-match-data
16857 (org-in-regexp
16860 (defun org-try-cdlatex-tab ()
16861 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16862 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16863 - inside a LaTeX fragment, or
16864 - after the first word in a line, where an abbreviation expansion could
16865 insert a LaTeX environment."
16866 (when org-cdlatex-mode
16867 (cond
16868 ;; Before any word on the line: No expansion possible.
16870 ;; Just after first word on the line: Expand it. Make sure it
16871 ;; cannot happen on headlines, though.
16872 ((save-excursion
16873 (skip-chars-backward "a-zA-Z0-9*")
16875 (and (bolp) (not (org-at-heading-p))))
16876 (cdlatex-tab) t)
16877 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16879 (defun org-cdlatex-underscore-caret (&optional arg)
16880 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16881 Revert to the normal definition outside of these fragments."
16882 (interactive "P")
16883 (if (org-inside-LaTeX-fragment-p)
16884 (call-interactively 'cdlatex-sub-superscript)
16885 (let (org-cdlatex-mode)
16886 (call-interactively (key-binding (vector last-input-event))))))
16888 (defun org-cdlatex-math-modify (&optional arg)
16889 "Execute `cdlatex-math-modify' in LaTeX fragments.
16890 Revert to the normal definition outside of these fragments."
16891 (interactive "P")
16892 (if (org-inside-LaTeX-fragment-p)
16893 (call-interactively 'cdlatex-math-modify)
16894 (let (org-cdlatex-mode)
16895 (call-interactively (key-binding (vector last-input-event))))))
16897 (defvar org-latex-fragment-image-overlays nil
16898 "List of overlays carrying the images of latex fragments.")
16899 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16901 (defun org-remove-latex-fragment-image-overlays ()
16902 "Remove all overlays with LaTeX fragment images in current buffer."
16903 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16904 (setq org-latex-fragment-image-overlays nil))
16906 (defun org-preview-latex-fragment (&optional subtree)
16907 "Preview the LaTeX fragment at point, or all locally or globally.
16908 If the cursor is in a LaTeX fragment, create the image and overlay
16909 it over the source code. If there is no fragment at point, display
16910 all fragments in the current text, from one headline to the next. With
16911 prefix SUBTREE, display all fragments in the current subtree. With a
16913 the cursor is before the first headline,
16914 display all fragments in the buffer.
16916 (interactive "P")
16917 (unless buffer-file-name
16918 (error "Can't preview LaTeX fragment in a non-file buffer"))
16919 (org-remove-latex-fragment-image-overlays)
16920 (save-excursion
16921 (save-restriction
16922 (let (beg end at msg)
16923 (cond
16924 ((or (equal subtree '(16))
16925 (not (save-excursion
16926 (re-search-backward org-outline-regexp-bol nil t))))
16927 (setq beg (point-min) end (point-max)
16928 msg "Creating images for buffer...%s"))
16929 ((equal subtree '(4))
16930 (org-back-to-heading)
16931 (setq beg (point) end (org-end-of-subtree t)
16932 msg "Creating images for subtree...%s"))
16933 (t
16934 (if (setq at (org-inside-LaTeX-fragment-p))
16935 (goto-char (max (point-min) (- (cdr at) 2)))
16936 (org-back-to-heading))
16937 (setq beg (point) end (progn (outline-next-heading) (point))
16938 msg (if at "Creating image...%s"
16939 "Creating images for entry...%s"))))
16940 (message msg "")
16941 (narrow-to-region beg end)
16942 (goto-char beg)
16943 (org-format-latex
16944 (concat "ltxpng/" (file-name-sans-extension
16945 (file-name-nondirectory
16946 buffer-file-name)))
16947 default-directory 'overlays msg at 'forbuffer
16948 org-latex-create-formula-image-program)
16949 (message msg "done. Use `C-c C-c' to remove images.")))))
16951 (defvar org-latex-regexps
16953 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16956 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16960 "Regular expressions for matching embedded LaTeX.")
16962 (defvar org-export-have-math nil) ;; dynamic scoping
16963 (defun org-format-latex (prefix &optional dir overlays msg at
16964 forbuffer processing-type)
16965 "Replace LaTeX fragments with links to an image, and produce images.
16966 Some of the options can be changed using the variable
16967 `org-format-latex-options'."
16968 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16969 (let* ((prefixnodir (file-name-nondirectory prefix))
16970 (absprefix (expand-file-name prefix dir))
16971 (todir (file-name-directory absprefix))
16972 (opt org-format-latex-options)
16973 (matchers (plist-get opt :matchers))
16974 (re-list org-latex-regexps)
16975 (org-format-latex-header-extra
16976 (plist-get (org-infile-export-plist) :latex-header-extra))
16977 (cnt 0) txt hash link beg end re e checkdir
16978 executables-checked string
16979 m n block-type block linkfile movefile ov)
16980 ;; Check the different regular expressions
16981 (while (setq e (pop re-list))
16982 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16984 (when (member m matchers)
16985 (goto-char (point-min))
16986 (while (re-search-forward re nil t)
16987 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16988 (not (get-text-property (match-beginning n)
16989 'org-protected))
16990 (or (not overlays)
16991 (not (eq (get-char-property (match-beginning n)
16992 'org-overlay-type)
16993 'org-latex-overlay))))
16994 (setq org-export-have-math t)
16995 (cond
16996 ((eq processing-type 'verbatim)
16997 ;; Leave the text verbatim, just protect it
16998 (add-text-properties (match-beginning n) (match-end n)
16999 '(org-protected t)))
17000 ((eq processing-type 'mathjax)
17001 ;; Prepare for MathJax processing
17002 (setq string (match-string n))
17003 (if (member m '("$" "$1"))
17004 (save-excursion
17005 (delete-region (match-beginning n) (match-end n))
17006 (goto-char (match-beginning n))
17009 '(org-protected t))))
17010 (add-text-properties (match-beginning n) (match-end n)
17011 '(org-protected t))))
17012 ((or (eq processing-type 'dvipng)
17013 (eq processing-type 'imagemagick))
17014 ;; Process to an image
17015 (setq txt (match-string n)
17016 beg (match-beginning n) end (match-end n)
17017 cnt (1+ cnt))
17018 (let (print-length print-level) ; make sure full list is printed
17019 (setq hash (sha1 (prin1-to-string
17020 (list org-format-latex-header
17021 org-format-latex-header-extra
17022 org-export-latex-default-packages-alist
17023 org-export-latex-packages-alist
17024 org-format-latex-options
17025 forbuffer txt)))
17026 linkfile (format "%s_%s.png" prefix hash)
17027 movefile (format "%s_%s.png" absprefix hash)))
17028 (setq link (concat block "[[file:" linkfile "]]" block))
17029 (if msg (message msg cnt))
17030 (goto-char beg)
17031 (unless checkdir ; make sure the directory exists
17032 (setq checkdir t)
17033 (or (file-directory-p todir) (make-directory todir t)))
17034 (cond
17035 ((eq processing-type 'dvipng)
17036 (unless executables-checked
17037 (org-check-external-command
17038 "latex" "needed to convert LaTeX fragments to images")
17039 (org-check-external-command
17040 "dvipng" "needed to convert LaTeX fragments to images")
17041 (setq executables-checked t))
17042 (unless (file-exists-p movefile)
17043 (org-create-formula-image-with-dvipng
17044 txt movefile opt forbuffer)))
17045 ((eq processing-type 'imagemagick)
17046 (unless executables-checked
17047 (org-check-external-command
17048 "convert" "you need to install imagemagick")
17049 (setq executables-checked t))
17050 (unless (file-exists-p movefile)
17051 (org-create-formula-image-with-imagemagick
17052 txt movefile opt forbuffer))))
17053 (if overlays
17054 (progn
17055 (mapc (lambda (o)
17056 (if (eq (overlay-get o 'org-overlay-type)
17057 'org-latex-overlay)
17058 (delete-overlay o)))
17059 (overlays-in beg end))
17060 (setq ov (make-overlay beg end))
17061 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17062 (if (featurep 'xemacs)
17063 (progn
17064 (overlay-put ov 'invisible t)
17065 (overlay-put
17066 ov 'end-glyph
17067 (make-glyph (vector 'png :file movefile))))
17068 (overlay-put
17069 ov 'display
17070 (list 'image :type 'png :file movefile :ascent 'center)))
17071 (push ov org-latex-fragment-image-overlays)
17072 (goto-char end))
17073 (delete-region beg end)
17074 (insert (org-add-props link
17075 (list 'org-latex-src
17076 (replace-regexp-in-string
17078 'org-latex-src-embed-type
17079 (if block-type 'paragraph 'character))))))
17080 ((eq processing-type 'mathml)
17081 ;; Process to MathML
17082 (unless executables-checked
17083 (unless (save-match-data (org-format-latex-mathml-available-p))
17084 (error "LaTeX to MathML converter not configured"))
17085 (setq executables-checked t))
17086 (setq txt (match-string n)
17087 beg (match-beginning n) end (match-end n)
17088 cnt (1+ cnt))
17089 (if msg (message msg cnt))
17090 (goto-char beg)
17091 (delete-region beg end)
17092 (insert (org-format-latex-as-mathml
17093 txt block-type prefix dir)))
17094 (t
17095 (error "Unknown conversion type %s for latex fragments"
17096 processing-type)))))))))
17098 (defun org-create-math-formula (latex-frag &optional mathml-file)
17099 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17100 Use `org-latex-to-mathml-convert-command'. If the conversion is
17102 elements otherwise return nil. When MATHML-FILE is specified,
17103 write the results in to that file. When invoked as an
17104 interactive command, prompt for LATEX-FRAG, with initial value
17105 set to the current active region and echo the results for user
17106 inspection."
17107 (interactive (list (let ((frag (when (region-active-p)
17108 (buffer-substring-no-properties
17109 (region-beginning) (region-end)))))
17110 (read-string "LaTeX Fragment: " frag nil frag))))
17111 (unless latex-frag (error "Invalid latex-frag"))
17112 (let* ((tmp-in-file (file-relative-name
17113 (make-temp-name (expand-file-name "ltxmathml-in"))))
17114 (ignore (write-region latex-frag nil tmp-in-file))
17115 (tmp-out-file (file-relative-name
17116 (make-temp-name (expand-file-name "ltxmathml-out"))))
17117 (cmd (format-spec
17118 org-latex-to-mathml-convert-command
17119 `((?j . ,(shell-quote-argument
17120 (expand-file-name org-latex-to-mathml-jar-file)))
17121 (?I . ,(shell-quote-argument tmp-in-file))
17122 (?o . ,(shell-quote-argument tmp-out-file)))))
17123 mathml shell-command-output)
17124 (when (org-called-interactively-p 'any)
17125 (unless (org-format-latex-mathml-available-p)
17126 (error "LaTeX to MathML converter not configured")))
17127 (message "Running %s" cmd)
17128 (setq shell-command-output (shell-command-to-string cmd))
17129 (setq mathml
17130 (when (file-readable-p tmp-out-file)
17131 (with-current-buffer (find-file-noselect tmp-out-file t)
17132 (goto-char (point-min))
17133 (when (re-search-forward
17134 (concat
17135 (regexp-quote
17138 (regexp-quote "</math>")) nil t)
17139 (prog1 (match-string 0) (kill-buffer))))))
17140 (cond
17141 (mathml
17142 (setq mathml
17144 (when mathml-file
17145 (write-region mathml nil mathml-file))
17146 (when (org-called-interactively-p 'any)
17147 (message mathml)))
17148 ((message "LaTeX to MathML conversion failed")
17149 (message shell-command-output)))
17150 (delete-file tmp-in-file)
17151 (when (file-exists-p tmp-out-file)
17152 (delete-file tmp-out-file))
17153 mathml))
17155 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17156 prefix &optional dir)
17157 "Use `org-create-math-formula' but check local cache first."
17158 (let* ((absprefix (expand-file-name prefix dir))
17159 (print-length nil) (print-level nil)
17160 (formula-id (concat
17161 "formula-"
17162 (sha1
17163 (prin1-to-string
17164 (list latex-frag
17165 org-latex-to-mathml-convert-command)))))
17166 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17167 (formula-cache-dir (file-name-directory formula-cache)))
17169 (unless (file-directory-p formula-cache-dir)
17170 (make-directory formula-cache-dir t))
17172 (unless (file-exists-p formula-cache)
17173 (org-create-math-formula latex-frag formula-cache))
17175 (if (file-exists-p formula-cache)
17176 ;; Successful conversion. Return the link to MathML file.
17177 (org-add-props
17178 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17180 'org-latex-src-embed-type (if latex-frag-type
17181 'paragraph 'character)))
17182 ;; Failed conversion. Return the LaTeX fragment verbatim
17183 (add-text-properties
17184 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17185 latex-frag)))
17187 ;; This function borrows from Ganesh Swami's latex2png.el
17188 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
17189 "This calls dvipng."
17190 (require 'org-latex)
17191 (let* ((tmpdir (if (featurep 'xemacs)
17192 (temp-directory)
17193 temporary-file-directory))
17194 (texfilebase (make-temp-name
17195 (expand-file-name "orgtex" tmpdir)))
17196 (texfile (concat texfilebase ".tex"))
17197 (dvifile (concat texfilebase ".dvi"))
17198 (pngfile (concat texfilebase ".png"))
17199 (fnh (if (featurep 'xemacs)
17200 (font-height (face-font 'default))
17201 (face-attribute 'default :height nil)))
17202 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17203 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17204 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17205 "Black"))
17206 (bg (or (plist-get options (if buffer :background :html-background))
17207 "Transparent")))
17208 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17209 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17210 (with-temp-file texfile
17211 (insert (org-splice-latex-header
17212 org-format-latex-header
17213 org-export-latex-default-packages-alist
17214 org-export-latex-packages-alist t
17215 org-format-latex-header-extra))
17217 (require 'org-latex)
17218 (org-export-latex-fix-inputenc))
17219 (let ((dir default-directory))
17220 (condition-case nil
17221 (progn
17222 (cd tmpdir)
17223 (call-process "latex" nil nil nil texfile))
17224 (error nil))
17225 (cd dir))
17226 (if (not (file-exists-p dvifile))
17227 (progn (message "Failed to create dvi file from %s" texfile) nil)
17228 (condition-case nil
17229 (if (featurep 'xemacs)
17230 (call-process "dvipng" nil nil nil
17231 "-fg" fg "-bg" bg
17232 "-T" "tight"
17233 "-o" pngfile
17234 dvifile)
17235 (call-process "dvipng" nil nil nil
17236 "-fg" fg "-bg" bg
17237 "-D" dpi
17238 ;;"-x" scale "-y" scale
17239 "-T" "tight"
17240 "-o" pngfile
17241 dvifile))
17242 (error nil))
17243 (if (not (file-exists-p pngfile))
17244 (if org-format-latex-signal-error
17245 (error "Failed to create png file from %s" texfile)
17246 (message "Failed to create png file from %s" texfile)
17247 nil)
17248 ;; Use the requested file name and clean up
17249 (copy-file pngfile tofile 'replace)
17250 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
17251 (if (file-exists-p (concat texfilebase e))
17252 (delete-file (concat texfilebase e))))
17253 pngfile))))
17255 (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
17256 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
17257 "This calls convert, which is included into imagemagick."
17258 (require 'org-latex)
17259 (let* ((tmpdir (if (featurep 'xemacs)
17260 (temp-directory)
17261 temporary-file-directory))
17262 (texfilebase (make-temp-name
17263 (expand-file-name "orgtex" tmpdir)))
17264 (texfile (concat texfilebase ".tex"))
17265 (pdffile (concat texfilebase ".pdf"))
17266 (pngfile (concat texfilebase ".png"))
17267 (fnh (if (featurep 'xemacs)
17268 (font-height (face-font 'default))
17269 (face-attribute 'default :height nil)))
17270 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17271 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17272 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17273 "black"))
17274 (bg (or (plist-get options (if buffer :background :html-background))
17275 "white")))
17276 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
17277 (setq fg (org-latex-color-format fg)))
17278 (if (eq bg 'default) (setq bg (org-latex-color :background))
17279 (setq bg (org-latex-color-format
17280 (if (string= bg "Transparent")(setq bg "white")))))
17281 (with-temp-file texfile
17282 (insert (org-splice-latex-header
17283 org-format-latex-header
17284 org-export-latex-default-packages-alist
17285 org-export-latex-packages-alist t
17286 org-format-latex-header-extra))
17292 string
17295 (require 'org-latex)
17296 (org-export-latex-fix-inputenc))
17297 (let ((dir default-directory) cmd cmds latex-frags-cmds)
17298 (condition-case nil
17299 (progn
17300 (cd tmpdir)
17301 (setq cmds org-latex-to-pdf-process)
17302 (while cmds
17303 (setq latex-frags-cmds (pop cmds))
17304 (if (listp latex-frags-cmds)
17305 (setq cmds nil)
17306 (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
17307 (while latex-frags-cmds
17308 (setq cmd (pop latex-frags-cmds))
17309 (while (string-match "%b" cmd)
17310 (setq cmd (replace-match
17311 (save-match-data
17312 (shell-quote-argument texfile))
17313 t t cmd)))
17314 (while (string-match "%f" cmd)
17315 (setq cmd (replace-match
17316 (save-match-data
17317 (shell-quote-argument (file-name-nondirectory texfile)))
17318 t t cmd)))
17319 (while (string-match "%o" cmd)
17320 (setq cmd (replace-match
17321 (save-match-data
17322 (shell-quote-argument (file-name-directory texfile)))
17323 t t cmd)))
17324 (setq cmd (split-string cmd))
17325 (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
17326 (error nil))
17327 (cd dir))
17328 (if (not (file-exists-p pdffile))
17329 (progn (message "Failed to create pdf file from %s" texfile) nil)
17330 (condition-case nil
17331 (if (featurep 'xemacs)
17332 (call-process "convert" nil nil nil
17333 "-density" "96"
17334 "-trim"
17335 "-antialias"
17336 pdffile
17337 "-quality" "100"
17338 ;; "-sharpen" "0x1.0"
17339 pngfile)
17340 (call-process "convert" nil nil nil
17341 "-density" dpi
17342 "-trim"
17343 "-antialias"
17344 pdffile
17345 "-quality" "100"
17346 ; "-sharpen" "0x1.0"
17347 pngfile))
17348 (error nil))
17349 (if (not (file-exists-p pngfile))
17350 (if org-format-latex-signal-error
17351 (error "Failed to create png file from %s" texfile)
17352 (message "Failed to create png file from %s" texfile)
17353 nil)
17354 ;; Use the requested file name and clean up
17355 (copy-file pngfile tofile 'replace)
17356 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
17357 (if (file-exists-p (concat texfilebase e))
17358 (delete-file (concat texfilebase e))))
17359 pngfile))))
17361 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17362 "Fill a LaTeX header template TPL.
17363 In the template, the following place holders will be recognized:
17366 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17368 [NO-PACKAGES] do not include PKG
17369 [EXTRA] the string EXTRA
17370 [NO-EXTRA] do not include EXTRA
17372 For backward compatibility, if both the positive and the negative place
17374 assumed to be present at the end of the template.
17375 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17376 EXTRA is a string.
17377 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17378 (let (rpl (end ""))
17380 (setq rpl (if (or (match-end 1) (not def-pkg))
17381 "" (org-latex-packages-to-string def-pkg snippets-p t))
17382 tpl (replace-match rpl t t tpl))
17383 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17386 (setq rpl (if (or (match-end 1) (not pkg))
17387 "" (org-latex-packages-to-string pkg snippets-p t))
17388 tpl (replace-match rpl t t tpl))
17389 (if pkg (setq end
17391 (org-latex-packages-to-string pkg snippets-p)))))
17394 (setq rpl (if (or (match-end 1) (not extra))
17396 tpl (replace-match rpl t t tpl))
17402 tpl)))
17404 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17406 (setq pkg (mapconcat (lambda(p)
17407 (cond
17408 ((stringp p) p)
17409 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17410 (format "%% Package %s omitted" (cadr p)))
17411 ((equal "" (car p))
17413 (t
17415 (car p) (cadr p)))))
17416 pkg
17420 (defun org-dvipng-color (attr)
17421 "Return a RGB color specification for dvipng."
17422 (apply 'format "rgb %s %s %s"
17423 (mapcar 'org-normalize-color
17424 (if (featurep 'xemacs)
17425 (color-rgb-components
17426 (face-property 'default
17427 (cond ((eq attr :foreground) 'foreground)
17428 ((eq attr :background) 'background))))
17429 (color-values (face-attribute 'default attr nil))))))
17431 (defun org-latex-color (attr)
17432 "Return a RGB color for the LaTeX color package."
17433 (apply 'format "%s,%s,%s"
17434 (mapcar 'org-normalize-color
17435 (if (featurep 'xemacs)
17436 (color-rgb-components
17437 (face-property 'default
17438 (cond ((eq attr :foreground) 'foreground)
17439 ((eq attr :background) 'background))))
17440 (color-values (face-attribute 'default attr nil))))))
17442 (defun org-latex-color-format (color-name)
17443 "Convert COLOR-NAME to a RGB color value."
17444 (apply 'format "%s,%s,%s"
17445 (mapcar 'org-normalize-color
17446 (color-values color-name))))
17448 (defun org-normalize-color (value)
17449 "Return string to be used as color value for an RGB component."
17450 (format "%g" (/ value 65535.0)))
17452 ;; Image display
17455 (defvar org-inline-image-overlays nil)
17456 (make-variable-buffer-local 'org-inline-image-overlays)
17458 (defun org-toggle-inline-images (&optional include-linked)
17459 "Toggle the display of inline images.
17460 INCLUDE-LINKED is passed to `org-display-inline-images'."
17461 (interactive "P")
17462 (if org-inline-image-overlays
17463 (progn
17464 (org-remove-inline-images)
17465 (message "Inline image display turned off"))
17466 (org-display-inline-images include-linked)
17467 (if org-inline-image-overlays
17468 (message "%d images displayed inline"
17469 (length org-inline-image-overlays))
17470 (message "No images to display inline"))))
17472 (defun org-display-inline-images (&optional include-linked refresh beg end)
17473 "Display inline images.
17474 Normally only links without a description part are inlined, because this
17475 is how it will work for export. When INCLUDE-LINKED is set, also links
17476 with a description part will be inlined. This can be nice for a quick
17477 look at those images, but it does not reflect what exported files will look
17478 like.
17479 When REFRESH is set, refresh existing images between BEG and END.
17480 This will create new image displays only if necessary.
17481 BEG and END default to the buffer boundaries."
17482 (interactive "P")
17483 (unless refresh
17484 (org-remove-inline-images)
17485 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17486 (save-excursion
17487 (save-restriction
17488 (widen)
17489 (setq beg (or beg (point-min)) end (or end (point-max)))
17490 (goto-char beg)
17492 (substring (org-image-file-name-regexp) 0 -2)
17494 old file ov img)
17495 (while (re-search-forward re end t)
17496 (setq old (get-char-property-and-overlay (match-beginning 1)
17497 'org-image-overlay))
17498 (setq file (expand-file-name
17499 (concat (or (match-string 3) "") (match-string 4))))
17500 (when (file-exists-p file)
17501 (if (and (car-safe old) refresh)
17502 (image-refresh (overlay-get (cdr old) 'display))
17503 (setq img (save-match-data (create-image file)))
17504 (when img
17505 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17506 (overlay-put ov 'display img)
17507 (overlay-put ov 'face 'default)
17508 (overlay-put ov 'org-image-overlay t)
17509 (overlay-put ov 'modification-hooks
17510 (list 'org-display-inline-modification-hook))
17511 (push ov org-inline-image-overlays)))))))))
17513 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17514 "Remove inline-display overlay if a corresponding region is modified."
17515 (let ((inhibit-modification-hooks t))
17516 (when (and ov after)
17517 (delete ov org-inline-image-overlays)
17518 (delete-overlay ov))))
17520 (defun org-remove-inline-images ()
17521 "Remove inline display of images."
17522 (interactive)
17523 (mapc 'delete-overlay org-inline-image-overlays)
17524 (setq org-inline-image-overlays nil))
17526 ;;;; Key bindings
17528 ;; Outline functions from `outline-mode-prefix-map'
17529 ;; that can be remapped in Org:
17530 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17531 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17532 (define-key org-mode-map [remap outline-forward-same-level]
17533 'org-forward-same-level)
17534 (define-key org-mode-map [remap outline-backward-same-level]
17535 'org-backward-same-level)
17536 (define-key org-mode-map [remap show-branches]
17537 'org-kill-note-or-show-branches)
17538 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17539 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17540 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17542 ;; Outline functions from `outline-mode-prefix-map'
17543 ;; that can not be remapped in Org:
17544 ;; - the column "key binding" shows whether the Outline function is still
17545 ;; available in Org mode on the same key that it has been bound to in
17546 ;; Outline mode:
17547 ;; - "overridden": key used for a different functionality in Org mode
17548 ;; - else: key still bound to the same Outline function in Org mode
17549 ;; | Outline function | key binding | Org replacement |
17550 ;; |------------------------------------+-------------+-----------------------|
17551 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17552 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17553 ;; | `show-children' | `C-c C-i' | visibility cycling |
17554 ;; | `hide-subtree' | overridden | visibility cycling |
17555 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17556 ;; | `hide-body' | overridden | no replacement |
17557 ;; | `show-all' | overridden | no replacement |
17558 ;; | `hide-entry' | overridden | visibility cycling |
17559 ;; | `show-entry' | overridden | no replacement |
17560 ;; | `hide-leaves' | overridden | no replacement |
17561 ;; | `hide-sublevels' | overridden | no replacement |
17562 ;; | `hide-other' | overridden | no replacement |
17563 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17564 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17566 ;; Make `C-c C-x' a prefix key
17567 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17569 ;; TAB key with modifiers
17570 (org-defkey org-mode-map "\C-i" 'org-cycle)
17571 (org-defkey org-mode-map [(tab)] 'org-cycle)
17572 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17574 ;; The following line is necessary under Suse GNU/Linux
17575 (unless (featurep 'xemacs)
17576 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17577 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17578 (define-key org-mode-map [backtab] 'org-shifttab)
17580 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17581 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17582 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17584 ;; Cursor keys with modifiers
17585 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17586 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17587 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17588 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17590 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17591 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17592 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17593 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17595 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17596 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17597 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17598 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17600 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17601 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17602 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17603 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17605 ;; Babel keys
17606 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17607 (mapc (lambda (pair)
17608 (define-key org-babel-map (car pair) (cdr pair)))
17609 org-babel-key-bindings)
17611 ;;; Extra keys for tty access.
17612 ;; We only set them when really needed because otherwise the
17613 ;; menus don't show the simple keys
17615 (when (or org-use-extra-keys
17616 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17617 (not window-system))
17618 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17619 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17620 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17621 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17622 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17623 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17624 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17625 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17626 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17627 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17628 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17629 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17630 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17631 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17632 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17633 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17634 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17635 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17636 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17637 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17638 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17639 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17640 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17641 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17642 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17643 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17644 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17645 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17647 ;; All the other keys
17649 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17650 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17651 (if (boundp 'narrow-map)
17652 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17653 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17654 (if (boundp 'narrow-map)
17655 (org-defkey narrow-map "b" 'org-narrow-to-block)
17656 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17657 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17658 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17659 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17660 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17661 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17662 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17663 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17664 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17665 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17666 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17667 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17668 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17669 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17670 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17671 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17672 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17673 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17675 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17676 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17677 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17678 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17679 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17680 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17681 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17682 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17683 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17684 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17685 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17686 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17687 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17688 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17689 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17690 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17691 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17692 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17693 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17694 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17696 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17697 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17698 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17699 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17700 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17701 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17702 (org-defkey org-mode-map "\C-c^" 'org-sort)
17703 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17704 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17705 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17706 (org-defkey org-mode-map "\C-m" 'org-return)
17707 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17708 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17709 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17710 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17711 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17712 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17713 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17714 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17715 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17716 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17717 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17718 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17719 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17720 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17721 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17722 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17723 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17724 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17725 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17726 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17727 (org-defkey org-mode-map "\C-c\C-@" 'org-mark-list)
17728 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17729 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17731 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17732 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17733 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17734 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17736 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17737 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17738 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17739 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17740 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17741 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17742 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17743 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17744 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17745 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17747 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17748 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17749 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17750 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17751 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17752 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17753 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17755 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17756 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17757 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17758 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17759 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17761 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17763 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17765 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17766 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17768 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17771 (when (featurep 'xemacs)
17772 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17775 (defconst org-speed-commands-default
17776 '(
17777 ("Outline Navigation")
17778 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17779 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17780 ("f" . (org-speed-move-safe 'org-forward-same-level))
17781 ("b" . (org-speed-move-safe 'org-backward-same-level))
17782 ("u" . (org-speed-move-safe 'outline-up-heading))
17783 ("j" . org-goto)
17784 ("g" . (org-refile t))
17785 ("Outline Visibility")
17786 ("c" . org-cycle)
17787 ("C" . org-shifttab)
17788 (" " . org-display-outline-path)
17789 ("Outline Structure Editing")
17790 ("U" . org-shiftmetaup)
17791 ("D" . org-shiftmetadown)
17792 ("r" . org-metaright)
17793 ("l" . org-metaleft)
17794 ("R" . org-shiftmetaright)
17795 ("L" . org-shiftmetaleft)
17796 ("i" . (progn (forward-char 1) (call-interactively
17797 'org-insert-heading-respect-content)))
17798 ("^" . org-sort)
17799 ("w" . org-refile)
17800 ("a" . org-archive-subtree-default-with-confirmation)
17801 ("." . org-mark-subtree)
17802 ("Clock Commands")
17803 ("I" . org-clock-in)
17804 ("O" . org-clock-out)
17805 ("Meta Data Editing")
17806 ("t" . org-todo)
17807 ("0" . (org-priority ?\ ))
17808 ("1" . (org-priority ?A))
17809 ("2" . (org-priority ?B))
17810 ("3" . (org-priority ?C))
17811 (";" . org-set-tags-command)
17812 ("e" . org-set-effort)
17813 ("Agenda Views etc")
17814 ("v" . org-agenda)
17815 ("/" . org-sparse-tree)
17816 ("Misc")
17817 ("o" . org-open-at-point)
17818 ("?" . org-speed-command-help)
17819 ("<" . (org-agenda-set-restriction-lock 'subtree))
17820 (">" . (org-agenda-remove-restriction-lock))
17821 )
17822 "The default speed commands.")
17824 (defun org-print-speed-command (e)
17825 (if (> (length (car e)) 1)
17826 (progn
17828 (princ (car e))
17830 (princ (make-string (length (car e)) ?-))
17832 (princ (car e))
17833 (princ " ")
17834 (if (symbolp (cdr e))
17835 (princ (symbol-name (cdr e)))
17836 (prin1 (cdr e)))
17839 (defun org-speed-command-help ()
17840 "Show the available speed commands."
17841 (interactive)
17842 (if (not org-use-speed-commands)
17843 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17844 (with-output-to-temp-buffer "*Help*"
17846 (mapc 'org-print-speed-command org-speed-commands-user)
17849 (mapc 'org-print-speed-command org-speed-commands-default))
17850 (with-current-buffer "*Help*"
17851 (setq truncate-lines t))))
17853 (defun org-speed-move-safe (cmd)
17854 "Execute CMD, but make sure that the cursor always ends up in a headline.
17855 If not, return to the original position and throw an error."
17856 (interactive)
17857 (let ((pos (point)))
17858 (call-interactively cmd)
17859 (unless (and (bolp) (org-at-heading-p))
17860 (goto-char pos)
17861 (error "Boundary reached while executing %s" cmd))))
17863 (defvar org-self-insert-command-undo-counter 0)
17865 (defvar org-table-auto-blank-field) ; defined in org-table.el
17866 (defvar org-speed-command nil)
17868 (defun org-speed-command-default-hook (keys)
17869 "Hook for activating single-letter speed commands.
17870 `org-speed-commands-default' specifies a minimal command set.
17871 Use `org-speed-commands-user' for further customization."
17872 (when (or (and (bolp) (looking-at org-outline-regexp))
17873 (and (functionp org-use-speed-commands)
17874 (funcall org-use-speed-commands)))
17875 (cdr (assoc keys (append org-speed-commands-user
17876 org-speed-commands-default)))))
17878 (defun org-babel-speed-command-hook (keys)
17879 "Hook for activating single-letter code block commands."
17880 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17881 (cdr (assoc keys org-babel-key-bindings))))
17883 (defcustom org-speed-command-hook
17884 '(org-speed-command-default-hook org-babel-speed-command-hook)
17885 "Hook for activating speed commands at strategic locations.
17886 Hook functions are called in sequence until a valid handler is
17887 found.
17889 Each hook takes a single argument, a user-pressed command key
17890 which is also a `self-insert-command' from the global map.
17892 Within the hook, examine the cursor position and the command key
17893 and return nil or a valid handler as appropriate. Handler could
17894 be one of an interactive command, a function, or a form.
17896 Set `org-use-speed-commands' to non-nil value to enable this
17897 hook. The default setting is `org-speed-command-default-hook'."
17898 :group 'org-structure
17899 :version "24.1"
17900 :type 'hook)
17902 (defun org-self-insert-command (N)
17903 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17904 If the cursor is in a table looking at whitespace, the whitespace is
17905 overwritten, and the table is not marked as requiring realignment."
17906 (interactive "p")
17907 (org-check-before-invisible-edit 'insert)
17908 (cond
17909 ((and org-use-speed-commands
17910 (setq org-speed-command
17911 (run-hook-with-args-until-success
17912 'org-speed-command-hook (this-command-keys))))
17913 (cond
17914 ((commandp org-speed-command)
17915 (setq this-command org-speed-command)
17916 (call-interactively org-speed-command))
17917 ((functionp org-speed-command)
17918 (funcall org-speed-command))
17919 ((and org-speed-command (listp org-speed-command))
17920 (eval org-speed-command))
17921 (t (let (org-use-speed-commands)
17922 (call-interactively 'org-self-insert-command)))))
17923 ((and
17924 (org-table-p)
17925 (progn
17926 ;; check if we blank the field, and if that triggers align
17927 (and (featurep 'org-table) org-table-auto-blank-field
17928 (member last-command
17929 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17931 ;; got extra space, this field does not determine column width
17932 (let (org-table-may-need-update) (org-table-blank-field))
17933 ;; no extra space, this field may determine column width
17934 (org-table-blank-field)))
17935 t)
17936 (eq N 1)
17938 (let (org-table-may-need-update)
17939 (goto-char (1- (match-end 0)))
17940 (backward-delete-char 1)
17941 (goto-char (match-beginning 0))
17942 (self-insert-command N)))
17943 (t
17944 (setq org-table-may-need-update t)
17945 (self-insert-command N)
17946 (org-fix-tags-on-the-fly)
17947 (if org-self-insert-cluster-for-undo
17948 (if (not (eq last-command 'org-self-insert-command))
17949 (setq org-self-insert-command-undo-counter 1)
17950 (if (>= org-self-insert-command-undo-counter 20)
17951 (setq org-self-insert-command-undo-counter 1)
17952 (and (> org-self-insert-command-undo-counter 0)
17953 buffer-undo-list (listp buffer-undo-list)
17954 (not (cadr buffer-undo-list)) ; remove nil entry
17955 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17956 (setq org-self-insert-command-undo-counter
17957 (1+ org-self-insert-command-undo-counter))))))))
17959 (defun org-check-before-invisible-edit (kind)
17960 "Check is editing if kind KIND would be dangerous with invisible text around.
17961 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17962 ;; First, try to get out of here as quickly as possible, to reduce overhead
17963 (if (and org-catch-invisible-edits
17964 (or (not (boundp 'visible-mode)) (not visible-mode))
17965 (or (get-char-property (point) 'invisible)
17966 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17967 ;; OK, we need to take a closer look
17968 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17969 (invisible-before-point (if (bobp) nil (get-char-property
17970 (1- (point)) 'invisible)))
17971 (border-and-ok-direction
17972 (or
17973 ;; Check if we are acting predictably before invisible text
17974 (and invisible-at-point (not invisible-before-point)
17975 (memq kind '(insert delete-backward)))
17976 ;; Check if we are acting predictably after invisible text
17977 ;; This works not well, and I have turned it off. It seems
17978 ;; better to always show and stop after invisible text.
17979 ;; (and (not invisible-at-point) invisible-before-point
17980 ;; (memq kind '(insert delete)))
17981 )))
17983 (when (or (memq invisible-at-point '(outline org-hide-block))
17984 (memq invisible-before-point '(outline org-hide-block)))
17985 (if (eq org-catch-invisible-edits 'error)
17986 (error "Editing in invisible areas is prohibited - make visible first"))
17987 ;; Make the area visible
17988 (save-excursion
17989 (if invisible-before-point
17990 (goto-char (previous-single-char-property-change
17991 (point) 'invisible)))
17992 (org-cycle))
17993 (cond
17994 ((eq org-catch-invisible-edits 'show)
17995 ;; That's it, we do the edit after showing
17996 (message
17997 "Unfolding invisible region around point before editing")
17998 (sit-for 1))
17999 ((and (eq org-catch-invisible-edits 'smart)
18000 border-and-ok-direction)
18001 (message "Unfolding invisible region around point before editing"))
18002 (t
18003 ;; Don't do the edit, make the user repeat it in full visibility
18004 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
18006 (defun org-fix-tags-on-the-fly ()
18007 (when (and (equal (char-after (point-at-bol)) ?*)
18008 (org-at-heading-p))
18009 (org-align-tags-here org-tags-column)))
18011 (defun org-delete-backward-char (N)
18012 "Like `delete-backward-char', insert whitespace at field end in tables.
18013 When deleting backwards, in tables this function will insert whitespace in
18015 still be marked for re-alignment if the field did fill the entire column,
18016 because, in this case the deletion might narrow the column."
18017 (interactive "p")
18018 (org-check-before-invisible-edit 'delete-backward)
18019 (if (and (org-table-p)
18020 (eq N 1)
18021 (string-match "|" (buffer-substring (point-at-bol) (point)))
18022 (looking-at ".*?|"))
18023 (let ((pos (point))
18025 (c org-table-may-need-update))
18026 (backward-delete-char N)
18027 (if (not overwrite-mode)
18028 (progn
18029 (skip-chars-forward "^|")
18030 (insert " ")
18031 (goto-char (1- pos))))
18032 ;; noalign: if there were two spaces at the end, this field
18033 ;; does not determine the width of the column.
18034 (if noalign (setq org-table-may-need-update c)))
18035 (backward-delete-char N)
18036 (org-fix-tags-on-the-fly)))
18038 (defun org-delete-char (N)
18039 "Like `delete-char', but insert whitespace at field end in tables.
18040 When deleting characters, in tables this function will insert whitespace in
18042 still be marked for re-alignment if the field did fill the entire column,
18043 because, in this case the deletion might narrow the column."
18044 (interactive "p")
18045 (org-check-before-invisible-edit 'delete)
18046 (if (and (org-table-p)
18047 (not (bolp))
18048 (not (= (char-after) ?|))
18049 (eq N 1))
18050 (if (looking-at ".*?|")
18051 (let ((pos (point))
18053 (c org-table-may-need-update))
18054 (replace-match (concat
18055 (substring (match-string 0) 1 -1)
18056 " |"))
18057 (goto-char pos)
18058 ;; noalign: if there were two spaces at the end, this field
18059 ;; does not determine the width of the column.
18060 (if noalign (setq org-table-may-need-update c)))
18061 (delete-char N))
18062 (delete-char N)
18063 (org-fix-tags-on-the-fly)))
18065 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
18066 (put 'org-self-insert-command 'delete-selection t)
18067 (put 'orgtbl-self-insert-command 'delete-selection t)
18068 (put 'org-delete-char 'delete-selection 'supersede)
18069 (put 'org-delete-backward-char 'delete-selection 'supersede)
18070 (put 'org-yank 'delete-selection 'yank)
18072 ;; Make `flyspell-mode' delay after some commands
18073 (put 'org-self-insert-command 'flyspell-delayed t)
18074 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
18075 (put 'org-delete-char 'flyspell-delayed t)
18076 (put 'org-delete-backward-char 'flyspell-delayed t)
18078 ;; Make pabbrev-mode expand after org-mode commands
18079 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
18080 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
18082 ;; How to do this: Measure non-white length of current string
18083 ;; If equal to column width, we should realign.
18085 (defun org-remap (map &rest commands)
18086 "In MAP, remap the functions given in COMMANDS.
18087 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
18088 (let (new old)
18089 (while commands
18090 (setq old (pop commands) new (pop commands))
18091 (if (fboundp 'command-remapping)
18092 (org-defkey map (vector 'remap old) new)
18093 (substitute-key-definition old new map global-map)))))
18095 (when (eq org-enable-table-editor 'optimized)
18096 ;; If the user wants maximum table support, we need to hijack
18097 ;; some standard editing functions
18098 (org-remap org-mode-map
18099 'self-insert-command 'org-self-insert-command
18100 'delete-char 'org-delete-char
18101 'delete-backward-char 'org-delete-backward-char)
18102 (org-defkey org-mode-map "|" 'org-force-self-insert))
18104 (defvar org-ctrl-c-ctrl-c-hook nil
18105 "Hook for functions attaching themselves to `C-c C-c'.
18107 This can be used to add additional functionality to the C-c C-c
18108 key which executes context-dependent commands. This hook is run
18109 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
18110 run after the last test.
18112 Each function will be called with no arguments. The function
18113 must check if the context is appropriate for it to act. If yes,
18114 it should do its thing and then return a non-nil value. If the
18115 context is wrong, just do nothing and return nil.")
18117 (defvar org-ctrl-c-ctrl-c-final-hook nil
18118 "Hook for functions attaching themselves to `C-c C-c'.
18120 This can be used to add additional functionality to the C-c C-c
18121 key which executes context-dependent commands. This hook is run
18122 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
18123 before the first test.
18125 Each function will be called with no arguments. The function
18126 must check if the context is appropriate for it to act. If yes,
18127 it should do its thing and then return a non-nil value. If the
18128 context is wrong, just do nothing and return nil.")
18130 (defvar org-tab-first-hook nil
18131 "Hook for functions to attach themselves to TAB.
18132 See `org-ctrl-c-ctrl-c-hook' for more information.
18133 This hook runs as the first action when TAB is pressed, even before
18134 `org-cycle' messes around with the `outline-regexp' to cater for
18135 inline tasks and plain list item folding.
18136 If any function in this hook returns t, any other actions that
18137 would have been caused by TAB (such as table field motion or visibility
18138 cycling) will not occur.")
18140 (defvar org-tab-after-check-for-table-hook nil
18141 "Hook for functions to attach themselves to TAB.
18142 See `org-ctrl-c-ctrl-c-hook' for more information.
18143 This hook runs after it has been established that the cursor is not in a
18144 table, but before checking if the cursor is in a headline or if global cycling
18145 should be done.
18146 If any function in this hook returns t, not other actions like visibility
18147 cycling will be done.")
18149 (defvar org-tab-after-check-for-cycling-hook nil
18150 "Hook for functions to attach themselves to TAB.
18151 See `org-ctrl-c-ctrl-c-hook' for more information.
18152 This hook runs after it has been established that not table field motion and
18153 not visibility should be done because of current context. This is probably
18154 the place where a package like yasnippets can hook in.")
18156 (defvar org-tab-before-tab-emulation-hook nil
18157 "Hook for functions to attach themselves to TAB.
18158 See `org-ctrl-c-ctrl-c-hook' for more information.
18159 This hook runs after every other options for TAB have been exhausted, but
18162 (defvar org-metaleft-hook nil
18163 "Hook for functions attaching themselves to `M-left'.
18164 See `org-ctrl-c-ctrl-c-hook' for more information.")
18165 (defvar org-metaright-hook nil
18166 "Hook for functions attaching themselves to `M-right'.
18167 See `org-ctrl-c-ctrl-c-hook' for more information.")
18168 (defvar org-metaup-hook nil
18169 "Hook for functions attaching themselves to `M-up'.
18170 See `org-ctrl-c-ctrl-c-hook' for more information.")
18171 (defvar org-metadown-hook nil
18172 "Hook for functions attaching themselves to `M-down'.
18173 See `org-ctrl-c-ctrl-c-hook' for more information.")
18174 (defvar org-shiftmetaleft-hook nil
18175 "Hook for functions attaching themselves to `M-S-left'.
18176 See `org-ctrl-c-ctrl-c-hook' for more information.")
18177 (defvar org-shiftmetaright-hook nil
18178 "Hook for functions attaching themselves to `M-S-right'.
18179 See `org-ctrl-c-ctrl-c-hook' for more information.")
18180 (defvar org-shiftmetaup-hook nil
18181 "Hook for functions attaching themselves to `M-S-up'.
18182 See `org-ctrl-c-ctrl-c-hook' for more information.")
18183 (defvar org-shiftmetadown-hook nil
18184 "Hook for functions attaching themselves to `M-S-down'.
18185 See `org-ctrl-c-ctrl-c-hook' for more information.")
18186 (defvar org-metareturn-hook nil
18187 "Hook for functions attaching themselves to `M-RET'.
18188 See `org-ctrl-c-ctrl-c-hook' for more information.")
18189 (defvar org-shiftup-hook nil
18190 "Hook for functions attaching themselves to `S-up'.
18191 See `org-ctrl-c-ctrl-c-hook' for more information.")
18192 (defvar org-shiftup-final-hook nil
18193 "Hook for functions attaching themselves to `S-up'.
18194 This one runs after all other options except shift-select have been excluded.
18195 See `org-ctrl-c-ctrl-c-hook' for more information.")
18196 (defvar org-shiftdown-hook nil
18197 "Hook for functions attaching themselves to `S-down'.
18198 See `org-ctrl-c-ctrl-c-hook' for more information.")
18199 (defvar org-shiftdown-final-hook nil
18200 "Hook for functions attaching themselves to `S-down'.
18201 This one runs after all other options except shift-select have been excluded.
18202 See `org-ctrl-c-ctrl-c-hook' for more information.")
18203 (defvar org-shiftleft-hook nil
18204 "Hook for functions attaching themselves to `S-left'.
18205 See `org-ctrl-c-ctrl-c-hook' for more information.")
18206 (defvar org-shiftleft-final-hook nil
18207 "Hook for functions attaching themselves to `S-left'.
18208 This one runs after all other options except shift-select have been excluded.
18209 See `org-ctrl-c-ctrl-c-hook' for more information.")
18210 (defvar org-shiftright-hook nil
18211 "Hook for functions attaching themselves to `S-right'.
18212 See `org-ctrl-c-ctrl-c-hook' for more information.")
18213 (defvar org-shiftright-final-hook nil
18214 "Hook for functions attaching themselves to `S-right'.
18215 This one runs after all other options except shift-select have been excluded.
18216 See `org-ctrl-c-ctrl-c-hook' for more information.")
18218 (defun org-modifier-cursor-error ()
18219 "Throw an error, a modified cursor command was applied in wrong context."
18220 (error "This command is active in special context like tables, headlines or items"))
18222 (defun org-shiftselect-error ()
18223 "Throw an error because Shift-Cursor command was applied in wrong context."
18224 (if (and (boundp 'shift-select-mode) shift-select-mode)
18225 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
18226 (error "This command works only in special context like headlines or timestamps")))
18228 (defun org-call-for-shift-select (cmd)
18229 (let ((this-command-keys-shift-translated t))
18230 (call-interactively cmd)))
18232 (defun org-shifttab (&optional arg)
18233 "Global visibility cycling or move to previous table field.
18234 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
18235 on context.
18236 See the individual commands for more information."
18237 (interactive "P")
18238 (cond
18239 ((org-at-table-p) (call-interactively 'org-table-previous-field))
18240 ((integerp arg)
18241 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18242 (message "Content view to level: %d" arg)
18243 (org-content (prefix-numeric-value arg2))
18244 (setq org-cycle-global-status 'overview)))
18245 (t (call-interactively 'org-global-cycle))))
18247 (defun org-shiftmetaleft ()
18248 "Promote subtree or delete table column.
18249 Calls `org-promote-subtree', `org-outdent-item-tree', or
18250 `org-table-delete-column', depending on context. See the
18251 individual commands for more information."
18252 (interactive)
18253 (cond
18254 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18255 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18256 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18257 ((if (not (org-region-active-p)) (org-at-item-p)
18258 (save-excursion (goto-char (region-beginning))
18259 (org-at-item-p)))
18260 (call-interactively 'org-outdent-item-tree))
18261 (t (org-modifier-cursor-error))))
18263 (defun org-shiftmetaright ()
18264 "Demote subtree or insert table column.
18265 Calls `org-demote-subtree', `org-indent-item-tree', or
18266 `org-table-insert-column', depending on context. See the
18267 individual commands for more information."
18268 (interactive)
18269 (cond
18270 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18271 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18272 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18273 ((if (not (org-region-active-p)) (org-at-item-p)
18274 (save-excursion (goto-char (region-beginning))
18275 (org-at-item-p)))
18276 (call-interactively 'org-indent-item-tree))
18277 (t (org-modifier-cursor-error))))
18279 (defun org-shiftmetaup (&optional arg)
18280 "Move subtree up or kill table row.
18281 Calls `org-move-subtree-up' or `org-table-kill-row' or
18282 `org-move-item-up' depending on context. See the individual commands
18283 for more information."
18284 (interactive "P")
18285 (cond
18286 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18287 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18288 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18289 ((org-at-item-p) (call-interactively 'org-move-item-up))
18290 (t (org-modifier-cursor-error))))
18292 (defun org-shiftmetadown (&optional arg)
18293 "Move subtree down or insert table row.
18294 Calls `org-move-subtree-down' or `org-table-insert-row' or
18295 `org-move-item-down', depending on context. See the individual
18296 commands for more information."
18297 (interactive "P")
18298 (cond
18299 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18300 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18301 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18302 ((org-at-item-p) (call-interactively 'org-move-item-down))
18303 (t (org-modifier-cursor-error))))
18305 (defsubst org-hidden-tree-error ()
18306 (error
18307 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18309 (defun org-metaleft (&optional arg)
18310 "Promote heading or move table column to left.
18311 Calls `org-do-promote' or `org-table-move-column', depending on context.
18312 With no specific context, calls the Emacs default `backward-word'.
18313 See the individual commands for more information."
18314 (interactive "P")
18315 (cond
18316 ((run-hook-with-args-until-success 'org-metaleft-hook))
18317 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18318 ((org-with-limited-levels
18319 (or (org-at-heading-p)
18320 (and (org-region-active-p)
18321 (save-excursion
18322 (goto-char (region-beginning))
18323 (org-at-heading-p)))))
18324 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18325 (call-interactively 'org-do-promote))
18326 ;; At an inline task.
18327 ((org-at-heading-p)
18328 (call-interactively 'org-inlinetask-promote))
18329 ((or (org-at-item-p)
18330 (and (org-region-active-p)
18331 (save-excursion
18332 (goto-char (region-beginning))
18333 (org-at-item-p))))
18334 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18335 (call-interactively 'org-outdent-item))
18336 (t (call-interactively 'backward-word))))
18338 (defun org-metaright (&optional arg)
18339 "Demote a subtree, a list item or move table column to right.
18340 In front of a drawer or a block keyword, indent it correctly.
18341 With no specific context, calls the Emacs default `forward-word'.
18342 See the individual commands for more information."
18343 (interactive "P")
18344 (cond
18345 ((run-hook-with-args-until-success 'org-metaright-hook))
18346 ((org-at-table-p) (call-interactively 'org-table-move-column))
18347 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18348 ((org-at-block-p) (call-interactively 'org-indent-block))
18349 ((org-with-limited-levels
18350 (or (org-at-heading-p)
18351 (and (org-region-active-p)
18352 (save-excursion
18353 (goto-char (region-beginning))
18354 (org-at-heading-p)))))
18355 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18356 (call-interactively 'org-do-demote))
18357 ;; At an inline task.
18358 ((org-at-heading-p)
18359 (call-interactively 'org-inlinetask-demote))
18360 ((or (org-at-item-p)
18361 (and (org-region-active-p)
18362 (save-excursion
18363 (goto-char (region-beginning))
18364 (org-at-item-p))))
18365 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18366 (call-interactively 'org-indent-item))
18367 (t (call-interactively 'forward-word))))
18369 (defun org-check-for-hidden (what)
18370 "Check if there are hidden headlines/items in the current visual line.
18371 WHAT can be either `headlines' or `items'. If the current line is
18372 an outline or item heading and it has a folded subtree below it,
18373 this function returns t, nil otherwise."
18374 (let ((re (cond
18375 ((eq what 'headlines) org-outline-regexp-bol)
18376 ((eq what 'items) (org-item-beginning-re))
18377 (t (error "This should not happen"))))
18378 beg end)
18379 (save-excursion
18380 (catch 'exit
18381 (unless (org-region-active-p)
18382 (setq beg (point-at-bol))
18383 (beginning-of-line 2)
18384 (while (and (not (eobp)) ;; this is like `next-line'
18385 (get-char-property (1- (point)) 'invisible))
18386 (beginning-of-line 2))
18387 (setq end (point))
18388 (goto-char beg)
18389 (goto-char (point-at-eol))
18390 (setq end (max end (point)))
18391 (while (re-search-forward re end t)
18392 (if (get-char-property (match-beginning 0) 'invisible)
18393 (throw 'exit t))))
18394 nil))))
18396 (defun org-metaup (&optional arg)
18397 "Move subtree up or move table row up.
18398 Calls `org-move-subtree-up' or `org-table-move-row' or
18399 `org-move-item-up', depending on context. See the individual commands
18400 for more information."
18401 (interactive "P")
18402 (cond
18403 ((run-hook-with-args-until-success 'org-metaup-hook))
18404 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18405 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18406 ((org-at-item-p) (call-interactively 'org-move-item-up))
18407 (t (transpose-lines 1) (beginning-of-line -1))))
18409 (defun org-metadown (&optional arg)
18410 "Move subtree down or move table row down.
18411 Calls `org-move-subtree-down' or `org-table-move-row' or
18412 `org-move-item-down', depending on context. See the individual
18413 commands for more information."
18414 (interactive "P")
18415 (cond
18416 ((run-hook-with-args-until-success 'org-metadown-hook))
18417 ((org-at-table-p) (call-interactively 'org-table-move-row))
18418 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18419 ((org-at-item-p) (call-interactively 'org-move-item-down))
18420 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18422 (defun org-shiftup (&optional arg)
18423 "Increase item in timestamp or increase priority of current headline.
18424 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18425 depending on context. See the individual commands for more information."
18426 (interactive "P")
18427 (cond
18428 ((run-hook-with-args-until-success 'org-shiftup-hook))
18429 ((and org-support-shift-select (org-region-active-p))
18430 (org-call-for-shift-select 'previous-line))
18431 ((org-at-timestamp-p t)
18432 (call-interactively (if org-edit-timestamp-down-means-later
18433 'org-timestamp-down 'org-timestamp-up)))
18434 ((and (not (eq org-support-shift-select 'always))
18435 org-enable-priority-commands
18436 (org-at-heading-p))
18437 (call-interactively 'org-priority-up))
18438 ((and (not org-support-shift-select) (org-at-item-p))
18439 (call-interactively 'org-previous-item))
18440 ((org-clocktable-try-shift 'up arg))
18441 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18442 (org-support-shift-select
18443 (org-call-for-shift-select 'previous-line))
18444 (t (org-shiftselect-error))))
18446 (defun org-shiftdown (&optional arg)
18447 "Decrease item in timestamp or decrease priority of current headline.
18448 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18449 depending on context. See the individual commands for more information."
18450 (interactive "P")
18451 (cond
18452 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18453 ((and org-support-shift-select (org-region-active-p))
18454 (org-call-for-shift-select 'next-line))
18455 ((org-at-timestamp-p t)
18456 (call-interactively (if org-edit-timestamp-down-means-later
18457 'org-timestamp-up 'org-timestamp-down)))
18458 ((and (not (eq org-support-shift-select 'always))
18459 org-enable-priority-commands
18460 (org-at-heading-p))
18461 (call-interactively 'org-priority-down))
18462 ((and (not org-support-shift-select) (org-at-item-p))
18463 (call-interactively 'org-next-item))
18464 ((org-clocktable-try-shift 'down arg))
18465 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18466 (org-support-shift-select
18467 (org-call-for-shift-select 'next-line))
18468 (t (org-shiftselect-error))))
18470 (defun org-shiftright (&optional arg)
18471 "Cycle the thing at point or in the current line, depending on context.
18472 Depending on context, this does one of the following:
18474 - switch a timestamp at point one day into the future
18475 - on a headline, switch to the next TODO keyword.
18476 - on an item, switch entire list to the next bullet type
18477 - on a property line, switch to the next allowed value
18478 - on a clocktable definition line, move time block into the future"
18479 (interactive "P")
18480 (cond
18481 ((run-hook-with-args-until-success 'org-shiftright-hook))
18482 ((and org-support-shift-select (org-region-active-p))
18483 (org-call-for-shift-select 'forward-char))
18484 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18485 ((and (not (eq org-support-shift-select 'always))
18486 (org-at-heading-p))
18487 (let ((org-inhibit-logging
18488 (not org-treat-S-cursor-todo-selection-as-state-change))
18489 (org-inhibit-blocking
18490 (not org-treat-S-cursor-todo-selection-as-state-change)))
18491 (org-call-with-arg 'org-todo 'right)))
18492 ((or (and org-support-shift-select
18493 (not (eq org-support-shift-select 'always))
18494 (org-at-item-bullet-p))
18495 (and (not org-support-shift-select) (org-at-item-p)))
18496 (org-call-with-arg 'org-cycle-list-bullet nil))
18497 ((and (not (eq org-support-shift-select 'always))
18498 (org-at-property-p))
18499 (call-interactively 'org-property-next-allowed-value))
18500 ((org-clocktable-try-shift 'right arg))
18501 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18502 (org-support-shift-select
18503 (org-call-for-shift-select 'forward-char))
18504 (t (org-shiftselect-error))))
18506 (defun org-shiftleft (&optional arg)
18507 "Cycle the thing at point or in the current line, depending on context.
18508 Depending on context, this does one of the following:
18510 - switch a timestamp at point one day into the past
18511 - on a headline, switch to the previous TODO keyword.
18512 - on an item, switch entire list to the previous bullet type
18513 - on a property line, switch to the previous allowed value
18514 - on a clocktable definition line, move time block into the past"
18515 (interactive "P")
18516 (cond
18517 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18518 ((and org-support-shift-select (org-region-active-p))
18519 (org-call-for-shift-select 'backward-char))
18520 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18521 ((and (not (eq org-support-shift-select 'always))
18522 (org-at-heading-p))
18523 (let ((org-inhibit-logging
18524 (not org-treat-S-cursor-todo-selection-as-state-change))
18525 (org-inhibit-blocking
18526 (not org-treat-S-cursor-todo-selection-as-state-change)))
18527 (org-call-with-arg 'org-todo 'left)))
18528 ((or (and org-support-shift-select
18529 (not (eq org-support-shift-select 'always))
18530 (org-at-item-bullet-p))
18531 (and (not org-support-shift-select) (org-at-item-p)))
18532 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18533 ((and (not (eq org-support-shift-select 'always))
18534 (org-at-property-p))
18535 (call-interactively 'org-property-previous-allowed-value))
18536 ((org-clocktable-try-shift 'left arg))
18537 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18538 (org-support-shift-select
18539 (org-call-for-shift-select 'backward-char))
18540 (t (org-shiftselect-error))))
18542 (defun org-shiftcontrolright ()
18543 "Switch to next TODO set."
18544 (interactive)
18545 (cond
18546 ((and org-support-shift-select (org-region-active-p))
18547 (org-call-for-shift-select 'forward-word))
18548 ((and (not (eq org-support-shift-select 'always))
18549 (org-at-heading-p))
18550 (org-call-with-arg 'org-todo 'nextset))
18551 (org-support-shift-select
18552 (org-call-for-shift-select 'forward-word))
18553 (t (org-shiftselect-error))))
18555 (defun org-shiftcontrolleft ()
18556 "Switch to previous TODO set."
18557 (interactive)
18558 (cond
18559 ((and org-support-shift-select (org-region-active-p))
18560 (org-call-for-shift-select 'backward-word))
18561 ((and (not (eq org-support-shift-select 'always))
18562 (org-at-heading-p))
18563 (org-call-with-arg 'org-todo 'previousset))
18564 (org-support-shift-select
18565 (org-call-for-shift-select 'backward-word))
18566 (t (org-shiftselect-error))))
18568 (defun org-shiftcontrolup ()
18569 "Change timestamps synchronously up in CLOCK log lines."
18570 (interactive)
18571 (cond ((and (not org-support-shift-select)
18572 (org-at-clock-log-p)
18573 (org-at-timestamp-p t))
18574 (org-clock-timestamps-up))
18575 (t (org-shiftselect-error))))
18577 (defun org-shiftcontroldown ()
18578 "Change timestamps synchronously down in CLOCK log lines."
18579 (interactive)
18580 (cond ((and (not org-support-shift-select)
18581 (org-at-clock-log-p)
18582 (org-at-timestamp-p t))
18583 (org-clock-timestamps-down))
18584 (t (org-shiftselect-error))))
18586 (defun org-ctrl-c-ret ()
18587 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18588 (interactive)
18589 (cond
18590 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18591 (t (call-interactively 'org-insert-heading))))
18593 (defun org-find-visible ()
18594 (let ((s (point)))
18595 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18596 (get-char-property s 'invisible)))
18597 s))
18598 (defun org-find-invisible ()
18599 (let ((s (point)))
18600 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18601 (not (get-char-property s 'invisible))))
18602 s))
18604 (defun org-copy-visible (beg end)
18605 "Copy the visible parts of the region."
18606 (interactive "r")
18607 (let (snippets s)
18608 (save-excursion
18609 (save-restriction
18610 (narrow-to-region beg end)
18611 (setq s (goto-char (point-min)))
18612 (while (not (= (point) (point-max)))
18613 (goto-char (org-find-invisible))
18614 (push (buffer-substring s (point)) snippets)
18615 (setq s (goto-char (org-find-visible))))))
18616 (kill-new (apply 'concat (nreverse snippets)))))
18618 (defun org-copy-special ()
18619 "Copy region in table or copy current subtree.
18620 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18621 See the individual commands for more information."
18622 (interactive)
18623 (call-interactively
18624 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18626 (defun org-cut-special ()
18627 "Cut region in table or cut current subtree.
18628 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18629 See the individual commands for more information."
18630 (interactive)
18631 (call-interactively
18632 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18634 (defun org-paste-special (arg)
18635 "Paste rectangular region into table, or past subtree relative to level.
18636 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18637 See the individual commands for more information."
18638 (interactive "P")
18639 (if (org-at-table-p)
18640 (org-table-paste-rectangle)
18641 (org-paste-subtree arg)))
18643 (defun org-edit-special (&optional arg)
18644 "Call a special editor for the stuff at point.
18645 When at a table, call the formula editor with `org-table-edit-formulas'.
18646 When at the first line of an src example, call `org-edit-src-code'.
18647 When in an #+include line, visit the include file. Otherwise call
18648 `ffap' to visit the file at point."
18649 (interactive)
18650 ;; possibly prep session before editing source
18651 (when arg
18652 (let* ((info (org-babel-get-src-block-info))
18653 (lang (nth 0 info))
18654 (params (nth 2 info))
18655 (session (cdr (assoc :session params))))
18656 (when (and info session) ;; we are in a source-code block with a session
18657 (funcall
18658 (intern (concat "org-babel-prep-session:" lang)) session params))))
18659 (cond ;; proceed with `org-edit-special'
18660 ((save-excursion
18661 (beginning-of-line 1)
18662 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18663 (find-file (org-trim (match-string 1))))
18664 ((org-edit-src-code))
18665 ((org-edit-fixed-width-region))
18666 ((org-at-table.el-p)
18667 (org-edit-src-code))
18668 ((or (org-at-table-p)
18669 (save-excursion
18670 (beginning-of-line 1)
18672 (call-interactively 'org-table-edit-formulas))
18673 (t (call-interactively 'ffap))))
18675 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18676 (defun org-ctrl-c-ctrl-c (&optional arg)
18677 "Set tags in headline, or update according to changed information at point.
18679 This command does many different things, depending on context:
18681 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18682 this is what we do.
18684 - If the cursor is on a statistics cookie, update it.
18686 - If the cursor is in a headline, prompt for tags and insert them
18687 into the current line, aligned to `org-tags-column'. When called
18688 with prefix arg, realign all tags in the current buffer.
18690 - If the cursor is in one of the special #+KEYWORD lines, this
18691 triggers scanning the buffer for these lines and updating the
18692 information.
18694 - If the cursor is inside a table, realign the table. This command
18695 works even if the automatic table editor has been turned off.
18697 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18698 the entire table.
18700 - If the cursor is at a footnote reference or definition, jump to
18701 the corresponding definition or references, respectively.
18703 - If the cursor is a the beginning of a dynamic block, update it.
18705 - If the current buffer is a capture buffer, close note and file it.
18707 - If the cursor is on a <<<target>>>, update radio targets and
18708 corresponding links in this buffer.
18710 - If the cursor is on a numbered item in a plain list, renumber the
18711 ordered list.
18713 - If the cursor is on a checkbox, toggle it.
18715 - If the cursor is on a code block, evaluate it. The variable
18716 `org-confirm-babel-evaluate' can be used to control prompting
18717 before code block evaluation, by default every code block
18718 evaluation requires confirmation. Code block evaluation can be
18719 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18720 (interactive "P")
18721 (let ((org-enable-table-editor t))
18722 (cond
18723 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18724 org-occur-highlights
18725 org-latex-fragment-image-overlays)
18726 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18727 (org-remove-occur-highlights)
18728 (org-remove-latex-fragment-image-overlays)
18729 (message "Temporary highlights/overlays removed from current buffer"))
18730 ((and (local-variable-p 'org-finish-function (current-buffer))
18731 (fboundp org-finish-function))
18732 (funcall org-finish-function))
18733 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18734 ((org-in-regexp org-ts-regexp-both)
18735 (org-timestamp-change 0 'day))
18736 ((or (looking-at org-property-start-re)
18737 (org-at-property-p))
18738 (call-interactively 'org-property-action))
18739 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18741 (or (org-at-heading-p) (org-at-item-p)))
18742 (call-interactively 'org-update-statistics-cookies))
18743 ((org-at-heading-p) (call-interactively 'org-set-tags))
18744 ((org-at-table.el-p)
18745 (message "Use C-c ' to edit table.el tables"))
18746 ((org-at-table-p)
18747 (org-table-maybe-eval-formula)
18748 (if arg
18749 (call-interactively 'org-table-recalculate)
18750 (org-table-maybe-recalculate-line))
18751 (call-interactively 'org-table-align)
18752 (orgtbl-send-table 'maybe))
18753 ((or (org-footnote-at-reference-p)
18754 (org-footnote-at-definition-p))
18755 (call-interactively 'org-footnote-action))
18756 ((org-at-item-checkbox-p)
18757 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18758 ;; list only if at top item.
18759 (let* ((cbox (match-string 1))
18760 (struct (org-list-struct))
18761 (old-struct (copy-tree struct))
18762 (parents (org-list-parents-alist struct))
18763 (orderedp (org-entry-get nil "ORDERED"))
18764 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18765 block-item)
18766 ;; Use a light version of `org-toggle-checkbox' to avoid
18767 ;; computing list structure twice.
18768 (let ((new-box (cond
18769 ((equal arg '(16)) "[-]")
18770 ((equal arg '(4)) nil)
18771 ((equal "[X]" cbox) "[ ]")
18772 (t "[X]"))))
18773 (if (and firstp arg)
18774 ;; If at first item of sub-list, remove check-box from
18775 ;; every item at the same level.
18776 (mapc
18777 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18778 (org-list-get-all-items
18779 (point-at-bol) struct (org-list-prevs-alist struct)))
18780 (org-list-set-checkbox (point-at-bol) struct new-box)))
18781 ;; Replicate `org-list-write-struct', while grabbing a return
18782 ;; value from `org-list-struct-fix-box'.
18783 (org-list-struct-fix-ind struct parents 2)
18784 (org-list-struct-fix-item-end struct)
18785 (let ((prevs (org-list-prevs-alist struct)))
18786 (org-list-struct-fix-bul struct prevs)
18787 (org-list-struct-fix-ind struct parents)
18788 (setq block-item
18789 (org-list-struct-fix-box struct parents prevs orderedp)))
18790 (org-list-struct-apply-struct struct old-struct)
18791 (org-update-checkbox-count-maybe)
18792 (when block-item
18793 (message
18794 "Checkboxes were removed due to unchecked box at line %d"
18795 (org-current-line block-item)))
18796 (when firstp (org-list-send-list 'maybe))))
18797 ((org-at-item-p)
18798 ;; Cursor at an item: repair list. Do checkbox related actions
18799 ;; only if function was called with an argument. Send list only
18800 ;; if at top item.
18801 (let* ((struct (org-list-struct))
18802 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18803 old-struct)
18804 (when arg
18805 (setq old-struct (copy-tree struct))
18806 (if firstp
18807 ;; If at first item of sub-list, add check-box to every
18808 ;; item at the same level.
18809 (mapc
18810 (lambda (pos)
18811 (unless (org-list-get-checkbox pos struct)
18812 (org-list-set-checkbox pos struct "[ ]")))
18813 (org-list-get-all-items
18814 (point-at-bol) struct (org-list-prevs-alist struct)))
18815 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18816 (org-list-write-struct
18817 struct (org-list-parents-alist struct) old-struct)
18818 (when arg (org-update-checkbox-count-maybe))
18819 (when firstp (org-list-send-list 'maybe))))
18820 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18821 ;; Dynamic block
18822 (beginning-of-line 1)
18823 (save-excursion (org-update-dblock)))
18824 ((save-excursion
18825 (let ((case-fold-search t))
18826 (beginning-of-line 1)
18828 (cond
18829 ((or (equal (match-string 1) "TBLFM")
18830 (equal (match-string 1) "tblfm"))
18831 ;; Recalculate the table before this line
18832 (save-excursion
18833 (beginning-of-line 1)
18835 (if (org-at-table-p)
18836 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18837 (t
18838 (let ((org-inhibit-startup-visibility-stuff t)
18839 (org-startup-align-all-tables nil))
18840 (when (boundp 'org-table-coordinate-overlays)
18841 (mapc 'delete-overlay org-table-coordinate-overlays)
18842 (setq org-table-coordinate-overlays nil))
18843 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18844 (message "Local setup has been refreshed"))))
18845 ((org-clock-update-time-maybe))
18846 (t
18847 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18848 (error "C-c C-c can do nothing useful at this location"))))))
18850 (defun org-mode-restart ()
18851 "Restart Org-mode, to scan again for special lines.
18852 Also updates the keyword regular expressions."
18853 (interactive)
18854 (org-mode)
18855 (message "Org-mode restarted"))
18857 (defun org-kill-note-or-show-branches ()
18858 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18859 (interactive)
18860 (if (not org-finish-function)
18861 (progn
18862 (hide-subtree)
18863 (call-interactively 'show-branches))
18864 (let ((org-note-abort t))
18865 (funcall org-finish-function))))
18867 (defun org-return (&optional indent)
18868 "Goto next table row or insert a newline.
18869 Calls `org-table-next-row' or `newline', depending on context.
18870 See the individual commands for more information."
18871 (interactive)
18872 (cond
18873 ((or (bobp) (org-in-src-block-p))
18874 (if indent (newline-and-indent) (newline)))
18875 ((org-at-table-p)
18876 (org-table-justify-field-maybe)
18877 (call-interactively 'org-table-next-row))
18878 ;; when `newline-and-indent' is called within a list, make sure
18879 ;; text moved stays inside the item.
18880 ((and (org-in-item-p) indent)
18881 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18882 (progn
18883 (save-match-data (newline))
18884 (org-indent-line-to (length (match-string 0))))
18885 (let ((ind (org-get-indentation)))
18886 (newline)
18887 (if (org-looking-back org-list-end-re)
18888 (org-indent-line-function)
18889 (org-indent-line-to ind)))))
18890 ((and org-return-follows-link
18891 (let ((tprop (get-text-property (point) 'face)))
18892 (or (eq tprop 'org-link)
18893 (and (listp tprop) (memq 'org-link tprop)))))
18894 (call-interactively 'org-open-at-point))
18895 ((and (org-at-heading-p)
18896 (looking-at
18898 (org-show-entry)
18899 (end-of-line 1)
18900 (newline))
18901 (t (if indent (newline-and-indent) (newline)))))
18903 (defun org-return-indent ()
18904 "Goto next table row or insert a newline and indent.
18905 Calls `org-table-next-row' or `newline-and-indent', depending on
18906 context. See the individual commands for more information."
18907 (interactive)
18908 (org-return t))
18910 (defun org-ctrl-c-star ()
18911 "Compute table, or change heading status of lines.
18912 Calls `org-table-recalculate' or `org-toggle-heading',
18913 depending on context."
18914 (interactive)
18915 (cond
18916 ((org-at-table-p)
18917 (call-interactively 'org-table-recalculate))
18918 (t
18919 ;; Convert all lines in region to list items
18920 (call-interactively 'org-toggle-heading))))
18922 (defun org-ctrl-c-minus ()
18923 "Insert separator line in table or modify bullet status of line.
18924 Also turns a plain line or a region of lines into list items.
18925 Calls `org-table-insert-hline', `org-toggle-item', or
18926 `org-cycle-list-bullet', depending on context."
18927 (interactive)
18928 (cond
18929 ((org-at-table-p)
18930 (call-interactively 'org-table-insert-hline))
18931 ((org-region-active-p)
18932 (call-interactively 'org-toggle-item))
18933 ((org-in-item-p)
18934 (call-interactively 'org-cycle-list-bullet))
18935 (t
18936 (call-interactively 'org-toggle-item))))
18938 (defun org-toggle-item (arg)
18939 "Convert headings or normal lines to items, items to normal lines.
18940 If there is no active region, only the current line is considered.
18942 If the first non blank line in the region is an headline, convert
18943 all headlines to items, shifting text accordingly.
18945 If it is an item, convert all items to normal lines.
18947 If it is normal text, change region into an item. With a prefix
18948 argument ARG, change each line in region into an item."
18949 (interactive "P")
18950 (let ((shift-text
18951 (function
18952 ;; Shift text in current section to IND, from point to END.
18953 ;; The function leaves point to END line.
18954 (lambda (ind end)
18955 (let ((min-i 1000) (end (copy-marker end)))
18956 ;; First determine the minimum indentation (MIN-I) of
18957 ;; the text.
18958 (save-excursion
18959 (catch 'exit
18960 (while (< (point) end)
18961 (let ((i (org-get-indentation)))
18962 (cond
18963 ;; Skip blank lines and inline tasks.
18965 ((looking-at org-outline-regexp-bol))
18966 ;; We can't find less than 0 indentation.
18967 ((zerop i) (throw 'exit (setq min-i 0)))
18968 ((< i min-i) (setq min-i i))))
18969 (forward-line))))
18970 ;; Then indent each line so that a line indented to
18971 ;; MIN-I becomes indented to IND. Ignore blank lines
18972 ;; and inline tasks in the process.
18973 (let ((delta (- ind min-i)))
18974 (while (< (point) end)
18976 (looking-at org-outline-regexp-bol))
18977 (org-indent-line-to (+ (org-get-indentation) delta)))
18978 (forward-line)))))))
18979 (skip-blanks
18980 (function
18981 ;; Return beginning of first non-blank line, starting from
18982 ;; line at POS.
18983 (lambda (pos)
18984 (save-excursion
18985 (goto-char pos)
18987 (point-at-bol)))))
18988 beg end)
18989 ;; Determine boundaries of changes.
18990 (if (org-region-active-p)
18991 (setq beg (funcall skip-blanks (region-beginning))
18992 end (copy-marker (region-end)))
18993 (setq beg (funcall skip-blanks (point-at-bol))
18994 end (copy-marker (point-at-eol))))
18995 ;; Depending on the starting line, choose an action on the text
18996 ;; between BEG and END.
18997 (org-with-limited-levels
18998 (save-excursion
18999 (goto-char beg)
19000 (cond
19001 ;; Case 1. Start at an item: de-itemize. Note that it only
19002 ;; happens when a region is active: `org-ctrl-c-minus'
19003 ;; would call `org-cycle-list-bullet' otherwise.
19004 ((org-at-item-p)
19005 (while (< (point) end)
19006 (when (org-at-item-p)
19008 (delete-region (point) (match-end 0)))
19009 (forward-line)))
19010 ;; Case 2. Start at an heading: convert to items.
19011 ((org-at-heading-p)
19012 (let* ((bul (org-list-bullet-string "-"))
19013 (bul-len (length bul))
19014 ;; Indentation of the first heading. It should be
19015 ;; relative to the indentation of its parent, if any.
19016 (start-ind (save-excursion
19017 (cond
19018 ((not org-adapt-indentation) 0)
19019 ((not (outline-previous-heading)) 0)
19020 (t (length (match-string 0))))))
19021 ;; Level of first heading. Further headings will be
19022 ;; compared to it to determine hierarchy in the list.
19023 (ref-level (org-reduced-level (org-outline-level))))
19024 (while (< (point) end)
19025 (let* ((level (org-reduced-level (org-outline-level)))
19026 (delta (max 0 (- level ref-level))))
19027 ;; If current headline is less indented than the first
19028 ;; one, set it as reference, in order to preserve
19029 ;; subtrees.
19030 (when (< level ref-level) (setq ref-level level))
19031 (replace-match bul t t)
19032 (org-indent-line-to (+ start-ind (* delta bul-len)))
19033 ;; Ensure all text down to END (or SECTION-END) belongs
19034 ;; to the newly created item.
19035 (let ((section-end (save-excursion
19036 (or (outline-next-heading) (point)))))
19037 (forward-line)
19038 (funcall shift-text
19039 (+ start-ind (* (1+ delta) bul-len))
19040 (min end section-end)))))))
19041 ;; Case 3. Normal line with ARG: turn each non-item line into
19042 ;; an item.
19043 (arg
19044 (while (< (point) end)
19045 (unless (or (org-at-heading-p) (org-at-item-p))
19047 (replace-match
19049 (forward-line)))
19050 ;; Case 4. Normal line without ARG: make the first line of
19051 ;; region an item, and shift indentation of others
19052 ;; lines to set them as item's body.
19053 (t (let* ((bul (org-list-bullet-string "-"))
19054 (bul-len (length bul))
19055 (ref-ind (org-get-indentation)))
19057 (insert bul)
19058 (forward-line)
19059 (while (< (point) end)
19060 ;; Ensure that lines less indented than first one
19061 ;; still get included in item body.
19062 (funcall shift-text
19063 (+ ref-ind bul-len)
19064 (min end (save-excursion (or (outline-next-heading)
19065 (point)))))
19066 (forward-line)))))))))
19068 (defun org-toggle-heading (&optional nstars)
19069 "Convert headings to normal text, or items or text to headings.
19070 If there is no active region, only the current line is considered.
19073 point into heading.
19075 In a region:
19077 - If the first non blank line is an headline, remove the stars
19078 from all headlines in the region.
19080 - If it is a normal line turn each and every normal line (i.e. not an
19081 heading or an item) in the region into a heading.
19083 - If it is a plain list item, turn all plain list items into headings.
19085 When converting a line into a heading, the number of stars is chosen
19086 such that the lines become children of the current entry. However,
19087 when a prefix argument is given, its value determines the number of
19088 stars to add."
19089 (interactive "P")
19090 (let ((skip-blanks
19091 (function
19092 ;; Return beginning of first non-blank line, starting from
19093 ;; line at POS.
19094 (lambda (pos)
19095 (save-excursion
19096 (goto-char pos)
19098 (point-at-bol)))))
19099 beg end)
19100 ;; Determine boundaries of changes. If a universal prefix has
19101 ;; been given, put the list in a region. If region ends at a bol,
19102 ;; do not consider the last line to be in the region.
19104 (when (and current-prefix-arg (org-at-item-p))
19105 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
19106 (org-mark-list))
19108 (if (org-region-active-p)
19109 (setq beg (funcall skip-blanks (region-beginning))
19110 end (copy-marker (save-excursion
19111 (goto-char (region-end))
19112 (if (bolp) (point) (point-at-eol)))))
19113 (setq beg (funcall skip-blanks (point-at-bol))
19114 end (copy-marker (point-at-eol))))
19115 ;; Ensure inline tasks don't count as headings.
19116 (org-with-limited-levels
19117 (save-excursion
19118 (goto-char beg)
19119 (cond
19120 ;; Case 1. Started at an heading: de-star headings.
19121 ((org-at-heading-p)
19122 (while (< (point) end)
19123 (when (org-at-heading-p t)
19124 (looking-at org-outline-regexp) (replace-match ""))
19125 (forward-line)))
19126 ;; Case 2. Started at an item: change items into headlines.
19127 ;; One star will be added by `org-list-to-subtree'.
19128 ((org-at-item-p)
19129 (let* ((stars (make-string
19130 (if nstars
19131 ;; subtract the star that will be added again by
19132 ;; `org-list-to-subtree'
19133 (1- (prefix-numeric-value current-prefix-arg))
19134 (or (org-current-level) 0))
19135 ?*))
19136 (add-stars
19137 (cond (nstars "") ; stars from prefix only
19138 ((equal stars "") "") ; before first heading
19139 (org-odd-levels-only "*") ; inside heading, odd
19140 (t "")))) ; inside heading, oddeven
19141 (while (< (point) end)
19142 (when (org-at-item-p)
19143 ;; Pay attention to cases when region ends before list.
19144 (let* ((struct (org-list-struct))
19145 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
19146 (save-restriction
19147 (narrow-to-region (point) list-end)
19148 (insert
19149 (org-list-to-subtree
19150 (org-list-parse-list t)
19151 '(:istart (concat stars add-stars (funcall get-stars depth))
19152 :icount (concat stars add-stars (funcall get-stars depth))))))))
19153 (forward-line))))
19154 ;; Case 3. Started at normal text: make every line an heading,
19155 ;; skipping headlines and items.
19156 (t (let* ((stars (make-string
19157 (if nstars
19158 (prefix-numeric-value current-prefix-arg)
19159 (or (org-current-level) 0))
19160 ?*))
19161 (add-stars
19162 (cond (nstars "") ; stars from prefix only
19163 ((equal stars "") "*") ; before first heading
19164 (org-odd-levels-only "**") ; inside heading, odd
19165 (t "*"))) ; inside heading, oddeven
19166 (rpl (concat stars add-stars " ")))
19167 (while (< (point) end)
19168 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
19170 (replace-match (concat rpl (match-string 2))))
19171 (forward-line)))))))))
19173 (defun org-meta-return (&optional arg)
19174 "Insert a new heading or wrap a region in a table.
19175 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
19176 See the individual commands for more information."
19177 (interactive "P")
19178 (cond
19179 ((run-hook-with-args-until-success 'org-metareturn-hook))
19180 ((or (org-at-drawer-p) (org-at-property-p))
19181 (newline-and-indent))
19182 ((org-at-table-p)
19183 (call-interactively 'org-table-wrap-region))
19184 (t (call-interactively 'org-insert-heading))))
19186 ;;; Menu entries
19188 ;; Define the Org-mode menus
19189 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
19190 '("Tbl"
19191 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
19192 ["Next Field" org-cycle (org-at-table-p)]
19193 ["Previous Field" org-shifttab (org-at-table-p)]
19194 ["Next Row" org-return (org-at-table-p)]
19195 "--"
19196 ["Blank Field" org-table-blank-field (org-at-table-p)]
19197 ["Edit Field" org-table-edit-field (org-at-table-p)]
19198 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
19199 "--"
19200 ("Column"
19201 ["Move Column Left" org-metaleft (org-at-table-p)]
19202 ["Move Column Right" org-metaright (org-at-table-p)]
19203 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
19204 ["Insert Column" org-shiftmetaright (org-at-table-p)])
19205 ("Row"
19206 ["Move Row Up" org-metaup (org-at-table-p)]
19207 ["Move Row Down" org-metadown (org-at-table-p)]
19208 ["Delete Row" org-shiftmetaup (org-at-table-p)]
19209 ["Insert Row" org-shiftmetadown (org-at-table-p)]
19210 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
19211 "--"
19212 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
19213 ("Rectangle"
19214 ["Copy Rectangle" org-copy-special (org-at-table-p)]
19215 ["Cut Rectangle" org-cut-special (org-at-table-p)]
19216 ["Paste Rectangle" org-paste-special (org-at-table-p)]
19217 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
19218 "--"
19219 ("Calculate"
19220 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
19221 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
19222 ["Edit Formulas" org-edit-special (org-at-table-p)]
19223 "--"
19224 ["Recalculate line" org-table-recalculate (org-at-table-p)]
19225 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
19226 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
19227 "--"
19228 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
19229 "--"
19230 ["Sum Column/Rectangle" org-table-sum
19231 (or (org-at-table-p) (org-region-active-p))]
19232 ["Which Column?" org-table-current-column (org-at-table-p)])
19233 ["Debug Formulas"
19234 org-table-toggle-formula-debugger
19235 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
19236 ["Show Col/Row Numbers"
19237 org-table-toggle-coordinate-overlays
19238 :style toggle
19239 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
19240 "--"
19241 ["Create" org-table-create (and (not (org-at-table-p))
19242 org-enable-table-editor)]
19243 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
19244 ["Import from File" org-table-import (not (org-at-table-p))]
19245 ["Export to File" org-table-export (org-at-table-p)]
19246 "--"
19247 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
19249 (easy-menu-define org-org-menu org-mode-map "Org menu"
19250 '("Org"
19251 ("Show/Hide"
19252 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
19253 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
19254 ["Sparse Tree..." org-sparse-tree t]
19255 ["Reveal Context" org-reveal t]
19256 ["Show All" show-all t]
19257 "--"
19258 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
19259 "--"
19260 ["New Heading" org-insert-heading t]
19261 ("Navigate Headings"
19262 ["Up" outline-up-heading t]
19263 ["Next" outline-next-visible-heading t]
19264 ["Previous" outline-previous-visible-heading t]
19265 ["Next Same Level" outline-forward-same-level t]
19266 ["Previous Same Level" outline-backward-same-level t]
19267 "--"
19268 ["Jump" org-goto t])
19269 ("Edit Structure"
19270 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
19271 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
19272 "--"
19273 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
19274 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
19275 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19276 "--"
19277 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19278 "--"
19279 ["Copy visible text" org-copy-visible t]
19280 "--"
19281 ["Promote Heading" org-metaleft (not (org-at-table-p))]
19282 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
19283 ["Demote Heading" org-metaright (not (org-at-table-p))]
19284 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
19285 "--"
19286 ["Sort Region/Children" org-sort (not (org-at-table-p))]
19287 "--"
19288 ["Convert to odd levels" org-convert-to-odd-levels t]
19289 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19290 ("Editing"
19291 ["Emphasis..." org-emphasize t]
19292 ["Edit Source Example" org-edit-special t]
19293 "--"
19294 ["Footnote new/jump" org-footnote-action t]
19295 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19296 ("Archive"
19297 ["Archive (default method)" org-archive-subtree-default t]
19298 "--"
19299 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
19300 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
19301 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
19302 )
19303 "--"
19304 ("Hyperlinks"
19305 ["Store Link (Global)" org-store-link t]
19306 ["Find existing link to here" org-occur-link-in-agenda-files t]
19307 ["Insert Link" org-insert-link t]
19308 ["Follow Link" org-open-at-point t]
19309 "--"
19310 ["Next link" org-next-link t]
19311 ["Previous link" org-previous-link t]
19312 "--"
19313 ["Descriptive Links"
19314 org-toggle-link-display
19315 :style radio
19316 :selected org-descriptive-links
19317 ]
19318 ["Literal Links"
19319 org-toggle-link-display
19320 :style radio
19321 :selected (not org-descriptive-links)])
19322 "--"
19323 ("TODO Lists"
19324 ["TODO/DONE/-" org-todo t]
19325 ("Select keyword"
19326 ["Next keyword" org-shiftright (org-at-heading-p)]
19327 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19328 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19329 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19330 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19331 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19332 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19333 "--"
19334 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19335 :selected org-enforce-todo-dependencies :style toggle :active t]
19336 "Settings for tree at point"
19337 ["Do Children sequentially" org-toggle-ordered-property :style radio
19338 :selected (org-entry-get nil "ORDERED")
19339 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19340 ["Do Children parallel" org-toggle-ordered-property :style radio
19341 :selected (not (org-entry-get nil "ORDERED"))
19342 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19343 "--"
19344 ["Set Priority" org-priority t]
19345 ["Priority Up" org-shiftup t]
19346 ["Priority Down" org-shiftdown t]
19347 "--"
19348 ["Get news from all feeds" org-feed-update-all t]
19349 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19350 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19351 ("TAGS and Properties"
19352 ["Set Tags" org-set-tags-command t]
19353 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19354 "--"
19355 ["Set property" org-set-property t]
19356 ["Column view of properties" org-columns t]
19357 ["Insert Column View DBlock" org-insert-columns-dblock t])
19358 ("Dates and Scheduling"
19359 ["Timestamp" org-time-stamp t]
19360 ["Timestamp (inactive)" org-time-stamp-inactive t]
19361 ("Change Date"
19362 ["1 Day Later" org-shiftright t]
19363 ["1 Day Earlier" org-shiftleft t]
19364 ["1 ... Later" org-shiftup t]
19365 ["1 ... Earlier" org-shiftdown t])
19366 ["Compute Time Range" org-evaluate-time-range t]
19367 ["Schedule Item" org-schedule t]
19368 ["Deadline" org-deadline t]
19369 "--"
19370 ["Custom time format" org-toggle-time-stamp-overlays
19371 :style radio :selected org-display-custom-times]
19372 "--"
19373 ["Goto Calendar" org-goto-calendar t]
19374 ["Date from Calendar" org-date-from-calendar t]
19375 "--"
19376 ["Start/Restart Timer" org-timer-start t]
19377 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19378 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19379 ["Insert Timer String" org-timer t]
19380 ["Insert Timer Item" org-timer-item t])
19381 ("Logging work"
19382 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19383 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19384 ["Clock out" org-clock-out t]
19385 ["Clock cancel" org-clock-cancel t]
19386 "--"
19387 ["Mark as default task" org-clock-mark-default-task t]
19388 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19389 ["Goto running clock" org-clock-goto t]
19390 "--"
19391 ["Display times" org-clock-display t]
19392 ["Create clock table" org-clock-report t]
19393 "--"
19394 ["Record DONE time"
19395 (progn (setq org-log-done (not org-log-done))
19396 (message "Switching to %s will %s record a timestamp"
19397 (car org-done-keywords)
19398 (if org-log-done "automatically" "not")))
19399 :style toggle :selected org-log-done])
19400 "--"
19401 ["Agenda Command..." org-agenda t]
19402 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19403 ("File List for Agenda")
19404 ("Special views current file"
19405 ["TODO Tree" org-show-todo-tree t]
19406 ["Check Deadlines" org-check-deadlines t]
19407 ["Timeline" org-timeline t]
19408 ["Tags/Property tree" org-match-sparse-tree t])
19409 "--"
19410 ["Export/Publish..." org-export t]
19411 ("LaTeX"
19412 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19413 :selected org-cdlatex-mode]
19414 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19415 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19416 ["Modify math symbol" org-cdlatex-math-modify
19417 (org-inside-LaTeX-fragment-p)]
19418 ["Insert citation" org-reftex-citation t]
19419 "--"
19420 ["Template for BEAMER" (progn (require 'org-beamer)
19421 (org-insert-beamer-options-template)) t])
19422 "--"
19423 ("MobileOrg"
19424 ["Push Files and Views" org-mobile-push t]
19425 ["Get Captured and Flagged" org-mobile-pull t]
19426 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19427 "--"
19428 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19429 "--"
19430 ("Documentation"
19431 ["Show Version" org-version t]
19432 ["Info Documentation" org-info t])
19433 ("Customize"
19434 ["Browse Org Group" org-customize t]
19435 "--"
19436 ["Expand This Menu" org-create-customize-menu
19437 (fboundp 'customize-menu-create)])
19438 ["Send bug report" org-submit-bug-report t]
19439 "--"
19440 ("Refresh/Reload"
19441 ["Refresh setup current buffer" org-mode-restart t]
19442 ["Reload Org (after update)" org-reload t]
19443 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19444 ))
19446 (defun org-info (&optional node)
19447 "Read documentation for Org-mode in the info system.
19448 With optional NODE, go directly to that node."
19449 (interactive)
19450 (info (format "(org)%s" (or node ""))))
19452 ;;;###autoload
19453 (defun org-submit-bug-report ()
19454 "Submit a bug report on Org-mode via mail.
19456 Don't hesitate to report any problems or inaccurate documentation.
19458 If you don't have setup sending mail from (X)Emacs, please copy the
19459 output buffer into your mail program, as it gives us important
19460 information about your Org-mode version and configuration."
19461 (interactive)
19462 (require 'reporter)
19463 (org-load-modules-maybe)
19464 (org-require-autoloaded-modules)
19465 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19466 (reporter-submit-bug-report
19467 "emacs-orgmode@gnu.org"
19468 (org-version)
19469 (let (list)
19470 (save-window-excursion
19471 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19472 (delete-other-windows)
19473 (erase-buffer)
19474 (insert "You are about to submit a bug report to the Org-mode mailing list.
19476 We would like to add your full Org-mode and Outline configuration to the
19477 bug report. This greatly simplifies the work of the maintainer and
19478 other experts on the mailing list.
19480 HOWEVER, some variables you have customized may contain private
19481 information. The names of customers, colleagues, or friends, might
19482 appear in the form of file names, tags, todo states, or search strings.
19483 If you answer yes to the prompt, you might want to check and remove
19484 such private information before sending the email.")
19485 (add-text-properties (point-min) (point-max) '(face org-warning))
19486 (when (yes-or-no-p "Include your Org-mode configuration ")
19487 (mapatoms
19488 (lambda (v)
19489 (and (boundp v)
19491 (or (and (symbol-value v)
19493 (and
19494 (get v 'custom-type) (get v 'standard-value)
19495 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19496 (push v list)))))
19497 (kill-buffer (get-buffer "*Warn about privacy*"))
19498 list))
19499 nil nil
19500 "Remember to cover the basics, that is, what you expected to happen and
19501 what in fact did happen. You don't know how to make a good report? See
19503 http://orgmode.org/manual/Feedback.html#Feedback
19505 Your bug report will be posted to the Org-mode mailing list.
19506 ------------------------------------------------------------------------")
19507 (save-excursion
19512 (defun org-install-agenda-files-menu ()
19513 (let ((bl (buffer-list)))
19514 (save-excursion
19515 (while bl
19516 (set-buffer (pop bl))
19517 (if (derived-mode-p 'org-mode) (setq bl nil)))
19518 (when (derived-mode-p 'org-mode)
19519 (easy-menu-change
19520 '("Org") "File List for Agenda"
19521 (append
19522 (list
19523 ["Edit File List" (org-edit-agenda-file-list) t]
19524 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19525 ["Remove Current File from List" org-remove-file t]
19526 ["Cycle through agenda files" org-cycle-agenda-files t]
19527 ["Occur in all agenda files" org-occur-in-agenda-files t]
19528 "--")
19529 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19531 ;;;; Documentation
19533 ;;;###autoload
19534 (defun org-require-autoloaded-modules ()
19535 (interactive)
19536 (mapc 'require
19537 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19538 org-docbook org-exp org-html org-icalendar
19539 org-id org-latex
19540 org-publish org-remember org-table
19541 org-timer org-xoxo)))
19543 ;;;###autoload
19544 (defun org-reload (&optional uncompiled)
19545 "Reload all org lisp files.
19546 With prefix arg UNCOMPILED, load the uncompiled versions."
19547 (interactive "P")
19548 (require 'find-func)
19550 (dir-org (file-name-directory (org-find-library-name "org")))
19551 (dir-org-contrib (ignore-errors
19552 (file-name-directory
19553 (org-find-library-name "org-contribdir"))))
19554 (babel-files
19555 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19556 (append (list nil "comint" "eval" "exp" "keys"
19557 "lob" "ref" "table" "tangle")
19558 (delq nil
19559 (mapcar
19560 (lambda (lang)
19561 (when (cdr lang) (symbol-name (car lang))))
19562 org-babel-load-languages)))))
19563 (files
19564 (append (directory-files dir-org t file-re)
19565 babel-files
19566 (and dir-org-contrib
19567 (directory-files dir-org-contrib t file-re))))
19568 (remove-re (concat (if (featurep 'xemacs)
19569 "org-colview" "org-colview-xemacs")
19571 (setq files (mapcar 'file-name-sans-extension files))
19572 (setq files (mapcar
19573 (lambda (x) (if (string-match remove-re x) nil x))
19574 files))
19575 (setq files (delq nil files))
19576 (mapc
19577 (lambda (f)
19578 (when (featurep (intern (file-name-nondirectory f)))
19579 (if (and (not uncompiled)
19580 (file-exists-p (concat f ".elc")))
19581 (load (concat f ".elc") nil nil t)
19582 (load (concat f ".el") nil nil t))))
19583 files))
19584 (org-version))
19586 ;;;###autoload
19587 (defun org-customize ()
19588 "Call the customize function with org as argument."
19589 (interactive)
19590 (org-load-modules-maybe)
19591 (org-require-autoloaded-modules)
19592 (customize-browse 'org))
19594 (defun org-create-customize-menu ()
19595 "Create a full customization menu for Org-mode, insert it into the menu."
19596 (interactive)
19597 (org-load-modules-maybe)
19598 (org-require-autoloaded-modules)
19599 (if (fboundp 'customize-menu-create)
19600 (progn
19601 (easy-menu-change
19602 '("Org") "Customize"
19603 `(["Browse Org group" org-customize t]
19604 "--"
19605 ,(customize-menu-create 'org)
19606 ["Set" Custom-set t]
19607 ["Save" Custom-save t]
19608 ["Reset to Current" Custom-reset-current t]
19609 ["Reset to Saved" Custom-reset-saved t]
19610 ["Reset to Standard Settings" Custom-reset-standard t]))
19612 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19614 ;;;; Miscellaneous stuff
19616 ;;; Generally useful functions
19618 (defun org-get-at-bol (property)
19619 "Get text property PROPERTY at beginning of line."
19620 (get-text-property (point-at-bol) property))
19622 (defun org-find-text-property-in-string (prop s)
19623 "Return the first non-nil value of property PROP in string S."
19624 (or (get-text-property 0 prop s)
19625 (get-text-property (or (next-single-property-change 0 prop s) 0)
19626 prop s)))
19628 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19629 "Display the given MESSAGE as a warning."
19630 (if (fboundp 'display-warning)
19631 (display-warning 'org message
19632 (if (featurep 'xemacs) 'warning :warning))
19633 (let ((buf (get-buffer-create "*Org warnings*")))
19634 (with-current-buffer buf
19635 (goto-char (point-max))
19636 (insert "Warning (Org): " message)
19637 (unless (bolp)
19638 (newline)))
19639 (display-buffer buf)
19640 (sit-for 0))))
19642 (defun org-eval (form)
19643 "Eval FORM and return result."
19644 (condition-case error
19645 (eval form)
19646 (error (format "%%![Error: %s]" error))))
19648 (defun org-in-clocktable-p ()
19649 "Check if the cursor is in a clocktable."
19650 (let ((pos (point)) start)
19651 (save-excursion
19652 (end-of-line 1)
19654 (setq start (match-beginning 0))
19656 (>= (match-end 0) pos)
19657 start))))
19659 (defun org-in-commented-line ()
19660 "Is point in a line starting with `#'?"
19661 (equal (char-after (point-at-bol)) ?#))
19663 (defun org-in-indented-comment-line ()
19664 "Is point in a line starting with `#' after some white space?"
19665 (save-excursion
19666 (save-match-data
19667 (goto-char (point-at-bol))
19670 (defun org-in-verbatim-emphasis ()
19671 (save-match-data
19672 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19674 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19675 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19676 (if (and marker (marker-buffer marker)
19677 (buffer-live-p (marker-buffer marker)))
19678 (progn
19679 (org-pop-to-buffer-same-window (marker-buffer marker))
19680 (if (or (> marker (point-max)) (< marker (point-min)))
19681 (widen))
19682 (goto-char marker)
19683 (org-show-context 'org-goto))
19684 (if bookmark
19685 (bookmark-jump bookmark)
19686 (error "Cannot find location"))))
19688 (defun org-quote-csv-field (s)
19689 "Quote field for inclusion in CSV material."
19692 s))
19694 (defun org-force-self-insert (N)
19695 "Needed to enforce self-insert under remapping."
19696 (interactive "p")
19697 (self-insert-command N))
19699 (defun org-string-width (s)
19700 "Compute width of string, ignoring invisible characters.
19701 This ignores character with invisibility property `org-link', and also
19702 characters with property `org-cwidth', because these will become invisible
19703 upon the next fontification round."
19704 (let (b l)
19705 (when (or (eq t buffer-invisibility-spec)
19706 (assq 'org-link buffer-invisibility-spec))
19707 (while (setq b (text-property-any 0 (length s)
19708 'invisible 'org-link s))
19709 (setq s (concat (substring s 0 b)
19710 (substring s (or (next-single-property-change
19711 b 'invisible s) (length s)))))))
19712 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19713 (setq s (concat (substring s 0 b)
19714 (substring s (or (next-single-property-change
19715 b 'org-cwidth s) (length s))))))
19716 (setq l (string-width s) b -1)
19717 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19718 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19719 l))
19721 (defun org-shorten-string (s maxlength)
19722 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19723 If the string is shorter or has length MAXLENGTH, just return the
19724 original string. If it is longer, the functions finds a space in the
19725 string, breaks this string off at that locations and adds three dots
19726 as ellipsis. Including the ellipsis, the string will not be longer
19727 than MAXLENGTH. If finding a good breaking point in the string does
19728 not work, the string is just chopped off in the middle of a word
19729 if necessary."
19730 (if (<= (length s) maxlength)
19731 s
19732 (let* ((n (max (- maxlength 4) 1))
19734 (if (string-match re s)
19735 (concat (match-string 1 s) "...")
19736 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19738 (defun org-get-indentation (&optional line)
19739 "Get the indentation of the current line, interpreting tabs.
19740 When LINE is given, assume it represents a line and compute its indentation."
19741 (if line
19742 (if (string-match "^ *" (org-remove-tabs line))
19743 (match-end 0))
19744 (save-excursion
19745 (beginning-of-line 1)
19747 (current-column))))
19749 (defun org-get-string-indentation (s)
19750 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19751 (let ((n -1) (i 0) (w tab-width) c)
19752 (catch 'exit
19753 (while (< (setq n (1+ n)) (length s))
19754 (setq c (aref s n))
19755 (cond ((= c ?\ ) (setq i (1+ i)))
19757 (t (throw 'exit t)))))
19758 i))
19760 (defun org-remove-tabs (s &optional width)
19761 "Replace tabulators in S with spaces.
19762 Assumes that s is a single line, starting in column 0."
19763 (setq width (or width tab-width))
19765 (setq s (replace-match
19766 (make-string
19767 (- (* width (/ (+ (match-beginning 0) width) width))
19768 (match-beginning 0)) ?\ )
19769 t t s)))
19770 s)
19772 (defun org-fix-indentation (line ind)
19773 "Fix indentation in LINE.
19774 IND is a cons cell with target and minimum indentation.
19775 If the current indentation in LINE is smaller than the minimum,
19776 leave it alone. If it is larger than ind, set it to the target."
19777 (let* ((l (org-remove-tabs line))
19778 (i (org-get-indentation l))
19779 (i1 (car ind)) (i2 (cdr ind)))
19780 (if (>= i i2) (setq l (substring line i2)))
19781 (if (> i1 0)
19782 (concat (make-string i1 ?\ ) l)
19783 l)))
19785 (defun org-remove-indentation (code &optional n)
19786 "Remove the maximum common indentation from the lines in CODE.
19787 N may optionally be the number of spaces to remove."
19788 (with-temp-buffer
19789 (insert code)
19790 (org-do-remove-indentation n)
19791 (buffer-string)))
19793 (defun org-do-remove-indentation (&optional n)
19794 "Remove the maximum common indentation from the buffer."
19795 (untabify (point-min) (point-max))
19796 (let ((min 10000) re)
19797 (if n
19798 (setq min n)
19799 (goto-char (point-min))
19801 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19802 (unless (or (= min 0) (= min 10000))
19804 (goto-char (point-min))
19805 (while (re-search-forward re nil t)
19806 (replace-match "")
19807 (end-of-line 1))
19808 min)))
19810 (defun org-fill-template (template alist)
19811 "Find each %key of ALIST in TEMPLATE and replace it."
19812 (let ((case-fold-search nil)
19813 entry key value)
19814 (setq alist (sort (copy-sequence alist)
19815 (lambda (a b) (< (length (car a)) (length (car b))))))
19816 (while (setq entry (pop alist))
19817 (setq template
19818 (replace-regexp-in-string
19819 (concat "%" (regexp-quote (car entry)))
19820 (cdr entry) template t t)))
19821 template))
19823 (defun org-base-buffer (buffer)
19824 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19825 (if (not buffer)
19826 buffer
19827 (or (buffer-base-buffer buffer)
19828 buffer)))
19830 (defun org-trim (s)
19831 "Remove whitespace at beginning and end of string."
19834 s)
19836 (defun org-wrap (string &optional width lines)
19837 "Wrap string to either a number of lines, or a width in characters.
19838 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19839 that costs. If there is a word longer than WIDTH, the text is actually
19840 wrapped to the length of that word.
19841 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19842 many lines, whatever width that takes.
19843 The return value is a list of lines, without newlines at the end."
19845 (maxword (apply 'max (mapcar 'org-string-width words)))
19846 w ll)
19847 (cond (width
19848 (org-do-wrap words (max maxword width)))
19849 (lines
19850 (setq w maxword)
19851 (setq ll (org-do-wrap words maxword))
19852 (if (<= (length ll) lines)
19853 ll
19854 (setq ll words)
19855 (while (> (length ll) lines)
19856 (setq w (1+ w))
19857 (setq ll (org-do-wrap words w)))
19858 ll))
19859 (t (error "Cannot wrap this")))))
19861 (defun org-do-wrap (words width)
19862 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19863 (let (lines line)
19864 (while words
19865 (setq line (pop words))
19866 (while (and words (< (+ (length line) (length (car words))) width))
19867 (setq line (concat line " " (pop words))))
19868 (setq lines (push line lines)))
19869 (nreverse lines)))
19871 (defun org-split-string (string &optional separators)
19872 "Splits STRING into substrings at SEPARATORS.
19873 No empty strings are returned if there are matches at the beginning
19874 and end of string."
19876 (start 0)
19877 notfirst
19878 (list nil))
19879 (while (and (string-match rexp string
19880 (if (and notfirst
19881 (= start (match-beginning 0))
19882 (< start (length string)))
19883 (1+ start) start))
19884 (< (match-beginning 0) (length string)))
19885 (setq notfirst t)
19886 (or (eq (match-beginning 0) 0)
19887 (and (eq (match-beginning 0) (match-end 0))
19888 (eq (match-beginning 0) start))
19889 (setq list
19890 (cons (substring string start (match-beginning 0))
19891 list)))
19892 (setq start (match-end 0)))
19893 (or (eq start (length string))
19894 (setq list
19895 (cons (substring string start)
19896 list)))
19897 (nreverse list)))
19899 (defun org-quote-vert (s)
19901 (while (string-match "|" s)
19903 s)
19905 (defun org-uuidgen-p (s)
19906 "Is S an ID created by UUIDGEN?"
19907 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19909 (defun org-in-src-block-p nil
19910 "Whether point is in a code source block."
19911 (let (ov)
19912 (when (setq ov (overlays-at (point)))
19913 (memq 'org-block-background
19914 (overlay-properties
19915 (car ov))))))
19917 (defun org-context ()
19918 "Return a list of contexts of the current cursor position.
19919 If several contexts apply, all are returned.
19920 Each context entry is a list with a symbol naming the context, and
19921 two positions indicating start and end of the context. Possible
19922 contexts are:
19924 :headline anywhere in a headline
19925 :headline-stars on the leading stars in a headline
19926 :todo-keyword on a TODO keyword (including DONE) in a headline
19927 :tags on the TAGS in a headline
19928 :priority on the priority cookie in a headline
19929 :item on the first line of a plain list item
19930 :item-bullet on the bullet/number of a plain list item
19931 :checkbox on the checkbox in a plain list item
19932 :table in an org-mode table
19933 :table-special on a special filed in a table
19934 :table-table in a table.el table
19935 :clocktable in a clocktable
19936 :src-block in a source block
19937 :link on a hyperlink
19938 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
19939 :target on a <<target>>
19940 :radio-target on a <<<radio-target>>>
19941 :latex-fragment on a LaTeX fragment
19942 :latex-preview on a LaTeX fragment with overlaid preview image
19944 This function expects the position to be visible because it uses font-lock
19945 faces as a help to recognize the following contexts: :table-special, :link,
19946 and :keyword."
19947 (let* ((f (get-text-property (point) 'face))
19948 (faces (if (listp f) f (list f)))
19949 (case-fold-search t)
19950 (p (point)) clist o)
19951 ;; First the large context
19952 (cond
19953 ((org-at-heading-p t)
19954 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19955 (when (progn
19956 (beginning-of-line 1)
19957 (looking-at org-todo-line-tags-regexp))
19958 (push (org-point-in-group p 1 :headline-stars) clist)
19959 (push (org-point-in-group p 2 :todo-keyword) clist)
19960 (push (org-point-in-group p 4 :tags) clist))
19961 (goto-char p)
19964 (push (org-point-in-group p 0 :priority) clist)))
19966 ((org-at-item-p)
19967 (push (org-point-in-group p 2 :item-bullet) clist)
19968 (push (list :item (point-at-bol)
19969 (save-excursion (org-end-of-item) (point)))
19970 clist)
19971 (and (org-at-item-checkbox-p)
19972 (push (org-point-in-group p 0 :checkbox) clist)))
19974 ((org-at-table-p)
19975 (push (list :table (org-table-begin) (org-table-end)) clist)
19976 (if (memq 'org-formula faces)
19977 (push (list :table-special
19978 (previous-single-property-change p 'face)
19979 (next-single-property-change p 'face)) clist)))
19980 ((org-at-table-p 'any)
19981 (push (list :table-table) clist)))
19982 (goto-char p)
19984 ;; New the "medium" contexts: clocktables, source blocks
19985 (cond ((org-in-clocktable-p)
19986 (push (list :clocktable
19988 (search-backward "#+BEGIN: clocktable" nil t))
19989 (match-beginning 0))
19991 (match-end 0))) clist))
19992 ((org-in-src-block-p)
19993 (push (list :src-block
19995 (search-backward "#+BEGIN_SRC" nil t))
19996 (match-beginning 0))
19997 (and (search-forward "#+END_SRC" nil t)
19998 (match-beginning 0))) clist)))
19999 (goto-char p)
20001 ;; Now the small context
20002 (cond
20003 ((org-at-timestamp-p)
20004 (push (org-point-in-group p 0 :timestamp) clist))
20005 ((memq 'org-link faces)
20006 (push (list :link
20007 (previous-single-property-change p 'face)
20008 (next-single-property-change p 'face)) clist))
20009 ((memq 'org-special-keyword faces)
20010 (push (list :keyword
20011 (previous-single-property-change p 'face)
20012 (next-single-property-change p 'face)) clist))
20013 ((org-at-target-p)
20014 (push (org-point-in-group p 0 :target) clist)
20015 (goto-char (1- (match-beginning 0)))
20016 (if (looking-at org-radio-target-regexp)
20017 (push (org-point-in-group p 0 :radio-target) clist))
20018 (goto-char p))
20019 ((setq o (car (delq nil
20020 (mapcar
20021 (lambda (x)
20022 (if (memq x org-latex-fragment-image-overlays) x))
20023 (overlays-at (point))))))
20024 (push (list :latex-fragment
20025 (overlay-start o) (overlay-end o)) clist)
20026 (push (list :latex-preview
20027 (overlay-start o) (overlay-end o)) clist))
20028 ((org-inside-LaTeX-fragment-p)
20029 ;; FIXME: positions wrong.
20030 (push (list :latex-fragment (point) (point)) clist)))
20032 (setq clist (nreverse (delq nil clist)))
20033 clist))
20035 ;; FIXME: Compare with at-regexp-p Do we need both?
20036 (defun org-in-regexp (re &optional nlines visually)
20037 "Check if point is inside a match of regexp.
20038 Normally only the current line is checked, but you can include NLINES extra
20039 lines both before and after point into the search.
20040 If VISUALLY is set, require that the cursor is not after the match but
20041 really on, so that the block visually is on the match."
20042 (catch 'exit
20043 (let ((pos (point))
20044 (eol (point-at-eol (+ 1 (or nlines 0))))
20045 (inc (if visually 1 0)))
20046 (save-excursion
20047 (beginning-of-line (- 1 (or nlines 0)))
20048 (while (re-search-forward re eol t)
20049 (if (and (<= (match-beginning 0) pos)
20050 (>= (+ inc (match-end 0)) pos))
20051 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
20053 (defun org-at-regexp-p (regexp)
20054 "Is point inside a match of REGEXP in the current line?"
20055 (catch 'exit
20056 (save-excursion
20057 (let ((pos (point)) (end (point-at-eol)))
20058 (beginning-of-line 1)
20059 (while (re-search-forward regexp end t)
20060 (if (and (<= (match-beginning 0) pos)
20061 (>= (match-end 0) pos))
20062 (throw 'exit t)))
20063 nil))))
20065 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
20066 "Non-nil when point is between matches of START-RE and END-RE.
20068 Also return a non-nil value when point is on one of the matches.
20070 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
20071 buffer positions. Default values are the positions of headlines
20072 surrounding the point.
20074 The functions returns a cons cell whose car (resp. cdr) is the
20075 position before START-RE (resp. after END-RE)."
20076 (save-match-data
20077 (let ((pos (point))
20078 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
20079 (limit-down (or lim-down (save-excursion (outline-next-heading))))
20080 beg end)
20081 (save-excursion
20082 ;; Point is on a block when on START-RE or if START-RE can be
20083 ;; found before it...
20084 (and (or (org-at-regexp-p start-re)
20085 (re-search-backward start-re limit-up t))
20086 (setq beg (match-beginning 0))
20087 ;; ... and END-RE after it...
20088 (goto-char (match-end 0))
20089 (re-search-forward end-re limit-down t)
20090 (> (setq end (match-end 0)) pos)
20091 ;; ... without another START-RE in-between.
20092 (goto-char (match-beginning 0))
20093 (not (re-search-backward start-re (1+ beg) t))
20094 ;; Return value.
20095 (cons beg end))))))
20097 (defun org-in-block-p (names)
20098 "Non-nil when point belongs to a block whose name belongs to NAMES.
20100 NAMES is a list of strings containing names of blocks.
20102 Return first block name matched, or nil. Beware that in case of
20103 nested blocks, the returned name may not belong to the closest
20104 block from point."
20105 (save-match-data
20106 (catch 'exit
20107 (let ((case-fold-search t)
20108 (lim-up (save-excursion (outline-previous-heading)))
20109 (lim-down (save-excursion (outline-next-heading))))
20110 (mapc (lambda (name)
20111 (let ((n (regexp-quote name)))
20112 (when (org-between-regexps-p
20115 lim-up lim-down)
20116 (throw 'exit n))))
20117 names))
20118 nil)))
20120 (defun org-occur-in-agenda-files (regexp &optional nlines)
20121 "Call `multi-occur' with buffers for all agenda files."
20123 (let* ((files (org-agenda-files))
20124 (tnames (mapcar 'file-truename files))
20125 (extra org-agenda-text-search-extra-files)
20126 f)
20127 (when (eq (car extra) 'agenda-archives)
20128 (setq extra (cdr extra))
20129 (setq files (org-add-archive-files files)))
20130 (while (setq f (pop extra))
20131 (unless (member (file-truename f) tnames)
20132 (add-to-list 'files f 'append)
20133 (add-to-list 'tnames (file-truename f) 'append)))
20134 (multi-occur
20135 (mapcar (lambda (x)
20136 (with-current-buffer
20137 (or (get-file-buffer x) (find-file-noselect x))
20138 (widen)
20139 (current-buffer)))
20140 files)
20141 regexp)))
20143 (if (boundp 'occur-mode-find-occurrence-hook)
20144 ;; Emacs 23
20145 (add-hook 'occur-mode-find-occurrence-hook
20146 (lambda ()
20147 (when (derived-mode-p 'org-mode)
20148 (org-reveal))))
20149 ;; Emacs 22
20150 (defadvice occur-mode-goto-occurrence
20151 (after org-occur-reveal activate)
20152 (and (derived-mode-p 'org-mode) (org-reveal)))
20153 (defadvice occur-mode-goto-occurrence-other-window
20154 (after org-occur-reveal activate)
20155 (and (derived-mode-p 'org-mode) (org-reveal)))
20156 (defadvice occur-mode-display-occurrence
20157 (after org-occur-reveal activate)
20158 (when (derived-mode-p 'org-mode)
20159 (let ((pos (occur-mode-find-occurrence)))
20160 (with-current-buffer (marker-buffer pos)
20161 (save-excursion
20162 (goto-char pos)
20163 (org-reveal)))))))
20165 (defun org-occur-link-in-agenda-files ()
20166 "Create a link and search for it in the agendas.
20167 The link is not stored in `org-stored-links', it is just created
20168 for the search purpose."
20169 (interactive)
20170 (let ((link (condition-case nil
20171 (org-store-link nil)
20172 (error "Unable to create a link to here"))))
20173 (org-occur-in-agenda-files (regexp-quote link))))
20175 (defun org-uniquify (list)
20176 "Remove duplicate elements from LIST."
20177 (let (res)
20178 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
20179 res))
20181 (defun org-delete-all (elts list)
20182 "Remove all elements in ELTS from LIST."
20183 (while elts
20184 (setq list (delete (pop elts) list)))
20185 list)
20187 (defun org-count (cl-item cl-seq)
20188 "Count the number of occurrences of ITEM in SEQ.
20189 Taken from `count' in cl-seq.el with all keyword arguments removed."
20190 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
20191 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
20192 (while (< cl-start cl-end)
20193 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
20194 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
20195 (setq cl-start (1+ cl-start)))
20196 cl-count))
20198 (defun org-remove-if (predicate seq)
20199 "Remove everything from SEQ that fulfills PREDICATE."
20200 (let (res e)
20201 (while seq
20202 (setq e (pop seq))
20203 (if (not (funcall predicate e)) (push e res)))
20204 (nreverse res)))
20206 (defun org-remove-if-not (predicate seq)
20207 "Remove everything from SEQ that does not fulfill PREDICATE."
20208 (let (res e)
20209 (while seq
20210 (setq e (pop seq))
20211 (if (funcall predicate e) (push e res)))
20212 (nreverse res)))
20214 (defun org-reduce (cl-func cl-seq &rest cl-keys)
20215 "Reduce two-argument FUNCTION across SEQ.
20216 Taken from `reduce' in cl-seq.el with all keyword arguments but
20218 (let ((cl-accum (cond ((memq :initial-value cl-keys)
20219 (cadr (memq :initial-value cl-keys)))
20220 (cl-seq (pop cl-seq))
20221 (t (funcall cl-func)))))
20222 (while cl-seq
20223 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
20224 cl-accum))
20226 (defun org-back-over-empty-lines ()
20227 "Move backwards over whitespace, to the beginning of the first empty line.
20228 Returns the number of empty lines passed."
20229 (let ((pos (point)))
20230 (if (cdr (assoc 'heading org-blank-before-new-entry))
20232 (unless (eobp)
20233 (forward-line -1)))
20234 (beginning-of-line 2)
20235 (goto-char (min (point) pos))
20236 (count-lines (point) pos)))
20238 (defun org-skip-whitespace ()
20241 (defun org-point-in-group (point group &optional context)
20242 "Check if POINT is in match-group GROUP.
20243 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
20244 match. If the match group does not exist or point is not inside it,
20245 return nil."
20246 (and (match-beginning group)
20247 (>= point (match-beginning group))
20248 (<= point (match-end group))
20249 (if context
20250 (list context (match-beginning group) (match-end group))
20251 t)))
20253 (defun org-switch-to-buffer-other-window (&rest args)
20254 "Switch to buffer in a second window on the current frame.
20255 In particular, do not allow pop-up frames.
20256 Returns the newly created buffer."
20257 (let (pop-up-frames special-display-buffer-names special-display-regexps
20258 special-display-function)
20259 (apply 'switch-to-buffer-other-window args)))
20261 (defun org-combine-plists (&rest plists)
20262 "Create a single property list from all plists in PLISTS.
20263 The process starts by copying the first list, and then setting properties
20264 from the other lists. Settings in the last list are the most significant
20265 ones and overrule settings in the other lists."
20266 (let ((rtn (copy-sequence (pop plists)))
20267 p v ls)
20268 (while plists
20269 (setq ls (pop plists))
20270 (while ls
20271 (setq p (pop ls) v (pop ls))
20272 (setq rtn (plist-put rtn p v))))
20273 rtn))
20275 (defun org-move-line-down (arg)
20276 "Move the current line down. With prefix argument, move it past ARG lines."
20277 (interactive "p")
20278 (let ((col (current-column))
20279 beg end pos)
20280 (beginning-of-line 1) (setq beg (point))
20281 (beginning-of-line 2) (setq end (point))
20282 (beginning-of-line (+ 1 arg))
20283 (setq pos (move-marker (make-marker) (point)))
20284 (insert (delete-and-extract-region beg end))
20285 (goto-char pos)
20286 (org-move-to-column col)))
20288 (defun org-move-line-up (arg)
20289 "Move the current line up. With prefix argument, move it past ARG lines."
20290 (interactive "p")
20291 (let ((col (current-column))
20292 beg end pos)
20293 (beginning-of-line 1) (setq beg (point))
20294 (beginning-of-line 2) (setq end (point))
20295 (beginning-of-line (- arg))
20296 (setq pos (move-marker (make-marker) (point)))
20297 (insert (delete-and-extract-region beg end))
20298 (goto-char pos)
20299 (org-move-to-column col)))
20301 (defun org-replace-escapes (string table)
20302 "Replace %-escapes in STRING with values in TABLE.
20304 The sequences in STRING may contain normal field width and padding information,
20306 so values can contain further %-escapes if they are define later in TABLE."
20307 (let ((tbl (copy-alist table))
20308 (case-fold-search nil)
20309 (pchg 0)
20310 e re rpl)
20311 (while (setq e (pop tbl))
20312 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20313 (when (and (cdr e) (string-match re (cdr e)))
20314 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20315 (safe "SREF"))
20316 (add-text-properties 0 3 (list 'sref sref) safe)
20317 (setcdr e (replace-match safe t t (cdr e)))))
20318 (while (string-match re string)
20319 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20320 (cdr e)))
20321 (setq string (replace-match rpl t t string))))
20322 (while (setq pchg (next-property-change pchg string))
20323 (let ((sref (get-text-property pchg 'sref string)))
20324 (when (and sref (string-match "SREF" string pchg))
20325 (setq string (replace-match sref t t string)))))
20326 string))
20328 (defun org-sublist (list start end)
20329 "Return a section of LIST, from START to END.
20330 Counting starts at 1."
20331 (let (rtn (c start))
20332 (setq list (nthcdr (1- start) list))
20333 (while (and list (<= c end))
20334 (push (pop list) rtn)
20335 (setq c (1+ c)))
20336 (nreverse rtn)))
20338 (defun org-find-base-buffer-visiting (file)
20339 "Like `find-buffer-visiting' but always return the base buffer and
20340 not an indirect buffer."
20341 (let ((buf (or (get-file-buffer file)
20342 (find-buffer-visiting file))))
20343 (if buf
20344 (or (buffer-base-buffer buf) buf)
20345 nil)))
20347 (defun org-image-file-name-regexp (&optional extensions)
20348 "Return regexp matching the file names of images.
20349 If EXTENSIONS is given, only match these."
20350 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20351 (image-file-name-regexp)
20352 (let ((image-file-name-extensions
20353 (or extensions
20354 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20355 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20357 (regexp-opt (nconc (mapcar 'upcase
20358 image-file-name-extensions)
20359 image-file-name-extensions)
20360 t)
20363 (defun org-file-image-p (file &optional extensions)
20364 "Return non-nil if FILE is an image."
20365 (save-match-data
20366 (string-match (org-image-file-name-regexp extensions) file)))
20368 (defun org-get-cursor-date ()
20369 "Return the date at cursor in as a time.
20370 This works in the calendar and in the agenda, anywhere else it just
20371 returns the current time."
20372 (let (date day defd)
20373 (cond
20374 ((eq major-mode 'calendar-mode)
20375 (setq date (calendar-cursor-to-date)
20376 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20377 ((eq major-mode 'org-agenda-mode)
20378 (setq day (get-text-property (point) 'day))
20379 (if day
20380 (setq date (calendar-gregorian-from-absolute day)
20381 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20382 (nth 2 date))))))
20383 (or defd (current-time))))
20385 (defvar org-agenda-action-marker (make-marker)
20386 "Marker pointing to the entry for the next agenda action.")
20388 (defun org-mark-entry-for-agenda-action ()
20389 "Mark the current entry as target of an agenda action.
20390 Agenda actions are actions executed from the agenda with the key `k',
20391 which make use of the date at the cursor."
20392 (interactive)
20393 (move-marker org-agenda-action-marker
20394 (save-excursion (org-back-to-heading t) (point))
20395 (current-buffer))
20396 (message
20397 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20399 (defun org-mark-subtree ()
20400 "Mark the current subtree.
20401 This puts point at the start of the current subtree, and mark at the end.
20403 If point is in an inline task, mark that task instead."
20404 (interactive)
20405 (let ((inline-task-p
20406 (and (featurep 'org-inlinetask)
20407 (org-inlinetask-in-task-p)))
20408 (beg))
20409 ;; Get beginning of subtree
20410 (cond
20411 (inline-task-p (org-inlinetask-goto-beginning))
20412 ((org-at-heading-p) (beginning-of-line))
20413 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20414 (setq beg (point))
20415 ;; Get end of it
20416 (if inline-task-p
20417 (org-inlinetask-goto-end)
20418 (org-end-of-subtree))
20419 ;; Mark zone
20420 (push-mark (point) nil t)
20421 (goto-char beg)))
20423 ;;; Paragraph filling stuff.
20424 ;; We want this to be just right, so use the full arsenal.
20426 (defun org-indent-line-function ()
20427 "Indent line depending on context."
20428 (interactive)
20429 (let* ((pos (point))
20430 (itemp (org-at-item-p))
20431 (case-fold-search t)
20433 (inline-task-p (and (featurep 'org-inlinetask)
20434 (org-inlinetask-in-task-p)))
20435 (inline-re (and inline-task-p
20436 (org-inlinetask-outline-regexp)))
20437 column)
20438 (beginning-of-line 1)
20439 (cond
20440 ;; Comments
20441 ((looking-at "# ") (setq column 0))
20442 ;; Headings
20443 ((looking-at org-outline-regexp) (setq column 0))
20444 ;; Included files
20446 ;; Footnote definition
20447 ((looking-at org-footnote-definition-re) (setq column 0))
20448 ;; Literal examples
20450 (setq column (org-get-indentation))) ; do nothing
20451 ;; Lists
20452 ((ignore-errors (goto-char (org-in-item-p)))
20453 (setq column (if itemp
20454 (org-get-indentation)
20455 (org-list-item-body-column (point))))
20456 (goto-char pos))
20457 ;; Drawers
20459 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20460 (save-excursion
20461 (goto-char (1- (match-beginning 1)))
20462 (setq column (current-column))))
20463 ;; Special blocks
20465 (save-excursion
20466 (re-search-backward
20468 (setq column (org-get-indentation (match-string 0))))
20471 (save-excursion
20473 (setq column
20474 (cond ((equal (downcase (match-string 1)) "src")
20475 ;; src blocks: let `org-edit-src-exit' handle them
20476 (org-get-indentation))
20477 ((equal (downcase (match-string 1)) "example")
20478 (max (org-get-indentation)
20479 (org-get-indentation (match-string 0))))
20480 (t
20481 (org-get-indentation (match-string 0))))))
20482 ;; This line has nothing special, look at the previous relevant
20483 ;; line to compute indentation
20484 (t
20485 (beginning-of-line 0)
20486 (while (and (not (bobp))
20487 (not (looking-at org-drawer-regexp))
20488 ;; When point started in an inline task, do not move
20489 ;; above task starting line.
20490 (not (and inline-task-p (looking-at inline-re)))
20491 ;; Skip drawers, blocks, empty lines, verbatim,
20492 ;; comments, tables, footnotes definitions, lists,
20493 ;; inline tasks.
20495 (re-search-backward org-drawer-regexp nil t))
20499 (looking-at org-footnote-definition-re)
20500 (and (ignore-errors (goto-char (org-in-item-p)))
20501 (goto-char
20502 (org-list-get-top-point (org-list-struct))))
20503 (and (not inline-task-p)
20504 (featurep 'org-inlinetask)
20505 (org-inlinetask-in-task-p)
20506 (or (org-inlinetask-goto-beginning) t))))
20507 (beginning-of-line 0))
20508 (cond
20509 ;; There was an heading above.
20511 (if (not org-adapt-indentation)
20512 (setq column 0)
20513 (goto-char (match-end 0))
20514 (setq column (current-column))))
20515 ;; A drawer had started and is unfinished
20516 ((looking-at org-drawer-regexp)
20517 (goto-char (1- (match-beginning 1)))
20518 (setq column (current-column)))
20519 ;; Else, nothing noticeable found: get indentation and go on.
20520 (t (setq column (org-get-indentation))))))
20521 ;; Now apply indentation and move cursor accordingly
20522 (goto-char pos)
20523 (if (<= (current-column) (current-indentation))
20524 (org-indent-line-to column)
20525 (save-excursion (org-indent-line-to column)))
20526 ;; Special polishing for properties, see `org-property-format'
20527 (setq column (current-column))
20528 (beginning-of-line 1)
20529 (if (looking-at
20531 (replace-match (concat (match-string 1)
20532 (format org-property-format
20533 (match-string 2) (match-string 3)))
20534 t t))
20535 (org-move-to-column column)
20536 (when (and orgstruct-is-++ (eq pos (point)))
20537 (org-let org-fb-vars
20538 '(indent-according-to-mode)))))
20540 (defun org-indent-drawer ()
20541 "Indent the drawer at point."
20542 (interactive)
20543 (let ((p (point))
20544 (e (and (save-excursion (re-search-forward ":END:" nil t))
20545 (match-end 0)))
20546 (folded
20547 (save-excursion
20548 (end-of-line)
20549 (when (overlays-at (point))
20550 (member 'invisible (overlay-properties
20551 (car (overlays-at (point)))))))))
20552 (when folded (org-cycle))
20553 (indent-for-tab-command)
20554 (while (and (move-beginning-of-line 2) (< (point) e))
20555 (indent-for-tab-command))
20556 (goto-char p)
20557 (when folded (org-cycle)))
20558 (message "Drawer at point indented"))
20560 (defun org-indent-block ()
20561 "Indent the block at point."
20562 (interactive)
20563 (let ((p (point))
20564 (case-fold-search t)
20566 (match-end 0)))
20567 (folded
20568 (save-excursion
20569 (end-of-line)
20570 (when (overlays-at (point))
20571 (member 'invisible (overlay-properties
20572 (car (overlays-at (point)))))))))
20573 (when folded (org-cycle))
20574 (indent-for-tab-command)
20575 (while (and (move-beginning-of-line 2) (< (point) e))
20576 (indent-for-tab-command))
20577 (goto-char p)
20578 (when folded (org-cycle)))
20579 (message "Block at point indented"))
20581 ;; For reference, this is the default value of adaptive-fill-regexp
20583 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20584 "Variable to store copy of `adaptive-fill-regexp'.
20585 Since `adaptive-fill-regexp' is set to never match, we need to
20586 store a backup of its value before entering `org-mode' so that
20587 the functionality can be provided as a fall-back.")
20589 (defun org-set-autofill-regexps ()
20590 (interactive)
20591 ;; In the paragraph separator we include headlines, because filling
20592 ;; text in a line directly attached to a headline would otherwise
20593 ;; fill the headline as well.
20596 ;; The paragraph starter includes hand-formatted lists.
20597 (org-set-local
20598 'paragraph-start
20599 (concat
20608 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20609 ;; But only if the user has not turned off tables or fixed-width regions
20610 (org-set-local
20611 'auto-fill-inhibit-regexp
20612 (concat org-outline-regexp
20615 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20616 (concat
20618 (if org-enable-table-editor "|" "")
20619 (if org-enable-fixed-width-editor ":" "")
20620 "]"))))
20621 ;; We use our own fill-paragraph function, to make sure that tables
20622 ;; and fixed-width regions are not wrapped. That function will pass
20623 ;; through to `fill-paragraph' when appropriate.
20624 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20625 ;; Prevent auto-fill from inserting unwanted new items.
20626 (if (boundp 'fill-nobreak-predicate)
20627 (org-set-local
20628 'fill-nobreak-predicate
20629 (org-uniquify
20630 (append fill-nobreak-predicate
20631 '(org-fill-item-nobreak-p org-fill-line-break-nobreak-p)))))
20632 ;; Adaptive filling: To get full control, first make sure that
20633 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20634 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20635 (org-set-local 'org-adaptive-fill-regexp-backup
20636 adaptive-fill-regexp))
20638 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20639 (org-set-local 'adaptive-fill-function
20640 'org-adaptive-fill-function)
20641 (org-set-local
20642 'align-mode-rules-list
20643 '((org-in-buffer-settings
20645 (modes . '(org-mode))))))
20647 (defun org-fill-item-nobreak-p ()
20648 "Non-nil when a line break at point would insert a new item."
20649 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20651 (defun org-fill-line-break-nobreak-p ()
20652 "Non-nil when a line break at point would create an Org line break."
20653 (save-excursion
20658 (defun org-fill-paragraph (&optional justify)
20659 "Re-align a table, pass through to fill-paragraph if no table."
20660 (let ((table-p (org-at-table-p))
20661 (table.el-p (org-at-table.el-p))
20662 (itemp (org-in-item-p)))
20663 (cond ((and (equal (char-after (point-at-bol)) ?*)
20664 (save-excursion (goto-char (point-at-bol))
20665 (looking-at org-outline-regexp)))
20666 t) ; skip headlines
20667 (table.el-p t) ; skip table.el tables
20668 (table-p (org-table-align) t) ; align Org tables
20669 (itemp ; align text in items
20670 (let* ((struct (save-excursion (goto-char itemp)
20671 (org-list-struct)))
20672 (parents (org-list-parents-alist struct))
20673 (children (org-list-get-children itemp struct parents))
20674 beg end prev next prefix)
20675 ;; Determine in which part of item point is: before
20676 ;; first child, after last child, between two
20677 ;; sub-lists, or simply in item if there's no child.
20678 (cond
20679 ((not children)
20680 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20681 beg itemp
20682 end (org-list-get-item-end itemp struct)))
20683 ((< (point) (setq next (car children)))
20684 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20685 beg itemp
20686 end next))
20687 ((> (point) (setq prev (car (last children))))
20688 (setq beg (org-list-get-item-end prev struct)
20689 end (org-list-get-item-end itemp struct)
20690 prefix (save-excursion
20691 (goto-char beg)
20693 (make-string (current-column) ?\ ))))
20694 (t (catch 'exit
20695 (while (setq next (pop children))
20696 (if (> (point) next)
20697 (setq prev next)
20698 (setq beg (org-list-get-item-end prev struct)
20699 end next
20700 prefix (save-excursion
20701 (goto-char beg)
20703 (make-string (current-column) ?\ )))
20704 (throw 'exit nil))))))
20705 ;; Use `fill-paragraph' with buffer narrowed to item
20706 ;; without any child, and with our computed PREFIX.
20707 (flet ((fill-context-prefix (from to &optional flr) prefix))
20708 (save-restriction
20709 (narrow-to-region beg end)
20710 (save-excursion (fill-paragraph justify)))) t))
20711 ;; Special case where point is not in a list but is on
20712 ;; a paragraph adjacent to a list: make sure this paragraph
20713 ;; doesn't get merged with the end of the list by narrowing
20714 ;; buffer first.
20715 ((and (derived-mode-p 'org-mode)
20716 (save-excursion (forward-paragraph -1)
20717 (setq itemp (org-in-item-p))))
20718 (let ((struct (save-excursion (goto-char itemp)
20719 (org-list-struct))))
20720 (save-restriction
20721 (narrow-to-region (org-list-get-bottom-point struct)
20722 (save-excursion (forward-paragraph 1)
20723 (point)))
20724 (fill-paragraph justify) t)))
20725 ;; Don't fill schedule/deadline line before a paragraph
20726 ;; This only makes sense in real org-mode buffers
20727 ((and (eq major-mode 'org-mode)
20728 (save-excursion (forward-paragraph -1)
20731 (save-restriction
20732 (narrow-to-region (1+ (match-end 0))
20733 (save-excursion (forward-paragraph 1) (point)))
20734 (fill-paragraph justify) t))
20735 ;; Else fall back on fill-paragraph-function as possibly
20736 ;; defined in `org-fb-vars'
20737 (orgstruct-is-++
20738 (org-let org-fb-vars
20739 '(fill-paragraph justify)))
20740 (t nil))))
20742 (defun org-adaptive-fill-function ()
20743 "Return a fill prefix for org-mode files."
20744 (let (itemp)
20745 (save-excursion
20746 (cond
20747 ;; Comment line
20749 (match-string-no-properties 0))
20750 ;; Plain list item
20751 ((org-at-item-p)
20752 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20753 ;; Point is in a list after `backward-paragraph': original
20754 ;; point wasn't in the list, or filling would have been taken
20755 ;; care of by `org-auto-fill-function', but the list and the
20756 ;; real paragraph are not separated by a blank line. Thus, move
20757 ;; point after the list to go back to real paragraph and
20758 ;; determine fill-prefix.
20759 ((setq itemp (org-in-item-p))
20760 (goto-char itemp)
20761 (let* ((struct (org-list-struct))
20762 (bottom (org-list-get-bottom-point struct)))
20763 (goto-char bottom)
20764 (make-string (org-get-indentation) ?\ )))
20765 ;; Other text
20766 ((looking-at org-adaptive-fill-regexp-backup)
20767 (match-string-no-properties 0))))))
20769 (defun org-auto-fill-function ()
20770 "Auto-fill function."
20771 (unless (and org-src-prevent-auto-filling (org-in-src-block-p))
20772 (let (itemp prefix)
20773 ;; When in a list, compute an appropriate fill-prefix and make
20774 ;; sure it will be used by `do-auto-fill'.
20775 (cond ((setq itemp (org-in-item-p))
20776 (progn
20777 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20778 (flet ((fill-context-prefix (from to &optional flr) prefix))
20779 (do-auto-fill))))
20780 (orgstruct-is-++
20781 (org-let org-fb-vars
20782 '(do-auto-fill)))
20783 (t (do-auto-fill))))))
20785 ;;; Other stuff.
20787 (defun org-toggle-fixed-width-section (arg)
20788 "Toggle the fixed-width export.
20789 If there is no active region, the QUOTE keyword at the current headline is
20790 inserted or removed. When present, it causes the text between this headline
20791 and the next to be exported as fixed-width text, and unmodified.
20792 If there is an active region, this command adds or removes a colon as the
20793 first character of this line. If the first character of a line is a colon,
20794 this line is also exported in fixed-width font."
20795 (interactive "P")
20796 (let* ((cc 0)
20797 (regionp (org-region-active-p))
20798 (beg (if regionp (region-beginning) (point)))
20799 (end (if regionp (region-end)))
20800 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20801 (case-fold-search nil)
20803 off)
20804 (if regionp
20805 (save-excursion
20806 (goto-char beg)
20807 (setq cc (current-column))
20808 (beginning-of-line 1)
20809 (setq off (looking-at re))
20810 (while (> nlines 0)
20811 (setq nlines (1- nlines))
20812 (beginning-of-line 1)
20813 (cond
20814 (arg
20815 (org-move-to-column cc t)
20817 (forward-line -1))
20818 ((and off (looking-at re))
20819 (replace-match "" t t nil 1))
20820 ((not off) (org-move-to-column cc t) (insert ": ")))
20821 (forward-line 1)))
20822 (save-excursion
20823 (org-back-to-heading)
20824 (cond
20825 ((looking-at (format org-heading-keyword-regexp-format
20826 org-quote-string))
20827 (goto-char (match-end 1))
20828 (looking-at (concat " +" org-quote-string))
20829 (replace-match "" t t)
20830 (when (eolp) (insert " ")))
20831 ((looking-at org-outline-regexp)
20832 (goto-char (match-end 0))
20833 (insert org-quote-string " ")))))))
20835 (defun org-reftex-citation ()
20836 "Use reftex-citation to insert a citation into the buffer.
20837 This looks for a line like
20839 #+BIBLIOGRAPHY: foo plain option:-d
20841 and derives from it that foo.bib is the bibliography file relevant
20842 for this document. It then installs the necessary environment for RefTeX
20843 to work in this buffer and calls `reftex-citation' to insert a citation
20844 into the buffer.
20846 Export of such citations to both LaTeX and HTML is handled by the contributed
20847 package org-exp-bibtex by Taru Karttunen."
20848 (interactive)
20849 (let ((reftex-docstruct-symbol 'rds)
20851 rds bib)
20852 (save-excursion
20853 (save-restriction
20854 (widen)
20855 (let ((case-fold-search t)
20857 (if (not (save-excursion
20858 (or (re-search-forward re nil t)
20859 (re-search-backward re nil t))))
20860 (error "No bibliography defined in file")
20861 (setq bib (concat (match-string 1) ".bib")
20862 rds (list (list 'bib bib)))))))
20863 (call-interactively 'reftex-citation)))
20865 ;;;; Functions extending outline functionality
20867 (defun org-beginning-of-line (&optional arg)
20868 "Go to the beginning of the current line. If that is invisible, continue
20869 to a visible line beginning. This makes the function of C-a more intuitive.
20870 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20871 first attempt, and only move to after the tags when the cursor is already
20872 beyond the end of the headline."
20873 (interactive "P")
20874 (let ((pos (point))
20875 (special (if (consp org-special-ctrl-a/e)
20876 (car org-special-ctrl-a/e)
20877 org-special-ctrl-a/e))
20878 refpos)
20879 (if (org-bound-and-true-p line-move-visual)
20880 (beginning-of-visual-line 1)
20881 (beginning-of-line 1))
20882 (if (and arg (fboundp 'move-beginning-of-line))
20883 (call-interactively 'move-beginning-of-line)
20884 (if (bobp)
20885 nil
20886 (backward-char 1)
20887 (if (org-truely-invisible-p)
20888 (while (and (not (bobp)) (org-truely-invisible-p))
20889 (backward-char 1)
20890 (beginning-of-line 1))
20891 (forward-char 1))))
20892 (when special
20893 (cond
20894 ((and (looking-at org-complex-heading-regexp)
20895 (= (char-after (match-end 1)) ?\ ))
20896 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20897 (point-at-eol)))
20898 (goto-char
20899 (if (eq special t)
20900 (cond ((> pos refpos) refpos)
20901 ((= pos (point)) refpos)
20902 (t (point)))
20903 (cond ((> pos (point)) (point))
20904 ((not (eq last-command this-command)) (point))
20905 (t refpos)))))
20906 ((org-at-item-p)
20907 ;; Being at an item and not looking at an the item means point
20908 ;; was previously moved to beginning of a visual line, which
20909 ;; doesn't contain the item. Therefore, do nothing special,
20910 ;; just stay here.
20911 (when (looking-at org-list-full-item-re)
20912 ;; Set special position at first white space character after
20913 ;; bullet, and check-box, if any.
20914 (let ((after-bullet
20915 (let ((box (match-end 3)))
20916 (if (not box) (match-end 1)
20917 (let ((after (char-after box)))
20918 (if (and after (= after ? )) (1+ box) box))))))
20919 ;; Special case: Move point to special position when
20920 ;; currently after it or at beginning of line.
20921 (if (eq special t)
20922 (when (or (> pos after-bullet) (= (point) pos))
20923 (goto-char after-bullet))
20924 ;; Reversed case: Move point to special position when
20925 ;; point was already at beginning of line and command is
20926 ;; repeated.
20927 (when (and (= (point) pos) (eq last-command this-command))
20928 (goto-char after-bullet))))))))
20929 (org-no-warnings
20930 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20932 (defun org-end-of-line (&optional arg)
20933 "Go to the end of the line.
20934 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20935 first attempt, and only move to after the tags when the cursor is already
20936 beyond the end of the headline."
20937 (interactive "P")
20938 (let ((special (if (consp org-special-ctrl-a/e)
20939 (cdr org-special-ctrl-a/e)
20940 org-special-ctrl-a/e)))
20941 (cond
20942 ((or (not special) arg
20943 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20944 (call-interactively
20945 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20946 ((fboundp 'move-end-of-line) 'move-end-of-line)
20947 (t 'end-of-line))))
20948 ((org-at-heading-p)
20949 (let ((pos (point)))
20950 (beginning-of-line 1)
20952 (if (eq special t)
20953 (if (or (< pos (match-beginning 1))
20954 (= pos (match-end 0)))
20955 (goto-char (match-beginning 1))
20956 (goto-char (match-end 0)))
20957 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20958 (goto-char (match-end 0))
20959 (goto-char (match-beginning 1))))
20960 (call-interactively (if (fboundp 'move-end-of-line)
20961 'move-end-of-line
20962 'end-of-line)))))
20963 ((org-at-drawer-p)
20964 (move-end-of-line 1)
20965 (when (overlays-at (1- (point))) (backward-char 1)))
20966 ;; At an item: Move before any hidden text.
20967 (t (call-interactively
20968 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20969 ((fboundp 'move-end-of-line) 'move-end-of-line)
20970 (t 'end-of-line)))))
20971 (org-no-warnings
20972 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20974 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20975 (define-key org-mode-map "\C-e" 'org-end-of-line)
20977 (defun org-backward-sentence (&optional arg)
20978 "Go to beginning of sentence, or beginning of table field.
20979 This will call `backward-sentence' or `org-table-beginning-of-field',
20980 depending on context."
20981 (interactive "P")
20982 (cond
20983 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20984 (t (call-interactively 'backward-sentence))))
20986 (defun org-forward-sentence (&optional arg)
20987 "Go to end of sentence, or end of table field.
20988 This will call `forward-sentence' or `org-table-end-of-field',
20989 depending on context."
20990 (interactive "P")
20991 (cond
20992 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20993 (t (call-interactively 'forward-sentence))))
20995 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20996 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20998 (defun org-kill-line (&optional arg)
20999 "Kill line, to tags or end of line."
21000 (interactive "P")
21001 (cond
21002 ((or (not org-special-ctrl-k)
21003 (bolp)
21004 (not (org-at-heading-p)))
21005 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
21006 org-ctrl-k-protect-subtree)
21007 (if (or (eq org-ctrl-k-protect-subtree 'error)
21008 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
21009 (error "C-k aborted - would kill hidden subtree")))
21010 (call-interactively
21011 (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
21013 (kill-region (point) (match-beginning 1))
21014 (org-set-tags nil t))
21015 (t (kill-region (point) (point-at-eol)))))
21017 (define-key org-mode-map "\C-k" 'org-kill-line)
21019 (defun org-yank (&optional arg)
21020 "Yank. If the kill is a subtree, treat it specially.
21021 This command will look at the current kill and check if is a single
21022 subtree, or a series of subtrees[1]. If it passes the test, and if the
21023 cursor is at the beginning of a line or after the stars of a currently
21024 empty headline, then the yank is handled specially. How exactly depends
21025 on the value of the following variables, both set by default.
21027 org-yank-folded-subtrees
21028 When set, the subtree(s) will be folded after insertion, but only
21029 if doing so would now swallow text after the yanked text.
21031 org-yank-adjusted-subtrees
21032 When set, the subtree will be promoted or demoted in order to
21033 fit into the local outline tree structure, which means that the level
21034 will be adjusted so that it becomes the smaller one of the two
21035 *visible* surrounding headings.
21037 Any prefix to this command will cause `yank' to be called directly with
21039 will just
21040 plainly yank the text as it is.
21042 \[1] The test checks if the first non-white line is a heading
21043 and if there are no other headings with fewer stars."
21044 (interactive "P")
21045 (org-yank-generic 'yank arg))
21047 (defun org-yank-generic (command arg)
21048 "Perform some yank-like command.
21050 This function implements the behavior described in the `org-yank'
21051 documentation. However, it has been generalized to work for any
21052 interactive command with similar behavior."
21054 ;; pretend to be command COMMAND
21055 (setq this-command command)
21057 (if arg
21058 (call-interactively command)
21060 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
21061 (and (org-kill-is-subtree-p)
21062 (or (bolp)
21064 (string-match
21066 (buffer-substring (point-at-bol) (point)))))))
21067 swallowp)
21068 (cond
21069 ((and subtreep org-yank-folded-subtrees)
21070 (let ((beg (point))
21071 end)
21072 (if (and subtreep org-yank-adjusted-subtrees)
21073 (org-paste-subtree nil nil 'for-yank)
21074 (call-interactively command))
21076 (setq end (point))
21077 (goto-char beg)
21078 (when (and (bolp) subtreep
21079 (not (setq swallowp
21080 (org-yank-folding-would-swallow-text beg end))))
21081 (org-with-limited-levels
21082 (or (looking-at org-outline-regexp)
21083 (re-search-forward org-outline-regexp-bol end t))
21084 (while (and (< (point) end) (looking-at org-outline-regexp))
21085 (hide-subtree)
21086 (org-cycle-show-empty-lines 'folded)
21087 (condition-case nil
21088 (outline-forward-same-level 1)
21089 (error (goto-char end))))))
21090 (when swallowp
21091 (message
21092 "Inserted text not folded because that would swallow text"))
21094 (goto-char end)
21096 (beginning-of-line 1)
21097 (push-mark beg 'nomsg)))
21098 ((and subtreep org-yank-adjusted-subtrees)
21099 (let ((beg (point-at-bol)))
21100 (org-paste-subtree nil nil 'for-yank)
21101 (push-mark beg 'nomsg)))
21102 (t
21103 (call-interactively command))))))
21105 (defun org-yank-folding-would-swallow-text (beg end)
21106 "Would hide-subtree at BEG swallow any text after END?"
21107 (let (level)
21108 (org-with-limited-levels
21109 (save-excursion
21110 (goto-char beg)
21111 (when (or (looking-at org-outline-regexp)
21112 (re-search-forward org-outline-regexp-bol end t))
21113 (setq level (org-outline-level)))
21114 (goto-char end)
21116 (if (or (eobp)
21117 (and (bolp) (looking-at org-outline-regexp)
21118 (<= (org-outline-level) level)))
21119 nil ; Nothing would be swallowed
21120 t))))) ; something would swallow
21122 (define-key org-mode-map "\C-y" 'org-yank)
21124 (defun org-truely-invisible-p ()
21125 "Check if point is at a character currently not visible.
21126 This version does not only check the character property, but also
21127 `visible-mode'."
21128 ;; Early versions of noutline don't have `outline-invisible-p'.
21129 (if (org-bound-and-true-p visible-mode)
21130 nil
21131 (outline-invisible-p)))
21133 (defun org-invisible-p2 ()
21134 "Check if point is at a character currently not visible."
21135 (save-excursion
21136 (if (and (eolp) (not (bobp))) (backward-char 1))
21137 ;; Early versions of noutline don't have `outline-invisible-p'.
21138 (outline-invisible-p)))
21140 (defun org-back-to-heading (&optional invisible-ok)
21141 "Call `outline-back-to-heading', but provide a better error message."
21142 (condition-case nil
21143 (outline-back-to-heading invisible-ok)
21144 (error (error "Before first headline at position %d in buffer %s"
21145 (point) (current-buffer)))))
21147 (defun org-beginning-of-defun ()
21148 "Go to the beginning of the subtree, i.e. back to the heading."
21149 (org-back-to-heading))
21150 (defun org-end-of-defun ()
21151 "Go to the end of the subtree."
21152 (org-end-of-subtree nil t))
21154 (defun org-before-first-heading-p ()
21155 "Before first heading?"
21156 (save-excursion
21157 (end-of-line)
21158 (null (re-search-backward org-outline-regexp-bol nil t))))
21160 (defun org-at-heading-p (&optional ignored)
21161 (outline-on-heading-p t))
21162 ;; Compatibility alias with Org versions < 7.8.03
21163 (defalias 'org-on-heading-p 'org-at-heading-p)
21165 (defun org-at-drawer-p nil
21166 "Is cursor at a drawer keyword?"
21167 (save-excursion
21168 (move-beginning-of-line 1)
21169 (looking-at org-drawer-regexp)))
21171 (defun org-at-block-p nil
21172 "Is cursor at a block keyword?"
21173 (save-excursion
21174 (move-beginning-of-line 1)
21175 (looking-at org-block-regexp)))
21177 (defun org-point-at-end-of-empty-headline ()
21178 "If point is at the end of an empty headline, return t, else nil.
21179 If the heading only contains a TODO keyword, it is still still considered
21180 empty."
21182 (when org-todo-line-regexp
21183 (save-excursion
21184 (beginning-of-line 1)
21185 (let ((case-fold-search nil))
21186 (looking-at org-todo-line-regexp)
21187 (string= (match-string 3) ""))))))
21189 (defun org-at-heading-or-item-p ()
21190 (or (org-at-heading-p) (org-at-item-p)))
21192 (defun org-at-target-p ()
21193 (or (org-in-regexp org-radio-target-regexp)
21194 (org-in-regexp org-target-regexp)))
21195 ;; Compatibility alias with Org versions < 7.8.03
21196 (defalias 'org-on-target-p 'org-at-target-p)
21198 (defun org-up-heading-all (arg)
21199 "Move to the heading line of which the present line is a subheading.
21200 This function considers both visible and invisible heading lines.
21201 With argument, move up ARG levels."
21202 (if (fboundp 'outline-up-heading-all)
21203 (outline-up-heading-all arg) ; emacs 21 version of outline.el
21204 (outline-up-heading arg t))) ; emacs 22 version of outline.el
21206 (defun org-up-heading-safe ()
21207 "Move to the heading line of which the present line is a subheading.
21208 This version will not throw an error. It will return the level of the
21209 headline found, or nil if no higher level is found.
21211 Also, this function will be a lot faster than `outline-up-heading',
21212 because it relies on stars being the outline starters. This can really
21213 make a significant difference in outlines with very many siblings."
21214 (let (start-level re)
21215 (org-back-to-heading t)
21216 (setq start-level (funcall outline-level))
21217 (if (equal start-level 1)
21218 nil
21220 (if (re-search-backward re nil t)
21221 (funcall outline-level)))))
21223 (defun org-first-sibling-p ()
21224 "Is this heading the first child of its parents?"
21225 (interactive)
21226 (let ((re org-outline-regexp-bol)
21227 level l)
21228 (unless (org-at-heading-p t)
21229 (error "Not at a heading"))
21230 (setq level (funcall outline-level))
21231 (save-excursion
21232 (if (not (re-search-backward re nil t))
21233 t
21234 (setq l (funcall outline-level))
21235 (< l level)))))
21237 (defun org-goto-sibling (&optional previous)
21238 "Goto the next sibling, even if it is invisible.
21239 When PREVIOUS is set, go to the previous sibling instead. Returns t
21240 when a sibling was found. When none is found, return nil and don't
21241 move point."
21242 (let ((fun (if previous 're-search-backward 're-search-forward))
21243 (pos (point))
21244 (re org-outline-regexp-bol)
21245 level l)
21246 (when (condition-case nil (org-back-to-heading t) (error nil))
21247 (setq level (funcall outline-level))
21248 (catch 'exit
21249 (or previous (forward-char 1))
21250 (while (funcall fun re nil t)
21251 (setq l (funcall outline-level))
21252 (when (< l level) (goto-char pos) (throw 'exit nil))
21253 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
21254 (goto-char pos)
21255 nil))))
21257 (defun org-show-siblings ()
21258 "Show all siblings of the current headline."
21259 (save-excursion
21260 (while (org-goto-sibling) (org-flag-heading nil)))
21261 (save-excursion
21262 (while (org-goto-sibling 'previous)
21263 (org-flag-heading nil))))
21265 (defun org-goto-first-child ()
21266 "Goto the first child, even if it is invisible.
21267 Return t when a child was found. Otherwise don't move point and
21268 return nil."
21269 (let (level (pos (point)) (re org-outline-regexp-bol))
21270 (when (condition-case nil (org-back-to-heading t) (error nil))
21271 (setq level (outline-level))
21272 (forward-char 1)
21273 (if (and (re-search-forward re nil t) (> (outline-level) level))
21274 (progn (goto-char (match-beginning 0)) t)
21275 (goto-char pos) nil))))
21277 (defun org-show-hidden-entry ()
21278 "Show an entry where even the heading is hidden."
21279 (save-excursion
21280 (org-show-entry)))
21282 (defun org-flag-heading (flag &optional entry)
21283 "Flag the current heading. FLAG non-nil means make invisible.
21284 When ENTRY is non-nil, show the entire entry."
21285 (save-excursion
21286 (org-back-to-heading t)
21287 ;; Check if we should show the entire entry
21288 (if entry
21289 (progn
21290 (org-show-entry)
21291 (save-excursion
21292 (and (outline-next-heading)
21293 (org-flag-heading nil))))
21294 (outline-flag-region (max (point-min) (1- (point)))
21295 (save-excursion (outline-end-of-heading) (point))
21296 flag))))
21298 (defun org-get-next-sibling ()
21299 "Move to next heading of the same level, and return point.
21300 If there is no such heading, return nil.
21301 This is like outline-next-sibling, but invisible headings are ok."
21302 (let ((level (funcall outline-level)))
21303 (outline-next-heading)
21304 (while (and (not (eobp)) (> (funcall outline-level) level))
21305 (outline-next-heading))
21306 (if (or (eobp) (< (funcall outline-level) level))
21307 nil
21308 (point))))
21310 (defun org-get-last-sibling ()
21311 "Move to previous heading of the same level, and return point.
21312 If there is no such heading, return nil."
21313 (let ((opoint (point))
21314 (level (funcall outline-level)))
21315 (outline-previous-heading)
21316 (when (and (/= (point) opoint) (outline-on-heading-p t))
21317 (while (and (> (funcall outline-level) level)
21318 (not (bobp)))
21319 (outline-previous-heading))
21320 (if (< (funcall outline-level) level)
21321 nil
21322 (point)))))
21324 (defun org-end-of-subtree (&optional invisible-OK to-heading)
21325 ;; This contains an exact copy of the original function, but it uses
21326 ;; `org-back-to-heading', to make it work also in invisible
21327 ;; trees. And is uses an invisible-OK argument.
21328 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21329 ;; Furthermore, when used inside Org, finding the end of a large subtree
21330 ;; with many children and grandchildren etc, this can be much faster
21331 ;; than the outline version.
21332 (org-back-to-heading invisible-OK)
21333 (let ((first t)
21334 (level (funcall outline-level)))
21335 (if (and (derived-mode-p 'org-mode) (< level 1000))
21336 ;; A true heading (not a plain list item), in Org-mode
21337 ;; This means we can easily find the end by looking
21338 ;; only for the right number of stars. Using a regexp to do
21339 ;; this is so much faster than using a Lisp loop.
21341 (forward-char 1)
21342 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21343 ;; something else, do it the slow way
21344 (while (and (not (eobp))
21345 (or first (> (funcall outline-level) level)))
21346 (setq first nil)
21347 (outline-next-heading)))
21348 (unless to-heading
21350 (progn
21351 ;; Go to end of line before heading
21352 (forward-char -1)
21354 ;; leave blank line before heading
21355 (forward-char -1))))))
21356 (point))
21358 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21359 "Use Org version in org-mode, for dramatic speed-up."
21360 (if (derived-mode-p 'org-mode)
21361 (progn
21362 (org-end-of-subtree nil t)
21363 (unless (eobp) (backward-char 1)))
21364 ad-do-it))
21366 (defun org-end-of-meta-data-and-drawers ()
21367 "Jump to the first text after meta data and drawers in the current entry.
21368 This will move over empty lines, lines with planning time stamps,
21369 clocking lines, and drawers."
21370 (org-back-to-heading t)
21371 (let ((end (save-excursion (outline-next-heading) (point)))
21374 (forward-line 1)
21375 (while (re-search-forward re end t)
21376 (if (not (match-end 1))
21377 ;; empty or planning line
21378 (forward-line 1)
21379 ;; a drawer, find the end
21381 (forward-line 1)))
21383 (point)))
21385 (defun org-forward-same-level (arg &optional invisible-ok)
21386 "Move forward to the arg'th subheading at same level as this one.
21387 Stop at the first and last subheadings of a superior heading.
21388 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
21389 it wil also look at invisible ones."
21390 (interactive "p")
21391 (org-back-to-heading invisible-ok)
21392 (org-at-heading-p)
21393 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21395 l)
21396 (forward-char 1)
21397 (while (> arg 0)
21398 (while (and (re-search-forward re nil 'move)
21399 (setq l (- (match-end 0) (match-beginning 0) 1))
21400 (= l level)
21401 (not invisible-ok)
21402 (progn (backward-char 1) (outline-invisible-p)))
21403 (if (< l level) (setq arg 1)))
21404 (setq arg (1- arg)))
21405 (beginning-of-line 1)))
21407 (defun org-backward-same-level (arg &optional invisible-ok)
21408 "Move backward to the arg'th subheading at same level as this one.
21409 Stop at the first and last subheadings of a superior heading."
21410 (interactive "p")
21411 (org-back-to-heading)
21412 (org-at-heading-p)
21413 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21415 l)
21416 (while (> arg 0)
21417 (while (and (re-search-backward re nil 'move)
21418 (setq l (- (match-end 0) (match-beginning 0) 1))
21419 (= l level)
21420 (not invisible-ok)
21421 (outline-invisible-p))
21422 (if (< l level) (setq arg 1)))
21423 (setq arg (1- arg)))))
21425 (defun org-show-subtree ()
21426 "Show everything after this heading at deeper levels."
21427 (interactive)
21428 (outline-flag-region
21429 (point)
21430 (save-excursion
21431 (org-end-of-subtree t t))
21432 nil))
21434 (defun org-show-entry ()
21435 "Show the body directly following this heading.
21436 Show the heading too, if it is currently invisible."
21437 (interactive)
21438 (save-excursion
21439 (condition-case nil
21440 (progn
21441 (org-back-to-heading t)
21442 (outline-flag-region
21443 (max (point-min) (1- (point)))
21444 (save-excursion
21445 (if (re-search-forward
21447 (match-beginning 1)
21448 (point-max)))
21449 nil)
21450 (org-cycle-hide-drawers 'children))
21451 (error nil))))
21453 (defun org-make-options-regexp (kwds &optional extra)
21454 "Make a regular expression for keyword lines."
21455 (concat
21456 "^"
21463 ;; Make isearch reveal the necessary context
21464 (defun org-isearch-end ()
21465 "Reveal context after isearch exits."
21466 (when isearch-success ; only if search was successful
21467 (if (featurep 'xemacs)
21468 ;; Under XEmacs, the hook is run in the correct place,
21469 ;; we directly show the context.
21470 (org-show-context 'isearch)
21471 ;; In Emacs the hook runs *before* restoring the overlays.
21472 ;; So we have to use a one-time post-command-hook to do this.
21473 ;; (Emacs 22 has a special variable, see function `org-mode')
21474 (unless (and (boundp 'isearch-mode-end-hook-quit)
21475 isearch-mode-end-hook-quit)
21476 ;; Only when the isearch was not quitted.
21477 (org-add-hook 'post-command-hook 'org-isearch-post-command
21478 'append 'local)))))
21480 (defun org-isearch-post-command ()
21481 "Remove self from hook, and show context."
21482 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21483 (org-show-context 'isearch))
21486 ;;;; Integration with and fixes for other packages
21488 ;;; Imenu support
21490 (defvar org-imenu-markers nil
21491 "All markers currently used by Imenu.")
21492 (make-variable-buffer-local 'org-imenu-markers)
21494 (defun org-imenu-new-marker (&optional pos)
21495 "Return a new marker for use by Imenu, and remember the marker."
21496 (let ((m (make-marker)))
21497 (move-marker m (or pos (point)))
21498 (push m org-imenu-markers)
21499 m))
21501 (defun org-imenu-get-tree ()
21502 "Produce the index for Imenu."
21503 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21504 (setq org-imenu-markers nil)
21505 (let* ((n org-imenu-depth)
21506 (re (concat "^" (org-get-limited-outline-regexp)))
21507 (subs (make-vector (1+ n) nil))
21508 (last-level 0)
21509 m level head)
21510 (save-excursion
21511 (save-restriction
21512 (widen)
21513 (goto-char (point-max))
21514 (while (re-search-backward re nil t)
21515 (setq level (org-reduced-level (funcall outline-level)))
21516 (when (and (<= level n)
21517 (looking-at org-complex-heading-regexp))
21518 (setq head (org-link-display-format
21519 (org-match-string-no-properties 4))
21520 m (org-imenu-new-marker))
21521 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21522 (if (>= level last-level)
21523 (push (cons head m) (aref subs level))
21524 (push (cons head (aref subs (1+ level))) (aref subs level))
21525 (loop for i from (1+ level) to n do (aset subs i nil)))
21526 (setq last-level level)))))
21527 (aref subs 1)))
21529 (eval-after-load "imenu"
21530 '(progn
21531 (add-hook 'imenu-after-jump-hook
21532 (lambda ()
21533 (if (derived-mode-p 'org-mode)
21534 (org-show-context 'org-goto))))))
21536 (defun org-link-display-format (link)
21537 "Replace a link with either the description, or the link target
21538 if no description is present"
21539 (save-match-data
21540 (if (string-match org-bracket-link-analytic-regexp link)
21541 (replace-match (if (match-end 5)
21542 (match-string 5 link)
21543 (concat (match-string 1 link)
21544 (match-string 3 link)))
21545 nil t link)
21546 link)))
21548 (defun org-toggle-link-display ()
21549 "Toggle the literal or descriptive display of links."
21550 (interactive)
21551 (if org-descriptive-links
21552 (progn (org-remove-from-invisibility-spec '(org-link))
21553 (org-restart-font-lock)
21554 (setq org-descriptive-links nil))
21555 (progn (add-to-invisibility-spec '(org-link))
21556 (org-restart-font-lock)
21557 (setq org-descriptive-links t))))
21559 ;; Speedbar support
21561 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21562 "Overlay marking the agenda restriction line in speedbar.")
21563 (overlay-put org-speedbar-restriction-lock-overlay
21564 'face 'org-agenda-restriction-lock)
21565 (overlay-put org-speedbar-restriction-lock-overlay
21566 'help-echo "Agendas are currently limited to this item.")
21567 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21569 (defun org-speedbar-set-agenda-restriction ()
21570 "Restrict future agenda commands to the location at point in speedbar.
21572 (interactive)
21573 (require 'org-agenda)
21574 (let (p m tp np dir txt)
21575 (cond
21576 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21577 'org-imenu t))
21578 (setq m (get-text-property p 'org-imenu-marker))
21579 (with-current-buffer (marker-buffer m)
21580 (goto-char m)
21581 (org-agenda-set-restriction-lock 'subtree)))
21582 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21583 'speedbar-function 'speedbar-find-file))
21584 (setq tp (previous-single-property-change
21585 (1+ p) 'speedbar-function)
21586 np (next-single-property-change
21587 tp 'speedbar-function)
21588 dir (speedbar-line-directory)
21589 txt (buffer-substring-no-properties (or tp (point-min))
21590 (or np (point-max))))
21591 (with-current-buffer (find-file-noselect
21592 (let ((default-directory dir))
21593 (expand-file-name txt)))
21594 (unless (derived-mode-p 'org-mode)
21595 (error "Cannot restrict to non-Org-mode file"))
21596 (org-agenda-set-restriction-lock 'file)))
21597 (t (error "Don't know how to restrict Org-mode's agenda")))
21598 (move-overlay org-speedbar-restriction-lock-overlay
21599 (point-at-bol) (point-at-eol))
21600 (setq current-prefix-arg nil)
21601 (org-agenda-maybe-redo)))
21603 (eval-after-load "speedbar"
21604 '(progn
21605 (speedbar-add-supported-extension ".org")
21606 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21607 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21608 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21609 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21610 (add-hook 'speedbar-visiting-tag-hook
21611 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
21613 ;;; Fixes and Hacks for problems with other packages
21615 ;; Make flyspell not check words in links, to not mess up our keymap
21616 (defun org-mode-flyspell-verify ()
21617 "Don't let flyspell put overlays at active buttons, or on
21618 {todo,all-time,additional-option-like}-keywords."
21619 (let ((pos (max (1- (point)) (point-min)))
21620 (word (thing-at-point 'word)))
21621 (and (not (get-text-property pos 'keymap))
21622 (not (get-text-property pos 'org-no-flyspell))
21623 (not (member word org-todo-keywords-1))
21624 (not (member word org-all-time-keywords))
21625 (not (member word org-additional-option-like-keywords)))))
21627 (defun org-remove-flyspell-overlays-in (beg end)
21628 "Remove flyspell overlays in region."
21629 (and (org-bound-and-true-p flyspell-mode)
21630 (fboundp 'flyspell-delete-region-overlays)
21631 (flyspell-delete-region-overlays beg end))
21632 (add-text-properties beg end '(org-no-flyspell t)))
21634 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21635 (eval-after-load "bookmark"
21636 '(if (boundp 'bookmark-after-jump-hook)
21637 ;; We can use the hook
21638 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21639 ;; Hook not available, use advice
21640 (defadvice bookmark-jump (after org-make-visible activate)
21641 "Make the position visible."
21642 (org-bookmark-jump-unhide))))
21644 ;; Make sure saveplace shows the location if it was hidden
21645 (eval-after-load "saveplace"
21646 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21647 "Make the position visible."
21648 (org-bookmark-jump-unhide)))
21650 ;; Make sure ecb shows the location if it was hidden
21651 (eval-after-load "ecb"
21652 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21653 "Make hierarchy visible when jumping into location from ECB tree buffer."
21654 (if (derived-mode-p 'org-mode)
21655 (org-show-context))))
21657 (defun org-bookmark-jump-unhide ()
21658 "Unhide the current position, to show the bookmark location."
21659 (and (derived-mode-p 'org-mode)
21660 (or (outline-invisible-p)
21661 (save-excursion (goto-char (max (point-min) (1- (point))))
21662 (outline-invisible-p)))
21663 (org-show-context 'bookmark-jump)))
21665 ;; Make session.el ignore our circular variable
21666 (eval-after-load "session"
21667 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21669 ;;;; Experimental code
21671 (defun org-closed-in-range ()
21672 "Sparse tree of items closed in a certain time range.
21673 Still experimental, may disappear in the future."
21674 (interactive)
21675 ;; Get the time interval from the user.
21676 (let* ((time1 (org-float-time
21677 (org-read-date nil 'to-time nil "Starting date: ")))
21678 (time2 (org-float-time
21679 (org-read-date nil 'to-time nil "End date:")))
21680 ;; callback function
21681 (callback (lambda ()
21682 (let ((time
21683 (org-float-time
21684 (apply 'encode-time
21685 (org-parse-time-string
21686 (match-string 1))))))
21687 ;; check if time in interval
21688 (and (>= time time1) (<= time time2))))))
21689 ;; make tree, check each match with the callback
21692 ;;;; Finish up
21694 (provide 'org)
21696 (run-hooks 'org-load-hook)
21698 ;;; org.el ends here