| blob | 816fb7bc15665e70136255bca10174122fa52fc7 |
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
84 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
85 ;; some places -- e.g. see the macro org-with-limited-levels.
86 ;;
87 ;; In Org buffers, the value of `outline-regexp' is that of
88 ;; `org-outline-regexp'. The only function still directly relying on
89 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
90 ;; job when `orgstruct-mode' is active.
95 "Regexp to match Org headlines.
96 This is similar to `org-outline-regexp' but additionally makes
100 "Matches an headline, putting stars and text into groups.
103 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
117 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
146 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
152 ;; load languages based on value of `org-babel-load-languages'
155 ;;;###autoload
157 "Load the languages defined in `org-babel-load-languages'."
169 org-babel-load-languages))
172 "Languages which can be evaluated in Org-mode buffers.
173 This list can be used to load support for any of the languages
174 below, note that each language will depend on a different set of
175 system executables and/or Emacs modes. When a language is
177 with `org-babel-execute-src-block' bound by default to C-c
178 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
179 be set to remove code block evaluation from the C-c C-c
180 keybinding. By default only Emacs Lisp (which has no
181 requirements) is loaded."
186 :key-type
230 ;;;; Customization variables
232 "Remove ID property of clones of a subtree.
233 When non-nil, clones of a subtree don't inherit the ID property.
234 Otherwise they inherit the ID property with a new unique
235 identifier."
240 ;;; Version
244 ;;;###autoload
246 "Show the org-mode version in the echo area.
247 With prefix argument HERE, insert it at point.
248 When FULL is non-nil, use a verbose version string.
249 When MESSAGE is non-nil, display a message with the version."
263 org-version
264 git-version
267 org-install-dir
276 _version)))
280 ;;; Compatibility constants
282 ;;; The custom variables
285 "Outline-based notes management and organizer."
291 "Mode hook for Org-mode, run after the mode was turned on."
296 "Hook that is run after org.el has been loaded."
301 "Hook that is run after an Org log buffer is created."
311 "Load all extensions listed in `org-modules'."
316 org-modules)
320 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
329 (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)
330 "Modules that should always be loaded together with org.el.
331 If a description starts with <C>, the file is not part of Emacs
332 and loading it will require that you have downloaded and properly installed
333 the org-mode distribution.
335 You can also use this system to load external packages (i.e. neither Org
336 core modules, nor modules from the CONTRIB directory). Just add symbols
337 to the end of the list. If the package is called org-xyz.el, then you need
338 to add the symbol `xyz', and the package must have a call to
340 (provide 'org-xyz)"
343 :type
374 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
383 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
392 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
408 "Non-nil means make shift-cursor commands select text when possible.
410 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
411 start selecting a region, or enlarge regions started in this way.
412 In Org-mode, in special contexts, these same keys are used for
413 other purposes, important enough to compete with shift selection.
414 Org tries to balance these needs by supporting `shift-select-mode'
415 outside these special contexts, under control of this variable.
417 The default of this variable is nil, to avoid confusing behavior. Shifted
418 cursor keys will then execute Org commands in the following contexts:
419 - on a headline, changing TODO state (left/right) and priority (up/down)
420 - on a time stamp, changing the time
421 - in a plain list item, changing the bullet type
422 - in a property definition line, switching between allowed values
423 - in the BEGIN line of a clock table (changing the time block).
424 Outside these contexts, the commands will throw an error.
426 When this variable is t and the cursor is not in a special
427 context, Org-mode will support shift-selection for making and
428 enlarging regions. To make this more effective, the bullet
429 cycling will no longer happen anywhere in an item line, but only
430 if the cursor is exactly on the bullet.
432 If you set this variable to the symbol `always', then the keys
433 will not be special in headlines, property lines, and item lines,
434 to make shift selection work there as well. If this is what you
435 want, you can use the following alternative commands: `C-c C-t'
436 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
437 can be used to switch TODO sets, `C-c -' to cycle item bullet
438 types, and properties can be edited by hand or in column view.
440 However, when the cursor is on a timestamp, shift-cursor commands
441 will still edit the time stamp - this is just too good to give up.
443 XEmacs user should have this variable set to nil, because
444 `shift-select-mode' is in Emacs 23 or later only."
452 "Shall some commands act upon headlines in the active region?
454 When set to `t', some commands will be performed in all headlines
455 within the active region.
457 When set to `start-level', some commands will be performed in all
458 headlines within the active region, provided that these headlines
459 are of the same level than the first one.
461 When set to a string, those commands will be performed on the
462 matching headlines within the active region. Such string must be
463 a tags/property/todo match as it is used in the agenda tags view.
465 The list of commands is: `org-schedule', `org-deadline',
466 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
467 `org-archive-to-archive-sibling'. The archiving commands skip
468 already archived entries."
478 "Options concerning startup of Org-mode."
483 "Non-nil means entering Org-mode will switch to OVERVIEW.
484 This can also be configured on a per-file basis by adding one of
485 the following lines anywhere in the buffer:
487 #+STARTUP: fold (or `overview', this is equivalent)
488 #+STARTUP: nofold (or `showall', this is equivalent)
489 #+STARTUP: content
490 #+STARTUP: showeverything"
499 "Non-nil means entering Org-mode will set `truncate-lines'.
500 This is useful since some lines containing links can be very long and
501 uninteresting. Also tables look terrible when wrapped."
506 "Non-nil means turn on `org-indent-mode' on startup.
507 This can also be configured on a per-file basis by adding one of
508 the following lines anywhere in the buffer:
510 #+STARTUP: indent
511 #+STARTUP: noindent"
519 When this option is turned on, you can use TeX-like syntax for sub- and
521 considered as a single item - so grouping with {} is normally not
522 needed. For example, the following things will be parsed as single
523 sub- or superscripts.
525 10^24 or 10^tau several digits will be considered 1 item.
526 10^-12 or 10^-tau a leading sign with digits or a word
527 x^2-y^3 will be read as x^2 - y^3, because items are
528 terminated by almost any nonword/nondigit char.
529 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
531 Still, ambiguity is possible - so when in doubt use {} to enclose the
532 sub/superscript. If you set this variable to the symbol `{}',
533 the braces are *required* in order to trigger interpretations as
535 frequently in plain text.
537 Not all export backends support this, but HTML does.
553 "Non-nil means turn on `org-beamer-mode' on startup.
554 This can also be configured on a per-file basis by adding one of
555 the following lines anywhere in the buffer:
557 #+STARTUP: beamer"
563 "Non-nil means align all tables when visiting a file.
564 This is useful when the column width in tables is forced with <N> cookies
565 in table fields. Such tables will look correct only after the first re-align.
566 This can also be configured on a per-file basis by adding one of
567 the following lines anywhere in the buffer:
568 #+STARTUP: align
569 #+STARTUP: noalign"
574 "Non-nil means show inline images when loading a new Org file.
575 This can also be configured on a per-file basis by adding one of
576 the following lines anywhere in the buffer:
577 #+STARTUP: inlineimages
578 #+STARTUP: noinlineimages"
584 "Non-nil means insert the first line setting Org-mode in empty files.
585 When the function `org-mode' is called interactively in an empty file, this
586 normally means that the file name does not automatically trigger Org-mode.
587 To ensure that the file will always be in Org-mode in the future, a
588 line enforcing Org-mode will be inserted into the buffer, if this option
589 has been set."
594 "Non-nil means use alternative key bindings for some keys.
595 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
596 These keys are also used by other packages like shift-selection-mode'
597 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
598 If you want to use Org-mode together with one of these other modes,
599 or more generally if you would like to move some Org-mode commands to
600 other keys, set this variable and configure the keys with the variable
601 `org-disputed-keys'.
603 This option is only relevant at load-time of Org-mode, and must be set
604 *before* org.el is loaded. Changing it requires a restart of Emacs to
605 become effective."
610 "Non-nil means use extra key sequence definitions for certain commands.
611 This happens automatically if you run XEmacs or if `window-system'
612 is nil. This variable lets you do the same manually. You must
613 set it before loading org.
615 Example: on Carbon Emacs 22 running graphically, with an external
616 keyboard on a Powerbook, the default way of setting M-left might
617 not work for either Alt or ESC. Setting this variable will make
618 it work for ESC."
632 "Keys for which Org-mode and other modes compete.
633 This is an alist, cars are the default keys, second element specifies
634 the alternative to use when `org-replace-disputed-keys' is t.
636 Keys can be specified in any syntax supported by `define-key'.
637 The value of this option takes effect only at Org-mode's startup,
638 therefore you'll have to restart Emacs to apply it after changing."
643 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
644 Or return the original if not disputed.
645 Also apply the translations defined in `org-xemacs-key-equivalents'."
650 org-disputed-keys)))
654 key)
664 "Define a key, possibly translated, as returned by `org-key'."
668 "The ellipsis to use in the Org-mode outline.
669 When nil, just use the standard three dots. When a string, use that instead,
670 When a face, use the standard 3 dots, but with the specified face.
671 The change affects only Org-mode (which will then use its own display table).
672 Changing this requires executing `M-x org-mode' in a buffer to become
673 effective."
683 "Keywords in Org-mode."
688 "String to mark deadline entries.
689 A deadline is this string, followed by a time stamp. Should be a word,
690 terminated by a colon. You can insert a schedule keyword and
692 Changes become only effective after restarting Emacs."
697 "String to mark scheduled TODO entries.
698 A schedule is this string, followed by a time stamp. Should be a word,
699 terminated by a colon. You can insert a schedule keyword and
701 Changes become only effective after restarting Emacs."
706 "String used as the prefix for timestamps logging closing a TODO entry."
711 "String used as prefix for timestamps clocking work hours on an item."
723 "Entries starting with this keyword will never be exported.
724 An entry can be toggled between COMMENT and normal with
726 Changes become only effective after restarting Emacs."
731 "Entries starting with this keyword will be exported in fixed-width font.
732 Quoting applies only to the text in the entry following the headline, and does
733 not extend beyond the next headline, even if that is lower level.
734 An entry can be toggled between QUOTE and normal with
741 "Regular expression for specifying repeated events.
745 "Options concerning the general structure of Org-mode files."
750 "Options about how to make context of a location visible."
774 "Non-nil means show full hierarchy when revealing a location.
775 Org-mode often shows locations in an org-mode file which might have
776 been invisible before. When this is set, the hierarchy of headings
777 above the exposed location is shown.
778 Turning this off for example for sparse trees makes them very compact.
779 Instead of t, this can also be an alist specifying this option for different
780 contexts. Valid contexts are
781 agenda when exposing an entry from the agenda
782 org-goto when using the command `org-goto' on key C-c C-j
783 occur-tree when using the command `org-occur' on key C-c /
784 tags-tree when constructing a sparse tree based on tags matches
785 link-search when exposing search matches associated with a link
786 mark-goto when exposing the jump goal of a mark
787 bookmark-jump when exposing a bookmark location
788 isearch when exiting from an incremental search
789 default default for all contexts not set explicitly"
794 "Non-nil means show following heading when revealing a location.
795 Org-mode often shows locations in an org-mode file which might have
796 been invisible before. When this is set, the heading following the
797 match is shown.
798 Turning this off for example for sparse trees makes them very compact,
799 but makes it harder to edit the location of the match. In such a case,
801 Instead of t, this can also be an alist specifying this option for different
802 contexts. See `org-show-hierarchy-above' for valid contexts."
807 "Non-nil means show all sibling heading when revealing a location.
808 Org-mode often shows locations in an org-mode file which might have
809 been invisible before. When this is set, the sibling of the current entry
810 heading are all made visible. If `org-show-hierarchy-above' is t,
811 the same happens on each level of the hierarchy above the current entry.
813 By default this is on for the isearch context, off for all other contexts.
814 Turning this off for example for sparse trees makes them very compact,
815 but makes it harder to edit the location of the match. In such a case,
817 Instead of t, this can also be an alist specifying this option for different
818 contexts. See `org-show-hierarchy-above' for valid contexts."
823 "Non-nil means show the entry below a headline when revealing a location.
824 Org-mode often shows locations in an org-mode file which might have
825 been invisible before. When this is set, the text below the headline that is
826 exposed is also shown.
828 By default this is off for all contexts.
829 Instead of t, this can also be an alist specifying this option for different
830 contexts. See `org-show-hierarchy-above' for valid contexts."
835 "How should indirect tree buffers be displayed?
836 This applies to indirect buffers created with the commands
838 Valid values are:
839 current-window Display in the current window
840 other-window Just display in another window.
841 dedicated-frame Create one new frame, and re-use it each time.
842 new-frame Make a new frame each time. Note that in this case
843 previously-made indirect buffers are kept, and you need to
844 kill these buffers yourself."
854 "Non-nil means activate single letter commands at beginning of a headline.
855 This may also be a function to test for appropriate locations where speed
856 commands should be active."
864 "Alist of additional speed commands.
865 This list will be checked before `org-speed-commands-default'
866 when the variable `org-use-speed-commands' is non-nil
867 and when the cursor is at the beginning of a headline.
868 The car if each entry is a string with a single letter, which must
869 be assigned to `self-insert-command' in the global map.
870 The cdr is either a command to be called interactively, a function
871 to be called, or a form to be evaluated.
872 An entry that is just a list with a single string will be interpreted
873 as a descriptive headline that will be added when listing the speed
874 commands in the Help buffer using the `?' speed command."
886 "Options concerning visibility cycling in Org-mode."
891 "Non-nil means skip CHILDREN state in entries that don't have any."
896 "Maximum level which should still be subject to visibility cycling.
897 Levels higher than this will, for cycling, be treated as text, not a headline.
898 When `org-odd-levels-only' is set, a value of N in this variable actually
899 means 2N-1 stars as the limiting headline.
900 When nil, cycle all levels.
901 Note that the limiting level of cycling is also influenced by
902 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
903 `org-inlinetask-min-level' is, cycling will be limited to levels one less
904 than its value."
911 "Names of drawers. Drawers are not opened by cycling on the headline above.
912 Drawers only open with a TAB on the drawer line itself. A drawer looks like
913 this:
914 :DRAWERNAME:
915 .....
916 :END:
918 the property API.
920 Drawers can be defined on the per-file basis with a line like:
922 #+DRAWERS: HIDDEN STATE PROPERTIES"
928 "Non-nil means entering Org-mode will fold all blocks.
929 This can also be set in on a per-file basis with
931 #+STARTUP: hideblocks
932 #+STARTUP: showblocks"
938 "Cycle globally if cursor is at beginning of buffer and not at a headline.
939 This makes it possible to do global cycling without having to use S-TAB or
941 of the buffer must not be a headline -- it may be empty or some other text.
942 When used in this way, `org-cycle-hook' is disabled temporarily to make
943 sure the cursor stays at the beginning of the buffer. When this option is
944 nil, don't do anything special at the beginning of the buffer."
949 "Non-nil means cycle entry level or item indentation in new empty entries.
951 When the cursor is at the end of an empty headline, i.e with only stars
952 and maybe a TODO keyword, TAB will then switch the entry to become a child,
953 and then all possible ancestor states, before returning to the original state.
954 This makes data entry extremely fast: M-RET to create a new headline,
955 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
957 When the cursor is at the end of an empty plain list item, one TAB will
958 make it a subitem, two or more tabs will back up to make this an item
959 higher up in the item hierarchy."
964 "Where should `org-cycle' emulate TAB.
965 nil Never
966 white Only in completely white lines
967 whitestart Only at the beginning of lines, before the first non-white char
968 t Everywhere except in headlines
969 exc-hl-bol Everywhere except at the start of a headline
970 If TAB is used in a place where it does not emulate TAB, the current subtree
971 visibility is cycled."
978 ))
981 "Number of empty lines needed to keep an empty line between collapsed trees.
982 If you leave an empty line between the end of a subtree and the following
983 headline, this empty line is hidden when the subtree is folded.
984 Org-mode will leave (exactly) one empty line visible if the number of
985 empty lines is equal or larger to the number given in this variable.
986 So the default 2 means at least 2 empty lines after the end of a subtree
987 are needed to produce free space between a collapsed subtree and the
988 following headline.
990 If the number is negative, and the number of empty lines is at least -N,
991 all empty lines are shown.
993 Special case: when 0, never leave empty lines in collapsed view."
999 "Hook that is run before visibility cycling is happening.
1000 The function(s) in this hook must accept a single argument which indicates
1001 the new state that will be set right after running this hook. The
1002 argument is a symbol. Before a global state change, it can have the values
1003 `overview', `content', or `all'. Before a local state change, it can have
1004 the values `folded', `children', or `subtree'."
1009 org-cycle-hide-drawers
1010 org-cycle-hide-inline-tasks
1011 org-cycle-show-empty-lines
1012 org-optimize-window-after-visibility-change)
1013 "Hook that is run after `org-cycle' has changed the buffer visibility.
1014 The function(s) in this hook must accept a single argument which indicates
1015 the new state that was set by the most recent `org-cycle' command. The
1016 argument is a symbol. After a global state change, it can have the values
1017 `overview', `contents', or `all'. After a local state change, it can have
1018 the values `folded', `children', or `subtree'."
1023 "Options concerning structure editing in Org-mode."
1028 "Non-nil means skip even levels and only use odd levels for the outline.
1029 This has the effect that two stars are being added/taken away in
1030 promotion/demotion commands. It also influences how levels are
1031 handled by the exporters.
1032 Changing it requires restart of `font-lock-mode' to become effective
1033 for fontification also in regions already fontified.
1034 You may also set this on a per-file basis by adding one of the following
1035 lines to the buffer:
1037 #+STARTUP: odd
1038 #+STARTUP: oddeven"
1044 "Non-nil means adapt indentation to outline node level.
1046 When this variable is set, Org assumes that you write outlines by
1047 indenting text in each node to align with the headline (after the stars).
1048 The following issues are influenced by this variable:
1050 - When this is set and the *entire* text in an entry is indented, the
1051 indentation is increased by one space in a demotion command, and
1052 decreased by one in a promotion command. If any line in the entry
1053 body starts with text at column 0, indentation is not changed at all.
1055 - Property drawers and planning information is inserted indented when
1056 this variable s set. When nil, they will not be indented.
1058 - TAB indents a line relative to context. The lines below a headline
1059 will be indented when this variable is set.
1061 Note that this is all about true indentation, by adding and removing
1062 space characters. See also `org-indent.el' which does level-dependent
1063 indentation in a virtual way, i.e. at display time in Emacs."
1068 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1070 When t, `C-a' will bring back the cursor to the beginning of the
1071 headline text, i.e. after the stars and after a possible TODO
1072 keyword. In an item, this will be the position after bullet and
1073 check-box, if any. When the cursor is already at that position,
1074 another `C-a' will bring it to the beginning of the line.
1076 `C-e' will jump to the end of the headline, ignoring the presence
1077 of tags in the headline. A second `C-e' will then jump to the
1078 true end of the line, after any tags. This also means that, when
1079 this variable is non-nil, `C-e' also will never jump beyond the
1080 end of the heading of a folded section, i.e. not after the
1081 ellipses.
1083 When set to the symbol `reversed', the first `C-a' or `C-e' works
1084 normally, going to the true line boundary first. Only a directly
1085 following, identical keypress will bring the cursor to the
1086 special positions.
1088 This may also be a cons cell where the behavior for `C-a' and
1089 `C-e' is set separately."
1108 "Non-nil means `C-k' will behave specially in headlines.
1109 When nil, `C-k' will call the default `kill-line' command.
1110 When t, the following will happen while the cursor is in the headline:
1112 - When the cursor is at the beginning of a headline, kill the entire
1113 line and possible the folded subtree below the line.
1114 - When in the middle of the headline text, kill the headline up to the tags.
1115 - When after the headline text, kill the tags."
1120 "Non-nil means, do not delete a hidden subtree with C-k.
1121 When set to the symbol `error', simply throw an error when C-k is
1122 used to kill (part-of) a headline that has hidden text behind it.
1123 Any other non-nil value will result in a query to the user, if it is
1124 OK to kill that hidden subtree. When nil, kill without remorse."
1133 "Check if in invisible region before inserting or deleting a character.
1134 Valid values are:
1136 nil Do not check, so just do invisible edits.
1137 error Throw an error and do nothing.
1138 show Make point visible, and do the requested edit.
1139 show-and-error Make point visible, then throw an error and abort the edit.
1140 smart Make point visible, and do insertion/deletion if it is
1141 adjacent to visible text and the change feels predictable.
1142 Never delete a previously invisible character or add in the
1143 middle or right after an invisible region. Basically, this
1144 allows insertion and backward-delete right before ellipses.
1145 FIXME: maybe in this case we should not even show?"
1156 "Non-nil means when yanking subtrees, fold them.
1157 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1158 it starts with a heading and all other headings in it are either children
1159 or siblings, then fold all the subtrees. However, do this only if no
1160 text after the yank would be swallowed into a folded tree by this action."
1165 "Non-nil means when yanking subtrees, adjust the level.
1166 With this setting, `org-paste-subtree' is used to insert the subtree, see
1167 this function for details."
1172 "Non-nil means M-RET will split the line at the cursor position.
1173 When nil, it will go to the end of the line before making a
1174 new line.
1175 You may also set this option in a different way for different
1176 contexts. Valid contexts are:
1178 headline when creating a new headline
1179 item when creating a new item
1180 table in a table field
1181 default the value to be used for all contexts not explicitly
1182 customized"
1199 "Non-nil means insert new headings after the current subtree.
1200 When nil, the new heading is created directly after the current line.
1203 for the duration of the command."
1209 "Should `org-insert-heading' leave a blank line before new heading/item?
1210 The value is an alist, with `heading' and `plain-list-item' as CAR,
1211 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1212 which case Org will look at the surrounding headings/items and try to
1213 make an intelligent decision whether to insert a blank line or not.
1215 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1216 set, the setting here is ignored and no empty line is inserted, to avoid
1217 breaking the list structure."
1230 "Hook being run after inserting a new heading."
1236 This currently only means they are never auto-wrapped.
1237 When nil, such lines will be treated like ordinary lines.
1238 See also the QUOTE keyword."
1243 "Non-nil means typing characters in `org-goto' starts incremental search."
1248 "Options concerning sparse trees in Org-mode."
1253 "Non-nil means highlight all matches that define a sparse tree.
1254 The highlights will automatically disappear the next time the buffer is
1255 changed by an edit command."
1260 "Non-nil means any change to the buffer will remove temporary highlights.
1261 Such highlights are created by `org-occur' and `org-clock-display'.
1262 When nil, `C-c C-c needs to be used to get rid of the highlights.
1263 The highlights created by `org-preview-latex-fragment' always need
1264 `C-c C-c' to be removed."
1271 "Hook that is run after `org-occur' has constructed a sparse tree.
1272 This can be used to recenter the window to show as much of the structure
1273 as possible."
1278 "Options concerning imenu and speedbar in Org-mode."
1283 "The maximum level for Imenu access to Org-mode headlines.
1284 This also applied for speedbar access."
1289 "Options concerning tables in Org-mode."
1295 When nil, such lines will be treated like ordinary lines.
1297 When equal to the symbol `optimized', the table editor will be optimized to
1298 do the following:
1299 - Automatic overwrite mode in front of whitespace in table fields.
1300 This makes the structure of the table stay in tact as long as the edited
1301 field does not exceed the column width.
1302 - Minimize the number of realigns. Normally, the table is aligned each time
1303 TAB or RET are pressed to move to another field. With optimization this
1304 happens only if changes to a field might have changed the column width.
1305 Optimization requires replacing the functions `self-insert-command',
1306 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1307 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1308 very good at guessing when a re-align will be necessary, but you can always
1311 If you would like to use the optimized version in Org-mode, but the
1312 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1314 This variable can be used to turn on and off the table editor during a session,
1315 but in order to toggle optimization, a restart is required.
1317 See also the variable `org-table-auto-blank-field'."
1326 "Non-nil means cluster self-insert commands for undo when possible.
1327 If this is set, then, like in the Emacs command loop, 20 consecutive
1328 characters will be undone together.
1329 This is configurable, because there is some impact on typing performance."
1334 "Non-nil means TAB will automatically notice a table.el table.
1335 When it sees such a table, it moves point into it and - if necessary -
1336 calls `table-recognize-table'."
1341 "Options concerning links in Org-mode."
1346 "Buffer-local version of `org-link-abbrev-alist', which see.
1351 "Alist of link abbreviations.
1352 The car of each element is a string, to be replaced at the start of a link.
1354 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1356 [[linkkey:tag][description]]
1358 The 'linkkey' must be a word word, starting with a letter, followed
1359 by letters, numbers, '-' or '_'.
1361 If REPLACE is a string, the tag will simply be appended to create the link.
1364 at that point (see the function `url-hexify-string'). If the string contains
1366 be invoked: this function takes the tag as its only argument and must return
1367 a string.
1369 REPLACE may also be a function that will be called with the tag as the
1370 only argument to create the link, which should be returned as a string.
1372 See the manual for examples."
1382 "Non-nil means Org will display descriptive links.
1383 E.g. [[http://orgmode.org][Org website]] will be displayed as
1385 description. When set to `nil', Org will display the full links
1386 literally.
1388 You can interactively set the value of this variable by calling
1389 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1394 "How the path name in file links should be stored.
1395 Valid values are:
1397 relative Relative to the current directory, i.e. the directory of the file
1398 into which the link is being inserted.
1399 absolute Absolute path, if possible with ~ for home directory.
1400 noabbrev Absolute path, no abbreviation of home directory.
1401 adaptive Use relative path for files in the current directory and sub-
1402 directories of it. For other files, use an absolute path."
1411 "Types of links that should be activated in Org-mode files.
1412 This is a list of symbols, each leading to the activation of a certain link
1413 type. In principle, it does not hurt to turn on most link types - there may
1414 be a small gain when turning off unused link types. The types are:
1416 bracket The recommended [[link][description]] or [[link]] links with hiding.
1417 angle Links in angular brackets that may contain whitespace like
1418 <bbdb:Carsten Dominik>.
1419 plain Plain links in normal text, no whitespace, like http://google.com.
1420 radio Text that is matched by a radio target, see manual for details.
1421 tag Tag settings in a headline (link to tag search).
1422 date Time stamps (link to calendar).
1423 footnote Footnote labels.
1425 Changing this variable requires a restart of Emacs to become effective."
1437 "Function to use for generating link descriptions from links.
1438 When nil, the link location will be used. This function must take
1439 two parameters: the first one is the link, the second one is the
1440 description generated by `org-insert-link'. The function should
1441 return the description to use."
1446 "Options concerning storing links in Org-mode."
1451 "When non-nil, hexify URL when creating a link."
1457 "Format of the description part of a link to an email or usenet message.
1458 The following %-escapes will be replaced by corresponding information:
1466 %s subject
1467 %d date
1468 %m message-id.
1470 You may use normal field width specification between the % and the letter.
1471 This is for example useful to limit the length of the subject.
1485 It should match if the message is from the user him/herself."
1490 "Non-nil means file links from `org-store-link' contain context.
1491 A search string will be added to the file name with :: as separator and
1492 used to find the context when the link is activated by the command
1493 `org-open-at-point'. When this option is t, the entire active region
1494 will be placed in the search string of the file link. If set to a
1495 positive integer, only the first n lines of context will be stored.
1498 negates this setting for the duration of the command."
1503 "Non-nil means keep link in list for entire session.
1505 The command `org-store-link' adds a link pointing to the current
1506 location to an internal list. These links accumulate during a session.
1507 The command `org-insert-link' can be used to insert links into any
1508 Org-mode file (offering completion for all stored links). When this
1510 will be removed from the list, to make completing the unused links
1511 more efficient."
1516 "Options concerning following links in Org-mode."
1521 "Function to translate links with different syntax to Org syntax.
1522 This can be used to translate links created for example by the Planner
1523 or emacs-wiki packages to Org syntax.
1524 The function must accept two parameters, a TYPE containing the link
1526 which is everything after the link protocol. It should return a cons
1527 with possibly modified values of type and path.
1528 Org contains a function for this, so if you set this variable to
1529 `org-translate-link-from-planner', you should be able follow many
1530 links created by planner."
1535 "Hook that is run after a link has been followed."
1540 "Non-nil means on links TAB will follow the link.
1541 Needs to be set before org.el is loaded.
1542 This really should not be used, it does not make sense, and the
1543 implementation is bad."
1548 "Non-nil means on links RET will follow the link."
1554 "Non-nil means mouse-1 on a link will follow the link.
1555 A longer mouse click will still set point. Does not work on XEmacs.
1556 Needs to be set before org.el is loaded."
1561 "Number of different positions to be recorded in the ring.
1562 Changing this requires a restart of Emacs to work correctly."
1567 "Non-nil means internal links in Org files must exactly match a headline.
1568 When nil, the link search tries to match a phrase with all words
1569 in the search text."
1576 query-to-create)))
1584 "Setup the frame configuration for following links.
1585 When following a link with Emacs, it may often be useful to display
1586 this link in another window or frame. This variable can be used to
1587 set this up for the different types of links.
1588 For VM, use any of
1589 `vm-visit-folder'
1590 `vm-visit-folder-other-window'
1591 `vm-visit-folder-other-frame'
1592 For Gnus, use any of
1593 `gnus'
1594 `gnus-other-frame'
1595 `org-gnus-no-new-news'
1596 For FILE, use any of
1597 `find-file'
1598 `find-file-other-window'
1599 `find-file-other-frame'
1600 For Wanderlust use any of
1601 `wl'
1602 `wl-other-frame'
1603 For the calendar, use the variable `calendar-setup'.
1604 For BBDB, it is currently only possible to display the matches in
1605 another window."
1629 "Non-nil means use indirect buffer to display infile links.
1630 Activating internal links (from one location in a file to another location
1631 in the same file) normally just jumps to the location. When the link is
1633 is displayed in
1634 another window. When this option is set, the other window actually displays
1635 an indirect buffer clone of the current buffer, to avoid any visibility
1636 changes to the current buffer."
1641 "Non-nil means `org-open-file' will open non-existing files.
1642 When nil, an error will be generated.
1643 This variable applies only to external applications because they
1644 might choke on non-existing files. If the link is to a file that
1645 will be opened in Emacs, the variable is ignored."
1650 "Non-nil means a link to a directory really means to index.org.
1651 When nil, following a directory link will run dired or open a finder/explorer
1652 window on that directory."
1657 "Function and arguments to call for following mailto links.
1658 This is a list with the first element being a Lisp function, and the
1659 remaining elements being arguments to the function. In string arguments,
1660 %a will be replaced by the address, and %s will be replaced by the subject
1661 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1670 "Non-nil means ask for confirmation before executing shell links.
1671 Shell links can be dangerous: just think about a link
1673 [[shell:rm -rf ~/*][Google Search]]
1676 but really it would remove your entire home directory.
1677 Therefore we advise against setting this variable to nil.
1678 Just change it to `y-or-n-p' if you want to confirm with a
1686 'safe-local-variable
1690 "A regexp to skip confirmation for shell links."
1696 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1697 Elisp links can be dangerous: just think about a link
1702 but really it would remove your entire home directory.
1703 Therefore we advise against setting this variable to nil.
1704 Just change it to `y-or-n-p' if you want to confirm with a
1712 'safe-local-variable
1716 "A regexp to skip confirmation for Elisp links."
1725 "Default file applications on a UNIX or GNU/Linux system.
1736 "Default file applications on a MacOS X system.
1738 for some files for which the OS does not have a good default.
1746 'mswindows-shell-execute
1751 'mswindows-shell-execute
1754 "Default file applications on a Windows NT system.
1759 '(
1764 )
1765 "External applications for opening `file:path' items in a document.
1766 Org-mode uses system defaults for different file types, but
1767 you can use this variable to set the application for a given file
1768 extension. The entries in this list are cons cells where the car identifies
1769 files and the cdr the corresponding command. Possible values for the
1770 file identifier are
1772 ways, depending on its contents:
1774 - Alphanumeric characters only:
1775 Match links with this file extension.
1777 to open PDFs with evince.
1779 - Regular expression: Match links where the
1780 filename matches the regexp. If you want to
1781 use groups here, use shy groups.
1785 to open *.html and *.xhtml with firefox.
1787 - Regular expression which contains (non-shy) groups:
1789 anything after that, matches the regexp.
1790 In a custom command string, %1, %2, etc. are replaced with
1791 the parts of the link that were matched by the groups.
1792 For backwards compatibility, if a command string is given
1793 that does not use any of the group matches, this case is
1794 handled identically to the second one (i.e. match against
1795 file name only).
1796 In a custom lisp form, you can access the group matches with
1797 (match-string n link).
1800 to open [[file:document.pdf::5]] with evince at page 5.
1802 `directory' Matches a directory
1803 `remote' Matches a remote file, accessible through tramp or efs.
1804 Remote files most likely should be visited through Emacs
1805 because external applications cannot handle such paths.
1806 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1807 so all files Emacs knows how to handle. Using this with
1808 command `emacs' will open most files in Emacs. Beware that this
1809 will also open html files inside Emacs, unless you add
1811 t Default for files not matched by any of the other options.
1812 `system' The system command to open files, like `open' on Windows
1813 and Mac OS X, and mailcap under GNU/Linux. This is the command
1814 that will be selected if you call `C-c C-o' with a double
1817 Possible values for the command are:
1818 `emacs' The file will be visited by the current Emacs process.
1819 `default' Use the default application for this file type, which is the
1820 association for t in the list, most likely in the system-specific
1821 part.
1822 This can be used to overrule an unwanted setting in the
1823 system-specific variable.
1825 This command is specified by the entry whose car is `system'.
1826 Most likely, the system-specific version of this variable
1827 does define this command, but you can overrule/replace it
1828 here.
1829 string A command to be executed by a shell; %s will be replaced
1830 by the path to the file.
1831 sexp A Lisp form which will be evaluated. The file path will
1832 be available in the Lisp variable `file'.
1833 For more examples, see the system specific constants
1834 `org-file-apps-defaults-macosx'
1835 `org-file-apps-defaults-windowsnt'
1836 `org-file-apps-defaults-gnu'."
1846 auto-mode))
1855 "The URL of the DOI server."
1861 "Options concerning refiling entries in Org-mode."
1866 "Directory with org files.
1867 This is just a default location to look for Org files. There is no need
1868 at all to put your files into this directory. It is only used in the
1869 following situations:
1871 1. When a capture template specifies a target file that is not an
1872 absolute path. The path will then be interpreted relative to
1873 `org-directory'
1874 2. When a capture note is filed away in an interactive way (when exiting the
1875 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1876 with `org-directory' as the default path."
1883 "Default target for storing notes.
1884 Used as a fall back file for org-remember.el and org-capture.el, for
1885 templates that do not specify a target file."
1891 file))
1894 "The default interface to be used for `org-goto'.
1895 Allowed values are:
1896 outline The interface shows an outline of the relevant file
1897 and the correct heading is found by moving through
1898 the outline or by searching with incremental search.
1899 outline-path-completion Headlines in the current buffer are offered via
1900 completion. This is the interface also used by
1901 the refile command."
1908 "Maximum target level when running `org-goto' with refile interface."
1913 "Non-nil means store new notes at the beginning of a file or entry.
1914 When nil, new notes will be filed to the end of a file or entry.
1915 This can also be a list with cons cells of regular expressions that
1916 are matched against file names, and values."
1927 "Information to record when a task is refiled.
1929 Possible values are:
1931 nil Don't add anything
1932 time Add a time stamp to the task
1933 note Prompt for a note and add it with template `org-log-note-headings'
1935 This option can also be set with on a per-file-basis with
1937 #+STARTUP: nologrefile
1938 #+STARTUP: logrefile
1939 #+STARTUP: lognoterefile
1941 You can have local logging settings for a subtree by setting the LOGGING
1942 property to one or more of these keywords.
1944 When bulk-refiling from the agenda, the value `note' is forbidden and
1945 will temporarily be changed to `time'."
1956 This is a list of cons cells. Each cell contains:
1957 - a specification of the files to be considered, either a list of files,
1958 or a symbol whose function or variable value will be used to retrieve
1959 a file name or a list of file names. If you use `org-agenda-files' for
1960 that, all agenda files will be scanned for targets. Nil means consider
1961 headings in the current buffer.
1962 - A specification of how to find candidate refile targets. This may be
1963 any of:
1965 This tag has to be present in all target headlines, inheritance will
1966 not be considered.
1968 todo keyword.
1970 headlines that are refiling targets.
1971 - a cons cell (:level . N). Any headline of level N is considered a target.
1972 Note that, when `org-odd-levels-only' is set, level corresponds to
1973 order in hierarchy, not to the number of stars.
1974 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1975 Note that, when `org-odd-levels-only' is set, level corresponds to
1976 order in hierarchy, not to the number of stars.
1978 Each element of this list generates a set of possible targets.
1979 The union of these sets is presented (with completion) to
1980 the user by `org-refile'.
1982 You can set the variable `org-refile-target-verify-function' to a function
1983 to verify each headline found by the simple criteria above.
1985 When this variable is nil, all top-level headlines in the current buffer
1986 are used, equivalent to the value `((nil . (:level . 1))'."
2002 "Function to verify if the headline at point should be a refile target.
2003 The function will be called without arguments, with point at the
2004 beginning of the headline. It should return t and leave point
2005 where it is if the headline is a valid target for refiling.
2007 If the target should not be selected, the function must return nil.
2008 In addition to this, it may move point to a place from where the search
2009 should be continued. For example, the function may decide that the entire
2010 subtree of the current entry should be excluded and move point to the end
2011 of the subtree."
2016 "Non-nil means cache refile targets to speed up the process.
2017 The cache for a particular file will be updated automatically when
2018 the buffer has been killed, or when any of the marker used for flagging
2019 refile targets no longer points at a live buffer.
2020 If you have added new entries to a buffer that might themselves be targets,
2021 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2022 find that easier, `C-u C-u C-u C-c C-w'."
2028 "Non-nil means provide refile targets as paths.
2029 So a level 3 headline will be available as level1/level2/level3.
2031 When the value is `file', also include the file name (without directory)
2032 into the path. In this case, you can also stop the completion after
2033 the file name, to get entries inserted as top level in the file.
2035 When `full-file-path', include the full file path."
2044 "Non-nil means complete the outline path in hierarchical steps.
2045 When Org-mode uses the refile interface to select an outline path
2046 \(see variable `org-refile-use-outline-path'), the completion of
2047 the path can be done is a single go, or if can be done in steps down
2048 the headline hierarchy. Going in steps is probably the best if you
2049 do not use a special completion package like `ido' or `icicles'.
2050 However, when using these packages, going in one step can be very
2051 fast, while still showing the whole path to the entry."
2056 "Non-nil means allow to create new nodes as refile targets.
2058 of an existing node. When the value of this variable is `confirm',
2059 new node creation must be confirmed by the user (recommended)
2060 When nil, the completion must match an existing entry.
2062 Note that, if the new heading is not seen by the criteria
2063 listed in `org-refile-targets', multiple instances of the same
2064 heading would be created by trying again to file under the new
2065 heading."
2073 "Non-nil means also refile active region within a subtree.
2075 By default `org-refile' doesn't allow refiling regions if they
2076 don't contain a set of subtrees, but it might be convenient to
2077 do so sometimes: in that case, the first line of the region is
2078 converted to a headline before refiling."
2084 "Options concerning TODO items in Org-mode."
2089 "Options concerning Progress logging in Org-mode."
2096 "The available interpretation symbols for customizing `org-todo-keywords'.
2100 "List of TODO entry keyword sequences and their interpretation.
2103 Each sequence starts with a symbol, either `sequence' or `type',
2104 indicating if the keywords should be interpreted as a sequence of
2105 action steps, or as different types of TODO items. The first
2106 keywords are states requiring action - these states will select a headline
2107 for inclusion into the global TODO list Org-mode produces. If one of
2110 the last keyword is treated as the only DONE state of the sequence.
2113 additional state where no keyword is present. For details about this
2114 cycling, see the manual.
2116 TODO keywords and interpretation can also be set on a per-file basis with
2117 the special #+SEQ_TODO and #+TYP_TODO lines.
2119 Each keyword can optionally specify a character for fast state selection
2120 \(in combination with the variable `org-use-fast-todo-selection')
2121 and specifiers for state change logging, using the same syntax that
2124 indicates to record a time stamp each time this state is selected.
2126 Each keyword may also specify if a timestamp or a note should be
2127 recorded when entering or leaving the state, by adding additional
2128 characters in the parenthesis after the keyword. This looks like this:
2130 record only the time of the state change. With X and Y being either
2132 Y when leaving the state if and only if the *target* state does not
2133 define X. You may omit any of the fast-selection key or X or /Y,
2134 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2136 For backward compatibility, this variable may also be just a list
2137 of keywords. In this case the interpretation (sequence or type) will be
2138 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2148 ;;Quick and dirty way to see
2149 ;;`org-todo-interpretations'. This takes the
2150 ;;place of item arguments
2151 :convert-widget
2158 org-todo-interpretation-widgets))
2159 widget))
2190 "Controls how TODO keywords are interpreted.
2191 This variable is in principle obsolete and is only used for
2192 backward compatibility, if the interpretation of todo keywords is
2193 not given already in `org-todo-keywords'. See that variable for
2194 more information."
2201 "Non-nil means use the fast todo selection scheme with C-c C-t.
2202 This variable describes if and under what circumstances the cycling
2203 mechanism for TODO keywords will be replaced by a single-key, direct
2204 selection scheme.
2206 When nil, fast selection is never used.
2208 When the symbol `prefix', it will be used when `org-todo' is called
2209 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2210 `C-u t' in an agenda buffer.
2212 When t, fast selection is used by default. In this case, the prefix
2213 argument forces cycling instead.
2215 In all cases, the special interface is only used if access keys have
2216 actually been assigned by the user, i.e. if keywords in the configuration
2217 are followed by a letter in parenthesis, like TODO(t)."
2225 "Non-nil means update todo statistics after insert and toggle.
2226 ALL-HEADLINES means update todo statistics by including headlines
2227 with no TODO keyword as well, counting them as not done.
2228 A list of TODO keywords means the same, but skip keywords that are
2229 not in this list.
2231 When this is set, todo statistics is updated in the parent of the
2232 current entry each time a todo state is changed."
2242 "Non-nil means TODO statistics covers just direct children.
2243 When nil, all entries in the subtree are considered.
2244 This has only an effect if `org-provide-todo-statistics' is set.
2245 To set this to nil for only a single subtree, use a COOKIE_DATA
2251 "Hook which is run after the state of a TODO item was changed.
2252 The new state (a string with a TODO keyword, or nil) is available in the
2253 Lisp variable `org-state'."
2258 "Hook for functions that are allowed to block a state change.
2260 Each function gets as its single argument a property list, see
2261 `org-trigger-hook' for more information about this list.
2263 If any of the functions in this hook returns nil, the state change
2267 "Hook for functions that are triggered by a state change.
2269 Each function gets as its single argument a property list with at least
2270 the following elements:
2272 (:type type-of-change :position pos-at-entry-start
2273 :from old-state :to new-state)
2275 Depending on the type, more properties may be present.
2277 This mechanism is currently implemented for:
2279 TODO state changes
2280 ------------------
2281 :type todo-state-change
2282 :from previous state (keyword as a string), or nil, or a symbol
2283 'todo' or 'done', to indicate the general type of state.
2287 "Non-nil means undone TODO entries will block switching the parent to DONE.
2288 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2289 be blocked if any prior sibling is not yet done.
2290 Finally, if the parent is blocked because of ordered siblings of its own,
2291 the child will also be blocked."
2303 "Non-nil means unchecked boxes will block switching the parent to DONE.
2304 When this is nil, checkboxes have no influence on switching TODO states.
2305 When non-nil, you first need to check off all check boxes before the TODO
2306 entry can be switched to DONE.
2307 This variable needs to be set before org.el is loaded, and you need to
2308 restart Emacs after a change to make the change effective. The only way
2309 to change is while Emacs is running is through the customize interface."
2321 "Non-nil means inserting a TODO heading is treated as state change.
2323 logging will apply if appropriate. When nil, the new TODO item will
2324 be inserted directly, and no logging will take place."
2329 "Non-nil means switching TODO states with S-cursor counts as state change.
2330 This is the default behavior. However, setting this to nil allows a
2331 convenient way to select a TODO state and bypass any logging associated
2332 with that."
2337 "Tag changes that should be triggered by TODO state changes.
2338 This is a list. Each entry is
2340 (state-change (tag . flag) .......)
2342 State-change can be a string with a state, and empty string to indicate the
2343 state that has no TODO keyword, or it can be one of the symbols `todo'
2344 or `done', meaning any not-done or done state, respectively."
2358 "Information to record when a task moves to the DONE state.
2360 Possible values are:
2362 nil Don't add anything, just change the keyword
2363 time Add a time stamp to the task
2364 note Prompt for a note and add it with template `org-log-note-headings'
2366 This option can also be set with on a per-file-basis with
2368 #+STARTUP: nologdone
2369 #+STARTUP: logdone
2370 #+STARTUP: lognotedone
2372 You can have local logging settings for a subtree by setting the LOGGING
2373 property to one or more of these keywords."
2381 ;; Normalize old uses of org-log-done.
2388 "Information to record when the scheduling date of a tasks is modified.
2390 Possible values are:
2392 nil Don't add anything, just change the date
2393 time Add a time stamp to the task
2394 note Prompt for a note and add it with template `org-log-note-headings'
2396 This option can also be set with on a per-file-basis with
2398 #+STARTUP: nologreschedule
2399 #+STARTUP: logreschedule
2400 #+STARTUP: lognotereschedule"
2409 "Information to record when the deadline date of a tasks is modified.
2411 Possible values are:
2413 nil Don't add anything, just change the date
2414 time Add a time stamp to the task
2415 note Prompt for a note and add it with template `org-log-note-headings'
2417 This option can also be set with on a per-file-basis with
2419 #+STARTUP: nologredeadline
2420 #+STARTUP: logredeadline
2421 #+STARTUP: lognoteredeadline
2423 You can have local logging settings for a subtree by setting the LOGGING
2424 property to one or more of these keywords."
2433 "Non-nil means record a note when clocking out of an item.
2434 This can also be configured on a per-file basis by adding one of
2435 the following lines anywhere in the buffer:
2437 #+STARTUP: lognoteclock-out
2438 #+STARTUP: nolognoteclock-out"
2444 "Non-nil means the CLOSED time stamp will contain date and time.
2445 When nil, only the date will be recorded."
2459 "Headings for notes added to entries.
2460 The value is an alist, with the car being a symbol indicating the note
2461 context, and the cdr is the heading to be used. The heading may also be the
2462 empty string.
2463 %t in the heading will be replaced by a time stamp.
2464 %T will be an active time stamp instead the default inactive one
2465 %d will be replaced by a short-format time stamp.
2466 %D will be replaced by an active short-format time stamp.
2467 %s will be replaced by the new TODO state, in double quotes.
2468 %S will be replaced by the old TODO state, in double quotes.
2469 %u will be replaced by the user name.
2470 %U will be replaced by the full user name.
2472 In fact, it is not a good idea to change the `state' entry, because
2473 agenda log mode depends on the format of these entries."
2479 "Heading when changing todo state (todo sequence only)"
2493 "Non-nil means insert state change notes and time stamps into a drawer.
2494 When nil, state changes notes will be inserted after the headline and
2495 any scheduling and clock lines, but not inside a drawer.
2497 The value of this variable should be the name of the drawer to use.
2498 LOGBOOK is proposed as the default drawer for this purpose, you can
2499 also set this to a string to define the drawer of your choice.
2503 If this variable is set, `org-log-state-notes-insert-after-drawers'
2504 will be ignored.
2506 You can set the property LOG_INTO_DRAWER to overrule this setting for
2507 a subtree."
2519 "Return the value of `org-log-into-drawer', but let properties overrule.
2520 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2521 used instead of the default value."
2530 "Non-nil means insert state change notes after any drawers in entry.
2531 Only the drawers that *immediately* follow the headline and the
2532 deadline/scheduled line are skipped.
2533 When nil, insert notes right after the heading and perhaps the line
2534 with deadline/scheduling if present.
2536 This variable will have no effect if `org-log-into-drawer' is
2537 set."
2543 "Non-nil means the latest state note will be directly after heading.
2544 When nil, the state change notes will be ordered according to time."
2550 "The TODO state to which a repeater should return the repeating task.
2551 By default this is the first task in a TODO sequence, or the previous state
2552 in a TODO_TYP set. But you can specify another task here.
2553 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2560 "Non-nil means record moving through the DONE state when triggering repeat.
2561 An auto-repeating task is immediately switched back to TODO when
2564 record a closing note, there will be no record of the task moving
2565 through DONE. This variable forces taking a note anyway.
2567 nil Don't force a record
2568 time Record a time stamp
2569 note Prompt for a note and add it with template `org-log-note-headings'
2571 This option can also be set with on a per-file-basis with
2573 #+STARTUP: nologrepeat
2574 #+STARTUP: logrepeat
2575 #+STARTUP: lognoterepeat
2577 You can have local logging settings for a subtree by setting the LOGGING
2578 property to one or more of these keywords."
2588 "Priorities in Org-mode."
2593 "Non-nil means priority commands are active.
2594 When nil, these commands will be disabled, so that you never accidentally
2595 set a priority."
2600 "The highest priority of TODO items. A character like ?A, ?B etc.
2601 Must have a smaller ASCII number than `org-lowest-priority'."
2606 "The lowest priority of TODO items. A character like ?A, ?B etc.
2607 Must have a larger ASCII number than `org-highest-priority'."
2612 "The default priority of TODO items.
2613 This is the priority an item gets if no explicit priority is given.
2614 When starting to cycle on an empty priority the first step in the cycle
2615 depends on `org-priority-start-cycle-with-default'. The resulting first
2616 step priority must not exceed the range from `org-highest-priority' to
2617 `org-lowest-priority' which means that `org-default-priority' has to be
2618 in this range exclusive or inclusive the range boundaries. Else the
2619 first step refuses to set the default and the second will fall back
2620 to (depending on the command used) the highest or lowest priority."
2625 "Non-nil means start with default priority when starting to cycle.
2626 When this is nil, the first step in the cycle will be (depending on the
2627 command used) one higher or lower than the default priority.
2628 See also `org-default-priority'."
2633 "Function to extract the priority from a string.
2634 The string is normally the headline. If this is nil Org computes the
2635 priority from the priority cookie like [#A] in the headline. It returns
2636 an integer, increasing by 1000 for each priority level.
2637 The user can set a different function here, which should take a string
2638 as an argument and return the numeric priority."
2644 "Options concerning time stamps and deadlines in Org-mode."
2649 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2650 When nil, these labeled time stamps are forces into the second line of an
2651 entry, just after the headline. When scheduling from the global TODO list,
2652 the time stamp will always be forced into the second line."
2657 "Formats for `format-time-string' which are used for time stamps.
2661 "Number of minutes to round time stamps to.
2662 These are two values, the first applies when first creating a time stamp.
2663 The second applies when changing it with the commands `S-up' and `S-down'.
2664 When changing the time stamp, this means that it will change in steps
2665 of N minutes, as given by the second value.
2667 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2668 numbers should be factors of 60, so for example 5, 10, 15.
2670 When this is larger than 1, you can still force an exact time stamp by using
2671 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2672 and by using a prefix arg to `S-up/down' to specify the exact number
2673 of minutes to shift."
2683 ;; Normalize old customizations of this variable.
2687 org-time-stamp-rounding-minutes)))
2690 "Non-nil means overlay custom formats over all time stamps.
2691 The formats are defined through the variable `org-time-stamp-custom-formats'.
2692 To turn this on on a per-file basis, insert anywhere in the file:
2693 #+STARTUP: customtime"
2701 "Custom formats for time stamps. See `format-time-string' for the syntax.
2702 These are overlaid over the default ISO format if the variable
2703 `org-display-custom-times' is set. Time like %H:%M should be at the
2704 end of the second format. The custom formats are also honored by export
2705 commands, if custom time display is turned on at the time of export."
2710 "Get the right format for a time string."
2715 f)))
2719 "The format string used when creating CLOCKSUM lines.
2720 This is also used when Org mode generates a time duration.
2722 The value can be a single format string containing two
2723 %-sequences, which will be filled with the number of hours and
2724 minutes in that order.
2726 Alternatively, the value can be a plist associating any of the
2727 keys :years, :months, :weeks, :days, :hours or :minutes with
2728 format strings. The time duration is formatted using only the
2729 time components that are needed and concatenating the results.
2730 If a time unit in absent, it falls back to the next smallest
2731 unit.
2733 The keys :require-years, :require-months, :require-days,
2734 :require-weeks, :require-hours, :require-minutes are also
2735 meaningful. A non-nil value for these keys indicates that the
2736 corresponding time component should always be included, even if
2737 its value is 0.
2740 For example,
2743 :require-minutes t)
2745 means durations longer than a day will be expressed in days,
2746 hours and minutes, and durations less than a day will always be
2747 expressed in hours and minutes (even for durations less than an
2748 hour).
2750 The value
2754 means durations longer than a day will be expressed in days and
2755 minutes, and durations less than a day will be expressed entirely
2756 in minutes (even for durations longer than an hour)."
2793 org-mode generates a time duration."
2798 "The format string used when creating CLOCKSUM lines,
2799 or when Org mode generates a time duration, if
2800 `org-time-clocksum-use-fractional' is enabled.
2802 The value can be a single format string containing one
2803 %-sequence, which will be filled with the number of hours as
2804 a float.
2806 Alternatively, the value can be a plist associating any of the
2807 keys :years, :months, :weeks, :days, :hours or :minutes with
2808 a format string. The time duration is formatted using the
2809 largest time unit which gives a non-zero integer part. If all
2810 specified formats have zero integer part, the smallest time unit
2811 is used."
2828 "No. of days before expiration during which a deadline becomes active.
2829 This variable governs the display in sparse trees and in the agenda.
2830 When 0 or negative, it means use this number (the absolute value of it)
2831 even if a deadline has a different individual lead time specified.
2833 Custom commands can set this variable in the options section."
2839 "Non-nil means assume future for incomplete date input from user.
2840 This affects the following situations:
2841 1. The user gives a month but not a year.
2844 2. The user gives a day, but no month.
2847 it will be considered as *this* month.
2849 If you set this variable to the symbol `time', then also the following
2850 will work:
2852 3. If the user gives a time.
2853 If the time is before now, it will be interpreted as tomorrow.
2855 Currently none of this works for ISO week specifications.
2857 When this option is nil, the current day, month and year will always be
2858 used as defaults.
2860 See also `org-agenda-jump-prefer-future'."
2868 "Should the agenda jump command prefer the future for incomplete dates?
2869 The default is to do the same as configured in `org-read-date-prefer-future'.
2870 But you can also set a deviating value here.
2871 This may t or nil, or the symbol `org-read-date-prefer-future'."
2877 org-read-date-prefer-future)
2882 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2884 Depending on the system Emacs is running on, certain dates cannot
2885 be represented with the type used internally to represent time.
2886 Dates between 1970-1-1 and 2038-1-1 can always be represented
2887 correctly. Some systems allow for earlier dates, some for later,
2888 some for both. One way to find out it to insert any date into an
2889 Org buffer, putting the cursor on the year and hitting S-up and
2890 S-down to test the range.
2892 When this variable is set to t, the date/time prompt will not let
2893 you specify dates outside the 1970-2037 range, so it is certain that
2894 these dates will work in whatever version of Emacs you are
2895 running, and also that you can move a file from one Emacs implementation
2896 to another. WHenever Org is forcing the year for you, it will display
2897 a message and beep.
2899 When this variable is nil, Org will check if the date is
2900 representable in the specific Emacs implementation you are using.
2901 If not, it will force a year, usually the current year, and beep
2902 to remind you. Currently this setting is not recommended because
2903 the likelihood that you will open your Org files in an Emacs that
2904 has limited date range is not negligible.
2906 A workaround for this problem is to use diary sexp dates for time
2907 stamps outside of this range."
2913 "Non-nil means display current interpretation of date prompt live.
2914 This display will be in an overlay, in the minibuffer."
2919 "Non-nil means pop up a calendar when prompting for a date.
2920 In the calendar, the date can be selected with mouse-1. However, the
2921 minibuffer will also be active, and you can simply enter the date as well.
2922 When nil, only the minibuffer will be available."
2930 "Hook to be used to set up keys for the date/time interface.
2931 Add key definitions to `minibuffer-local-map', which will be a temporary
2932 copy."
2937 "The hour when your day really ends. Must be an integer.
2938 This has influence for the following applications:
2940 the time given here, the day recognized as TODAY is actually yesterday.
2941 - When a date is read from the user and it is still before the time given
2942 here, the current date and time will be assumed to be yesterday, 23:59.
2943 Also, timestamps inserted in capture templates follow this rule.
2945 IMPORTANT: This is a feature whose implementation is and likely will
2946 remain incomplete. Really, it is only here because past midnight seems to
2947 be the favorite working time of John Wiegley :-)"
2952 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2953 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2955 23:59 of the previous day."
2961 "When non-nil, use the last clock out time for `org-todo'.
2962 Note that this option has precedence over the combined use of
2963 `org-use-effective-time' and `org-extend-today-until'."
2965 ;; :version "24.3"
2969 "Non-nil means S-down will increase the time in a time stamp.
2970 When nil, S-up will increase."
2975 "Non-nil means make the calendar window follow timestamp changes.
2976 When a timestamp is modified and the calendar window is visible, it will be
2977 moved to the new date."
2982 "Options concerning tags in Org-mode."
2987 "List of tags allowed in Org-mode files.
2988 When this list is nil, Org-mode will base TAG input on what is already in the
2989 buffer.
2990 The value of this variable is an alist, the car of each entry must be a
2991 keyword as a string, the cdr may be a character that is used to select
2992 that tag through the fast-tag-selection interface.
2993 See the manual for details."
3008 "List of tags that will always appear in all Org-mode files.
3009 This is in addition to any in buffer settings or customizations
3010 of `org-tag-alist'.
3011 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3012 The value of this variable is an alist, the car of each entry must be a
3013 keyword as a string, the cdr may be a character that is used to select
3014 that tag through the fast-tag-selection interface.
3015 See the manual for details.
3016 To disable these tags on a per-file basis, insert anywhere in the file:
3017 #+STARTUP: noptag"
3028 "If non-nil, always offer completion for all tags of all agenda files.
3029 Instead of customizing this variable directly, you might want to
3030 set it locally for capture buffers, because there no list of
3031 tags in that file can be created dynamically (there are none).
3033 (add-hook 'org-capture-mode-hook
3034 (lambda ()
3035 (set (make-local-variable
3036 'org-complete-tags-always-offer-all-agenda-tags)
3037 t)))"
3043 "List of tags that can be inherited by all entries in the file.
3044 The tags will be inherited if the variable `org-use-tag-inheritance'
3045 says they should be.
3049 "Non-nil means use fast tag selection scheme.
3050 This is a special interface to select and deselect tags with single keys.
3051 When nil, fast selection is never used.
3052 When the symbol `auto', fast selection is used if and only if selection
3053 characters for tags have been configured, either through the variable
3054 `org-tag-alist' or through a #+TAGS line in the buffer.
3055 When t, fast selection is always used and selection keys are assigned
3056 automatically if necessary."
3064 "Non-nil means fast tag selection exits after first change.
3065 When nil, you have to press RET to exit it.
3066 During fast tag selection, you can toggle this flag with `C-c'.
3067 This variable can also have the value `expert'. In this case, the window
3068 displaying the tags menu is not even shown, until you press C-c again."
3076 "Non-nil means fast tags selection interface will also offer TODO states.
3080 "The column to which tags should be indented in a headline.
3081 If this number is positive, it specifies the column. If it is negative,
3082 it means that the tags should be flushright to that column. For example,
3083 -80 works well for a normal 80 character screen.
3084 When 0, place tags directly after headline text, with only one space in
3085 between."
3090 "Non-nil keeps tags aligned when modifying headlines.
3091 Some operations (i.e. demoting) change the length of a headline and
3092 therefore shift the tags around. With this option turned on, after
3093 each such operation the tags are again aligned to `org-tags-column'."
3098 "Non-nil means tags in levels apply also for sublevels.
3099 When nil, only the tags directly given in a specific line apply there.
3100 This may also be a list of tags that should be inherited, or a regexp that
3101 matches tags that should be inherited. Additional control is possible
3102 with the variable `org-tags-exclude-from-inheritance' which gives an
3103 explicit list of tags to be excluded from inheritance., even if the value of
3104 `org-use-tag-inheritance' would select it for inheritance.
3106 If this option is t, a match early-on in a tree can lead to a large
3107 number of matches in the subtree when constructing the agenda or creating
3108 a sparse tree. If you only want to see the first match in a tree during
3109 a search, check out the variable `org-tags-match-list-sublevels'."
3118 "List of tags that should never be inherited.
3119 This is a way to exclude a few tags from inheritance. For way to do
3120 the opposite, to actively allow inheritance for selected tags,
3121 see the variable `org-use-tag-inheritance'."
3126 "Check if TAG is one that should be inherited."
3138 "Non-nil means list also sublevels of headlines matching a search.
3139 This variable applies to tags/property searches, and also to stuck
3140 projects because this search is based on a tags match as well.
3142 When set to the symbol `indented', sublevels are indented with
3143 leading dots.
3145 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3146 the sublevels of a headline matching a tag search often also match
3147 the same search. Listing all of them can create very long lists.
3148 Setting this variable to nil causes subtrees of a match to be skipped.
3150 This variable is semi-obsolete and probably should always be true. It
3151 is better to limit inheritance to certain tags using the variables
3152 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3160 "When set, tags are sorted using this function as a comparator."
3176 "Options concerning properties in Org-mode."
3181 "How property key/value pairs should be formatted by `indent-line'.
3182 When `indent-line' hits a property definition, it will format the line
3183 according to this format, mainly to make sure that the values are
3184 lined-up with respect to each other."
3189 "Alist of properties and functions to adjust inserted values.
3190 Elements of this alist must be of the form
3192 ([string] [function])
3194 where [string] must be a property name and [function] must be a
3195 lambda expression: this lambda expression must take one argument,
3196 the value to adjust, and return the new value as a string.
3200 and the clock summary:
3203 (let ((clocksum (org-clock-sum-current-item))
3204 (effort (org-duration-string-to-minutes
3206 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3213 "Non-nil means properties apply also for sublevels.
3215 This setting is chiefly used during property searches. Turning it on can
3216 cause significant overhead when doing a search, which is why it is not
3217 on by default.
3219 When nil, only the properties directly given in the current entry count.
3220 When t, every property is inherited. The value may also be a list of
3221 properties that should have inheritance, or a regular expression matching
3222 properties that should be inherited.
3224 However, note that some special properties use inheritance under special
3225 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3227 for valid values of a property.
3229 Note for programmers:
3230 When querying an entry with `org-entry-get', you can control if inheritance
3231 should be used. By default, `org-entry-get' looks only at the local
3232 properties. You can request inheritance by setting the inherit argument
3233 to t (to force inheritance) or to `selective' (to respect the setting
3234 in this variable)."
3243 "Check if PROPERTY is one that should be inherited."
3254 "The default column format, if no other format has been defined.
3255 This variable can be set on the per-file basis by inserting a line
3257 #+COLUMNS: %25ITEM ....."
3262 "The ellipses to be used when a field in column view is truncated.
3263 When this is the empty string, as many characters as possible are shown,
3264 but then there will be no visual indication that the field has been truncated.
3265 When this is a string of length N, the last N characters of a truncated
3266 field are replaced by this string. If the column is narrower than the
3267 ellipses string, only part of the ellipses string will be shown."
3272 "Function that modifies values for display in column view.
3273 For example, it can be used to cut out a certain part from a time stamp.
3274 The function must take 2 arguments:
3276 column-title The title of the column (*not* the property name)
3277 value The value that should be modified.
3279 The function should return the value that should be displayed,
3280 or nil if the normal value should be used."
3285 "The property that is being used to keep track of effort estimates.
3286 Effort estimates given in this property need to have the format H:MM."
3294 "List of property/value pairs that can be inherited by any entry.
3296 These are fixed values, for the preset properties. The user variable
3297 that can be used to add to this list is `org-global-properties'.
3299 The entries in this list are cons cells where the car is a property
3300 name and cdr is a string with the value. If the value represents
3305 "List of property/value pairs that can be inherited by any entry.
3307 This list will be combined with the constant `org-global-properties-fixed'.
3309 The entries in this list are cons cells where the car is a property
3310 name and cdr is a string with the value.
3312 You can set buffer-local values for the same purpose in the variable
3313 `org-file-properties' this by adding lines like
3315 #+PROPERTY: NAME VALUE"
3322 "List of property/value pairs that can be inherited by any entry.
3323 Valid for the current buffer.
3328 "Options concerning agenda views in Org-mode."
3333 "Variable used by org files to set a category for agenda display.
3334 Such files should use a file variable to set it, for example
3338 or contain a special line
3340 #+CATEGORY: ELisp
3342 If the file does not specify a category, then file's base name
3348 "The files to be used for agenda display.
3352 If an entry is a directory, all files in that directory that are matched by
3353 `org-agenda-file-regexp' will be part of the file list.
3355 If the value of the variable is not a list but a single file name, then
3356 the list of agenda files is actually stored and maintained in that file, one
3357 agenda file per line. In this file paths can be given relative to
3358 `org-directory'. Tilde expansion and environment variable substitution
3359 are also made."
3366 "Regular expression to match files for `org-agenda-files'.
3367 If any element in the list in that variable contains a directory instead
3368 of a normal file, all files in that directory that are matched by this
3369 regular expression will be included."
3374 "List of extra files to be searched by text search commands.
3375 These files will be search in addition to the agenda files by the
3376 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3377 Note that these files will only be searched for text search commands,
3378 not for the other agenda views like todo lists, tag searches or the weekly
3379 agenda. This variable is intended to list notes and possibly archive files
3380 that should also be searched by these two commands.
3381 In fact, if the first element in the list is the symbol `agenda-archives',
3382 than all archive files of all agenda files will be added to the search
3383 scope."
3394 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3395 A nil value means to remove them, after a query, from the list."
3400 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3401 The command `org-calendar-goto-agenda' will be bound to this key. The
3402 default is the character `c' because then `c' can be used to switch back and
3403 forth between agenda and calendar."
3408 "The key to be installed in `calendar-mode-map' for adding diary entries.
3409 This option is irrelevant until `org-agenda-diary-file' has been configured
3410 to point to an Org-mode file. When that is the case, the command
3411 `org-agenda-diary-entry' will be bound to the key given here, by default
3412 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3413 if you want to continue doing this, you need to change this to a different
3414 key."
3419 "File to which to add new entries with the `i' key in agenda and calendar.
3420 When this is the symbol `diary-file', the functionality in the Emacs
3421 calendar will be used to add entries to the `diary-file'. But when this
3422 points to a file, `org-agenda-diary-entry' will be used instead."
3436 org-calendar-insert-diary-entry-key
3440 "Options for embedding LaTeX code into Org-mode."
3448 "Options for creating images from LaTeX fragments.
3449 This is a property list with the following properties:
3451 `default' means use the foreground of the default face.
3452 `auto' means use the foreground from the text face.
3454 `default' means use the background of the default face.
3455 `auto' means use the background from the text face.
3456 :scale a scaling factor for the size of the images, to get more pixels
3457 :html-foreground, :html-background, :html-scale
3458 the same numbers for HTML export.
3459 :matchers a list indicating which matchers should be used to
3460 find LaTeX fragments. Valid members of this list are:
3471 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3472 When nil, just push out a message."
3479 Use this to specify additional executable file say a jar file.
3481 When using MathToWeb as the converter, specify the full-path to
3482 your mathtoweb.jar file."
3490 "Command to convert LaTeX fragments to MathML.
3491 Replace format-specifiers in the command as noted below and use
3492 `shell-command' to convert LaTeX to MathML.
3493 %j: Executable file in fully expanded form as specified by
3494 `org-latex-to-mathml-jar-file'.
3495 %I: Input LaTeX file in fully expanded form
3496 %o: Output MathML file
3497 This command is used by `org-create-math-formula'.
3499 When using MathToWeb as the converter, set this to
3508 "Program to convert LaTeX fragments with.
3510 dvipng Process the LaTeX fragments to dvi file, then convert
3511 dvi files to png files using dvipng.
3512 This will also include processing of non-math environments.
3513 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3514 to convert pdf files to png files"
3522 "Path to store latex preview images.
3523 A relative path here creates many directories relative to the
3524 processed org files paths. An absolute path puts all preview
3525 images at the same place."
3531 "Return t if `org-latex-to-mathml-convert-command' is usable."
3534 org-latex-to-mathml-convert-command)
3536 org-latex-to-mathml-convert-command))))
3541 t))))))
3548 \[PACKAGES]
3549 \[DEFAULT-PACKAGES]
3550 % The settings below are copied from fullpage.sty
3563 "The document header used for processing LaTeX fragments.
3564 It is imperative that this header make sure that no page number
3565 appears on the page. The package defined in the variables
3566 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3568 will be appended."
3575 "Set the packages alist and make sure it has 3 elements per entry."
3579 x))
3580 val)))
3584 "Get the packages alist and make sure it has 3 elements per entry."
3588 x))
3591 ;; The following variables are defined here because is it also used
3592 ;; when formatting latex fragments. Originally it was part of the
3593 ;; LaTeX exporter, which is why the name includes "export".
3610 )
3611 "Alist of default packages to be inserted in the header.
3612 Change this only if one of the packages here causes an incompatibility
3613 with another package you are using.
3614 The packages in this list are needed by one part or another of Org-mode
3615 to function properly.
3617 - inputenc, fontenc: for basic font and character selection
3618 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3619 for interpreting the entities in `org-entities'. You can skip some of these
3620 packages if you don't use any of the symbols in it.
3621 - graphicx: for including images
3622 - float, wrapfig: for figure placement
3623 - longtable: for long tables
3624 - hyperref: for cross references
3626 Therefore you should not modify this variable unless you know what you
3627 are doing. The one reason to change it anyway is that you might be loading
3628 some other package that conflicts with one of the default packages.
3630 If SNIPPET-FLAG is t, the package also needs to be included when
3631 compiling LaTeX snippets into images for inclusion into HTML."
3645 "Alist of packages to be inserted in every LaTeX header.
3646 These will be inserted after `org-export-latex-default-packages-alist'.
3648 SNIPPET-FLAG, when t, indicates that this package is also needed when
3649 turning LaTeX snippets into images for inclusion into HTML.
3650 Make sure that you only list packages here which:
3651 - you want in every file
3652 - do not conflict with the default packages in
3653 `org-export-latex-default-packages-alist'
3654 - do not conflict with the setup in `org-format-latex-header'."
3668 "Settings for Org-mode appearance."
3673 "Non-nil means fontify only the stars in each headline.
3674 When nil, the entire headline is fontified.
3675 Changing it requires restart of `font-lock-mode' to become effective
3676 also in regions already fontified."
3681 "Non-nil means hide the first N-1 stars in a headline.
3682 This works by using the face `org-hide' for these stars. This
3683 face is white for a light background, and black for a dark
3684 background. You may have to customize the face `org-hide' to
3685 make this work.
3686 Changing it requires restart of `font-lock-mode' to become effective
3687 also in regions already fontified.
3688 You may also set this on a per-file basis by adding one of the following
3689 lines to the buffer:
3691 #+STARTUP: hidestars
3692 #+STARTUP: showstars"
3697 "List of symbols corresponding to keywords to be hidden the org buffer.
3698 For example, a value '(title) for this list will make the document's title
3699 appear in the buffer without the initial #+TITLE: keyword."
3708 "List of properties (as strings) with a special meaning.
3709 The default use of these custom properties is to let the user
3710 hide them with `org-toggle-custom-properties-visibility'."
3717 "Non-nil means change the face of a headline if it is marked DONE.
3718 Normally, only the TODO/DONE keyword indicates the state of a headline.
3719 When this is non-nil, the headline after the keyword is set to the
3720 `org-headline-done' as an additional indication."
3725 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3726 Changing this variable requires a restart of Emacs to take effect."
3731 "Non-nil means fontify the whole line for headings.
3732 This is useful when setting a background color for the
3733 org-level-* faces."
3738 "Non-nil means fontify what is treated specially by the exporters."
3743 "Non-nil mean font-lock should hide the emphasis marker characters."
3748 "Non-nil means show entities as UTF8 characters.
3755 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3761 "Regular expression for matching emphasis.
3762 After a match, the match groups contain these elements:
3763 0 The match of the full regular expression, including the characters
3764 before and after the proper match
3765 1 The character before the proper match, or empty at beginning of line
3766 2 The proper match, including the leading and trailing markers
3767 3 The leading marker like * or /, indicating the type of highlighting
3768 4 The text between the emphasis markers, not including the markers
3775 "Set variable and compute the emphasis regular expression."
3779 org-emphasis-alist org-emphasis-regexp-components)
3791 ;; make sure special characters appear at the right position in the class
3803 ;; Make the regexp
3811 body1
3823 body1
3831 "Components used to build the regular expression for emphasis.
3832 This is a list with five entries. Terminology: In an emphasis string
3836 specify what is allowed/forbidden in each part:
3838 pre Chars allowed as prematch. Beginning of line will be allowed too.
3839 post Chars allowed as postmatch. End of line will be allowed too.
3840 border The chars *forbidden* as border characters.
3842 non-shy groups here, and don't allow newline here.
3843 newline The maximum number of newlines allowed in an emphasis exp.
3845 Use customize to modify this, or restart Emacs after changing it."
3864 )
3865 "Special syntax for emphasized text.
3866 Text starting and ending with a special character will be emphasized, for
3867 example *bold*, _underlined_ and /italic/. This variable sets the marker
3868 characters, the face to be used by font-lock for highlighting in Org-mode
3869 Emacs buffers, and the HTML tags to be used for this.
3870 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3871 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3872 Use customize to modify this, or restart Emacs after changing it."
3887 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3890 ;;; Miscellaneous options
3893 "Completion in Org-mode."
3898 "Non-nil means use ido completion wherever possible.
3899 Note that `ido-mode' must be active for this variable to be relevant.
3900 If you decide to turn this variable on, you might well want to turn off
3901 `org-outline-path-complete-in-steps'.
3902 See also `org-completion-use-iswitchb'."
3907 "Non-nil means use iswitchb completion wherever possible.
3908 Note that `iswitchb-mode' must be active for this variable to be relevant.
3909 If you decide to turn this variable on, you might well want to turn off
3910 `org-outline-path-complete-in-steps'.
3911 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3917 Normal means, no org-mode-specific context."
3921 ;;; Functions and variables from their packages
3922 ;; Declared here to avoid compiler warnings
3924 ;; XEmacs only
3930 ;; Emacs only
3933 ;; Various packages
3952 org-agenda-format-item "org-agenda"
3983 ;;; Autoload and prepare some org modules
3985 ;; Some table stuff that needs to be defined here, because it is used
3986 ;; by the functions setting up org-mode or checking for table context.
3999 "Detect the first line outside a table when searching from within it.
4002 ;; Autoload the functions in org-table.el that are needed by functions here.
4008 ;;;###autoload
4010 "Unconditionally turn on `orgtbl-mode'."
4015 "Return t if the cursor is inside an org-type table.
4016 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4021 org-table-line-regexp)))
4022 nil))
4026 "Return t if and only if we are at a table.el table."
4032 "If there is a table.el table nearby, recognize it and move into it."
4038 nil
4048 t
4053 t)
4054 nil)
4055 nil))
4058 "Return t if the cursor is inside a hline in a table."
4063 nil))
4068 "Apply FUNCTION to the start of all tables in the buffer."
4078 ;; Exclude tables in src/example/verbatim/clocktable blocks
4086 ;; Declare and autoload functions from org-exp.el & Co
4092 ;; Declare and autoload functions from org-agenda.el
4110 "Return non-nil if clock is currently running.
4111 The return value is actually the clock marker."
4116 org-clock-update-time-maybe
4117 org-clocktable-shift)))
4120 "Check if the current buffer contains the running clock.
4121 If yes, offer to stop it and to save the buffer with the changes."
4130 "Check if this line starts a clock table, if yes, shift the time block."
4134 ;;;###autoload
4136 "Set up hooks for clock persistence."
4141 ;; Define the variable already here, to make sure we have it.
4143 "Non-nil if Org-Indent mode is enabled.
4146 ;; Autoload archiving code
4147 ;; The stuff that is needed for cycling and tags has to be defined here.
4150 "Options concerning archiving in Org-mode."
4155 "The location where subtrees should be archived.
4157 The value of this variable is a string, consisting of two parts,
4158 separated by a double-colon. The first part is a filename and
4159 the second part is a headline.
4161 When the filename is omitted, archiving happens in the same file.
4162 %s in the filename will be replaced by the current file
4163 name (without the directory part). Archiving to a different file
4164 is useful to keep archived entries from contributing to the
4165 Org-mode Agenda.
4167 The archived entries will be filed as subtrees of the specified
4168 headline. When the headline is omitted, the subtrees are simply
4169 filed away at the end of the file, as top-level entries. Also in
4170 the heading you can use %s to represent the file name, this can be
4171 useful when using the same archive for a number of different files.
4173 Here are a few examples:
4175 If the current file is Projects.org, archive in file
4176 Projects.org_archive, as top-level trees. This is the default.
4179 Archive in the current file, under the top-level headline
4183 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4186 Archive in file ~/org/archive.org (absolute path), under headlines
4191 items to the datetree. Items are placed in either the CLOSED
4192 date of the item, or the current date if there is no CLOSED date.
4193 The heading will be a subentry to the current date. There doesn't
4194 need to be a heading, but there always needs to be a slash after
4195 datetree. For example, to store archived items directly in the
4199 Archive in file ./basement (relative path), as level 3 trees
4202 You may set this option on a per-file basis by adding to the buffer a
4203 line like
4205 #+ARCHIVE: basement::** Finished Tasks
4207 You may also define it locally for a subtree by setting an ARCHIVE property
4208 in the entry. If such a property is found in an entry, or anywhere up
4209 the hierarchy, it will be used."
4214 "The tag that marks a subtree as archived.
4215 An archived subtree does not open during visibility cycling, and does
4216 not contribute to the agenda listings.
4217 After changing this, font-lock must be restarted in the relevant buffers to
4218 get the proper fontification."
4224 "Non-nil means the agenda will skip any items located in archived trees.
4225 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4226 variable is no longer recommended, you should leave it at the value t.
4227 Instead, use the key `v' to cycle the archives-mode in the agenda."
4233 "Non-nil means ignore archived trees when creating column view."
4239 "Non-nil means `org-cycle' will open archived trees.
4240 An archived tree is a tree marked with the tag ARCHIVE.
4241 When nil, archived trees will stay folded. You can still open them with
4242 normal outline commands like `show-all', but not with the cycling commands."
4248 "Non-nil means sparse tree construction shows matches in archived trees.
4249 When nil, matches in these trees are highlighted, but the trees are kept in
4250 collapsed state."
4256 "The default date type when building a sparse tree.
4257 When this is nil, a date is a scheduled or a deadline timestamp.
4258 Otherwise, these types are allowed:
4260 all: all timestamps
4261 active: only active timestamps (<...>)
4262 inactive: only inactive timestamps (<...)
4263 scheduled: only scheduled timestamps
4264 deadline: only deadline timestamps"
4275 "Re-hide all archived subtrees after a visibility state change."
4286 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4289 "Cycle subtree even if it is archived."
4296 "Re-hide all archived subtrees after a visibility state change."
4313 flag)))
4321 ;; Autoload Column View Code
4329 org-columns-get-format-and-top-level
4330 org-columns-compute
4331 org-columns-remove-overlays))
4333 ;; Autoload ID code
4341 org-id-copy
4342 org-id-get-with-outline-path-completion
4343 org-id-get-with-outline-drilling))
4345 ;;; Variables for pre-computed regular expressions, all buffer local
4363 "Matches a headline and puts everything into groups:
4364 group 1: the stars
4365 group 2: The todo keyword, maybe
4366 group 3: Priority cookie
4367 group 4: True headline
4371 "Printf format to make regexp to match an exact headline.
4372 This regexp will match the headline of any node which has the
4373 exact headline text that is put into the format, but may have any
4377 "Matches a headline and puts TODO state into group 2 if present.
4423 "Regular expression to match a plain time or time range.
4424 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4425 groups carry important information:
4426 0 the full match
4427 1 the first time, range or not
4435 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4436 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4437 groups carry important information:
4438 0 the full match
4439 7 hours of duration
4448 "Regular expression to match a timestamp time or time range.
4449 After a match, the following groups carry important information:
4450 0 the full match
4451 1 date plus weekday, for back referencing to make sure both times are on the same day
4452 2 the first time, range or not
4507 "Variable associated with STARTUP options for org-mode.
4508 Each element is a list of three items: the startup options (as written
4509 in the #+STARTUP line), the corresponding variable, and the value to set
4510 this variable to if the option is found. An optional forth element PUSH
4514 "Update PROPS with KEY and VAL."
4528 "Printf format for a regexp matching an headline with some keyword.
4529 This regexp will match the headline of any node which has the
4530 exact keyword that is put into the format. The keyword isn't in
4534 "Printf format for a regexp matching an headline, possibly with some keyword.
4535 This regexp can match any headline with the specified keyword, or
4536 without a keyword. The keyword isn't in any group by default,
4540 "Precompute regular expressions for current buffer."
4560 kwds kws0 kwsa key log value cat arch tags const links hw dws
4561 tail sep kws1 prio props ftags drawers beamer-p
4583 ;; general TODO-like setup
4595 links)))
4602 props))))
4607 ftags
4617 l var val)
4647 ;; search for property blocks
4656 props)))))))
4673 ;; Process the TODO keywords
4675 ;; Use the global values as if they had been given locally.
4687 kws)))
4690 kwsa nil
4693 ;; 1 2
4701 kw)
4703 kws0)
4720 ;; Process the constants
4728 ;; Process the tags.
4739 tgs))
4747 ;; Compute the regular expressions and other local variables.
4748 ;; Using `org-outline-regexp-bol' would complicate them much,
4749 ;; because of the fixed white space at the end of that string.
4757 org-drawer-regexp
4761 org-not-done-keywords
4763 org-todo-regexp
4767 org-not-done-regexp
4771 org-not-done-heading-regexp
4773 org-todo-line-regexp
4775 org-complex-heading-regexp
4782 org-complex-heading-regexp-format
4787 ;; Stats cookies can be stuck to body.
4794 org-todo-line-tags-regexp
4801 org-deadline-time-regexp
4803 org-deadline-line-regexp
4805 org-scheduled-regexp
4807 org-scheduled-time-regexp
4809 org-closed-time-regexp
4811 org-keyword-time-regexp
4817 org-keyword-time-not-clock-regexp
4823 org-maybe-keyword-time-regexp
4829 org-all-time-keywords
4832 org-clock-string org-closed-string))
4833 )
4838 "Return the contents of FILE, as a string."
4852 "Extract the log state setting from a TODO keyword string.
4866 "Remove a pair of parenthesis at the end of each string in LIST."
4870 x))
4871 list))
4874 "Assign fast keys to a keyword-key alist.
4875 Respect keys that are already there."
4893 ;;; Some variables used in various places
4900 "Function to be called when `C-c C-c' is used.
4904 ;; FIXME: Occasionally check by commenting these, to make sure
4905 ;; no other functions uses these, forgetting to let-bind them.
4910 ;; Defined somewhere in this file, but used before definition.
4916 ;;;; Define the Org-mode
4918 ;; We use a before-change function to check if a table might need
4919 ;; an update.
4921 "Indicates that a table might need an update.
4922 This variable is set by `org-before-change-function'.
4925 "Every change indicates that a table might need an update."
4940 (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"))
4943 ;; Other stuff we need.
4951 ;; (require 'org-compat) moved higher up in the file before it is first used
4958 ;; babel
4961 ;;;###autoload
4963 "Outline-based notes management and organizer, alias
4966 Org-mode develops organizational tasks around a NOTES file which
4967 contains information about projects as plain text. Org-mode is
4968 implemented on top of outline-mode, which is ideal to keep the content
4969 of large files well structured. It supports ToDo items, deadlines and
4970 time stamps, which magically appear in the diary listing of the Emacs
4971 calendar. Tables are easily created with a built-in table editor.
4972 Plain text URL-like links connect to websites, emails (VM), Usenet
4973 messages (Gnus), BBDB entries, and any files related to the project.
4974 For printing and sharing of notes, an Org-mode file (or a part of it)
4975 can be exported as a structured ASCII or HTML file.
4977 The following commands are available:
4981 ;; Get rid of Outline menus, they are not needed
4982 ;; Need to do this here because define-derived-mode sets up
4983 ;; the keymap so late. Still, it is a waste to call this each time
4984 ;; we switch another buffer into org-mode.
4987 ;; Assume this is Greg's port, it uses easymenu
5013 org-display-table 4
5016 org-ellipsis)))
5021 ;; tag faces set outside customize.... force initialization.
5023 ;; Calc embedded
5030 ;; Activate before-change-function
5034 ;; Check for running clock before killing a buffer
5036 ;; Initialize macros templates.
5038 ;; Initialize radio targets.
5040 ;; Indentation.
5043 ;; Filling and auto-filling.
5045 ;; Comments.
5047 ;; Beginning/end of defun
5050 ;; Next error for sparse trees
5052 ;; Make sure dependence stuff works reliably, even for users who set it
5053 ;; too late :-(
5065 ;; Align options lines
5067 'align-mode-rules-list
5072 ;; Imenu
5076 ;; Make isearch reveal context
5079 ;; Emacs 21 and XEmacs make use of the hook
5081 ;; Emacs 22 deals with this through a special variable
5085 ;; Turn on org-beamer-mode?
5088 ;; Setup the pcomplete hooks
5101 ;; If empty file that did not turn on org-mode automatically, make it to.
5118 ;; Try to set org-hide correctly
5130 "unspecified-bg"
5143 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5153 "Return today date, considering `org-extend-today-until'."
5158 ;;;; Font-Lock stuff, including the activators
5189 "Regular expression used to analyze links.
5190 Here is what the match groups contain after a match:
5191 1: http:
5192 2: http
5193 3: path
5194 4: [desc]
5202 "Number of stacked braces for sub/superscript matching.
5203 This has to be set before loading org.el to be effective."
5208 "Create a regular expression which will match a balanced sexp.
5209 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5210 as single character strings.
5211 The regexp returned will match the entire expression including the
5212 delimiters. It will also define a single group which contains the
5213 match except for the outermost delimiters. The maximum depth of
5214 stacked delimiters is N. Escaping delimiters is not possible."
5243 "Update the link regular expressions.
5244 This should be called after the variable `org-link-types' has changed."
5248 org-link-re-with-space
5254 org-link-re-with-space2
5260 org-link-re-with-space3
5265 org-angle-link-re
5271 org-plain-link-re
5275 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5276 org-bracket-link-regexp
5278 org-bracket-link-analytic-regexp
5286 org-bracket-link-analytic-regexp++
5294 org-any-link-re
5303 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5306 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5307 "Regular expression matching time strings for analysis.
5308 This one does not require the space after the date, so it can be used
5310 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5326 "Regular expression matching a time stamp or time stamp range.
5332 "Run through the buffer and add overlays to emphasized strings."
5341 'face
5354 rtn))
5357 "Insert or change an emphasis, i.e. a font like bold or italic.
5358 If there is an active region, change that region to a new emphasis.
5359 If there is no region, just insert the marker characters and position
5360 the cursor between them.
5361 CHAR should be either the marker character, or the first character of the
5362 HTML tag associated with that emphasis. If CHAR is a space, the means
5363 to remove the emphasis of the selected region.
5364 If char is not given (for example in an interactive call) it
5365 will be prompted for."
5416 "Run through the buffer and add overlays to links."
5425 nil
5432 t))))
5440 t)))
5443 "When non-nil, fontify code in code blocks."
5450 "When non-nil, allow promoting a top level subtree.
5451 The leading star of the top level headline will be replaced
5452 by a #."
5463 "Fontify #+ lines and blocks, in the correct ways."
5466 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5467 limit t)
5475 end end1 quoting block-type ovl)
5478 ;; a single line of backend-specific content
5486 ; for backend-specific code
5487 t)
5489 ;; Truly a block
5502 beg end
5510 ;; remove old background overlays
5515 ;; add a background overlay
5530 t))
5550 t)
5556 ;; just any other in-buffer setting, but not indented
5560 t)
5564 "Run through the buffer and add overlays to links."
5572 t)))
5575 "Run through the buffer and add overlays to footnotes."
5582 'keymap org-mouse-map
5583 'help-echo
5585 "Footnote definition"
5587 'font-lock-fontified t
5588 'font-lock-multiline t
5592 "Run through the buffer and add overlays to bracketed links."
5596 ;; FIXME: Above we should remove the escapes. But that
5597 ;; requires another match, protecting match data, a lot
5598 ;; of overhead for font-lock.
5607 ;; We need to remove the invisible property here. Table narrowing
5608 ;; may have made some of this invisible.
5626 t)))
5629 "Run through the buffer and add overlays to dates."
5641 t)))
5650 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5654 "Run through the buffer and add overlays to target matches."
5662 'keymap org-mouse-map
5666 t)))))
5669 "Find all radio targets in this file and update the regular expression."
5684 t)))
5691 ;; This should be with the exporter code, but we also use if for font-locking
5701 "Compute regular expression for stuff treated specially by exporters."
5708 org-latex-regexps)))
5735 org-entities)))
5739 org-latex-entities)
5740 nil))
5742 ))
5743 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5746 org-export-html-special-string-regexps)))
5751 ))))
5753 'org-latex-and-specials-regexp
5758 "Run through the buffer and add overlays to links."
5762 limit t))
5776 rtn)))
5779 "Restart `font-lock-mode', to force refontification."
5785 "Return a list of all targets in this file.
5786 When optional argument RADIO is non-nil, only find radio
5787 targets."
5792 ;; Make sure point is really within the object.
5797 rtn)))
5800 "Make regular expression matching all strings in TARGETS.
5801 The regular expression finds the targets also if there is a line break
5802 between words."
5811 x)
5812 targets
5824 t)))
5827 "Compute the outline level of the heading at point.
5828 If this is called at a normal headline, the level is the number of stars.
5829 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5834 0
5840 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5847 "Functions that can manipulate `org-font-lock-extra-keywords'.
5848 This is called after `org-font-lock-extra-keywords' is defined, but before
5849 it is installed to be used by font lock. This can be useful if something
5853 "Run `org-font-lock-hook' within LIMIT."
5857 "Set font lock defaults for the current buffer."
5862 ;; Call the hook
5864 ;; Headlines
5871 ;; Table lines
5874 ;; Table internals
5879 ;; Drawers
5882 ;; Properties
5886 ;; Links
5897 ;; TODO keyword
5899 org-todo-regexp)
5901 ;; DONE
5909 nil)
5910 ;; Priorities
5912 ;; Tags
5914 ;; Special keywords
5919 ;; Emphasis
5924 ;; Checkboxes
5925 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5930 ;; Description list items
5933 ;; ARCHIVEd headings
5935 org-outline-regexp-bol
5938 ;; Specials
5942 ;; Code
5944 ;; COMMENT
5950 ;; Blocks and meta lines
5952 )))
5955 ;; Now set the full font-lock-keywords
5962 "Toggle the composition display of entities as UTF8 characters."
5978 "Display or hide properties in `org-custom-properties'."
5995 org-custom-properties)))))))
5998 "Find an entity to fontify."
6004 limit t)
6019 nil))))
6022 "Fontify string S like in Org-mode."
6034 "Get the right face for match N in font-lock matching of headlines."
6047 "Get the right face for a TODO keyword KWD.
6048 If KWD is a number, get the corresponding match group."
6056 "Create a face list that inherits INHERIT, but sets the foreground color.
6057 When FACE-OR-COLOR is not a string, just return it."
6061 face-or-color)
6062 face-or-color))
6065 "Add the special tag faces."
6074 "Add the special priority faces."
6082 org-priority-faces)))
6087 "Get the right face for a TODO keyword KWD.
6088 If KWD is a number, get the corresponding match group."
6095 "Remove fontification and activation overlays from links."
6100 deactivate-mark buffer-file-name buffer-file-truename)
6104 invisible t intangible t
6105 org-no-flyspell t org-emphasis t))
6115 "Remove specific display properties that have been added by font lock.
6116 The will remove the raise properties that are used to show superscripts
6117 and subscripts."
6127 "Add raise properties to sub/superscripts."
6131 org-match-substring-regexp
6132 org-match-substring-with-braces-regexp)
6133 limit t)
6143 ;; FIXME: Should we go back one character here, for a_b^c
6144 ;; (goto-char (1- pos)) ;????????????????????
6146 t
6148 'display
6164 t)))))
6166 ;;;; Visibility cycling, including org-goto and indirect buffer
6168 ;;; Cycling
6177 ;;;###autoload
6179 "TAB-action and visibility cycling for Org-mode.
6181 This is the command invoked in Org-mode by the TAB key. Its main purpose
6182 is outline visibility cycling, but it also invokes other actions
6183 in special contexts.
6185 - When this function is called with a prefix argument, rotate the entire
6186 buffer through 3 states (global cycling)
6187 1. OVERVIEW: Show only top-level headlines.
6188 2. CONTENTS: Show all headlines of all levels, but no body text.
6189 3. SHOW ALL: Show everything.
6190 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6191 determined by the variable `org-startup-folded', and by any VISIBILITY
6192 properties in the buffer.
6193 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6194 including any drawers.
6196 - When inside a table, re-align the table and move to the next field.
6198 - When point is at the beginning of a headline, rotate the subtree started
6199 by this line through 3 different states (local cycling)
6200 1. FOLDED: Only the main headline is shown.
6201 2. CHILDREN: The main headline and the direct children are shown.
6202 From this state, you can move to one of the children
6203 and zoom in further.
6204 3. SUBTREE: Show the entire subtree, including body text.
6205 If there is no subtree, switch directly from CHILDREN to FOLDED.
6207 - When point is at the beginning of an empty headline and the variable
6208 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6209 of the headline by demoting and promoting it to likely levels. This
6210 speeds up creation document structure by pressing TAB once or several
6211 times right after creating a new headline.
6213 - When there is a numeric prefix, go up to a heading with level ARG, do
6214 a `show-subtree' and return to the previous cursor position. If ARG
6215 is negative, go up that many levels.
6217 - When point is not at the beginning of a headline, execute the global
6218 binding for TAB, which is re-indenting the line. See the option
6219 `org-cycle-emulate-tab' for details.
6221 - Special case: if point is at the beginning of the buffer and there is
6222 no headline in line 1, this function will act as if called with prefix arg
6223 (C-u TAB, same as S-TAB) also when called without prefix arg.
6224 But only if also the variable `org-cycle-global-at-bob' is t."
6234 org-inlinetask-min-level
6239 limit-level)))
6242 outline-regexp
6250 org-cycle-hook))
6254 ;; special case: use global cycling
6268 ;; Table: enter it or move to the next field.
6279 ;; Global cycling: delegate to `org-cycle-internal-global'.
6282 ;; Drawers: delegate to `org-flag-drawer'.
6290 ;; Show-subtree, ARG levels up from here.
6298 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6306 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6313 ;; From there: TAB emulation and template completion.
6335 t
6344 "Do the global cycling action."
6345 ;; Hack to avoid display of messages for .org attachments in Gnus
6350 ;; We just created the overview - now do table of contents
6351 ;; This can be slow in very large buffers, so indicate action
6361 ;; We just showed the table of contents - now show everything
6369 ;; Default action: go to overview
6377 "Do the local cycling action."
6379 ;; First, determine end of headline (EOH), end of subtree or item
6380 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6404 ;; Determine end invisible part of buffer (EOL)
6406 ;; XEmacs doesn't have `next-single-char-property-change'
6416 ;; Find out what to do next and set `this-command'
6419 ;; Nothing is hidden behind this heading
6431 org-cycle-skip-children-state-if-no-children))))
6432 ;; Entire subtree is hidden in one line: children view
6438 ;; FIXME: This slows down the func way too much.
6439 ;; How keep drawers hidden in subtree anyway?
6440 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6441 ;; (org-cycle-hide-drawers 'subtree))
6443 ;; Fold every list in subtree to top-level items.
6465 ;; We just showed the children, or no children are there,
6466 ;; now show everything.
6473 ;; Default action: hide the subtree.
6480 ;;;###autoload
6482 "Cycle the global visibility. For details see `org-cycle'.
6484 With a numeric prefix, show all headlines up to that level."
6500 "Set the visibility required by startup options and properties."
6515 "Switch subtree visibilities according to :VISIBILITY: property."
6522 nil t)
6546 ;; This function uses outline-regexp instead of the more fundamental
6547 ;; org-outline-regexp so that org-cycle-global works outside of Org
6548 ;; buffers, where outline-regexp is needed.
6550 "Switch to overview mode, showing only top-level headlines.
6551 Really, this shows all headlines with level equal or greater than the level
6552 of the first headline in the buffer. This is important, because if the
6553 first headline is not level one, then (hide-sublevels 1) gives confusing
6554 results."
6565 "Show all headlines in the buffer, like a table of contents.
6566 With numerical argument N, show content up to level N."
6569 ;; Visit all headings and show their offspring
6576 t)
6585 "Adjust the window after a change in outline visibility.
6586 This function is the default value of the hook `org-cycle-hook'."
6596 "Remove outline overlays that do not contain non-white stuff."
6606 "Fix visibility issues after moving a subtree."
6607 ;; First, find a reasonable region to look at:
6608 ;; Start two siblings above, end three below
6626 ;; Properly fold already folded siblings
6637 "Show empty lines above all visible headlines.
6638 The region to be covered depends on STATE when called through
6639 `org-cycle-hook'. Lisp program can use t for STATE to get the
6640 entire buffer covered. Note that an empty line is only shown if there
6641 are at least `org-cycle-separator-lines' empty lines before the headline."
6651 beg end b e)
6675 ;; Never hide empty lines at the end of the file.
6685 "Move to the parent and re-show empty lines before visible headlines."
6691 "Return `org-agenda-files' list, plus all open org-mode files.
6692 This is useful for operations that need to scan all of a user's
6693 open and agenda-wise Org files."
6701 files))
6704 "Return the beginning position of the current entry."
6708 "Return the end position of the current entry."
6712 "Re-hide all drawers after a visibility state change."
6727 "Re-hide inline task when switching to 'contents visibility state."
6730 org-inlinetask-min-level)
6734 "When FLAG is non-nil, hide the drawer we are within.
6735 Otherwise make it visible."
6747 "Is the end of the current subtree visible?"
6752 "Move cursor to the first headline and recenter the headline.
6753 Optional argument N means put the headline into the Nth line of the window."
6759 ;;; Saving and restoring visibility
6762 "Return a list of the locations of all outline overlays.
6763 These are overlays with the `invisible' property value `outline'.
6764 The return value is a list of cons cells, with start and stop
6765 positions for each overlay.
6766 If USE-MARKERS is set, return the positions as markers."
6784 "Create visibility overlays for all positions in DATA.
6785 DATA should have been made by `org-outline-overlay-data'."
6793 data)))))
6795 ;;; Folding of blocks
6802 "Call FUNCTION at the head of all source blocks in the current buffer.
6803 Optional arguments START and END can be used to limit the range."
6815 "Toggle the visibility of all blocks in the current buffer."
6819 "Fold all blocks in the current buffer."
6825 "Unfold all blocks in the current buffer."
6831 "Toggle visibility of block at point."
6842 "Toggle the visibility of the current block."
6849 ov)
6865 ;; make the block accessible to isearch
6867 ov 'isearch-open-invisible
6878 ;; org-tab-after-check-for-cycling-hook
6880 ;; Remove overlays when changing major mode
6885 ;;; Org-goto
6891 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6907 nil)
6908 (org-defkey map "q" 'org-goto-quit)
6909 (org-defkey map "n" 'outline-next-visible-heading)
6910 (org-defkey map "p" 'outline-previous-visible-heading)
6911 (org-defkey map "f" 'outline-forward-same-level)
6912 (org-defkey map "b" 'outline-backward-same-level)
6913 (org-defkey map "u" 'outline-up-heading))
6914 (org-defkey map "/" 'org-occur)
6915 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6916 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6917 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6918 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6919 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6920 map))
6922 (defconst org-goto-help
6923 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6924 RET=jump to location [Q]uit and return to previous location
6925 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6927 (defvar org-goto-start-pos) ; dynamically scoped parameter
6929 ;; FIXME: Docstring does not mention both interfaces
6930 (defun org-goto (&optional alternative-interface)
6931 "Look up a different location in the current file, keeping current visibility.
6933 When you want look-up or go to a different location in a
6934 document, the fastest way is often to fold the entire buffer and
6935 then dive into the tree. This method has the disadvantage, that
6936 the previous location will be folded, which may not be what you
6937 want.
6939 This command works around this by showing a copy of the current
6940 buffer in an indirect buffer, in overview mode. You can dive
6941 into the tree in that copy, use org-occur and incremental search
6942 to find a location. When pressing RET or `Q', the command
6943 returns to the original buffer in which the visibility is still
6944 unchanged. After RET it will also jump to the location selected
6945 in the indirect buffer and expose the headline hierarchy above.
6947 With a prefix argument, use the alternative interface: e.g. if
6948 `org-goto-interface' is 'outline use 'outline-path-completion."
6949 (interactive "P")
6950 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6951 (org-refile-use-outline-path t)
6952 (org-refile-target-verify-function nil)
6953 (interface
6954 (if (not alternative-interface)
6955 org-goto-interface
6956 (if (eq org-goto-interface 'outline)
6957 'outline-path-completion
6958 'outline)))
6959 (org-goto-start-pos (point))
6960 (selected-point
6961 (if (eq interface 'outline)
6962 (car (org-get-location (current-buffer) org-goto-help))
6963 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6964 (org-refile-check-position pa)
6965 (nth 3 pa)))))
6966 (if selected-point
6967 (progn
6968 (org-mark-ring-push org-goto-start-pos)
6969 (goto-char selected-point)
6970 (if (or (outline-invisible-p) (org-invisible-p2))
6971 (org-show-context 'org-goto)))
6972 (message "Quit"))))
6974 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6975 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6976 (defvar org-goto-local-auto-isearch-map) ; defined below
6978 (defun org-get-location (buf help)
6979 "Let the user select a location in the Org-mode buffer BUF.
6980 This function uses a recursive edit. It returns the selected position
6981 or nil."
6982 (org-no-popups
6983 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6984 (isearch-hide-immediately nil)
6985 (isearch-search-fun-function
6986 (lambda () 'org-goto-local-search-headings))
6987 (org-goto-selected-point org-goto-exit-command))
6988 (save-excursion
6989 (save-window-excursion
6990 (delete-other-windows)
6991 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6992 (org-pop-to-buffer-same-window
6993 (condition-case nil
6994 (make-indirect-buffer (current-buffer) "*org-goto*")
6995 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6996 (with-output-to-temp-buffer "*Help*"
6997 (princ help))
6998 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6999 (setq buffer-read-only nil)
7000 (let ((org-startup-truncated t)
7001 (org-startup-folded nil)
7002 (org-startup-align-all-tables nil))
7003 (org-mode)
7004 (org-overview))
7005 (setq buffer-read-only t)
7006 (if (and (boundp 'org-goto-start-pos)
7007 (integer-or-marker-p org-goto-start-pos))
7008 (let ((org-show-hierarchy-above t)
7009 (org-show-siblings t)
7010 (org-show-following-heading t))
7011 (goto-char org-goto-start-pos)
7012 (and (outline-invisible-p) (org-show-context)))
7013 (goto-char (point-min)))
7014 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7015 (message "Select location and press RET")
7016 (use-local-map org-goto-map)
7017 (recursive-edit)
7018 ))
7019 (kill-buffer "*org-goto*")
7020 (cons org-goto-selected-point org-goto-exit-command))))
7022 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7023 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7024 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7025 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7027 (defun org-goto-local-search-headings (string bound noerror)
7028 "Search and make sure that any matches are in headlines."
7029 (catch 'return
7030 (while (if isearch-forward
7031 (search-forward string bound noerror)
7032 (search-backward string bound noerror))
7033 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7034 (and (member :headline context)
7035 (not (member :tags context))))
7036 (throw 'return (point))))))
7038 (defun org-goto-local-auto-isearch ()
7039 "Start isearch."
7040 (interactive)
7041 (goto-char (point-min))
7042 (let ((keys (this-command-keys)))
7043 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7044 (isearch-mode t)
7045 (isearch-process-search-char (string-to-char keys)))))
7047 (defun org-goto-ret (&optional arg)
7048 "Finish `org-goto' by going to the new location."
7049 (interactive "P")
7050 (setq org-goto-selected-point (point)
7051 org-goto-exit-command 'return)
7052 (throw 'exit nil))
7054 (defun org-goto-left ()
7055 "Finish `org-goto' by going to the new location."
7056 (interactive)
7057 (if (org-at-heading-p)
7058 (progn
7059 (beginning-of-line 1)
7060 (setq org-goto-selected-point (point)
7061 org-goto-exit-command 'left)
7062 (throw 'exit nil))
7063 (error "Not on a heading")))
7065 (defun org-goto-right ()
7066 "Finish `org-goto' by going to the new location."
7067 (interactive)
7068 (if (org-at-heading-p)
7069 (progn
7070 (setq org-goto-selected-point (point)
7071 org-goto-exit-command 'right)
7072 (throw 'exit nil))
7073 (error "Not on a heading")))
7075 (defun org-goto-quit ()
7076 "Finish `org-goto' without cursor motion."
7077 (interactive)
7078 (setq org-goto-selected-point nil)
7079 (setq org-goto-exit-command 'quit)
7080 (throw 'exit nil))
7082 ;;; Indirect buffer display of subtrees
7084 (defvar org-indirect-dedicated-frame nil
7085 "This is the frame being used for indirect tree display.")
7086 (defvar org-last-indirect-buffer nil)
7088 (defun org-tree-to-indirect-buffer (&optional arg)
7089 "Create indirect buffer and narrow it to current subtree.
7090 With a numerical prefix ARG, go up to this level and then take that tree.
7091 If ARG is negative, go up that many levels.
7093 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7094 indirect buffer previously made with this command, to avoid proliferation of
7095 indirect buffers. However, when you call the command with a \
7097 when `org-indirect-buffer-display' is `new-frame', the last buffer
7098 is kept so that you can work with several indirect buffers at the same time.
7099 If `org-indirect-buffer-display' is `dedicated-frame', the \
7101 requests that a new frame be made for the new buffer, so that the dedicated
7102 frame is not changed."
7103 (interactive "P")
7104 (let ((cbuf (current-buffer))
7105 (cwin (selected-window))
7106 (pos (point))
7107 beg end level heading ibuf)
7108 (save-excursion
7109 (org-back-to-heading t)
7110 (when (numberp arg)
7111 (setq level (org-outline-level))
7112 (if (< arg 0) (setq arg (+ level arg)))
7113 (while (> (setq level (org-outline-level)) arg)
7114 (org-up-heading-safe)))
7115 (setq beg (point)
7116 heading (org-get-heading))
7117 (org-end-of-subtree t t)
7118 (if (org-at-heading-p) (backward-char 1))
7119 (setq end (point)))
7120 (if (and (buffer-live-p org-last-indirect-buffer)
7121 (not (eq org-indirect-buffer-display 'new-frame))
7122 (not arg))
7123 (kill-buffer org-last-indirect-buffer))
7124 (setq ibuf (org-get-indirect-buffer cbuf)
7125 org-last-indirect-buffer ibuf)
7126 (cond
7127 ((or (eq org-indirect-buffer-display 'new-frame)
7128 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7129 (select-frame (make-frame))
7130 (delete-other-windows)
7131 (org-pop-to-buffer-same-window ibuf)
7132 (org-set-frame-title heading))
7133 ((eq org-indirect-buffer-display 'dedicated-frame)
7134 (raise-frame
7135 (select-frame (or (and org-indirect-dedicated-frame
7136 (frame-live-p org-indirect-dedicated-frame)
7137 org-indirect-dedicated-frame)
7138 (setq org-indirect-dedicated-frame (make-frame)))))
7139 (delete-other-windows)
7140 (org-pop-to-buffer-same-window ibuf)
7141 (org-set-frame-title (concat "Indirect: " heading)))
7142 ((eq org-indirect-buffer-display 'current-window)
7143 (org-pop-to-buffer-same-window ibuf))
7144 ((eq org-indirect-buffer-display 'other-window)
7145 (pop-to-buffer ibuf))
7146 (t (error "Invalid value")))
7147 (if (featurep 'xemacs)
7148 (save-excursion (org-mode) (turn-on-font-lock)))
7149 (narrow-to-region beg end)
7150 (show-all)
7151 (goto-char pos)
7152 (run-hook-with-args 'org-cycle-hook 'all)
7153 (and (window-live-p cwin) (select-window cwin))))
7155 (defun org-get-indirect-buffer (&optional buffer)
7156 (setq buffer (or buffer (current-buffer)))
7157 (let ((n 1) (base (buffer-name buffer)) bname)
7158 (while (buffer-live-p
7159 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7160 (setq n (1+ n)))
7161 (condition-case nil
7162 (make-indirect-buffer buffer bname 'clone)
7163 (error (make-indirect-buffer buffer bname)))))
7165 (defun org-set-frame-title (title)
7166 "Set the title of the current frame to the string TITLE."
7167 ;; FIXME: how to name a single frame in XEmacs???
7168 (unless (featurep 'xemacs)
7169 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7171 ;;;; Structure editing
7173 ;;; Inserting headlines
7175 (defun org-previous-line-empty-p ()
7176 (save-excursion
7177 (and (not (bobp))
7178 (or (beginning-of-line 0) t)
7179 (save-match-data
7182 (defun org-insert-heading (&optional force-heading invisible-ok)
7183 "Insert a new heading or item with same depth at point.
7184 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7185 If point is at the beginning of a headline, insert a sibling before the
7186 current headline. If point is not at the beginning, split the line,
7187 create the new headline with the text in the current line after point
7188 \(but see also the variable `org-M-RET-may-split-line').
7190 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7191 This is important for non-interactive uses of the command."
7192 (interactive "P")
7193 (if (or (= (buffer-size) 0)
7194 (and (not (save-excursion
7195 (and (ignore-errors (org-back-to-heading invisible-ok))
7196 (org-at-heading-p))))
7197 (or force-heading (not (org-in-item-p)))))
7198 (progn
7200 (run-hooks 'org-insert-heading-hook))
7201 (when (or force-heading (not (org-insert-item)))
7202 (let* ((empty-line-p nil)
7203 (level nil)
7204 (on-heading (org-at-heading-p))
7205 (head (save-excursion
7206 (condition-case nil
7207 (progn
7208 (org-back-to-heading invisible-ok)
7209 (when (and (not on-heading)
7210 (featurep 'org-inlinetask)
7211 (integerp org-inlinetask-min-level)
7212 (>= (length (match-string 0))
7213 org-inlinetask-min-level))
7214 ;; Find a heading level before the inline task
7215 (while (and (setq level (org-up-heading-safe))
7216 (>= level org-inlinetask-min-level)))
7217 (if (org-at-heading-p)
7218 (org-back-to-heading invisible-ok)
7219 (error "This should not happen")))
7220 (setq empty-line-p (org-previous-line-empty-p))
7221 (match-string 0))
7222 (error "*"))))
7223 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7224 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7225 pos hide-previous previous-pos)
7226 (cond
7227 ((and (org-at-heading-p) (bolp)
7228 (or (bobp)
7229 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7230 ;; insert before the current line
7231 (open-line (if blank 2 1)))
7232 ((and (bolp)
7233 (not org-insert-heading-respect-content)
7234 (or (bobp)
7235 (save-excursion
7236 (backward-char 1) (not (outline-invisible-p)))))
7237 ;; insert right here
7238 nil)
7239 (t
7240 ;; somewhere in the line
7241 (save-excursion
7242 (setq previous-pos (point-at-bol))
7243 (end-of-line)
7244 (setq hide-previous (outline-invisible-p)))
7245 (and org-insert-heading-respect-content (org-show-subtree))
7246 (let ((split
7247 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7248 (save-excursion
7249 (let ((p (point)))
7250 (goto-char (point-at-bol))
7251 (and (looking-at org-complex-heading-regexp)
7252 (match-beginning 4)
7253 (> p (match-beginning 4)))))))
7254 tags pos)
7255 (cond
7256 (org-insert-heading-respect-content
7257 (org-end-of-subtree nil t)
7258 (when (featurep 'org-inlinetask)
7259 (while (and (not (eobp))
7261 (>= (length (match-string 1))
7262 org-inlinetask-min-level))
7263 (org-end-of-subtree nil t)))
7264 (or (bolp) (newline))
7265 (or (org-previous-line-empty-p)
7266 (and blank (newline)))
7267 (open-line 1))
7268 ((org-at-heading-p)
7269 (when hide-previous
7270 (show-children)
7271 (org-show-entry))
7273 (setq tags (and (match-end 2) (match-string 2)))
7274 (and (match-end 1)
7275 (delete-region (match-beginning 1) (match-end 1)))
7276 (setq pos (point-at-bol))
7277 (or split (end-of-line 1))
7278 (delete-horizontal-space)
7280 (buffer-substring (point-at-bol) (point)))
7281 (insert " "))
7282 (newline (if blank 2 1))
7283 (when tags
7284 (save-excursion
7285 (goto-char pos)
7286 (end-of-line 1)
7287 (insert " " tags)
7288 (org-set-tags nil 'align))))
7289 (t
7290 (or split (end-of-line 1))
7291 (newline (if blank 2 1)))))))
7292 (insert head) (just-one-space)
7293 (setq pos (point))
7294 (end-of-line 1)
7295 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7296 (when (and org-insert-heading-respect-content hide-previous)
7297 (save-excursion
7298 (goto-char previous-pos)
7299 (hide-subtree)))
7300 (run-hooks 'org-insert-heading-hook)))))
7302 (defun org-get-heading (&optional no-tags no-todo)
7303 "Return the heading of the current entry, without the stars.
7304 When NO-TAGS is non-nil, don't include tags.
7305 When NO-TODO is non-nil, don't include TODO keywords."
7306 (save-excursion
7307 (org-back-to-heading t)
7308 (cond
7309 ((and no-tags no-todo)
7310 (looking-at org-complex-heading-regexp)
7311 (match-string 4))
7312 (no-tags
7313 (looking-at (concat org-outline-regexp
7316 (match-string 1))
7317 (no-todo
7318 (looking-at org-todo-line-regexp)
7319 (match-string 3))
7320 (t (looking-at org-heading-regexp)
7321 (match-string 2)))))
7323 (defun org-heading-components ()
7324 "Return the components of the current heading.
7325 This is a list with the following elements:
7326 - the level as an integer
7327 - the reduced level, different if `org-odd-levels-only' is set.
7328 - the TODO keyword, or nil
7329 - the priority character, like ?A, or nil if no priority is given
7330 - the headline text itself, or the tags string if no headline text
7331 - the tags string, or nil."
7332 (save-excursion
7333 (org-back-to-heading t)
7334 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7335 (list (length (match-string 1))
7336 (org-reduced-level (length (match-string 1)))
7337 (org-match-string-no-properties 2)
7338 (and (match-end 3) (aref (match-string 3) 2))
7339 (org-match-string-no-properties 4)
7340 (org-match-string-no-properties 5)))))
7342 (defun org-get-entry ()
7343 "Get the entry text, after heading, entire subtree."
7344 (save-excursion
7345 (org-back-to-heading t)
7346 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7348 (defun org-insert-heading-after-current ()
7349 "Insert a new heading with same level as current, after current subtree."
7350 (interactive)
7351 (org-back-to-heading)
7352 (org-insert-heading)
7353 (org-move-subtree-down)
7354 (end-of-line 1))
7356 (defun org-insert-heading-respect-content ()
7357 (interactive)
7358 (let ((org-insert-heading-respect-content t))
7359 (org-insert-heading t)))
7361 (defun org-insert-todo-heading-respect-content (&optional force-state)
7362 (interactive "P")
7363 (let ((org-insert-heading-respect-content t))
7364 (org-insert-todo-heading force-state t)))
7366 (defun org-insert-todo-heading (arg &optional force-heading)
7367 "Insert a new heading with the same level and TODO state as current heading.
7368 If the heading has no TODO state, or if the state is DONE, use the first
7369 state (TODO by default). Also with prefix arg, force first state."
7370 (interactive "P")
7371 (when (or force-heading (not (org-insert-item 'checkbox)))
7372 (org-insert-heading force-heading)
7373 (save-excursion
7374 (org-back-to-heading)
7375 (outline-previous-heading)
7376 (looking-at org-todo-line-regexp))
7377 (let*
7378 ((new-mark-x
7379 (if (or arg
7380 (not (match-beginning 2))
7381 (member (match-string 2) org-done-keywords))
7382 (car org-todo-keywords-1)
7383 (match-string 2)))
7384 (new-mark
7385 (or
7386 (run-hook-with-args-until-success
7387 'org-todo-get-default-hook new-mark-x nil)
7388 new-mark-x)))
7389 (beginning-of-line 1)
7390 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7391 (if org-treat-insert-todo-heading-as-state-change
7392 (org-todo new-mark)
7393 (insert new-mark " "))))
7394 (when org-provide-todo-statistics
7395 (org-update-parent-todo-statistics))))
7397 (defun org-insert-subheading (arg)
7398 "Insert a new subheading and demote it.
7399 Works for outline headings and for plain lists alike."
7400 (interactive "P")
7401 (org-insert-heading arg)
7402 (cond
7403 ((org-at-heading-p) (org-do-demote))
7404 ((org-at-item-p) (org-indent-item))))
7406 (defun org-insert-todo-subheading (arg)
7407 "Insert a new subheading with TODO keyword or checkbox and demote it.
7408 Works for outline headings and for plain lists alike."
7409 (interactive "P")
7410 (org-insert-todo-heading arg)
7411 (cond
7412 ((org-at-heading-p) (org-do-demote))
7413 ((org-at-item-p) (org-indent-item))))
7415 ;;; Promotion and Demotion
7417 (defvar org-after-demote-entry-hook nil
7418 "Hook run after an entry has been demoted.
7419 The cursor will be at the beginning of the entry.
7420 When a subtree is being demoted, the hook will be called for each node.")
7422 (defvar org-after-promote-entry-hook nil
7423 "Hook run after an entry has been promoted.
7424 The cursor will be at the beginning of the entry.
7425 When a subtree is being promoted, the hook will be called for each node.")
7427 (defun org-promote-subtree ()
7428 "Promote the entire subtree.
7429 See also `org-promote'."
7430 (interactive)
7431 (save-excursion
7432 (org-with-limited-levels (org-map-tree 'org-promote)))
7433 (org-fix-position-after-promote))
7435 (defun org-demote-subtree ()
7436 "Demote the entire subtree. See `org-demote'.
7437 See also `org-promote'."
7438 (interactive)
7439 (save-excursion
7440 (org-with-limited-levels (org-map-tree 'org-demote)))
7441 (org-fix-position-after-promote))
7444 (defun org-do-promote ()
7445 "Promote the current heading higher up the tree.
7446 If the region is active in `transient-mark-mode', promote all headings
7447 in the region."
7448 (interactive)
7449 (save-excursion
7450 (if (org-region-active-p)
7451 (org-map-region 'org-promote (region-beginning) (region-end))
7452 (org-promote)))
7453 (org-fix-position-after-promote))
7455 (defun org-do-demote ()
7456 "Demote the current heading lower down the tree.
7457 If the region is active in `transient-mark-mode', demote all headings
7458 in the region."
7459 (interactive)
7460 (save-excursion
7461 (if (org-region-active-p)
7462 (org-map-region 'org-demote (region-beginning) (region-end))
7463 (org-demote)))
7464 (org-fix-position-after-promote))
7466 (defun org-fix-position-after-promote ()
7467 "Make sure that after pro/demotion cursor position is right."
7468 (let ((pos (point)))
7469 (when (save-excursion
7470 (beginning-of-line 1)
7471 (looking-at org-todo-line-regexp)
7472 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7473 (cond ((eobp) (insert " "))
7474 ((eolp) (insert " "))
7475 ((equal (char-after) ?\ ) (forward-char 1))))))
7477 (defun org-current-level ()
7478 "Return the level of the current entry, or nil if before the first headline.
7479 The level is the number of stars at the beginning of the headline."
7480 (save-excursion
7481 (org-with-limited-levels
7482 (if (ignore-errors (org-back-to-heading t))
7483 (funcall outline-level)))))
7485 (defun org-get-previous-line-level ()
7486 "Return the outline depth of the last headline before the current line.
7487 Returns 0 for the first headline in the buffer, and nil if before the
7488 first headline."
7489 (let ((current-level (org-current-level))
7490 (prev-level (when (> (line-number-at-pos) 1)
7491 (save-excursion
7492 (beginning-of-line 0)
7493 (org-current-level)))))
7494 (cond ((null current-level) nil) ; Before first headline
7495 ((null prev-level) 0) ; At first headline
7496 (prev-level))))
7498 (defun org-reduced-level (l)
7499 "Compute the effective level of a heading.
7500 This takes into account the setting of `org-odd-levels-only'."
7501 (cond
7502 ((zerop l) 0)
7503 (org-odd-levels-only (1+ (floor (/ l 2))))
7504 (t l)))
7506 (defun org-level-increment ()
7507 "Return the number of stars that will be added or removed at a
7508 time to headlines when structure editing, based on the value of
7509 `org-odd-levels-only'."
7510 (if org-odd-levels-only 2 1))
7512 (defun org-get-valid-level (level &optional change)
7513 "Rectify a level change under the influence of `org-odd-levels-only'
7514 LEVEL is a current level, CHANGE is by how much the level should be
7515 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7516 even level numbers will become the next higher odd number."
7517 (if org-odd-levels-only
7518 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7519 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7520 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7521 (max 1 (+ level (or change 0)))))
7523 (if (boundp 'define-obsolete-function-alias)
7524 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7525 (define-obsolete-function-alias 'org-get-legal-level
7526 'org-get-valid-level)
7527 (define-obsolete-function-alias 'org-get-legal-level
7528 'org-get-valid-level "23.1")))
7530 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7531 ;; ̀org-with-limited-levels'
7532 (defun org-promote ()
7533 "Promote the current heading higher up the tree.
7534 If the region is active in `transient-mark-mode', promote all headings
7535 in the region."
7536 (org-back-to-heading t)
7537 (let* ((level (save-match-data (funcall outline-level)))
7538 (after-change-functions (remove 'flyspell-after-change-function
7539 after-change-functions))
7540 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7541 (diff (abs (- level (length up-head) -1))))
7542 (cond ((and (= level 1) org-called-with-limited-levels
7543 org-allow-promoting-top-level-subtree)
7544 (replace-match "# " nil t))
7545 ((= level 1)
7546 (error "Cannot promote to level 0. UNDO to recover if necessary"))
7547 (t (replace-match up-head nil t)))
7548 ;; Fixup tag positioning
7549 (unless (= level 1)
7550 (and org-auto-align-tags (org-set-tags nil t))
7551 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7552 (run-hooks 'org-after-promote-entry-hook)))
7554 (defun org-demote ()
7555 "Demote the current heading lower down the tree.
7556 If the region is active in `transient-mark-mode', demote all headings
7557 in the region."
7558 (org-back-to-heading t)
7559 (let* ((level (save-match-data (funcall outline-level)))
7560 (after-change-functions (remove 'flyspell-after-change-function
7561 after-change-functions))
7562 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7563 (diff (abs (- level (length down-head) -1))))
7564 (replace-match down-head nil t)
7565 ;; Fixup tag positioning
7566 (and org-auto-align-tags (org-set-tags nil t))
7567 (if org-adapt-indentation (org-fixup-indentation diff))
7568 (run-hooks 'org-after-demote-entry-hook)))
7570 (defun org-cycle-level ()
7571 "Cycle the level of an empty headline through possible states.
7572 This goes first to child, then to parent, level, then up the hierarchy.
7573 After top level, it switches back to sibling level."
7574 (interactive)
7575 (let ((org-adapt-indentation nil))
7576 (when (org-point-at-end-of-empty-headline)
7577 (setq this-command 'org-cycle-level) ; Only needed for caching
7578 (let ((cur-level (org-current-level))
7579 (prev-level (org-get-previous-line-level)))
7580 (cond
7581 ;; If first headline in file, promote to top-level.
7582 ((= prev-level 0)
7583 (loop repeat (/ (- cur-level 1) (org-level-increment))
7584 do (org-do-promote)))
7585 ;; If same level as prev, demote one.
7586 ((= prev-level cur-level)
7587 (org-do-demote))
7588 ;; If parent is top-level, promote to top level if not already.
7589 ((= prev-level 1)
7590 (loop repeat (/ (- cur-level 1) (org-level-increment))
7591 do (org-do-promote)))
7592 ;; If top-level, return to prev-level.
7593 ((= cur-level 1)
7594 (loop repeat (/ (- prev-level 1) (org-level-increment))
7595 do (org-do-demote)))
7596 ;; If less than prev-level, promote one.
7597 ((< cur-level prev-level)
7598 (org-do-promote))
7599 ;; If deeper than prev-level, promote until higher than
7600 ;; prev-level.
7601 ((> cur-level prev-level)
7602 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7603 do (org-do-promote))))
7604 t))))
7606 (defun org-map-tree (fun)
7607 "Call FUN for every heading underneath the current one."
7608 (org-back-to-heading)
7609 (let ((level (funcall outline-level)))
7610 (save-excursion
7611 (funcall fun)
7612 (while (and (progn
7613 (outline-next-heading)
7614 (> (funcall outline-level) level))
7615 (not (eobp)))
7616 (funcall fun)))))
7618 (defun org-map-region (fun beg end)
7619 "Call FUN for every heading between BEG and END."
7620 (let ((org-ignore-region t))
7621 (save-excursion
7622 (setq end (copy-marker end))
7623 (goto-char beg)
7624 (if (and (re-search-forward org-outline-regexp-bol nil t)
7625 (< (point) end))
7626 (funcall fun))
7627 (while (and (progn
7628 (outline-next-heading)
7629 (< (point) end))
7630 (not (eobp)))
7631 (funcall fun)))))
7633 (defvar org-property-end-re) ; silence byte-compiler
7634 (defun org-fixup-indentation (diff)
7635 "Change the indentation in the current entry by DIFF.
7636 However, if any line in the current entry has no indentation, or if it
7637 would end up with no indentation after the change, nothing at all is done."
7638 (save-excursion
7639 (let ((end (save-excursion (outline-next-heading)
7640 (point-marker)))
7641 (prohibit (if (> diff 0)
7644 col)
7645 (unless (save-excursion (end-of-line 1)
7646 (re-search-forward prohibit end t))
7647 (while (and (< (point) end)
7649 (goto-char (match-end 0))
7650 (setq col (current-column))
7651 (if (< diff 0) (replace-match ""))
7652 (org-indent-to-column (+ diff col))))
7653 (move-marker end nil))))
7655 (defun org-convert-to-odd-levels ()
7656 "Convert an org-mode file with all levels allowed to one with odd levels.
7657 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7658 level 5 etc."
7659 (interactive)
7660 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7661 (let ((outline-level 'org-outline-level)
7662 (org-odd-levels-only nil) n)
7663 (save-excursion
7664 (goto-char (point-min))
7666 (setq n (- (length (match-string 0)) 2))
7667 (while (>= (setq n (1- n)) 0)
7668 (org-demote))
7669 (end-of-line 1))))))
7671 (defun org-convert-to-oddeven-levels ()
7672 "Convert an org-mode file with only odd levels to one with odd/even levels.
7673 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7674 file contains a section with an even level, conversion would
7675 destroy the structure of the file. An error is signaled in this
7676 case."
7677 (interactive)
7678 (goto-char (point-min))
7679 ;; First check if there are no even levels
7681 (org-show-context t)
7682 (error "Not all levels are odd in this file. Conversion not possible"))
7683 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7684 (let ((outline-regexp org-outline-regexp)
7685 (outline-level 'org-outline-level)
7686 (org-odd-levels-only nil) n)
7687 (save-excursion
7688 (goto-char (point-min))
7690 (setq n (/ (1- (length (match-string 0))) 2))
7691 (while (>= (setq n (1- n)) 0)
7692 (org-promote))
7693 (end-of-line 1))))))
7695 (defun org-tr-level (n)
7696 "Make N odd if required."
7697 (if org-odd-levels-only (1+ (/ n 2)) n))
7699 ;;; Vertical tree motion, cutting and pasting of subtrees
7701 (defun org-move-subtree-up (&optional arg)
7702 "Move the current subtree up past ARG headlines of the same level."
7703 (interactive "p")
7704 (org-move-subtree-down (- (prefix-numeric-value arg))))
7706 (defun org-move-subtree-down (&optional arg)
7707 "Move the current subtree down past ARG headlines of the same level."
7708 (interactive "p")
7709 (setq arg (prefix-numeric-value arg))
7710 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7711 'org-get-last-sibling))
7712 (ins-point (make-marker))
7713 (cnt (abs arg))
7714 (col (current-column))
7715 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7716 ;; Select the tree
7717 (org-back-to-heading)
7718 (setq beg0 (point))
7719 (save-excursion
7720 (setq ne-beg (org-back-over-empty-lines))
7721 (setq beg (point)))
7722 (save-match-data
7723 (save-excursion (outline-end-of-heading)
7724 (setq folded (outline-invisible-p)))
7725 (outline-end-of-subtree))
7726 (outline-next-heading)
7727 (setq ne-end (org-back-over-empty-lines))
7728 (setq end (point))
7729 (goto-char beg0)
7730 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7731 ;; include less whitespace
7732 (save-excursion
7733 (goto-char beg)
7734 (forward-line (- ne-beg ne-end))
7735 (setq beg (point))))
7736 ;; Find insertion point, with error handling
7737 (while (> cnt 0)
7738 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7739 (progn (goto-char beg0)
7740 (error "Cannot move past superior level or buffer limit")))
7741 (setq cnt (1- cnt)))
7742 (if (> arg 0)
7743 ;; Moving forward - still need to move over subtree
7744 (progn (org-end-of-subtree t t)
7745 (save-excursion
7746 (org-back-over-empty-lines)
7747 (or (bolp) (newline)))))
7748 (setq ne-ins (org-back-over-empty-lines))
7749 (move-marker ins-point (point))
7750 (setq txt (buffer-substring beg end))
7751 (org-save-markers-in-region beg end)
7752 (delete-region beg end)
7753 (org-remove-empty-overlays-at beg)
7754 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7755 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7757 (let ((bbb (point)))
7758 (insert-before-markers txt)
7759 (org-reinstall-markers-in-region bbb)
7760 (move-marker ins-point bbb))
7762 (setq ins-end (point))
7763 (goto-char ins-point)
7764 (org-skip-whitespace)
7765 (when (and (< arg 0)
7766 (org-first-sibling-p)
7767 (> ne-ins ne-beg))
7768 ;; Move whitespace back to beginning
7769 (save-excursion
7770 (goto-char ins-end)
7771 (let ((kill-whole-line t))
7772 (kill-line (- ne-ins ne-beg)) (point)))
7774 (move-marker ins-point nil)
7775 (if folded
7776 (hide-subtree)
7777 (org-show-entry)
7778 (show-children)
7779 (org-cycle-hide-drawers 'children))
7780 (org-clean-visibility-after-subtree-move)
7781 ;; move back to the initial column we were at
7782 (move-to-column col)))
7784 (defvar org-subtree-clip ""
7785 "Clipboard for cut and paste of subtrees.
7786 This is actually only a copy of the kill, because we use the normal kill
7787 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7789 (defvar org-subtree-clip-folded nil
7790 "Was the last copied subtree folded?
7791 This is used to fold the tree back after pasting.")
7793 (defun org-cut-subtree (&optional n)
7794 "Cut the current subtree into the clipboard.
7795 With prefix arg N, cut this many sequential subtrees.
7796 This is a short-hand for marking the subtree and then cutting it."
7797 (interactive "p")
7798 (org-copy-subtree n 'cut))
7800 (defun org-copy-subtree (&optional n cut force-store-markers)
7801 "Cut the current subtree into the clipboard.
7802 With prefix arg N, cut this many sequential subtrees.
7803 This is a short-hand for marking the subtree and then copying it.
7804 If CUT is non-nil, actually cut the subtree.
7805 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7806 of some markers in the region, even if CUT is non-nil. This is
7807 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7808 (interactive "p")
7809 (let (beg end folded (beg0 (point)))
7810 (if (org-called-interactively-p 'any)
7811 (org-back-to-heading nil) ; take what looks like a subtree
7812 (org-back-to-heading t)) ; take what is really there
7813 (org-back-over-empty-lines)
7814 (setq beg (point))
7816 (save-match-data
7817 (save-excursion (outline-end-of-heading)
7818 (setq folded (outline-invisible-p)))
7819 (condition-case nil
7820 (org-forward-heading-same-level (1- n) t)
7821 (error nil))
7822 (org-end-of-subtree t t))
7823 (org-back-over-empty-lines)
7824 (setq end (point))
7825 (goto-char beg0)
7826 (when (> end beg)
7827 (setq org-subtree-clip-folded folded)
7828 (when (or cut force-store-markers)
7829 (org-save-markers-in-region beg end))
7830 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7831 (setq org-subtree-clip (current-kill 0))
7832 (message "%s: Subtree(s) with %d characters"
7833 (if cut "Cut" "Copied")
7834 (length org-subtree-clip)))))
7836 (defun org-paste-subtree (&optional level tree for-yank)
7837 "Paste the clipboard as a subtree, with modification of headline level.
7838 The entire subtree is promoted or demoted in order to match a new headline
7839 level.
7841 If the cursor is at the beginning of a headline, the same level as
7842 that headline is used to paste the tree
7844 If not, the new level is derived from the *visible* headings
7845 before and after the insertion point, and taken to be the inferior headline
7846 level of the two. So if the previous visible heading is level 3 and the
7847 next is level 4 (or vice versa), level 4 will be used for insertion.
7848 This makes sure that the subtree remains an independent subtree and does
7849 not swallow low level entries.
7851 You can also force a different level, either by using a numeric prefix
7852 argument, or by inserting the heading marker by hand. For example, if the
7855 If optional TREE is given, use this text instead of the kill ring.
7857 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7858 move back over whitespace before inserting, and move point to the end of
7859 the inserted text when done."
7860 (interactive "P")
7861 (setq tree (or tree (and kill-ring (current-kill 0))))
7862 (unless (org-kill-is-subtree-p tree)
7863 (error "%s"
7864 (substitute-command-keys
7866 (org-with-limited-levels
7867 (let* ((visp (not (outline-invisible-p)))
7868 (txt tree)
7870 (old-level (if (string-match org-outline-regexp-bol txt)
7871 (- (match-end 0) (match-beginning 0) 1)
7872 -1))
7873 (force-level (cond (level (prefix-numeric-value level))
7875 (string-match
7877 (point-at-bol) (point))))
7878 (- (match-end 1) (match-beginning 1)))
7879 ((and (bolp)
7880 (looking-at org-outline-regexp))
7881 (- (match-end 0) (point) 1))))
7882 (previous-level (save-excursion
7883 (condition-case nil
7884 (progn
7885 (outline-previous-visible-heading 1)
7886 (if (looking-at ^re_)
7887 (- (match-end 0) (match-beginning 0) 1)
7888 1))
7889 (error 1))))
7890 (next-level (save-excursion
7891 (condition-case nil
7892 (progn
7893 (or (looking-at org-outline-regexp)
7894 (outline-next-visible-heading 1))
7895 (if (looking-at ^re_)
7896 (- (match-end 0) (match-beginning 0) 1)
7897 1))
7898 (error 1))))
7899 (new-level (or force-level (max previous-level next-level)))
7900 (shift (if (or (= old-level -1)
7901 (= new-level -1)
7902 (= old-level new-level))
7903 0
7904 (- new-level old-level)))
7905 (delta (if (> shift 0) -1 1))
7906 (func (if (> shift 0) 'org-demote 'org-promote))
7907 (org-odd-levels-only nil)
7908 beg end newend)
7909 ;; Remove the forced level indicator
7910 (if force-level
7911 (delete-region (point-at-bol) (point)))
7912 ;; Paste
7913 (beginning-of-line (if (bolp) 1 2))
7914 (unless for-yank (org-back-over-empty-lines))
7915 (setq beg (point))
7916 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7917 (insert-before-markers txt)
7919 (setq newend (point))
7920 (org-reinstall-markers-in-region beg)
7921 (setq end (point))
7922 (goto-char beg)
7924 (setq beg (point))
7925 (if (and (outline-invisible-p) visp)
7926 (save-excursion (outline-show-heading)))
7927 ;; Shift if necessary
7928 (unless (= shift 0)
7929 (save-restriction
7930 (narrow-to-region beg end)
7931 (while (not (= shift 0))
7932 (org-map-region func (point-min) (point-max))
7933 (setq shift (+ delta shift)))
7934 (goto-char (point-min))
7935 (setq newend (point-max))))
7936 (when (or (org-called-interactively-p 'interactive) for-yank)
7937 (message "Clipboard pasted as level %d subtree" new-level))
7938 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7939 kill-ring
7940 (eq org-subtree-clip (current-kill 0))
7941 org-subtree-clip-folded)
7942 ;; The tree was folded before it was killed/copied
7943 (hide-subtree))
7944 (and for-yank (goto-char newend)))))
7946 (defun org-kill-is-subtree-p (&optional txt)
7947 "Check if the current kill is an outline subtree, or a set of trees.
7948 Returns nil if kill does not start with a headline, or if the first
7949 headline level is not the largest headline level in the tree.
7950 So this will actually accept several entries of equal levels as well,
7951 which is OK for `org-paste-subtree'.
7952 If optional TXT is given, check this string instead of the current kill."
7953 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7954 (re (org-get-limited-outline-regexp))
7955 (^re (concat "^" re))
7956 (start-level (and kill
7957 (string-match
7959 kill)
7960 (- (match-end 2) (match-beginning 2) 1)))
7961 (start (1+ (or (match-beginning 2) -1))))
7962 (if (not start-level)
7963 (progn
7964 nil) ;; does not even start with a heading
7965 (catch 'exit
7966 (while (setq start (string-match ^re kill (1+ start)))
7967 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7968 (throw 'exit nil)))
7969 t))))
7971 (defvar org-markers-to-move nil
7972 "Markers that should be moved with a cut-and-paste operation.
7973 Those markers are stored together with their positions relative to
7974 the start of the region.")
7976 (defun org-save-markers-in-region (beg end)
7977 "Check markers in region.
7978 If these markers are between BEG and END, record their position relative
7979 to BEG, so that after moving the block of text, we can put the markers back
7980 into place.
7981 This function gets called just before an entry or tree gets cut from the
7982 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7983 called immediately, to move the markers with the entries."
7984 (setq org-markers-to-move nil)
7985 (when (featurep 'org-clock)
7986 (org-clock-save-markers-for-cut-and-paste beg end))
7987 (when (featurep 'org-agenda)
7988 (org-agenda-save-markers-for-cut-and-paste beg end)))
7990 (defun org-check-and-save-marker (marker beg end)
7991 "Check if MARKER is between BEG and END.
7992 If yes, remember the marker and the distance to BEG."
7993 (when (and (marker-buffer marker)
7994 (equal (marker-buffer marker) (current-buffer)))
7995 (if (and (>= marker beg) (< marker end))
7996 (push (cons marker (- marker beg)) org-markers-to-move))))
7998 (defun org-reinstall-markers-in-region (beg)
7999 "Move all remembered markers to their position relative to BEG."
8000 (mapc (lambda (x)
8001 (move-marker (car x) (+ beg (cdr x))))
8002 org-markers-to-move)
8003 (setq org-markers-to-move nil))
8005 (defun org-narrow-to-subtree ()
8006 "Narrow buffer to the current subtree."
8007 (interactive)
8008 (save-excursion
8009 (save-match-data
8010 (org-with-limited-levels
8011 (narrow-to-region
8012 (progn (org-back-to-heading t) (point))
8013 (progn (org-end-of-subtree t t)
8014 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8015 (point)))))))
8017 (defun org-narrow-to-block ()
8018 "Narrow buffer to the current block."
8019 (interactive)
8020 (let* ((case-fold-search t)
8023 (if blockp
8024 (narrow-to-region (car blockp) (cdr blockp))
8025 (error "Not in a block"))))
8027 (eval-when-compile
8028 (defvar org-property-drawer-re))
8030 (defvar org-property-start-re) ;; defined below
8031 (defun org-clone-subtree-with-time-shift (n &optional shift)
8032 "Clone the task (subtree) at point N times.
8033 The clones will be inserted as siblings.
8035 In interactive use, the user will be prompted for the number of
8036 clones to be produced, and for a time SHIFT, which may be a
8037 repeater as used in time stamps, for example `+3d'.
8039 When a valid repeater is given and the entry contains any time
8040 stamps, the clones will become a sequence in time, with time
8041 stamps in the subtree shifted for each clone produced. If SHIFT
8042 is nil or the empty string, time stamps will be left alone. The
8043 ID property of the original subtree is removed.
8045 If the original subtree did contain time stamps with a repeater,
8046 the following will happen:
8047 - the repeater will be removed in each clone
8048 - an additional clone will be produced, with the current, unshifted
8049 date(s) in the entry.
8050 - the original entry will be placed *after* all the clones, with
8051 repeater intact.
8052 - the start days in the repeater in the original entry will be shifted
8053 to past the last clone.
8054 In this way you can spell out a number of instances of a repeating task,
8055 and still retain the repeater to cover future instances of the task."
8056 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
8057 (let (beg end template task idprop
8058 shift-n shift-what doshift nmin nmax (n-no-remove -1)
8059 (drawer-re org-drawer-regexp))
8060 (if (not (and (integerp n) (> n 0)))
8061 (error "Invalid number of replications %s" n))
8064 shift)))
8065 (error "Invalid shift specification %s" shift))
8066 (when doshift
8067 (setq shift-n (string-to-number (match-string 1 shift))
8068 shift-what (cdr (assoc (match-string 2 shift)
8069 '(("d" . day) ("w" . week)
8070 ("m" . month) ("y" . year))))))
8071 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8072 (setq nmin 1 nmax n)
8073 (org-back-to-heading t)
8074 (setq beg (point))
8075 (setq idprop (org-entry-get nil "ID"))
8076 (org-end-of-subtree t t)
8078 (setq end (point))
8079 (setq template (buffer-substring beg end))
8080 (when (and doshift
8082 (delete-region beg end)
8083 (setq end beg)
8084 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8085 (goto-char end)
8086 (loop for n from nmin to nmax do
8087 ;; prepare clone
8088 (with-temp-buffer
8089 (insert template)
8090 (org-mode)
8091 (goto-char (point-min))
8092 (org-show-subtree)
8093 (and idprop (if org-clone-delete-id
8094 (org-entry-delete nil "ID")
8095 (org-id-get-create t)))
8096 (unless (= n 0)
8098 (kill-whole-line))
8099 (goto-char (point-min))
8100 (while (re-search-forward drawer-re nil t)
8101 (mapc (lambda (d)
8102 (org-remove-empty-drawer-at d (point))) org-drawers)))
8103 (goto-char (point-min))
8104 (when doshift
8105 (while (re-search-forward org-ts-regexp-both nil t)
8106 (org-timestamp-change (* n shift-n) shift-what))
8107 (unless (= n n-no-remove)
8108 (goto-char (point-min))
8109 (while (re-search-forward org-ts-regexp nil t)
8110 (save-excursion
8111 (goto-char (match-beginning 0))
8113 (delete-region (match-beginning 1) (match-end 1)))))))
8114 (setq task (buffer-string)))
8115 (insert task))
8116 (goto-char beg)))
8118 ;;; Outline Sorting
8120 (defun org-sort (with-case)
8121 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8122 Optional argument WITH-CASE means sort case-sensitively."
8123 (interactive "P")
8124 (cond
8125 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8126 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8127 (t
8128 (org-call-with-arg 'org-sort-entries with-case))))
8130 (defun org-sort-remove-invisible (s)
8131 (remove-text-properties 0 (length s) org-rm-props s)
8132 (while (string-match org-bracket-link-regexp s)
8133 (setq s (replace-match (if (match-end 2)
8134 (match-string 3 s)
8135 (match-string 1 s)) t t s)))
8136 s)
8138 (defvar org-priority-regexp) ; defined later in the file
8140 (defvar org-after-sorting-entries-or-items-hook nil
8141 "Hook that is run after a bunch of entries or items have been sorted.
8142 When children are sorted, the cursor is in the parent line when this
8143 hook gets called. When a region or a plain list is sorted, the cursor
8144 will be in the first entry of the sorted region/list.")
8146 (defun org-sort-entries
8147 (&optional with-case sorting-type getkey-func compare-func property)
8148 "Sort entries on a certain level of an outline tree.
8149 If there is an active region, the entries in the region are sorted.
8150 Else, if the cursor is before the first entry, sort the top-level items.
8151 Else, the children of the entry at point are sorted.
8153 Sorting can be alphabetically, numerically, by date/time as given by
8154 a time stamp, by a property or by priority.
8156 The command prompts for the sorting type unless it has been given to the
8157 function through the SORTING-TYPE argument, which needs to be a character,
8158 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8159 precise meaning of each character:
8161 n Numerically, by converting the beginning of the entry/item to a number.
8162 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8163 o By order of TODO keywords.
8164 t By date/time, either the first active time stamp in the entry, or, if
8165 none exist, by the first inactive one.
8166 s By the scheduled date/time.
8167 d By deadline date/time.
8168 c By creation time, which is assumed to be the first inactive time stamp
8169 at the beginning of a line.
8170 p By priority according to the cookie.
8171 r By the value of a property.
8173 Capital letters will reverse the sort order.
8175 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8176 called with point at the beginning of the record. It must return either
8177 a string or a number that should serve as the sorting key for that record.
8179 Comparing entries ignores case by default. However, with an optional argument
8180 WITH-CASE, the sorting considers case as well."
8181 (interactive "P")
8182 (let ((case-func (if with-case 'identity 'downcase))
8183 (cmstr
8184 ;; The clock marker is lost when using `sort-subr', let's
8185 ;; store the clocking string.
8186 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8187 (save-excursion
8188 (goto-char org-clock-marker)
8189 (looking-back "^.*") (match-string-no-properties 0))))
8190 start beg end stars re re2
8191 txt what tmp)
8192 ;; Find beginning and end of region to sort
8193 (cond
8194 ((org-region-active-p)
8195 ;; we will sort the region
8196 (setq end (region-end)
8197 what "region")
8198 (goto-char (region-beginning))
8199 (if (not (org-at-heading-p)) (outline-next-heading))
8200 (setq start (point)))
8201 ((or (org-at-heading-p)
8202 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8203 ;; we will sort the children of the current headline
8204 (org-back-to-heading)
8205 (setq start (point)
8206 end (progn (org-end-of-subtree t t)
8208 (org-back-over-empty-lines)
8209 (point))
8210 what "children")
8211 (goto-char start)
8212 (show-subtree)
8213 (outline-next-heading))
8214 (t
8215 ;; we will sort the top-level entries in this file
8216 (goto-char (point-min))
8217 (or (org-at-heading-p) (outline-next-heading))
8218 (setq start (point))
8219 (goto-char (point-max))
8220 (beginning-of-line 1)
8222 ;; File ends in a non-white line
8223 (end-of-line 1)
8225 (setq end (point-max))
8226 (setq what "top-level")
8227 (goto-char start)
8228 (show-all)))
8230 (setq beg (point))
8231 (if (>= beg end) (error "Nothing to sort"))
8234 (setq stars (match-string 1)
8235 re (concat "^" (regexp-quote stars) " +")
8237 txt (buffer-substring beg end))
8239 (if (and (not (equal stars "*")) (string-match re2 txt))
8240 (error "Region to sort contains a level above the first entry"))
8242 (unless sorting-type
8243 (message
8244 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8246 A/N/P/R/O/F/T/S/D/C means reversed:"
8247 what)
8248 (setq sorting-type (read-char-exclusive))
8250 (unless getkey-func
8251 (and (= (downcase sorting-type) ?f)
8252 (setq getkey-func
8253 (org-icompleting-read "Sort using function: "
8254 obarray 'fboundp t nil nil))
8255 (setq getkey-func (intern getkey-func))))
8257 (and (= (downcase sorting-type) ?r)
8258 (not property)
8259 (setq property
8260 (org-icompleting-read "Property: "
8261 (mapcar 'list (org-buffer-property-keys t))
8262 nil t))))
8264 (message "Sorting entries...")
8266 (save-restriction
8267 (narrow-to-region start end)
8268 (let ((dcst (downcase sorting-type))
8269 (case-fold-search nil)
8270 (now (current-time)))
8271 (sort-subr
8272 (/= dcst sorting-type)
8273 ;; This function moves to the beginning character of the "record" to
8274 ;; be sorted.
8275 (lambda nil
8276 (if (re-search-forward re nil t)
8277 (goto-char (match-beginning 0))
8278 (goto-char (point-max))))
8279 ;; This function moves to the last character of the "record" being
8280 ;; sorted.
8281 (lambda nil
8282 (save-match-data
8283 (condition-case nil
8284 (outline-forward-same-level 1)
8285 (error
8286 (goto-char (point-max))))))
8287 ;; This function returns the value that gets sorted against.
8288 (lambda nil
8289 (cond
8290 ((= dcst ?n)
8291 (if (looking-at org-complex-heading-regexp)
8292 (string-to-number (match-string 4))
8293 nil))
8294 ((= dcst ?a)
8295 (if (looking-at org-complex-heading-regexp)
8296 (funcall case-func (match-string 4))
8297 nil))
8298 ((= dcst ?t)
8299 (let ((end (save-excursion (outline-next-heading) (point))))
8300 (if (or (re-search-forward org-ts-regexp end t)
8301 (re-search-forward org-ts-regexp-both end t))
8302 (org-time-string-to-seconds (match-string 0))
8303 (org-float-time now))))
8304 ((= dcst ?c)
8305 (let ((end (save-excursion (outline-next-heading) (point))))
8306 (if (re-search-forward
8308 end t)
8309 (org-time-string-to-seconds (match-string 0))
8310 (org-float-time now))))
8311 ((= dcst ?s)
8312 (let ((end (save-excursion (outline-next-heading) (point))))
8313 (if (re-search-forward org-scheduled-time-regexp end t)
8314 (org-time-string-to-seconds (match-string 1))
8315 (org-float-time now))))
8316 ((= dcst ?d)
8317 (let ((end (save-excursion (outline-next-heading) (point))))
8318 (if (re-search-forward org-deadline-time-regexp end t)
8319 (org-time-string-to-seconds (match-string 1))
8320 (org-float-time now))))
8321 ((= dcst ?p)
8322 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8323 (string-to-char (match-string 2))
8324 org-default-priority))
8325 ((= dcst ?r)
8326 (or (org-entry-get nil property) ""))
8327 ((= dcst ?o)
8328 (if (looking-at org-complex-heading-regexp)
8329 (- 9999 (length (member (match-string 2)
8330 org-todo-keywords-1)))))
8331 ((= dcst ?f)
8332 (if getkey-func
8333 (progn
8334 (setq tmp (funcall getkey-func))
8335 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8336 tmp)
8337 (error "Invalid key function `%s'" getkey-func)))
8338 (t (error "Invalid sorting type `%c'" sorting-type))))
8339 nil
8340 (cond
8341 ((= dcst ?a) 'string<)
8342 ((= dcst ?f) compare-func)
8343 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8344 (run-hooks 'org-after-sorting-entries-or-items-hook)
8345 ;; Reset the clock marker if needed
8346 (when cmstr
8347 (save-excursion
8348 (goto-char start)
8349 (search-forward cmstr nil t)
8350 (move-marker org-clock-marker (point))))
8351 (message "Sorting entries...done")))
8353 (defun org-do-sort (table what &optional with-case sorting-type)
8354 "Sort TABLE of WHAT according to SORTING-TYPE.
8355 The user will be prompted for the SORTING-TYPE if the call to this
8356 function does not specify it. WHAT is only for the prompt, to indicate
8357 what is being sorted. The sorting key will be extracted from
8358 the car of the elements of the table.
8359 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8360 (unless sorting-type
8361 (message
8362 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8363 what)
8364 (setq sorting-type (read-char-exclusive)))
8365 (let ((dcst (downcase sorting-type))
8366 extractfun comparefun)
8367 ;; Define the appropriate functions
8368 (cond
8369 ((= dcst ?n)
8370 (setq extractfun 'string-to-number
8371 comparefun (if (= dcst sorting-type) '< '>)))
8372 ((= dcst ?a)
8373 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8374 (lambda(x) (downcase (org-sort-remove-invisible x))))
8375 comparefun (if (= dcst sorting-type)
8376 'string<
8377 (lambda (a b) (and (not (string< a b))
8378 (not (string= a b)))))))
8379 ((= dcst ?t)
8380 (setq extractfun
8381 (lambda (x)
8382 (if (or (string-match org-ts-regexp x)
8383 (string-match org-ts-regexp-both x))
8384 (org-float-time
8385 (org-time-string-to-time (match-string 0 x)))
8386 0))
8387 comparefun (if (= dcst sorting-type) '< '>)))
8388 (t (error "Invalid sorting type `%c'" sorting-type)))
8390 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8391 table)
8392 (lambda (a b) (funcall comparefun (car a) (car b))))))
8395 ;;; The orgstruct minor mode
8397 ;; Define a minor mode which can be used in other modes in order to
8398 ;; integrate the org-mode structure editing commands.
8400 ;; This is really a hack, because the org-mode structure commands use
8401 ;; keys which normally belong to the major mode. Here is how it
8402 ;; works: The minor mode defines all the keys necessary to operate the
8403 ;; structure commands, but wraps the commands into a function which
8404 ;; tests if the cursor is currently at a headline or a plain list
8405 ;; item. If that is the case, the structure command is used,
8406 ;; temporarily setting many Org-mode variables like regular
8407 ;; expressions for filling etc. However, when any of those keys is
8408 ;; used at a different location, function uses `key-binding' to look
8409 ;; up if the key has an associated command in another currently active
8410 ;; keymap (minor modes, major mode, global), and executes that
8411 ;; command. There might be problems if any of the keys is otherwise
8412 ;; used as a prefix key.
8414 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8415 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8416 ;; addresses this by checking explicitly for both bindings.
8418 (defvar orgstruct-mode-map (make-sparse-keymap)
8419 "Keymap for the minor `orgstruct-mode'.")
8421 (defvar org-local-vars nil
8422 "List of local variables, for use by `orgstruct-mode'.")
8424 ;;;###autoload
8425 (define-minor-mode orgstruct-mode
8426 "Toggle the minor mode `orgstruct-mode'.
8427 This mode is for using Org-mode structure commands in other
8428 modes. The following keys behave as if Org-mode were active, if
8429 the cursor is on a headline, or on a plain list item (both as
8430 defined by Org-mode).
8432 M-up Move entry/item up
8433 M-down Move entry/item down
8434 M-left Promote
8435 M-right Demote
8436 M-S-up Move entry/item up
8437 M-S-down Move entry/item down
8438 M-S-left Promote subtree
8439 M-S-right Demote subtree
8440 M-q Fill paragraph and items like in Org-mode
8441 C-c ^ Sort entries
8442 C-c - Cycle list bullet
8443 TAB Cycle item visibility
8444 M-RET Insert new heading/item
8445 S-M-RET Insert new TODO heading / Checkbox item
8446 C-c C-c Set tags / toggle checkbox"
8447 nil " OrgStruct" nil
8448 (org-load-modules-maybe)
8449 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8451 ;;;###autoload
8452 (defun turn-on-orgstruct ()
8453 "Unconditionally turn on `orgstruct-mode'."
8454 (orgstruct-mode 1))
8456 (defvar org-fb-vars nil)
8457 (make-variable-buffer-local 'org-fb-vars)
8458 (defun orgstruct++-mode (&optional arg)
8459 "Toggle `orgstruct-mode', the enhanced version of it.
8460 In addition to setting orgstruct-mode, this also exports all
8461 indentation and autofilling variables from org-mode into the
8462 buffer. It will also recognize item context in multiline items."
8463 (interactive "P")
8464 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8465 (if (< arg 1)
8466 (progn (orgstruct-mode -1)
8467 (mapc (lambda(v)
8468 (org-set-local (car v)
8469 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8470 org-fb-vars))
8471 (orgstruct-mode 1)
8472 (setq org-fb-vars nil)
8473 (let (var val)
8474 (mapc
8475 (lambda (x)
8476 (when (string-match
8478 (symbol-name (car x)))
8479 (setq var (car x) val (nth 1 x))
8480 (push (list var `(quote ,(eval var))) org-fb-vars)
8481 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8482 org-local-vars)
8483 (org-set-local 'orgstruct-is-++ t))))
8485 (defvar orgstruct-is-++ nil
8486 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8487 (make-variable-buffer-local 'orgstruct-is-++)
8489 ;;;###autoload
8490 (defun turn-on-orgstruct++ ()
8491 "Unconditionally turn on `orgstruct++-mode'."
8492 (orgstruct++-mode 1))
8494 (defun orgstruct-error ()
8495 "Error when there is no default binding for a structure key."
8496 (interactive)
8497 (error "This key has no function outside structure elements"))
8499 (defun orgstruct-setup ()
8500 "Setup orgstruct keymaps."
8501 (let ((nfunc 0)
8502 (bindings
8503 (list
8504 '([(meta up)] org-metaup)
8505 '([(meta down)] org-metadown)
8506 '([(meta left)] org-metaleft)
8507 '([(meta right)] org-metaright)
8508 '([(meta shift up)] org-shiftmetaup)
8509 '([(meta shift down)] org-shiftmetadown)
8510 '([(meta shift left)] org-shiftmetaleft)
8511 '([(meta shift right)] org-shiftmetaright)
8512 '([?\e (up)] org-metaup)
8513 '([?\e (down)] org-metadown)
8514 '([?\e (left)] org-metaleft)
8515 '([?\e (right)] org-metaright)
8516 '([?\e (shift up)] org-shiftmetaup)
8517 '([?\e (shift down)] org-shiftmetadown)
8518 '([?\e (shift left)] org-shiftmetaleft)
8519 '([?\e (shift right)] org-shiftmetaright)
8520 '([(shift up)] org-shiftup)
8521 '([(shift down)] org-shiftdown)
8522 '([(shift left)] org-shiftleft)
8523 '([(shift right)] org-shiftright)
8524 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8525 '("\M-q" fill-paragraph)
8526 '("\C-c^" org-sort)
8527 '("\C-c-" org-cycle-list-bullet)))
8528 elt key fun cmd)
8529 (while (setq elt (pop bindings))
8530 (setq nfunc (1+ nfunc))
8531 (setq key (org-key (car elt))
8532 fun (nth 1 elt)
8533 cmd (orgstruct-make-binding fun nfunc key))
8534 (org-defkey orgstruct-mode-map key cmd))
8536 ;; Prevent an error for users who forgot to make autoloads
8537 (require 'org-element)
8539 ;; Special treatment needed for TAB and RET
8540 (org-defkey orgstruct-mode-map [(tab)]
8541 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8542 (org-defkey orgstruct-mode-map "\C-i"
8543 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8545 (org-defkey orgstruct-mode-map "\M-\C-m"
8546 (orgstruct-make-binding 'org-insert-heading 105
8547 "\M-\C-m" [(meta return)]))
8548 (org-defkey orgstruct-mode-map [(meta return)]
8549 (orgstruct-make-binding 'org-insert-heading 106
8550 [(meta return)] "\M-\C-m"))
8552 (org-defkey orgstruct-mode-map [(shift meta return)]
8553 (orgstruct-make-binding 'org-insert-todo-heading 107
8554 [(meta return)] "\M-\C-m"))
8556 (org-defkey orgstruct-mode-map "\e\C-m"
8557 (orgstruct-make-binding 'org-insert-heading 108
8558 "\e\C-m" [?\e (return)]))
8559 (org-defkey orgstruct-mode-map [?\e (return)]
8560 (orgstruct-make-binding 'org-insert-heading 109
8561 [?\e (return)] "\e\C-m"))
8562 (org-defkey orgstruct-mode-map [?\e (shift return)]
8563 (orgstruct-make-binding 'org-insert-todo-heading 110
8564 [?\e (return)] "\e\C-m"))
8566 (unless org-local-vars
8567 (setq org-local-vars (org-get-local-variables)))
8569 t))
8571 (defun orgstruct-make-binding (fun n &rest keys)
8572 "Create a function for binding in the structure minor mode.
8573 FUN is the command to call inside a table. N is used to create a unique
8574 command name. KEYS are keys that should be checked in for a command
8575 to execute outside of tables."
8576 (eval
8577 (list 'defun
8578 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8579 '(arg)
8581 "Outside of structure, run the binding of `"
8582 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8583 "'.")
8584 '(interactive "p")
8585 (list 'if
8586 `(org-context-p 'headline 'item
8587 (and orgstruct-is-++
8588 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8589 'item-body))
8590 (list 'org-run-like-in-org-mode (list 'quote fun))
8591 (list 'let '(orgstruct-mode)
8592 (list 'call-interactively
8593 (append '(or)
8594 (mapcar (lambda (k)
8595 (list 'key-binding k))
8596 keys)
8597 '('orgstruct-error))))))))
8599 (defun org-contextualize-keys (alist contexts)
8600 "Return valid elements in ALIST depending on CONTEXTS.
8602 `org-agenda-custom-commands' or `org-capture-templates' are the
8603 values used for ALIST, and `org-agenda-custom-commands-contexts'
8604 or `org-capture-templates-contexts' are the associated contexts
8605 definitions."
8606 (let ((contexts
8607 ;; normalize contexts
8608 (mapcar
8609 (lambda(c) (cond ((listp (cadr c))
8610 (list (car c) (car c) (cadr c)))
8611 ((string= "" (cadr c))
8612 (list (car c) (car c) (caddr c)))
8613 (t c))) contexts))
8614 (a alist) c r s)
8615 ;; loop over all commands or templates
8616 (while (setq c (pop a))
8617 (let (vrules repl)
8618 (cond
8619 ((not (assoc (car c) contexts))
8620 (push c r))
8621 ((and (assoc (car c) contexts)
8622 (setq vrules (org-contextualize-validate-key
8623 (car c) contexts)))
8624 (mapc (lambda (vr)
8625 (when (not (equal (car vr) (cadr vr)))
8626 (setq repl vr))) vrules)
8627 (if (not repl) (push c r)
8628 (push (cadr repl) s)
8629 (push
8630 (cons (car c)
8631 (cdr (or (assoc (cadr repl) alist)
8632 (error "Undefined key `%s' as contextual replacement for `%s'"
8633 (cadr repl) (car c)))))
8634 r))))))
8635 ;; Return limited ALIST, possibly with keys modified, and deduplicated
8636 (delq
8637 nil
8638 (delete-dups
8639 (mapcar (lambda (x)
8640 (let ((tpl (car x)))
8641 (when (not (delq
8642 nil
8643 (mapcar (lambda(y)
8644 (equal y tpl)) s))) x)))
8645 (reverse r))))))
8647 (defun org-contextualize-validate-key (key contexts)
8648 "Check CONTEXTS for agenda or capture KEY."
8649 (let (r rr res)
8650 (while (setq r (pop contexts))
8651 (mapc
8652 (lambda (rr)
8653 (when
8654 (and (equal key (car r))
8655 (if (functionp rr) (funcall rr)
8656 (or (and (eq (car rr) 'in-file)
8657 (buffer-file-name)
8658 (string-match (cdr rr) (buffer-file-name)))
8659 (and (eq (car rr) 'in-mode)
8660 (string-match (cdr rr) (symbol-name major-mode)))
8661 (when (and (eq (car rr) 'not-in-file)
8662 (buffer-file-name))
8663 (not (string-match (cdr rr) (buffer-file-name))))
8664 (when (eq (car rr) 'not-in-mode)
8665 (not (string-match (cdr rr) (symbol-name major-mode)))))))
8666 (push r res)))
8667 (car (last r))))
8668 (delete-dups (delq nil res))))
8670 (defun org-context-p (&rest contexts)
8671 "Check if local context is any of CONTEXTS.
8672 Possible values in the list of contexts are `table', `headline', and `item'."
8673 (let ((pos (point)))
8674 (goto-char (point-at-bol))
8675 (prog1 (or (and (memq 'table contexts)
8677 (and (memq 'headline contexts)
8678 (looking-at org-outline-regexp))
8679 (and (memq 'item contexts)
8681 (and (memq 'item-body contexts)
8682 (org-in-item-p)))
8683 (goto-char pos))))
8685 (defun org-get-local-variables ()
8686 "Return a list of all local variables in an Org mode buffer."
8687 (let (varlist)
8688 (with-current-buffer (get-buffer-create "*Org tmp*")
8689 (erase-buffer)
8690 (org-mode)
8691 (setq varlist (buffer-local-variables)))
8692 (kill-buffer "*Org tmp*")
8693 (delq nil
8694 (mapcar
8695 (lambda (x)
8696 (setq x
8697 (if (symbolp x)
8698 (list x)
8699 (list (car x) (list 'quote (cdr x)))))
8700 (if (string-match
8701 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
8702 (symbol-name (car x)))
8703 x nil))
8704 varlist))))
8706 (defun org-clone-local-variables (from-buffer &optional regexp)
8707 "Clone local variables from FROM-BUFFER.
8708 Optional argument REGEXP selects variables to clone."
8709 (mapc
8710 (lambda (pair)
8711 (and (symbolp (car pair))
8712 (or (null regexp)
8713 (string-match regexp (symbol-name (car pair))))
8714 (set (make-local-variable (car pair))
8715 (cdr pair))))
8716 (buffer-local-variables from-buffer)))
8718 ;;;###autoload
8719 (defun org-run-like-in-org-mode (cmd)
8720 "Run a command, pretending that the current buffer is in Org-mode.
8721 This will temporarily bind local variables that are typically bound in
8722 Org-mode to the values they have in Org-mode, and then interactively
8723 call CMD."
8724 (org-load-modules-maybe)
8725 (unless org-local-vars
8726 (setq org-local-vars (org-get-local-variables)))
8727 (eval (list 'let org-local-vars
8728 (list 'call-interactively (list 'quote cmd)))))
8730 ;;;; Archiving
8732 (defun org-get-category (&optional pos force-refresh)
8733 "Get the category applying to position POS."
8734 (save-match-data
8735 (if force-refresh (org-refresh-category-properties))
8736 (let ((pos (or pos (point))))
8737 (or (get-text-property pos 'org-category)
8738 (progn (org-refresh-category-properties)
8739 (get-text-property pos 'org-category))))))
8741 (defun org-refresh-category-properties ()
8742 "Refresh category text properties in the buffer."
8743 (let ((case-fold-search t)
8744 (inhibit-read-only t)
8745 (def-cat (cond
8746 ((null org-category)
8747 (if buffer-file-name
8748 (file-name-sans-extension
8749 (file-name-nondirectory buffer-file-name))
8750 "???"))
8751 ((symbolp org-category) (symbol-name org-category))
8752 (t org-category)))
8753 beg end cat pos optionp)
8754 (org-unmodified
8755 (save-excursion
8756 (save-restriction
8757 (widen)
8758 (goto-char (point-min))
8759 (put-text-property (point) (point-max) 'org-category def-cat)
8760 (while (re-search-forward
8762 (setq pos (match-end 0)
8763 optionp (equal (char-after (match-beginning 0)) ?#)
8764 cat (org-trim (match-string 2)))
8765 (if optionp
8766 (setq beg (point-at-bol) end (point-max))
8767 (org-back-to-heading t)
8768 (setq beg (point) end (org-end-of-subtree t t)))
8769 (put-text-property beg end 'org-category cat)
8770 (put-text-property beg end 'org-category-position beg)
8771 (goto-char pos)))))))
8774 ;;;; Link Stuff
8776 ;;; Link abbreviations
8778 (defun org-link-expand-abbrev (link)
8779 "Apply replacements as defined in `org-link-abbrev-alist'."
8781 (let* ((key (match-string 1 link))
8782 (as (or (assoc key org-link-abbrev-alist-local)
8783 (assoc key org-link-abbrev-alist)))
8784 (tag (and (match-end 2) (match-string 3 link)))
8785 rpl)
8786 (if (not as)
8787 link
8788 (setq rpl (cdr as))
8789 (cond
8790 ((symbolp rpl) (funcall rpl tag))
8792 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
8793 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8794 ((string-match "%h" rpl)
8795 (replace-match (url-hexify-string (or tag "")) t t rpl))
8796 (t (concat rpl tag)))))
8797 link))
8799 ;;; Storing and inserting links
8801 (defvar org-insert-link-history nil
8802 "Minibuffer history for links inserted with `org-insert-link'.")
8804 (defvar org-stored-links nil
8805 "Contains the links stored with `org-store-link'.")
8807 (defvar org-store-link-plist nil
8808 "Plist with info about the most recently link created with `org-store-link'.")
8810 (defvar org-link-protocols nil
8811 "Link protocols added to Org-mode using `org-add-link-type'.")
8813 (defvar org-store-link-functions nil
8814 "List of functions that are called to create and store a link.
8815 Each function will be called in turn until one returns a non-nil
8816 value. Each function should check if it is responsible for creating
8817 this link (for example by looking at the major mode).
8818 If not, it must exit and return nil.
8819 If yes, it should return a non-nil value after a calling
8820 `org-store-link-props' with a list of properties and values.
8821 Special properties are:
8825 This is obligatory as well.
8826 :description Optional default description for the second pair
8827 of brackets in an Org-mode link. The user can still change
8828 this when inserting this link into an Org-mode buffer.
8830 In addition to these, any additional properties can be specified
8831 and then used in capture templates.")
8833 (defun org-add-link-type (type &optional follow export)
8834 "Add TYPE to the list of `org-link-types'.
8835 Re-compute all regular expressions depending on `org-link-types'
8837 FOLLOW and EXPORT are two functions.
8839 FOLLOW should take the link path as the single argument and do whatever
8840 is necessary to follow the link, for example find a file or display
8841 a mail message.
8843 EXPORT should format the link path for export to one of the export formats.
8844 It should be a function accepting three arguments:
8847 desc the description of the link, if any, or a description added by
8848 org-export-normalize-links if there is none
8849 format the export format, a symbol like `html' or `latex' or `ascii'..
8851 The function may use the FORMAT information to return different values
8852 depending on the format. The return value will be put literally into
8853 the exported file. If the return value is nil, this means Org should
8854 do what it normally does with links which do not have EXPORT defined.
8856 Org-mode has a built-in default for exporting links. If you are happy with
8857 this default, there is no need to define an export function for the link
8858 type. For a simple example of an export function, see `org-bbdb.el'."
8859 (add-to-list 'org-link-types type t)
8860 (org-make-link-regexps)
8861 (if (assoc type org-link-protocols)
8862 (setcdr (assoc type org-link-protocols) (list follow export))
8863 (push (list type follow export) org-link-protocols)))
8865 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
8866 (defvar org-link-to-org-use-id) ; Defined in org-id.el
8868 ;;;###autoload
8869 (defun org-store-link (arg)
8871 This link is added to `org-stored-links' and can later be inserted
8874 For some link types, a prefix arg is interpreted:
8875 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8876 For file links, arg negates `org-context-in-file-links'."
8877 (interactive "P")
8878 (org-load-modules-maybe)
8879 (setq org-store-link-plist nil) ; reset
8880 (org-with-limited-levels
8881 (let (link cpltxt desc description search txt custom-id agenda-link)
8882 (cond
8884 ((run-hook-with-args-until-success 'org-store-link-functions)
8885 (setq link (plist-get org-store-link-plist :link)
8886 desc (or (plist-get org-store-link-plist :description) link)))
8888 ((org-src-edit-buffer-p)
8889 (let (label gc)
8890 (while (or (not label)
8891 (save-excursion
8892 (save-restriction
8893 (widen)
8894 (goto-char (point-min))
8895 (re-search-forward
8896 (regexp-quote (format org-coderef-label-format label))
8897 nil t))))
8898 (when label (message "Label exists already") (sit-for 2))
8899 (setq label (read-string "Code line label: " label)))
8900 (end-of-line 1)
8901 (setq link (format org-coderef-label-format label))
8902 (setq gc (- 79 (length link)))
8903 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8904 (insert link)
8905 (setq link (concat "(" label ")") desc nil)))
8907 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8908 ;; We are in the agenda, link to referenced location
8909 (let ((m (or (get-text-property (point) 'org-hd-marker)
8910 (get-text-property (point) 'org-marker))))
8911 (when m
8912 (org-with-point-at m
8913 (setq agenda-link
8914 (if (org-called-interactively-p 'any)
8915 (call-interactively 'org-store-link)
8916 (org-store-link nil)))))))
8918 ((eq major-mode 'calendar-mode)
8919 (let ((cd (calendar-cursor-to-date)))
8920 (setq link
8921 (format-time-string
8922 (car org-time-stamp-formats)
8923 (apply 'encode-time
8924 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8925 nil nil nil))))
8926 (org-store-link-props :type "calendar" :date cd)))
8928 ((eq major-mode 'help-mode)
8929 (setq link (concat "help:" (save-excursion
8930 (goto-char (point-min))
8931 (looking-at "^[^ ]+")
8932 (match-string 0))))
8933 (org-store-link-props :type "help"))
8935 ((eq major-mode 'w3-mode)
8936 (setq cpltxt (if (and (buffer-name)
8937 (not (string-match "Untitled" (buffer-name))))
8938 (buffer-name)
8939 (url-view-url t))
8940 link (url-view-url t))
8941 (org-store-link-props :type "w3" :url (url-view-url t)))
8943 ((eq major-mode 'w3m-mode)
8944 (setq cpltxt (or w3m-current-title w3m-current-url)
8945 link w3m-current-url)
8946 (org-store-link-props :type "w3m" :url (url-view-url t)))
8948 ((setq search (run-hook-with-args-until-success
8949 'org-create-file-search-functions))
8950 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8951 "::" search))
8952 (setq cpltxt (or description link)))
8954 ((eq major-mode 'image-mode)
8955 (setq cpltxt (concat "file:"
8956 (abbreviate-file-name buffer-file-name))
8957 link cpltxt)
8958 (org-store-link-props :type "image" :file buffer-file-name))
8960 ((eq major-mode 'dired-mode)
8961 ;; link to the file in the current line
8962 (let ((file (dired-get-filename nil t)))
8963 (setq file (if file
8964 (abbreviate-file-name
8965 (expand-file-name (dired-get-filename nil t)))
8966 ;; otherwise, no file so use current directory.
8967 default-directory))
8968 (setq cpltxt (concat "file:" file)
8969 link cpltxt)))
8971 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
8972 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8973 (cond
8975 (setq cpltxt
8976 (concat "file:"
8977 (abbreviate-file-name
8978 (buffer-file-name (buffer-base-buffer)))
8979 "::" (match-string 1))
8980 link cpltxt))
8981 ((and (featurep 'org-id)
8982 (or (eq org-link-to-org-use-id t)
8983 (and (org-called-interactively-p 'any)
8984 (or (eq org-link-to-org-use-id 'create-if-interactive)
8985 (and (eq org-link-to-org-use-id
8986 'create-if-interactive-and-no-custom-id)
8987 (not custom-id))))
8988 (and org-link-to-org-use-id (org-entry-get nil "ID"))))
8989 ;; We can make a link using the ID.
8990 (setq link (condition-case nil
8991 (prog1 (org-id-store-link)
8992 (setq desc (plist-get org-store-link-plist :description)))
8993 (error
8994 ;; probably before first headline, link to file only
8995 (concat "file:"
8996 (abbreviate-file-name
8997 (buffer-file-name (buffer-base-buffer))))))))
8998 (t
8999 ;; Just link to current headline
9000 (setq cpltxt (concat "file:"
9001 (abbreviate-file-name
9002 (buffer-file-name (buffer-base-buffer)))))
9003 ;; Add a context search string
9004 (when (org-xor org-context-in-file-links arg)
9005 (setq txt (cond
9006 ((org-at-heading-p) nil)
9007 ((org-region-active-p)
9008 (buffer-substring (region-beginning) (region-end)))))
9010 (setq cpltxt
9011 (concat cpltxt "::"
9012 (condition-case nil
9013 (org-make-org-heading-search-string txt)
9014 (error "")))
9015 desc (or (nth 4 (ignore-errors
9016 (org-heading-components))) "NONE"))))
9018 (setq cpltxt (substring cpltxt 0 -2)))
9019 (setq link cpltxt))))
9021 ((buffer-file-name (buffer-base-buffer))
9022 ;; Just link to this file here.
9023 (setq cpltxt (concat "file:"
9024 (abbreviate-file-name
9025 (buffer-file-name (buffer-base-buffer)))))
9026 ;; Add a context string
9027 (when (org-xor org-context-in-file-links arg)
9028 (setq txt (if (org-region-active-p)
9029 (buffer-substring (region-beginning) (region-end))
9030 (buffer-substring (point-at-bol) (point-at-eol))))
9031 ;; Only use search option if there is some text.
9033 (setq cpltxt
9034 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9035 desc "NONE")))
9036 (setq link cpltxt))
9038 ((org-called-interactively-p 'interactive)
9039 (error "Cannot link to a buffer which is not visiting a file"))
9041 (t (setq link nil)))
9043 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9044 (setq link (or link cpltxt)
9045 desc (or desc cpltxt))
9046 (if (equal desc "NONE") (setq desc nil))
9048 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
9049 (progn
9050 (setq org-stored-links
9051 (cons (list link desc) org-stored-links))
9052 (message "Stored: %s" (or desc link))
9053 (when custom-id
9054 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
9055 "::#" custom-id))
9056 (setq org-stored-links
9057 (cons (list link desc) org-stored-links))))
9058 (or agenda-link (and link (org-make-link-string link desc)))))))
9060 (defun org-store-link-props (&rest plist)
9061 "Store link properties, extract names and addresses."
9062 (let (x adr)
9063 (when (setq x (plist-get plist :from))
9064 (setq adr (mail-extract-address-components x))
9065 (setq plist (plist-put plist :fromname (car adr)))
9066 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9067 (when (setq x (plist-get plist :to))
9068 (setq adr (mail-extract-address-components x))
9069 (setq plist (plist-put plist :toname (car adr)))
9070 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9071 (let ((from (plist-get plist :from))
9072 (to (plist-get plist :to)))
9073 (when (and from to org-from-is-user-regexp)
9074 (setq plist
9075 (plist-put plist :fromto
9076 (if (string-match org-from-is-user-regexp from)
9077 (concat "to %t")
9078 (concat "from %f"))))))
9079 (setq org-store-link-plist plist))
9081 (defun org-add-link-props (&rest plist)
9082 "Add these properties to the link property list."
9083 (let (key value)
9084 (while plist
9085 (setq key (pop plist) value (pop plist))
9086 (setq org-store-link-plist
9087 (plist-put org-store-link-plist key value)))))
9089 (defun org-email-link-description (&optional fmt)
9090 "Return the description part of an email link.
9091 This takes information from `org-store-link-plist' and formats it
9092 according to FMT (default from `org-email-link-description-format')."
9093 (setq fmt (or fmt org-email-link-description-format))
9094 (let* ((p org-store-link-plist)
9095 (to (plist-get p :toaddress))
9096 (from (plist-get p :fromaddress))
9097 (table
9098 (list
9099 (cons "%c" (plist-get p :fromto))
9100 (cons "%F" (plist-get p :from))
9101 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9102 (cons "%T" (plist-get p :to))
9103 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9104 (cons "%s" (plist-get p :subject))
9105 (cons "%d" (plist-get p :date))
9106 (cons "%m" (plist-get p :message-id)))))
9107 (when (string-match "%c" fmt)
9108 ;; Check if the user wrote this message
9109 (if (and org-from-is-user-regexp from to
9110 (save-match-data (string-match org-from-is-user-regexp from)))
9111 (setq fmt (replace-match "to %t" t t fmt))
9112 (setq fmt (replace-match "from %f" t t fmt))))
9113 (org-replace-escapes fmt table)))
9115 (defun org-make-org-heading-search-string (&optional string heading)
9116 "Make search string for STRING or current headline."
9117 (interactive)
9118 (let ((s (or string (org-get-heading)))
9119 (lines org-context-in-file-links))
9120 (unless (and string (not heading))
9121 ;; We are using a headline, clean up garbage in there.
9122 (if (string-match org-todo-regexp s)
9123 (setq s (replace-match "" t t s)))
9125 (setq s (replace-match "" t t s)))
9126 (setq s (org-trim s))
9129 (setq s (replace-match "" t t s)))
9130 (while (string-match org-ts-regexp s)
9131 (setq s (replace-match "" t t s))))
9132 (or string (setq s (concat "*" s))) ; Add * for headlines
9133 (when (and string (integerp lines) (> lines 0))
9135 (when (< lines (length slines))
9136 (setq s (mapconcat
9137 'identity
9138 (reverse (nthcdr (- (length slines) lines)
9142 (defun org-make-link-string (link &optional description)
9143 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9145 (error "Empty link"))
9146 (when (and description
9147 (stringp description)
9149 (setq description nil))
9150 (when (stringp description)
9151 ;; Remove brackets from the description, they are fatal.
9153 (setq description (replace-match "{" t t description)))
9155 (setq description (replace-match "}" t t description))))
9156 (when (equal link description)
9157 ;; No description needed, it is identical
9158 (setq description nil))
9159 (when (and (not description)
9160 (not (string-match (org-image-file-name-regexp) link))
9161 (not (equal link (org-link-escape link))))
9162 (setq description (org-extract-attributes link)))
9163 (setq link
9164 (cond ((string-match (org-image-file-name-regexp) link) link)
9165 ((string-match org-link-types-re link)
9166 (concat (match-string 1 link)
9167 (org-link-escape (substring link (match-end 1)))))
9168 (t (org-link-escape link))))
9169 (concat "[[" link "]"
9170 (if description (concat "[" description "]") "")
9171 "]"))
9173 (defconst org-link-escape-chars
9174 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9175 "List of characters that should be escaped in link.
9176 This is the list that is used for internal purposes.")
9178 (defconst org-link-escape-chars-browser
9179 '(?\ )
9180 "List of escapes for characters that are problematic in links.
9181 This is the list that is used before handing over to the browser.")
9183 (defun org-link-escape (text &optional table merge)
9184 "Return percent escaped representation of TEXT.
9185 TEXT is a string with the text to escape.
9186 Optional argument TABLE is a list with characters that should be
9187 escaped. When nil, `org-link-escape-chars' is used.
9188 If optional argument MERGE is set, merge TABLE into
9189 `org-link-escape-chars'."
9190 (cond
9191 ((and table merge)
9192 (mapc (lambda (defchr)
9193 (unless (member defchr table)
9194 (setq table (cons defchr table)))) org-link-escape-chars))
9195 ((null table)
9196 (setq table org-link-escape-chars)))
9197 (mapconcat
9198 (lambda (char)
9199 (if (or (member char table)
9200 (and (or (< char 32) (= char 37) (> char 126))
9201 org-url-hexify-p))
9202 (mapconcat (lambda (sequence-element)
9203 (format "%%%.2X" sequence-element))
9204 (or (encode-coding-char char 'utf-8)
9205 (error "Unable to percent escape character: %s"
9206 (char-to-string char))) "")
9207 (char-to-string char))) text ""))
9209 (defun org-link-unescape (str)
9210 "Unhex hexified Unicode strings as returned from the JavaScript function
9211 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9212 (unless (and (null str) (string= "" str))
9213 (let ((pos 0) (case-fold-search t) unhexed)
9215 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9216 (setq str (replace-match unhexed t t str))
9217 (setq pos (+ pos (length unhexed))))))
9218 str)
9220 (defun org-link-unescape-compound (hex)
9221 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9222 Note: this function also decodes single byte encodings like
9223 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9224 (save-match-data
9225 (let* ((bytes (cdr (split-string hex "%")))
9226 (ret "")
9227 (eat 0)
9228 (sum 0))
9229 (while bytes
9230 (let* ((val (string-to-number (pop bytes) 16))
9231 (shift-xor
9232 (if (= 0 eat)
9233 (cond
9234 ((>= val 252) (cons 6 252))
9235 ((>= val 248) (cons 5 248))
9236 ((>= val 240) (cons 4 240))
9237 ((>= val 224) (cons 3 224))
9238 ((>= val 192) (cons 2 192))
9239 (t (cons 0 0)))
9240 (cons 6 128))))
9241 (if (>= val 192) (setq eat (car shift-xor)))
9242 (setq val (logxor val (cdr shift-xor)))
9243 (setq sum (+ (lsh sum (car shift-xor)) val))
9244 (if (> eat 0) (setq eat (- eat 1)))
9245 (cond
9246 ((= 0 eat) ;multi byte
9247 (setq ret (concat ret (org-char-to-string sum)))
9248 (setq sum 0))
9249 ((not bytes) ; single byte(s)
9250 (setq ret (org-link-unescape-single-byte-sequence hex))))
9251 )) ;; end (while bytes
9252 ret )))
9254 (defun org-link-unescape-single-byte-sequence (hex)
9255 "Unhexify hex-encoded single byte character sequences."
9256 (mapconcat (lambda (byte)
9257 (char-to-string (string-to-number byte 16)))
9258 (cdr (split-string hex "%")) ""))
9260 (defun org-xor (a b)
9261 "Exclusive or."
9262 (if a (not b) b))
9264 (defun org-fixup-message-id-for-http (s)
9265 "Replace special characters in a message id, so it can be used in an http query."
9266 (when (string-match "%" s)
9267 (setq s (mapconcat (lambda (c)
9268 (if (eq c ?%)
9269 "%25"
9270 (char-to-string c)))
9271 s "")))
9272 (while (string-match "<" s)
9273 (setq s (replace-match "%3C" t t s)))
9274 (while (string-match ">" s)
9275 (setq s (replace-match "%3E" t t s)))
9276 (while (string-match "@" s)
9277 (setq s (replace-match "%40" t t s)))
9278 s)
9280 (defun org-link-prettify (link)
9281 "Return a human-readable representation of LINK.
9282 The car of LINK must be a raw link the cdr of LINK must be either
9283 a link description or nil."
9284 (let ((desc (or (cadr link) "<no description>")))
9285 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9286 "<" (car link) ">")))
9288 ;;;###autoload
9289 (defun org-insert-link-global ()
9290 "Insert a link like Org-mode does.
9291 This command can be called in any mode to insert a link in Org-mode syntax."
9292 (interactive)
9293 (org-load-modules-maybe)
9294 (org-run-like-in-org-mode 'org-insert-link))
9296 (defun org-insert-all-links (&optional keep)
9297 "Insert all links in `org-stored-links'."
9298 (interactive "P")
9299 (let ((links (copy-sequence org-stored-links)) l)
9300 (while (setq l (if keep (pop links) (pop org-stored-links)))
9301 (insert "- ")
9302 (org-insert-link nil (car l) (cadr l))
9305 (defun org-link-fontify-links-to-this-file ()
9306 "Fontify links to the current file in `org-stored-links'."
9307 (let ((f (buffer-file-name)) a b)
9308 (setq a (mapcar (lambda(l)
9309 (let ((ll (car l)))
9311 (equal f (expand-file-name (match-string 1 ll))))
9312 ll)))
9313 org-stored-links))
9314 (when (featurep 'org-id)
9315 (setq b (mapcar (lambda(l)
9316 (let ((ll (car l)))
9318 (equal f (expand-file-name
9319 (or (org-id-find-id-file
9320 (match-string 1 ll)) ""))))
9321 ll)))
9322 org-stored-links)))
9323 (mapcar (lambda(l)
9324 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9325 (delq nil (append a b)))))
9327 (defvar org-link-links-in-this-file nil)
9328 (defun org-insert-link (&optional complete-file link-location default-description)
9329 "Insert a link. At the prompt, enter the link.
9331 Completion can be used to insert any of the link protocol prefixes like
9332 http or ftp in use.
9334 The history can be used to select a link previously stored with
9335 `org-store-link'. When the empty string is entered (i.e. if you just
9336 press RET at the prompt), the link defaults to the most recently
9337 stored link. As SPC triggers completion in the minibuffer, you need to
9338 use M-SPC or C-q SPC to force the insertion of a space character.
9340 You will also be prompted for a description, and if one is given, it will
9341 be displayed in the buffer instead of the link.
9343 If there is already a link at point, this command will allow you to edit link
9344 and description parts.
9347 be selected using completion. The path to the file will be relative to the
9348 current directory if the file is in the current directory or a subdirectory.
9349 Otherwise, the link will be the absolute path as completed in the minibuffer
9350 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9351 option `org-link-file-path-type'.
9354 the current directory or below.
9357 `org-keep-stored-link-after-insertion'.
9359 If `org-make-link-description-function' is non-nil, this function will be
9360 called with the link target, and the result will be the default
9361 link description.
9363 If the LINK-LOCATION parameter is non-nil, this value will be
9364 used as the link location instead of reading one interactively.
9366 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9367 be used as the default description."
9368 (interactive "P")
9369 (let* ((wcf (current-window-configuration))
9370 (origbuf (current-buffer))
9371 (region (if (org-region-active-p)
9372 (buffer-substring (region-beginning) (region-end))))
9373 (remove (and region (list (region-beginning) (region-end))))
9374 (desc region)
9375 tmphist ; byte-compile incorrectly complains about this
9376 (link link-location)
9377 (abbrevs org-link-abbrev-alist-local)
9378 entry file all-prefixes auto-desc)
9379 (cond
9380 (link-location) ; specified by arg, just use it.
9381 ((org-in-regexp org-bracket-link-regexp 1)
9382 ;; We do have a link at point, and we are going to edit it.
9383 (setq remove (list (match-beginning 0) (match-end 0)))
9384 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9385 (setq link (read-string "Link: "
9386 (org-link-unescape
9387 (org-match-string-no-properties 1)))))
9388 ((or (org-in-regexp org-angle-link-re)
9389 (org-in-regexp org-plain-link-re))
9390 ;; Convert to bracket link
9391 (setq remove (list (match-beginning 0) (match-end 0))
9392 link (read-string "Link: "
9393 (org-remove-angle-brackets (match-string 0)))))
9394 ((member complete-file '((4) (16)))
9395 ;; Completing read for file names.
9396 (setq link (org-file-complete-link complete-file)))
9397 (t
9398 ;; Read link, with completion for stored links.
9399 (org-link-fontify-links-to-this-file)
9400 (org-switch-to-buffer-other-window "*Org Links*")
9401 (with-current-buffer "*Org Links*"
9402 (erase-buffer)
9403 (insert "Insert a link.
9405 (when org-stored-links
9407 (insert (mapconcat 'org-link-prettify
9409 (goto-char (point-min)))
9410 (let ((cw (selected-window)))
9411 (select-window (get-buffer-window "*Org Links*" 'visible))
9412 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9413 (unless (pos-visible-in-window-p (point-max))
9414 (org-fit-window-to-buffer))
9415 (and (window-live-p cw) (select-window cw)))
9416 ;; Fake a link history, containing the stored links.
9417 (setq tmphist (append (mapcar 'car org-stored-links)
9418 org-insert-link-history))
9419 (setq all-prefixes (append (mapcar 'car abbrevs)
9420 (mapcar 'car org-link-abbrev-alist)
9421 org-link-types))
9422 (unwind-protect
9423 (progn
9424 (setq link
9425 (org-completing-read
9426 "Link: "
9427 (append
9428 (mapcar (lambda (x) (concat x ":"))
9429 all-prefixes)
9430 (mapcar 'car org-stored-links))
9431 nil nil nil
9432 'tmphist
9433 (caar org-stored-links)))
9435 (error "No link selected"))
9436 (mapc (lambda(l)
9437 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9438 org-stored-links)
9439 (if (or (member link all-prefixes)
9440 (and (equal ":" (substring link -1))
9441 (member (substring link 0 -1) all-prefixes)
9442 (setq link (substring link 0 -1))))
9443 (setq link (with-current-buffer origbuf
9444 (org-link-try-special-completion link)))))
9445 (set-window-configuration wcf)
9446 (kill-buffer "*Org Links*"))
9447 (setq entry (assoc link org-stored-links))
9448 (or entry (push link org-insert-link-history))
9449 (setq desc (or desc (nth 1 entry)))))
9451 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9452 (not org-keep-stored-link-after-insertion))
9453 (setq org-stored-links (delq (assoc link org-stored-links)
9454 org-stored-links)))
9456 (if (string-match org-plain-link-re link)
9457 ;; URL-like link, normalize the use of angular brackets.
9458 (setq link (org-remove-angle-brackets link)))
9460 ;; Check if we are linking to the current file with a search option
9461 ;; If yes, simplify the link by using only the search option.
9462 (when (and buffer-file-name
9464 (let* ((path (match-string 1 link))
9465 (case-fold-search nil)
9466 (search (match-string 2 link)))
9467 (save-match-data
9468 (if (equal (file-truename buffer-file-name) (file-truename path))
9469 ;; We are linking to this same file, with a search option
9470 (setq link search)))))
9472 ;; Check if we can/should use a relative path. If yes, simplify the link
9474 (let* ((type (match-string 1 link))
9475 (path (match-string 2 link))
9476 (origpath path)
9477 (case-fold-search nil))
9478 (cond
9479 ((or (eq org-link-file-path-type 'absolute)
9480 (equal complete-file '(16)))
9481 (setq path (abbreviate-file-name (expand-file-name path))))
9482 ((eq org-link-file-path-type 'noabbrev)
9483 (setq path (expand-file-name path)))
9484 ((eq org-link-file-path-type 'relative)
9485 (setq path (file-relative-name path)))
9486 (t
9487 (save-match-data
9488 (if (string-match (concat "^" (regexp-quote
9489 (expand-file-name
9490 (file-name-as-directory
9491 default-directory))))
9492 (expand-file-name path))
9493 ;; We are linking a file with relative path name.
9494 (setq path (substring (expand-file-name path)
9495 (match-end 0)))
9496 (setq path (abbreviate-file-name (expand-file-name path)))))))
9497 (setq link (concat type path))
9498 (if (equal desc origpath)
9499 (setq desc path))))
9501 (if org-make-link-description-function
9502 (setq desc
9503 (or (condition-case nil
9504 (funcall org-make-link-description-function link desc)
9505 (error (progn (message "Can't get link description from `%s'"
9506 (symbol-name org-make-link-description-function))
9507 (sit-for 2) nil)))
9508 (read-string "Description: " default-description)))
9509 (if default-description (setq desc default-description)
9510 (setq desc (or (and auto-desc desc)
9511 (read-string "Description: " desc)))))
9514 (if remove (apply 'delete-region remove))
9515 (insert (org-make-link-string link desc))))
9517 (defun org-link-try-special-completion (type)
9518 "If there is completion support for link type TYPE, offer it."
9519 (let ((fun (intern (concat "org-" type "-complete-link"))))
9520 (if (functionp fun)
9521 (funcall fun)
9522 (read-string "Link (no completion support): " (concat type ":")))))
9524 (defun org-file-complete-link (&optional arg)
9525 "Create a file link using completion."
9526 (let (file link)
9527 (setq file (org-iread-file-name "File: "))
9528 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9529 (pwd1 (file-name-as-directory (abbreviate-file-name
9530 (expand-file-name ".")))))
9531 (cond
9532 ((equal arg '(16))
9533 (setq link (concat
9534 "file:"
9535 (abbreviate-file-name (expand-file-name file)))))
9537 (setq link (concat "file:" (match-string 1 file))))
9539 (expand-file-name file))
9540 (setq link (concat
9541 "file:" (match-string 1 (expand-file-name file)))))
9542 (t (setq link (concat "file:" file)))))
9543 link))
9545 (defun org-iread-file-name (&rest args)
9546 "Read-file-name using `ido-mode' speedup if available.
9547 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
9548 See `read-file-name' for a description of parameters."
9549 (org-without-partial-completion
9550 (if (and org-completion-use-ido
9551 (fboundp 'ido-read-file-name)
9552 (boundp 'ido-mode) ido-mode
9553 (listp (second args)))
9554 (let ((ido-enter-matching-directory nil))
9555 (apply 'ido-read-file-name args))
9556 (apply 'read-file-name args))))
9558 (defun org-completing-read (&rest args)
9559 "Completing-read with SPACE being a normal character."
9560 (let ((enable-recursive-minibuffers t)
9561 (minibuffer-local-completion-map
9562 (copy-keymap minibuffer-local-completion-map)))
9563 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9564 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9565 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9566 (apply 'org-icompleting-read args)))
9568 (defun org-completing-read-no-i (&rest args)
9569 (let (org-completion-use-ido org-completion-use-iswitchb)
9570 (apply 'org-completing-read args)))
9572 (defun org-iswitchb-completing-read (prompt choices &rest args)
9573 "Use iswitch as a completing-read replacement to choose from choices.
9574 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9575 from."
9576 (let* ((iswitchb-use-virtual-buffers nil)
9577 (iswitchb-make-buflist-hook
9578 (lambda ()
9579 (setq iswitchb-temp-buflist choices))))
9580 (iswitchb-read-buffer prompt)))
9582 (defun org-icompleting-read (&rest args)
9583 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9584 (org-without-partial-completion
9585 (if (and org-completion-use-ido
9586 (fboundp 'ido-completing-read)
9587 (boundp 'ido-mode) ido-mode
9588 (listp (second args)))
9589 (let ((ido-enter-matching-directory nil))
9590 (apply 'ido-completing-read (concat (car args))
9591 (if (consp (car (nth 1 args)))
9592 (mapcar 'car (nth 1 args))
9593 (nth 1 args))
9594 (cddr args)))
9595 (if (and org-completion-use-iswitchb
9596 (boundp 'iswitchb-mode) iswitchb-mode
9597 (listp (second args)))
9598 (apply 'org-iswitchb-completing-read (concat (car args))
9599 (if (consp (car (nth 1 args)))
9600 (mapcar 'car (nth 1 args))
9601 (nth 1 args))
9602 (cddr args))
9603 (apply 'completing-read args)))))
9605 (defun org-extract-attributes (s)
9606 "Extract the attributes cookie from a string and set as text property."
9607 (let (a attr (start 0) key value)
9608 (save-match-data
9610 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9612 (setq key (match-string 1 a) value (match-string 2 a)
9613 start (match-end 0)
9614 attr (plist-put attr (intern key) value))))
9615 (org-add-props s nil 'org-attr attr))
9616 s))
9618 (defun org-extract-attributes-from-string (tag)
9619 (let (key value attr)
9621 (setq key (match-string 1 tag) value (match-string 2 tag)
9622 tag (replace-match "" t t tag)
9623 attr (plist-put attr (intern key) value)))
9624 (cons tag attr)))
9626 (defun org-attributes-to-string (plist)
9627 "Format a property list into an HTML attribute list."
9628 (let ((s "") key value)
9629 (while plist
9630 (setq key (pop plist) value (pop plist))
9631 (and value
9633 s))
9635 ;;; Opening/following a link
9637 (defvar org-link-search-failed nil)
9639 (defvar org-open-link-functions nil
9640 "Hook for functions finding a plain text link.
9641 These functions must take a single argument, the link content.
9642 They will be called for links that look like [[link text][description]]
9646 These functions will be called *before* Org attempts to resolve the
9647 link by doing text searches in the current buffer - so if you want a
9649 handle this as a special case.
9651 When the function does handle the link, it must return a non-nil value.
9652 If it decides that it is not responsible for this link, it must return
9653 nil to indicate that that Org-mode can continue with other options
9654 like exact and fuzzy text search.")
9656 (defun org-next-link ()
9657 "Move forward to the next link.
9658 If the link is in hidden text, expose it."
9659 (interactive)
9660 (when (and org-link-search-failed (eq this-command last-command))
9661 (goto-char (point-min))
9662 (message "Link search wrapped back to beginning of buffer"))
9663 (setq org-link-search-failed nil)
9664 (let* ((pos (point))
9665 (ct (org-context))
9666 (a (assoc :link ct)))
9667 (if a (goto-char (nth 2 a)))
9668 (if (re-search-forward org-any-link-re nil t)
9669 (progn
9670 (goto-char (match-beginning 0))
9671 (if (outline-invisible-p) (org-show-context)))
9672 (goto-char pos)
9673 (setq org-link-search-failed t)
9674 (error "No further link found"))))
9676 (defun org-previous-link ()
9677 "Move backward to the previous link.
9678 If the link is in hidden text, expose it."
9679 (interactive)
9680 (when (and org-link-search-failed (eq this-command last-command))
9681 (goto-char (point-max))
9682 (message "Link search wrapped back to end of buffer"))
9683 (setq org-link-search-failed nil)
9684 (let* ((pos (point))
9685 (ct (org-context))
9686 (a (assoc :link ct)))
9687 (if a (goto-char (nth 1 a)))
9688 (if (re-search-backward org-any-link-re nil t)
9689 (progn
9690 (goto-char (match-beginning 0))
9691 (if (outline-invisible-p) (org-show-context)))
9692 (goto-char pos)
9693 (setq org-link-search-failed t)
9694 (error "No further link found"))))
9696 (defun org-translate-link (s)
9697 "Translate a link string if a translation function has been defined."
9698 (if (and org-link-translation-function
9699 (fboundp org-link-translation-function)
9701 (progn
9702 (setq s (funcall org-link-translation-function
9703 (match-string 1 s) (match-string 2 s)))
9704 (concat (car s) ":" (cdr s)))
9705 s))
9707 (defun org-translate-link-from-planner (type path)
9708 "Translate a link from Emacs Planner syntax so that Org can follow it.
9709 This is still an experimental function, your mileage may vary."
9710 (cond
9711 ((member type '("http" "https" "news" "ftp"))
9712 ;; standard Internet links are the same.
9713 nil)
9714 ((and (equal type "irc") (string-match "^//" path))
9715 ;; Planner has two / at the beginning of an irc link, we have 1.
9716 ;; We should have zero, actually....
9717 (setq path (substring path 1)))
9718 ((and (equal type "lisp") (string-match "^/" path))
9719 ;; Planner has a slash, we do not.
9720 (setq type "elisp" path (substring path 1)))
9722 ;; A typical message link. Planner has the id after the final slash,
9723 ;; we separate it with a hash mark
9724 (setq path (concat (match-string 1 path) "#"
9725 (org-remove-angle-brackets (match-string 2 path)))))
9726 )
9727 (cons type path))
9729 (defun org-find-file-at-mouse (ev)
9730 "Open file link or URL at mouse."
9731 (interactive "e")
9732 (mouse-set-point ev)
9733 (org-open-at-point 'in-emacs))
9735 (defun org-open-at-mouse (ev)
9736 "Open file link or URL at mouse.
9737 See the docstring of `org-open-file' for details."
9738 (interactive "e")
9739 (mouse-set-point ev)
9740 (if (eq major-mode 'org-agenda-mode)
9741 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9742 (org-open-at-point))
9744 (defvar org-window-config-before-follow-link nil
9745 "The window configuration before following a link.
9746 This is saved in case the need arises to restore it.")
9748 (defvar org-open-link-marker (make-marker)
9749 "Marker pointing to the location where `org-open-at-point; was called.")
9751 ;;;###autoload
9752 (defun org-open-at-point-global ()
9753 "Follow a link like Org-mode does.
9754 This command can be called in any mode to follow a link that has
9755 Org-mode syntax."
9756 (interactive)
9757 (org-run-like-in-org-mode 'org-open-at-point))
9759 ;;;###autoload
9760 (defun org-open-link-from-string (s &optional arg reference-buffer)
9761 "Open a link in the string S, as if it was in Org-mode."
9763 (let ((reference-buffer (or reference-buffer (current-buffer))))
9764 (with-temp-buffer
9765 (let ((org-inhibit-startup (not reference-buffer)))
9766 (org-mode)
9767 (insert s)
9768 (goto-char (point-min))
9769 (when reference-buffer
9770 (setq org-link-abbrev-alist-local
9771 (with-current-buffer reference-buffer
9772 org-link-abbrev-alist-local)))
9773 (org-open-at-point arg reference-buffer)))))
9775 (defvar org-open-at-point-functions nil
9776 "Hook that is run when following a link at point.
9778 Functions in this hook must return t if they identify and follow
9779 a link at point. If they don't find anything interesting at point,
9780 they must return nil.")
9782 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
9783 (defun org-open-at-point (&optional arg reference-buffer)
9784 "Open link at or after point.
9785 If there is no link at point, this function will search forward up to
9786 the end of the current line.
9787 Normally, files will be opened by an appropriate application. If the
9788 optional prefix argument ARG is non-nil, Emacs will visit the file.
9789 With a double prefix argument, try to open outside of Emacs, in the
9790 application the system uses for this file type."
9791 (interactive "P")
9792 ;; if in a code block, then open the block's results
9793 (unless (call-interactively #'org-babel-open-src-block-result)
9794 (org-load-modules-maybe)
9795 (move-marker org-open-link-marker (point))
9796 (setq org-window-config-before-follow-link (current-window-configuration))
9797 (org-remove-occur-highlights nil nil t)
9798 (cond
9799 ((and (org-at-heading-p)
9800 (not (org-at-timestamp-p t))
9801 (not (org-in-regexp
9806 (not (get-text-property (point) 'org-linked-text)))
9807 (or (org-offer-links-in-entry arg)
9808 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9809 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9810 ((and (org-at-timestamp-p t)
9811 (not (org-in-regexp org-bracket-link-regexp)))
9812 (org-follow-timestamp-link))
9813 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9814 (not (org-in-regexp org-any-link-re)))
9815 (org-footnote-action))
9816 (t
9817 (let (type path link line search (pos (point)))
9818 (catch 'match
9819 (save-excursion
9821 (when (org-in-regexp org-bracket-link-regexp 1)
9822 (setq link (org-extract-attributes
9823 (org-link-unescape (org-match-string-no-properties 1))))
9825 (setq link (replace-match " " t t link)))
9826 (setq link (org-link-expand-abbrev link))
9827 (cond
9828 ((or (file-name-absolute-p link)
9830 (setq type "file" path link))
9831 ((string-match org-link-re-with-space3 link)
9832 (setq type (match-string 1 link) path (match-string 2 link)))
9834 (setq type "help" path (match-string 1 link)))
9835 (t (setq type "thisfile" path link)))
9836 (throw 'match t)))
9838 (when (get-text-property (point) 'org-linked-text)
9839 (setq type "thisfile"
9840 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9841 (1+ (point)) (point))
9842 path (buffer-substring
9843 (or (previous-single-property-change pos 'org-linked-text)
9844 (point-min))
9845 (or (next-single-property-change pos 'org-linked-text)
9846 (point-max))))
9847 (throw 'match t))
9849 (save-excursion
9850 (let ((plinkpos (org-in-regexp org-plain-link-re)))
9851 (when (or (org-in-regexp org-angle-link-re)
9852 (and plinkpos (goto-char (car plinkpos))
9854 (setq type (match-string 1)
9855 path (org-link-unescape (match-string 2)))
9856 (throw 'match t))))
9857 (save-excursion
9859 (setq type "tags"
9860 path (match-string 1))
9861 (while (string-match ":" path)
9862 (setq path (replace-match "+" t t path)))
9863 (throw 'match t)))
9865 (setq type "tree-match"
9866 path (match-string 1))
9867 (throw 'match t)))
9868 (unless path
9869 (user-error "No link found"))
9871 ;; switch back to reference buffer
9872 ;; needed when if called in a temporary buffer through
9873 ;; org-open-link-from-string
9874 (with-current-buffer (or reference-buffer (current-buffer))
9876 ;; Remove any trailing spaces in path
9878 (setq path (replace-match "" t t path)))
9879 (if (and org-link-translation-function
9880 (fboundp org-link-translation-function))
9881 ;; Check if we need to translate the link
9882 (let ((tmp (funcall org-link-translation-function type path)))
9883 (setq type (car tmp) path (cdr tmp))))
9885 (cond
9887 ((assoc type org-link-protocols)
9888 (funcall (nth 1 (assoc type org-link-protocols)) path))
9890 ((equal type "help")
9891 (let ((f-or-v (intern path)))
9892 (cond ((fboundp f-or-v)
9893 (describe-function f-or-v))
9894 ((boundp f-or-v)
9895 (describe-variable f-or-v))
9896 (t (error "Not a known function or variable")))))
9898 ((equal type "mailto")
9899 (let ((cmd (car org-link-mailto-program))
9900 (args (cdr org-link-mailto-program)) args1
9901 (address path) (subject "") a)
9903 (setq address (match-string 1 path)
9904 subject (org-link-escape (match-string 2 path))))
9905 (while args
9906 (cond
9907 ((not (stringp (car args))) (push (pop args) args1))
9908 (t (setq a (pop args))
9909 (if (string-match "%a" a)
9910 (setq a (replace-match address t t a)))
9911 (if (string-match "%s" a)
9912 (setq a (replace-match subject t t a)))
9913 (push a args1))))
9914 (apply cmd (nreverse args1))))
9916 ((member type '("http" "https" "ftp" "news"))
9917 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9918 (org-link-escape
9919 path org-link-escape-chars-browser)
9920 path))))
9922 ((string= type "doi")
9923 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
9924 (org-link-escape
9925 path org-link-escape-chars-browser)
9926 path))))
9928 ((member type '("message"))
9929 (browse-url (concat type ":" path)))
9931 ((string= type "tags")
9932 (org-tags-view arg path))
9934 ((string= type "tree-match")
9937 ((string= type "file")
9939 (setq line (string-to-number (match-string 1 path))
9940 path (substring path 0 (match-beginning 0)))
9942 (setq search (match-string 1 path)
9943 path (substring path 0 (match-beginning 0)))))
9944 (if (string-match "[*?{]" (file-name-nondirectory path))
9945 (dired path)
9946 (org-open-file path arg line search)))
9948 ((string= type "shell")
9949 (let ((buf (generate-new-buffer "*Org Shell Output"))
9950 (cmd path))
9951 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9952 (string-match org-confirm-shell-link-not-regexp cmd))
9953 (not org-confirm-shell-link-function)
9954 (funcall org-confirm-shell-link-function
9956 (org-add-props cmd nil
9957 'face 'org-warning))))
9958 (progn
9959 (message "Executing %s" cmd)
9960 (shell-command cmd buf)
9961 (if (featurep 'midnight)
9962 (setq clean-buffer-list-kill-buffer-names
9963 (cons buf clean-buffer-list-kill-buffer-names))))
9964 (error "Abort"))))
9966 ((string= type "elisp")
9967 (let ((cmd path))
9968 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9969 (string-match org-confirm-elisp-link-not-regexp cmd))
9970 (not org-confirm-elisp-link-function)
9971 (funcall org-confirm-elisp-link-function
9973 (org-add-props cmd nil
9974 'face 'org-warning))))
9975 (message "%s => %s" cmd
9976 (if (equal (string-to-char cmd) ?\()
9977 (eval (read cmd))
9978 (call-interactively (read cmd))))
9979 (error "Abort"))))
9981 ((and (string= type "thisfile")
9982 (run-hook-with-args-until-success
9983 'org-open-link-functions path)))
9985 ((string= type "thisfile")
9986 (if arg
9987 (switch-to-buffer-other-window
9988 (org-get-buffer-for-internal-link (current-buffer)))
9989 (org-mark-ring-push))
9990 (let ((cmd `(org-link-search
9991 ,path
9992 ,(cond ((equal arg '(4)) ''occur)
9993 ((equal arg '(16)) ''org-occur))
9994 ,pos)))
9995 (condition-case nil (let ((org-link-search-inhibit-query t))
9996 (eval cmd))
9997 (error (progn (widen) (eval cmd))))))
9999 (t (browse-url-at-point)))))))
10000 (move-marker org-open-link-marker nil)
10001 (run-hook-with-args 'org-follow-link-hook)))
10003 (defun org-offer-links-in-entry (&optional nth zero)
10004 "Offer links in the current entry and follow the selected link.
10005 If there is only one link, follow it immediately as well.
10006 If NTH is an integer, immediately pick the NTH link found.
10007 If ZERO is a string, check also this string for a link, and if
10008 there is one, offer it as link number zero."
10012 (cnt ?0)
10013 (in-emacs (if (integerp nth) nil nth))
10014 have-zero end links link c)
10015 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10016 (push (match-string 0 zero) links)
10017 (setq cnt (1- cnt) have-zero t))
10018 (save-excursion
10019 (org-back-to-heading t)
10020 (setq end (save-excursion (outline-next-heading) (point)))
10021 (while (re-search-forward re end t)
10022 (push (match-string 0) links))
10023 (setq links (org-uniquify (reverse links))))
10025 (cond
10026 ((null links)
10027 (message "No links"))
10028 ((equal (length links) 1)
10029 (setq link (list (car links))))
10030 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10031 (setq link (list (nth (if have-zero nth (1- nth)) links))))
10032 (t ; we have to select a link
10033 (save-excursion
10034 (save-window-excursion
10035 (delete-other-windows)
10036 (with-output-to-temp-buffer "*Select Link*"
10037 (mapc (lambda (l)
10038 (if (not (string-match org-bracket-link-regexp l))
10040 (org-remove-angle-brackets l)))
10041 (if (match-end 3)
10043 (match-string 3 l) (match-string 1 l)))
10045 (match-string 1 l))))))
10046 links))
10047 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10048 (message "Select link to open, RET to open all:")
10049 (setq c (read-char-exclusive))
10050 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10051 (when (equal c ?q) (error "Abort"))
10052 (if (equal c ?\C-m)
10053 (setq link links)
10054 (setq nth (- c ?0))
10055 (if have-zero (setq nth (1+ nth)))
10056 (unless (and (integerp nth) (>= (length links) nth))
10057 (error "Invalid link selection"))
10058 (setq link (list (nth (1- nth) links))))))
10059 (if link
10060 (let ((buf (current-buffer)))
10061 (dolist (l link)
10062 (org-open-link-from-string l in-emacs buf))
10063 t)
10064 nil)))
10066 ;; Add special file links that specify the way of opening
10068 (org-add-link-type "file+sys" 'org-open-file-with-system)
10069 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10070 (defun org-open-file-with-system (path)
10071 "Open file at PATH using the system way of opening it."
10072 (org-open-file path 'system))
10073 (defun org-open-file-with-emacs (path)
10074 "Open file at PATH in Emacs."
10075 (org-open-file path 'emacs))
10076 (defun org-remove-file-link-modifiers ()
10077 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
10078 (goto-char (point-min))
10080 (org-if-unprotected
10081 (replace-match "file:" t t))))
10082 (eval-after-load "org-exp"
10083 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
10084 'org-remove-file-link-modifiers))
10086 ;;;; Time estimates
10088 (defun org-get-effort (&optional pom)
10089 "Get the effort estimate for the current entry."
10090 (org-entry-get pom org-effort-property))
10092 ;;; File search
10094 (defvar org-create-file-search-functions nil
10095 "List of functions to construct the right search string for a file link.
10096 These functions are called in turn with point at the location to
10097 which the link should point.
10099 A function in the hook should first test if it would like to
10100 handle this file type, for example by checking the `major-mode'
10101 or the file extension. If it decides not to handle this file, it
10102 should just return nil to give other functions a chance. If it
10103 does handle the file, it must return the search string to be used
10104 when following the link. The search string will be part of the
10105 file link, given after a double colon, and `org-open-at-point'
10106 will automatically search for it. If special measures must be
10107 taken to make the search successful, another function should be
10108 added to the companion hook `org-execute-file-search-functions',
10109 which see.
10111 A function in this hook may also use `setq' to set the variable
10112 `description' to provide a suggestion for the descriptive text to
10113 be used for this link when it gets inserted into an Org-mode
10116 (defvar org-execute-file-search-functions nil
10117 "List of functions to execute a file search triggered by a link.
10119 Functions added to this hook must accept a single argument, the
10120 search string that was part of the file link, the part after the
10121 double colon. The function must first check if it would like to
10122 handle this search, for example by checking the `major-mode' or
10123 the file extension. If it decides not to handle this search, it
10124 should just return nil to give other functions a chance. If it
10125 does handle the search, it must return a non-nil value to keep
10126 other functions from trying.
10128 Each function can access the current prefix argument through the
10129 variable `current-prefix-argument'. Note that a single prefix is
10130 used to force opening a link in Emacs, so it may be good to only
10131 use a numeric or double prefix to guide the search function.
10133 In case this is needed, a function in this hook can also restore
10134 the window configuration before `org-open-at-point' was called using:
10136 (set-window-configuration org-window-config-before-follow-link)")
10138 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10139 (defun org-link-search (s &optional type avoid-pos stealth)
10140 "Search for a link search option.
10141 If S is surrounded by forward slashes, it is interpreted as a
10142 regular expression. In org-mode files, this will create an `org-occur'
10143 sparse tree. In ordinary files, `occur' will be used to list matches.
10144 If the current buffer is in `dired-mode', grep will be used to search
10145 in all files. If AVOID-POS is given, ignore matches near that position.
10147 When optional argument STEALTH is non-nil, do not modify
10148 visibility around point, thus ignoring
10149 `org-show-hierarchy-above', `org-show-following-heading' and
10150 `org-show-siblings' variables."
10151 (let ((case-fold-search t)
10155 org-emphasis-alist)
10157 (pos (point))
10158 (pre nil) (post nil)
10159 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10160 (cond
10161 ;; First check if there are any special search functions
10162 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10163 ;; Now try the builtin stuff
10164 ((and (equal (string-to-char s0) ?#)
10165 (> (length s0) 1)
10166 (save-excursion
10167 (goto-char (point-min))
10168 (and
10169 (re-search-forward
10171 (setq type 'dedicated
10172 pos (match-beginning 0))))
10173 ;; There is an exact target for this
10174 (goto-char pos)
10175 (org-back-to-heading t)))
10176 ((save-excursion
10177 (goto-char (point-min))
10178 (and
10179 (re-search-forward
10180 (concat "<<" (regexp-quote s0) ">>") nil t)
10181 (setq type 'dedicated
10182 pos (match-beginning 0))))
10183 ;; There is an exact target for this
10184 (goto-char pos))
10185 ((save-excursion
10186 (goto-char (point-min))
10187 (and
10188 (re-search-forward
10190 (setq type 'dedicated pos (match-beginning 0))))
10191 ;; Found an invisible target.
10192 (goto-char pos))
10193 ((save-excursion
10194 (goto-char (point-min))
10195 (and
10196 (re-search-forward
10198 (setq type 'dedicated pos (match-beginning 0))))
10199 ;; Found an element with a matching #+name affiliated keyword.
10200 (goto-char pos))
10202 (save-excursion
10203 (goto-char (point-min))
10204 (and
10205 (re-search-forward
10206 (concat "[^[]" (regexp-quote
10207 (format org-coderef-label-format
10208 (match-string 1 s0))))
10209 nil t)
10210 (setq type 'dedicated
10211 pos (1+ (match-beginning 0))))))
10212 ;; There is a coderef target for this
10213 (goto-char pos))
10215 ;; A regular expression
10216 (cond
10217 ((derived-mode-p 'org-mode)
10218 (org-occur (match-string 1 s)))
10219 ;;((eq major-mode 'dired-mode)
10220 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
10221 (t (org-do-occur (match-string 1 s)))))
10222 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10223 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10224 (goto-char (point-min))
10225 (cond
10226 ((let (case-fold-search)
10227 (re-search-forward (format org-complex-heading-regexp-format
10228 (regexp-quote s))
10229 nil t))
10230 ;; OK, found a match
10231 (setq type 'dedicated)
10232 (goto-char (match-beginning 0)))
10233 ((and (not org-link-search-inhibit-query)
10234 (eq org-link-search-must-match-exact-headline 'query-to-create)
10235 (y-or-n-p "No match - create this as a new heading? "))
10236 (goto-char (point-max))
10237 (or (bolp) (newline))
10239 (beginning-of-line 0))
10240 (t
10241 (goto-char pos)
10242 (error "No match"))))
10243 (t
10244 ;; A normal search string
10245 (when (equal (string-to-char s) ?*)
10246 ;; Anchor on headlines, post may include tags.
10249 s (substring s 1)))
10250 (remove-text-properties
10251 0 (length s)
10252 '(face nil mouse-face nil keymap nil fontified nil) s)
10253 ;; Make a series of regular expressions to find a match
10262 re4 (concat "[^a-zA-Z_]" re4_)
10264 re1 (concat pre re2 post)
10265 re3 (concat pre (if pre re4_ re4) post)
10266 re5 (concat pre ".*" re4)
10267 re2 (concat pre re2)
10268 re2a (concat pre (if pre re2a_ re2a))
10269 re4 (concat pre (if pre re4_ re4))
10273 ))
10274 (cond
10275 ((eq type 'org-occur) (org-occur reall))
10276 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10277 (t (goto-char (point-min))
10278 (setq type 'fuzzy)
10279 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10280 (org-search-not-self 1 re1 nil t)
10281 (org-search-not-self 1 re2 nil t)
10282 (org-search-not-self 1 re2a nil t)
10283 (org-search-not-self 1 re3 nil t)
10284 (org-search-not-self 1 re4 nil t)
10285 (org-search-not-self 1 re5 nil t)
10286 )
10287 (goto-char (match-beginning 1))
10288 (goto-char pos)
10289 (error "No match"))))))
10290 (and (derived-mode-p 'org-mode)
10291 (not stealth)
10292 (org-show-context 'link-search))
10293 type))
10295 (defun org-search-not-self (group &rest args)
10296 "Execute `re-search-forward', but only accept matches that do not
10297 enclose the position of `org-open-link-marker'."
10298 (let ((m org-open-link-marker))
10299 (catch 'exit
10300 (while (apply 're-search-forward args)
10301 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10302 (goto-char (match-end group))
10303 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10304 (> (match-beginning 0) (marker-position m))
10305 (< (match-end 0) (marker-position m)))
10306 (save-match-data
10307 (or (not (org-in-regexp
10308 org-bracket-link-analytic-regexp 1))
10309 (not (match-end 4)) ; no description
10310 (and (<= (match-beginning 4) (point))
10311 (>= (match-end 4) (point))))))
10312 (throw 'exit (point))))))))
10314 (defun org-get-buffer-for-internal-link (buffer)
10315 "Return a buffer to be used for displaying the link target of internal links."
10316 (cond
10317 ((not org-display-internal-link-with-indirect-buffer)
10318 buffer)
10319 ((string-match "(Clone)$" (buffer-name buffer))
10320 (message "Buffer is already a clone, not making another one")
10321 ;; we also do not modify visibility in this case
10322 buffer)
10323 (t ; make a new indirect buffer for displaying the link
10324 (let* ((bn (buffer-name buffer))
10325 (ibn (concat bn "(Clone)"))
10326 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10327 (with-current-buffer ib (org-overview))
10328 ib))))
10330 (defun org-do-occur (regexp &optional cleanup)
10331 "Call the Emacs command `occur'.
10332 If CLEANUP is non-nil, remove the printout of the regular expression
10333 in the *Occur* buffer. This is useful if the regex is long and not useful
10334 to read."
10335 (occur regexp)
10336 (when cleanup
10337 (let ((cwin (selected-window)) win beg end)
10338 (when (setq win (get-buffer-window "*Occur*"))
10339 (select-window win))
10340 (goto-char (point-min))
10341 (when (re-search-forward "match[a-z]+" nil t)
10342 (setq beg (match-end 0))
10344 (setq end (1- (match-beginning 0)))))
10345 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10346 (goto-char (point-min))
10347 (select-window cwin))))
10349 ;;; The mark ring for links jumps
10351 (defvar org-mark-ring nil
10352 "Mark ring for positions before jumps in Org-mode.")
10353 (defvar org-mark-ring-last-goto nil
10354 "Last position in the mark ring used to go back.")
10355 ;; Fill and close the ring
10356 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10357 (loop for i from 1 to org-mark-ring-length do
10358 (push (make-marker) org-mark-ring))
10359 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10360 org-mark-ring)
10362 (defun org-mark-ring-push (&optional pos buffer)
10363 "Put the current position or POS into the mark ring and rotate it."
10364 (interactive)
10365 (setq pos (or pos (point)))
10366 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10367 (move-marker (car org-mark-ring)
10368 (or pos (point))
10369 (or buffer (current-buffer)))
10370 (message "%s"
10371 (substitute-command-keys
10374 (defun org-mark-ring-goto (&optional n)
10375 "Jump to the previous position in the mark ring.
10376 With prefix arg N, jump back that many stored positions. When
10377 called several times in succession, walk through the entire ring.
10378 Org-mode commands jumping to a different position in the current file,
10379 or to another Org-mode file, automatically push the old position
10380 onto the ring."
10381 (interactive "p")
10382 (let (p m)
10383 (if (eq last-command this-command)
10384 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10385 (setq p org-mark-ring))
10386 (setq org-mark-ring-last-goto p)
10387 (setq m (car p))
10388 (org-pop-to-buffer-same-window (marker-buffer m))
10389 (goto-char m)
10390 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10392 (defun org-remove-angle-brackets (s)
10393 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10394 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10395 s)
10396 (defun org-add-angle-brackets (s)
10397 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10398 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10399 s)
10400 (defun org-remove-double-quotes (s)
10403 s)
10405 ;;; Following specific links
10407 (defun org-follow-timestamp-link ()
10408 "Open an agenda view for the time-stamp date/range at point."
10409 (cond
10410 ((org-at-date-range-p t)
10411 (let ((org-agenda-start-on-weekday)
10412 (t1 (match-string 1))
10413 (t2 (match-string 2)) tt1 tt2)
10414 (setq tt1 (time-to-days (org-time-string-to-time t1))
10415 tt2 (time-to-days (org-time-string-to-time t2)))
10416 (let ((org-agenda-buffer-tmp-name
10417 (format "*Org Agenda(a:%s)"
10418 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10419 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10420 ((org-at-timestamp-p t)
10421 (let ((org-agenda-buffer-tmp-name
10422 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10423 (org-agenda-list nil (time-to-days (org-time-string-to-time
10424 (substring (match-string 1) 0 10)))
10425 1)))
10426 (t (error "This should not happen"))))
10429 ;;; Following file links
10430 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10431 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10432 (declare-function mailcap-mime-info
10433 "mailcap" (string &optional request no-decode))
10434 (defvar org-wait nil)
10435 (defun org-open-file (path &optional in-emacs line search)
10436 "Open the file at PATH.
10437 First, this expands any special file name abbreviations. Then the
10438 configuration variable `org-file-apps' is checked if it contains an
10439 entry for this file type, and if yes, the corresponding command is launched.
10441 If no application is found, Emacs simply visits the file.
10443 With optional prefix argument IN-EMACS, Emacs will visit the file.
10445 prefix arg, Org tries to avoid opening in Emacs
10446 and to use an external application to visit the file.
10448 Optional LINE specifies a line to go to, optional SEARCH a string
10449 to search for. If LINE or SEARCH is given, the file will be
10450 opened in Emacs, unless an entry from org-file-apps that makes
10451 use of groups in a regexp matches.
10453 If you want to change the way frames are used when following a
10454 link, please customize `org-link-frame-setup'.
10456 If the file does not exist, an error is thrown."
10457 (let* ((file (if (equal path "")
10458 buffer-file-name
10459 (substitute-in-file-name (expand-file-name path))))
10460 (file-apps (append org-file-apps (org-default-apps)))
10461 (apps (org-remove-if
10462 'org-file-apps-entry-match-against-dlink-p file-apps))
10463 (apps-dlink (org-remove-if-not
10464 'org-file-apps-entry-match-against-dlink-p file-apps))
10465 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10466 (dirp (if remp nil (file-directory-p file)))
10467 (file (if (and dirp org-open-directory-means-index-dot-org)
10468 (concat (file-name-as-directory file) "index.org")
10469 file))
10470 (a-m-a-p (assq 'auto-mode apps))
10471 (dfile (downcase file))
10472 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10473 (link (cond ((and (eq line nil)
10474 (eq search nil))
10475 file)
10476 (line
10477 (concat file "::" (number-to-string line)))
10478 (search
10479 (concat file "::" search))))
10480 (dlink (downcase link))
10481 (old-buffer (current-buffer))
10482 (old-pos (point))
10483 (old-mode major-mode)
10484 ext cmd link-match-data)
10486 (setq ext (match-string 1 dfile))
10488 (setq ext (match-string 1 dfile))))
10489 (cond
10490 ((member in-emacs '((16) system))
10491 (setq cmd (cdr (assoc 'system apps))))
10492 (in-emacs (setq cmd 'emacs))
10493 (t
10494 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10495 (and dirp (cdr (assoc 'directory apps)))
10496 ; first, try matching against apps-dlink
10497 ; if we get a match here, store the match data for later
10498 (let ((match (assoc-default dlink apps-dlink
10499 'string-match)))
10500 (if match
10501 (progn (setq link-match-data (match-data))
10502 match)
10503 (progn (setq in-emacs (or in-emacs line search))
10504 nil))) ; if we have no match in apps-dlink,
10505 ; always open the file in emacs if line or search
10506 ; is given (for backwards compatibility)
10507 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10508 'string-match)
10509 (cdr (assoc ext apps))
10510 (cdr (assoc t apps))))))
10511 (when (eq cmd 'system)
10512 (setq cmd (cdr (assoc 'system apps))))
10513 (when (eq cmd 'default)
10514 (setq cmd (cdr (assoc t apps))))
10515 (when (eq cmd 'mailcap)
10516 (require 'mailcap)
10517 (mailcap-parse-mailcaps)
10518 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10519 (command (mailcap-mime-info mime-type)))
10520 (if (stringp command)
10521 (setq cmd command)
10522 (setq cmd 'emacs))))
10523 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10524 (not (file-exists-p file))
10525 (not org-open-non-existing-files))
10526 (error "No such file: %s" file))
10527 (cond
10529 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10531 (setq cmd (replace-match "%s" t t cmd)))
10532 (while (string-match "%s" cmd)
10533 (setq cmd (replace-match
10534 (save-match-data
10535 (shell-quote-argument
10536 (convert-standard-filename file)))
10537 t t cmd)))
10539 ;; Replace "%1", "%2" etc. in command with group matches from regex
10540 (save-match-data
10541 (let ((match-index 1)
10542 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10543 (set-match-data link-match-data)
10544 (while (<= match-index number-of-groups)
10545 (let ((regex (concat "%" (number-to-string match-index)))
10546 (replace-with (match-string match-index dlink)))
10547 (while (string-match regex cmd)
10548 (setq cmd (replace-match replace-with t t cmd))))
10549 (setq match-index (+ match-index 1)))))
10551 (save-window-excursion
10552 (message "Running %s...done" cmd)
10553 (start-process-shell-command cmd nil cmd)
10554 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
10555 ((or (stringp cmd)
10556 (eq cmd 'emacs))
10557 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10558 (widen)
10559 (if line (org-goto-line line)
10560 (if search (org-link-search search))))
10561 ((consp cmd)
10562 (let ((file (convert-standard-filename file)))
10563 (save-match-data
10564 (set-match-data link-match-data)
10565 (eval cmd))))
10566 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10567 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10568 (or (not (equal old-buffer (current-buffer)))
10569 (not (equal old-pos (point))))
10570 (org-mark-ring-push old-pos old-buffer))))
10572 (defun org-file-apps-entry-match-against-dlink-p (entry)
10573 "This function returns non-nil if `entry' uses a regular
10574 expression which should be matched against the whole link by
10575 org-open-file.
10577 It assumes that is the case when the entry uses a regular
10578 expression which has at least one grouping construct and the
10579 action is either a lisp form or a command string containing
10580 '%1', i.e. using at least one subexpression match as a
10581 parameter."
10582 (let ((selector (car entry))
10583 (action (cdr entry)))
10584 (if (stringp selector)
10585 (and (> (regexp-opt-depth selector) 0)
10586 (or (and (stringp action)
10587 (string-match "%[0-9]" action))
10588 (consp action)))
10589 nil)))
10591 (defun org-default-apps ()
10592 "Return the default applications for this operating system."
10593 (cond
10594 ((eq system-type 'darwin)
10595 org-file-apps-defaults-macosx)
10596 ((eq system-type 'windows-nt)
10597 org-file-apps-defaults-windowsnt)
10598 (t org-file-apps-defaults-gnu)))
10600 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10601 "Convert extensions to regular expressions in the cars of LIST.
10602 Also, weed out any non-string entries, because the return value is used
10603 only for regexp matching.
10604 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10605 point to the symbol `emacs', indicating that the file should
10606 be opened in Emacs."
10607 (append
10608 (delq nil
10609 (mapcar (lambda (x)
10610 (if (not (stringp (car x)))
10611 nil
10613 x
10615 list))
10616 (if add-auto-mode
10617 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10619 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10620 (defun org-file-remote-p (file)
10621 "Test whether FILE specifies a location on a remote system.
10622 Return non-nil if the location is indeed remote.
10626 (cond ((fboundp 'file-remote-p)
10627 (file-remote-p file))
10628 ((fboundp 'tramp-handle-file-remote-p)
10629 (tramp-handle-file-remote-p file))
10630 ((and (boundp 'ange-ftp-name-format)
10631 (string-match (car ange-ftp-name-format) file))
10632 t)))
10635 ;;;; Refiling
10637 (defun org-get-org-file ()
10638 "Read a filename, with default directory `org-directory'."
10639 (let ((default (or org-default-notes-file remember-data-file)))
10640 (read-file-name (format "File name [%s]: " default)
10641 (file-name-as-directory org-directory)
10642 default)))
10644 (defun org-notes-order-reversed-p ()
10645 "Check if the current file should receive notes in reversed order."
10646 (cond
10647 ((not org-reverse-note-order) nil)
10648 ((eq t org-reverse-note-order) t)
10649 ((not (listp org-reverse-note-order)) nil)
10650 (t (catch 'exit
10651 (let ((all org-reverse-note-order)
10652 entry)
10653 (while (setq entry (pop all))
10654 (if (string-match (car entry) buffer-file-name)
10655 (throw 'exit (cdr entry))))
10656 nil)))))
10658 (defvar org-refile-target-table nil
10659 "The list of refile targets, created by `org-refile'.")
10661 (defvar org-agenda-new-buffers nil
10662 "Buffers created to visit agenda files.")
10664 (defvar org-refile-cache nil
10665 "Cache for refile targets.")
10667 (defvar org-refile-markers nil
10668 "All the markers used for caching refile locations.")
10670 (defun org-refile-marker (pos)
10671 "Get a new refile marker, but only if caching is in use."
10672 (if (not org-refile-use-cache)
10673 pos
10674 (let ((m (make-marker)))
10675 (move-marker m pos)
10676 (push m org-refile-markers)
10677 m)))
10679 (defun org-refile-cache-clear ()
10680 "Clear the refile cache and disable all the markers."
10681 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10682 (setq org-refile-markers nil)
10683 (setq org-refile-cache nil)
10684 (message "Refile cache has been cleared"))
10686 (defun org-refile-cache-check-set (set)
10687 "Check if all the markers in the cache still have live buffers."
10688 (let (marker)
10689 (catch 'exit
10690 (while (and set (setq marker (nth 3 (pop set))))
10691 ;; if org-refile-use-outline-path is 'file, marker may be nil
10692 (when (and marker (null (marker-buffer marker)))
10693 (message "not found") (sit-for 3)
10694 (throw 'exit nil)))
10695 t)))
10697 (defun org-refile-cache-put (set &rest identifiers)
10698 "Push the refile targets SET into the cache, under IDENTIFIERS."
10699 (let* ((key (sha1 (prin1-to-string identifiers)))
10700 (entry (assoc key org-refile-cache)))
10701 (if entry
10702 (setcdr entry set)
10703 (push (cons key set) org-refile-cache))))
10705 (defun org-refile-cache-get (&rest identifiers)
10706 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10707 (cond
10708 ((not org-refile-cache) nil)
10709 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10710 (t
10711 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10712 org-refile-cache))))
10713 (and set (org-refile-cache-check-set set) set)))))
10715 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10716 "Produce a table with refile targets."
10717 (let ((case-fold-search nil)
10718 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10719 (entries (or org-refile-targets '((nil . (:level . 1)))))
10720 targets tgs txt re files f desc descre fast-path-p level pos0)
10721 (message "Getting targets...")
10722 (with-current-buffer (or default-buffer (current-buffer))
10723 (while (setq entry (pop entries))
10724 (setq files (car entry) desc (cdr entry))
10725 (setq fast-path-p nil)
10726 (cond
10727 ((null files) (setq files (list (current-buffer))))
10728 ((eq files 'org-agenda-files)
10729 (setq files (org-agenda-files 'unrestricted)))
10730 ((and (symbolp files) (fboundp files))
10731 (setq files (funcall files)))
10732 ((and (symbolp files) (boundp files))
10733 (setq files (symbol-value files))))
10734 (if (stringp files) (setq files (list files)))
10735 (cond
10736 ((eq (car desc) :tag)
10738 ((eq (car desc) :todo)
10740 ((eq (car desc) :regexp)
10741 (setq descre (cdr desc)))
10742 ((eq (car desc) :level)
10744 (if org-odd-levels-only
10745 (1- (* 2 (cdr desc)))
10746 (cdr desc)))
10748 ((eq (car desc) :maxlevel)
10749 (setq fast-path-p t)
10751 (if org-odd-levels-only
10752 (1- (* 2 (cdr desc)))
10753 (cdr desc)))
10755 (t (error "Bad refiling target description %s" desc)))
10756 (while (setq f (pop files))
10757 (with-current-buffer
10758 (if (bufferp f) f (org-get-agenda-file-buffer f))
10759 (or
10760 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10761 (progn
10762 (if (bufferp f) (setq f (buffer-file-name
10763 (buffer-base-buffer f))))
10764 (setq f (and f (expand-file-name f)))
10765 (if (eq org-refile-use-outline-path 'file)
10766 (push (list (file-name-nondirectory f) f nil nil) tgs))
10767 (save-excursion
10768 (save-restriction
10769 (widen)
10770 (goto-char (point-min))
10771 (while (re-search-forward descre nil t)
10772 (goto-char (setq pos0 (point-at-bol)))
10773 (catch 'next
10774 (when org-refile-target-verify-function
10775 (save-match-data
10776 (or (funcall org-refile-target-verify-function)
10777 (throw 'next t))))
10778 (when (and (looking-at org-complex-heading-regexp)
10779 (not (member (match-string 4) excluded-entries))
10780 (match-string 4))
10781 (setq level (org-reduced-level
10782 (- (match-end 1) (match-beginning 1)))
10783 txt (org-link-display-format (match-string 4))
10785 re (format org-complex-heading-regexp-format
10786 (regexp-quote (match-string 4))))
10787 (when org-refile-use-outline-path
10788 (setq txt (mapconcat
10789 'org-protect-slash
10790 (append
10791 (if (eq org-refile-use-outline-path
10792 'file)
10793 (list (file-name-nondirectory
10794 (buffer-file-name
10795 (buffer-base-buffer))))
10796 (if (eq org-refile-use-outline-path
10797 'full-file-path)
10798 (list (buffer-file-name
10799 (buffer-base-buffer)))))
10800 (org-get-outline-path fast-path-p
10801 level txt)
10802 (list txt))
10803 "/")))
10804 (push (list txt f re (org-refile-marker (point)))
10805 tgs)))
10806 (when (= (point) pos0)
10807 ;; verification function has not moved point
10808 (goto-char (point-at-eol))))))))
10809 (when org-refile-use-cache
10810 (org-refile-cache-put tgs (buffer-file-name) descre))
10811 (setq targets (append tgs targets))
10812 ))))
10813 (message "Getting targets...done")
10814 (nreverse targets)))
10816 (defun org-protect-slash (s)
10817 (while (string-match "/" s)
10819 s)
10821 (defvar org-olpa (make-vector 20 nil))
10823 (defun org-get-outline-path (&optional fastp level heading)
10824 "Return the outline path to the current entry, as a list.
10826 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10827 routine which makes outline path derivations for an entire file,
10828 avoiding backtracing. Refile target collection makes use of that."
10829 (if fastp
10830 (progn
10831 (if (> level 19)
10832 (error "Outline path failure, more than 19 levels"))
10833 (loop for i from level upto 19 do
10834 (aset org-olpa i nil))
10835 (prog1
10836 (delq nil (append org-olpa nil))
10837 (aset org-olpa level heading)))
10838 (let (rtn case-fold-search)
10839 (save-excursion
10840 (save-restriction
10841 (widen)
10842 (while (org-up-heading-safe)
10843 (when (looking-at org-complex-heading-regexp)
10844 (push (org-match-string-no-properties 4) rtn)))
10845 rtn)))))
10847 (defun org-format-outline-path (path &optional width prefix separator)
10848 "Format the outline path PATH for display.
10849 WIDTH is the maximum number of characters that is available.
10850 PREFIX is a prefix to be included in the returned string,
10851 such as the file name.
10852 SEPARATOR is inserted between the different parts of the path,
10854 (setq width (or width 79))
10855 (if prefix (setq width (- width (length prefix))))
10856 (if (not path)
10857 (or prefix "")
10858 (let* ((nsteps (length path))
10859 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10860 (maxwidth (if (<= total-width width)
10861 10000 ;; everything fits
10862 ;; we need to shorten the level headings
10863 (/ (- width nsteps) nsteps)))
10864 (org-odd-levels-only nil)
10865 (n 0)
10866 (total (1+ (length prefix))))
10867 (setq maxwidth (max maxwidth 10))
10868 (concat prefix
10869 (if prefix (or separator "/"))
10870 (mapconcat
10871 (lambda (h)
10872 (setq n (1+ n))
10873 (if (and (= n nsteps) (< maxwidth 10000))
10874 (setq maxwidth (- total-width total)))
10875 (if (< (length h) maxwidth)
10876 (progn (setq total (+ total (length h) 1)) h)
10877 (setq h (substring h 0 (- maxwidth 2))
10878 total (+ total maxwidth 1))
10880 (setq h (substring h 0 (match-beginning 0))))
10881 (setq h (concat h "..")))
10882 (org-add-props h nil 'face
10883 (nth (% (1- n) org-n-level-faces)
10884 org-level-faces))
10885 h)
10886 path (or separator "/"))))))
10888 (defun org-display-outline-path (&optional file current separator just-return-string)
10889 "Display the current outline path in the echo area.
10891 If FILE is non-nil, prepend the output with the file name.
10892 If CURRENT is non-nil, append the current heading to the output.
10893 SEPARATOR is passed through to `org-format-outline-path'. It separates
10895 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
10896 (interactive "P")
10897 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10898 (case-fold-search nil)
10899 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
10900 res)
10901 (if current (setq path (append path
10902 (save-excursion
10903 (org-back-to-heading t)
10904 (if (looking-at org-complex-heading-regexp)
10905 (list (match-string 4)))))))
10906 (setq res
10907 (org-format-outline-path
10908 path
10909 (1- (frame-width))
10910 (and file bfn (concat (file-name-nondirectory bfn) separator))
10911 separator))
10912 (if just-return-string
10913 (org-no-properties res)
10914 (message "%s" res))))
10916 (defvar org-refile-history nil
10917 "History for refiling operations.")
10919 (defvar org-after-refile-insert-hook nil
10920 "Hook run after `org-refile' has inserted its stuff at the new location.
10921 Note that this is still *before* the stuff will be removed from
10922 the *old* location.")
10924 (defvar org-capture-last-stored-marker)
10925 (defvar org-refile-keep nil
10926 "Non-nil means `org-refile' will copy instead of refile.")
10928 (defun org-copy ()
10929 "Like `org-refile', but copy."
10930 (interactive)
10931 (let ((org-refile-keep t))
10932 (funcall 'org-refile nil nil nil "Copy")))
10934 (defun org-refile (&optional goto default-buffer rfloc msg)
10935 "Move the entry or entries at point to another heading.
10936 The list of target headings is compiled using the information in
10937 `org-refile-targets', which see.
10939 At the target location, the entry is filed as a subitem of the target
10940 heading. Depending on `org-reverse-note-order', the new subitem will
10941 either be the first or the last subitem.
10943 If there is an active region, all entries in that region will be moved.
10944 However, the region must fulfill the requirement that the first heading
10945 is the first one sets the top-level of the moved text - at most siblings
10946 below it are allowed.
10948 With prefix arg GOTO, the command will only visit the target location
10949 and not actually move anything.
10952 go to the location where the last refiling operation has put the subtree.
10953 With a prefix argument of `2', refile to the running clock.
10955 RFLOC can be a refile location obtained in a different way.
10960 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10962 If you are using target caching (see `org-refile-use-cache'),
10963 you have to clear the target cache in order to find new targets.
10964 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10965 prefix argument (`C-u C-u C-u C-c C-w')."
10967 (interactive "P")
10968 (if (member goto '(0 (64)))
10969 (org-refile-cache-clear)
10970 (let* ((actionmsg (or msg "Refile"))
10971 (cbuf (current-buffer))
10972 (regionp (org-region-active-p))
10973 (region-start (and regionp (region-beginning)))
10974 (region-end (and regionp (region-end)))
10975 (region-length (and regionp (- region-end region-start)))
10976 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10977 pos it nbuf file re level reversed)
10978 (setq last-command nil)
10979 (when regionp
10980 (goto-char region-start)
10981 (or (bolp) (goto-char (point-at-bol)))
10982 (setq region-start (point))
10983 (unless (or (org-kill-is-subtree-p
10984 (buffer-substring region-start region-end))
10985 (prog1 org-refile-active-region-within-subtree
10986 (org-toggle-heading)))
10987 (error "The region is not a (sequence of) subtree(s)")))
10988 (if (equal goto '(16))
10989 (org-refile-goto-last-stored)
10990 (when (or
10991 (and (equal goto 2)
10992 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10993 (prog1
10994 (setq it (list (or org-clock-heading "running clock")
10995 (buffer-file-name
10996 (marker-buffer org-clock-hd-marker))
10997 ""
10998 (marker-position org-clock-hd-marker)))
10999 (setq goto nil)))
11000 (setq it (or rfloc
11001 (let (heading-text)
11002 (save-excursion
11003 (unless goto
11004 (org-back-to-heading t)
11005 (setq heading-text
11006 (nth 4 (org-heading-components))))
11008 (org-refile-get-location
11009 (cond (goto "Goto")
11010 (regionp (concat actionmsg " region to"))
11013 default-buffer
11014 (and (not (equal '(4) goto))
11015 org-refile-allow-creating-parent-nodes)
11016 goto))))))
11017 (setq file (nth 1 it)
11018 re (nth 2 it)
11019 pos (nth 3 it))
11020 (if (and (not goto)
11021 pos
11022 (equal (buffer-file-name) file)
11023 (if regionp
11024 (and (>= pos region-start)
11025 (<= pos region-end))
11026 (and (>= pos (point))
11027 (< pos (save-excursion
11028 (org-end-of-subtree t t))))))
11029 (error "Cannot refile to position inside the tree or region"))
11031 (setq nbuf (or (find-buffer-visiting file)
11032 (find-file-noselect file)))
11033 (if goto
11034 (progn
11035 (org-pop-to-buffer-same-window nbuf)
11036 (goto-char pos)
11037 (org-show-context 'org-goto))
11038 (if regionp
11039 (progn
11040 (org-kill-new (buffer-substring region-start region-end))
11041 (org-save-markers-in-region region-start region-end))
11042 (org-copy-subtree 1 nil t))
11043 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11044 (find-file-noselect file)))
11045 (setq reversed (org-notes-order-reversed-p))
11046 (save-excursion
11047 (save-restriction
11048 (widen)
11049 (if pos
11050 (progn
11051 (goto-char pos)
11052 (looking-at org-outline-regexp)
11053 (setq level (org-get-valid-level (funcall outline-level) 1))
11054 (goto-char
11055 (if reversed
11056 (or (outline-next-heading) (point-max))
11057 (or (save-excursion (org-get-next-sibling))
11058 (org-end-of-subtree t t)
11059 (point-max)))))
11060 (setq level 1)
11061 (if (not reversed)
11062 (goto-char (point-max))
11063 (goto-char (point-min))
11064 (or (outline-next-heading) (goto-char (point-max)))))
11065 (if (not (bolp)) (newline))
11066 (org-paste-subtree level)
11067 (when org-log-refile
11068 (org-add-log-setup 'refile nil nil 'findpos
11069 org-log-refile)
11070 (unless (eq org-log-refile 'note)
11071 (save-excursion (org-add-log-note))))
11072 (and org-auto-align-tags
11073 (let ((org-loop-over-headlines-in-active-region nil))
11074 (org-set-tags nil t)))
11075 (with-demoted-errors
11076 (bookmark-set "org-refile-last-stored"))
11077 ;; If we are refiling for capture, make sure that the
11078 ;; last-capture pointers point here
11079 (when (org-bound-and-true-p org-refile-for-capture)
11080 (with-demoted-errors
11081 (bookmark-set "org-capture-last-stored-marker"))
11082 (move-marker org-capture-last-stored-marker (point)))
11083 (if (fboundp 'deactivate-mark) (deactivate-mark))
11084 (run-hooks 'org-after-refile-insert-hook))))
11085 (unless org-refile-keep
11086 (if regionp
11087 (delete-region (point) (+ (point) region-length))
11088 (org-cut-subtree)))
11089 (when (featurep 'org-inlinetask)
11090 (org-inlinetask-remove-END-maybe))
11091 (setq org-markers-to-move nil)
11094 (defun org-refile-goto-last-stored ()
11095 "Go to the location where the last refile was stored."
11096 (interactive)
11097 (bookmark-jump "org-refile-last-stored")
11098 (message "This is the location of the last refile"))
11100 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11101 no-exclude)
11102 "Prompt the user for a refile location, using PROMPT.
11103 PROMPT should not be suffixed with a colon and a space, because
11104 this function appends the default value from
11105 `org-refile-history' automatically, if that is not empty.
11106 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11107 this is used for the GOTO interface."
11108 (let ((org-refile-targets org-refile-targets)
11109 (org-refile-use-outline-path org-refile-use-outline-path)
11110 excluded-entries)
11111 (when (and (derived-mode-p 'org-mode)
11112 (not org-refile-use-cache)
11113 (not no-exclude))
11114 (org-map-tree
11115 (lambda()
11116 (setq excluded-entries
11117 (append excluded-entries (list (org-get-heading t t)))))))
11118 (setq org-refile-target-table
11119 (org-refile-get-targets default-buffer excluded-entries)))
11120 (unless org-refile-target-table
11121 (error "No refile targets"))
11122 (let* ((cbuf (current-buffer))
11123 (partial-completion-mode nil)
11124 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11125 (cfunc (if (and org-refile-use-outline-path
11126 org-outline-path-complete-in-steps)
11127 'org-olpath-completing-read
11128 'org-icompleting-read))
11129 (extra (if org-refile-use-outline-path "/" ""))
11130 (cbnex (concat (buffer-name) extra))
11131 (filename (and cfn (expand-file-name cfn)))
11132 (tbl (mapcar
11133 (lambda (x)
11134 (if (and (not (member org-refile-use-outline-path
11135 '(file full-file-path)))
11136 (not (equal filename (nth 1 x))))
11137 (cons (concat (car x) extra " ("
11138 (file-name-nondirectory (nth 1 x)) ")")
11139 (cdr x))
11140 (cons (concat (car x) extra) (cdr x))))
11141 org-refile-target-table))
11142 (completion-ignore-case t)
11143 cdef
11144 (prompt (concat prompt
11145 (or (and (car org-refile-history)
11146 (concat " (default " (car org-refile-history) ")"))
11147 (and (assoc cbnex tbl) (setq cdef cbnex)
11148 (concat " (default " cbnex ")"))) ": "))
11149 pa answ parent-target child parent old-hist)
11150 (setq old-hist org-refile-history)
11151 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11152 nil 'org-refile-history (or cdef (car org-refile-history))))
11153 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11154 (org-refile-check-position pa)
11155 (if pa
11156 (progn
11157 (when (or (not org-refile-history)
11158 (not (eq old-hist org-refile-history))
11159 (not (equal (car pa) (car org-refile-history))))
11160 (setq org-refile-history
11161 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11162 org-refile-history
11163 (cdr org-refile-history))))
11164 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11165 (pop org-refile-history)))
11166 pa)
11168 (progn
11169 (setq parent (match-string 1 answ)
11170 child (match-string 2 answ))
11171 (setq parent-target (or (assoc parent tbl)
11172 (assoc (concat parent "/") tbl)))
11173 (when (and parent-target
11174 (or (eq new-nodes t)
11175 (and (eq new-nodes 'confirm)
11177 child)))))
11178 (org-refile-new-child parent-target child)))
11179 (error "Invalid target location")))))
11181 (declare-function org-string-nw-p "org-macs" (s))
11182 (defun org-refile-check-position (refile-pointer)
11183 "Check if the refile pointer matches the headline to which it points."
11184 (let* ((file (nth 1 refile-pointer))
11185 (re (nth 2 refile-pointer))
11186 (pos (nth 3 refile-pointer))
11187 buffer)
11188 (if (and (not (markerp pos)) (not file))
11189 (error "Please save the buffer to a file before refiling")
11190 (when (org-string-nw-p re)
11191 (setq buffer (if (markerp pos)
11192 (marker-buffer pos)
11193 (or (find-buffer-visiting file)
11194 (find-file-noselect file))))
11195 (with-current-buffer buffer
11196 (save-excursion
11197 (save-restriction
11198 (widen)
11199 (goto-char pos)
11200 (beginning-of-line 1)
11201 (unless (org-looking-at-p re)
11202 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11204 (defun org-refile-new-child (parent-target child)
11205 "Use refile target PARENT-TARGET to add new CHILD below it."
11206 (unless parent-target
11207 (error "Cannot find parent for new node"))
11208 (let ((file (nth 1 parent-target))
11209 (pos (nth 3 parent-target))
11210 level)
11211 (with-current-buffer (or (find-buffer-visiting file)
11212 (find-file-noselect file))
11213 (save-excursion
11214 (save-restriction
11215 (widen)
11216 (if pos
11217 (goto-char pos)
11218 (goto-char (point-max))
11219 (if (not (bolp)) (newline)))
11220 (when (looking-at org-outline-regexp)
11221 (setq level (funcall outline-level))
11222 (org-end-of-subtree t t))
11223 (org-back-over-empty-lines)
11225 (if pos (org-get-valid-level level 1) 1) ?*)
11227 (beginning-of-line 0)
11228 (list (concat (car parent-target) "/" child) file "" (point)))))))
11230 (defun org-olpath-completing-read (prompt collection &rest args)
11231 "Read an outline path like a file name."
11232 (let ((thetable collection)
11233 (org-completion-use-ido nil) ; does not work with ido.
11234 (org-completion-use-iswitchb nil)) ; or iswitchb
11235 (apply
11236 'org-icompleting-read prompt
11237 (lambda (string predicate &optional flag)
11238 (let (rtn r f (l (length string)))
11239 (cond
11240 ((eq flag nil)
11241 ;; try completion
11242 (try-completion string thetable))
11243 ((eq flag t)
11244 ;; all-completions
11245 (setq rtn (all-completions string thetable predicate))
11246 (mapcar
11247 (lambda (x)
11248 (setq r (substring x l))
11249 (if (string-match " ([^)]*)$" x)
11250 (setq f (match-string 0 x))
11251 (setq f ""))
11252 (if (string-match "/" r)
11253 (concat string (substring r 0 (match-end 0)) f)
11254 x))
11255 rtn))
11256 ((eq flag 'lambda)
11257 ;; exact match?
11258 (assoc string thetable)))))
11259 args)))
11261 ;;;; Dynamic blocks
11263 (defun org-find-dblock (name)
11264 "Find the first dynamic block with name NAME in the buffer.
11265 If not found, stay at current position and return nil."
11266 (let ((case-fold-search t) pos)
11267 (save-excursion
11268 (goto-char (point-min))
11269 (setq pos (and (re-search-forward
11271 (match-beginning 0))))
11272 (if pos (goto-char pos))
11273 pos))
11275 (defconst org-dblock-start-re
11277 "Matches the start line of a dynamic block, with parameters.")
11280 "Matches the end of a dynamic block.")
11282 (defun org-create-dblock (plist)
11283 "Create a dynamic block section, with parameters taken from PLIST.
11284 PLIST must contain a :name entry which is used as name of the block."
11286 (end-of-line 1)
11287 (newline))
11288 (let ((col (current-column))
11289 (name (plist-get plist :name)))
11290 (insert "#+BEGIN: " name)
11291 (while plist
11292 (if (eq (car plist) :name)
11293 (setq plist (cddr plist))
11294 (insert " " (prin1-to-string (pop plist)))))
11296 (beginning-of-line -2)))
11298 (defun org-prepare-dblock ()
11299 "Prepare dynamic block for refresh.
11300 This empties the block, puts the cursor at the insert position and returns
11301 the property list including an extra property :name with the block name."
11302 (unless (looking-at org-dblock-start-re)
11303 (error "Not at a dynamic block"))
11304 (let* ((begdel (1+ (match-end 0)))
11305 (name (org-no-properties (match-string 1)))
11306 (params (append (list :name name)
11307 (read (concat "(" (match-string 3) ")")))))
11308 (save-excursion
11309 (beginning-of-line 1)
11311 (setq params (plist-put params :indentation-column (current-column))))
11312 (unless (re-search-forward org-dblock-end-re nil t)
11313 (error "Dynamic block not terminated"))
11314 (setq params
11315 (append params
11316 (list :content (buffer-substring
11317 begdel (match-beginning 0)))))
11318 (delete-region begdel (match-beginning 0))
11319 (goto-char begdel)
11320 (open-line 1)
11321 params))
11323 (defun org-map-dblocks (&optional command)
11324 "Apply COMMAND to all dynamic blocks in the current buffer.
11325 If COMMAND is not given, use `org-update-dblock'."
11326 (let ((cmd (or command 'org-update-dblock)))
11327 (save-excursion
11328 (goto-char (point-min))
11329 (while (re-search-forward org-dblock-start-re nil t)
11330 (goto-char (match-beginning 0))
11331 (save-excursion
11332 (condition-case nil
11333 (funcall cmd)
11334 (error (message "Error during update of dynamic block"))))
11335 (unless (re-search-forward org-dblock-end-re nil t)
11336 (error "Dynamic block not terminated"))))))
11338 (defun org-dblock-update (&optional arg)
11339 "User command for updating dynamic blocks.
11340 Update the dynamic block at point. With prefix ARG, update all dynamic
11341 blocks in the buffer."
11342 (interactive "P")
11343 (if arg
11344 (org-update-all-dblocks)
11345 (or (looking-at org-dblock-start-re)
11346 (org-beginning-of-dblock))
11347 (org-update-dblock)))
11349 (defun org-update-dblock ()
11350 "Update the dynamic block at point.
11351 This means to empty the block, parse for parameters and then call
11352 the correct writing function."
11353 (interactive)
11354 (save-window-excursion
11355 (let* ((pos (point))
11356 (line (org-current-line))
11357 (params (org-prepare-dblock))
11358 (name (plist-get params :name))
11359 (indent (plist-get params :indentation-column))
11360 (cmd (intern (concat "org-dblock-write:" name))))
11361 (message "Updating dynamic block `%s' at line %d..." name line)
11362 (funcall cmd params)
11363 (message "Updating dynamic block `%s' at line %d...done" name line)
11364 (goto-char pos)
11365 (when (and indent (> indent 0))
11366 (setq indent (make-string indent ?\ ))
11367 (save-excursion
11368 (org-beginning-of-dblock)
11369 (forward-line 1)
11370 (while (not (looking-at org-dblock-end-re))
11371 (insert indent)
11372 (beginning-of-line 2))
11373 (when (looking-at org-dblock-end-re)
11375 (replace-match ""))
11376 (insert indent)))))))
11378 (defun org-beginning-of-dblock ()
11379 "Find the beginning of the dynamic block at point.
11380 Error if there is no such block at point."
11381 (let ((pos (point))
11382 beg)
11383 (end-of-line 1)
11384 (if (and (re-search-backward org-dblock-start-re nil t)
11385 (setq beg (match-beginning 0))
11386 (re-search-forward org-dblock-end-re nil t)
11387 (> (match-end 0) pos))
11388 (goto-char beg)
11389 (goto-char pos)
11390 (error "Not in a dynamic block"))))
11392 (defun org-update-all-dblocks ()
11393 "Update all dynamic blocks in the buffer.
11394 This function can be used in a hook."
11395 (interactive)
11396 (when (derived-mode-p 'org-mode)
11397 (org-map-dblocks 'org-update-dblock)))
11400 ;;;; Completion
11402 (defconst org-additional-option-like-keywords
11403 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11404 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11405 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11406 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11407 "BEGIN:" "END:"
11408 "ORGTBL" "TBLFM:" "TBLNAME:"
11409 "BEGIN_EXAMPLE" "END_EXAMPLE"
11410 "BEGIN_VERBATIM" "END_VERBATIM"
11411 "BEGIN_QUOTE" "END_QUOTE"
11412 "BEGIN_VERSE" "END_VERSE"
11413 "BEGIN_CENTER" "END_CENTER"
11414 "BEGIN_SRC" "END_SRC"
11415 "BEGIN_RESULT" "END_RESULT"
11416 "BEGIN_lstlisting" "END_lstlisting"
11417 "NAME:" "RESULTS:"
11418 "HEADER:" "HEADERS:"
11419 "COLUMNS:" "PROPERTY:"
11420 "CAPTION:" "LABEL:"
11421 "SETUPFILE:"
11422 "INCLUDE:" "INDEX:"
11423 "BIND:"
11424 "MACRO:"))
11426 (defconst org-options-keywords
11427 '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
11428 "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
11429 "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
11430 "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
11431 "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
11432 "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:" "STYLE:"
11433 "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
11435 (defconst org-additional-option-like-keywords-for-flyspell
11436 (delete-dups
11437 (split-string
11438 (mapconcat (lambda(k)
11439 (replace-regexp-in-string
11441 (concat k " " (downcase k) " " (upcase k))))
11442 (append org-options-keywords org-additional-option-like-keywords)
11443 " ")
11444 " +" t)))
11446 (defcustom org-structure-template-alist
11447 '(
11460 ("L" "#+LaTeX: "
11464 ("H" "#+HTML: "
11467 ("A" "#+ASCII: ")
11468 ("i" "#+INDEX: ?"
11469 "#+INDEX: ?")
11470 ("I" "#+INCLUDE: %file ?"
11472 )
11473 "Structure completion elements.
11474 This is a list of abbreviation keys and values. The value gets inserted
11475 if you type `<' followed by the key and then press the completion key,
11476 usually `M-TAB'. %file will be replaced by a file name after prompting
11477 for the file using completion. The cursor will be placed at the position
11478 of the `?` in the template.
11479 There are two templates for each key, the first uses the original Org syntax,
11480 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11481 the default when the /org-mtags.el/ module has been loaded. See also the
11482 variable `org-mtags-prefer-muse-templates'."
11483 :group 'org-completion
11484 :type '(repeat
11485 (string :tag "Key")
11486 (string :tag "Template")
11487 (string :tag "Muse Template")))
11489 (defun org-try-structure-completion ()
11490 "Try to complete a structure template before point.
11492 expands them."
11493 (let ((l (buffer-substring (point-at-bol) (point)))
11494 a)
11497 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11498 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11499 (match-beginning 1)) a)
11500 t)))
11502 (defun org-complete-expand-structure-template (start cell)
11503 "Expand a structure template."
11504 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11505 (rpl (nth (if musep 2 1) cell))
11506 (ind ""))
11507 (delete-region start (point))
11509 (cond
11510 ((bolp))
11512 (setq ind (buffer-substring (point-at-bol) (point))))
11513 (t (newline))))
11514 (setq start (point))
11515 (if (string-match "%file" rpl)
11516 (setq rpl (replace-match
11517 (concat
11519 (save-match-data
11520 (abbreviate-file-name (read-file-name "Include file: ")))
11522 t t rpl)))
11525 (insert rpl)
11528 ;;;; TODO, DEADLINE, Comments
11530 (defun org-toggle-comment ()
11531 "Change the COMMENT state of an entry."
11532 (interactive)
11533 (save-excursion
11534 (org-back-to-heading)
11535 (let (case-fold-search)
11536 (cond
11537 ((looking-at (format org-heading-keyword-regexp-format
11538 org-comment-string))
11539 (goto-char (match-end 1))
11540 (looking-at (concat " +" org-comment-string))
11541 (replace-match "" t t)
11542 (when (eolp) (insert " ")))
11543 ((looking-at org-outline-regexp)
11544 (goto-char (match-end 0))
11545 (insert org-comment-string " "))))))
11547 (defvar org-last-todo-state-is-todo nil
11548 "This is non-nil when the last TODO state change led to a TODO state.
11549 If the last change removed the TODO tag or switched to DONE, then
11550 this is nil.")
11552 (defvar org-setting-tags nil) ; dynamically skipped
11554 (defvar org-todo-setup-filter-hook nil
11555 "Hook for functions that pre-filter todo specs.
11556 Each function takes a todo spec and returns either nil or the spec
11557 transformed into canonical form." )
11559 (defvar org-todo-get-default-hook nil
11560 "Hook for functions that get a default item for todo.
11561 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11562 nil or a string to be used for the todo mark." )
11564 (defvar org-agenda-headline-snapshot-before-repeat)
11566 (defun org-current-effective-time ()
11567 "Return current time adjusted for `org-extend-today-until' variable."
11568 (let* ((ct (org-current-time))
11569 (dct (decode-time ct))
11570 (ct1
11571 (cond
11572 (org-use-last-clock-out-time-as-effective-time
11573 (or (org-clock-get-last-clock-out-time) ct))
11574 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
11575 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
11576 (t ct))))
11577 ct1))
11579 (defun org-todo-yesterday (&optional arg)
11580 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11581 (interactive "P")
11582 (if (eq major-mode 'org-agenda-mode)
11583 (apply 'org-agenda-todo-yesterday arg)
11584 (let* ((hour (third (decode-time
11585 (org-current-time))))
11586 (org-extend-today-until (1+ hour)))
11587 (org-todo arg))))
11589 (defvar org-block-entry-blocking ""
11590 "First entry preventing the TODO state change.")
11592 (defun org-todo (&optional arg)
11593 "Change the TODO state of an item.
11594 The state of an item is given by a keyword at the start of the heading,
11595 like
11596 *** TODO Write paper
11597 *** DONE Call mom
11599 The different keywords are specified in the variable `org-todo-keywords'.
11601 So for this example: when the item starts with TODO, it is changed to DONE.
11602 When it starts with DONE, the DONE is removed. And when neither TODO nor
11603 DONE are present, add TODO at the beginning of the heading.
11606 state.
11607 With numeric prefix arg, switch to that state.
11609 keywords (nextset).
11611 With a numeric prefix arg of 0, inhibit note taking for the change.
11613 For calling through lisp, arg is also interpreted in the following way:
11614 'none -> empty state
11616 'done -> switch to DONE
11617 'nextset -> switch to the next set of keywords
11618 'previousset -> switch to the previous set of keywords
11620 really is a member of `org-todo-keywords'."
11621 (interactive "P")
11622 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11623 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11624 'region-start-level 'region))
11625 org-loop-over-headlines-in-active-region)
11626 (org-map-entries
11627 `(org-todo ,arg)
11628 org-loop-over-headlines-in-active-region
11629 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11630 (if (equal arg '(16)) (setq arg 'nextset))
11631 (let ((org-blocker-hook org-blocker-hook)
11632 (case-fold-search nil))
11633 (when (equal arg '(64))
11634 (setq arg nil org-blocker-hook nil))
11635 (when (and org-blocker-hook
11636 (or org-inhibit-blocking
11637 (org-entry-get nil "NOBLOCKING")))
11638 (setq org-blocker-hook nil))
11639 (save-excursion
11640 (catch 'exit
11641 (org-back-to-heading t)
11642 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11645 (let* ((match-data (match-data))
11646 (startpos (point-at-bol))
11647 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11648 (org-log-done org-log-done)
11649 (org-log-repeat org-log-repeat)
11650 (org-todo-log-states org-todo-log-states)
11651 (org-inhibit-logging
11652 (if (equal arg 0)
11653 (progn (setq arg nil) 'note) org-inhibit-logging))
11654 (this (match-string 1))
11655 (hl-pos (match-beginning 0))
11656 (head (org-get-todo-sequence-head this))
11657 (ass (assoc head org-todo-kwd-alist))
11658 (interpret (nth 1 ass))
11659 (done-word (nth 3 ass))
11660 (final-done-word (nth 4 ass))
11661 (org-last-state (or this ""))
11662 (completion-ignore-case t)
11663 (member (member this org-todo-keywords-1))
11664 (tail (cdr member))
11665 (org-state (cond
11666 ((and org-todo-key-trigger
11667 (or (and (equal arg '(4))
11668 (eq org-use-fast-todo-selection 'prefix))
11669 (and (not arg) org-use-fast-todo-selection
11670 (not (eq org-use-fast-todo-selection
11671 'prefix)))))
11672 ;; Use fast selection
11673 (org-fast-todo-selection))
11674 ((and (equal arg '(4))
11675 (or (not org-use-fast-todo-selection)
11676 (not org-todo-key-trigger)))
11677 ;; Read a state with completion
11678 (org-icompleting-read
11679 "State: " (mapcar (lambda(x) (list x))
11680 org-todo-keywords-1)
11681 nil t))
11682 ((eq arg 'right)
11683 (if this
11684 (if tail (car tail) nil)
11685 (car org-todo-keywords-1)))
11686 ((eq arg 'left)
11687 (if (equal member org-todo-keywords-1)
11688 nil
11689 (if this
11690 (nth (- (length org-todo-keywords-1)
11691 (length tail) 2)
11692 org-todo-keywords-1)
11693 (org-last org-todo-keywords-1))))
11694 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11695 (setq arg nil))) ; hack to fall back to cycling
11696 (arg
11697 ;; user or caller requests a specific state
11698 (cond
11699 ((equal arg "") nil)
11700 ((eq arg 'none) nil)
11701 ((eq arg 'done) (or done-word (car org-done-keywords)))
11702 ((eq arg 'nextset)
11703 (or (car (cdr (member head org-todo-heads)))
11704 (car org-todo-heads)))
11705 ((eq arg 'previousset)
11706 (let ((org-todo-heads (reverse org-todo-heads)))
11707 (or (car (cdr (member head org-todo-heads)))
11708 (car org-todo-heads))))
11709 ((car (member arg org-todo-keywords-1)))
11710 ((stringp arg)
11711 (error "State `%s' not valid in this file" arg))
11712 ((nth (1- (prefix-numeric-value arg))
11713 org-todo-keywords-1))))
11714 ((null member) (or head (car org-todo-keywords-1)))
11715 ((equal this final-done-word) nil) ;; -> make empty
11716 ((null tail) nil) ;; -> first entry
11717 ((memq interpret '(type priority))
11718 (if (eq this-command last-command)
11719 (car tail)
11720 (if (> (length tail) 0)
11721 (or done-word (car org-done-keywords))
11722 nil)))
11723 (t
11724 (car tail))))
11725 (org-state (or
11726 (run-hook-with-args-until-success
11727 'org-todo-get-default-hook org-state org-last-state)
11728 org-state))
11729 (next (if org-state (concat " " org-state " ") " "))
11730 (change-plist (list :type 'todo-state-change :from this :to org-state
11731 :position startpos))
11732 dolog now-done-p)
11733 (when org-blocker-hook
11734 (setq org-last-todo-state-is-todo
11735 (not (member this org-done-keywords)))
11736 (unless (save-excursion
11737 (save-match-data
11738 (org-with-wide-buffer
11739 (run-hook-with-args-until-failure
11740 'org-blocker-hook change-plist))))
11741 (if (org-called-interactively-p 'interactive)
11743 this org-state org-block-entry-blocking)
11744 ;; fail silently
11746 this org-state org-block-entry-blocking)
11747 (throw 'exit nil))))
11748 (store-match-data match-data)
11749 (replace-match next t t)
11750 (unless (pos-visible-in-window-p hl-pos)
11751 (message "TODO state changed to %s" (org-trim next)))
11752 (unless head
11753 (setq head (org-get-todo-sequence-head org-state)
11754 ass (assoc head org-todo-kwd-alist)
11755 interpret (nth 1 ass)
11756 done-word (nth 3 ass)
11757 final-done-word (nth 4 ass)))
11758 (when (memq arg '(nextset previousset))
11759 (message "Keyword-Set %d/%d: %s"
11760 (- (length org-todo-sets) -1
11761 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11762 (length org-todo-sets)
11763 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11764 (setq org-last-todo-state-is-todo
11765 (not (member org-state org-done-keywords)))
11766 (setq now-done-p (and (member org-state org-done-keywords)
11767 (not (member this org-done-keywords))))
11768 (and logging (org-local-logging logging))
11769 (when (and (or org-todo-log-states org-log-done)
11770 (not (eq org-inhibit-logging t))
11771 (not (memq arg '(nextset previousset))))
11772 ;; we need to look at recording a time and note
11773 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11774 (nth 2 (assoc this org-todo-log-states))))
11775 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11776 (setq dolog 'time))
11777 (when (and org-state
11778 (member org-state org-not-done-keywords)
11779 (not (member this org-not-done-keywords)))
11780 ;; This is now a todo state and was not one before
11781 ;; If there was a CLOSED time stamp, get rid of it.
11782 (org-add-planning-info nil nil 'closed))
11783 (when (and now-done-p org-log-done)
11784 ;; It is now done, and it was not done before
11785 (org-add-planning-info 'closed (org-current-effective-time))
11786 (if (and (not dolog) (eq 'note org-log-done))
11787 (org-add-log-setup 'done org-state this 'findpos 'note)))
11788 (when (and org-state dolog)
11789 ;; This is a non-nil state, and we need to log it
11790 (org-add-log-setup 'state org-state this 'findpos dolog)))
11791 ;; Fixup tag positioning
11792 (org-todo-trigger-tag-changes org-state)
11793 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11794 (when org-provide-todo-statistics
11795 (org-update-parent-todo-statistics))
11796 (run-hooks 'org-after-todo-state-change-hook)
11797 (if (and arg (not (member org-state org-done-keywords)))
11798 (setq head (org-get-todo-sequence-head org-state)))
11799 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11800 ;; Do we need to trigger a repeat?
11801 (when now-done-p
11802 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11803 ;; This is for the agenda, take a snapshot of the headline.
11804 (save-match-data
11805 (setq org-agenda-headline-snapshot-before-repeat
11806 (org-get-heading))))
11807 (org-auto-repeat-maybe org-state))
11808 ;; Fixup cursor location if close to the keyword
11809 (if (and (outline-on-heading-p)
11810 (not (bolp))
11811 (save-excursion (beginning-of-line 1)
11812 (looking-at org-todo-line-regexp))
11813 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11814 (progn
11815 (goto-char (or (match-end 2) (match-end 1)))
11816 (and (looking-at " ") (just-one-space))))
11817 (when org-trigger-hook
11818 (save-excursion
11819 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11821 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11822 "Block turning an entry into a TODO, using the hierarchy.
11823 This checks whether the current task should be blocked from state
11824 changes. Such blocking occurs when:
11826 1. The task has children which are not all in a completed state.
11828 2. A task has a parent with the property :ORDERED:, and there
11829 are siblings prior to the current task with incomplete
11830 status.
11832 3. The parent of the task is blocked because it has siblings that should
11833 be done first, or is child of a block grandparent TODO entry."
11835 (if (not org-enforce-todo-dependencies)
11836 t ; if locally turned off don't block
11837 (catch 'dont-block
11838 ;; If this is not a todo state change, or if this entry is already DONE,
11839 ;; do not block
11840 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11841 (member (plist-get change-plist :from)
11842 (cons 'done org-done-keywords))
11843 (member (plist-get change-plist :to)
11844 (cons 'todo org-not-done-keywords))
11845 (not (plist-get change-plist :to)))
11846 (throw 'dont-block t))
11847 ;; If this task has children, and any are undone, it's blocked
11848 (save-excursion
11849 (org-back-to-heading t)
11850 (let ((this-level (funcall outline-level)))
11851 (outline-next-heading)
11852 (let ((child-level (funcall outline-level)))
11853 (while (and (not (eobp))
11854 (> child-level this-level))
11855 ;; this todo has children, check whether they are all
11856 ;; completed
11857 (if (and (not (org-entry-is-done-p))
11858 (org-entry-is-todo-p))
11859 (progn (setq org-block-entry-blocking (org-get-heading))
11860 (throw 'dont-block nil)))
11861 (outline-next-heading)
11862 (setq child-level (funcall outline-level))))))
11863 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11864 ;; any previous siblings are undone, it's blocked
11865 (save-excursion
11866 (org-back-to-heading t)
11867 (let* ((pos (point))
11868 (parent-pos (and (org-up-heading-safe) (point))))
11869 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11870 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11871 (forward-line 1)
11872 (re-search-forward org-not-done-heading-regexp pos t))
11873 (setq org-block-entry-blocking (match-string 0))
11874 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11875 ;; Search further up the hierarchy, to see if an ancestor is blocked
11876 (while t
11877 (goto-char parent-pos)
11878 (if (not (looking-at org-not-done-heading-regexp))
11879 (throw 'dont-block t)) ; do not block, parent is not a TODO
11880 (setq pos (point))
11881 (setq parent-pos (and (org-up-heading-safe) (point)))
11882 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11883 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11884 (forward-line 1)
11885 (re-search-forward org-not-done-heading-regexp pos t)
11886 (setq org-block-entry-blocking (org-get-heading)))
11887 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11889 (defcustom org-track-ordered-property-with-tag nil
11890 "Should the ORDERED property also be shown as a tag?
11891 The ORDERED property decides if an entry should require subtasks to be
11892 completed in sequence. Since a property is not very visible, setting
11893 this option means that toggling the ORDERED property with the command
11894 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11895 not relevant for the behavior, but it makes things more visible.
11897 Note that toggling the tag with tags commands will not change the property
11898 and therefore not influence behavior!
11900 This can be t, meaning the tag ORDERED should be used, It can also be a
11901 string to select a different tag for this task."
11902 :group 'org-todo
11903 :type '(choice
11904 (const :tag "No tracking" nil)
11905 (const :tag "Track with ORDERED tag" t)
11906 (string :tag "Use other tag")))
11908 (defun org-toggle-ordered-property ()
11909 "Toggle the ORDERED property of the current entry.
11910 For better visibility, you can track the value of this property with a tag.
11911 See variable `org-track-ordered-property-with-tag'."
11912 (interactive)
11913 (let* ((t1 org-track-ordered-property-with-tag)
11914 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11915 (save-excursion
11916 (org-back-to-heading)
11917 (if (org-entry-get nil "ORDERED")
11918 (progn
11919 (org-delete-property "ORDERED")
11920 (and tag (org-toggle-tag tag 'off))
11921 (message "Subtasks can be completed in arbitrary order"))
11922 (org-entry-put nil "ORDERED" "t")
11923 (and tag (org-toggle-tag tag 'on))
11924 (message "Subtasks must be completed in sequence")))))
11926 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11927 (defun org-block-todo-from-checkboxes (change-plist)
11928 "Block turning an entry into a TODO, using checkboxes.
11929 This checks whether the current task should be blocked from state
11930 changes because there are unchecked boxes in this entry."
11931 (if (not org-enforce-todo-checkbox-dependencies)
11932 t ; if locally turned off don't block
11933 (catch 'dont-block
11934 ;; If this is not a todo state change, or if this entry is already DONE,
11935 ;; do not block
11936 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11937 (member (plist-get change-plist :from)
11938 (cons 'done org-done-keywords))
11939 (member (plist-get change-plist :to)
11940 (cons 'todo org-not-done-keywords))
11941 (not (plist-get change-plist :to)))
11942 (throw 'dont-block t))
11943 ;; If this task has checkboxes that are not checked, it's blocked
11944 (save-excursion
11945 (org-back-to-heading t)
11946 (let ((beg (point)) end)
11947 (outline-next-heading)
11948 (setq end (point))
11949 (goto-char beg)
11950 (if (org-list-search-forward
11951 (concat (org-item-beginning-re)
11954 end t)
11955 (progn
11956 (if (boundp 'org-blocked-by-checkboxes)
11957 (setq org-blocked-by-checkboxes t))
11958 (throw 'dont-block nil)))))
11959 t))) ; do not block
11961 (defun org-entry-blocked-p ()
11962 "Is the current entry blocked?"
11963 (if (org-entry-get nil "NOBLOCKING")
11964 nil ;; Never block this entry
11965 (not
11966 (run-hook-with-args-until-failure
11967 'org-blocker-hook
11968 (list :type 'todo-state-change
11969 :position (point)
11970 :from 'todo
11971 :to 'done)))))
11973 (defun org-update-statistics-cookies (all)
11974 "Update the statistics cookie, either from TODO or from checkboxes.
11975 This should be called with the cursor in a line with a statistics cookie."
11976 (interactive "P")
11977 (if all
11978 (progn
11979 (org-update-checkbox-count 'all)
11980 (org-map-entries 'org-update-parent-todo-statistics))
11981 (if (not (org-at-heading-p))
11982 (org-update-checkbox-count)
11983 (let ((pos (point-marker))
11984 end l1 l2)
11985 (ignore-errors (org-back-to-heading t))
11986 (if (not (org-at-heading-p))
11987 (org-update-checkbox-count)
11988 (setq l1 (org-outline-level))
11989 (setq end (save-excursion
11990 (outline-next-heading)
11991 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11992 (point)))
11993 (if (and (save-excursion
11994 (re-search-forward
11996 (not (save-excursion (re-search-forward
11998 (org-update-checkbox-count)
11999 (if (and l2 (> l2 l1))
12000 (progn
12001 (goto-char end)
12002 (org-update-parent-todo-statistics))
12003 (goto-char pos)
12004 (beginning-of-line 1)
12005 (while (re-search-forward
12007 (point-at-eol) t)
12008 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12009 (goto-char pos)
12010 (move-marker pos nil)))))
12012 (defvar org-entry-property-inherited-from) ;; defined below
12013 (defun org-update-parent-todo-statistics ()
12014 "Update any statistics cookie in the parent of the current headline.
12015 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12016 the entire subtree and this will travel up the hierarchy and update
12017 statistics everywhere."
12018 (let* ((prop (save-excursion (org-up-heading-safe)
12019 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12020 (recursive (or (not org-hierarchical-todo-statistics)
12022 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12023 0))
12024 (first t)
12026 level ltoggle l1 new ndel
12027 (cnt-all 0) (cnt-done 0) is-percent kwd
12028 checkbox-beg ov ovs ove cookie-present)
12029 (catch 'exit
12030 (save-excursion
12031 (beginning-of-line 1)
12032 (setq ltoggle (funcall outline-level))
12033 ;; Three situations are to consider:
12035 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12036 ;; to the top-level ancestor on the headline;
12038 ;; 2. If parent has "recursive" property, repeat up to the
12039 ;; headline setting that property, taking inheritance into
12040 ;; account;
12042 ;; 3. Else, move up to direct parent and proceed only once.
12043 (while (and (setq level (org-up-heading-safe))
12044 (or recursive first)
12045 (>= (point) lim))
12046 (setq first nil cookie-present nil)
12047 (unless (and level
12048 (not (string-match
12050 (downcase (or (org-entry-get nil "COOKIE_DATA")
12051 "")))))
12052 (throw 'exit nil))
12053 (while (re-search-forward box-re (point-at-eol) t)
12054 (setq cnt-all 0 cnt-done 0 cookie-present t)
12055 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12056 (save-match-data
12057 (unless (outline-next-heading) (throw 'exit nil))
12058 (while (and (looking-at org-complex-heading-regexp)
12059 (> (setq l1 (length (match-string 1))) level))
12060 (setq kwd (and (or recursive (= l1 ltoggle))
12061 (match-string 2)))
12062 (if (or (eq org-provide-todo-statistics 'all-headlines)
12063 (and (listp org-provide-todo-statistics)
12064 (or (member kwd org-provide-todo-statistics)
12065 (member kwd org-done-keywords))))
12066 (setq cnt-all (1+ cnt-all))
12067 (if (eq org-provide-todo-statistics t)
12068 (and kwd (setq cnt-all (1+ cnt-all)))))
12069 (and (member kwd org-done-keywords)
12070 (setq cnt-done (1+ cnt-done)))
12071 (outline-next-heading)))
12072 (setq new
12073 (if is-percent
12074 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12075 (format "[%d/%d]" cnt-done cnt-all))
12076 ndel (- (match-end 0) checkbox-beg))
12077 ;; handle overlays when updating cookie from column view
12078 (when (setq ov (car (overlays-at checkbox-beg)))
12079 (setq ovs (overlay-start ov) ove (overlay-end ov))
12080 (delete-overlay ov))
12081 (goto-char checkbox-beg)
12082 (insert new)
12083 (delete-region (point) (+ (point) ndel))
12084 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12085 (when ov (move-overlay ov ovs ove)))
12086 (when cookie-present
12087 (run-hook-with-args 'org-after-todo-statistics-hook
12088 cnt-done (- cnt-all cnt-done))))))
12089 (run-hooks 'org-todo-statistics-hook)))
12091 (defvar org-after-todo-statistics-hook nil
12092 "Hook that is called after a TODO statistics cookie has been updated.
12093 Each function is called with two arguments: the number of not-done entries
12094 and the number of done entries.
12096 For example, the following function, when added to this hook, will switch
12097 an entry to DONE when all children are done, and back to TODO when new
12098 entries are set to a TODO status. Note that this hook is only called
12099 when there is a statistics cookie in the headline!
12101 (defun org-summary-todo (n-done n-not-done)
12103 (let (org-log-done org-log-states) ; turn off logging
12105 ")
12107 (defvar org-todo-statistics-hook nil
12108 "Hook that is run whenever Org thinks TODO statistics should be updated.
12109 This hook runs even if there is no statistics cookie present, in which case
12110 `org-after-todo-statistics-hook' would not run.")
12112 (defun org-todo-trigger-tag-changes (state)
12113 "Apply the changes defined in `org-todo-state-tags-triggers'."
12114 (let ((l org-todo-state-tags-triggers)
12115 changes)
12116 (when (or (not state) (equal state ""))
12117 (setq changes (append changes (cdr (assoc "" l)))))
12118 (when (and (stringp state) (> (length state) 0))
12119 (setq changes (append changes (cdr (assoc state l)))))
12120 (when (member state org-not-done-keywords)
12121 (setq changes (append changes (cdr (assoc 'todo l)))))
12122 (when (member state org-done-keywords)
12123 (setq changes (append changes (cdr (assoc 'done l)))))
12124 (dolist (c changes)
12125 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12127 (defun org-local-logging (value)
12128 "Get logging settings from a property VALUE."
12129 (let* (words w a)
12130 ;; directly set the variables, they are already local.
12131 (setq org-log-done nil
12132 org-log-repeat nil
12133 org-todo-log-states nil)
12134 (setq words (org-split-string value))
12135 (while (setq w (pop words))
12136 (cond
12137 ((setq a (assoc w org-startup-options))
12138 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12139 (set (nth 1 a) (nth 2 a))))
12140 ((setq a (org-extract-log-state-settings w))
12141 (and (member (car a) org-todo-keywords-1)
12142 (push a org-todo-log-states)))))))
12144 (defun org-get-todo-sequence-head (kwd)
12145 "Return the head of the TODO sequence to which KWD belongs.
12146 If KWD is not set, check if there is a text property remembering the
12147 right sequence."
12148 (let (p)
12149 (cond
12150 ((not kwd)
12151 (or (get-text-property (point-at-bol) 'org-todo-head)
12152 (progn
12153 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12154 nil (point-at-eol)))
12155 (get-text-property p 'org-todo-head))))
12156 ((not (member kwd org-todo-keywords-1))
12157 (car org-todo-keywords-1))
12158 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12160 (defun org-fast-todo-selection ()
12161 "Fast TODO keyword selection with single keys.
12162 Returns the new TODO keyword, or nil if no state change should occur."
12163 (let* ((fulltable org-todo-key-alist)
12164 (done-keywords org-done-keywords) ;; needed for the faces.
12165 (maxlen (apply 'max (mapcar
12166 (lambda (x)
12167 (if (stringp (car x)) (string-width (car x)) 0))
12168 fulltable)))
12169 (expert nil)
12170 (fwidth (+ maxlen 3 1 3))
12171 (ncol (/ (- (window-width) 4) fwidth))
12172 tg cnt e c tbl
12173 groups ingroup)
12174 (save-excursion
12175 (save-window-excursion
12176 (if expert
12177 (set-buffer (get-buffer-create " *Org todo*"))
12178 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12179 (erase-buffer)
12180 (org-set-local 'org-done-keywords done-keywords)
12181 (setq tbl fulltable cnt 0)
12182 (while (setq e (pop tbl))
12183 (cond
12184 ((equal e '(:startgroup))
12185 (push '() groups) (setq ingroup t)
12186 (when (not (= cnt 0))
12187 (setq cnt 0)
12189 (insert "{ "))
12190 ((equal e '(:endgroup))
12191 (setq ingroup nil cnt 0)
12193 ((equal e '(:newline))
12194 (when (not (= cnt 0))
12195 (setq cnt 0)
12197 (setq e (car tbl))
12198 (while (equal (car tbl) '(:newline))
12200 (setq tbl (cdr tbl)))))
12201 (t
12202 (setq tg (car e) c (cdr e))
12203 (if ingroup (push tg (car groups)))
12204 (setq tg (org-add-props tg nil 'face
12205 (org-get-todo-face tg)))
12206 (if (and (= cnt 0) (not ingroup)) (insert " "))
12207 (insert "[" c "] " tg (make-string
12208 (- fwidth 4 (length tg)) ?\ ))
12209 (when (= (setq cnt (1+ cnt)) ncol)
12211 (if ingroup (insert " "))
12212 (setq cnt 0)))))
12214 (goto-char (point-min))
12215 (if (not expert) (org-fit-window-to-buffer))
12216 (message "[a-z..]:Set [SPC]:clear")
12217 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12218 (cond
12219 ((or (= c ?\C-g)
12220 (and (= c ?q) (not (rassoc c fulltable))))
12221 (setq quit-flag t))
12222 ((= c ?\ ) nil)
12223 ((setq e (rassoc c fulltable) tg (car e))
12224 tg)
12225 (t (setq quit-flag t)))))))
12227 (defun org-entry-is-todo-p ()
12228 (member (org-get-todo-state) org-not-done-keywords))
12230 (defun org-entry-is-done-p ()
12231 (member (org-get-todo-state) org-done-keywords))
12233 (defun org-get-todo-state ()
12234 (save-excursion
12235 (org-back-to-heading t)
12236 (and (looking-at org-todo-line-regexp)
12237 (match-end 2)
12238 (match-string 2))))
12240 (defun org-at-date-range-p (&optional inactive-ok)
12241 "Is the cursor inside a date range?"
12242 (interactive)
12243 (save-excursion
12244 (catch 'exit
12245 (let ((pos (point)))
12247 (skip-chars-backward "<[")
12248 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12249 (>= (match-end 0) pos)
12250 (throw 'exit t))
12252 (skip-chars-backward "<[")
12253 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12254 (>= (match-end 0) pos)
12255 (throw 'exit t)))
12256 nil)))
12258 (defun org-get-repeat (&optional tagline)
12259 "Check if there is a deadline/schedule with repeater in this entry."
12260 (save-match-data
12261 (save-excursion
12262 (org-back-to-heading t)
12263 (and (re-search-forward (if tagline
12265 org-repeat-re)
12266 (org-entry-end-position) t)
12267 (match-string-no-properties 1)))))
12269 (defvar org-last-changed-timestamp)
12270 (defvar org-last-inserted-timestamp)
12271 (defvar org-log-post-message)
12272 (defvar org-log-note-purpose)
12273 (defvar org-log-note-how)
12274 (defvar org-log-note-extra)
12275 (defun org-auto-repeat-maybe (done-word)
12276 "Check if the current headline contains a repeated deadline/schedule.
12277 If yes, set TODO state back to what it was and change the base date
12278 of repeating deadline/scheduled time stamps to new date.
12279 This function is run automatically after each state change to a DONE state."
12280 ;; last-state is dynamically scoped into this function
12281 (let* ((repeat (org-get-repeat))
12282 (aa (assoc org-last-state org-todo-kwd-alist))
12283 (interpret (nth 1 aa))
12284 (head (nth 2 aa))
12285 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12286 (msg "Entry repeats: ")
12287 (org-log-done nil)
12288 (org-todo-log-states nil)
12289 re type n what ts time to-state)
12290 (when repeat
12291 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12292 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12293 org-todo-repeat-to-state))
12294 (unless (and to-state (member to-state org-todo-keywords-1))
12295 (setq to-state (if (eq interpret 'type) org-last-state head)))
12296 (org-todo to-state)
12297 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12298 (org-entry-put nil "LAST_REPEAT" (format-time-string
12299 (org-time-stamp-format t t))))
12300 (when org-log-repeat
12301 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12302 (memq 'org-add-log-note post-command-hook))
12303 ;; OK, we are already setup for some record
12304 (if (eq org-log-repeat 'note)
12305 ;; make sure we take a note, not only a time stamp
12306 (setq org-log-note-how 'note))
12307 ;; Set up for taking a record
12308 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12309 org-last-state
12310 'findpos org-log-repeat)))
12311 (org-back-to-heading t)
12312 (org-add-planning-info nil nil 'closed)
12316 (while (re-search-forward
12317 re (save-excursion (outline-next-heading) (point)) t)
12318 (setq type (if (match-end 1) org-scheduled-string
12319 (if (match-end 3) org-deadline-string "Plain:"))
12320 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12322 (setq n (string-to-number (match-string 2 ts))
12323 what (match-string 3 ts))
12324 (if (equal what "w") (setq n (* n 7) what "d"))
12326 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12327 ;; Preparation, see if we need to modify the start date for the change
12328 (when (match-end 1)
12329 (setq time (save-match-data (org-time-string-to-time ts)))
12330 (cond
12331 ((equal (match-string 1 ts) ".")
12332 ;; Shift starting date to today
12333 (org-timestamp-change
12334 (- (org-today) (time-to-days time))
12335 'day))
12336 ((equal (match-string 1 ts) "+")
12337 (let ((nshiftmax 10) (nshift 0))
12338 (while (or (= nshift 0)
12339 (<= (time-to-days time)
12340 (time-to-days (current-time))))
12341 (when (= (incf nshift) nshiftmax)
12342 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12343 (error "Abort")))
12344 (org-timestamp-change n (cdr (assoc what whata)))
12345 (org-at-timestamp-p t)
12346 (setq ts (match-string 1))
12347 (setq time (save-match-data (org-time-string-to-time ts)))))
12348 (org-timestamp-change (- n) (cdr (assoc what whata)))
12349 ;; rematch, so that we have everything in place for the real shift
12350 (org-at-timestamp-p t)
12351 (setq ts (match-string 1))
12353 (org-timestamp-change n (cdr (assoc what whata)))
12354 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12355 (setq org-log-post-message msg)
12356 (message "%s" msg))))
12358 (defun org-show-todo-tree (arg)
12359 "Make a compact tree which shows all headlines marked with TODO.
12360 The tree will show the lines where the regexp matches, and all higher
12361 headlines above the match.
12363 With a numeric prefix N, construct a sparse tree for the Nth element
12364 of `org-todo-keywords-1'."
12365 (interactive "P")
12366 (let ((case-fold-search nil)
12367 (kwd-re
12368 (cond ((null arg) org-not-done-regexp)
12369 ((equal arg '(4))
12370 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12371 (mapcar 'list org-todo-keywords-1))))
12375 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12376 (regexp-quote (nth (1- (prefix-numeric-value arg))
12377 org-todo-keywords-1)))
12378 (t (error "Invalid prefix argument: %s" arg)))))
12379 (message "%d TODO entries found"
12380 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12382 (defun org-deadline (&optional remove time)
12384 With argument REMOVE, remove any deadline from the item.
12385 With argument TIME, set the deadline at the corresponding date. TIME
12387 (interactive "P")
12388 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12389 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12390 'region-start-level 'region))
12391 org-loop-over-headlines-in-active-region)
12392 (org-map-entries
12393 `(org-deadline ',remove ,time)
12394 org-loop-over-headlines-in-active-region
12395 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12396 (let* ((old-date (org-entry-get nil "DEADLINE"))
12397 (repeater (and old-date
12398 (string-match
12400 old-date)
12401 (match-string 1 old-date))))
12402 (if remove
12403 (progn
12404 (when (and old-date org-log-redeadline)
12405 (org-add-log-setup 'deldeadline nil old-date 'findpos
12406 org-log-redeadline))
12407 (org-remove-timestamp-with-keyword org-deadline-string)
12408 (message "Item no longer has a deadline."))
12409 (org-add-planning-info 'deadline time 'closed)
12410 (when (and old-date org-log-redeadline
12411 (not (equal old-date
12412 (substring org-last-inserted-timestamp 1 -1))))
12413 (org-add-log-setup 'redeadline nil old-date 'findpos
12414 org-log-redeadline))
12415 (when repeater
12416 (save-excursion
12417 (org-back-to-heading t)
12418 (when (re-search-forward (concat org-deadline-string " "
12419 org-last-inserted-timestamp)
12420 (save-excursion
12421 (outline-next-heading) (point)) t)
12422 (goto-char (1- (match-end 0)))
12423 (insert " " repeater)
12424 (setq org-last-inserted-timestamp
12425 (concat (substring org-last-inserted-timestamp 0 -1)
12426 " " repeater
12427 (substring org-last-inserted-timestamp -1))))))
12428 (message "Deadline on %s" org-last-inserted-timestamp)))))
12430 (defun org-schedule (&optional remove time)
12431 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12432 With argument REMOVE, remove any scheduling date from the item.
12433 With argument TIME, scheduled at the corresponding date. TIME can
12435 (interactive "P")
12436 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12437 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12438 'region-start-level 'region))
12439 org-loop-over-headlines-in-active-region)
12440 (org-map-entries
12441 `(org-schedule ',remove ,time)
12442 org-loop-over-headlines-in-active-region
12443 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12444 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12445 (repeater (and old-date
12446 (string-match
12448 old-date)
12449 (match-string 1 old-date))))
12450 (if remove
12451 (progn
12452 (when (and old-date org-log-reschedule)
12453 (org-add-log-setup 'delschedule nil old-date 'findpos
12454 org-log-reschedule))
12455 (org-remove-timestamp-with-keyword org-scheduled-string)
12456 (message "Item is no longer scheduled."))
12457 (org-add-planning-info 'scheduled time 'closed)
12458 (when (and old-date org-log-reschedule
12459 (not (equal old-date
12460 (substring org-last-inserted-timestamp 1 -1))))
12461 (org-add-log-setup 'reschedule nil old-date 'findpos
12462 org-log-reschedule))
12463 (when repeater
12464 (save-excursion
12465 (org-back-to-heading t)
12466 (when (re-search-forward (concat org-scheduled-string " "
12467 org-last-inserted-timestamp)
12468 (save-excursion
12469 (outline-next-heading) (point)) t)
12470 (goto-char (1- (match-end 0)))
12471 (insert " " repeater)
12472 (setq org-last-inserted-timestamp
12473 (concat (substring org-last-inserted-timestamp 0 -1)
12474 " " repeater
12475 (substring org-last-inserted-timestamp -1))))))
12476 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12478 (defun org-get-scheduled-time (pom &optional inherit)
12479 "Get the scheduled time as a time tuple, of a format suitable
12480 for calling org-schedule with, or if there is no scheduling,
12481 returns nil."
12482 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12483 (when time
12484 (apply 'encode-time (org-parse-time-string time)))))
12486 (defun org-get-deadline-time (pom &optional inherit)
12487 "Get the deadline as a time tuple, of a format suitable for
12488 calling org-deadline with, or if there is no scheduling, returns
12489 nil."
12490 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12491 (when time
12492 (apply 'encode-time (org-parse-time-string time)))))
12494 (defun org-remove-timestamp-with-keyword (keyword)
12495 "Remove all time stamps with KEYWORD in the current entry."
12497 beg)
12498 (save-excursion
12499 (org-back-to-heading t)
12500 (setq beg (point))
12501 (outline-next-heading)
12502 (while (re-search-backward re beg t)
12503 (replace-match "")
12505 (equal (char-before) ?\ ))
12506 (backward-delete-char 1)
12508 (point-at-bol) (point-at-eol)))
12509 (delete-region (point-at-bol)
12510 (min (point-max) (1+ (point-at-eol))))))))))
12512 (defun org-add-planning-info (what &optional time &rest remove)
12513 "Insert new timestamp with keyword in the line directly after the headline.
12514 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12515 If non is given, the user is prompted for a date.
12516 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12517 be removed."
12518 (interactive)
12519 (let (org-time-was-given org-end-time-was-given ts
12520 end default-time default-input)
12522 (catch 'exit
12523 (when (and (memq what '(scheduled deadline))
12524 (or (not time)
12525 (and (stringp time)
12526 (string-match "^[-+]+[0-9]" time))))
12527 ;; Try to get a default date/time from existing timestamp
12528 (save-excursion
12529 (org-back-to-heading t)
12530 (setq end (save-excursion (outline-next-heading) (point)))
12531 (when (re-search-forward (if (eq what 'scheduled)
12532 org-scheduled-time-regexp
12533 org-deadline-time-regexp)
12534 end t)
12535 (setq ts (match-string 1)
12536 default-time
12537 (apply 'encode-time (org-parse-time-string ts))
12538 default-input (and ts (org-get-compact-tod ts))))))
12539 (when what
12540 (setq time
12541 (if (stringp time)
12542 ;; This is a string (relative or absolute), set proper date
12543 (apply 'encode-time
12544 (org-read-date-analyze
12545 time default-time (decode-time default-time)))
12546 ;; If necessary, get the time from the user
12547 (or time (org-read-date nil 'to-time nil nil
12548 default-time default-input)))))
12550 (when (and org-insert-labeled-timestamps-at-point
12551 (member what '(scheduled deadline)))
12552 (insert
12553 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12554 (org-insert-time-stamp time org-time-was-given
12555 nil nil nil (list org-end-time-was-given))
12556 (setq what nil))
12557 (save-excursion
12558 (save-restriction
12559 (let (col list elt ts buffer-invisibility-spec)
12560 (org-back-to-heading t)
12562 (goto-char (match-end 1))
12563 (setq col (current-column))
12564 (goto-char (match-end 0))
12566 (when (and (not what)
12567 (not (looking-at
12569 org-keyword-time-not-clock-regexp))))
12570 ;; Nothing to add, nothing to remove...... :-)
12571 (throw 'exit nil))
12572 (if (and (not (looking-at org-outline-regexp))
12575 (not (equal (match-string 1) org-clock-string)))
12576 (narrow-to-region (match-beginning 0) (match-end 0))
12578 (backward-char 1)
12579 (narrow-to-region (point) (point))
12580 (and org-adapt-indentation (org-indent-to-column col)))
12581 ;; Check if we have to remove something.
12582 (setq list (cons what remove))
12583 (while list
12584 (setq elt (pop list))
12585 (when (or (and (eq elt 'scheduled)
12586 (re-search-forward org-scheduled-time-regexp nil t))
12587 (and (eq elt 'deadline)
12588 (re-search-forward org-deadline-time-regexp nil t))
12589 (and (eq elt 'closed)
12590 (re-search-forward org-closed-time-regexp nil t)))
12591 (replace-match "")
12592 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12594 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12595 (when what
12596 (insert
12597 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12598 (cond ((eq what 'scheduled) org-scheduled-string)
12599 ((eq what 'deadline) org-deadline-string)
12600 ((eq what 'closed) org-closed-string))
12601 " ")
12602 (setq ts (org-insert-time-stamp
12603 time
12604 (or org-time-was-given
12605 (and (eq what 'closed) org-log-done-with-time))
12606 (eq what 'closed)
12607 nil nil (list org-end-time-was-given)))
12608 (insert
12609 (if (not (or (bolp) (eq (char-before) ?\ )
12610 (memq (char-after) '(32 10))
12611 (eobp))) " " ""))
12612 (end-of-line 1))
12613 (goto-char (point-min))
12614 (widen)
12617 (delete-region (1- (point)) (point-at-eol)))
12618 ts))))))
12620 (defvar org-log-note-marker (make-marker))
12621 (defvar org-log-note-purpose nil)
12622 (defvar org-log-note-state nil)
12623 (defvar org-log-note-previous-state nil)
12624 (defvar org-log-note-how nil)
12625 (defvar org-log-note-extra nil)
12626 (defvar org-log-note-window-configuration nil)
12627 (defvar org-log-note-return-to (make-marker))
12628 (defvar org-log-note-effective-time nil
12629 "Remembered current time so that dynamically scoped
12630 `org-extend-today-until' affects tha timestamps in state change
12631 log")
12633 (defvar org-log-post-message nil
12634 "Message to be displayed after a log note has been stored.
12635 The auto-repeater uses this.")
12637 (defun org-add-note ()
12638 "Add a note to the current entry.
12639 This is done in the same way as adding a state change note."
12640 (interactive)
12641 (org-add-log-setup 'note nil nil 'findpos nil))
12643 (defvar org-property-end-re)
12644 (defun org-add-log-setup (&optional purpose state prev-state
12645 findpos how extra)
12646 "Set up the post command hook to take a note.
12647 If this is about to TODO state change, the new state is expected in STATE.
12648 When FINDPOS is non-nil, find the correct position for the note in
12649 the current entry. If not, assume that it can be inserted at point.
12650 HOW is an indicator what kind of note should be created.
12651 EXTRA is additional text that will be inserted into the notes buffer."
12652 (let* ((org-log-into-drawer (org-log-into-drawer))
12653 (drawer (cond ((stringp org-log-into-drawer)
12654 org-log-into-drawer)
12655 (org-log-into-drawer "LOGBOOK"))))
12656 (save-restriction
12657 (save-excursion
12658 (when findpos
12659 (org-back-to-heading t)
12660 (narrow-to-region (point) (save-excursion
12661 (outline-next-heading) (point)))
12665 (goto-char (match-end 0))
12666 (cond
12667 (drawer
12669 nil t)
12670 (progn
12671 (goto-char (match-end 0))
12672 (or org-log-states-order-reversed
12673 (and (re-search-forward org-property-end-re nil t)
12674 (goto-char (1- (match-beginning 0))))))
12676 (beginning-of-line 0)
12677 (org-indent-line)
12678 (beginning-of-line 2)
12679 (org-indent-line)
12680 (end-of-line 0)))
12681 ((and org-log-state-notes-insert-after-drawers
12682 (save-excursion
12683 (forward-line) (looking-at org-drawer-regexp)))
12684 (forward-line)
12685 (while (looking-at org-drawer-regexp)
12686 (goto-char (match-end 0))
12687 (re-search-forward org-property-end-re (point-max) t)
12688 (forward-line))
12689 (forward-line -1)))
12690 (unless org-log-states-order-reversed
12692 (org-skip-over-state-notes)
12694 (move-marker org-log-note-marker (point))
12695 (setq org-log-note-purpose purpose
12696 org-log-note-state state
12697 org-log-note-previous-state prev-state
12698 org-log-note-how how
12699 org-log-note-extra extra
12700 org-log-note-effective-time (org-current-effective-time))
12701 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12703 (defun org-skip-over-state-notes ()
12704 "Skip past the list of State notes in an entry."
12706 (when (ignore-errors (goto-char (org-in-item-p)))
12707 (let* ((struct (org-list-struct))
12708 (prevs (org-list-prevs-alist struct)))
12710 (goto-char (or (org-list-get-next-item (point) struct prevs)
12711 (org-list-get-item-end (point) struct)))))))
12713 (defun org-add-log-note (&optional purpose)
12714 "Pop up a window for taking a note, and add this note later at point."
12715 (remove-hook 'post-command-hook 'org-add-log-note)
12716 (setq org-log-note-window-configuration (current-window-configuration))
12717 (delete-other-windows)
12718 (move-marker org-log-note-return-to (point))
12719 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12720 (goto-char org-log-note-marker)
12721 (org-switch-to-buffer-other-window "*Org Note*")
12722 (erase-buffer)
12723 (if (memq org-log-note-how '(time state))
12724 (let (current-prefix-arg) (org-store-log-note))
12725 (let ((org-inhibit-startup t)) (org-mode))
12726 (insert (format "# Insert note for %s.
12728 (cond
12729 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12730 ((eq org-log-note-purpose 'done) "closed todo item")
12731 ((eq org-log-note-purpose 'state)
12733 (or org-log-note-previous-state "")
12734 (or org-log-note-state "")))
12735 ((eq org-log-note-purpose 'reschedule)
12736 "rescheduling")
12737 ((eq org-log-note-purpose 'delschedule)
12738 "no longer scheduled")
12739 ((eq org-log-note-purpose 'redeadline)
12740 "changing deadline")
12741 ((eq org-log-note-purpose 'deldeadline)
12742 "removing deadline")
12743 ((eq org-log-note-purpose 'refile)
12744 "refiling")
12745 ((eq org-log-note-purpose 'note)
12746 "this entry")
12747 (t (error "This should not happen")))))
12748 (if org-log-note-extra (insert org-log-note-extra))
12749 (org-set-local 'org-finish-function 'org-store-log-note)
12750 (run-hooks 'org-log-buffer-setup-hook)))
12752 (defvar org-note-abort nil) ; dynamically scoped
12753 (defun org-store-log-note ()
12754 "Finish taking a log note, and insert it to where it belongs."
12755 (let ((txt (buffer-string)))
12756 (kill-buffer (current-buffer))
12757 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
12758 lines ind bul)
12760 (setq txt (replace-match "" t t txt)))
12762 (setq txt (replace-match "" t t txt)))
12765 (setq note
12766 (org-replace-escapes
12767 note
12768 (list (cons "%u" (user-login-name))
12769 (cons "%U" user-full-name)
12770 (cons "%t" (format-time-string
12771 (org-time-stamp-format 'long 'inactive)
12772 org-log-note-effective-time))
12773 (cons "%T" (format-time-string
12774 (org-time-stamp-format 'long nil)
12775 org-log-note-effective-time))
12776 (cons "%d" (format-time-string
12777 (org-time-stamp-format nil 'inactive)
12778 org-log-note-effective-time))
12779 (cons "%D" (format-time-string
12780 (org-time-stamp-format nil nil)
12781 org-log-note-effective-time))
12782 (cons "%s" (if org-log-note-state
12784 ""))
12785 (cons "%S" (if org-log-note-previous-state
12789 (push note lines))
12790 (when (or current-prefix-arg org-note-abort)
12791 (when org-log-into-drawer
12792 (org-remove-empty-drawer-at
12793 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12794 org-log-note-marker))
12795 (setq lines nil))
12796 (when lines
12797 (with-current-buffer (marker-buffer org-log-note-marker)
12798 (save-excursion
12799 (goto-char org-log-note-marker)
12800 (move-marker org-log-note-marker nil)
12801 (end-of-line 1)
12803 (setq ind (save-excursion
12804 (if (ignore-errors (goto-char (org-in-item-p)))
12805 (let ((struct (org-list-struct)))
12806 (org-list-get-ind
12807 (org-list-get-top-point struct) struct))
12809 (cond
12810 ((and (org-at-heading-p)
12811 org-adapt-indentation)
12812 (1+ (org-current-level)))
12813 ((org-at-heading-p) 0)
12814 (t (org-get-indentation))))))
12815 (setq bul (org-list-bullet-string "-"))
12816 (org-indent-line-to ind)
12817 (insert bul (pop lines))
12818 (let ((ind-body (+ (length bul) ind)))
12819 (while lines
12821 (org-indent-line-to ind-body)
12822 (insert (pop lines))))
12823 (message "Note stored")
12824 (org-back-to-heading t)
12825 (org-cycle-hide-drawers 'children))))))
12826 (set-window-configuration org-log-note-window-configuration)
12827 (with-current-buffer (marker-buffer org-log-note-return-to)
12828 (goto-char org-log-note-return-to))
12829 (move-marker org-log-note-return-to nil)
12830 (and org-log-post-message (message "%s" org-log-post-message)))
12832 (defun org-remove-empty-drawer-at (drawer pos)
12833 "Remove an empty drawer DRAWER at position POS.
12834 POS may also be a marker."
12835 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12836 (save-excursion
12837 (save-restriction
12838 (widen)
12839 (goto-char pos)
12840 (if (org-in-regexp
12842 (replace-match ""))))))
12844 (defvar org-ts-type nil)
12845 (defun org-sparse-tree (&optional arg type)
12846 "Create a sparse tree, prompt for the details.
12847 This command can create sparse trees. You first need to select the type
12848 of match used to create the tree:
12850 t Show all TODO entries.
12851 T Show entries with a specific TODO keyword.
12852 m Show entries selected by a tags/property match.
12853 p Enter a property name and its value (both with completion on existing
12854 names/values) and show entries with that property.
12855 r Show entries matching a regular expression (`/' can be used as well).
12856 b Show deadlines and scheduled items before a date.
12857 a Show deadlines and scheduled items after a date.
12858 d Show deadlines due within `org-deadline-warning-days'.
12859 D Show deadlines and scheduled items between a date range."
12860 (interactive "P")
12861 (let (ans kwd value ts-type)
12862 (setq type (or type org-sparse-tree-default-date-type))
12863 (setq org-ts-type type)
12864 (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\n [c]ycle through date types: %s"
12865 (cond ((eq type 'all) "all timestamps")
12866 ((eq type 'scheduled) "only scheduled")
12867 ((eq type 'deadline) "only deadline")
12868 ((eq type 'active) "only active timestamps")
12869 ((eq type 'inactive) "only inactive timestamps")
12870 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
12871 (t "scheduled/deadline")))
12872 (setq ans (read-char-exclusive))
12873 (cond
12874 ((equal ans ?c)
12875 (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
12876 ((equal ans ?d)
12877 (call-interactively 'org-check-deadlines))
12878 ((equal ans ?b)
12879 (call-interactively 'org-check-before-date))
12880 ((equal ans ?a)
12881 (call-interactively 'org-check-after-date))
12882 ((equal ans ?D)
12883 (call-interactively 'org-check-dates-range))
12884 ((equal ans ?t)
12885 (call-interactively 'org-show-todo-tree))
12886 ((equal ans ?T)
12887 (org-show-todo-tree '(4)))
12888 ((member ans '(?T ?m))
12889 (call-interactively 'org-match-sparse-tree))
12890 ((member ans '(?p ?P))
12891 (setq kwd (org-icompleting-read "Property: "
12892 (mapcar 'list (org-buffer-property-keys))))
12893 (setq value (org-icompleting-read "Value: "
12894 (mapcar 'list (org-property-values kwd))))
12897 (org-match-sparse-tree arg (concat kwd "=" value)))
12898 ((member ans '(?r ?R ?/))
12899 (call-interactively 'org-occur))
12902 (defvar org-occur-highlights nil
12903 "List of overlays used for occur matches.")
12904 (make-variable-buffer-local 'org-occur-highlights)
12905 (defvar org-occur-parameters nil
12906 "Parameters of the active org-occur calls.
12907 This is a list, each call to org-occur pushes as cons cell,
12908 containing the regular expression and the callback, onto the list.
12909 The list can contain several entries if `org-occur' has been called
12910 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12911 will only contain one set of parameters. When the highlights are
12912 removed (for example with `C-c C-c', or with the next edit (depending
12913 on `org-remove-highlights-with-change'), this variable is emptied
12914 as well.")
12915 (make-variable-buffer-local 'org-occur-parameters)
12917 (defun org-occur (regexp &optional keep-previous callback)
12918 "Make a compact tree which shows all matches of REGEXP.
12919 The tree will show the lines where the regexp matches, and all higher
12920 headlines above the match. It will also show the heading after the match,
12921 to make sure editing the matching entry is easy.
12922 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12923 call to `org-occur' will be kept, to allow stacking of calls to this
12924 command.
12925 If CALLBACK is non-nil, it is a function which is called to confirm
12926 that the match should indeed be shown."
12928 (when (equal regexp "")
12929 (error "Regexp cannot be empty"))
12930 (unless keep-previous
12931 (org-remove-occur-highlights nil nil t))
12932 (push (cons regexp callback) org-occur-parameters)
12933 (let ((cnt 0))
12934 (save-excursion
12935 (goto-char (point-min))
12936 (if (or (not keep-previous) ; do not want to keep
12937 (not org-occur-highlights)) ; no previous matches
12938 ;; hide everything
12939 (org-overview))
12940 (while (re-search-forward regexp nil t)
12941 (when (or (not callback)
12942 (save-match-data (funcall callback)))
12943 (setq cnt (1+ cnt))
12944 (when org-highlight-sparse-tree-matches
12945 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12946 (org-show-context 'occur-tree))))
12947 (when org-remove-highlights-with-change
12948 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12949 nil 'local))
12950 (unless org-sparse-tree-open-archived-trees
12951 (org-hide-archived-subtrees (point-min) (point-max)))
12952 (run-hooks 'org-occur-hook)
12953 (if (org-called-interactively-p 'interactive)
12954 (message "%d match(es) for regexp %s" cnt regexp))
12955 cnt))
12957 (defun org-occur-next-match (&optional n reset)
12958 "Function for `next-error-function' to find sparse tree matches.
12959 N is the number of matches to move, when negative move backwards.
12960 RESET is entirely ignored - this function always goes back to the
12961 starting point when no match is found."
12962 (let* ((limit (if (< n 0) (point-min) (point-max)))
12963 (search-func (if (< n 0)
12964 'previous-single-char-property-change
12965 'next-single-char-property-change))
12966 (n (abs n))
12967 (pos (point))
12968 p1)
12969 (catch 'exit
12970 (while (setq p1 (funcall search-func (point) 'org-type))
12971 (when (equal p1 limit)
12972 (goto-char pos)
12973 (error "No more matches"))
12974 (when (equal (get-char-property p1 'org-type) 'org-occur)
12975 (setq n (1- n))
12976 (when (= n 0)
12977 (goto-char p1)
12978 (throw 'exit (point))))
12979 (goto-char p1))
12980 (goto-char p1)
12981 (error "No more matches"))))
12983 (defun org-show-context (&optional key)
12984 "Make sure point and context are visible.
12985 How much context is shown depends upon the variables
12986 `org-show-hierarchy-above', `org-show-following-heading',
12987 `org-show-entry-below' and `org-show-siblings'."
12988 (let ((heading-p (org-at-heading-p t))
12989 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12990 (following-p (org-get-alist-option org-show-following-heading key))
12991 (entry-p (org-get-alist-option org-show-entry-below key))
12992 (siblings-p (org-get-alist-option org-show-siblings key)))
12993 (catch 'exit
12994 ;; Show heading or entry text
12995 (if (and heading-p (not entry-p))
12996 (org-flag-heading nil) ; only show the heading
12997 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12998 (org-show-hidden-entry))) ; show entire entry
12999 (when following-p
13000 ;; Show next sibling, or heading below text
13001 (save-excursion
13002 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13003 (org-flag-heading nil))))
13004 (when siblings-p (org-show-siblings))
13005 (when hierarchy-p
13006 ;; show all higher headings, possibly with siblings
13007 (save-excursion
13008 (while (and (condition-case nil
13009 (progn (org-up-heading-all 1) t)
13010 (error nil))
13011 (not (bobp)))
13012 (org-flag-heading nil)
13013 (when siblings-p (org-show-siblings))))))))
13015 (defvar org-reveal-start-hook nil
13016 "Hook run before revealing a location.")
13018 (defun org-reveal (&optional siblings)
13019 "Show current entry, hierarchy above it, and the following headline.
13020 This can be used to show a consistent set of context around locations
13021 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13022 not t for the search context.
13024 With optional argument SIBLINGS, on each level of the hierarchy all
13025 siblings are shown. This repairs the tree structure to what it would
13026 look like when opened with hierarchical calls to `org-cycle'.
13028 go to the parent and show the
13029 entire tree."
13030 (interactive "P")
13031 (run-hooks 'org-reveal-start-hook)
13032 (let ((org-show-hierarchy-above t)
13033 (org-show-following-heading t)
13034 (org-show-siblings (if siblings t org-show-siblings)))
13035 (org-show-context nil))
13036 (when (equal siblings '(16))
13037 (save-excursion
13038 (when (org-up-heading-safe)
13039 (org-show-subtree)
13040 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13042 (defun org-highlight-new-match (beg end)
13043 "Highlight from BEG to END and mark the highlight is an occur headline."
13044 (let ((ov (make-overlay beg end)))
13045 (overlay-put ov 'face 'secondary-selection)
13046 (overlay-put ov 'org-type 'org-occur)
13047 (push ov org-occur-highlights)))
13049 (defun org-remove-occur-highlights (&optional beg end noremove)
13050 "Remove the occur highlights from the buffer.
13051 BEG and END are ignored. If NOREMOVE is nil, remove this function
13052 from the `before-change-functions' in the current buffer."
13053 (interactive)
13054 (unless org-inhibit-highlight-removal
13055 (mapc 'delete-overlay org-occur-highlights)
13056 (setq org-occur-highlights nil)
13057 (setq org-occur-parameters nil)
13058 (unless noremove
13059 (remove-hook 'before-change-functions
13060 'org-remove-occur-highlights 'local))))
13062 ;;;; Priorities
13065 "Regular expression matching the priority indicator.")
13067 (defvar org-remove-priority-next-time nil)
13069 (defun org-priority-up ()
13070 "Increase the priority of the current item."
13071 (interactive)
13072 (org-priority 'up))
13074 (defun org-priority-down ()
13075 "Decrease the priority of the current item."
13076 (interactive)
13077 (org-priority 'down))
13079 (defun org-priority (&optional action show)
13080 "Change the priority of an item.
13081 ACTION can be `set', `up', `down', or a character."
13082 (interactive "P")
13083 (if (equal action '(4))
13084 (org-show-priority)
13085 (unless org-enable-priority-commands
13086 (error "Priority commands are disabled"))
13087 (setq action (or action 'set))
13088 (let (current new news have remove)
13089 (save-excursion
13090 (org-back-to-heading t)
13091 (if (looking-at org-priority-regexp)
13092 (setq current (string-to-char (match-string 2))
13093 have t))
13094 (cond
13095 ((eq action 'remove)
13096 (setq remove t new ?\ ))
13097 ((or (eq action 'set)
13098 (if (featurep 'xemacs) (characterp action) (integerp action)))
13099 (if (not (eq action 'set))
13100 (setq new action)
13101 (message "Priority %c-%c, SPC to remove: "
13102 org-highest-priority org-lowest-priority)
13103 (save-match-data
13104 (setq new (read-char-exclusive))))
13105 (if (and (= (upcase org-highest-priority) org-highest-priority)
13106 (= (upcase org-lowest-priority) org-lowest-priority))
13107 (setq new (upcase new)))
13108 (cond ((equal new ?\ ) (setq remove t))
13109 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13110 (error "Priority must be between `%c' and `%c'"
13111 org-highest-priority org-lowest-priority))))
13112 ((eq action 'up)
13113 (setq new (if have
13114 (1- current) ; normal cycling
13115 ;; last priority was empty
13116 (if (eq last-command this-command)
13117 org-lowest-priority ; wrap around empty to lowest
13118 ;; default
13119 (if org-priority-start-cycle-with-default
13120 org-default-priority
13121 (1- org-default-priority))))))
13122 ((eq action 'down)
13123 (setq new (if have
13124 (1+ current) ; normal cycling
13125 ;; last priority was empty
13126 (if (eq last-command this-command)
13127 org-highest-priority ; wrap around empty to highest
13128 ;; default
13129 (if org-priority-start-cycle-with-default
13130 org-default-priority
13131 (1+ org-default-priority))))))
13132 (t (error "Invalid action")))
13133 (if (or (< (upcase new) org-highest-priority)
13134 (> (upcase new) org-lowest-priority))
13135 (if (and (memq action '(up down))
13136 (not have) (not (eq last-command this-command)))
13137 ;; `new' is from default priority
13138 (error
13139 "The default can not be set, see `org-default-priority' why")
13140 ;; normal cycling: `new' is beyond highest/lowest priority
13141 ;; and is wrapped around to the empty priority
13142 (setq remove t)))
13143 (setq news (format "%c" new))
13144 (if have
13145 (if remove
13146 (replace-match "" t t nil 1)
13147 (replace-match news t t nil 2))
13148 (if remove
13149 (error "No priority cookie found in line")
13150 (let ((case-fold-search nil))
13151 (looking-at org-todo-line-regexp))
13152 (if (match-end 2)
13153 (progn
13154 (goto-char (match-end 2))
13155 (insert " [#" news "]"))
13156 (goto-char (match-beginning 3))
13157 (insert "[#" news "] "))))
13158 (org-preserve-lc (org-set-tags nil 'align)))
13159 (if remove
13160 (message "Priority removed")
13161 (message "Priority of current item set to %s" news)))))
13163 (defun org-show-priority ()
13164 "Show the priority of the current item.
13165 This priority is composed of the main priority given with the [#A] cookies,
13166 and by additional input from the age of a schedules or deadline entry."
13167 (interactive)
13168 (let ((pri (if (eq major-mode 'org-agenda-mode)
13169 (org-get-at-bol 'priority)
13170 (save-excursion
13171 (save-match-data
13172 (beginning-of-line)
13173 (and (looking-at org-heading-regexp)
13174 (org-get-priority (match-string 0))))))))
13175 (message "Priority is %d" (if pri pri -1000))))
13177 (defun org-get-priority (s)
13178 "Find priority cookie and return priority."
13179 (if (functionp org-get-priority-function)
13180 (funcall org-get-priority-function)
13181 (save-match-data
13182 (if (not (string-match org-priority-regexp s))
13183 (* 1000 (- org-lowest-priority org-default-priority))
13184 (* 1000 (- org-lowest-priority
13185 (string-to-char (match-string 2 s))))))))
13187 ;;;; Tags
13189 (defvar org-agenda-archives-mode)
13190 (defvar org-map-continue-from nil
13191 "Position from where mapping should continue.
13192 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13194 (defvar org-scanner-tags nil
13195 "The current tag list while the tags scanner is running.")
13196 (defvar org-trust-scanner-tags nil
13197 "Should `org-get-tags-at' use the tags for the scanner.
13198 This is for internal dynamical scoping only.
13199 When this is non-nil, the function `org-get-tags-at' will return the value
13200 of `org-scanner-tags' instead of building the list by itself. This
13201 can lead to large speed-ups when the tags scanner is used in a file with
13202 many entries, and when the list of tags is retrieved, for example to
13203 obtain a list of properties. Building the tags list for each entry in such
13204 a file becomes an N^2 operation - but with this variable set, it scales
13205 as N.")
13207 (defun org-scan-tags (action matcher todo-only &optional start-level)
13208 "Scan headline tags with inheritance and produce output ACTION.
13210 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13211 or `agenda' to produce an entry list for an agenda view. It can also be
13212 a Lisp form or a function that should be called at each matched headline, in
13213 this case the return value is a list of all return values from these calls.
13215 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13216 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13217 only lines with a not-done TODO keyword are included in the output.
13218 This should be the same variable that was scoped into
13219 and set by `org-make-tags-matcher' when it constructed MATCHER.
13221 START-LEVEL can be a string with asterisks, reducing the scope to
13222 headlines matching this string."
13223 (require 'org-agenda)
13224 (let* ((re (concat "^"
13225 (if start-level
13226 ;; Get the correct level to match
13228 org-outline-regexp)
13232 (props (list 'face 'default
13233 'done-face 'org-agenda-done
13234 'undone-face 'default
13235 'mouse-face 'highlight
13236 'org-not-done-regexp org-not-done-regexp
13237 'org-todo-regexp org-todo-regexp
13238 'org-complex-heading-regexp org-complex-heading-regexp
13239 'help-echo
13240 (format "mouse-2 or RET jump to org file %s"
13241 (abbreviate-file-name
13242 (or (buffer-file-name (buffer-base-buffer))
13243 (buffer-name (buffer-base-buffer)))))))
13244 (case-fold-search nil)
13245 (org-map-continue-from nil)
13246 lspos tags tags-list
13247 (tags-alist (list (cons 0 org-file-tags)))
13248 (llast 0) rtn rtn1 level category i txt
13249 todo marker entry priority)
13250 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13251 (setq action (list 'lambda nil action)))
13252 (save-excursion
13253 (goto-char (point-min))
13254 (when (eq action 'sparse-tree)
13255 (org-overview)
13256 (org-remove-occur-highlights))
13257 (while (re-search-forward re nil t)
13258 (setq org-map-continue-from nil)
13259 (catch :skip
13260 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13261 tags (if (match-end 4) (org-match-string-no-properties 4)))
13262 (goto-char (setq lspos (match-beginning 0)))
13263 (setq level (org-reduced-level (org-outline-level))
13264 category (org-get-category))
13265 (setq i llast llast level)
13266 ;; remove tag lists from same and sublevels
13267 (while (>= i level)
13268 (when (setq entry (assoc i tags-alist))
13269 (setq tags-alist (delete entry tags-alist)))
13270 (setq i (1- i)))
13271 ;; add the next tags
13272 (when tags
13273 (setq tags (org-split-string tags ":")
13274 tags-alist
13275 (cons (cons level tags) tags-alist)))
13276 ;; compile tags for current headline
13277 (setq tags-list
13278 (if org-use-tag-inheritance
13279 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13280 tags)
13281 org-scanner-tags tags-list)
13282 (when org-use-tag-inheritance
13283 (setcdr (car tags-alist)
13284 (mapcar (lambda (x)
13285 (setq x (copy-sequence x))
13286 (org-add-prop-inherited x))
13287 (cdar tags-alist))))
13288 (when (and tags org-use-tag-inheritance
13289 (or (not (eq t org-use-tag-inheritance))
13290 org-tags-exclude-from-inheritance))
13291 ;; selective inheritance, remove uninherited ones
13292 (setcdr (car tags-alist)
13293 (org-remove-uninherited-tags (cdar tags-alist))))
13294 (when (and
13296 ;; eval matcher only when the todo condition is OK
13297 (and (or (not todo-only) (member todo org-not-done-keywords))
13298 (let ((case-fold-search t) (org-trust-scanner-tags t))
13299 (eval matcher)))
13301 ;; Call the skipper, but return t if it does not skip,
13302 ;; so that the `and' form continues evaluating
13303 (progn
13304 (unless (eq action 'sparse-tree) (org-agenda-skip))
13305 t)
13307 ;; Check if timestamps are deselecting this entry
13308 (or (not todo-only)
13309 (and (member todo org-not-done-keywords)
13310 (or (not org-agenda-tags-todo-honor-ignore-options)
13311 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
13313 ;; Extra check for the archive tag
13314 ;; FIXME: Does the skipper already do this????
13315 (or
13316 (not (member org-archive-tag tags-list))
13317 ;; we have an archive tag, should we use this anyway?
13318 (or (not org-agenda-skip-archived-trees)
13319 (and (eq action 'agenda) org-agenda-archives-mode))))
13321 ;; select this headline
13322 (cond
13323 ((eq action 'sparse-tree)
13324 (and org-highlight-sparse-tree-matches
13325 (org-get-heading) (match-end 0)
13326 (org-highlight-new-match
13327 (match-beginning 1) (match-end 1)))
13328 (org-show-context 'tags-tree))
13329 ((eq action 'agenda)
13330 (setq txt (org-agenda-format-item
13331 ""
13332 (concat
13333 (if (eq org-tags-match-list-sublevels 'indented)
13334 (make-string (1- level) ?.) "")
13335 (org-get-heading))
13336 level category
13337 tags-list)
13338 priority (org-get-priority txt))
13339 (goto-char lspos)
13340 (setq marker (org-agenda-new-marker))
13341 (org-add-props txt props
13342 'org-marker marker 'org-hd-marker marker 'org-category category
13343 'todo-state todo
13344 'priority priority 'type "tagsmatch")
13345 (push txt rtn))
13346 ((functionp action)
13347 (setq org-map-continue-from nil)
13348 (save-excursion
13349 (setq rtn1 (funcall action))
13350 (push rtn1 rtn)))
13351 (t (error "Invalid action")))
13353 ;; if we are to skip sublevels, jump to end of subtree
13354 (unless org-tags-match-list-sublevels
13355 (org-end-of-subtree t)
13356 (backward-char 1))))
13357 ;; Get the correct position from where to continue
13358 (if org-map-continue-from
13359 (goto-char org-map-continue-from)
13360 (and (= (point) lspos) (end-of-line 1)))))
13361 (when (and (eq action 'sparse-tree)
13362 (not org-sparse-tree-open-archived-trees))
13363 (org-hide-archived-subtrees (point-min) (point-max)))
13364 (nreverse rtn)))
13366 (defun org-remove-uninherited-tags (tags)
13367 "Remove all tags that are not inherited from the list TAGS."
13368 (cond
13369 ((eq org-use-tag-inheritance t)
13370 (if org-tags-exclude-from-inheritance
13371 (org-delete-all org-tags-exclude-from-inheritance tags)
13372 tags))
13373 ((not org-use-tag-inheritance) nil)
13374 ((stringp org-use-tag-inheritance)
13375 (delq nil (mapcar
13376 (lambda (x)
13377 (if (and (string-match org-use-tag-inheritance x)
13378 (not (member x org-tags-exclude-from-inheritance)))
13379 x nil))
13380 tags)))
13381 ((listp org-use-tag-inheritance)
13382 (delq nil (mapcar
13383 (lambda (x)
13384 (if (member x org-use-tag-inheritance) x nil))
13385 tags)))))
13387 (defun org-match-sparse-tree (&optional todo-only match)
13388 "Create a sparse tree according to tags string MATCH.
13389 MATCH can contain positive and negative selection of tags, like
13391 If optional argument TODO-ONLY is non-nil, only select lines that are
13392 also TODO lines."
13393 (interactive "P")
13394 (org-agenda-prepare-buffers (list (current-buffer)))
13395 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13397 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13399 (defvar org-cached-props nil)
13400 (defun org-cached-entry-get (pom property)
13401 (if (or (eq t org-use-property-inheritance)
13402 (and (stringp org-use-property-inheritance)
13403 (string-match org-use-property-inheritance property))
13404 (and (listp org-use-property-inheritance)
13405 (member property org-use-property-inheritance)))
13406 ;; Caching is not possible, check it directly
13407 (org-entry-get pom property 'inherit)
13408 ;; Get all properties, so that we can do complicated checks easily
13409 (cdr (assoc property (or org-cached-props
13410 (setq org-cached-props
13411 (org-entry-properties pom)))))))
13413 (defun org-global-tags-completion-table (&optional files)
13414 "Return the list of all tags in all agenda buffer/files.
13415 Optional FILES argument is a list of files which can be used
13416 instead of the agenda files."
13417 (save-excursion
13418 (org-uniquify
13419 (delq nil
13420 (apply 'append
13421 (mapcar
13422 (lambda (file)
13423 (set-buffer (find-file-noselect file))
13424 (append (org-get-buffer-tags)
13425 (mapcar (lambda (x) (if (stringp (car-safe x))
13426 (list (car-safe x)) nil))
13427 org-tag-alist)))
13428 (if (and files (car files))
13429 files
13430 (org-agenda-files))))))))
13432 (defun org-make-tags-matcher (match)
13433 "Create the TAGS/TODO matcher form for the selection string MATCH.
13435 The variable `todo-only' is scoped dynamically into this function.
13436 It will be set to t if the matcher restricts matching to TODO entries,
13437 otherwise will not be touched.
13439 Returns a cons of the selection string MATCH and the constructed
13440 lisp form implementing the matcher. The matcher is to be evaluated
13441 at an Org entry, with point on the headline, and returns t if the
13442 entry matches the selection string MATCH. The returned lisp form
13443 references two variables with information about the entry, which
13444 must be bound around the form's evaluation: todo, the TODO keyword
13445 at the entry (or nil of none); and tags-list, the list of all tags
13446 at the entry including inherited ones. Additionally, the category
13447 of the entry (if any) must be specified as the text property
13448 'org-category on the headline.
13450 See also `org-scan-tags'.
13451 "
13452 (declare (special todo-only))
13453 (unless (boundp 'todo-only)
13454 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13455 (unless match
13456 ;; Get a new match request, with completion
13457 (let ((org-last-tags-completion-table
13458 (org-global-tags-completion-table)))
13459 (setq match (org-completing-read-no-i
13460 "Match: " 'org-tags-completion-function nil nil nil
13461 'org-tags-history))))
13463 ;; Parse the string and create a lisp form
13464 (let ((match0 match)
13465 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13466 minus tag mm
13467 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13468 orterms term orlist re-p str-p level-p level-op time-p
13469 prop-p pn pv po gv rest)
13470 (if (string-match "/+" match)
13471 ;; match contains also a todo-matching request
13472 (progn
13473 (setq tagsmatch (substring match 0 (match-beginning 0))
13474 todomatch (substring match (match-end 0)))
13475 (if (string-match "^!" todomatch)
13476 (setq todo-only t todomatch (substring todomatch 1)))
13478 (setq todomatch nil)))
13479 ;; only matching tags
13480 (setq tagsmatch match todomatch nil))
13482 ;; Make the tags matcher
13484 (setq tagsmatcher t)
13485 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13486 (while (setq term (pop orterms))
13488 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13489 (while (string-match re term)
13490 (setq rest (substring term (match-end 0))
13491 minus (and (match-end 1)
13492 (equal (match-string 1 term) "-"))
13493 tag (save-match-data (replace-regexp-in-string
13495 (match-string 2 term)))
13496 re-p (equal (string-to-char tag) ?{)
13497 level-p (match-end 4)
13498 prop-p (match-end 5)
13499 mm (cond
13500 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13501 (level-p
13502 (setq level-op (org-op-to-function (match-string 3 term)))
13503 `(,level-op level ,(string-to-number
13504 (match-string 4 term))))
13505 (prop-p
13506 (setq pn (match-string 5 term)
13507 po (match-string 6 term)
13508 pv (match-string 7 term)
13509 re-p (equal (string-to-char pv) ?{)
13511 time-p (save-match-data
13513 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13514 (if time-p (setq pv (org-matcher-time pv)))
13515 (setq po (org-op-to-function po (if time-p 'time str-p)))
13516 (cond
13517 ((equal pn "CATEGORY")
13518 (setq gv '(get-text-property (point) 'org-category)))
13519 ((equal pn "TODO")
13520 (setq gv 'todo))
13521 (t
13522 (setq gv `(org-cached-entry-get nil ,pn))))
13523 (if re-p
13524 (if (eq po 'org<>)
13525 `(not (string-match ,pv (or ,gv "")))
13526 `(string-match ,pv (or ,gv "")))
13527 (if str-p
13528 `(,po (or ,gv "") ,pv)
13529 `(,po (string-to-number (or ,gv ""))
13530 ,(string-to-number pv) ))))
13531 (t `(member ,tag tags-list)))
13532 mm (if minus (list 'not mm) mm)
13533 term rest)
13534 (push mm tagsmatcher))
13535 (push (if (> (length tagsmatcher) 1)
13536 (cons 'and tagsmatcher)
13537 (car tagsmatcher))
13538 orlist)
13539 (setq tagsmatcher nil))
13540 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13541 (setq tagsmatcher
13542 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13543 ;; Make the todo matcher
13545 (setq todomatcher t)
13546 (setq orterms (org-split-string todomatch "|") orlist nil)
13547 (while (setq term (pop orterms))
13548 (while (string-match re term)
13549 (setq minus (and (match-end 1)
13550 (equal (match-string 1 term) "-"))
13551 kwd (match-string 2 term)
13552 re-p (equal (string-to-char kwd) ?{)
13553 term (substring term (match-end 0))
13554 mm (if re-p
13555 `(string-match ,(substring kwd 1 -1) todo)
13556 (list 'equal 'todo kwd))
13557 mm (if minus (list 'not mm) mm))
13558 (push mm todomatcher))
13559 (push (if (> (length todomatcher) 1)
13560 (cons 'and todomatcher)
13561 (car todomatcher))
13562 orlist)
13563 (setq todomatcher nil))
13564 (setq todomatcher (if (> (length orlist) 1)
13565 (cons 'or orlist) (car orlist))))
13567 ;; Return the string and lisp forms of the matcher
13568 (setq matcher (if todomatcher
13569 (list 'and tagsmatcher todomatcher)
13570 tagsmatcher))
13571 (when todo-only
13572 (setq matcher (list 'and '(member todo org-not-done-keywords)
13573 matcher)))
13574 (cons match0 matcher)))
13576 (defun org-op-to-function (op &optional stringp)
13577 "Turn an operator into the appropriate function."
13578 (setq op
13579 (cond
13580 ((equal op "<" ) '(< string< org-time<))
13581 ((equal op ">" ) '(> org-string> org-time>))
13582 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13583 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13584 ((member op '("=" "==")) '(= string= org-time=))
13585 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13586 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13588 (defun org<> (a b) (not (= a b)))
13589 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13590 (defun org-string>= (a b) (not (string< a b)))
13591 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13592 (defun org-string<> (a b) (not (string= a b)))
13593 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13594 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13595 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13596 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13597 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13598 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13599 (defun org-2ft (s)
13600 "Convert S to a floating point time.
13601 If S is already a number, just return it. If it is a string, parse
13602 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13603 (cond
13604 ((numberp s) s)
13605 ((stringp s)
13606 (condition-case nil
13607 (float-time (apply 'encode-time (org-parse-time-string s)))
13608 (error 0.)))
13609 (t 0.)))
13611 (defun org-time-today ()
13612 "Time in seconds today at 0:00.
13613 Returns the float number of seconds since the beginning of the
13614 epoch to the beginning of today (00:00)."
13615 (float-time (apply 'encode-time
13616 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13618 (defun org-matcher-time (s)
13619 "Interpret a time comparison value."
13620 (save-match-data
13621 (cond
13622 ((string= s "<now>") (float-time))
13623 ((string= s "<today>") (org-time-today))
13624 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13625 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13627 (+ (org-time-today)
13628 (* (string-to-number (match-string 1 s))
13629 (cdr (assoc (match-string 2 s)
13630 '(("d" . 86400.0) ("w" . 604800.0)
13631 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13632 (t (org-2ft s)))))
13634 (defun org-match-any-p (re list)
13635 "Does re match any element of list?"
13636 (setq list (mapcar (lambda (x) (string-match re x)) list))
13637 (delq nil list))
13639 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13640 (defvar org-tags-overlay (make-overlay 1 1))
13641 (org-detach-overlay org-tags-overlay)
13643 (defun org-get-local-tags-at (&optional pos)
13644 "Get a list of tags defined in the current headline."
13645 (org-get-tags-at pos 'local))
13647 (defun org-get-local-tags ()
13648 "Get a list of tags defined in the current headline."
13649 (org-get-tags-at nil 'local))
13651 (defun org-get-tags-at (&optional pos local)
13652 "Get a list of all headline tags applicable at POS.
13653 POS defaults to point. If tags are inherited, the list contains
13654 the targets in the same sequence as the headlines appear, i.e.
13655 the tags of the current headline come last.
13656 When LOCAL is non-nil, only return tags from the current headline,
13657 ignore inherited ones."
13658 (interactive)
13659 (if (and org-trust-scanner-tags
13660 (or (not pos) (equal pos (point)))
13661 (not local))
13662 org-scanner-tags
13663 (let (tags ltags lastpos parent)
13664 (save-excursion
13665 (save-restriction
13666 (widen)
13667 (goto-char (or pos (point)))
13668 (save-match-data
13669 (catch 'done
13670 (condition-case nil
13671 (progn
13672 (org-back-to-heading t)
13673 (while (not (equal lastpos (point)))
13674 (setq lastpos (point))
13675 (when (looking-at
13677 (setq ltags (org-split-string
13678 (org-match-string-no-properties 1) ":"))
13679 (when parent
13680 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13681 (setq tags (append
13682 (if parent
13683 (org-remove-uninherited-tags ltags)
13684 ltags)
13685 tags)))
13686 (or org-use-tag-inheritance (throw 'done t))
13687 (if local (throw 'done t))
13688 (or (org-up-heading-safe) (error nil))
13689 (setq parent t)))
13690 (error nil)))))
13691 (if local
13692 tags
13693 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13695 (defun org-add-prop-inherited (s)
13696 (add-text-properties 0 (length s) '(inherited t) s)
13697 s)
13699 (defun org-toggle-tag (tag &optional onoff)
13700 "Toggle the tag TAG for the current line.
13701 If ONOFF is `on' or `off', don't toggle but set to this state."
13702 (let (res current)
13703 (save-excursion
13704 (org-back-to-heading t)
13706 (point-at-eol) t)
13707 (progn
13708 (setq current (match-string 1))
13709 (replace-match ""))
13710 (setq current ""))
13711 (setq current (nreverse (org-split-string current ":")))
13712 (cond
13713 ((eq onoff 'on)
13714 (setq res t)
13715 (or (member tag current) (push tag current)))
13716 ((eq onoff 'off)
13717 (or (not (member tag current)) (setq current (delete tag current))))
13718 (t (if (member tag current)
13719 (setq current (delete tag current))
13720 (setq res t)
13721 (push tag current))))
13722 (end-of-line 1)
13723 (if current
13724 (progn
13725 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13726 (org-set-tags nil t))
13727 (delete-horizontal-space))
13728 (run-hooks 'org-after-tags-change-hook))
13729 res))
13731 (defun org-align-tags-here (to-col)
13732 ;; Assumes that this is a headline
13733 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13734 (beginning-of-line 1)
13736 (< pos (match-beginning 2)))
13737 (progn
13738 (setq tags-l (- (match-end 2) (match-beginning 2)))
13739 (goto-char (match-beginning 1))
13740 (insert " ")
13741 (delete-region (point) (1+ (match-beginning 2)))
13742 (setq ncol (max (current-column)
13743 (1+ col)
13744 (if (> to-col 0)
13745 to-col
13746 (- (abs to-col) tags-l))))
13747 (setq p (point))
13748 (insert (make-string (- ncol (current-column)) ?\ ))
13749 (setq ncol (current-column))
13750 (when indent-tabs-mode (tabify p (point-at-eol)))
13751 (org-move-to-column (min ncol col) t))
13752 (goto-char pos))))
13754 (defun org-set-tags-command (&optional arg just-align)
13755 "Call the set-tags command for the current entry."
13756 (interactive "P")
13757 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13758 (org-set-tags arg just-align)
13759 (save-excursion
13760 (org-back-to-heading t)
13761 (org-set-tags arg just-align))))
13763 (defun org-set-tags-to (data)
13764 "Set the tags of the current entry to DATA, replacing the current tags.
13765 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13766 If DATA is nil or the empty string, any tags will be removed."
13767 (interactive "sTags: ")
13768 (setq data
13769 (cond
13770 ((eq data nil) "")
13771 ((equal data "") "")
13772 ((stringp data)
13773 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13774 ":"))
13775 ((listp data)
13776 (concat ":" (mapconcat 'identity data ":") ":"))))
13777 (when data
13778 (save-excursion
13779 (org-back-to-heading t)
13780 (when (looking-at org-complex-heading-regexp)
13781 (if (match-end 5)
13782 (progn
13783 (goto-char (match-beginning 5))
13784 (insert data)
13785 (delete-region (point) (point-at-eol))
13786 (org-set-tags nil 'align))
13787 (goto-char (point-at-eol))
13788 (insert " " data)
13789 (org-set-tags nil 'align)))
13790 (beginning-of-line 1)
13792 (delete-region (match-beginning 1) (match-end 1))))))
13794 (defun org-align-all-tags ()
13795 "Align the tags i all headings."
13796 (interactive)
13797 (save-excursion
13798 (or (ignore-errors (org-back-to-heading t))
13799 (outline-next-heading))
13800 (if (org-at-heading-p)
13801 (org-set-tags t)
13802 (message "No headings"))))
13804 (defvar org-indent-indentation-per-level)
13805 (defun org-set-tags (&optional arg just-align)
13806 "Set the tags for the current headline.
13807 With prefix ARG, realign all tags in headings in the current buffer."
13808 (interactive "P")
13809 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13810 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13811 'region-start-level 'region))
13812 org-loop-over-headlines-in-active-region)
13813 (org-map-entries
13814 ;; We don't use ARG and JUST-ALIGN here these args are not
13815 ;; useful when looping over headlines
13816 `(org-set-tags)
13817 org-loop-over-headlines-in-active-region
13818 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13819 (let* ((re org-outline-regexp-bol)
13820 (current (unless arg (org-get-tags-string)))
13821 (col (current-column))
13822 (org-setting-tags t)
13823 table current-tags inherited-tags ; computed below when needed
13824 tags p0 c0 c1 rpl di tc level)
13825 (if arg
13826 (save-excursion
13827 (goto-char (point-min))
13828 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13829 (while (re-search-forward re nil t)
13830 (org-set-tags nil t)
13831 (end-of-line 1)))
13832 (message "All tags realigned to column %d" org-tags-column))
13833 (if just-align
13834 (setq tags current)
13835 ;; Get a new set of tags from the user
13836 (save-excursion
13837 (setq table (append org-tag-persistent-alist
13838 (or org-tag-alist (org-get-buffer-tags))
13839 (and
13840 org-complete-tags-always-offer-all-agenda-tags
13841 (org-global-tags-completion-table
13842 (org-agenda-files))))
13843 org-last-tags-completion-table table
13844 current-tags (org-split-string current ":")
13845 inherited-tags (nreverse
13846 (nthcdr (length current-tags)
13847 (nreverse (org-get-tags-at))))
13848 tags
13849 (if (or (eq t org-use-fast-tag-selection)
13850 (and org-use-fast-tag-selection
13851 (delq nil (mapcar 'cdr table))))
13852 (org-fast-tag-selection
13853 current-tags inherited-tags table
13854 (if org-fast-tag-selection-include-todo
13855 org-todo-key-alist))
13856 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13857 (org-trim
13858 (org-icompleting-read "Tags: "
13859 'org-tags-completion-function
13860 nil nil current 'org-tags-history))))))
13861 (while (string-match "[-+&]+" tags)
13862 ;; No boolean logic, just a list
13863 (setq tags (replace-match ":" t t tags))))
13865 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13867 (if org-tags-sort-function
13868 (setq tags (mapconcat 'identity
13869 (sort (org-split-string
13870 tags (org-re "[^[:alnum:]_@#%]+"))
13871 org-tags-sort-function) ":")))
13874 (setq tags "")
13875 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13876 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13878 ;; Insert new tags at the correct column
13879 (beginning-of-line 1)
13880 (setq level (or (and (looking-at org-outline-regexp)
13881 (- (match-end 0) (point) 1))
13882 1))
13883 (cond
13884 ((and (equal current "") (equal tags "")))
13885 ((re-search-forward
13887 (point-at-eol) t)
13888 (if (equal tags "")
13889 (setq rpl "")
13890 (goto-char (match-beginning 0))
13891 (setq c0 (current-column)
13892 ;; compute offset for the case of org-indent-mode active
13893 di (if org-indent-mode
13894 (* (1- org-indent-indentation-per-level) (1- level))
13895 0)
13896 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13897 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13898 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13899 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13900 (replace-match rpl t t)
13901 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13902 tags)
13903 (t (error "Tags alignment failed")))
13904 (org-move-to-column col)
13905 (unless just-align
13906 (run-hooks 'org-after-tags-change-hook))))))
13908 (defun org-change-tag-in-region (beg end tag off)
13909 "Add or remove TAG for each entry in the region.
13910 This works in the agenda, and also in an org-mode buffer."
13911 (interactive
13912 (list (region-beginning) (region-end)
13913 (let ((org-last-tags-completion-table
13914 (if (derived-mode-p 'org-mode)
13915 (org-get-buffer-tags)
13916 (org-global-tags-completion-table))))
13917 (org-icompleting-read
13918 "Tag: " 'org-tags-completion-function nil nil nil
13919 'org-tags-history))
13920 (progn
13922 (equal (read-char-exclusive) ?r))))
13923 (if (fboundp 'deactivate-mark) (deactivate-mark))
13924 (let ((agendap (equal major-mode 'org-agenda-mode))
13925 l1 l2 m buf pos newhead (cnt 0))
13926 (goto-char end)
13927 (setq l2 (1- (org-current-line)))
13928 (goto-char beg)
13929 (setq l1 (org-current-line))
13930 (loop for l from l1 to l2 do
13931 (org-goto-line l)
13932 (setq m (get-text-property (point) 'org-hd-marker))
13933 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
13934 (and agendap m))
13935 (setq buf (if agendap (marker-buffer m) (current-buffer))
13936 pos (if agendap m (point)))
13937 (with-current-buffer buf
13938 (save-excursion
13939 (save-restriction
13940 (goto-char pos)
13941 (setq cnt (1+ cnt))
13942 (org-toggle-tag tag (if off 'off 'on))
13943 (setq newhead (org-get-heading)))))
13944 (and agendap (org-agenda-change-all-lines newhead m))))
13945 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13947 (defun org-tags-completion-function (string predicate &optional flag)
13948 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13949 (confirm (lambda (x) (stringp (car x)))))
13951 (setq s1 (match-string 1 string)
13952 s2 (match-string 2 string))
13953 (setq s1 "" s2 string))
13954 (cond
13955 ((eq flag nil)
13956 ;; try completion
13957 (setq rtn (try-completion s2 ctable confirm))
13958 (if (stringp rtn)
13959 (setq rtn
13960 (concat s1 s2 (substring rtn (length s2))
13961 (if (and org-add-colon-after-tag-completion
13962 (assoc rtn ctable))
13963 ":" ""))))
13964 rtn)
13965 ((eq flag t)
13966 ;; all-completions
13967 (all-completions s2 ctable confirm)
13968 )
13969 ((eq flag 'lambda)
13970 ;; exact match?
13971 (assoc s2 ctable)))
13972 ))
13974 (defun org-fast-tag-insert (kwd tags face &optional end)
13975 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13976 (insert (format "%-12s" (concat kwd ":"))
13977 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13978 (or end "")))
13980 (defun org-fast-tag-show-exit (flag)
13981 (save-excursion
13982 (org-goto-line 3)
13984 (replace-match ""))
13985 (when flag
13986 (end-of-line 1)
13987 (org-move-to-column (- (window-width) 19) t)
13988 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13990 (defun org-set-current-tags-overlay (current prefix)
13991 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13992 (if (featurep 'xemacs)
13993 (org-overlay-display org-tags-overlay (concat prefix s)
13994 'secondary-selection)
13995 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13996 (org-overlay-display org-tags-overlay (concat prefix s)))))
13998 (defvar org-last-tag-selection-key nil)
13999 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14000 "Fast tag selection with single keys.
14001 CURRENT is the current list of tags in the headline, INHERITED is the
14002 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14003 possibly with grouping information. TODO-TABLE is a similar table with
14004 TODO keywords, should these have keys assigned to them.
14005 If the keys are nil, a-z are automatically assigned.
14006 Returns the new tags string, or nil to not change the current settings."
14007 (let* ((fulltable (append table todo-table))
14008 (maxlen (apply 'max (mapcar
14009 (lambda (x)
14010 (if (stringp (car x)) (string-width (car x)) 0))
14011 fulltable)))
14012 (buf (current-buffer))
14013 (expert (eq org-fast-tag-selection-single-key 'expert))
14014 (buffer-tags nil)
14015 (fwidth (+ maxlen 3 1 3))
14016 (ncol (/ (- (window-width) 4) fwidth))
14017 (i-face 'org-done)
14018 (c-face 'org-todo)
14019 tg cnt e c char c1 c2 ntable tbl rtn
14020 ov-start ov-end ov-prefix
14021 (exit-after-next org-fast-tag-selection-single-key)
14022 (done-keywords org-done-keywords)
14023 groups ingroup)
14024 (save-excursion
14025 (beginning-of-line 1)
14026 (if (looking-at
14028 (setq ov-start (match-beginning 1)
14029 ov-end (match-end 1)
14030 ov-prefix "")
14031 (setq ov-start (1- (point-at-eol))
14032 ov-end (1+ ov-start))
14034 (setq ov-prefix
14035 (concat
14036 (buffer-substring (1- (point)) (point))
14037 (if (> (current-column) org-tags-column)
14038 " "
14039 (make-string (- org-tags-column (current-column)) ?\ ))))))
14040 (move-overlay org-tags-overlay ov-start ov-end)
14041 (save-window-excursion
14042 (if expert
14043 (set-buffer (get-buffer-create " *Org tags*"))
14044 (delete-other-windows)
14045 (split-window-vertically)
14046 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14047 (erase-buffer)
14048 (org-set-local 'org-done-keywords done-keywords)
14051 (org-fast-tag-show-exit exit-after-next)
14052 (org-set-current-tags-overlay current ov-prefix)
14053 (setq tbl fulltable char ?a cnt 0)
14054 (while (setq e (pop tbl))
14055 (cond
14056 ((equal (car e) :startgroup)
14057 (push '() groups) (setq ingroup t)
14058 (when (not (= cnt 0))
14059 (setq cnt 0)
14061 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14062 ((equal (car e) :endgroup)
14063 (setq ingroup nil cnt 0)
14065 ((equal e '(:newline))
14066 (when (not (= cnt 0))
14067 (setq cnt 0)
14069 (setq e (car tbl))
14070 (while (equal (car tbl) '(:newline))
14072 (setq tbl (cdr tbl)))))
14073 (t
14074 (setq tg (copy-sequence (car e)) c2 nil)
14075 (if (cdr e)
14076 (setq c (cdr e))
14077 ;; automatically assign a character.
14078 (setq c1 (string-to-char
14079 (downcase (substring
14080 tg (if (= (string-to-char tg) ?@) 1 0)))))
14081 (if (or (rassoc c1 ntable) (rassoc c1 table))
14082 (while (or (rassoc char ntable) (rassoc char table))
14083 (setq char (1+ char)))
14084 (setq c2 c1))
14085 (setq c (or c2 char)))
14086 (if ingroup (push tg (car groups)))
14087 (setq tg (org-add-props tg nil 'face
14088 (cond
14089 ((not (assoc tg table))
14090 (org-get-todo-face tg))
14091 ((member tg current) c-face)
14092 ((member tg inherited) i-face))))
14093 (if (and (= cnt 0) (not ingroup)) (insert " "))
14094 (insert "[" c "] " tg (make-string
14095 (- fwidth 4 (length tg)) ?\ ))
14096 (push (cons tg c) ntable)
14097 (when (= (setq cnt (1+ cnt)) ncol)
14099 (if ingroup (insert " "))
14100 (setq cnt 0)))))
14101 (setq ntable (nreverse ntable))
14103 (goto-char (point-min))
14104 (if (not expert) (org-fit-window-to-buffer))
14105 (setq rtn
14106 (catch 'exit
14107 (while t
14108 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14109 (if (not groups) "no " "")
14110 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14111 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14112 (setq org-last-tag-selection-key c)
14113 (cond
14115 ((= c ?!)
14116 (setq groups (not groups))
14117 (goto-char (point-min))
14118 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14119 ((= c ?\C-c)
14120 (if (not expert)
14121 (org-fast-tag-show-exit
14122 (setq exit-after-next (not exit-after-next)))
14123 (setq expert nil)
14124 (delete-other-windows)
14125 (set-window-buffer (split-window-vertically) " *Org tags*")
14126 (org-switch-to-buffer-other-window " *Org tags*")
14127 (org-fit-window-to-buffer)))
14128 ((or (= c ?\C-g)
14129 (and (= c ?q) (not (rassoc c ntable))))
14130 (org-detach-overlay org-tags-overlay)
14131 (setq quit-flag t))
14132 ((= c ?\ )
14133 (setq current nil)
14134 (if exit-after-next (setq exit-after-next 'now)))
14136 (condition-case nil
14137 (setq tg (org-icompleting-read
14138 "Tag: "
14139 (or buffer-tags
14140 (with-current-buffer buf
14141 (org-get-buffer-tags)))))
14142 (quit (setq tg "")))
14144 (add-to-list 'buffer-tags (list tg))
14145 (if (member tg current)
14146 (setq current (delete tg current))
14147 (push tg current)))
14148 (if exit-after-next (setq exit-after-next 'now)))
14149 ((setq e (rassoc c todo-table) tg (car e))
14150 (with-current-buffer buf
14151 (save-excursion (org-todo tg)))
14152 (if exit-after-next (setq exit-after-next 'now)))
14153 ((setq e (rassoc c ntable) tg (car e))
14154 (if (member tg current)
14155 (setq current (delete tg current))
14156 (loop for g in groups do
14157 (if (member tg g)
14158 (mapc (lambda (x)
14159 (setq current (delete x current)))
14160 g)))
14161 (push tg current))
14162 (if exit-after-next (setq exit-after-next 'now))))
14164 ;; Create a sorted list
14165 (setq current
14166 (sort current
14167 (lambda (a b)
14168 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14169 (if (eq exit-after-next 'now) (throw 'exit t))
14170 (goto-char (point-min))
14171 (beginning-of-line 2)
14172 (delete-region (point) (point-at-eol))
14173 (org-fast-tag-insert "Current" current c-face)
14174 (org-set-current-tags-overlay current ov-prefix)
14175 (while (re-search-forward
14177 (setq tg (match-string 1))
14178 (add-text-properties
14179 (match-beginning 1) (match-end 1)
14180 (list 'face
14181 (cond
14182 ((member tg current) c-face)
14183 ((member tg inherited) i-face)
14184 (t (get-text-property (match-beginning 1) 'face))))))
14185 (goto-char (point-min)))))
14186 (org-detach-overlay org-tags-overlay)
14187 (if rtn
14188 (mapconcat 'identity current ":")
14189 nil))))
14191 (defun org-get-tags-string ()
14192 "Get the TAGS string in the current headline."
14193 (unless (org-at-heading-p t)
14194 (error "Not on a heading"))
14195 (save-excursion
14196 (beginning-of-line 1)
14198 (org-match-string-no-properties 1)
14199 "")))
14201 (defun org-get-tags ()
14202 "Get the list of tags specified in the current headline."
14203 (org-split-string (org-get-tags-string) ":"))
14205 (defun org-get-buffer-tags ()
14206 "Get a table of all tags used in the buffer, for completion."
14207 (let (tags)
14208 (save-excursion
14209 (goto-char (point-min))
14210 (while (re-search-forward
14212 (when (equal (char-after (point-at-bol 0)) ?*)
14213 (mapc (lambda (x) (add-to-list 'tags x))
14214 (org-split-string (org-match-string-no-properties 1) ":")))))
14215 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14216 (mapcar 'list tags)))
14218 ;;;; The mapping API
14220 (defun org-map-entries (func &optional match scope &rest skip)
14221 "Call FUNC at each headline selected by MATCH in SCOPE.
14223 FUNC is a function or a lisp form. The function will be called without
14224 arguments, with the cursor positioned at the beginning of the headline.
14225 The return values of all calls to the function will be collected and
14226 returned as a list.
14228 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14229 does not need to preserve point. After evaluation, the cursor will be
14230 moved to the end of the line (presumably of the headline of the
14231 processed entry) and search continues from there. Under some
14232 circumstances, this may not produce the wanted results. For example,
14233 if you have removed (e.g. archived) the current (sub)tree it could
14234 mean that the next entry will be skipped entirely. In such cases, you
14235 can specify the position from where search should continue by making
14236 FUNC set the variable `org-map-continue-from' to the desired buffer
14237 position.
14239 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14240 Only headlines that are matched by this query will be considered during
14241 the iteration. When MATCH is nil or t, all headlines will be
14242 visited by the iteration.
14244 SCOPE determines the scope of this command. It can be any of:
14246 nil The current buffer, respecting the restriction if any
14247 tree The subtree started with the entry at point
14248 region The entries within the active region, if any
14249 region-start-level
14250 The entries within the active region, but only those at
14251 the same level than the first one.
14252 file The current buffer, without restriction
14253 file-with-archives
14254 The current buffer, and any archives associated with it
14255 agenda All agenda files
14256 agenda-with-archives
14257 All agenda files with any archive files associated with them
14258 \(file1 file2 ...)
14259 If this is a list, all files in the list will be scanned
14261 The remaining args are treated as settings for the skipping facilities of
14262 the scanner. The following items can be given here:
14264 archive skip trees with the archive tag.
14265 comment skip trees with the COMMENT keyword
14266 function or Emacs Lisp form:
14267 will be used as value for `org-agenda-skip-function', so whenever
14268 the function returns t, FUNC will not be called for that
14269 entry and search will continue from the point where the
14270 function leaves it.
14272 If your function needs to retrieve the tags including inherited tags
14273 at the *current* entry, you can use the value of the variable
14274 `org-scanner-tags' which will be much faster than getting the value
14275 with `org-get-tags-at'. If your function gets properties with
14276 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14277 to t around the call to `org-entry-properties' to get the same speedup.
14278 Note that if your function moves around to retrieve tags and properties at
14279 a *different* entry, you cannot use these techniques."
14280 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14281 (not (org-region-active-p)))
14282 (let* ((org-agenda-archives-mode nil) ; just to make sure
14283 (org-agenda-skip-archived-trees (memq 'archive skip))
14284 (org-agenda-skip-comment-trees (memq 'comment skip))
14285 (org-agenda-skip-function
14286 (car (org-delete-all '(comment archive) skip)))
14287 (org-tags-match-list-sublevels t)
14288 (start-level (eq scope 'region-start-level))
14289 matcher file res
14290 org-todo-keywords-for-agenda
14291 org-done-keywords-for-agenda
14292 org-todo-keyword-alist-for-agenda
14293 org-drawers-for-agenda
14294 org-tag-alist-for-agenda
14295 todo-only)
14297 (cond
14298 ((eq match t) (setq matcher t))
14299 ((eq match nil) (setq matcher t))
14300 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14302 (save-excursion
14303 (save-restriction
14304 (cond ((eq scope 'tree)
14305 (org-back-to-heading t)
14306 (org-narrow-to-subtree)
14307 (setq scope nil))
14308 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14309 (org-region-active-p))
14310 ;; If needed, set start-level to a string like "2"
14311 (when start-level
14312 (save-excursion
14313 (goto-char (region-beginning))
14314 (unless (org-at-heading-p) (outline-next-heading))
14315 (setq start-level (org-current-level))))
14316 (narrow-to-region (region-beginning)
14317 (save-excursion
14318 (goto-char (region-end))
14319 (unless (and (bolp) (org-at-heading-p))
14320 (outline-next-heading))
14321 (point)))
14322 (setq scope nil)))
14324 (if (not scope)
14325 (progn
14326 (org-agenda-prepare-buffers
14327 (list (buffer-file-name (current-buffer))))
14328 (setq res (org-scan-tags func matcher todo-only start-level)))
14329 ;; Get the right scope
14330 (cond
14331 ((and scope (listp scope) (symbolp (car scope)))
14332 (setq scope (eval scope)))
14333 ((eq scope 'agenda)
14334 (setq scope (org-agenda-files t)))
14335 ((eq scope 'agenda-with-archives)
14336 (setq scope (org-agenda-files t))
14337 (setq scope (org-add-archive-files scope)))
14338 ((eq scope 'file)
14339 (setq scope (list (buffer-file-name))))
14340 ((eq scope 'file-with-archives)
14341 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14342 (org-agenda-prepare-buffers scope)
14343 (while (setq file (pop scope))
14344 (with-current-buffer (org-find-base-buffer-visiting file)
14345 (save-excursion
14346 (save-restriction
14347 (widen)
14348 (goto-char (point-min))
14349 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14350 res)))
14352 ;;;; Properties
14354 ;;; Setting and retrieving properties
14356 (defconst org-special-properties
14357 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14358 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14359 "The special properties valid in Org-mode.
14361 These are properties that are not defined in the property drawer,
14362 but in some other way.")
14364 (defconst org-default-properties
14365 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14366 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14367 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14368 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14369 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14370 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14371 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14372 "Some properties that are used by Org-mode for various purposes.
14373 Being in this list makes sure that they are offered for completion.")
14376 "Regular expression matching the first line of a property drawer.")
14379 "Regular expression matching the last line of a property drawer.")
14382 "Regular expression matching the first line of a property drawer.")
14385 "Regular expression matching the first line of a property drawer.")
14387 (defconst org-property-drawer-re
14390 "Matches an entire property drawer.")
14392 (defconst org-clock-drawer-re
14395 "Matches an entire clock drawer.")
14397 (defsubst org-re-property (property)
14398 "Return a regexp matching a PROPERTY line.
14399 Match group 1 will be set to the value."
14402 (defsubst org-re-property-keyword (property)
14403 "Return a regexp matching a PROPERTY line, possibly with no
14404 value for the property."
14407 (defun org-property-action ()
14408 "Do an action on properties."
14409 (interactive)
14410 (let (c)
14411 (org-at-property-p)
14412 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14413 (setq c (read-char-exclusive))
14414 (cond
14415 ((equal c ?s)
14416 (call-interactively 'org-set-property))
14417 ((equal c ?d)
14418 (call-interactively 'org-delete-property))
14419 ((equal c ?D)
14420 (call-interactively 'org-delete-property-globally))
14421 ((equal c ?c)
14422 (call-interactively 'org-compute-property-at-point))
14423 (t (error "No such property action %c" c)))))
14425 (defun org-inc-effort ()
14426 "Increment the value of the effort property in the current entry."
14427 (interactive)
14428 (org-set-effort nil t))
14430 (defun org-set-effort (&optional value increment)
14431 "Set the effort property of the current entry.
14432 With numerical prefix arg, use the nth allowed value, 0 stands for the
14433 10th allowed value.
14435 When INCREMENT is non-nil, set the property to the next allowed value."
14436 (interactive "P")
14437 (if (equal value 0) (setq value 10))
14438 (let* ((completion-ignore-case t)
14439 (prop org-effort-property)
14440 (cur (org-entry-get nil prop))
14441 (allowed (org-property-get-allowed-values nil prop 'table))
14442 (existing (mapcar 'list (org-property-values prop)))
14443 rpl
14444 (val (cond
14445 ((stringp value) value)
14446 ((and allowed (integerp value))
14447 (or (car (nth (1- value) allowed))
14448 (car (org-last allowed))))
14449 ((and allowed increment)
14450 (or (caadr (member (list cur) allowed))
14451 (error "Allowed effort values are not set")))
14452 (allowed
14453 (message "Select 1-9,0, [RET%s]: %s"
14454 (if cur (concat "=" cur) "")
14455 (mapconcat 'car allowed " "))
14456 (setq rpl (read-char-exclusive))
14458 cur
14459 (setq rpl (- rpl ?0))
14460 (if (equal rpl 0) (setq rpl 10))
14461 (if (and (> rpl 0) (<= rpl (length allowed)))
14462 (car (nth (1- rpl) allowed))
14463 (org-completing-read "Effort: " allowed nil))))
14464 (t
14465 (let (org-completion-use-ido org-completion-use-iswitchb)
14466 (org-completing-read
14468 (concat "[" cur "]") "")
14469 ": ")
14470 existing nil nil "" nil cur))))))
14471 (unless (equal (org-entry-get nil prop) val)
14472 (org-entry-put nil prop val))
14473 (message "%s is now %s" prop val)))
14475 (defun org-at-property-p ()
14476 "Is cursor inside a property drawer?"
14477 (save-excursion
14478 (beginning-of-line 1)
14480 (save-match-data ;; Used by calling procedures
14481 (let ((p (point))
14482 (range (unless (org-before-first-heading-p)
14483 (org-get-property-block))))
14484 (and range (<= (car range) p) (< p (cdr range))))))))
14486 (defun org-get-property-block (&optional beg end force)
14487 "Return the (beg . end) range of the body of the property drawer.
14488 BEG and END are the beginning and end of the current subtree, or of
14489 the part before the first headline. If they are not given, they will
14490 be found. If the drawer does not exist and FORCE is non-nil, create
14491 the drawer."
14492 (catch 'exit
14493 (save-excursion
14494 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
14495 (progn (org-back-to-heading t) (point))))
14496 (end (or end (and (not (outline-next-heading)) (point-max))
14497 (point))))
14498 (goto-char beg)
14499 (if (re-search-forward org-property-start-re end t)
14500 (setq beg (1+ (match-end 0)))
14501 (if force
14502 (save-excursion
14503 (org-insert-property-drawer)
14504 (setq end (progn (outline-next-heading) (point))))
14505 (throw 'exit nil))
14506 (goto-char beg)
14507 (if (re-search-forward org-property-start-re end t)
14508 (setq beg (1+ (match-end 0)))))
14509 (if (re-search-forward org-property-end-re end t)
14510 (setq end (match-beginning 0))
14511 (or force (throw 'exit nil))
14512 (goto-char beg)
14513 (setq end beg)
14514 (org-indent-line)
14516 (cons beg end)))))
14518 (defun org-entry-properties (&optional pom which specific)
14519 "Get all properties of the entry at point-or-marker POM.
14520 This includes the TODO keyword, the tags, time strings for deadline,
14521 scheduled, and clocking, and any additional properties defined in the
14522 entry. The return value is an alist, keys may occur multiple times
14523 if the property key was used several times.
14524 POM may also be nil, in which case the current entry is used.
14525 If WHICH is nil or `all', get all properties. If WHICH is
14526 `special' or `standard', only get that subclass. If WHICH
14527 is a string only get exactly this property. SPECIFIC can be a string, the
14528 specific property we are interested in. Specifying it can speed
14529 things up because then unnecessary parsing is avoided."
14530 (setq which (or which 'all))
14531 (org-with-point-at pom
14532 (let ((clockstr (substring org-clock-string 0 -1))
14533 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14534 (case-fold-search nil)
14535 beg end range props sum-props key key1 value string clocksum clocksumt)
14536 (save-excursion
14537 (when (condition-case nil
14538 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14539 (error nil))
14540 (setq beg (point))
14541 (setq sum-props (get-text-property (point) 'org-summaries))
14542 (setq clocksum (get-text-property (point) :org-clock-minutes)
14543 clocksumt (get-text-property (point) :org-clock-minutes-today))
14544 (outline-next-heading)
14545 (setq end (point))
14546 (when (memq which '(all special))
14547 ;; Get the special properties, like TODO and tags
14548 (goto-char beg)
14549 (when (and (or (not specific) (string= specific "TODO"))
14550 (looking-at org-todo-line-regexp) (match-end 2))
14551 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14552 (when (and (or (not specific) (string= specific "PRIORITY"))
14553 (looking-at org-priority-regexp))
14554 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14555 (when (or (not specific) (string= specific "FILE"))
14556 (push (cons "FILE" buffer-file-name) props))
14557 (when (and (or (not specific) (string= specific "TAGS"))
14558 (setq value (org-get-tags-string))
14560 (push (cons "TAGS" value) props))
14561 (when (and (or (not specific) (string= specific "ALLTAGS"))
14562 (setq value (org-get-tags-at)))
14563 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14564 ":"))
14565 props))
14566 (when (or (not specific) (string= specific "BLOCKED"))
14567 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14568 (when (or (not specific)
14569 (member specific
14570 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14571 "TIMESTAMP" "TIMESTAMP_IA")))
14572 (catch 'match
14573 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14574 (setq key (if (match-end 1)
14575 (substring (org-match-string-no-properties 1)
14576 0 -1))
14577 string (if (equal key clockstr)
14578 (org-trim
14579 (buffer-substring-no-properties
14580 (match-beginning 3) (goto-char
14581 (point-at-eol))))
14582 (substring (org-match-string-no-properties 3)
14583 1 -1)))
14584 ;; Get the correct property name from the key. This is
14585 ;; necessary if the user has configured time keywords.
14586 (setq key1 (concat key ":"))
14587 (cond
14588 ((not key)
14589 (setq key
14590 (if (= (char-after (match-beginning 3)) ?\[)
14591 "TIMESTAMP_IA" "TIMESTAMP")))
14592 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14593 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14594 ((equal key1 org-closed-string) (setq key "CLOSED"))
14595 ((equal key1 org-clock-string) (setq key "CLOCK")))
14596 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14597 (progn
14598 (push (cons key string) props)
14599 ;; no need to search further if match is found
14600 (throw 'match t))
14601 (when (or (equal key "CLOCK") (not (assoc key props)))
14602 (push (cons key string) props)))))))
14604 (when (memq which '(all standard))
14605 ;; Get the standard properties, like :PROP: ...
14606 (setq range (org-get-property-block beg end))
14607 (when range
14608 (goto-char (car range))
14609 (while (re-search-forward
14611 (cdr range) t)
14612 (setq key (org-match-string-no-properties 1)
14613 value (org-trim (or (org-match-string-no-properties 2) "")))
14614 (unless (member key excluded)
14615 (push (cons key (or value "")) props)))))
14616 (if clocksum
14617 (push (cons "CLOCKSUM"
14618 (org-columns-number-to-string (/ (float clocksum) 60.)
14619 'add_times))
14620 props))
14621 (if clocksumt
14622 (push (cons "CLOCKSUM_T"
14623 (org-columns-number-to-string (/ (float clocksumt) 60.)
14624 'add_times))
14625 props))
14626 (unless (assoc "CATEGORY" props)
14627 (push (cons "CATEGORY" (org-get-category)) props))
14628 (append sum-props (nreverse props)))))))
14630 (defun org-entry-get (pom property &optional inherit literal-nil)
14631 "Get value of PROPERTY for entry or content at point-or-marker POM.
14632 If INHERIT is non-nil and the entry does not have the property,
14633 then also check higher levels of the hierarchy.
14634 If INHERIT is the symbol `selective', use inheritance only if the setting
14635 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14636 If the property is present but empty, the return value is the empty string.
14637 If the property is not present at all, nil is returned.
14640 do not interpret it as the list atom nil. This is used for inheritance
14642 (org-with-point-at pom
14643 (if (and inherit (if (eq inherit 'selective)
14644 (org-property-inherit-p property)
14645 t))
14646 (org-entry-get-with-inheritance property literal-nil)
14647 (if (member property org-special-properties)
14648 ;; We need a special property. Use `org-entry-properties' to
14649 ;; retrieve it, but specify the wanted property
14650 (cdr (assoc property (org-entry-properties nil 'special property)))
14651 (let* ((range (org-get-property-block))
14652 (props (list (or (assoc property org-file-properties)
14653 (assoc property org-global-properties)
14654 (assoc property org-global-properties-fixed))))
14655 (ap (lambda (key)
14656 (when (re-search-forward
14657 (org-re-property key) (cdr range) t)
14658 (setq props
14659 (org-update-property-plist
14660 key
14661 (if (match-end 1)
14662 (org-match-string-no-properties 1) "")
14663 props)))))
14664 val)
14665 (when (and range (goto-char (car range)))
14666 (funcall ap property)
14667 (goto-char (car range))
14668 (while (funcall ap (concat property "+")))
14669 (setq val (cdr (assoc property props)))
14670 (when val (if literal-nil val (org-not-nil val)))))))))
14672 (defun org-property-or-variable-value (var &optional inherit)
14673 "Check if there is a property fixing the value of VAR.
14674 If yes, return this value. If not, return the current value of the variable."
14675 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14677 (read prop)
14678 (symbol-value var))))
14680 (defun org-entry-delete (pom property)
14681 "Delete the property PROPERTY from entry at point-or-marker POM."
14682 (org-with-point-at pom
14683 (if (member property org-special-properties)
14684 nil ; cannot delete these properties.
14685 (let ((range (org-get-property-block)))
14686 (if (and range
14687 (goto-char (car range))
14688 (re-search-forward
14689 (org-re-property property)
14690 (cdr range) t))
14691 (progn
14692 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14693 t)
14694 nil)))))
14696 ;; Multi-values properties are properties that contain multiple values
14697 ;; These values are assumed to be single words, separated by whitespace.
14698 (defun org-entry-add-to-multivalued-property (pom property value)
14699 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14700 (let* ((old (org-entry-get pom property))
14702 (setq value (org-entry-protect-space value))
14703 (unless (member value values)
14704 (setq values (cons value values))
14705 (org-entry-put pom property
14706 (mapconcat 'identity values " ")))))
14708 (defun org-entry-remove-from-multivalued-property (pom property value)
14709 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14710 (let* ((old (org-entry-get pom property))
14712 (setq value (org-entry-protect-space value))
14713 (when (member value values)
14714 (setq values (delete value values))
14715 (org-entry-put pom property
14716 (mapconcat 'identity values " ")))))
14718 (defun org-entry-member-in-multivalued-property (pom property value)
14719 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14720 (let* ((old (org-entry-get pom property))
14722 (setq value (org-entry-protect-space value))
14723 (member value values)))
14725 (defun org-entry-get-multivalued-property (pom property)
14726 "Return a list of values in a multivalued property."
14727 (let* ((value (org-entry-get pom property))
14729 (mapcar 'org-entry-restore-space values)))
14731 (defun org-entry-put-multivalued-property (pom property &rest values)
14732 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14733 VALUES should be a list of strings. Spaces will be protected."
14734 (org-entry-put pom property
14735 (mapconcat 'org-entry-protect-space values " "))
14736 (let* ((value (org-entry-get pom property))
14738 (mapcar 'org-entry-restore-space values)))
14740 (defun org-entry-protect-space (s)
14741 "Protect spaces and newline in string S."
14742 (while (string-match " " s)
14743 (setq s (replace-match "%20" t t s)))
14745 (setq s (replace-match "%0A" t t s)))
14746 s)
14748 (defun org-entry-restore-space (s)
14749 "Restore spaces and newline in string S."
14750 (while (string-match "%20" s)
14751 (setq s (replace-match " " t t s)))
14752 (while (string-match "%0A" s)
14754 s)
14756 (defvar org-entry-property-inherited-from (make-marker)
14757 "Marker pointing to the entry from where a property was inherited.
14758 Each call to `org-entry-get-with-inheritance' will set this marker to the
14759 location of the entry where the inheritance search matched. If there was
14760 no match, the marker will point nowhere.
14761 Note that also `org-entry-get' calls this function, if the INHERIT flag
14762 is set.")
14764 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14765 "Get PROPERTY of entry or content at point, search higher levels if needed.
14766 The search will stop at the first ancestor which has the property defined.
14768 should be considered as undefined (this is the meaning of nil here).
14770 (move-marker org-entry-property-inherited-from nil)
14771 (let (tmp)
14772 (save-excursion
14773 (save-restriction
14774 (widen)
14775 (catch 'ex
14776 (while t
14777 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14778 (or (ignore-errors (org-back-to-heading t))
14779 (goto-char (point-min)))
14780 (move-marker org-entry-property-inherited-from (point))
14781 (throw 'ex tmp))
14782 (or (ignore-errors (org-up-heading-safe))
14783 (throw 'ex nil))))))
14784 (setq tmp (or tmp
14785 (cdr (assoc property org-file-properties))
14786 (cdr (assoc property org-global-properties))
14787 (cdr (assoc property org-global-properties-fixed))))
14788 (if literal-nil tmp (org-not-nil tmp))))
14790 (defvar org-property-changed-functions nil
14791 "Hook called when the value of a property has changed.
14792 Each hook function should accept two arguments, the name of the property
14793 and the new value.")
14795 (defun org-entry-put (pom property value)
14796 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14797 (org-with-point-at pom
14798 (org-back-to-heading t)
14799 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14800 range)
14801 (cond
14802 ((equal property "TODO")
14804 (not (member value org-todo-keywords-1)))
14806 (if (or (not value)
14808 (setq value 'none))
14809 (org-todo value)
14810 (org-set-tags nil 'align))
14811 ((equal property "PRIORITY")
14813 (string-to-char value) ?\ ))
14814 (org-set-tags nil 'align))
14815 ((equal property "CLOCKSUM")
14816 (if (not (re-search-forward
14818 (error "Cannot find a clock log")
14819 (goto-char (- (match-end 1) 2))
14820 (cond
14821 ((eq value 'earlier) (org-timestamp-down))
14822 ((eq value 'later) (org-timestamp-up)))
14823 (org-clock-sum-current-item)))
14824 ((equal property "SCHEDULED")
14825 (if (re-search-forward org-scheduled-time-regexp end t)
14826 (cond
14827 ((eq value 'earlier) (org-timestamp-change -1 'day))
14828 ((eq value 'later) (org-timestamp-change 1 'day))
14829 (t (call-interactively 'org-schedule)))
14830 (call-interactively 'org-schedule)))
14831 ((equal property "DEADLINE")
14832 (if (re-search-forward org-deadline-time-regexp end t)
14833 (cond
14834 ((eq value 'earlier) (org-timestamp-change -1 'day))
14835 ((eq value 'later) (org-timestamp-change 1 'day))
14836 (t (call-interactively 'org-deadline)))
14837 (call-interactively 'org-deadline)))
14838 ((member property org-special-properties)
14839 (error "The %s property can not yet be set with `org-entry-put'"
14840 property))
14841 (t ; a non-special property
14842 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14843 (setq range (org-get-property-block beg end 'force))
14844 (goto-char (car range))
14845 (if (re-search-forward
14846 (org-re-property-keyword property) (cdr range) t)
14847 (progn
14848 (delete-region (match-beginning 0) (match-end 0))
14849 (goto-char (match-beginning 0)))
14850 (goto-char (cdr range))
14852 (backward-char 1)
14853 (org-indent-line))
14854 (insert ":" property ":")
14855 (and value (insert " " value))
14856 (org-indent-line)))))
14857 (run-hook-with-args 'org-property-changed-functions property value)))
14859 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14860 "Get all property keys in the current buffer.
14861 With INCLUDE-SPECIALS, also list the special properties that reflect things
14862 like tags and TODO state.
14863 With INCLUDE-DEFAULTS, also include properties that has special meaning
14864 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14865 and others.
14866 With INCLUDE-COLUMNS, also include property names given in COLUMN
14867 formats in the current buffer."
14868 (let (rtn range cfmt s p)
14869 (save-excursion
14870 (save-restriction
14871 (widen)
14872 (goto-char (point-min))
14873 (while (re-search-forward org-property-start-re nil t)
14874 (setq range (org-get-property-block))
14875 (goto-char (car range))
14876 (while (re-search-forward
14878 (cdr range) t)
14879 (add-to-list 'rtn (org-match-string-no-properties 1)))
14880 (outline-next-heading))))
14882 (when include-specials
14883 (setq rtn (append org-special-properties rtn)))
14885 (when include-defaults
14886 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14887 (add-to-list 'rtn org-effort-property))
14889 (when include-columns
14890 (save-excursion
14891 (save-restriction
14892 (widen)
14893 (goto-char (point-min))
14894 (while (re-search-forward
14896 nil t)
14897 (setq cfmt (match-string 2) s 0)
14899 cfmt s)
14900 (setq s (match-end 0)
14901 p (match-string 1 cfmt))
14902 (unless (or (equal p "ITEM")
14903 (member p org-special-properties))
14904 (add-to-list 'rtn (match-string 1 cfmt))))))))
14906 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14908 (defun org-property-values (key)
14909 "Return a list of all values of property KEY in the current buffer."
14910 (save-excursion
14911 (save-restriction
14912 (widen)
14913 (goto-char (point-min))
14914 (let ((re (org-re-property key))
14915 values)
14916 (while (re-search-forward re nil t)
14917 (add-to-list 'values (org-trim (match-string 1))))
14918 (delete "" values)))))
14920 (defun org-insert-property-drawer ()
14921 "Insert a property drawer into the current entry."
14922 (org-back-to-heading t)
14923 (looking-at org-outline-regexp)
14924 (let ((indent (if org-adapt-indentation
14925 (- (match-end 0) (match-beginning 0))
14926 0))
14927 (beg (point))
14929 end hiddenp)
14930 (outline-next-heading)
14931 (setq end (point))
14932 (goto-char beg)
14933 (while (re-search-forward re end t))
14934 (setq hiddenp (outline-invisible-p))
14935 (end-of-line 1)
14938 (if (member (match-string 1) '("CLOCK:" ":END:"))
14939 ;; just skip this line
14940 (beginning-of-line 2)
14941 ;; Drawer start, find the end
14943 (beginning-of-line 1)))
14944 (org-skip-over-state-notes)
14946 (if (eq (char-before) ?*) (forward-char 1))
14948 (beginning-of-line 0)
14949 (org-indent-to-column indent)
14950 (beginning-of-line 2)
14951 (org-indent-to-column indent)
14952 (beginning-of-line 0)
14953 (if hiddenp
14954 (save-excursion
14955 (org-back-to-heading t)
14956 (hide-entry))
14957 (org-flag-drawer t))))
14959 (defun org-insert-drawer (&optional arg drawer)
14960 "Insert a drawer at point.
14962 Optional argument DRAWER, when non-nil, is a string representing
14963 drawer's name. Otherwise, the user is prompted for a name.
14965 If a region is active, insert the drawer around that region
14966 instead.
14968 Point is left between drawer's boundaries."
14969 (interactive "P")
14970 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14971 "LOGBOOK"))
14972 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14973 ;; internally by Org. They are meant to be inserted
14974 ;; automatically.
14975 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14976 ;; Remove system drawers from list. Note: For some reason,
14977 ;; `org-completing-read' ignores the predicate while
14978 ;; `completing-read' handles it fine.
14979 (drawer (if arg "PROPERTIES"
14980 (or drawer
14981 (completing-read
14982 "Drawer: " org-drawers
14983 (lambda (d) (not (member d system-drawers))))))))
14984 (cond
14985 ;; With C-u, fall back on `org-insert-property-drawer'
14986 (arg (org-insert-property-drawer))
14987 ;; With an active region, insert a drawer at point.
14988 ((not (org-region-active-p))
14989 (progn
14992 (forward-line -2)))
14993 ;; Otherwise, insert the drawer at point
14994 (t
14995 (let ((rbeg (region-beginning))
14996 (rend (copy-marker (region-end))))
14997 (unwind-protect
14998 (progn
14999 (goto-char rbeg)
15000 (beginning-of-line)
15001 (when (save-excursion
15002 (re-search-forward org-outline-regexp-bol rend t))
15003 (error "Drawers cannot contain headlines"))
15004 ;; Position point at the beginning of the first
15005 ;; non-blank line in region. Insert drawer's opening
15006 ;; there, then indent it.
15007 (org-skip-whitespace)
15008 (beginning-of-line)
15010 (forward-line -1)
15011 (indent-for-tab-command)
15012 ;; Move point to the beginning of the first blank line
15013 ;; after the last non-blank line in region. Insert
15014 ;; drawer's closing, then indent it.
15015 (goto-char rend)
15018 (deactivate-mark t)
15019 (indent-for-tab-command)
15021 ;; Clear marker, whatever the outcome of insertion is.
15022 (set-marker rend nil)))))))
15024 (defvar org-property-set-functions-alist nil
15025 "Property set function alist.
15026 Each entry should have the following format:
15028 (PROPERTY . READ-FUNCTION)
15030 The read function will be called with the same argument as
15031 `org-completing-read'.")
15033 (defun org-set-property-function (property)
15034 "Get the function that should be used to set PROPERTY.
15035 This is computed according to `org-property-set-functions-alist'."
15036 (or (cdr (assoc property org-property-set-functions-alist))
15037 'org-completing-read))
15039 (defun org-read-property-value (property)
15040 "Read PROPERTY value from user."
15041 (let* ((completion-ignore-case t)
15042 (allowed (org-property-get-allowed-values nil property 'table))
15043 (cur (org-entry-get nil property))
15044 (prompt (concat property " value"
15046 (concat " [" cur "]") "") ": "))
15047 (set-function (org-set-property-function property))
15048 (val (if allowed
15049 (funcall set-function prompt allowed nil
15050 (not (get-text-property 0 'org-unrestricted
15051 (caar allowed))))
15052 (let (org-completion-use-ido org-completion-use-iswitchb)
15053 (funcall set-function prompt
15054 (mapcar 'list (org-property-values property))
15055 nil nil "" nil cur)))))
15056 (if (equal val "")
15057 cur
15058 val)))
15060 (defvar org-last-set-property nil)
15061 (defun org-read-property-name ()
15062 "Read a property name."
15063 (let* ((completion-ignore-case t)
15064 (keys (org-buffer-property-keys nil t t))
15065 (default-prop (or (save-excursion
15066 (save-match-data
15067 (beginning-of-line)
15069 (null (string= (match-string 1) "END"))
15070 (match-string 1))))
15071 org-last-set-property))
15072 (property (org-icompleting-read
15073 (concat "Property"
15074 (if default-prop (concat " [" default-prop "]") "")
15075 ": ")
15076 (mapcar 'list keys)
15077 nil nil nil nil
15078 default-prop
15079 )))
15080 (if (member property keys)
15081 property
15082 (or (cdr (assoc (downcase property)
15083 (mapcar (lambda (x) (cons (downcase x) x))
15084 keys)))
15085 property))))
15087 (defun org-set-property (property value)
15088 "In the current entry, set PROPERTY to VALUE.
15089 When called interactively, this will prompt for a property name, offering
15090 completion on existing and default properties. And then it will prompt
15091 for a value, offering completion either on allowed values (via an inherited
15092 xxx_ALL property) or on existing values in other instances of this property
15093 in the current file."
15094 (interactive (list nil nil))
15095 (let* ((property (or property (org-read-property-name)))
15096 (value (or value (org-read-property-value property)))
15097 (fn (cdr (assoc property org-properties-postprocess-alist))))
15098 (setq org-last-set-property property)
15099 ;; Possibly postprocess the inserted value:
15100 (when fn (setq value (funcall fn value)))
15101 (unless (equal (org-entry-get nil property) value)
15102 (org-entry-put nil property value))))
15104 (defun org-delete-property (property)
15105 "In the current entry, delete PROPERTY."
15106 (interactive
15107 (let* ((completion-ignore-case t)
15108 (prop (org-icompleting-read "Property: "
15109 (org-entry-properties nil 'standard))))
15110 (list prop)))
15111 (message "Property %s %s" property
15112 (if (org-entry-delete nil property)
15113 "deleted"
15114 "was not present in the entry")))
15116 (defun org-delete-property-globally (property)
15117 "Remove PROPERTY globally, from all entries."
15118 (interactive
15119 (let* ((completion-ignore-case t)
15120 (prop (org-icompleting-read
15121 "Globally remove property: "
15122 (mapcar 'list (org-buffer-property-keys)))))
15123 (list prop)))
15124 (save-excursion
15125 (save-restriction
15126 (widen)
15127 (goto-char (point-min))
15128 (let ((cnt 0))
15129 (while (re-search-forward
15130 (org-re-property property)
15131 nil t)
15132 (setq cnt (1+ cnt))
15133 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15136 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15138 (defun org-compute-property-at-point ()
15139 "Compute the property at point.
15140 This looks for an enclosing column format, extracts the operator and
15141 then applies it to the property in the column format's scope."
15142 (interactive)
15143 (unless (org-at-property-p)
15144 (error "Not at a property"))
15145 (let ((prop (org-match-string-no-properties 2)))
15146 (org-columns-get-format-and-top-level)
15147 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15148 (error "No operator defined for property %s" prop))
15149 (org-columns-compute prop)))
15151 (defvar org-property-allowed-value-functions nil
15152 "Hook for functions supplying allowed values for a specific property.
15153 The functions must take a single argument, the name of the property, and
15155 the values, this means that these values are intended as defaults for
15156 completion, but that other values should be allowed too.
15157 The functions must return nil if they are not responsible for this
15158 property.")
15160 (defun org-property-get-allowed-values (pom property &optional table)
15161 "Get allowed values for the property PROPERTY.
15162 When TABLE is non-nil, return an alist that can directly be used for
15163 completion."
15164 (let (vals)
15165 (cond
15166 ((equal property "TODO")
15167 (setq vals (org-with-point-at pom
15168 (append org-todo-keywords-1 '("")))))
15169 ((equal property "PRIORITY")
15170 (let ((n org-lowest-priority))
15171 (while (>= n org-highest-priority)
15172 (push (char-to-string n) vals)
15173 (setq n (1- n)))))
15174 ((member property org-special-properties))
15175 ((setq vals (run-hook-with-args-until-success
15176 'org-property-allowed-value-functions property)))
15177 (t
15178 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15180 (setq vals (car (read-from-string (concat "(" vals ")"))))
15181 (setq vals (mapcar (lambda (x)
15182 (cond ((stringp x) x)
15183 ((numberp x) (number-to-string x))
15184 ((symbolp x) (symbol-name x))
15185 (t "???")))
15186 vals)))))
15187 (when (member ":ETC" vals)
15188 (setq vals (remove ":ETC" vals))
15189 (org-add-props (car vals) '(org-unrestricted t)))
15190 (if table (mapcar 'list vals) vals)))
15192 (defun org-property-previous-allowed-value (&optional previous)
15193 "Switch to the next allowed value for this property."
15194 (interactive)
15195 (org-property-next-allowed-value t))
15197 (defun org-property-next-allowed-value (&optional previous)
15198 "Switch to the next allowed value for this property."
15199 (interactive)
15200 (unless (org-at-property-p)
15201 (error "Not at a property"))
15202 (let* ((key (match-string 2))
15203 (value (match-string 3))
15204 (allowed (or (org-property-get-allowed-values (point) key)
15205 (and (member value '("[ ]" "[-]" "[X]"))
15206 '("[ ]" "[X]"))))
15207 nval)
15208 (unless allowed
15209 (error "Allowed values for this property have not been defined"))
15210 (if previous (setq allowed (reverse allowed)))
15211 (if (member value allowed)
15212 (setq nval (car (cdr (member value allowed)))))
15213 (setq nval (or nval (car allowed)))
15214 (if (equal nval value)
15215 (error "Only one allowed value for this property"))
15216 (org-at-property-p)
15217 (replace-match (concat " :" key ": " nval) t t)
15218 (org-indent-line)
15219 (beginning-of-line 1)
15221 (run-hook-with-args 'org-property-changed-functions key nval)))
15223 (defun org-find-olp (path &optional this-buffer)
15224 "Return a marker pointing to the entry at outline path OLP.
15225 If anything goes wrong, throw an error.
15226 You can wrap this call to catch the error like this:
15228 (condition-case msg
15229 (org-mobile-locate-entry (match-string 4))
15230 (error (nth 1 msg)))
15232 The return value will then be either a string with the error message,
15233 or a marker if everything is OK.
15235 If THIS-BUFFER is set, the outline path does not contain a file,
15236 only headings."
15237 (let* ((file (if this-buffer buffer-file-name (pop path)))
15238 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15239 (level 1)
15240 (lmin 1)
15241 (lmax 1)
15242 limit re end found pos heading cnt flevel)
15243 (unless buffer (error "File not found :%s" file))
15244 (with-current-buffer buffer
15245 (save-excursion
15246 (save-restriction
15247 (widen)
15248 (setq limit (point-max))
15249 (goto-char (point-min))
15250 (while (setq heading (pop path))
15251 (setq re (format org-complex-heading-regexp-format
15252 (regexp-quote heading)))
15253 (setq cnt 0 pos (point))
15254 (while (re-search-forward re end t)
15255 (setq level (- (match-end 1) (match-beginning 1)))
15256 (if (and (>= level lmin) (<= level lmax))
15257 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15258 (when (= cnt 0) (error "Heading not found on level %d: %s"
15259 lmax heading))
15260 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15261 lmax heading))
15262 (goto-char found)
15263 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15264 (setq end (save-excursion (org-end-of-subtree t t))))
15265 (when (org-at-heading-p)
15266 (point-marker)))))))
15268 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15269 "Find node HEADING in BUFFER.
15270 Return a marker to the heading if it was found, or nil if not.
15271 If POS-ONLY is set, return just the position instead of a marker.
15273 The heading text must match exact, but it may have a TODO keyword,
15274 a priority cookie and tags in the standard locations."
15275 (with-current-buffer (or buffer (current-buffer))
15276 (save-excursion
15277 (save-restriction
15278 (widen)
15279 (goto-char (point-min))
15280 (let (case-fold-search)
15281 (if (re-search-forward
15282 (format org-complex-heading-regexp-format
15283 (regexp-quote heading)) nil t)
15284 (if pos-only
15285 (match-beginning 0)
15286 (move-marker (make-marker) (match-beginning 0)))))))))
15288 (defun org-find-exact-heading-in-directory (heading &optional dir)
15289 "Find Org node headline HEADING in all .org files in directory DIR.
15290 When the target headline is found, return a marker to this location."
15291 (let ((files (directory-files (or dir default-directory)
15293 file visiting m buffer)
15294 (catch 'found
15295 (while (setq file (pop files))
15296 (message "trying %s" file)
15297 (setq visiting (org-find-base-buffer-visiting file))
15298 (setq buffer (or visiting (find-file-noselect file)))
15299 (setq m (org-find-exact-headline-in-buffer
15300 heading buffer))
15301 (when (and (not m) (not visiting)) (kill-buffer buffer))
15302 (and m (throw 'found m))))))
15304 (defun org-find-entry-with-id (ident)
15305 "Locate the entry that contains the ID property with exact value IDENT.
15306 IDENT can be a string, a symbol or a number, this function will search for
15307 the string representation of it.
15308 Return the position where this entry starts, or nil if there is no such entry."
15309 (interactive "sID: ")
15310 (let ((id (cond
15311 ((stringp ident) ident)
15312 ((symbol-name ident) (symbol-name ident))
15313 ((numberp ident) (number-to-string ident))
15314 (t (error "IDENT %s must be a string, symbol or number" ident))))
15315 (case-fold-search nil))
15316 (save-excursion
15317 (save-restriction
15318 (widen)
15319 (goto-char (point-min))
15320 (when (re-search-forward
15322 nil t)
15323 (org-back-to-heading t)
15324 (point))))))
15326 ;;;; Timestamps
15328 (defvar org-last-changed-timestamp nil)
15329 (defvar org-last-inserted-timestamp nil
15330 "The last time stamp inserted with `org-insert-time-stamp'.")
15331 (defvar org-time-was-given) ; dynamically scoped parameter
15332 (defvar org-end-time-was-given) ; dynamically scoped parameter
15333 (defvar org-ts-what) ; dynamically scoped parameter
15335 (defun org-time-stamp (arg &optional inactive)
15336 "Prompt for a date/time and insert a time stamp.
15337 If the user specifies a time like HH:MM or if this command is
15338 called with at least one prefix argument, the time stamp contains
15339 the date and the time. Otherwise, only the date is be included.
15341 All parts of a date not specified by the user is filled in from
15342 the current date/time. So if you just press return without
15343 typing anything, the time stamp will represent the current
15344 date/time.
15346 If there is already a timestamp at the cursor, it will be
15347 modified.
15349 With two universal prefix arguments, insert an active timestamp
15350 with the current time without prompting the user."
15351 (interactive "P")
15352 (let* ((ts nil)
15353 (default-time
15354 ;; Default time is either today, or, when entering a range,
15355 ;; the range start.
15356 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15357 (save-excursion
15358 (re-search-backward
15360 (- (point) 20) t)))
15361 (apply 'encode-time (org-parse-time-string (match-string 1)))
15362 (current-time)))
15363 (default-input (and ts (org-get-compact-tod ts)))
15364 (repeater (save-excursion
15365 (save-match-data
15366 (beginning-of-line)
15367 (when (re-search-forward
15369 (save-excursion (progn (end-of-line) (point))) t)
15370 (match-string 0)))))
15371 org-time-was-given org-end-time-was-given time)
15372 (cond
15373 ((and (org-at-timestamp-p t)
15374 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15375 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15376 (insert "--")
15377 (setq time (let ((this-command this-command))
15378 (org-read-date arg 'totime nil nil
15379 default-time default-input inactive)))
15380 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15381 ((org-at-timestamp-p t)
15382 (setq time (let ((this-command this-command))
15383 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15384 (when (org-at-timestamp-p t) ; just to get the match data
15385 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15386 (replace-match "")
15387 (setq org-last-changed-timestamp
15388 (org-insert-time-stamp
15389 time (or org-time-was-given arg)
15390 inactive nil nil (list org-end-time-was-given)))
15391 (when repeater (goto-char (1- (point))) (insert " " repeater)
15392 (setq org-last-changed-timestamp
15393 (concat (substring org-last-inserted-timestamp 0 -1)
15394 " " repeater ">"))))
15395 (message "Timestamp updated"))
15396 ((equal arg '(16))
15397 (org-insert-time-stamp (current-time) t))
15398 (t
15399 (setq time (let ((this-command this-command))
15400 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15401 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15402 nil nil (list org-end-time-was-given))))))
15404 ;; FIXME: can we use this for something else, like computing time differences?
15405 (defun org-get-compact-tod (s)
15406 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15407 (let* ((t1 (match-string 1 s))
15408 (h1 (string-to-number (match-string 2 s)))
15409 (m1 (string-to-number (match-string 3 s)))
15410 (t2 (and (match-end 4) (match-string 5 s)))
15411 (h2 (and t2 (string-to-number (match-string 6 s))))
15412 (m2 (and t2 (string-to-number (match-string 7 s))))
15413 dh dm)
15414 (if (not t2)
15415 t1
15416 (setq dh (- h2 h1) dm (- m2 m1))
15417 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15418 (concat t1 "+" (number-to-string dh)
15419 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15421 (defun org-time-stamp-inactive (&optional arg)
15422 "Insert an inactive time stamp.
15423 An inactive time stamp is enclosed in square brackets instead of angle
15424 brackets. It is inactive in the sense that it does not trigger agenda entries,
15425 does not link to the calendar and cannot be changed with the S-cursor keys.
15426 So these are more for recording a certain time/date."
15427 (interactive "P")
15428 (org-time-stamp arg 'inactive))
15430 (defvar org-date-ovl (make-overlay 1 1))
15431 (overlay-put org-date-ovl 'face 'org-date-selected)
15432 (org-detach-overlay org-date-ovl)
15434 (defvar org-ans1) ; dynamically scoped parameter
15435 (defvar org-ans2) ; dynamically scoped parameter
15437 (defvar org-plain-time-of-day-regexp) ; defined below
15439 (defvar org-overriding-default-time nil) ; dynamically scoped
15440 (defvar org-read-date-overlay nil)
15441 (defvar org-dcst nil) ; dynamically scoped
15442 (defvar org-read-date-history nil)
15443 (defvar org-read-date-final-answer nil)
15444 (defvar org-read-date-analyze-futurep nil)
15445 (defvar org-read-date-analyze-forced-year nil)
15446 (defvar org-read-date-inactive)
15448 (defun org-read-date (&optional org-with-time to-time from-string prompt
15449 default-time default-input inactive)
15450 "Read a date, possibly a time, and make things smooth for the user.
15451 The prompt will suggest to enter an ISO date, but you can also enter anything
15452 which will at least partially be understood by `parse-time-string'.
15453 Unrecognized parts of the date will default to the current day, month, year,
15454 hour and minute. If this command is called to replace a timestamp at point,
15455 or to enter the second timestamp of a range, the default time is taken
15456 from the existing stamp. Furthermore, the command prefers the future,
15457 so if you are giving a date where the year is not given, and the day-month
15458 combination is already past in the current year, it will assume you
15459 mean next year. For details, see the manual. A few examples:
15461 3-2-5 --> 2003-02-05
15462 feb 15 --> currentyear-02-15
15463 2/15 --> currentyear-02-15
15464 sep 12 9 --> 2009-09-12
15465 12:45 --> today 12:45
15466 22 sept 0:34 --> currentyear-09-22 0:34
15467 12 --> currentyear-currentmonth-12
15468 Fri --> nearest Friday (today or later)
15469 etc.
15471 Furthermore you can specify a relative date by giving, as the *first* thing
15472 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15473 change in days weeks, months, years.
15474 With a single plus or minus, the date is relative to today. With a double
15475 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15476 +4d --> four days from today
15477 +4 --> same as above
15478 +2w --> two weeks from today
15479 ++5 --> five days from default date
15481 The function understands only English month and weekday abbreviations.
15483 While prompting, a calendar is popped up - you can also select the
15484 date with the mouse (button 1). The calendar shows a period of three
15485 months. To scroll it to other months, use the keys `>' and `<'.
15486 If you don't like the calendar, turn it off with
15487 \(setq org-read-date-popup-calendar nil)
15489 With optional argument TO-TIME, the date will immediately be converted
15490 to an internal time.
15491 With an optional argument ORG-WITH-TIME, the prompt will suggest to
15492 also insert a time. Note that when ORG-WITH-TIME is not set, you can
15493 still enter a time, and this function will inform the calling routine
15494 about this change. The calling routine may then choose to change the
15495 format used to insert the time stamp into the buffer to include the time.
15496 With optional argument FROM-STRING, read from this string instead from
15497 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15498 the time/date that is used for everything that is not specified by the
15499 user."
15500 (require 'parse-time)
15501 (let* ((org-time-stamp-rounding-minutes
15502 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15503 (org-dcst org-display-custom-times)
15504 (ct (org-current-time))
15505 (org-def (or org-overriding-default-time default-time ct))
15506 (org-defdecode (decode-time org-def))
15507 (dummy (progn
15508 (when (< (nth 2 org-defdecode) org-extend-today-until)
15509 (setcar (nthcdr 2 org-defdecode) -1)
15510 (setcar (nthcdr 1 org-defdecode) 59)
15511 (setq org-def (apply 'encode-time org-defdecode)
15512 org-defdecode (decode-time org-def)))))
15513 (calendar-frame-setup nil)
15514 (calendar-setup nil)
15515 (calendar-move-hook nil)
15516 (calendar-view-diary-initially-flag nil)
15517 (calendar-view-holidays-initially-flag nil)
15518 (timestr (format-time-string
15519 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15520 (prompt (concat (if prompt (concat prompt " ") "")
15521 (format "Date+time [%s]: " timestr)))
15522 ans (org-ans0 "") org-ans1 org-ans2 final)
15524 (cond
15525 (from-string (setq ans from-string))
15526 (org-read-date-popup-calendar
15527 (save-excursion
15528 (save-window-excursion
15529 (calendar)
15530 (org-eval-in-calendar '(setq cursor-type nil) t)
15531 (unwind-protect
15532 (progn
15533 (calendar-forward-day (- (time-to-days org-def)
15534 (calendar-absolute-from-gregorian
15535 (calendar-current-date))))
15536 (org-eval-in-calendar nil t)
15537 (let* ((old-map (current-local-map))
15538 (map (copy-keymap calendar-mode-map))
15539 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15540 (org-defkey map (kbd "RET") 'org-calendar-select)
15541 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15542 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15543 (org-defkey minibuffer-local-map [(meta shift left)]
15544 (lambda () (interactive)
15545 (org-eval-in-calendar '(calendar-backward-month 1))))
15546 (org-defkey minibuffer-local-map [(meta shift right)]
15547 (lambda () (interactive)
15548 (org-eval-in-calendar '(calendar-forward-month 1))))
15549 (org-defkey minibuffer-local-map [(meta shift up)]
15550 (lambda () (interactive)
15551 (org-eval-in-calendar '(calendar-backward-year 1))))
15552 (org-defkey minibuffer-local-map [(meta shift down)]
15553 (lambda () (interactive)
15554 (org-eval-in-calendar '(calendar-forward-year 1))))
15555 (org-defkey minibuffer-local-map [?\e (shift left)]
15556 (lambda () (interactive)
15557 (org-eval-in-calendar '(calendar-backward-month 1))))
15558 (org-defkey minibuffer-local-map [?\e (shift right)]
15559 (lambda () (interactive)
15560 (org-eval-in-calendar '(calendar-forward-month 1))))
15561 (org-defkey minibuffer-local-map [?\e (shift up)]
15562 (lambda () (interactive)
15563 (org-eval-in-calendar '(calendar-backward-year 1))))
15564 (org-defkey minibuffer-local-map [?\e (shift down)]
15565 (lambda () (interactive)
15566 (org-eval-in-calendar '(calendar-forward-year 1))))
15567 (org-defkey minibuffer-local-map [(shift up)]
15568 (lambda () (interactive)
15569 (org-eval-in-calendar '(calendar-backward-week 1))))
15570 (org-defkey minibuffer-local-map [(shift down)]
15571 (lambda () (interactive)
15572 (org-eval-in-calendar '(calendar-forward-week 1))))
15573 (org-defkey minibuffer-local-map [(shift left)]
15574 (lambda () (interactive)
15575 (org-eval-in-calendar '(calendar-backward-day 1))))
15576 (org-defkey minibuffer-local-map [(shift right)]
15577 (lambda () (interactive)
15578 (org-eval-in-calendar '(calendar-forward-day 1))))
15579 (org-defkey minibuffer-local-map ">"
15580 (lambda () (interactive)
15581 (org-eval-in-calendar '(scroll-calendar-left 1))))
15582 (org-defkey minibuffer-local-map "<"
15583 (lambda () (interactive)
15584 (org-eval-in-calendar '(scroll-calendar-right 1))))
15585 (org-defkey minibuffer-local-map "\C-v"
15586 (lambda () (interactive)
15587 (org-eval-in-calendar
15588 '(calendar-scroll-left-three-months 1))))
15589 (org-defkey minibuffer-local-map "\M-v"
15590 (lambda () (interactive)
15591 (org-eval-in-calendar
15592 '(calendar-scroll-right-three-months 1))))
15593 (run-hooks 'org-read-date-minibuffer-setup-hook)
15594 (unwind-protect
15595 (progn
15596 (use-local-map map)
15597 (setq org-read-date-inactive inactive)
15598 (add-hook 'post-command-hook 'org-read-date-display)
15599 (setq org-ans0 (read-string prompt default-input
15600 'org-read-date-history nil))
15601 ;; org-ans0: from prompt
15602 ;; org-ans1: from mouse click
15603 ;; org-ans2: from calendar motion
15604 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15605 (remove-hook 'post-command-hook 'org-read-date-display)
15606 (use-local-map old-map)
15607 (when org-read-date-overlay
15608 (delete-overlay org-read-date-overlay)
15609 (setq org-read-date-overlay nil)))))
15610 (bury-buffer "*Calendar*")))))
15612 (t ; Naked prompt only
15613 (unwind-protect
15614 (setq ans (read-string prompt default-input
15615 'org-read-date-history timestr))
15616 (when org-read-date-overlay
15617 (delete-overlay org-read-date-overlay)
15618 (setq org-read-date-overlay nil)))))
15620 (setq final (org-read-date-analyze ans org-def org-defdecode))
15622 (when org-read-date-analyze-forced-year
15623 (message "Year was forced into %s"
15624 (if org-read-date-force-compatible-dates
15625 "compatible range (1970-2037)"
15626 "range representable on this machine"))
15627 (ding))
15629 ;; One round trip to get rid of 34th of August and stuff like that....
15630 (setq final (decode-time (apply 'encode-time final)))
15632 (setq org-read-date-final-answer ans)
15634 (if to-time
15635 (apply 'encode-time final)
15636 (if (and (boundp 'org-time-was-given) org-time-was-given)
15637 (format "%04d-%02d-%02d %02d:%02d"
15638 (nth 5 final) (nth 4 final) (nth 3 final)
15639 (nth 2 final) (nth 1 final))
15640 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15642 (defvar org-def)
15643 (defvar org-defdecode)
15644 (defvar org-with-time)
15645 (defun org-read-date-display ()
15646 "Display the current date prompt interpretation in the minibuffer."
15647 (when org-read-date-display-live
15648 (when org-read-date-overlay
15649 (delete-overlay org-read-date-overlay))
15650 (when (minibufferp (current-buffer))
15651 (save-excursion
15652 (end-of-line 1)
15653 (while (not (equal (buffer-substring
15654 (max (point-min) (- (point) 4)) (point))
15655 " "))
15656 (insert " ")))
15657 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15658 " " (or org-ans1 org-ans2)))
15659 (org-end-time-was-given nil)
15660 (f (org-read-date-analyze ans org-def org-defdecode))
15661 (fmts (if org-dcst
15662 org-time-stamp-custom-formats
15663 org-time-stamp-formats))
15664 (fmt (if (or org-with-time
15665 (and (boundp 'org-time-was-given) org-time-was-given))
15666 (cdr fmts)
15667 (car fmts)))
15668 (txt (format-time-string fmt (apply 'encode-time f)))
15669 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15670 (txt (concat "=> " txt)))
15671 (when (and org-end-time-was-given
15672 (string-match org-plain-time-of-day-regexp txt))
15673 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15674 org-end-time-was-given
15675 (substring txt (match-end 0)))))
15676 (when org-read-date-analyze-futurep
15677 (setq txt (concat txt " (=>F)")))
15678 (setq org-read-date-overlay
15679 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15680 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
15682 (defun org-read-date-analyze (ans org-def org-defdecode)
15683 "Analyze the combined answer of the date prompt."
15684 ;; FIXME: cleanup and comment
15685 (let ((nowdecode (decode-time (current-time)))
15686 delta deltan deltaw deltadef year month day
15687 hour minute second wday pm h2 m2 tl wday1
15688 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15689 (setq org-read-date-analyze-futurep nil
15690 org-read-date-analyze-forced-year nil)
15692 (setq ans "+0"))
15694 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15695 (setq ans (replace-match "" t t ans)
15696 deltan (car delta)
15697 deltaw (nth 1 delta)
15698 deltadef (nth 2 delta)))
15700 ;; Check if there is an iso week date in there. If yes, store the
15701 ;; info and postpone interpreting it until the rest of the parsing
15702 ;; is done.
15703 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15704 (setq iso-year (if (match-end 1)
15705 (org-small-year-to-year
15706 (string-to-number (match-string 1 ans))))
15707 iso-weekday (if (match-end 3)
15708 (string-to-number (match-string 3 ans)))
15709 iso-week (string-to-number (match-string 2 ans)))
15710 (setq ans (replace-match "" t t ans)))
15712 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15713 (when (string-match
15715 (setq year (if (match-end 2)
15716 (string-to-number (match-string 2 ans))
15717 (progn (setq kill-year t)
15718 (string-to-number (format-time-string "%Y"))))
15719 month (string-to-number (match-string 3 ans))
15720 day (string-to-number (match-string 4 ans)))
15721 (if (< year 100) (setq year (+ 2000 year)))
15723 t nil ans)))
15725 ;; Help matching dotted european dates
15726 (when (string-match
15727 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
15728 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
15729 (setq kill-year t)
15730 (string-to-number (format-time-string "%Y")))
15731 day (string-to-number (match-string 1 ans))
15732 month (string-to-number (match-string 2 ans))
15733 ans (replace-match (format "%04d-%02d-%02d" year month day)
15734 t nil ans)))
15736 ;; Help matching american dates, like 5/30 or 5/30/7
15737 (when (string-match
15738 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15739 (setq year (if (match-end 4)
15740 (string-to-number (match-string 4 ans))
15741 (progn (setq kill-year t)
15742 (string-to-number (format-time-string "%Y"))))
15743 month (string-to-number (match-string 1 ans))
15744 day (string-to-number (match-string 2 ans)))
15745 (if (< year 100) (setq year (+ 2000 year)))
15747 t nil ans)))
15748 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15749 ;; If there is a time with am/pm, and *no* time without it, we convert
15750 ;; so that matching will be successful.
15751 (loop for i from 1 to 2 do ; twice, for end time as well
15754 (setq hour (string-to-number (match-string 1 ans))
15755 minute (if (match-end 3)
15756 (string-to-number (match-string 3 ans))
15757 0)
15758 pm (equal ?p
15759 (string-to-char (downcase (match-string 4 ans)))))
15760 (if (and (= hour 12) (not pm))
15761 (setq hour 0)
15762 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15763 (setq ans (replace-match (format "%02d:%02d" hour minute)
15764 t t ans))))
15766 ;; Check if a time range is given as a duration
15767 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15768 (setq hour (string-to-number (match-string 1 ans))
15769 h2 (+ hour (string-to-number (match-string 3 ans)))
15770 minute (string-to-number (match-string 2 ans))
15771 m2 (+ minute (if (match-end 5) (string-to-number
15772 (match-string 5 ans))0)))
15773 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15774 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15775 t t ans)))
15777 ;; Check if there is a time range
15778 (when (boundp 'org-end-time-was-given)
15779 (setq org-time-was-given nil)
15780 (when (and (string-match org-plain-time-of-day-regexp ans)
15781 (match-end 8))
15782 (setq org-end-time-was-given (match-string 8 ans))
15783 (setq ans (concat (substring ans 0 (match-beginning 7))
15784 (substring ans (match-end 7))))))
15786 (setq tl (parse-time-string ans)
15787 day (or (nth 3 tl) (nth 3 org-defdecode))
15788 month (or (nth 4 tl)
15789 (if (and org-read-date-prefer-future
15790 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15791 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15792 (nth 4 org-defdecode)))
15793 year (or (and (not kill-year) (nth 5 tl))
15794 (if (and org-read-date-prefer-future
15795 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15796 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15797 (nth 5 org-defdecode)))
15798 hour (or (nth 2 tl) (nth 2 org-defdecode))
15799 minute (or (nth 1 tl) (nth 1 org-defdecode))
15800 second (or (nth 0 tl) 0)
15801 wday (nth 6 tl))
15803 (when (and (eq org-read-date-prefer-future 'time)
15804 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15805 (equal day (nth 3 nowdecode))
15806 (equal month (nth 4 nowdecode))
15807 (equal year (nth 5 nowdecode))
15808 (nth 2 tl)
15809 (or (< (nth 2 tl) (nth 2 nowdecode))
15810 (and (= (nth 2 tl) (nth 2 nowdecode))
15811 (nth 1 tl)
15812 (< (nth 1 tl) (nth 1 nowdecode)))))
15813 (setq day (1+ day)
15814 futurep t))
15816 ;; Special date definitions below
15817 (cond
15818 (iso-week
15819 ;; There was an iso week
15820 (require 'cal-iso)
15821 (setq futurep nil)
15822 (setq year (or iso-year year)
15823 day (or iso-weekday wday 1)
15824 wday nil ; to make sure that the trigger below does not match
15825 iso-date (calendar-gregorian-from-absolute
15826 (calendar-absolute-from-iso
15827 (list iso-week day year))))
15828 ; FIXME: Should we also push ISO weeks into the future?
15829 ; (when (and org-read-date-prefer-future
15830 ; (not iso-year)
15831 ; (< (calendar-absolute-from-gregorian iso-date)
15832 ; (time-to-days (current-time))))
15833 ; (setq year (1+ year)
15834 ; iso-date (calendar-gregorian-from-absolute
15835 ; (calendar-absolute-from-iso
15836 ; (list iso-week day year)))))
15837 (setq month (car iso-date)
15838 year (nth 2 iso-date)
15839 day (nth 1 iso-date)))
15840 (deltan
15841 (setq futurep nil)
15842 (unless deltadef
15843 (let ((now (decode-time (current-time))))
15844 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15845 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15846 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15847 ((equal deltaw "m") (setq month (+ month deltan)))
15848 ((equal deltaw "y") (setq year (+ year deltan)))))
15849 ((and wday (not (nth 3 tl)))
15850 ;; Weekday was given, but no day, so pick that day in the week
15851 ;; on or after the derived date.
15852 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15853 (unless (equal wday wday1)
15854 (setq day (+ day (% (- wday wday1 -7) 7))))))
15855 (if (and (boundp 'org-time-was-given)
15856 (nth 2 tl))
15857 (setq org-time-was-given t))
15858 (if (< year 100) (setq year (+ 2000 year)))
15859 ;; Check of the date is representable
15860 (if org-read-date-force-compatible-dates
15861 (progn
15862 (if (< year 1970)
15863 (setq year 1970 org-read-date-analyze-forced-year t))
15864 (if (> year 2037)
15865 (setq year 2037 org-read-date-analyze-forced-year t)))
15866 (condition-case nil
15867 (ignore (encode-time second minute hour day month year))
15868 (error
15869 (setq year (nth 5 org-defdecode))
15870 (setq org-read-date-analyze-forced-year t))))
15871 (setq org-read-date-analyze-futurep futurep)
15872 (list second minute hour day month year)))
15874 (defvar parse-time-weekdays)
15875 (defun org-read-date-get-relative (s today default)
15876 "Check string S for special relative date string.
15877 TODAY and DEFAULT are internal times, for today and for a default.
15878 Return shift list (N what def-flag)
15880 N is the number of WHATs to shift.
15881 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15882 the DEFAULT date rather than TODAY."
15883 (require 'parse-time)
15884 (when (and
15885 (string-match
15886 (concat
15891 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15892 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15893 (string-to-char (substring (match-string 1 s) -1))
15894 ?+))
15895 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15896 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15897 (what (if (match-end 3) (match-string 3 s) "d"))
15898 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15899 (date (if rel default today))
15900 (wday (nth 6 (decode-time date)))
15901 delta)
15902 (if wday1
15903 (progn
15904 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15905 (if (= dir ?-) (setq delta (- delta 7)))
15906 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15907 (list delta "d" rel))
15908 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15910 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15911 "Turn a user-specified date into the internal representation.
15912 The internal representation needed by the calendar is (month day year).
15913 This is a wrapper to handle the brain-dead convention in calendar that
15914 user function argument order change dependent on argument order."
15915 (if (boundp 'calendar-date-style)
15916 (cond
15917 ((eq calendar-date-style 'american)
15918 (list arg1 arg2 arg3))
15919 ((eq calendar-date-style 'european)
15920 (list arg2 arg1 arg3))
15921 ((eq calendar-date-style 'iso)
15922 (list arg2 arg3 arg1)))
15923 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15924 (if (org-bound-and-true-p european-calendar-style)
15925 (list arg2 arg1 arg3)
15926 (list arg1 arg2 arg3)))))
15928 (defun org-eval-in-calendar (form &optional keepdate)
15929 "Eval FORM in the calendar window and return to current window.
15930 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
15931 otherwise stick to the current value of `org-ans2'."
15932 (let ((sf (selected-frame))
15933 (sw (selected-window)))
15934 (select-window (get-buffer-window "*Calendar*" t))
15935 (eval form)
15936 (when (and (not keepdate) (calendar-cursor-to-date))
15937 (let* ((date (calendar-cursor-to-date))
15938 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15939 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15940 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15941 (select-window sw)
15942 (org-select-frame-set-input-focus sf)))
15944 (defun org-calendar-select ()
15945 "Return to `org-read-date' with the date currently selected.
15946 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15947 (interactive)
15948 (when (calendar-cursor-to-date)
15949 (let* ((date (calendar-cursor-to-date))
15950 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15951 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15952 (if (active-minibuffer-window) (exit-minibuffer))))
15954 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15955 "Insert a date stamp for the date given by the internal TIME.
15956 WITH-HM means use the stamp format that includes the time of the day.
15957 INACTIVE means use square brackets instead of angular ones, so that the
15958 stamp will not contribute to the agenda.
15959 PRE and POST are optional strings to be inserted before and after the
15960 stamp.
15961 The command returns the inserted time stamp."
15962 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15963 stamp)
15964 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15965 (insert-before-markers (or pre ""))
15966 (when (listp extra)
15967 (setq extra (car extra))
15968 (if (and (stringp extra)
15970 (setq extra (format "-%02d:%02d"
15971 (string-to-number (match-string 1 extra))
15972 (string-to-number (match-string 2 extra))))
15973 (setq extra nil)))
15974 (when extra
15975 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15976 (insert-before-markers (setq stamp (format-time-string fmt time)))
15977 (insert-before-markers (or post ""))
15978 (setq org-last-inserted-timestamp stamp)))
15980 (defun org-toggle-time-stamp-overlays ()
15981 "Toggle the use of custom time stamp formats."
15982 (interactive)
15983 (setq org-display-custom-times (not org-display-custom-times))
15984 (unless org-display-custom-times
15985 (let ((p (point-min)) (bmp (buffer-modified-p)))
15986 (while (setq p (next-single-property-change p 'display))
15987 (if (and (get-text-property p 'display)
15988 (eq (get-text-property p 'face) 'org-date))
15989 (remove-text-properties
15990 p (setq p (next-single-property-change p 'display))
15991 '(display t))))
15992 (set-buffer-modified-p bmp)))
15993 (if (featurep 'xemacs)
15994 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15995 (org-restart-font-lock)
15996 (setq org-table-may-need-update t)
15997 (if org-display-custom-times
15998 (message "Time stamps are overlaid with custom format")
15999 (message "Time stamp overlays removed")))
16001 (defun org-display-custom-time (beg end)
16002 "Overlay modified time stamp format over timestamp between BEG and END."
16003 (let* ((ts (buffer-substring beg end))
16004 t1 w1 with-hm tf time str w2 (off 0))
16005 (save-match-data
16006 (setq t1 (org-parse-time-string ts t))
16007 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16008 (setq off (- (match-end 0) (match-beginning 0)))))
16009 (setq end (- end off))
16010 (setq w1 (- end beg)
16011 with-hm (and (nth 1 t1) (nth 2 t1))
16012 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16013 time (org-fix-decoded-time t1)
16014 str (org-add-props
16015 (format-time-string
16016 (substring tf 1 -1) (apply 'encode-time time))
16017 nil 'mouse-face 'highlight)
16018 w2 (length str))
16019 (if (not (= w2 w1))
16020 (add-text-properties (1+ beg) (+ 2 beg)
16021 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16022 (if (featurep 'xemacs)
16023 (progn
16024 (put-text-property beg end 'invisible t)
16025 (put-text-property beg end 'end-glyph (make-glyph str)))
16026 (put-text-property beg end 'display str))))
16028 (defun org-translate-time (string)
16029 "Translate all timestamps in STRING to custom format.
16030 But do this only if the variable `org-display-custom-times' is set."
16031 (when org-display-custom-times
16032 (save-match-data
16033 (let* ((start 0)
16034 (re org-ts-regexp-both)
16035 t1 with-hm inactive tf time str beg end)
16036 (while (setq start (string-match re string start))
16037 (setq beg (match-beginning 0)
16038 end (match-end 0)
16039 t1 (save-match-data
16040 (org-parse-time-string (substring string beg end) t))
16041 with-hm (and (nth 1 t1) (nth 2 t1))
16042 inactive (equal (substring string beg (1+ beg)) "[")
16043 tf (funcall (if with-hm 'cdr 'car)
16044 org-time-stamp-custom-formats)
16045 time (org-fix-decoded-time t1)
16046 str (format-time-string
16047 (concat
16048 (if inactive "[" "<") (substring tf 1 -1)
16049 (if inactive "]" ">"))
16050 (apply 'encode-time time))
16051 string (replace-match str t t string)
16052 start (+ start (length str)))))))
16053 string)
16055 (defun org-fix-decoded-time (time)
16056 "Set 0 instead of nil for the first 6 elements of time.
16057 Don't touch the rest."
16058 (let ((n 0))
16059 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16061 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.3")
16063 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16064 "Difference between TIMESTAMP-STRING and now in days.
16065 If SECONDS is non-nil, return the difference in seconds."
16066 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16067 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16068 (funcall fdiff (current-time)))))
16070 (defun org-deadline-close (timestamp-string &optional ndays)
16071 "Is the time in TIMESTAMP-STRING close to the current date?"
16072 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16073 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16074 (not (org-entry-is-done-p))))
16076 (defun org-get-wdays (ts)
16077 "Get the deadline lead time appropriate for timestring TS."
16078 (cond
16079 ((<= org-deadline-warning-days 0)
16080 ;; 0 or negative, enforce this value no matter what
16081 (- org-deadline-warning-days))
16083 ;; lead time is specified.
16084 (floor (* (string-to-number (match-string 1 ts))
16085 (cdr (assoc (match-string 2 ts)
16086 '(("d" . 1) ("w" . 7)
16087 ("m" . 30.4) ("y" . 365.25)))))))
16088 ;; go for the default.
16089 (t org-deadline-warning-days)))
16091 (defun org-calendar-select-mouse (ev)
16092 "Return to `org-read-date' with the date currently selected.
16093 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16094 (interactive "e")
16095 (mouse-set-point ev)
16096 (when (calendar-cursor-to-date)
16097 (let* ((date (calendar-cursor-to-date))
16098 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16099 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16100 (if (active-minibuffer-window) (exit-minibuffer))))
16102 (defun org-check-deadlines (ndays)
16103 "Check if there are any deadlines due or past due.
16104 A deadline is considered due if it happens within `org-deadline-warning-days'
16105 days from today's date. If the deadline appears in an entry marked DONE,
16106 it is not shown. The prefix arg NDAYS can be used to test that many
16108 (interactive "P")
16109 (let* ((org-warn-days
16110 (cond
16111 ((equal ndays '(4)) 100000)
16112 (ndays (prefix-numeric-value ndays))
16113 (t (abs org-deadline-warning-days))))
16114 (case-fold-search nil)
16116 (callback
16117 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16119 (message "%d deadlines past-due or due within %d days"
16120 (org-occur regexp nil callback)
16121 org-warn-days)))
16123 (defsubst org-re-timestamp (type)
16124 "Return a regexp for timestamp TYPE.
16125 Allowed values for TYPE are:
16127 all: all timestamps
16128 active: only active timestamps (<...>)
16129 inactive: only inactive timestamps ([...])
16130 scheduled: only scheduled timestamps
16131 deadline: only deadline timestamps
16133 When TYPE is nil, fall back on returning a regexp that matches
16134 both scheduled and deadline timestamps."
16135 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16136 ((eq type 'active) org-ts-regexp)
16140 ((eq type 'scheduled-or-deadline)
16143 (defun org-check-before-date (date)
16144 "Check if there are deadlines or scheduled entries before DATE."
16145 (interactive (list (org-read-date)))
16146 (let ((case-fold-search nil)
16147 (regexp (org-re-timestamp org-ts-type))
16148 (callback
16149 (lambda () (time-less-p
16150 (org-time-string-to-time (match-string 1))
16151 (org-time-string-to-time date)))))
16152 (message "%d entries before %s"
16153 (org-occur regexp nil callback) date)))
16155 (defun org-check-after-date (date)
16156 "Check if there are deadlines or scheduled entries after DATE."
16157 (interactive (list (org-read-date)))
16158 (let ((case-fold-search nil)
16159 (regexp (org-re-timestamp org-ts-type))
16160 (callback
16161 (lambda () (not
16162 (time-less-p
16163 (org-time-string-to-time (match-string 1))
16164 (org-time-string-to-time date))))))
16165 (message "%d entries after %s"
16166 (org-occur regexp nil callback) date)))
16168 (defun org-check-dates-range (start-date end-date)
16169 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16170 (interactive (list (org-read-date nil nil nil "Range starts")
16171 (org-read-date nil nil nil "Range end")))
16172 (let ((case-fold-search nil)
16173 (regexp (org-re-timestamp org-ts-type))
16174 (callback
16175 (lambda ()
16176 (let ((match (match-string 1)))
16177 (and
16178 (not (time-less-p
16179 (org-time-string-to-time match)
16180 (org-time-string-to-time start-date)))
16181 (time-less-p
16182 (org-time-string-to-time match)
16183 (org-time-string-to-time end-date)))))))
16184 (message "%d entries between %s and %s"
16185 (org-occur regexp nil callback) start-date end-date)))
16187 (defun org-evaluate-time-range (&optional to-buffer)
16188 "Evaluate a time range by computing the difference between start and end.
16189 Normally the result is just printed in the echo area, but with prefix arg
16190 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16191 If the time range is actually in a table, the result is inserted into the
16192 next column.
16193 For time difference computation, a year is assumed to be exactly 365
16194 days in order to avoid rounding problems."
16195 (interactive "P")
16196 (or
16197 (org-clock-update-time-maybe)
16198 (save-excursion
16199 (unless (org-at-date-range-p t)
16200 (goto-char (point-at-bol))
16201 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16202 (if (not (org-at-date-range-p t))
16203 (error "Not at a time-stamp range, and none found in current line")))
16204 (let* ((ts1 (match-string 1))
16205 (ts2 (match-string 2))
16206 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16207 (match-end (match-end 0))
16208 (time1 (org-time-string-to-time ts1))
16209 (time2 (org-time-string-to-time ts2))
16210 (t1 (org-float-time time1))
16211 (t2 (org-float-time time2))
16212 (diff (abs (- t2 t1)))
16213 (negative (< (- t2 t1) 0))
16214 ;; (ys (floor (* 365 24 60 60)))
16215 (ds (* 24 60 60))
16216 (hs (* 60 60))
16217 (fy "%dy %dd %02d:%02d")
16218 (fy1 "%dy %dd")
16219 (fd "%dd %02d:%02d")
16220 (fd1 "%dd")
16221 (fh "%02d:%02d")
16222 y d h m align)
16223 (if havetime
16224 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16225 y 0
16226 d (floor (/ diff ds)) diff (mod diff ds)
16227 h (floor (/ diff hs)) diff (mod diff hs)
16228 m (floor (/ diff 60)))
16229 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16230 y 0
16231 d (floor (+ (/ diff ds) 0.5))
16232 h 0 m 0))
16233 (if (not to-buffer)
16234 (message "%s" (org-make-tdiff-string y d h m))
16235 (if (org-at-table-p)
16236 (progn
16237 (goto-char match-end)
16238 (setq align t)
16239 (and (looking-at " *|") (goto-char (match-end 0))))
16240 (goto-char match-end))
16241 (if (looking-at
16243 (replace-match ""))
16244 (if negative (insert " -"))
16245 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16246 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16247 (insert " " (format fh h m))))
16248 (if align (org-table-align))
16249 (message "Time difference inserted")))))
16251 (defun org-make-tdiff-string (y d h m)
16252 (let ((fmt "")
16253 (l nil))
16254 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16255 l (push y l)))
16256 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16257 l (push d l)))
16258 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16259 l (push h l)))
16260 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16261 l (push m l)))
16262 (apply 'format fmt (nreverse l))))
16264 (defun org-time-string-to-time (s &optional buffer pos)
16265 "Convert a timestamp string into internal time."
16266 (condition-case errdata
16267 (apply 'encode-time (org-parse-time-string s))
16269 s (if (not (and buffer pos))
16270 ""
16271 (format " at %d in buffer `%s'" pos buffer))
16272 (cdr errdata)))))
16274 (defun org-time-string-to-seconds (s)
16275 "Convert a timestamp string to a number of seconds."
16276 (org-float-time (org-time-string-to-time s)))
16278 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16279 "Convert a time stamp to an absolute day number.
16280 If there is a specifier for a cyclic time stamp, get the closest date to
16281 DAYNR.
16282 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16283 The variable date is bound by the calendar when this is called."
16284 (cond
16286 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16287 daynr
16288 (+ daynr 1000)))
16290 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16291 (time-to-days (current-time))) (match-string 0 s)
16292 prefer show-all))
16293 (t (time-to-days
16294 (condition-case errdata
16295 (apply 'encode-time (org-parse-time-string s))
16297 s (if (not (and buffer pos))
16298 ""
16299 (format " at %d in buffer `%s'" pos buffer))
16300 (cdr errdata))))))))
16302 (defun org-days-to-iso-week (days)
16303 "Return the iso week number."
16304 (require 'cal-iso)
16305 (car (calendar-iso-from-absolute days)))
16307 (defun org-small-year-to-year (year)
16308 "Convert 2-digit years into 4-digit years.
16309 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16310 The year 2000 cannot be abbreviated. Any year larger than 99
16311 is returned unchanged."
16312 (if (< year 38)
16313 (setq year (+ 2000 year))
16314 (if (< year 100)
16315 (setq year (+ 1900 year))))
16316 year)
16318 (defun org-time-from-absolute (d)
16319 "Return the time corresponding to date D.
16320 D may be an absolute day number, or a calendar-type list (month day year)."
16321 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16322 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16324 (defun org-calendar-holiday ()
16325 "List of holidays, for Diary display in Org-mode."
16326 (require 'holidays)
16327 (let ((hl (funcall
16328 (if (fboundp 'calendar-check-holidays)
16329 'calendar-check-holidays 'check-calendar-holidays) date)))
16330 (if hl (mapconcat 'identity hl "; "))))
16332 (defun org-diary-sexp-entry (sexp entry date)
16333 "Process a SEXP diary ENTRY for DATE."
16334 (require 'diary-lib)
16335 (let ((result (if calendar-debug-sexp
16336 (let ((stack-trace-on-error t))
16337 (eval (car (read-from-string sexp))))
16338 (condition-case nil
16339 (eval (car (read-from-string sexp)))
16340 (error
16341 (beep)
16342 (message "Bad sexp at line %d in %s: %s"
16343 (org-current-line)
16344 (buffer-file-name) sexp)
16345 (sleep-for 2))))))
16346 (cond ((stringp result) (split-string result "; "))
16347 ((and (consp result)
16348 (not (consp (cdr result)))
16349 (stringp (cdr result))) (cdr result))
16350 ((and (consp result)
16351 (stringp (car result))) result)
16352 (result entry))))
16354 (defun org-diary-to-ical-string (frombuf)
16355 "Get iCalendar entries from diary entries in buffer FROMBUF.
16356 This uses the icalendar.el library."
16357 (let* ((tmpdir (if (featurep 'xemacs)
16358 (temp-directory)
16359 temporary-file-directory))
16360 (tmpfile (make-temp-name
16361 (expand-file-name "orgics" tmpdir)))
16362 buf rtn b e)
16363 (with-current-buffer frombuf
16364 (icalendar-export-region (point-min) (point-max) tmpfile)
16365 (setq buf (find-buffer-visiting tmpfile))
16366 (set-buffer buf)
16367 (goto-char (point-min))
16368 (if (re-search-forward "^BEGIN:VEVENT" nil t)
16369 (setq b (match-beginning 0)))
16370 (goto-char (point-max))
16371 (if (re-search-backward "^END:VEVENT" nil t)
16372 (setq e (match-end 0)))
16374 (kill-buffer buf)
16375 (delete-file tmpfile)
16376 rtn))
16378 (defun org-closest-date (start current change prefer show-all)
16379 "Find the date closest to CURRENT that is consistent with START and CHANGE.
16380 When PREFER is `past', return a date that is either CURRENT or past.
16381 When PREFER is `future', return a date that is either CURRENT or future.
16382 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
16383 ;; Make the proper lists from the dates
16384 (catch 'exit
16385 (let ((a1 '(("h" . hour)
16386 ("d" . day)
16387 ("w" . week)
16388 ("m" . month)
16389 ("y" . year)))
16390 (shour (nth 2 (org-parse-time-string start)))
16391 dn dw sday cday n1 n2 n0
16392 d m y y1 y2 date1 date2 nmonths nm ny m2)
16394 (setq start (org-date-to-gregorian start)
16395 current (org-date-to-gregorian
16396 (if show-all
16397 current
16398 (time-to-days (current-time))))
16399 sday (calendar-absolute-from-gregorian start)
16400 cday (calendar-absolute-from-gregorian current))
16402 (if (<= cday sday) (throw 'exit sday))
16405 (setq dn (string-to-number (match-string 1 change))
16406 dw (cdr (assoc (match-string 2 change) a1)))
16407 (error "Invalid change specifier: %s" change))
16408 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16409 (cond
16410 ((eq dw 'hour)
16411 (let ((missing-hours
16412 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
16413 dn)))
16414 (setq n1 (if (zerop missing-hours) cday
16415 (- cday (1+ (floor (/ missing-hours 24)))))
16416 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
16417 ((eq dw 'day)
16418 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16419 n2 (+ n1 dn)))
16420 ((eq dw 'year)
16421 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16422 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16423 (setq date1 (list m d y1)
16424 n1 (calendar-absolute-from-gregorian date1)
16425 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16426 n2 (calendar-absolute-from-gregorian date2)))
16427 ((eq dw 'month)
16428 ;; approx number of month between the two dates
16429 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16430 ;; How often does dn fit in there?
16431 (setq d (nth 1 start) m (car start) y (nth 2 start)
16432 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16433 m (+ m nm)
16434 ny (floor (/ m 12))
16435 y (+ y ny)
16436 m (- m (* ny 12)))
16437 (while (> m 12) (setq m (- m 12) y (1+ y)))
16438 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16439 (setq m2 (+ m dn) y2 y)
16440 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16441 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16442 (while (<= n2 cday)
16443 (setq n1 n2 m m2 y y2)
16444 (setq m2 (+ m dn) y2 y)
16445 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16446 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
16447 ;; Make sure n1 is the earlier date
16448 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16449 (if show-all
16450 (cond
16451 ((eq prefer 'past) (if (= cday n2) n2 n1))
16452 ((eq prefer 'future) (if (= cday n1) n1 n2))
16453 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16454 (cond
16455 ((eq prefer 'past) (if (= cday n2) n2 n1))
16456 ((eq prefer 'future) (if (= cday n1) n1 n2))
16457 (t (if (= cday n1) n1 n2)))))))
16459 (defun org-date-to-gregorian (date)
16460 "Turn any specification of DATE into a Gregorian date for the calendar."
16461 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16462 ((and (listp date) (= (length date) 3)) date)
16463 ((stringp date)
16464 (setq date (org-parse-time-string date))
16465 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16466 ((listp date)
16467 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16469 (defun org-parse-time-string (s &optional nodefault)
16470 "Parse the standard Org-mode time string.
16471 This should be a lot faster than the normal `parse-time-string'.
16472 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16473 hour and minute fields will be nil if not given."
16474 (if (string-match org-ts-regexp0 s)
16475 (list 0
16476 (if (or (match-beginning 8) (not nodefault))
16477 (string-to-number (or (match-string 8 s) "0")))
16478 (if (or (match-beginning 7) (not nodefault))
16479 (string-to-number (or (match-string 7 s) "0")))
16480 (string-to-number (match-string 4 s))
16481 (string-to-number (match-string 3 s))
16482 (string-to-number (match-string 2 s))
16483 nil nil nil)
16484 (error "Not a standard Org-mode time string: %s" s)))
16486 (defun org-timestamp-up (&optional arg)
16487 "Increase the date item at the cursor by one.
16488 If the cursor is on the year, change the year. If it is on the month,
16489 the day or the time, change that.
16490 With prefix ARG, change by that many units."
16491 (interactive "p")
16492 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16494 (defun org-timestamp-down (&optional arg)
16495 "Decrease the date item at the cursor by one.
16496 If the cursor is on the year, change the year. If it is on the month,
16497 the day or the time, change that.
16498 With prefix ARG, change by that many units."
16499 (interactive "p")
16500 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16502 (defun org-timestamp-up-day (&optional arg)
16503 "Increase the date in the time stamp by one day.
16504 With prefix ARG, change that many days."
16505 (interactive "p")
16506 (if (and (not (org-at-timestamp-p t))
16507 (org-at-heading-p))
16508 (org-todo 'up)
16509 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16511 (defun org-timestamp-down-day (&optional arg)
16512 "Decrease the date in the time stamp by one day.
16513 With prefix ARG, change that many days."
16514 (interactive "p")
16515 (if (and (not (org-at-timestamp-p t))
16516 (org-at-heading-p))
16517 (org-todo 'down)
16518 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16520 (defun org-at-timestamp-p (&optional inactive-ok)
16521 "Determine if the cursor is in or at a timestamp."
16522 (interactive)
16523 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16524 (pos (point))
16525 (ans (or (looking-at tsr)
16526 (save-excursion
16528 (if (> (point) (point-min)) (backward-char 1))
16529 (and (looking-at tsr)
16530 (> (- (match-end 0) pos) -1))))))
16531 (and ans
16532 (boundp 'org-ts-what)
16533 (setq org-ts-what
16534 (cond
16535 ((= pos (match-beginning 0)) 'bracket)
16536 ;; Point is considered to be "on the bracket" whether
16537 ;; it's really on it or right after it.
16538 ((= pos (1- (match-end 0))) 'bracket)
16539 ((= pos (match-end 0)) 'after)
16540 ((org-pos-in-match-range pos 2) 'year)
16541 ((org-pos-in-match-range pos 3) 'month)
16542 ((org-pos-in-match-range pos 7) 'hour)
16543 ((org-pos-in-match-range pos 8) 'minute)
16544 ((or (org-pos-in-match-range pos 4)
16545 (org-pos-in-match-range pos 5)) 'day)
16546 ((and (> pos (or (match-end 8) (match-end 5)))
16547 (< pos (match-end 0)))
16548 (- pos (or (match-end 8) (match-end 5))))
16549 (t 'day))))
16550 ans))
16552 (defun org-toggle-timestamp-type ()
16553 "Toggle the type (<active> or [inactive]) of a time stamp."
16554 (interactive)
16555 (when (org-at-timestamp-p t)
16556 (let ((beg (match-beginning 0)) (end (match-end 0))
16557 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16558 (save-excursion
16559 (goto-char beg)
16560 (while (re-search-forward "[][<>]" end t)
16561 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16562 t t)))
16563 (message "Timestamp is now %sactive"
16564 (if (equal (char-after beg) ?<) "" "in")))))
16566 (defvar org-clock-history) ; defined in org-clock.el
16567 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
16568 (defun org-timestamp-change (n &optional what updown)
16569 "Change the date in the time stamp at point.
16570 The date will be changed by N times WHAT. WHAT can be `day', `month',
16571 `year', `minute', `second'. If WHAT is not given, the cursor position
16572 in the timestamp determines what will be changed."
16573 (let ((origin (point)) origin-cat
16574 with-hm inactive
16575 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16576 org-ts-what
16577 extra rem
16578 ts time time0 fixnext clrgx)
16579 (if (not (org-at-timestamp-p t))
16580 (error "Not at a timestamp"))
16581 (if (and (not what) (eq org-ts-what 'bracket))
16582 (org-toggle-timestamp-type)
16583 ;; Point isn't on brackets. Remember the part of the time-stamp
16584 ;; the point was in. Indeed, size of time-stamps may change,
16585 ;; but point must be kept in the same category nonetheless.
16586 (setq origin-cat org-ts-what)
16587 (if (and (not what) (not (eq org-ts-what 'day))
16588 org-display-custom-times
16589 (get-text-property (point) 'display)
16590 (not (get-text-property (1- (point)) 'display)))
16591 (setq org-ts-what 'day))
16592 (setq org-ts-what (or what org-ts-what)
16593 inactive (= (char-after (match-beginning 0)) ?\[)
16594 ts (match-string 0))
16595 (replace-match "")
16596 (if (string-match
16598 ts)
16599 (setq extra (match-string 1 ts)))
16601 (setq with-hm t))
16602 (setq time0 (org-parse-time-string ts))
16603 (when (and updown
16604 (eq org-ts-what 'minute)
16605 (not current-prefix-arg))
16606 ;; This looks like s-up and s-down. Change by one rounding step.
16607 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16608 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16609 (setcar (cdr time0) (+ (nth 1 time0)
16610 (if (> n 0) (- rem) (- dm rem))))))
16611 (setq time
16612 (encode-time (or (car time0) 0)
16613 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16614 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16615 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16616 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16617 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16618 (nthcdr 6 time0)))
16619 (when (and (member org-ts-what '(hour minute))
16620 extra
16622 (setq extra (org-modify-ts-extra
16623 extra
16624 (if (eq org-ts-what 'hour) 2 5)
16625 n dm)))
16626 (when (integerp org-ts-what)
16627 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16628 (if (eq what 'calendar)
16629 (let ((cal-date (org-get-date-from-calendar)))
16630 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16631 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16632 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16633 (setcar time0 (or (car time0) 0))
16634 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16635 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16636 (setq time (apply 'encode-time time0))))
16637 ;; Insert the new time-stamp, and ensure point stays in the same
16638 ;; category as before (i.e. not after the last position in that
16639 ;; category).
16640 (let ((pos (point)))
16641 ;; Stay before inserted string. `save-excursion' is of no use.
16642 (setq org-last-changed-timestamp
16643 (org-insert-time-stamp time with-hm inactive nil nil extra))
16644 (goto-char pos))
16645 (save-match-data
16646 (looking-at org-ts-regexp3)
16647 (goto-char (cond
16648 ;; `day' category ends before `hour' if any, or at
16649 ;; the end of the day name.
16650 ((eq origin-cat 'day)
16651 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16652 ((eq origin-cat 'hour) (min (match-end 7) origin))
16653 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16654 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16655 ;; `year' and `month' have both fixed size: point
16656 ;; couldn't have moved into another part.
16657 (t origin))))
16658 ;; Update clock if on a CLOCK line.
16659 (org-clock-update-time-maybe)
16660 ;; Maybe adjust the closest clock in `org-clock-history'
16661 (when org-clock-adjust-closest
16662 (if (not (and (org-at-clock-log-p)
16663 (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
16664 org-clock-history))))))
16665 (message "No clock to adjust")
16666 (cond ((save-excursion ; fix previous clock?
16667 (re-search-backward org-ts-regexp0 nil t)
16670 ((save-excursion ; fix next clock?
16671 (re-search-backward org-ts-regexp0 nil t)
16674 (save-window-excursion
16675 ;; Find closest clock to point, adjust the previous/next one in history
16676 (let* ((p (save-excursion (org-back-to-heading t)))
16677 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
16678 (clfixnth
16679 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
16680 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
16681 (if (not clfixpos)
16682 (message "No clock to adjust")
16683 (save-excursion
16684 (org-goto-marker-or-bmk clfixpos)
16685 (org-show-subtree)
16686 (when (re-search-forward clrgx nil t)
16687 (goto-char (match-beginning 1))
16688 (let (org-clock-adjust-closest)
16689 (org-timestamp-change n org-ts-what updown))
16690 (message "Clock adjusted in %s for heading: %s"
16691 (file-name-nondirectory (buffer-file-name))
16692 (org-get-heading t t)))))))))
16693 ;; Try to recenter the calendar window, if any.
16694 (if (and org-calendar-follow-timestamp-change
16695 (get-buffer-window "*Calendar*" t)
16696 (memq org-ts-what '(day month year)))
16697 (org-recenter-calendar (time-to-days time))))))
16699 (defun org-modify-ts-extra (s pos n dm)
16700 "Change the different parts of the lead-time and repeat fields in timestamp."
16701 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16702 ng h m new rem)
16703 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16704 (cond
16705 ((or (org-pos-in-match-range pos 2)
16706 (org-pos-in-match-range pos 3))
16707 (setq m (string-to-number (match-string 3 s))
16708 h (string-to-number (match-string 2 s)))
16709 (if (org-pos-in-match-range pos 2)
16710 (setq h (+ h n))
16711 (setq n (* dm (org-no-warnings (signum n))))
16712 (when (not (= 0 (setq rem (% m dm))))
16713 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16714 (setq m (+ m n)))
16715 (if (< m 0) (setq m (+ m 60) h (1- h)))
16716 (if (> m 59) (setq m (- m 60) h (1+ h)))
16717 (setq h (min 24 (max 0 h)))
16718 (setq ng 1 new (format "-%02d:%02d" h m)))
16719 ((org-pos-in-match-range pos 6)
16720 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16721 ((org-pos-in-match-range pos 5)
16722 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16724 ((org-pos-in-match-range pos 9)
16725 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16726 ((org-pos-in-match-range pos 8)
16727 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16729 (when ng
16730 (setq s (concat
16731 (substring s 0 (match-beginning ng))
16732 new
16733 (substring s (match-end ng))))))
16734 s))
16736 (defun org-recenter-calendar (date)
16737 "If the calendar is visible, recenter it to DATE."
16738 (let ((cwin (get-buffer-window "*Calendar*" t)))
16739 (when cwin
16740 (let ((calendar-move-hook nil))
16741 (with-selected-window cwin
16742 (calendar-goto-date (if (listp date) date
16743 (calendar-gregorian-from-absolute date))))))))
16745 (defun org-goto-calendar (&optional arg)
16746 "Go to the Emacs calendar at the current date.
16747 If there is a time stamp in the current line, go to that date.
16748 A prefix ARG can be used to force the current date."
16749 (interactive "P")
16750 (let ((tsr org-ts-regexp) diff
16751 (calendar-move-hook nil)
16752 (calendar-view-holidays-initially-flag nil)
16753 (calendar-view-diary-initially-flag nil))
16754 (if (or (org-at-timestamp-p)
16755 (save-excursion
16756 (beginning-of-line 1)
16757 (looking-at (concat ".*" tsr))))
16758 (let ((d1 (time-to-days (current-time)))
16759 (d2 (time-to-days
16760 (org-time-string-to-time (match-string 1)))))
16761 (setq diff (- d2 d1))))
16762 (calendar)
16763 (calendar-goto-today)
16764 (if (and diff (not arg)) (calendar-forward-day diff))))
16766 (defun org-get-date-from-calendar ()
16767 "Return a list (month day year) of date at point in calendar."
16768 (with-current-buffer "*Calendar*"
16769 (save-match-data
16770 (calendar-cursor-to-date))))
16772 (defun org-date-from-calendar ()
16773 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16774 If there is already a time stamp at the cursor position, update it."
16775 (interactive)
16776 (if (org-at-timestamp-p t)
16777 (org-timestamp-change 0 'calendar)
16778 (let ((cal-date (org-get-date-from-calendar)))
16779 (org-insert-time-stamp
16780 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16782 (defun org-minutes-to-clocksum-string (m)
16783 "Format number of minutes as a clocksum string.
16784 The format is determined by `org-time-clocksum-format',
16785 `org-time-clocksum-use-fractional' and
16786 `org-time-clocksum-fractional-format'."
16787 (let ((clocksum "") fmt n)
16788 ;; fractional format
16789 (if org-time-clocksum-use-fractional
16790 (cond
16791 ;; single format string
16792 ((stringp org-time-clocksum-fractional-format)
16793 (format org-time-clocksum-fractional-format (/ m 60.0)))
16794 ;; choice of fractional formats for different time units
16795 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
16796 (> (/ (truncate m) (* 365 24 60)) 0))
16797 (format fmt (/ m (* 365 24 60.0))))
16798 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
16799 (> (/ (truncate m) (* 30 24 60)) 0))
16800 (format fmt (/ m (* 30 24 60.0))))
16801 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
16802 (> (/ (truncate m) (* 7 24 60)) 0))
16803 (format fmt (/ m (* 7 24 60.0))))
16804 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
16805 (> (/ (truncate m) (* 24 60)) 0))
16806 (format fmt (/ m (* 24 60.0))))
16807 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
16808 (> (/ (truncate m) 60) 0))
16809 (format fmt (/ m 60.0)))
16810 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
16811 (format fmt m))
16812 ;; fall back to smallest time unit with a format
16813 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
16814 (format fmt (/ m 60.0)))
16815 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
16816 (format fmt (/ m (* 24 60.0))))
16817 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
16818 (format fmt (/ m (* 7 24 60.0))))
16819 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
16820 (format fmt (/ m (* 30 24 60.0))))
16821 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
16822 (format fmt (/ m (* 365 24 60.0)))))
16823 ;; standard (non-fractional) format, with single format string
16824 (if (stringp org-time-clocksum-format)
16825 (format org-time-clocksum-format (setq n (/ m 60)) (- m (* 60 n)))
16826 ;; separate formats components
16827 (and (setq fmt (plist-get org-time-clocksum-format :years))
16828 (or (> (setq n (/ (truncate m) (* 365 24 60))) 0)
16829 (plist-get org-time-clocksum-format :require-years))
16830 (setq clocksum (concat clocksum (format fmt n))
16831 m (- m (* n 365 24 60))))
16832 (and (setq fmt (plist-get org-time-clocksum-format :months))
16833 (or (> (setq n (/ (truncate m) (* 30 24 60))) 0)
16834 (plist-get org-time-clocksum-format :require-months))
16835 (setq clocksum (concat clocksum (format fmt n))
16836 m (- m (* n 30 24 60))))
16837 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
16838 (or (> (setq n (/ (truncate m) (* 7 24 60))) 0)
16839 (plist-get org-time-clocksum-format :require-weeks))
16840 (setq clocksum (concat clocksum (format fmt n))
16841 m (- m (* n 7 24 60))))
16842 (and (setq fmt (plist-get org-time-clocksum-format :days))
16843 (or (> (setq n (/ (truncate m) (* 24 60))) 0)
16844 (plist-get org-time-clocksum-format :require-days))
16845 (setq clocksum (concat clocksum (format fmt n))
16846 m (- m (* n 24 60))))
16847 (and (setq fmt (plist-get org-time-clocksum-format :hours))
16848 (or (> (setq n (/ (truncate m) 60)) 0)
16849 (plist-get org-time-clocksum-format :require-hours))
16850 (setq clocksum (concat clocksum (format fmt n))
16851 m (- m (* n 60))))
16852 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
16853 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
16854 (setq clocksum (concat clocksum (format fmt m))))
16855 ;; return formatted time duration
16856 clocksum))))
16858 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
16859 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
16860 "Org mode version 8.0")
16862 (defun org-hours-to-clocksum-string (n)
16863 (org-minutes-to-clocksum-string (* n 60)))
16865 (defun org-hh:mm-string-to-minutes (s)
16866 "Convert a string H:MM to a number of minutes.
16867 If the string is just a number, interpret it as minutes.
16868 In fact, the first hh:mm or number in the string will be taken,
16869 there can be extra stuff in the string.
16870 If no number is found, the return value is 0."
16871 (cond
16872 ((integerp s) s)
16874 (+ (* (string-to-number (match-string 1 s)) 60)
16875 (string-to-number (match-string 2 s))))
16877 (string-to-number (match-string 1 s)))
16878 (t 0)))
16880 (defcustom org-effort-durations
16881 `(("h" . 60)
16882 ("d" . ,(* 60 8))
16883 ("w" . ,(* 60 8 5))
16884 ("m" . ,(* 60 8 5 4))
16885 ("y" . ,(* 60 8 5 40)))
16886 "Conversion factor to minutes for an effort modifier.
16888 Each entry has the form (MODIFIER . MINUTES).
16890 In an effort string, a number followed by MODIFIER is multiplied
16891 by the specified number of MINUTES to obtain an effort in
16892 minutes.
16896 :group 'org-agenda
16897 :version "24.1"
16898 :type '(alist :key-type (string :tag "Modifier")
16899 :value-type (number :tag "Minutes")))
16901 (defcustom org-image-actual-width t
16902 "Should we use the actual width of images when inlining them?
16904 When set to `t', always use the image width.
16906 When set to a number, use imagemagick (when available) to set
16907 the image's width to this value.
16909 When set to a number in a list, try to get the width from the
16910 #+ATTR.* keyword if it matches a width specification like
16913 When set to nil, try to get the width from an #+ATTR.* keyword
16914 and fall back on the original width if none is found.
16916 This requires Emacs >= 24.1, build with imagemagick support."
16917 :group 'org-appearance
16918 :version "24.3"
16919 :type '(choice
16920 (const :tag "Use the image width" t)
16921 (integer :tag "Use a number of pixels")
16922 (list :tag "Use #+ATTR* or a number of pixels" (integer))
16923 (const :tag "Use #+ATTR* or don't resize" nil)))
16925 (defun org-duration-string-to-minutes (s &optional output-to-string)
16926 "Convert a duration string S to minutes.
16928 A bare number is interpreted as minutes, modifiers can be set by
16929 customizing `org-effort-durations' (which see).
16931 Entries containing a colon are interpreted as H:MM by
16932 `org-hh:mm-string-to-minutes'."
16933 (let ((result 0)
16935 (regexp-opt (mapcar 'car org-effort-durations))
16937 (while (string-match re s)
16938 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16939 (string-to-number (match-string 1 s))))
16940 (setq s (replace-match "" nil t s)))
16941 (setq result (floor result))
16942 (incf result (org-hh:mm-string-to-minutes s))
16943 (if output-to-string (number-to-string result) result)))
16945 ;;;; Files
16947 (defun org-save-all-org-buffers ()
16948 "Save all Org-mode buffers without user confirmation."
16949 (interactive)
16950 (message "Saving all Org-mode buffers...")
16951 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
16952 (when (featurep 'org-id) (org-id-locations-save))
16953 (message "Saving all Org-mode buffers... done"))
16955 (defun org-revert-all-org-buffers ()
16956 "Revert all Org-mode buffers.
16957 Prompt for confirmation when there are unsaved changes.
16958 Be sure you know what you are doing before letting this function
16959 overwrite your changes.
16961 This function is useful in a setup where one tracks org files
16962 with a version control system, to revert on one machine after pulling
16963 changes from another. I believe the procedure must be like this:
16965 1. M-x org-save-all-org-buffers
16966 2. Pull changes from the other machine, resolve conflicts
16967 3. M-x org-revert-all-org-buffers"
16968 (interactive)
16969 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16970 (error "Abort"))
16971 (save-excursion
16972 (save-window-excursion
16973 (mapc
16974 (lambda (b)
16975 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
16976 (with-current-buffer b buffer-file-name))
16977 (org-pop-to-buffer-same-window b)
16978 (revert-buffer t 'no-confirm)))
16979 (buffer-list))
16980 (when (and (featurep 'org-id) org-id-track-globally)
16981 (org-id-locations-load)))))
16983 ;;;; Agenda files
16985 ;;;###autoload
16986 (defun org-switchb (&optional arg)
16987 "Switch between Org buffers.
16988 With one prefix argument, restrict available buffers to files.
16989 With two prefix arguments, restrict available buffers to agenda files.
16991 Defaults to `iswitchb' for buffer name completion.
16992 Set `org-completion-use-ido' to make it use ido instead."
16993 (interactive "P")
16994 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16995 ((equal arg '(16)) (org-buffer-list 'agenda))
16996 (t (org-buffer-list))))
16997 (org-completion-use-iswitchb org-completion-use-iswitchb)
16998 (org-completion-use-ido org-completion-use-ido))
16999 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17000 (setq org-completion-use-iswitchb t))
17001 (org-pop-to-buffer-same-window
17002 (org-icompleting-read "Org buffer: "
17003 (mapcar 'list (mapcar 'buffer-name blist))
17004 nil t))))
17006 ;;; Define some older names previously used for this functionality
17007 ;;;###autoload
17008 (defalias 'org-ido-switchb 'org-switchb)
17009 ;;;###autoload
17010 (defalias 'org-iswitchb 'org-switchb)
17012 (defun org-buffer-list (&optional predicate exclude-tmp)
17013 "Return a list of Org buffers.
17014 PREDICATE can be `export', `files' or `agenda'.
17016 export restrict the list to Export buffers.
17017 files restrict the list to buffers visiting Org files.
17018 agenda restrict the list to buffers visiting agenda files.
17020 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17021 (let* ((bfn nil)
17022 (agenda-files (and (eq predicate 'agenda)
17023 (mapcar 'file-truename (org-agenda-files t))))
17024 (filter
17025 (cond
17026 ((eq predicate 'files)
17027 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17028 ((eq predicate 'export)
17029 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17030 ((eq predicate 'agenda)
17031 (lambda (b)
17032 (with-current-buffer b
17033 (and (derived-mode-p 'org-mode)
17034 (setq bfn (buffer-file-name b))
17035 (member (file-truename bfn) agenda-files)))))
17036 (t (lambda (b) (with-current-buffer b
17037 (or (derived-mode-p 'org-mode)
17038 (string-match "\*Org .*Export"
17039 (buffer-name b)))))))))
17040 (delq nil
17041 (mapcar
17042 (lambda(b)
17043 (if (and (funcall filter b)
17044 (or (not exclude-tmp)
17045 (not (string-match "tmp" (buffer-name b)))))
17046 b
17047 nil))
17048 (buffer-list)))))
17050 (defun org-agenda-files (&optional unrestricted archives)
17051 "Get the list of agenda files.
17052 Optional UNRESTRICTED means return the full list even if a restriction
17053 is currently in place.
17054 When ARCHIVES is t, include all archive files that are really being
17055 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17056 `org-agenda-archives-mode' is t."
17057 (let ((files
17058 (cond
17059 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17060 ((stringp org-agenda-files) (org-read-agenda-file-list))
17061 ((listp org-agenda-files) org-agenda-files)
17062 (t (error "Invalid value of `org-agenda-files'")))))
17063 (setq files (apply 'append
17064 (mapcar (lambda (f)
17065 (if (file-directory-p f)
17066 (directory-files
17067 f t org-agenda-file-regexp)
17068 (list f)))
17069 files)))
17070 (when org-agenda-skip-unavailable-files
17071 (setq files (delq nil
17072 (mapcar (function
17073 (lambda (file)
17074 (and (file-readable-p file) file)))
17075 files))))
17076 (when (or (eq archives t)
17077 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17078 (setq files (org-add-archive-files files)))
17079 files))
17081 (defun org-agenda-file-p (&optional file)
17082 "Return non-nil, if FILE is an agenda file.
17083 If FILE is omitted, use the file associated with the current
17084 buffer."
17085 (member (or file (buffer-file-name))
17086 (org-agenda-files t)))
17088 (defun org-edit-agenda-file-list ()
17089 "Edit the list of agenda files.
17090 Depending on setup, this either uses customize to edit the variable
17091 `org-agenda-files', or it visits the file that is holding the list. In the
17092 latter case, the buffer is set up in a way that saving it automatically kills
17093 the buffer and restores the previous window configuration."
17094 (interactive)
17095 (if (stringp org-agenda-files)
17096 (let ((cw (current-window-configuration)))
17097 (find-file org-agenda-files)
17098 (org-set-local 'org-window-configuration cw)
17099 (org-add-hook 'after-save-hook
17100 (lambda ()
17101 (set-window-configuration
17102 (prog1 org-window-configuration
17103 (kill-buffer (current-buffer))))
17104 (org-install-agenda-files-menu)
17105 (message "New agenda file list installed"))
17106 nil 'local)
17107 (message "%s" (substitute-command-keys
17109 (customize-variable 'org-agenda-files)))
17111 (defun org-store-new-agenda-file-list (list)
17112 "Set new value for the agenda file list and save it correctly."
17113 (if (stringp org-agenda-files)
17114 (let ((fe (org-read-agenda-file-list t)) b u)
17115 (while (setq b (find-buffer-visiting org-agenda-files))
17116 (kill-buffer b))
17117 (with-temp-file org-agenda-files
17118 (insert
17119 (mapconcat
17120 (lambda (f) ;; Keep un-expanded entries.
17121 (if (setq u (assoc f fe))
17122 (cdr u)
17123 f))
17126 (let ((org-mode-hook nil) (org-inhibit-startup t)
17127 (org-insert-mode-line-in-empty-file nil))
17128 (setq org-agenda-files list)
17129 (customize-save-variable 'org-agenda-files org-agenda-files))))
17131 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17132 "Read the list of agenda files from a file.
17133 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17134 filenames, used by `org-store-new-agenda-file-list' to write back
17135 un-expanded file names."
17136 (when (file-directory-p org-agenda-files)
17137 (error "`org-agenda-files' cannot be a single directory"))
17138 (when (stringp org-agenda-files)
17139 (with-temp-buffer
17140 (insert-file-contents org-agenda-files)
17141 (mapcar
17142 (lambda (f)
17143 (let ((e (expand-file-name (substitute-in-file-name f)
17144 org-directory)))
17145 (if pair-with-expansion
17146 (cons e f)
17147 e)))
17150 ;;;###autoload
17151 (defun org-cycle-agenda-files ()
17152 "Cycle through the files in `org-agenda-files'.
17153 If the current buffer visits an agenda file, find the next one in the list.
17154 If the current buffer does not, find the first agenda file."
17155 (interactive)
17156 (let* ((fs (org-agenda-files t))
17157 (files (append fs (list (car fs))))
17158 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17159 file)
17160 (unless files (error "No agenda files"))
17161 (catch 'exit
17162 (while (setq file (pop files))
17163 (if (equal (file-truename file) tcf)
17164 (when (car files)
17165 (find-file (car files))
17166 (throw 'exit t))))
17167 (find-file (car fs)))
17168 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17170 (defun org-agenda-file-to-front (&optional to-end)
17171 "Move/add the current file to the top of the agenda file list.
17172 If the file is not present in the list, it is added to the front. If it is
17173 present, it is moved there. With optional argument TO-END, add/move to the
17174 end of the list."
17175 (interactive "P")
17176 (let ((org-agenda-skip-unavailable-files nil)
17177 (file-alist (mapcar (lambda (x)
17178 (cons (file-truename x) x))
17179 (org-agenda-files t)))
17180 (ctf (file-truename
17181 (or buffer-file-name
17182 (error "Please save the current buffer to a file"))))
17183 x had)
17184 (setq x (assoc ctf file-alist) had x)
17186 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17187 (if to-end
17188 (setq file-alist (append (delq x file-alist) (list x)))
17189 (setq file-alist (cons x (delq x file-alist))))
17190 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17191 (org-install-agenda-files-menu)
17192 (message "File %s to %s of agenda file list"
17193 (if had "moved" "added") (if to-end "end" "front"))))
17195 (defun org-remove-file (&optional file)
17196 "Remove current file from the list of files in variable `org-agenda-files'.
17197 These are the files which are being checked for agenda entries.
17198 Optional argument FILE means use this file instead of the current."
17199 (interactive)
17200 (let* ((org-agenda-skip-unavailable-files nil)
17201 (file (or file buffer-file-name
17202 (error "Current buffer does not visit a file")))
17203 (true-file (file-truename file))
17204 (afile (abbreviate-file-name file))
17205 (files (delq nil (mapcar
17206 (lambda (x)
17207 (if (equal true-file
17208 (file-truename x))
17209 nil x))
17210 (org-agenda-files t)))))
17211 (if (not (= (length files) (length (org-agenda-files t))))
17212 (progn
17213 (org-store-new-agenda-file-list files)
17214 (org-install-agenda-files-menu)
17215 (message "Removed file: %s" afile))
17216 (message "File was not in list: %s (not removed)" afile))))
17218 (defun org-file-menu-entry (file)
17219 (vector file (list 'find-file file) t))
17221 (defun org-check-agenda-file (file)
17222 "Make sure FILE exists. If not, ask user what to do."
17223 (when (not (file-exists-p file))
17224 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17225 (abbreviate-file-name file))
17226 (let ((r (downcase (read-char-exclusive))))
17227 (cond
17228 ((equal r ?r)
17229 (org-remove-file file)
17230 (throw 'nextfile t))
17231 (t (error "Abort"))))))
17233 (defun org-get-agenda-file-buffer (file)
17234 "Get a buffer visiting FILE. If the buffer needs to be created, add
17235 it to the list of buffers which might be released later."
17236 (let ((buf (org-find-base-buffer-visiting file)))
17237 (if buf
17238 buf ; just return it
17239 ;; Make a new buffer and remember it
17240 (setq buf (find-file-noselect file))
17241 (if buf (push buf org-agenda-new-buffers))
17242 buf)))
17244 (defun org-release-buffers (blist)
17245 "Release all buffers in list, asking the user for confirmation when needed.
17246 When a buffer is unmodified, it is just killed. When modified, it is saved
17247 \(if the user agrees) and then killed."
17248 (let (buf file)
17249 (while (setq buf (pop blist))
17250 (setq file (buffer-file-name buf))
17251 (when (and (buffer-modified-p buf)
17252 file
17253 (y-or-n-p (format "Save file %s? " file)))
17254 (with-current-buffer buf (save-buffer)))
17255 (kill-buffer buf))))
17257 (defun org-agenda-prepare-buffers (files)
17258 "Create buffers for all agenda files, protect archived trees and comments."
17259 (interactive)
17260 (let ((pa '(:org-archived t))
17261 (pc '(:org-comment t))
17262 (pall '(:org-archived t :org-comment t))
17263 (inhibit-read-only t)
17264 (rea (concat ":" org-archive-tag ":"))
17265 bmp file re)
17266 (save-excursion
17267 (save-restriction
17268 (while (setq file (pop files))
17269 (catch 'nextfile
17270 (if (bufferp file)
17271 (set-buffer file)
17272 (org-check-agenda-file file)
17273 (set-buffer (org-get-agenda-file-buffer file)))
17274 (widen)
17275 (setq bmp (buffer-modified-p))
17276 (org-refresh-category-properties)
17277 (setq org-todo-keywords-for-agenda
17278 (append org-todo-keywords-for-agenda org-todo-keywords-1))
17279 (setq org-done-keywords-for-agenda
17280 (append org-done-keywords-for-agenda org-done-keywords))
17281 (setq org-todo-keyword-alist-for-agenda
17282 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
17283 (setq org-drawers-for-agenda
17284 (append org-drawers-for-agenda org-drawers))
17285 (setq org-tag-alist-for-agenda
17286 (append org-tag-alist-for-agenda org-tag-alist))
17288 (save-excursion
17289 (remove-text-properties (point-min) (point-max) pall)
17290 (when org-agenda-skip-archived-trees
17291 (goto-char (point-min))
17292 (while (re-search-forward rea nil t)
17293 (if (org-at-heading-p t)
17294 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
17295 (goto-char (point-min))
17296 (setq re (format org-heading-keyword-regexp-format
17297 org-comment-string))
17298 (while (re-search-forward re nil t)
17299 (add-text-properties
17300 (match-beginning 0) (org-end-of-subtree t) pc)))
17301 (set-buffer-modified-p bmp)))))
17302 (setq org-todo-keywords-for-agenda
17303 (org-uniquify org-todo-keywords-for-agenda))
17304 (setq org-todo-keyword-alist-for-agenda
17305 (org-uniquify org-todo-keyword-alist-for-agenda)
17306 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
17308 ;;;; Embedded LaTeX
17310 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17311 "Keymap for the minor `org-cdlatex-mode'.")
17313 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
17314 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
17315 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
17316 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
17317 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
17319 (defvar org-cdlatex-texmathp-advice-is-done nil
17320 "Flag remembering if we have applied the advice to texmathp already.")
17322 (define-minor-mode org-cdlatex-mode
17323 "Toggle the minor `org-cdlatex-mode'.
17324 This mode supports entering LaTeX environment and math in LaTeX fragments
17325 in Org-mode.
17327 nil " OCDL" nil
17328 (when org-cdlatex-mode
17329 (require 'cdlatex)
17330 (run-hooks 'cdlatex-mode-hook)
17331 (cdlatex-compute-tables))
17332 (unless org-cdlatex-texmathp-advice-is-done
17333 (setq org-cdlatex-texmathp-advice-is-done t)
17334 (defadvice texmathp (around org-math-always-on activate)
17335 "Always return t in org-mode buffers.
17336 This is because we want to insert math symbols without dollars even outside
17337 the LaTeX math segments. If Orgmode thinks that point is actually inside
17338 an embedded LaTeX fragment, let texmathp do its job.
17340 (interactive)
17341 (let (p)
17342 (cond
17343 ((not (derived-mode-p 'org-mode)) ad-do-it)
17344 ((eq this-command 'cdlatex-math-symbol)
17345 (setq ad-return-value t
17346 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
17347 (t
17348 (let ((p (org-inside-LaTeX-fragment-p)))
17349 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
17350 (setq ad-return-value t
17351 texmathp-why '("Org-mode embedded math" . 0))
17352 (if p ad-do-it)))))))))
17354 (defun turn-on-org-cdlatex ()
17355 "Unconditionally turn on `org-cdlatex-mode'."
17356 (org-cdlatex-mode 1))
17358 (defun org-inside-LaTeX-fragment-p ()
17359 "Test if point is inside a LaTeX fragment.
17361 sequence appearing also before point.
17362 Even though the matchers for math are configurable, this function assumes
17364 delimiters are skipped when they have been removed by customization.
17365 The return value is nil, or a cons cell with the delimiter and the
17366 position of this delimiter.
17368 This function does a reasonably good job, but can locally be fooled by
17369 for example currency specifications. For example it will assume being in
17371 fragments that are properly closed, but during editing, we have to live
17372 with the uncertainty caused by missing closing delimiters. This function
17373 looks only before point, not after."
17374 (catch 'exit
17375 (let ((pos (point))
17376 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
17377 (lim (progn
17379 (point)))
17380 dd-on str (start 0) m re)
17381 (goto-char pos)
17382 (when dodollar
17384 re (nth 1 (assoc "$" org-latex-regexps)))
17385 (while (string-match re str start)
17386 (cond
17387 ((= (match-end 0) (length str))
17388 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
17389 ((= (match-end 0) (- (length str) 5))
17390 (throw 'exit nil))
17391 (t (setq start (match-end 0))))))
17392 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17393 (goto-char pos)
17394 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
17395 (and (match-beginning 2) (throw 'exit nil))
17396 ;; count $$
17398 (setq dd-on (not dd-on)))
17399 (goto-char pos)
17400 (if dd-on (cons "$$" m))))))
17402 (defun org-inside-latex-macro-p ()
17403 "Is point inside a LaTeX macro or its arguments?"
17404 (save-match-data
17405 (org-in-regexp
17408 (defun org-try-cdlatex-tab ()
17409 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17410 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17411 - inside a LaTeX fragment, or
17412 - after the first word in a line, where an abbreviation expansion could
17413 insert a LaTeX environment."
17414 (when org-cdlatex-mode
17415 (cond
17416 ;; Before any word on the line: No expansion possible.
17418 ;; Just after first word on the line: Expand it. Make sure it
17419 ;; cannot happen on headlines, though.
17420 ((save-excursion
17421 (skip-chars-backward "a-zA-Z0-9*")
17423 (and (bolp) (not (org-at-heading-p))))
17424 (cdlatex-tab) t)
17425 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
17427 (defun org-cdlatex-underscore-caret (&optional arg)
17428 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17429 Revert to the normal definition outside of these fragments."
17430 (interactive "P")
17431 (if (org-inside-LaTeX-fragment-p)
17432 (call-interactively 'cdlatex-sub-superscript)
17433 (let (org-cdlatex-mode)
17434 (call-interactively (key-binding (vector last-input-event))))))
17436 (defun org-cdlatex-math-modify (&optional arg)
17437 "Execute `cdlatex-math-modify' in LaTeX fragments.
17438 Revert to the normal definition outside of these fragments."
17439 (interactive "P")
17440 (if (org-inside-LaTeX-fragment-p)
17441 (call-interactively 'cdlatex-math-modify)
17442 (let (org-cdlatex-mode)
17443 (call-interactively (key-binding (vector last-input-event))))))
17445 (defvar org-latex-fragment-image-overlays nil
17446 "List of overlays carrying the images of latex fragments.")
17447 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
17449 (defun org-remove-latex-fragment-image-overlays ()
17450 "Remove all overlays with LaTeX fragment images in current buffer."
17451 (mapc 'delete-overlay org-latex-fragment-image-overlays)
17452 (setq org-latex-fragment-image-overlays nil))
17454 (defun org-preview-latex-fragment (&optional subtree)
17455 "Preview the LaTeX fragment at point, or all locally or globally.
17456 If the cursor is in a LaTeX fragment, create the image and overlay
17457 it over the source code. If there is no fragment at point, display
17458 all fragments in the current text, from one headline to the next. With
17459 prefix SUBTREE, display all fragments in the current subtree. With a
17461 the cursor is before the first headline,
17462 display all fragments in the buffer.
17464 (interactive "P")
17465 (unless buffer-file-name
17466 (error "Can't preview LaTeX fragment in a non-file buffer"))
17467 (org-remove-latex-fragment-image-overlays)
17468 (save-excursion
17469 (save-restriction
17470 (let (beg end at msg)
17471 (cond
17472 ((or (equal subtree '(16))
17473 (not (save-excursion
17474 (re-search-backward org-outline-regexp-bol nil t))))
17475 (setq beg (point-min) end (point-max)
17476 msg "Creating images for buffer...%s"))
17477 ((equal subtree '(4))
17478 (org-back-to-heading)
17479 (setq beg (point) end (org-end-of-subtree t)
17480 msg "Creating images for subtree...%s"))
17481 (t
17482 (if (setq at (org-inside-LaTeX-fragment-p))
17483 (goto-char (max (point-min) (- (cdr at) 2)))
17484 (org-back-to-heading))
17485 (setq beg (point) end (progn (outline-next-heading) (point))
17486 msg (if at "Creating image...%s"
17487 "Creating images for entry...%s"))))
17488 (message msg "")
17489 (narrow-to-region beg end)
17490 (goto-char beg)
17491 (org-format-latex
17492 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
17493 (file-name-nondirectory
17494 buffer-file-name)))
17495 default-directory 'overlays msg at 'forbuffer
17496 org-latex-create-formula-image-program)
17497 (message msg "done. Use `C-c C-c' to remove images.")))))
17499 (defvar org-latex-regexps
17501 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17504 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
17508 "Regular expressions for matching embedded LaTeX.")
17510 (defvar org-export-have-math nil) ;; dynamic scoping
17511 (defun org-format-latex (prefix &optional dir overlays msg at
17512 forbuffer processing-type)
17513 "Replace LaTeX fragments with links to an image, and produce images.
17514 Some of the options can be changed using the variable
17515 `org-format-latex-options'."
17516 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
17517 (let* ((prefixnodir (file-name-nondirectory prefix))
17518 (absprefix (expand-file-name prefix dir))
17519 (todir (file-name-directory absprefix))
17520 (opt org-format-latex-options)
17521 (optnew org-format-latex-options)
17522 (matchers (plist-get opt :matchers))
17523 (re-list org-latex-regexps)
17524 (org-format-latex-header-extra
17525 (plist-get (org-infile-export-plist) :latex-header-extra))
17526 (cnt 0) txt hash link beg end re e checkdir
17527 string
17528 m n block-type block linkfile movefile ov)
17529 ;; Check the different regular expressions
17530 (while (setq e (pop re-list))
17531 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
17533 (when (member m matchers)
17534 (goto-char (point-min))
17535 (while (re-search-forward re nil t)
17536 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
17537 (not (get-text-property (match-beginning n)
17538 'org-protected))
17539 (or (not overlays)
17540 (not (eq (get-char-property (match-beginning n)
17541 'org-overlay-type)
17542 'org-latex-overlay))))
17543 (setq org-export-have-math t)
17544 (cond
17545 ((eq processing-type 'verbatim)
17546 ;; Leave the text verbatim, just protect it
17547 (add-text-properties (match-beginning n) (match-end n)
17548 '(org-protected t)))
17549 ((eq processing-type 'mathjax)
17550 ;; Prepare for MathJax processing
17551 (setq string (match-string n))
17552 (if (member m '("$" "$1"))
17553 (save-excursion
17554 (delete-region (match-beginning n) (match-end n))
17555 (goto-char (match-beginning n))
17558 '(org-protected t))))
17559 (add-text-properties (match-beginning n) (match-end n)
17560 '(org-protected t))))
17561 ((or (eq processing-type 'dvipng)
17562 (eq processing-type 'imagemagick))
17563 ;; Process to an image
17564 (setq txt (match-string n)
17565 beg (match-beginning n) end (match-end n)
17566 cnt (1+ cnt))
17567 (let ((face (face-at-point))
17568 (fg (plist-get opt :foreground))
17569 (bg (plist-get opt :background))
17570 print-length print-level) ; make sure full list is printed
17571 (when forbuffer
17572 ; Get the colors from the face at point
17573 (goto-char beg)
17574 (when (eq fg 'auto)
17575 (setq fg (face-attribute face :foreground nil 'default)))
17576 (when (eq bg 'auto)
17577 (setq bg (face-attribute face :background nil 'default)))
17578 (setq optnew (copy-sequence opt))
17579 (plist-put optnew :foreground fg)
17580 (plist-put optnew :background bg))
17581 (setq hash (sha1 (prin1-to-string
17582 (list org-format-latex-header
17583 org-format-latex-header-extra
17584 org-export-latex-default-packages-alist
17585 org-export-latex-packages-alist
17586 org-format-latex-options
17587 forbuffer txt fg bg)))
17588 linkfile (format "%s_%s.png" prefix hash)
17589 movefile (format "%s_%s.png" absprefix hash)))
17590 (setq link (concat block "[[file:" linkfile "]]" block))
17591 (if msg (message msg cnt))
17592 (goto-char beg)
17593 (unless checkdir ; make sure the directory exists
17594 (setq checkdir t)
17595 (or (file-directory-p todir) (make-directory todir t)))
17596 (org-create-formula-image
17597 txt movefile optnew forbuffer processing-type)
17598 (if overlays
17599 (progn
17600 (mapc (lambda (o)
17601 (if (eq (overlay-get o 'org-overlay-type)
17602 'org-latex-overlay)
17603 (delete-overlay o)))
17604 (overlays-in beg end))
17605 (setq ov (make-overlay beg end))
17606 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17607 (if (featurep 'xemacs)
17608 (progn
17609 (overlay-put ov 'invisible t)
17610 (overlay-put
17611 ov 'end-glyph
17612 (make-glyph (vector 'png :file movefile))))
17613 (overlay-put
17614 ov 'display
17615 (list 'image :type 'png :file movefile :ascent 'center)))
17616 (push ov org-latex-fragment-image-overlays)
17617 (goto-char end))
17618 (delete-region beg end)
17619 (insert (org-add-props link
17620 (list 'org-latex-src
17621 (replace-regexp-in-string
17623 'org-latex-src-embed-type
17624 (if block-type 'paragraph 'character))))))
17625 ((eq processing-type 'mathml)
17626 ;; Process to MathML
17627 (unless (save-match-data (org-format-latex-mathml-available-p))
17628 (error "LaTeX to MathML converter not configured"))
17629 (setq txt (match-string n)
17630 beg (match-beginning n) end (match-end n)
17631 cnt (1+ cnt))
17632 (if msg (message msg cnt))
17633 (goto-char beg)
17634 (delete-region beg end)
17635 (insert (org-format-latex-as-mathml
17636 txt block-type prefix dir)))
17637 (t
17638 (error "Unknown conversion type %s for latex fragments"
17639 processing-type)))))))))
17641 (defun org-create-math-formula (latex-frag &optional mathml-file)
17642 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17643 Use `org-latex-to-mathml-convert-command'. If the conversion is
17645 elements otherwise return nil. When MATHML-FILE is specified,
17646 write the results in to that file. When invoked as an
17647 interactive command, prompt for LATEX-FRAG, with initial value
17648 set to the current active region and echo the results for user
17649 inspection."
17650 (interactive (list (let ((frag (when (org-region-active-p)
17651 (buffer-substring-no-properties
17652 (region-beginning) (region-end)))))
17653 (read-string "LaTeX Fragment: " frag nil frag))))
17654 (unless latex-frag (error "Invalid latex-frag"))
17655 (let* ((tmp-in-file (file-relative-name
17656 (make-temp-name (expand-file-name "ltxmathml-in"))))
17657 (ignore (write-region latex-frag nil tmp-in-file))
17658 (tmp-out-file (file-relative-name
17659 (make-temp-name (expand-file-name "ltxmathml-out"))))
17660 (cmd (format-spec
17661 org-latex-to-mathml-convert-command
17662 `((?j . ,(shell-quote-argument
17663 (expand-file-name org-latex-to-mathml-jar-file)))
17664 (?I . ,(shell-quote-argument tmp-in-file))
17665 (?o . ,(shell-quote-argument tmp-out-file)))))
17666 mathml shell-command-output)
17667 (when (org-called-interactively-p 'any)
17668 (unless (org-format-latex-mathml-available-p)
17669 (error "LaTeX to MathML converter not configured")))
17670 (message "Running %s" cmd)
17671 (setq shell-command-output (shell-command-to-string cmd))
17672 (setq mathml
17673 (when (file-readable-p tmp-out-file)
17674 (with-current-buffer (find-file-noselect tmp-out-file t)
17675 (goto-char (point-min))
17676 (when (re-search-forward
17677 (concat
17678 (regexp-quote
17681 (regexp-quote "</math>")) nil t)
17682 (prog1 (match-string 0) (kill-buffer))))))
17683 (cond
17684 (mathml
17685 (setq mathml
17687 (when mathml-file
17688 (write-region mathml nil mathml-file))
17689 (when (org-called-interactively-p 'any)
17690 (message mathml)))
17691 ((message "LaTeX to MathML conversion failed")
17692 (message shell-command-output)))
17693 (delete-file tmp-in-file)
17694 (when (file-exists-p tmp-out-file)
17695 (delete-file tmp-out-file))
17696 mathml))
17698 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17699 prefix &optional dir)
17700 "Use `org-create-math-formula' but check local cache first."
17701 (let* ((absprefix (expand-file-name prefix dir))
17702 (print-length nil) (print-level nil)
17703 (formula-id (concat
17704 "formula-"
17705 (sha1
17706 (prin1-to-string
17707 (list latex-frag
17708 org-latex-to-mathml-convert-command)))))
17709 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17710 (formula-cache-dir (file-name-directory formula-cache)))
17712 (unless (file-directory-p formula-cache-dir)
17713 (make-directory formula-cache-dir t))
17715 (unless (file-exists-p formula-cache)
17716 (org-create-math-formula latex-frag formula-cache))
17718 (if (file-exists-p formula-cache)
17719 ;; Successful conversion. Return the link to MathML file.
17720 (org-add-props
17721 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17723 'org-latex-src-embed-type (if latex-frag-type
17724 'paragraph 'character)))
17725 ;; Failed conversion. Return the LaTeX fragment verbatim
17726 (add-text-properties
17727 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17728 latex-frag)))
17730 (defun org-create-formula-image (string tofile options buffer &optional type)
17731 "Create an image from LaTeX source using dvipng or convert.
17732 This function calls either `org-create-formula-image-with-dvipng'
17733 or `org-create-formula-image-with-imagemagick' depending on the
17734 value of `org-latex-create-formula-image-program' or on the value
17735 of the optional TYPE variable.
17737 Note: ultimately these two function should be combined as they
17738 share a good deal of logic."
17739 (org-check-external-command
17740 "latex" "needed to convert LaTeX fragments to images")
17741 (funcall
17742 (case (or type org-latex-create-formula-image-program)
17743 ('dvipng
17744 (org-check-external-command
17745 "dvipng" "needed to convert LaTeX fragments to images")
17746 #'org-create-formula-image-with-dvipng)
17747 ('imagemagick
17748 (org-check-external-command
17749 "convert" "you need to install imagemagick")
17750 #'org-create-formula-image-with-imagemagick)
17751 (t (error
17752 "invalid value of `org-latex-create-formula-image-program'")))
17753 string tofile options buffer))
17755 ;; This function borrows from Ganesh Swami's latex2png.el
17756 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
17757 "This calls dvipng."
17758 (require 'org-latex)
17759 (let* ((tmpdir (if (featurep 'xemacs)
17760 (temp-directory)
17761 temporary-file-directory))
17762 (texfilebase (make-temp-name
17763 (expand-file-name "orgtex" tmpdir)))
17764 (texfile (concat texfilebase ".tex"))
17765 (dvifile (concat texfilebase ".dvi"))
17766 (pngfile (concat texfilebase ".png"))
17767 (fnh (if (featurep 'xemacs)
17768 (font-height (face-font 'default))
17769 (face-attribute 'default :height nil)))
17770 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17771 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17772 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17773 "Black"))
17774 (bg (or (plist-get options (if buffer :background :html-background))
17775 "Transparent")))
17776 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
17777 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
17778 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
17779 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
17780 (with-temp-file texfile
17781 (insert (org-splice-latex-header
17782 org-format-latex-header
17783 org-export-latex-default-packages-alist
17784 org-export-latex-packages-alist t
17785 org-format-latex-header-extra))
17787 (require 'org-latex)
17788 (org-export-latex-fix-inputenc))
17789 (let ((dir default-directory))
17790 (condition-case nil
17791 (progn
17792 (cd tmpdir)
17793 (call-process "latex" nil nil nil texfile))
17794 (error nil))
17795 (cd dir))
17796 (if (not (file-exists-p dvifile))
17797 (progn (message "Failed to create dvi file from %s" texfile) nil)
17798 (condition-case nil
17799 (if (featurep 'xemacs)
17800 (call-process "dvipng" nil nil nil
17801 "-fg" fg "-bg" bg
17802 "-T" "tight"
17803 "-o" pngfile
17804 dvifile)
17805 (call-process "dvipng" nil nil nil
17806 "-fg" fg "-bg" bg
17807 "-D" dpi
17808 ;;"-x" scale "-y" scale
17809 "-T" "tight"
17810 "-o" pngfile
17811 dvifile))
17812 (error nil))
17813 (if (not (file-exists-p pngfile))
17814 (if org-format-latex-signal-error
17815 (error "Failed to create png file from %s" texfile)
17816 (message "Failed to create png file from %s" texfile)
17817 nil)
17818 ;; Use the requested file name and clean up
17819 (copy-file pngfile tofile 'replace)
17820 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
17821 (if (file-exists-p (concat texfilebase e))
17822 (delete-file (concat texfilebase e))))
17823 pngfile))))
17825 (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
17826 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
17827 "This calls convert, which is included into imagemagick."
17828 (require 'org-latex)
17829 (let* ((tmpdir (if (featurep 'xemacs)
17830 (temp-directory)
17831 temporary-file-directory))
17832 (texfilebase (make-temp-name
17833 (expand-file-name "orgtex" tmpdir)))
17834 (texfile (concat texfilebase ".tex"))
17835 (pdffile (concat texfilebase ".pdf"))
17836 (pngfile (concat texfilebase ".png"))
17837 (fnh (if (featurep 'xemacs)
17838 (font-height (face-font 'default))
17839 (face-attribute 'default :height nil)))
17840 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17841 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17842 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17843 "black"))
17844 (bg (or (plist-get options (if buffer :background :html-background))
17845 "white")))
17846 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
17847 (setq fg (org-latex-color-format fg)))
17848 (if (eq bg 'default) (setq bg (org-latex-color :background))
17849 (setq bg (org-latex-color-format
17850 (if (string= bg "Transparent") "white" bg))))
17851 (with-temp-file texfile
17852 (insert (org-splice-latex-header
17853 org-format-latex-header
17854 org-export-latex-default-packages-alist
17855 org-export-latex-packages-alist t
17856 org-format-latex-header-extra))
17862 string
17865 (require 'org-latex)
17866 (org-export-latex-fix-inputenc))
17867 (let ((dir default-directory) cmd cmds latex-frags-cmds)
17868 (condition-case nil
17869 (progn
17870 (cd tmpdir)
17871 (setq cmds org-latex-to-pdf-process)
17872 (while cmds
17873 (setq latex-frags-cmds (pop cmds))
17874 (if (listp latex-frags-cmds)
17875 (setq cmds nil)
17876 (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
17877 (while latex-frags-cmds
17878 (setq cmd (pop latex-frags-cmds))
17879 (while (string-match "%b" cmd)
17880 (setq cmd (replace-match
17881 (save-match-data
17882 (shell-quote-argument texfile))
17883 t t cmd)))
17884 (while (string-match "%f" cmd)
17885 (setq cmd (replace-match
17886 (save-match-data
17887 (shell-quote-argument (file-name-nondirectory texfile)))
17888 t t cmd)))
17889 (while (string-match "%o" cmd)
17890 (setq cmd (replace-match
17891 (save-match-data
17892 (shell-quote-argument (file-name-directory texfile)))
17893 t t cmd)))
17894 (setq cmd (split-string cmd))
17895 (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
17896 (error nil))
17897 (cd dir))
17898 (if (not (file-exists-p pdffile))
17899 (progn (message "Failed to create pdf file from %s" texfile) nil)
17900 (condition-case nil
17901 (if (featurep 'xemacs)
17902 (call-process "convert" nil nil nil
17903 "-density" "96"
17904 "-trim"
17905 "-antialias"
17906 pdffile
17907 "-quality" "100"
17908 ;; "-sharpen" "0x1.0"
17909 pngfile)
17910 (call-process "convert" nil nil nil
17911 "-density" dpi
17912 "-trim"
17913 "-antialias"
17914 pdffile
17915 "-quality" "100"
17916 ; "-sharpen" "0x1.0"
17917 pngfile))
17918 (error nil))
17919 (if (not (file-exists-p pngfile))
17920 (if org-format-latex-signal-error
17921 (error "Failed to create png file from %s" texfile)
17922 (message "Failed to create png file from %s" texfile)
17923 nil)
17924 ;; Use the requested file name and clean up
17925 (copy-file pngfile tofile 'replace)
17926 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
17927 (if (file-exists-p (concat texfilebase e))
17928 (delete-file (concat texfilebase e))))
17929 pngfile))))
17931 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17932 "Fill a LaTeX header template TPL.
17933 In the template, the following place holders will be recognized:
17936 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17938 [NO-PACKAGES] do not include PKG
17939 [EXTRA] the string EXTRA
17940 [NO-EXTRA] do not include EXTRA
17942 For backward compatibility, if both the positive and the negative place
17944 assumed to be present at the end of the template.
17945 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17946 EXTRA is a string.
17947 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17948 (let (rpl (end ""))
17950 (setq rpl (if (or (match-end 1) (not def-pkg))
17951 "" (org-latex-packages-to-string def-pkg snippets-p t))
17952 tpl (replace-match rpl t t tpl))
17953 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17956 (setq rpl (if (or (match-end 1) (not pkg))
17957 "" (org-latex-packages-to-string pkg snippets-p t))
17958 tpl (replace-match rpl t t tpl))
17959 (if pkg (setq end
17961 (org-latex-packages-to-string pkg snippets-p)))))
17964 (setq rpl (if (or (match-end 1) (not extra))
17966 tpl (replace-match rpl t t tpl))
17972 tpl)))
17974 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17976 (setq pkg (mapconcat (lambda(p)
17977 (cond
17978 ((stringp p) p)
17979 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17980 (format "%% Package %s omitted" (cadr p)))
17981 ((equal "" (car p))
17983 (t
17985 (car p) (cadr p)))))
17986 pkg
17990 (defun org-dvipng-color (attr)
17991 "Return a RGB color specification for dvipng."
17992 (apply 'format "rgb %s %s %s"
17993 (mapcar 'org-normalize-color
17994 (if (featurep 'xemacs)
17995 (color-rgb-components
17996 (face-property 'default
17997 (cond ((eq attr :foreground) 'foreground)
17998 ((eq attr :background) 'background))))
17999 (color-values (face-attribute 'default attr nil))))))
18001 (defun org-dvipng-color-format (color-name)
18002 "Convert COLOR-NAME to a RGB color value for dvipng."
18003 (apply 'format "rgb %s %s %s"
18004 (mapcar 'org-normalize-color
18005 (color-values color-name))))
18007 (defun org-latex-color (attr)
18008 "Return a RGB color for the LaTeX color package."
18009 (apply 'format "%s,%s,%s"
18010 (mapcar 'org-normalize-color
18011 (if (featurep 'xemacs)
18012 (color-rgb-components
18013 (face-property 'default
18014 (cond ((eq attr :foreground) 'foreground)
18015 ((eq attr :background) 'background))))
18016 (color-values (face-attribute 'default attr nil))))))
18018 (defun org-latex-color-format (color-name)
18019 "Convert COLOR-NAME to a RGB color value."
18020 (apply 'format "%s,%s,%s"
18021 (mapcar 'org-normalize-color
18022 (color-values color-name))))
18024 (defun org-normalize-color (value)
18025 "Return string to be used as color value for an RGB component."
18026 (format "%g" (/ value 65535.0)))
18028 ;; Image display
18031 (defvar org-inline-image-overlays nil)
18032 (make-variable-buffer-local 'org-inline-image-overlays)
18034 (defun org-toggle-inline-images (&optional include-linked)
18035 "Toggle the display of inline images.
18036 INCLUDE-LINKED is passed to `org-display-inline-images'."
18037 (interactive "P")
18038 (if org-inline-image-overlays
18039 (progn
18040 (org-remove-inline-images)
18041 (message "Inline image display turned off"))
18042 (org-display-inline-images include-linked)
18043 (if (and (org-called-interactively-p)
18044 org-inline-image-overlays)
18045 (message "%d images displayed inline"
18046 (length org-inline-image-overlays))
18047 (message "No images to display inline"))))
18049 (defun org-redisplay-inline-images ()
18050 "Refresh the display of inline images."
18051 (interactive)
18052 (if (not org-inline-image-overlays)
18053 (org-toggle-inline-images)
18054 (org-toggle-inline-images)
18055 (org-toggle-inline-images)))
18057 (defun org-display-inline-images (&optional include-linked refresh beg end)
18058 "Display inline images.
18059 Normally only links without a description part are inlined, because this
18060 is how it will work for export. When INCLUDE-LINKED is set, also links
18061 with a description part will be inlined. This can be nice for a quick
18062 look at those images, but it does not reflect what exported files will look
18063 like.
18064 When REFRESH is set, refresh existing images between BEG and END.
18065 This will create new image displays only if necessary.
18066 BEG and END default to the buffer boundaries."
18067 (interactive "P")
18068 (unless refresh
18069 (org-remove-inline-images)
18070 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18071 (save-excursion
18072 (save-restriction
18073 (widen)
18074 (setq beg (or beg (point-min)) end (or end (point-max)))
18075 (goto-char beg)
18077 (substring (org-image-file-name-regexp) 0 -2)
18079 old file ov img type attrwidth width)
18080 (while (re-search-forward re end t)
18081 (setq old (get-char-property-and-overlay (match-beginning 1)
18082 'org-image-overlay)
18083 file (expand-file-name
18084 (concat (or (match-string 3) "") (match-string 4))))
18085 (when (image-type-available-p 'imagemagick)
18086 (setq attrwidth (if (or (listp org-image-actual-width)
18087 (null org-image-actual-width))
18088 (save-excursion
18089 (save-match-data
18090 (when (re-search-backward
18092 (save-excursion
18094 (string-to-number (match-string 1))))))
18095 width (cond ((eq org-image-actual-width t) nil)
18096 ((null org-image-actual-width) attrwidth)
18097 ((numberp org-image-actual-width)
18098 org-image-actual-width)
18099 ((listp org-image-actual-width)
18100 (or attrwidth (car org-image-actual-width))))
18101 type (if width 'imagemagick)))
18102 (when (file-exists-p file)
18103 (if (and (car-safe old) refresh)
18104 (image-refresh (overlay-get (cdr old) 'display))
18105 (setq img (save-match-data (create-image file type nil :width width)))
18106 (when img
18107 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18108 (overlay-put ov 'display img)
18109 (overlay-put ov 'face 'default)
18110 (overlay-put ov 'org-image-overlay t)
18111 (overlay-put ov 'modification-hooks
18112 (list 'org-display-inline-remove-overlay))
18113 (push ov org-inline-image-overlays)))))))))
18115 (define-obsolete-function-alias
18116 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18118 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18119 "Remove inline-display overlay if a corresponding region is modified."
18120 (let ((inhibit-modification-hooks t))
18121 (when (and ov after)
18122 (delete ov org-inline-image-overlays)
18123 (delete-overlay ov))))
18125 (defun org-remove-inline-images ()
18126 "Remove inline display of images."
18127 (interactive)
18128 (mapc 'delete-overlay org-inline-image-overlays)
18129 (setq org-inline-image-overlays nil))
18131 ;;;; Key bindings
18133 ;; Outline functions from `outline-mode-prefix-map'
18134 ;; that can be remapped in Org:
18135 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18136 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18137 (define-key org-mode-map [remap outline-forward-same-level]
18138 'org-forward-heading-same-level)
18139 (define-key org-mode-map [remap outline-backward-same-level]
18140 'org-backward-heading-same-level)
18141 (define-key org-mode-map [remap show-branches]
18142 'org-kill-note-or-show-branches)
18143 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18144 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18145 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18147 ;; Outline functions from `outline-mode-prefix-map' that can not
18148 ;; be remapped in Org:
18149 ;;
18150 ;; - the column "key binding" shows whether the Outline function is still
18151 ;; available in Org mode on the same key that it has been bound to in
18152 ;; Outline mode:
18153 ;; - "overridden": key used for a different functionality in Org mode
18154 ;; - else: key still bound to the same Outline function in Org mode
18155 ;;
18156 ;; | Outline function | key binding | Org replacement |
18157 ;; |------------------------------------+-------------+-----------------------|
18158 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18159 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18160 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18161 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18162 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18163 ;; | `show-entry' | overridden | no replacement |
18164 ;; | `show-children' | `C-c C-i' | visibility cycling |
18165 ;; | `show-branches' | `C-c C-k' | still same function |
18166 ;; | `show-subtree' | overridden | visibility cycling |
18167 ;; | `show-all' | overridden | no replacement |
18168 ;; | `hide-subtree' | overridden | visibility cycling |
18169 ;; | `hide-body' | overridden | no replacement |
18170 ;; | `hide-entry' | overridden | visibility cycling |
18171 ;; | `hide-leaves' | overridden | no replacement |
18172 ;; | `hide-sublevels' | overridden | no replacement |
18173 ;; | `hide-other' | overridden | no replacement |
18175 ;; Make `C-c C-x' a prefix key
18176 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18178 ;; TAB key with modifiers
18179 (org-defkey org-mode-map "\C-i" 'org-cycle)
18180 (org-defkey org-mode-map [(tab)] 'org-cycle)
18181 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18183 ;; The following line is necessary under Suse GNU/Linux
18184 (unless (featurep 'xemacs)
18185 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18186 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18187 (define-key org-mode-map [backtab] 'org-shifttab)
18189 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18190 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18191 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18193 ;; Cursor keys with modifiers
18194 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18195 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18196 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18197 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18199 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18200 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18201 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18202 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18204 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18205 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18206 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18207 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18209 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18210 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18211 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18212 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18214 ;; Babel keys
18215 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18216 (mapc (lambda (pair)
18217 (define-key org-babel-map (car pair) (cdr pair)))
18218 org-babel-key-bindings)
18220 ;;; Extra keys for tty access.
18221 ;; We only set them when really needed because otherwise the
18222 ;; menus don't show the simple keys
18224 (when (or org-use-extra-keys
18225 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18226 (not window-system))
18227 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18228 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18229 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18230 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18231 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18232 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18233 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18234 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18235 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18236 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18237 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18238 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18239 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18240 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18241 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18242 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18243 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18244 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18245 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18246 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18247 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18248 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18249 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18250 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18251 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18252 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18253 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18254 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18256 ;; All the other keys
18258 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18259 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18260 (if (boundp 'narrow-map)
18261 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18262 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18263 (if (boundp 'narrow-map)
18264 (org-defkey narrow-map "b" 'org-narrow-to-block)
18265 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18266 (if (boundp 'narrow-map)
18267 (org-defkey narrow-map "e" 'org-narrow-to-element)
18268 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18269 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18270 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18271 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18272 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18273 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18274 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18275 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18276 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
18277 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
18278 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
18279 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
18280 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
18281 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
18282 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
18283 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
18284 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
18285 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
18286 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
18287 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
18288 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
18289 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
18290 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
18291 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
18293 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
18294 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
18295 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
18296 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
18297 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
18298 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
18299 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
18300 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
18301 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
18302 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
18303 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
18304 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
18305 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
18306 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
18307 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
18308 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
18309 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
18310 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
18311 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
18312 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
18313 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
18315 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
18316 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
18317 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
18318 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18319 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
18320 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
18321 (org-defkey org-mode-map "\C-c^" 'org-sort)
18322 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
18323 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
18324 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
18325 (org-defkey org-mode-map "\C-m" 'org-return)
18326 (org-defkey org-mode-map "\C-j" 'org-return-indent)
18327 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
18328 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
18329 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
18330 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
18331 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
18332 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
18333 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
18334 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
18335 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
18336 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
18337 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
18338 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
18339 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
18340 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
18341 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
18342 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
18343 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
18344 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
18345 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
18346 (org-defkey org-mode-map "\M-h" 'org-mark-element)
18347 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
18348 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
18350 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
18351 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
18352 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
18354 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
18355 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
18356 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
18357 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
18358 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
18359 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
18360 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
18361 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
18362 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
18363 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
18364 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
18365 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
18366 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
18368 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
18369 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
18370 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
18371 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
18372 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
18373 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
18374 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
18375 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
18377 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
18378 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
18379 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
18380 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
18381 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
18383 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
18385 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
18387 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
18388 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
18390 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
18393 (when (featurep 'xemacs)
18394 (org-defkey org-mode-map 'button3 'popup-mode-menu))
18397 (defconst org-speed-commands-default
18398 '(
18399 ("Outline Navigation")
18400 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
18401 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
18402 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
18403 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
18404 ("u" . (org-speed-move-safe 'outline-up-heading))
18405 ("j" . org-goto)
18406 ("g" . (org-refile t))
18407 ("Outline Visibility")
18408 ("c" . org-cycle)
18409 ("C" . org-shifttab)
18410 (" " . org-display-outline-path)
18411 (":" . org-columns)
18412 ("Outline Structure Editing")
18413 ("U" . org-shiftmetaup)
18414 ("D" . org-shiftmetadown)
18415 ("r" . org-metaright)
18416 ("l" . org-metaleft)
18417 ("R" . org-shiftmetaright)
18418 ("L" . org-shiftmetaleft)
18419 ("i" . (progn (forward-char 1) (call-interactively
18420 'org-insert-heading-respect-content)))
18421 ("^" . org-sort)
18422 ("w" . org-refile)
18423 ("a" . org-archive-subtree-default-with-confirmation)
18424 ("." . org-mark-subtree)
18425 ("#" . org-toggle-comment)
18426 ("Clock Commands")
18427 ("I" . org-clock-in)
18428 ("O" . org-clock-out)
18429 ("Meta Data Editing")
18430 ("t" . org-todo)
18431 ("," . (org-priority))
18432 ("0" . (org-priority ?\ ))
18433 ("1" . (org-priority ?A))
18434 ("2" . (org-priority ?B))
18435 ("3" . (org-priority ?C))
18436 (";" . org-set-tags-command)
18437 ("e" . org-set-effort)
18438 ("E" . org-inc-effort)
18439 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
18440 (org-entry-put (point) "APPT_WARNTIME" m)))
18441 ("Agenda Views etc")
18442 ("v" . org-agenda)
18443 ("/" . org-sparse-tree)
18444 ("Misc")
18445 ("o" . org-open-at-point)
18446 ("?" . org-speed-command-help)
18447 ("<" . (org-agenda-set-restriction-lock 'subtree))
18448 (">" . (org-agenda-remove-restriction-lock))
18449 )
18450 "The default speed commands.")
18452 (defun org-print-speed-command (e)
18453 (if (> (length (car e)) 1)
18454 (progn
18456 (princ (car e))
18458 (princ (make-string (length (car e)) ?-))
18460 (princ (car e))
18461 (princ " ")
18462 (if (symbolp (cdr e))
18463 (princ (symbol-name (cdr e)))
18464 (prin1 (cdr e)))
18467 (defun org-speed-command-help ()
18468 "Show the available speed commands."
18469 (interactive)
18470 (if (not org-use-speed-commands)
18471 (error "Speed commands are not activated, customize `org-use-speed-commands'")
18472 (with-output-to-temp-buffer "*Help*"
18474 (mapc 'org-print-speed-command org-speed-commands-user)
18477 (mapc 'org-print-speed-command org-speed-commands-default))
18478 (with-current-buffer "*Help*"
18479 (setq truncate-lines t))))
18481 (defun org-speed-move-safe (cmd)
18482 "Execute CMD, but make sure that the cursor always ends up in a headline.
18483 If not, return to the original position and throw an error."
18484 (interactive)
18485 (let ((pos (point)))
18486 (call-interactively cmd)
18487 (unless (and (bolp) (org-at-heading-p))
18488 (goto-char pos)
18489 (error "Boundary reached while executing %s" cmd))))
18491 (defvar org-self-insert-command-undo-counter 0)
18493 (defvar org-table-auto-blank-field) ; defined in org-table.el
18494 (defvar org-speed-command nil)
18496 (define-obsolete-function-alias
18497 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
18499 (defun org-speed-command-activate (keys)
18500 "Hook for activating single-letter speed commands.
18501 `org-speed-commands-default' specifies a minimal command set.
18502 Use `org-speed-commands-user' for further customization."
18503 (when (or (and (bolp) (looking-at org-outline-regexp))
18504 (and (functionp org-use-speed-commands)
18505 (funcall org-use-speed-commands)))
18506 (cdr (assoc keys (append org-speed-commands-user
18507 org-speed-commands-default)))))
18509 (define-obsolete-function-alias
18510 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
18512 (defun org-babel-speed-command-activate (keys)
18513 "Hook for activating single-letter code block commands."
18514 (when (and (bolp) (looking-at org-babel-src-block-regexp))
18515 (cdr (assoc keys org-babel-key-bindings))))
18517 (defcustom org-speed-command-hook
18518 '(org-speed-command-default-hook org-babel-speed-command-hook)
18519 "Hook for activating speed commands at strategic locations.
18520 Hook functions are called in sequence until a valid handler is
18521 found.
18523 Each hook takes a single argument, a user-pressed command key
18524 which is also a `self-insert-command' from the global map.
18526 Within the hook, examine the cursor position and the command key
18527 and return nil or a valid handler as appropriate. Handler could
18528 be one of an interactive command, a function, or a form.
18530 Set `org-use-speed-commands' to non-nil value to enable this
18531 hook. The default setting is `org-speed-command-activate'."
18532 :group 'org-structure
18533 :version "24.1"
18534 :type 'hook)
18536 (defun org-self-insert-command (N)
18537 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18538 If the cursor is in a table looking at whitespace, the whitespace is
18539 overwritten, and the table is not marked as requiring realignment."
18540 (interactive "p")
18541 (org-check-before-invisible-edit 'insert)
18542 (cond
18543 ((and org-use-speed-commands
18544 (setq org-speed-command
18545 (run-hook-with-args-until-success
18546 'org-speed-command-hook (this-command-keys))))
18547 (cond
18548 ((commandp org-speed-command)
18549 (setq this-command org-speed-command)
18550 (call-interactively org-speed-command))
18551 ((functionp org-speed-command)
18552 (funcall org-speed-command))
18553 ((and org-speed-command (listp org-speed-command))
18554 (eval org-speed-command))
18555 (t (let (org-use-speed-commands)
18556 (call-interactively 'org-self-insert-command)))))
18557 ((and
18558 (org-table-p)
18559 (progn
18560 ;; check if we blank the field, and if that triggers align
18561 (and (featurep 'org-table) org-table-auto-blank-field
18562 (member last-command
18563 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
18565 ;; got extra space, this field does not determine column width
18566 (let (org-table-may-need-update) (org-table-blank-field))
18567 ;; no extra space, this field may determine column width
18568 (org-table-blank-field)))
18569 t)
18570 (eq N 1)
18572 (let (org-table-may-need-update)
18573 (goto-char (1- (match-end 0)))
18574 (backward-delete-char 1)
18575 (goto-char (match-beginning 0))
18576 (self-insert-command N)))
18577 (t
18578 (setq org-table-may-need-update t)
18579 (self-insert-command N)
18580 (org-fix-tags-on-the-fly)
18581 (if org-self-insert-cluster-for-undo
18582 (if (not (eq last-command 'org-self-insert-command))
18583 (setq org-self-insert-command-undo-counter 1)
18584 (if (>= org-self-insert-command-undo-counter 20)
18585 (setq org-self-insert-command-undo-counter 1)
18586 (and (> org-self-insert-command-undo-counter 0)
18587 buffer-undo-list (listp buffer-undo-list)
18588 (not (cadr buffer-undo-list)) ; remove nil entry
18589 (setcdr buffer-undo-list (cddr buffer-undo-list)))
18590 (setq org-self-insert-command-undo-counter
18591 (1+ org-self-insert-command-undo-counter))))))))
18593 (defun org-check-before-invisible-edit (kind)
18594 "Check is editing if kind KIND would be dangerous with invisible text around.
18595 The detailed reaction depends on the user option `org-catch-invisible-edits'."
18596 ;; First, try to get out of here as quickly as possible, to reduce overhead
18597 (if (and org-catch-invisible-edits
18598 (or (not (boundp 'visible-mode)) (not visible-mode))
18599 (or (get-char-property (point) 'invisible)
18600 (get-char-property (max (point-min) (1- (point))) 'invisible)))
18601 ;; OK, we need to take a closer look
18602 (let* ((invisible-at-point (get-char-property (point) 'invisible))
18603 (invisible-before-point (if (bobp) nil (get-char-property
18604 (1- (point)) 'invisible)))
18605 (border-and-ok-direction
18606 (or
18607 ;; Check if we are acting predictably before invisible text
18608 (and invisible-at-point (not invisible-before-point)
18609 (memq kind '(insert delete-backward)))
18610 ;; Check if we are acting predictably after invisible text
18611 ;; This works not well, and I have turned it off. It seems
18612 ;; better to always show and stop after invisible text.
18613 ;; (and (not invisible-at-point) invisible-before-point
18614 ;; (memq kind '(insert delete)))
18615 )))
18616 (when (or (memq invisible-at-point '(outline org-hide-block t))
18617 (memq invisible-before-point '(outline org-hide-block t)))
18618 (if (eq org-catch-invisible-edits 'error)
18619 (error "Editing in invisible areas is prohibited - make visible first"))
18620 (if (and org-custom-properties-overlays
18621 (y-or-n-p "Display invisible properties in this buffer? "))
18622 (org-toggle-custom-properties-visibility)
18623 ;; Make the area visible
18624 (save-excursion
18625 (if invisible-before-point
18626 (goto-char (previous-single-char-property-change
18627 (point) 'invisible)))
18628 (org-cycle))
18629 (cond
18630 ((eq org-catch-invisible-edits 'show)
18631 ;; That's it, we do the edit after showing
18632 (message
18633 "Unfolding invisible region around point before editing")
18634 (sit-for 1))
18635 ((and (eq org-catch-invisible-edits 'smart)
18636 border-and-ok-direction)
18637 (message "Unfolding invisible region around point before editing"))
18638 (t
18639 ;; Don't do the edit, make the user repeat it in full visibility
18640 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
18642 (defun org-fix-tags-on-the-fly ()
18643 (when (and (equal (char-after (point-at-bol)) ?*)
18644 (org-at-heading-p))
18645 (org-align-tags-here org-tags-column)))
18647 (defun org-delete-backward-char (N)
18648 "Like `delete-backward-char', insert whitespace at field end in tables.
18649 When deleting backwards, in tables this function will insert whitespace in
18651 still be marked for re-alignment if the field did fill the entire column,
18652 because, in this case the deletion might narrow the column."
18653 (interactive "p")
18654 (org-check-before-invisible-edit 'delete-backward)
18655 (if (and (org-table-p)
18656 (eq N 1)
18657 (string-match "|" (buffer-substring (point-at-bol) (point)))
18658 (looking-at ".*?|"))
18659 (let ((pos (point))
18661 (c org-table-may-need-update))
18662 (backward-delete-char N)
18663 (if (not overwrite-mode)
18664 (progn
18665 (skip-chars-forward "^|")
18666 (insert " ")
18667 (goto-char (1- pos))))
18668 ;; noalign: if there were two spaces at the end, this field
18669 ;; does not determine the width of the column.
18670 (if noalign (setq org-table-may-need-update c)))
18671 (backward-delete-char N)
18672 (org-fix-tags-on-the-fly)))
18674 (defun org-delete-char (N)
18675 "Like `delete-char', but insert whitespace at field end in tables.
18676 When deleting characters, in tables this function will insert whitespace in
18678 still be marked for re-alignment if the field did fill the entire column,
18679 because, in this case the deletion might narrow the column."
18680 (interactive "p")
18681 (org-check-before-invisible-edit 'delete)
18682 (if (and (org-table-p)
18683 (not (bolp))
18684 (not (= (char-after) ?|))
18685 (eq N 1))
18686 (if (looking-at ".*?|")
18687 (let ((pos (point))
18689 (c org-table-may-need-update))
18690 (replace-match (concat
18691 (substring (match-string 0) 1 -1)
18692 " |"))
18693 (goto-char pos)
18694 ;; noalign: if there were two spaces at the end, this field
18695 ;; does not determine the width of the column.
18696 (if noalign (setq org-table-may-need-update c)))
18697 (delete-char N))
18698 (delete-char N)
18699 (org-fix-tags-on-the-fly)))
18701 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
18702 (put 'org-self-insert-command 'delete-selection t)
18703 (put 'orgtbl-self-insert-command 'delete-selection t)
18704 (put 'org-delete-char 'delete-selection 'supersede)
18705 (put 'org-delete-backward-char 'delete-selection 'supersede)
18706 (put 'org-yank 'delete-selection 'yank)
18708 ;; Make `flyspell-mode' delay after some commands
18709 (put 'org-self-insert-command 'flyspell-delayed t)
18710 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
18711 (put 'org-delete-char 'flyspell-delayed t)
18712 (put 'org-delete-backward-char 'flyspell-delayed t)
18714 ;; Make pabbrev-mode expand after org-mode commands
18715 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
18716 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
18718 ;; How to do this: Measure non-white length of current string
18719 ;; If equal to column width, we should realign.
18721 (defun org-remap (map &rest commands)
18722 "In MAP, remap the functions given in COMMANDS.
18723 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
18724 (let (new old)
18725 (while commands
18726 (setq old (pop commands) new (pop commands))
18727 (if (fboundp 'command-remapping)
18728 (org-defkey map (vector 'remap old) new)
18729 (substitute-key-definition old new map global-map)))))
18731 (when (eq org-enable-table-editor 'optimized)
18732 ;; If the user wants maximum table support, we need to hijack
18733 ;; some standard editing functions
18734 (org-remap org-mode-map
18735 'self-insert-command 'org-self-insert-command
18736 'delete-char 'org-delete-char
18737 'delete-backward-char 'org-delete-backward-char)
18738 (org-defkey org-mode-map "|" 'org-force-self-insert))
18740 (defvar org-ctrl-c-ctrl-c-hook nil
18741 "Hook for functions attaching themselves to `C-c C-c'.
18743 This can be used to add additional functionality to the C-c C-c
18744 key which executes context-dependent commands. This hook is run
18745 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
18746 run after the last test.
18748 Each function will be called with no arguments. The function
18749 must check if the context is appropriate for it to act. If yes,
18750 it should do its thing and then return a non-nil value. If the
18751 context is wrong, just do nothing and return nil.")
18753 (defvar org-ctrl-c-ctrl-c-final-hook nil
18754 "Hook for functions attaching themselves to `C-c C-c'.
18756 This can be used to add additional functionality to the C-c C-c
18757 key which executes context-dependent commands. This hook is run
18758 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
18759 before the first test.
18761 Each function will be called with no arguments. The function
18762 must check if the context is appropriate for it to act. If yes,
18763 it should do its thing and then return a non-nil value. If the
18764 context is wrong, just do nothing and return nil.")
18766 (defvar org-tab-first-hook nil
18767 "Hook for functions to attach themselves to TAB.
18768 See `org-ctrl-c-ctrl-c-hook' for more information.
18769 This hook runs as the first action when TAB is pressed, even before
18770 `org-cycle' messes around with the `outline-regexp' to cater for
18771 inline tasks and plain list item folding.
18772 If any function in this hook returns t, any other actions that
18773 would have been caused by TAB (such as table field motion or visibility
18774 cycling) will not occur.")
18776 (defvar org-tab-after-check-for-table-hook nil
18777 "Hook for functions to attach themselves to TAB.
18778 See `org-ctrl-c-ctrl-c-hook' for more information.
18779 This hook runs after it has been established that the cursor is not in a
18780 table, but before checking if the cursor is in a headline or if global cycling
18781 should be done.
18782 If any function in this hook returns t, not other actions like visibility
18783 cycling will be done.")
18785 (defvar org-tab-after-check-for-cycling-hook nil
18786 "Hook for functions to attach themselves to TAB.
18787 See `org-ctrl-c-ctrl-c-hook' for more information.
18788 This hook runs after it has been established that not table field motion and
18789 not visibility should be done because of current context. This is probably
18790 the place where a package like yasnippets can hook in.")
18792 (defvar org-tab-before-tab-emulation-hook nil
18793 "Hook for functions to attach themselves to TAB.
18794 See `org-ctrl-c-ctrl-c-hook' for more information.
18795 This hook runs after every other options for TAB have been exhausted, but
18798 (defvar org-metaleft-hook nil
18799 "Hook for functions attaching themselves to `M-left'.
18800 See `org-ctrl-c-ctrl-c-hook' for more information.")
18801 (defvar org-metaright-hook nil
18802 "Hook for functions attaching themselves to `M-right'.
18803 See `org-ctrl-c-ctrl-c-hook' for more information.")
18804 (defvar org-metaup-hook nil
18805 "Hook for functions attaching themselves to `M-up'.
18806 See `org-ctrl-c-ctrl-c-hook' for more information.")
18807 (defvar org-metadown-hook nil
18808 "Hook for functions attaching themselves to `M-down'.
18809 See `org-ctrl-c-ctrl-c-hook' for more information.")
18810 (defvar org-shiftmetaleft-hook nil
18811 "Hook for functions attaching themselves to `M-S-left'.
18812 See `org-ctrl-c-ctrl-c-hook' for more information.")
18813 (defvar org-shiftmetaright-hook nil
18814 "Hook for functions attaching themselves to `M-S-right'.
18815 See `org-ctrl-c-ctrl-c-hook' for more information.")
18816 (defvar org-shiftmetaup-hook nil
18817 "Hook for functions attaching themselves to `M-S-up'.
18818 See `org-ctrl-c-ctrl-c-hook' for more information.")
18819 (defvar org-shiftmetadown-hook nil
18820 "Hook for functions attaching themselves to `M-S-down'.
18821 See `org-ctrl-c-ctrl-c-hook' for more information.")
18822 (defvar org-metareturn-hook nil
18823 "Hook for functions attaching themselves to `M-RET'.
18824 See `org-ctrl-c-ctrl-c-hook' for more information.")
18825 (defvar org-shiftup-hook nil
18826 "Hook for functions attaching themselves to `S-up'.
18827 See `org-ctrl-c-ctrl-c-hook' for more information.")
18828 (defvar org-shiftup-final-hook nil
18829 "Hook for functions attaching themselves to `S-up'.
18830 This one runs after all other options except shift-select have been excluded.
18831 See `org-ctrl-c-ctrl-c-hook' for more information.")
18832 (defvar org-shiftdown-hook nil
18833 "Hook for functions attaching themselves to `S-down'.
18834 See `org-ctrl-c-ctrl-c-hook' for more information.")
18835 (defvar org-shiftdown-final-hook nil
18836 "Hook for functions attaching themselves to `S-down'.
18837 This one runs after all other options except shift-select have been excluded.
18838 See `org-ctrl-c-ctrl-c-hook' for more information.")
18839 (defvar org-shiftleft-hook nil
18840 "Hook for functions attaching themselves to `S-left'.
18841 See `org-ctrl-c-ctrl-c-hook' for more information.")
18842 (defvar org-shiftleft-final-hook nil
18843 "Hook for functions attaching themselves to `S-left'.
18844 This one runs after all other options except shift-select have been excluded.
18845 See `org-ctrl-c-ctrl-c-hook' for more information.")
18846 (defvar org-shiftright-hook nil
18847 "Hook for functions attaching themselves to `S-right'.
18848 See `org-ctrl-c-ctrl-c-hook' for more information.")
18849 (defvar org-shiftright-final-hook nil
18850 "Hook for functions attaching themselves to `S-right'.
18851 This one runs after all other options except shift-select have been excluded.
18852 See `org-ctrl-c-ctrl-c-hook' for more information.")
18854 (defun org-modifier-cursor-error ()
18855 "Throw an error, a modified cursor command was applied in wrong context."
18856 (error "This command is active in special context like tables, headlines or items"))
18858 (defun org-shiftselect-error ()
18859 "Throw an error because Shift-Cursor command was applied in wrong context."
18860 (if (and (boundp 'shift-select-mode) shift-select-mode)
18861 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
18862 (error "This command works only in special context like headlines or timestamps")))
18864 (defun org-call-for-shift-select (cmd)
18865 (let ((this-command-keys-shift-translated t))
18866 (call-interactively cmd)))
18868 (defun org-shifttab (&optional arg)
18869 "Global visibility cycling or move to previous table field.
18870 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
18871 on context.
18872 See the individual commands for more information."
18873 (interactive "P")
18874 (cond
18875 ((org-at-table-p) (call-interactively 'org-table-previous-field))
18876 ((integerp arg)
18877 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18878 (message "Content view to level: %d" arg)
18879 (org-content (prefix-numeric-value arg2))
18880 (setq org-cycle-global-status 'overview)))
18881 (t (call-interactively 'org-global-cycle))))
18883 (defun org-shiftmetaleft ()
18884 "Promote subtree or delete table column.
18885 Calls `org-promote-subtree', `org-outdent-item-tree', or
18886 `org-table-delete-column', depending on context. See the
18887 individual commands for more information."
18888 (interactive)
18889 (cond
18890 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18891 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18892 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18893 ((if (not (org-region-active-p)) (org-at-item-p)
18894 (save-excursion (goto-char (region-beginning))
18895 (org-at-item-p)))
18896 (call-interactively 'org-outdent-item-tree))
18897 (t (org-modifier-cursor-error))))
18899 (defun org-shiftmetaright ()
18900 "Demote subtree or insert table column.
18901 Calls `org-demote-subtree', `org-indent-item-tree', or
18902 `org-table-insert-column', depending on context. See the
18903 individual commands for more information."
18904 (interactive)
18905 (cond
18906 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18907 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18908 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18909 ((if (not (org-region-active-p)) (org-at-item-p)
18910 (save-excursion (goto-char (region-beginning))
18911 (org-at-item-p)))
18912 (call-interactively 'org-indent-item-tree))
18913 (t (org-modifier-cursor-error))))
18915 (defun org-shiftmetaup (&optional arg)
18916 "Move subtree up or kill table row.
18917 Calls `org-move-subtree-up' or `org-table-kill-row' or
18918 `org-move-item-up' or `org-timestamp-up', depending on context.
18919 See the individual commands for more information."
18920 (interactive "P")
18921 (cond
18922 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18923 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18924 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18925 ((org-at-item-p) (call-interactively 'org-move-item-up))
18926 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18927 (call-interactively 'org-timestamp-up)))
18928 (t (org-modifier-cursor-error))))
18930 (defun org-shiftmetadown (&optional arg)
18931 "Move subtree down or insert table row.
18932 Calls `org-move-subtree-down' or `org-table-insert-row' or
18933 `org-move-item-down' or `org-timestamp-up', depending on context.
18934 See the individual commands for more information."
18935 (interactive "P")
18936 (cond
18937 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18938 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18939 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18940 ((org-at-item-p) (call-interactively 'org-move-item-down))
18941 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18942 (call-interactively 'org-timestamp-down)))
18943 (t (org-modifier-cursor-error))))
18945 (defsubst org-hidden-tree-error ()
18946 (error
18947 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18949 (defun org-metaleft (&optional arg)
18950 "Promote heading or move table column to left.
18951 Calls `org-do-promote' or `org-table-move-column', depending on context.
18952 With no specific context, calls the Emacs default `backward-word'.
18953 See the individual commands for more information."
18954 (interactive "P")
18955 (cond
18956 ((run-hook-with-args-until-success 'org-metaleft-hook))
18957 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18958 ((org-with-limited-levels
18959 (or (org-at-heading-p)
18960 (and (org-region-active-p)
18961 (save-excursion
18962 (goto-char (region-beginning))
18963 (org-at-heading-p)))))
18964 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18965 (call-interactively 'org-do-promote))
18966 ;; At an inline task.
18967 ((org-at-heading-p)
18968 (call-interactively 'org-inlinetask-promote))
18969 ((or (org-at-item-p)
18970 (and (org-region-active-p)
18971 (save-excursion
18972 (goto-char (region-beginning))
18973 (org-at-item-p))))
18974 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18975 (call-interactively 'org-outdent-item))
18976 (t (call-interactively 'backward-word))))
18978 (defun org-metaright (&optional arg)
18979 "Demote a subtree, a list item or move table column to right.
18980 In front of a drawer or a block keyword, indent it correctly.
18981 With no specific context, calls the Emacs default `forward-word'.
18982 See the individual commands for more information."
18983 (interactive "P")
18984 (cond
18985 ((run-hook-with-args-until-success 'org-metaright-hook))
18986 ((org-at-table-p) (call-interactively 'org-table-move-column))
18987 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18988 ((org-at-block-p) (call-interactively 'org-indent-block))
18989 ((org-with-limited-levels
18990 (or (org-at-heading-p)
18991 (and (org-region-active-p)
18992 (save-excursion
18993 (goto-char (region-beginning))
18994 (org-at-heading-p)))))
18995 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18996 (call-interactively 'org-do-demote))
18997 ;; At an inline task.
18998 ((org-at-heading-p)
18999 (call-interactively 'org-inlinetask-demote))
19000 ((or (org-at-item-p)
19001 (and (org-region-active-p)
19002 (save-excursion
19003 (goto-char (region-beginning))
19004 (org-at-item-p))))
19005 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19006 (call-interactively 'org-indent-item))
19007 (t (call-interactively 'forward-word))))
19009 (defun org-check-for-hidden (what)
19010 "Check if there are hidden headlines/items in the current visual line.
19011 WHAT can be either `headlines' or `items'. If the current line is
19012 an outline or item heading and it has a folded subtree below it,
19013 this function returns t, nil otherwise."
19014 (let ((re (cond
19015 ((eq what 'headlines) org-outline-regexp-bol)
19016 ((eq what 'items) (org-item-beginning-re))
19017 (t (error "This should not happen"))))
19018 beg end)
19019 (save-excursion
19020 (catch 'exit
19021 (unless (org-region-active-p)
19022 (setq beg (point-at-bol))
19023 (beginning-of-line 2)
19024 (while (and (not (eobp)) ;; this is like `next-line'
19025 (get-char-property (1- (point)) 'invisible))
19026 (beginning-of-line 2))
19027 (setq end (point))
19028 (goto-char beg)
19029 (goto-char (point-at-eol))
19030 (setq end (max end (point)))
19031 (while (re-search-forward re end t)
19032 (if (get-char-property (match-beginning 0) 'invisible)
19033 (throw 'exit t))))
19034 nil))))
19036 (defun org-metaup (&optional arg)
19037 "Move subtree up or move table row up.
19038 Calls `org-move-subtree-up' or `org-table-move-row' or
19039 `org-move-item-up', depending on context. See the individual commands
19040 for more information."
19041 (interactive "P")
19042 (cond
19043 ((run-hook-with-args-until-success 'org-metaup-hook))
19044 ((org-region-active-p)
19045 (let* ((a (min (region-beginning) (region-end)))
19046 (b (1- (max (region-beginning) (region-end))))
19047 (c (save-excursion (goto-char a)
19048 (move-beginning-of-line 0)))
19049 (d (save-excursion (goto-char a)
19050 (move-end-of-line 0) (point))))
19051 (transpose-regions a b c d)
19052 (goto-char c)))
19053 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19054 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19055 ((org-at-item-p) (call-interactively 'org-move-item-up))
19056 (t (org-drag-element-backward))))
19058 (defun org-metadown (&optional arg)
19059 "Move subtree down or move table row down.
19060 Calls `org-move-subtree-down' or `org-table-move-row' or
19061 `org-move-item-down', depending on context. See the individual
19062 commands for more information."
19063 (interactive "P")
19064 (cond
19065 ((run-hook-with-args-until-success 'org-metadown-hook))
19066 ((org-region-active-p)
19067 (let* ((a (min (region-beginning) (region-end)))
19068 (b (max (region-beginning) (region-end)))
19069 (c (save-excursion (goto-char b)
19070 (move-beginning-of-line 1)))
19071 (d (save-excursion (goto-char b)
19072 (move-end-of-line 1) (1+ (point)))))
19073 (transpose-regions a b c d)
19074 (goto-char d)))
19075 ((org-at-table-p) (call-interactively 'org-table-move-row))
19076 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19077 ((org-at-item-p) (call-interactively 'org-move-item-down))
19078 (t (org-drag-element-forward))))
19080 (defun org-shiftup (&optional arg)
19081 "Increase item in timestamp or increase priority of current headline.
19082 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19083 depending on context. See the individual commands for more information."
19084 (interactive "P")
19085 (cond
19086 ((run-hook-with-args-until-success 'org-shiftup-hook))
19087 ((and org-support-shift-select (org-region-active-p))
19088 (org-call-for-shift-select 'previous-line))
19089 ((org-at-timestamp-p t)
19090 (call-interactively (if org-edit-timestamp-down-means-later
19091 'org-timestamp-down 'org-timestamp-up)))
19092 ((and (not (eq org-support-shift-select 'always))
19093 org-enable-priority-commands
19094 (org-at-heading-p))
19095 (call-interactively 'org-priority-up))
19096 ((and (not org-support-shift-select) (org-at-item-p))
19097 (call-interactively 'org-previous-item))
19098 ((org-clocktable-try-shift 'up arg))
19099 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19100 (org-support-shift-select
19101 (org-call-for-shift-select 'previous-line))
19102 (t (org-shiftselect-error))))
19104 (defun org-shiftdown (&optional arg)
19105 "Decrease item in timestamp or decrease priority of current headline.
19106 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19107 depending on context. See the individual commands for more information."
19108 (interactive "P")
19109 (cond
19110 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19111 ((and org-support-shift-select (org-region-active-p))
19112 (org-call-for-shift-select 'next-line))
19113 ((org-at-timestamp-p t)
19114 (call-interactively (if org-edit-timestamp-down-means-later
19115 'org-timestamp-up 'org-timestamp-down)))
19116 ((and (not (eq org-support-shift-select 'always))
19117 org-enable-priority-commands
19118 (org-at-heading-p))
19119 (call-interactively 'org-priority-down))
19120 ((and (not org-support-shift-select) (org-at-item-p))
19121 (call-interactively 'org-next-item))
19122 ((org-clocktable-try-shift 'down arg))
19123 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19124 (org-support-shift-select
19125 (org-call-for-shift-select 'next-line))
19126 (t (org-shiftselect-error))))
19128 (defun org-shiftright (&optional arg)
19129 "Cycle the thing at point or in the current line, depending on context.
19130 Depending on context, this does one of the following:
19132 - switch a timestamp at point one day into the future
19133 - on a headline, switch to the next TODO keyword.
19134 - on an item, switch entire list to the next bullet type
19135 - on a property line, switch to the next allowed value
19136 - on a clocktable definition line, move time block into the future"
19137 (interactive "P")
19138 (cond
19139 ((run-hook-with-args-until-success 'org-shiftright-hook))
19140 ((and org-support-shift-select (org-region-active-p))
19141 (org-call-for-shift-select 'forward-char))
19142 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19143 ((and (not (eq org-support-shift-select 'always))
19144 (org-at-heading-p))
19145 (let ((org-inhibit-logging
19146 (not org-treat-S-cursor-todo-selection-as-state-change))
19147 (org-inhibit-blocking
19148 (not org-treat-S-cursor-todo-selection-as-state-change)))
19149 (org-call-with-arg 'org-todo 'right)))
19150 ((or (and org-support-shift-select
19151 (not (eq org-support-shift-select 'always))
19152 (org-at-item-bullet-p))
19153 (and (not org-support-shift-select) (org-at-item-p)))
19154 (org-call-with-arg 'org-cycle-list-bullet nil))
19155 ((and (not (eq org-support-shift-select 'always))
19156 (org-at-property-p))
19157 (call-interactively 'org-property-next-allowed-value))
19158 ((org-clocktable-try-shift 'right arg))
19159 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19160 (org-support-shift-select
19161 (org-call-for-shift-select 'forward-char))
19162 (t (org-shiftselect-error))))
19164 (defun org-shiftleft (&optional arg)
19165 "Cycle the thing at point or in the current line, depending on context.
19166 Depending on context, this does one of the following:
19168 - switch a timestamp at point one day into the past
19169 - on a headline, switch to the previous TODO keyword.
19170 - on an item, switch entire list to the previous bullet type
19171 - on a property line, switch to the previous allowed value
19172 - on a clocktable definition line, move time block into the past"
19173 (interactive "P")
19174 (cond
19175 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19176 ((and org-support-shift-select (org-region-active-p))
19177 (org-call-for-shift-select 'backward-char))
19178 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19179 ((and (not (eq org-support-shift-select 'always))
19180 (org-at-heading-p))
19181 (let ((org-inhibit-logging
19182 (not org-treat-S-cursor-todo-selection-as-state-change))
19183 (org-inhibit-blocking
19184 (not org-treat-S-cursor-todo-selection-as-state-change)))
19185 (org-call-with-arg 'org-todo 'left)))
19186 ((or (and org-support-shift-select
19187 (not (eq org-support-shift-select 'always))
19188 (org-at-item-bullet-p))
19189 (and (not org-support-shift-select) (org-at-item-p)))
19190 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19191 ((and (not (eq org-support-shift-select 'always))
19192 (org-at-property-p))
19193 (call-interactively 'org-property-previous-allowed-value))
19194 ((org-clocktable-try-shift 'left arg))
19195 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19196 (org-support-shift-select
19197 (org-call-for-shift-select 'backward-char))
19198 (t (org-shiftselect-error))))
19200 (defun org-shiftcontrolright ()
19201 "Switch to next TODO set."
19202 (interactive)
19203 (cond
19204 ((and org-support-shift-select (org-region-active-p))
19205 (org-call-for-shift-select 'forward-word))
19206 ((and (not (eq org-support-shift-select 'always))
19207 (org-at-heading-p))
19208 (org-call-with-arg 'org-todo 'nextset))
19209 (org-support-shift-select
19210 (org-call-for-shift-select 'forward-word))
19211 (t (org-shiftselect-error))))
19213 (defun org-shiftcontrolleft ()
19214 "Switch to previous TODO set."
19215 (interactive)
19216 (cond
19217 ((and org-support-shift-select (org-region-active-p))
19218 (org-call-for-shift-select 'backward-word))
19219 ((and (not (eq org-support-shift-select 'always))
19220 (org-at-heading-p))
19221 (org-call-with-arg 'org-todo 'previousset))
19222 (org-support-shift-select
19223 (org-call-for-shift-select 'backward-word))
19224 (t (org-shiftselect-error))))
19226 (defun org-shiftcontrolup (&optional n)
19227 "Change timestamps synchronously up in CLOCK log lines.
19228 Optional argument N tells to change by that many units."
19229 (interactive "P")
19230 (cond ((and (not org-support-shift-select)
19231 (org-at-clock-log-p)
19232 (org-at-timestamp-p t))
19233 (org-clock-timestamps-up n))
19234 (t (org-shiftselect-error))))
19236 (defun org-shiftcontroldown (&optional n)
19237 "Change timestamps synchronously down in CLOCK log lines.
19238 Optional argument N tells to change by that many units."
19239 (interactive "P")
19240 (cond ((and (not org-support-shift-select)
19241 (org-at-clock-log-p)
19242 (org-at-timestamp-p t))
19243 (org-clock-timestamps-down n))
19244 (t (org-shiftselect-error))))
19246 (defun org-ctrl-c-ret ()
19247 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19248 (interactive)
19249 (cond
19250 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19251 (t (call-interactively 'org-insert-heading))))
19253 (defun org-find-visible ()
19254 (let ((s (point)))
19255 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19256 (get-char-property s 'invisible)))
19257 s))
19258 (defun org-find-invisible ()
19259 (let ((s (point)))
19260 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19261 (not (get-char-property s 'invisible))))
19262 s))
19264 (defun org-copy-visible (beg end)
19265 "Copy the visible parts of the region."
19266 (interactive "r")
19267 (let (snippets s)
19268 (save-excursion
19269 (save-restriction
19270 (narrow-to-region beg end)
19271 (setq s (goto-char (point-min)))
19272 (while (not (= (point) (point-max)))
19273 (goto-char (org-find-invisible))
19274 (push (buffer-substring s (point)) snippets)
19275 (setq s (goto-char (org-find-visible))))))
19276 (kill-new (apply 'concat (nreverse snippets)))))
19278 (defun org-copy-special ()
19279 "Copy region in table or copy current subtree.
19280 Calls `org-table-copy' or `org-copy-subtree', depending on context.
19281 See the individual commands for more information."
19282 (interactive)
19283 (call-interactively
19284 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
19286 (defun org-cut-special ()
19287 "Cut region in table or cut current subtree.
19288 Calls `org-table-copy' or `org-cut-subtree', depending on context.
19289 See the individual commands for more information."
19290 (interactive)
19291 (call-interactively
19292 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
19294 (defun org-paste-special (arg)
19295 "Paste rectangular region into table, or past subtree relative to level.
19296 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
19297 See the individual commands for more information."
19298 (interactive "P")
19299 (if (org-at-table-p)
19300 (org-table-paste-rectangle)
19301 (org-paste-subtree arg)))
19303 (defsubst org-in-fixed-width-region-p ()
19304 "Is point in a fixed-width region?"
19305 (eq 'fixed-width (org-element-type (org-element-at-point))))
19307 (defun org-edit-special (&optional arg)
19308 "Call a special editor for the stuff at point.
19309 When at a table, call the formula editor with `org-table-edit-formulas'.
19310 When in a source code block, call `org-edit-src-code'.
19311 When in an #+include line, visit the included file.
19312 On a link, call `ffap' to visit the link at point.
19313 Otherwise, return a user error."
19314 (interactive)
19315 ;; possibly prep session before editing source
19316 (when (and (org-in-src-block-p) arg)
19317 (let* ((info (org-babel-get-src-block-info))
19318 (lang (nth 0 info))
19319 (params (nth 2 info))
19320 (session (cdr (assoc :session params))))
19321 (when (and info session) ;; we are in a source-code block with a session
19322 (funcall
19323 (intern (concat "org-babel-prep-session:" lang)) session params))))
19324 (cond ;; proceed with `org-edit-special'
19325 ((save-excursion
19326 (beginning-of-line 1)
19327 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
19328 (find-file (org-trim (match-string 1))))
19329 ((or (org-at-table-p)
19330 (save-excursion
19331 (beginning-of-line 1)
19333 (call-interactively 'org-table-edit-formulas))
19334 ((or (org-in-src-block-p) (org-at-table.el-p)) (org-edit-src-code))
19335 ((org-in-fixed-width-region-p) (org-edit-fixed-width-region))
19336 ((org-at-regexp-p org-any-link-re) (call-interactively 'ffap))
19337 (t (user-error "No special environment to edit here"))))
19339 (defvar org-table-coordinate-overlays) ; defined in org-table.el
19340 (defun org-ctrl-c-ctrl-c (&optional arg)
19341 "Set tags in headline, or update according to changed information at point.
19343 This command does many different things, depending on context:
19345 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
19346 this is what we do.
19348 - If the cursor is on a statistics cookie, update it.
19350 - If the cursor is in a headline, prompt for tags and insert them
19351 into the current line, aligned to `org-tags-column'. When called
19352 with prefix arg, realign all tags in the current buffer.
19354 - If the cursor is in one of the special #+KEYWORD lines, this
19355 triggers scanning the buffer for these lines and updating the
19356 information.
19358 - If the cursor is inside a table, realign the table. This command
19359 works even if the automatic table editor has been turned off.
19361 - If the cursor is on a #+TBLFM line, re-apply the formulas to
19362 the entire table.
19364 - If the cursor is at a footnote reference or definition, jump to
19365 the corresponding definition or references, respectively.
19367 - If the cursor is a the beginning of a dynamic block, update it.
19369 - If the current buffer is a capture buffer, close note and file it.
19371 - If the cursor is on a <<<target>>>, update radio targets and
19372 corresponding links in this buffer.
19374 - If the cursor is on a numbered item in a plain list, renumber the
19375 ordered list.
19377 - If the cursor is on a checkbox, toggle it.
19379 - If the cursor is on a code block, evaluate it. The variable
19380 `org-confirm-babel-evaluate' can be used to control prompting
19381 before code block evaluation, by default every code block
19382 evaluation requires confirmation. Code block evaluation can be
19383 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
19384 (interactive "P")
19385 (let ((org-enable-table-editor t))
19386 (cond
19387 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
19388 org-occur-highlights
19389 org-latex-fragment-image-overlays)
19390 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
19391 (org-remove-occur-highlights)
19392 (org-remove-latex-fragment-image-overlays)
19393 (message "Temporary highlights/overlays removed from current buffer"))
19394 ((and (local-variable-p 'org-finish-function (current-buffer))
19395 (fboundp org-finish-function))
19396 (funcall org-finish-function))
19397 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
19398 ((org-in-regexp org-ts-regexp-both)
19399 (org-timestamp-change 0 'day))
19400 ((or (looking-at org-property-start-re)
19401 (org-at-property-p))
19402 (call-interactively 'org-property-action))
19403 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
19405 (or (org-at-heading-p) (org-at-item-p)))
19406 (call-interactively 'org-update-statistics-cookies))
19407 ((org-at-heading-p) (call-interactively 'org-set-tags))
19408 ((org-at-table.el-p)
19409 (message "Use C-c ' to edit table.el tables"))
19410 ((org-at-table-p)
19411 (org-table-maybe-eval-formula)
19412 (if arg
19413 (call-interactively 'org-table-recalculate)
19414 (org-table-maybe-recalculate-line))
19415 (call-interactively 'org-table-align)
19416 (orgtbl-send-table 'maybe))
19417 ((or (org-footnote-at-reference-p)
19418 (org-footnote-at-definition-p))
19419 (call-interactively 'org-footnote-action))
19420 ((org-at-item-checkbox-p)
19421 ;; Cursor at a checkbox: repair list and update checkboxes. Send
19422 ;; list only if at top item.
19423 (let* ((cbox (match-string 1))
19424 (struct (org-list-struct))
19425 (old-struct (copy-tree struct))
19426 (parents (org-list-parents-alist struct))
19427 (orderedp (org-entry-get nil "ORDERED"))
19428 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19429 block-item)
19430 ;; Use a light version of `org-toggle-checkbox' to avoid
19431 ;; computing list structure twice.
19432 (let ((new-box (cond
19433 ((equal arg '(16)) "[-]")
19434 ((equal arg '(4)) nil)
19435 ((equal "[X]" cbox) "[ ]")
19436 (t "[X]"))))
19437 (if (and firstp arg)
19438 ;; If at first item of sub-list, remove check-box from
19439 ;; every item at the same level.
19440 (mapc
19441 (lambda (pos) (org-list-set-checkbox pos struct new-box))
19442 (org-list-get-all-items
19443 (point-at-bol) struct (org-list-prevs-alist struct)))
19444 (org-list-set-checkbox (point-at-bol) struct new-box)))
19445 ;; Replicate `org-list-write-struct', while grabbing a return
19446 ;; value from `org-list-struct-fix-box'.
19447 (org-list-struct-fix-ind struct parents 2)
19448 (org-list-struct-fix-item-end struct)
19449 (let ((prevs (org-list-prevs-alist struct)))
19450 (org-list-struct-fix-bul struct prevs)
19451 (org-list-struct-fix-ind struct parents)
19452 (setq block-item
19453 (org-list-struct-fix-box struct parents prevs orderedp)))
19454 (org-list-struct-apply-struct struct old-struct)
19455 (org-update-checkbox-count-maybe)
19456 (when block-item
19457 (message
19458 "Checkboxes were removed due to unchecked box at line %d"
19459 (org-current-line block-item)))
19460 (when firstp (org-list-send-list 'maybe))))
19461 ((org-at-item-p)
19462 ;; Cursor at an item: repair list. Do checkbox related actions
19463 ;; only if function was called with an argument. Send list only
19464 ;; if at top item.
19465 (let* ((struct (org-list-struct))
19466 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19467 old-struct)
19468 (when arg
19469 (setq old-struct (copy-tree struct))
19470 (if firstp
19471 ;; If at first item of sub-list, add check-box to every
19472 ;; item at the same level.
19473 (mapc
19474 (lambda (pos)
19475 (unless (org-list-get-checkbox pos struct)
19476 (org-list-set-checkbox pos struct "[ ]")))
19477 (org-list-get-all-items
19478 (point-at-bol) struct (org-list-prevs-alist struct)))
19479 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
19480 (org-list-write-struct
19481 struct (org-list-parents-alist struct) old-struct)
19482 (when arg (org-update-checkbox-count-maybe))
19483 (when firstp (org-list-send-list 'maybe))))
19484 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
19485 ;; Dynamic block
19486 (beginning-of-line 1)
19487 (save-excursion (org-update-dblock)))
19488 ((save-excursion
19489 (let ((case-fold-search t))
19490 (beginning-of-line 1)
19492 (cond
19493 ((or (equal (match-string 1) "TBLFM")
19494 (equal (match-string 1) "tblfm"))
19495 ;; Recalculate the table before this line
19496 (save-excursion
19497 (beginning-of-line 1)
19499 (if (org-at-table-p)
19500 (org-call-with-arg 'org-table-recalculate (or arg t)))))
19501 (t
19502 (let ((org-inhibit-startup-visibility-stuff t)
19503 (org-startup-align-all-tables nil))
19504 (when (boundp 'org-table-coordinate-overlays)
19505 (mapc 'delete-overlay org-table-coordinate-overlays)
19506 (setq org-table-coordinate-overlays nil))
19507 (org-save-outline-visibility 'use-markers (org-mode-restart)))
19508 (message "Local setup has been refreshed"))))
19509 ((org-clock-update-time-maybe))
19510 (t
19511 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19512 (error "C-c C-c can do nothing useful at this location"))))))
19514 (defun org-mode-restart ()
19515 "Restart Org-mode, to scan again for special lines.
19516 Also updates the keyword regular expressions."
19517 (interactive)
19518 (org-mode)
19519 (message "Org-mode restarted"))
19521 (defun org-kill-note-or-show-branches ()
19522 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
19523 (interactive)
19524 (if (not org-finish-function)
19525 (progn
19526 (hide-subtree)
19527 (call-interactively 'show-branches))
19528 (let ((org-note-abort t))
19529 (funcall org-finish-function))))
19531 (defun org-return (&optional indent)
19532 "Goto next table row or insert a newline.
19533 Calls `org-table-next-row' or `newline', depending on context.
19534 See the individual commands for more information."
19535 (interactive)
19536 (let (org-ts-what)
19537 (cond
19538 ((or (bobp) (org-in-src-block-p))
19539 (if indent (newline-and-indent) (newline)))
19540 ((org-at-table-p)
19541 (org-table-justify-field-maybe)
19542 (call-interactively 'org-table-next-row))
19543 ;; when `newline-and-indent' is called within a list, make sure
19544 ;; text moved stays inside the item.
19545 ((and (org-in-item-p) indent)
19546 (if (and (org-at-item-p) (>= (point) (match-end 0)))
19547 (progn
19548 (save-match-data (newline))
19549 (org-indent-line-to (length (match-string 0))))
19550 (let ((ind (org-get-indentation)))
19551 (newline)
19552 (if (org-looking-back org-list-end-re)
19553 (org-indent-line)
19554 (org-indent-line-to ind)))))
19555 ((and org-return-follows-link
19556 (org-at-timestamp-p t)
19557 (not (eq org-ts-what 'after)))
19558 (org-follow-timestamp-link))
19559 ((and org-return-follows-link
19560 (let ((tprop (get-text-property (point) 'face)))
19561 (or (eq tprop 'org-link)
19562 (and (listp tprop) (memq 'org-link tprop)))))
19563 (call-interactively 'org-open-at-point))
19564 ((and (org-at-heading-p)
19565 (looking-at
19567 (org-show-entry)
19568 (end-of-line 1)
19569 (newline))
19570 (t (if indent (newline-and-indent) (newline))))))
19572 (defun org-return-indent ()
19573 "Goto next table row or insert a newline and indent.
19574 Calls `org-table-next-row' or `newline-and-indent', depending on
19575 context. See the individual commands for more information."
19576 (interactive)
19577 (org-return t))
19579 (defun org-ctrl-c-star ()
19580 "Compute table, or change heading status of lines.
19581 Calls `org-table-recalculate' or `org-toggle-heading',
19582 depending on context."
19583 (interactive)
19584 (cond
19585 ((org-at-table-p)
19586 (call-interactively 'org-table-recalculate))
19587 (t
19588 ;; Convert all lines in region to list items
19589 (call-interactively 'org-toggle-heading))))
19591 (defun org-ctrl-c-minus ()
19592 "Insert separator line in table or modify bullet status of line.
19593 Also turns a plain line or a region of lines into list items.
19594 Calls `org-table-insert-hline', `org-toggle-item', or
19595 `org-cycle-list-bullet', depending on context."
19596 (interactive)
19597 (cond
19598 ((org-at-table-p)
19599 (call-interactively 'org-table-insert-hline))
19600 ((org-region-active-p)
19601 (call-interactively 'org-toggle-item))
19602 ((org-in-item-p)
19603 (call-interactively 'org-cycle-list-bullet))
19604 (t
19605 (call-interactively 'org-toggle-item))))
19607 (defun org-toggle-item (arg)
19608 "Convert headings or normal lines to items, items to normal lines.
19609 If there is no active region, only the current line is considered.
19611 If the first non blank line in the region is an headline, convert
19612 all headlines to items, shifting text accordingly.
19614 If it is an item, convert all items to normal lines.
19616 If it is normal text, change region into an item. With a prefix
19617 argument ARG, change each line in region into an item."
19618 (interactive "P")
19619 (let ((shift-text
19620 (function
19621 ;; Shift text in current section to IND, from point to END.
19622 ;; The function leaves point to END line.
19623 (lambda (ind end)
19624 (let ((min-i 1000) (end (copy-marker end)))
19625 ;; First determine the minimum indentation (MIN-I) of
19626 ;; the text.
19627 (save-excursion
19628 (catch 'exit
19629 (while (< (point) end)
19630 (let ((i (org-get-indentation)))
19631 (cond
19632 ;; Skip blank lines and inline tasks.
19634 ((looking-at org-outline-regexp-bol))
19635 ;; We can't find less than 0 indentation.
19636 ((zerop i) (throw 'exit (setq min-i 0)))
19637 ((< i min-i) (setq min-i i))))
19638 (forward-line))))
19639 ;; Then indent each line so that a line indented to
19640 ;; MIN-I becomes indented to IND. Ignore blank lines
19641 ;; and inline tasks in the process.
19642 (let ((delta (- ind min-i)))
19643 (while (< (point) end)
19645 (looking-at org-outline-regexp-bol))
19646 (org-indent-line-to (+ (org-get-indentation) delta)))
19647 (forward-line)))))))
19648 (skip-blanks
19649 (function
19650 ;; Return beginning of first non-blank line, starting from
19651 ;; line at POS.
19652 (lambda (pos)
19653 (save-excursion
19654 (goto-char pos)
19656 (point-at-bol)))))
19657 beg end)
19658 ;; Determine boundaries of changes.
19659 (if (org-region-active-p)
19660 (setq beg (funcall skip-blanks (region-beginning))
19661 end (copy-marker (region-end)))
19662 (setq beg (funcall skip-blanks (point-at-bol))
19663 end (copy-marker (point-at-eol))))
19664 ;; Depending on the starting line, choose an action on the text
19665 ;; between BEG and END.
19666 (org-with-limited-levels
19667 (save-excursion
19668 (goto-char beg)
19669 (cond
19670 ;; Case 1. Start at an item: de-itemize. Note that it only
19671 ;; happens when a region is active: `org-ctrl-c-minus'
19672 ;; would call `org-cycle-list-bullet' otherwise.
19673 ((org-at-item-p)
19674 (while (< (point) end)
19675 (when (org-at-item-p)
19677 (delete-region (point) (match-end 0)))
19678 (forward-line)))
19679 ;; Case 2. Start at an heading: convert to items.
19680 ((org-at-heading-p)
19681 (let* ((bul (org-list-bullet-string "-"))
19682 (bul-len (length bul))
19683 ;; Indentation of the first heading. It should be
19684 ;; relative to the indentation of its parent, if any.
19685 (start-ind (save-excursion
19686 (cond
19687 ((not org-adapt-indentation) 0)
19688 ((not (outline-previous-heading)) 0)
19689 (t (length (match-string 0))))))
19690 ;; Level of first heading. Further headings will be
19691 ;; compared to it to determine hierarchy in the list.
19692 (ref-level (org-reduced-level (org-outline-level))))
19693 (while (< (point) end)
19694 (let* ((level (org-reduced-level (org-outline-level)))
19695 (delta (max 0 (- level ref-level))))
19696 ;; If current headline is less indented than the first
19697 ;; one, set it as reference, in order to preserve
19698 ;; subtrees.
19699 (when (< level ref-level) (setq ref-level level))
19700 (replace-match bul t t)
19701 (org-indent-line-to (+ start-ind (* delta bul-len)))
19702 ;; Ensure all text down to END (or SECTION-END) belongs
19703 ;; to the newly created item.
19704 (let ((section-end (save-excursion
19705 (or (outline-next-heading) (point)))))
19706 (forward-line)
19707 (funcall shift-text
19708 (+ start-ind (* (1+ delta) bul-len))
19709 (min end section-end)))))))
19710 ;; Case 3. Normal line with ARG: turn each non-item line into
19711 ;; an item.
19712 (arg
19713 (while (< (point) end)
19714 (unless (or (org-at-heading-p) (org-at-item-p))
19716 (replace-match
19718 (forward-line)))
19719 ;; Case 4. Normal line without ARG: make the first line of
19720 ;; region an item, and shift indentation of others
19721 ;; lines to set them as item's body.
19722 (t (let* ((bul (org-list-bullet-string "-"))
19723 (bul-len (length bul))
19724 (ref-ind (org-get-indentation)))
19726 (insert bul)
19727 (forward-line)
19728 (while (< (point) end)
19729 ;; Ensure that lines less indented than first one
19730 ;; still get included in item body.
19731 (funcall shift-text
19732 (+ ref-ind bul-len)
19733 (min end (save-excursion (or (outline-next-heading)
19734 (point)))))
19735 (forward-line)))))))))
19737 (defun org-toggle-heading (&optional nstars)
19738 "Convert headings to normal text, or items or text to headings.
19739 If there is no active region, only the current line is considered.
19742 point into heading.
19744 In a region:
19746 - If the first non blank line is an headline, remove the stars
19747 from all headlines in the region.
19749 - If it is a normal line turn each and every normal line (i.e. not an
19750 heading or an item) in the region into a heading.
19752 - If it is a plain list item, turn all plain list items into headings.
19754 When converting a line into a heading, the number of stars is chosen
19755 such that the lines become children of the current entry. However,
19756 when a prefix argument is given, its value determines the number of
19757 stars to add."
19758 (interactive "P")
19759 (let ((skip-blanks
19760 (function
19761 ;; Return beginning of first non-blank line, starting from
19762 ;; line at POS.
19763 (lambda (pos)
19764 (save-excursion
19765 (goto-char pos)
19766 (while (org-at-comment-p) (forward-line))
19768 (point-at-bol)))))
19769 beg end toggled)
19770 ;; Determine boundaries of changes. If a universal prefix has
19771 ;; been given, put the list in a region. If region ends at a bol,
19772 ;; do not consider the last line to be in the region.
19774 (when (and current-prefix-arg (org-at-item-p))
19775 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
19776 (org-mark-element))
19778 (if (org-region-active-p)
19779 (setq beg (funcall skip-blanks (region-beginning))
19780 end (copy-marker (save-excursion
19781 (goto-char (region-end))
19782 (if (bolp) (point) (point-at-eol)))))
19783 (setq beg (funcall skip-blanks (point-at-bol))
19784 end (copy-marker (point-at-eol))))
19785 ;; Ensure inline tasks don't count as headings.
19786 (org-with-limited-levels
19787 (save-excursion
19788 (goto-char beg)
19789 (cond
19790 ;; Case 1. Started at an heading: de-star headings.
19791 ((org-at-heading-p)
19792 (while (< (point) end)
19793 (when (org-at-heading-p t)
19794 (looking-at org-outline-regexp) (replace-match "")
19795 (setq toggled t))
19796 (forward-line)))
19797 ;; Case 2. Started at an item: change items into headlines.
19798 ;; One star will be added by `org-list-to-subtree'.
19799 ((org-at-item-p)
19800 (let* ((stars (make-string
19801 (if nstars
19802 ;; subtract the star that will be added again by
19803 ;; `org-list-to-subtree'
19804 (1- (prefix-numeric-value current-prefix-arg))
19805 (or (org-current-level) 0))
19806 ?*))
19807 (add-stars
19808 (cond (nstars "") ; stars from prefix only
19809 ((equal stars "") "") ; before first heading
19810 (org-odd-levels-only "*") ; inside heading, odd
19811 (t "")))) ; inside heading, oddeven
19812 (while (< (point) end)
19813 (when (org-at-item-p)
19814 ;; Pay attention to cases when region ends before list.
19815 (let* ((struct (org-list-struct))
19816 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
19817 (save-restriction
19818 (narrow-to-region (point) list-end)
19819 (insert
19820 (org-list-to-subtree
19821 (org-list-parse-list t)
19822 '(:istart (concat stars add-stars (funcall get-stars depth))
19823 :icount (concat stars add-stars (funcall get-stars depth)))))))
19824 (setq toggled t))
19825 (forward-line))))
19826 ;; Case 3. Started at normal text: make every line an heading,
19827 ;; skipping headlines and items.
19828 (t (let* ((stars (make-string
19829 (if nstars
19830 (prefix-numeric-value current-prefix-arg)
19831 (or (org-current-level) 0))
19832 ?*))
19833 (add-stars
19834 (cond (nstars "") ; stars from prefix only
19835 ((equal stars "") "*") ; before first heading
19836 (org-odd-levels-only "**") ; inside heading, odd
19837 (t "*"))) ; inside heading, oddeven
19838 (rpl (concat stars add-stars " ")))
19839 (while (< (point) end)
19840 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
19842 (replace-match (concat rpl (match-string 2))) (setq toggled t))
19843 (forward-line)))))))
19844 (unless toggled (message "Cannot toggle heading from here"))))
19846 (defun org-meta-return (&optional arg)
19847 "Insert a new heading or wrap a region in a table.
19848 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
19849 See the individual commands for more information."
19850 (interactive "P")
19851 (cond
19852 ((run-hook-with-args-until-success 'org-metareturn-hook))
19853 ((or (org-at-drawer-p) (org-at-property-p))
19854 (newline-and-indent))
19855 ((org-at-table-p)
19856 (call-interactively 'org-table-wrap-region))
19857 (t (call-interactively 'org-insert-heading))))
19859 ;;; Menu entries
19861 (defsubst org-in-subtree-not-table-p ()
19862 "Are we in a subtree and not in a table?"
19863 (and (not (org-before-first-heading-p))
19864 (not (org-at-table-p))))
19866 ;; Define the Org-mode menus
19867 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
19868 '("Tbl"
19869 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
19870 ["Next Field" org-cycle (org-at-table-p)]
19871 ["Previous Field" org-shifttab (org-at-table-p)]
19872 ["Next Row" org-return (org-at-table-p)]
19873 "--"
19874 ["Blank Field" org-table-blank-field (org-at-table-p)]
19875 ["Edit Field" org-table-edit-field (org-at-table-p)]
19876 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
19877 "--"
19878 ("Column"
19879 ["Move Column Left" org-metaleft (org-at-table-p)]
19880 ["Move Column Right" org-metaright (org-at-table-p)]
19881 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
19882 ["Insert Column" org-shiftmetaright (org-at-table-p)])
19883 ("Row"
19884 ["Move Row Up" org-metaup (org-at-table-p)]
19885 ["Move Row Down" org-metadown (org-at-table-p)]
19886 ["Delete Row" org-shiftmetaup (org-at-table-p)]
19887 ["Insert Row" org-shiftmetadown (org-at-table-p)]
19888 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
19889 "--"
19890 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
19891 ("Rectangle"
19892 ["Copy Rectangle" org-copy-special (org-at-table-p)]
19893 ["Cut Rectangle" org-cut-special (org-at-table-p)]
19894 ["Paste Rectangle" org-paste-special (org-at-table-p)]
19895 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
19896 "--"
19897 ("Calculate"
19898 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
19899 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
19900 ["Edit Formulas" org-edit-special (org-at-table-p)]
19901 "--"
19902 ["Recalculate line" org-table-recalculate (org-at-table-p)]
19903 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
19904 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
19905 "--"
19906 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
19907 "--"
19908 ["Sum Column/Rectangle" org-table-sum
19909 (or (org-at-table-p) (org-region-active-p))]
19910 ["Which Column?" org-table-current-column (org-at-table-p)])
19911 ["Debug Formulas"
19912 org-table-toggle-formula-debugger
19913 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
19914 ["Show Col/Row Numbers"
19915 org-table-toggle-coordinate-overlays
19916 :style toggle
19917 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
19918 "--"
19919 ["Create" org-table-create (and (not (org-at-table-p))
19920 org-enable-table-editor)]
19921 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
19922 ["Import from File" org-table-import (not (org-at-table-p))]
19923 ["Export to File" org-table-export (org-at-table-p)]
19924 "--"
19925 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
19927 (easy-menu-define org-org-menu org-mode-map "Org menu"
19928 '("Org"
19929 ("Show/Hide"
19930 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
19931 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
19932 ["Sparse Tree..." org-sparse-tree t]
19933 ["Reveal Context" org-reveal t]
19934 ["Show All" show-all t]
19935 "--"
19936 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
19937 "--"
19938 ["New Heading" org-insert-heading t]
19939 ("Navigate Headings"
19940 ["Up" outline-up-heading t]
19941 ["Next" outline-next-visible-heading t]
19942 ["Previous" outline-previous-visible-heading t]
19943 ["Next Same Level" outline-forward-same-level t]
19944 ["Previous Same Level" outline-backward-same-level t]
19945 "--"
19946 ["Jump" org-goto t])
19947 ("Edit Structure"
19948 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
19949 "--"
19950 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
19951 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
19952 "--"
19953 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
19954 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
19955 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19956 "--"
19957 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19958 "--"
19959 ["Copy visible text" org-copy-visible t]
19960 "--"
19961 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
19962 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
19963 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
19964 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
19965 "--"
19966 ["Sort Region/Children" org-sort t]
19967 "--"
19968 ["Convert to odd levels" org-convert-to-odd-levels t]
19969 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19970 ("Editing"
19971 ["Emphasis..." org-emphasize t]
19972 ["Edit Source Example" org-edit-special t]
19973 "--"
19974 ["Footnote new/jump" org-footnote-action t]
19975 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19976 ("Archive"
19977 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
19978 "--"
19979 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
19980 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
19981 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
19982 )
19983 "--"
19984 ("Hyperlinks"
19985 ["Store Link (Global)" org-store-link t]
19986 ["Find existing link to here" org-occur-link-in-agenda-files t]
19987 ["Insert Link" org-insert-link t]
19988 ["Follow Link" org-open-at-point t]
19989 "--"
19990 ["Next link" org-next-link t]
19991 ["Previous link" org-previous-link t]
19992 "--"
19993 ["Descriptive Links"
19994 org-toggle-link-display
19995 :style radio
19996 :selected org-descriptive-links
19997 ]
19998 ["Literal Links"
19999 org-toggle-link-display
20000 :style radio
20001 :selected (not org-descriptive-links)])
20002 "--"
20003 ("TODO Lists"
20004 ["TODO/DONE/-" org-todo t]
20005 ("Select keyword"
20006 ["Next keyword" org-shiftright (org-at-heading-p)]
20007 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20008 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20009 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20010 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20011 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20012 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20013 "--"
20014 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20015 :selected org-enforce-todo-dependencies :style toggle :active t]
20016 "Settings for tree at point"
20017 ["Do Children sequentially" org-toggle-ordered-property :style radio
20018 :selected (org-entry-get nil "ORDERED")
20019 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20020 ["Do Children parallel" org-toggle-ordered-property :style radio
20021 :selected (not (org-entry-get nil "ORDERED"))
20022 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20023 "--"
20024 ["Set Priority" org-priority t]
20025 ["Priority Up" org-shiftup t]
20026 ["Priority Down" org-shiftdown t]
20027 "--"
20028 ["Get news from all feeds" org-feed-update-all t]
20029 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20030 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20031 ("TAGS and Properties"
20032 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20033 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20034 "--"
20035 ["Set property" org-set-property (not (org-before-first-heading-p))]
20036 ["Column view of properties" org-columns t]
20037 ["Insert Column View DBlock" org-insert-columns-dblock t])
20038 ("Dates and Scheduling"
20039 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20040 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20041 ("Change Date"
20042 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20043 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20044 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20045 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20046 ["Compute Time Range" org-evaluate-time-range t]
20047 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20048 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20049 "--"
20050 ["Custom time format" org-toggle-time-stamp-overlays
20051 :style radio :selected org-display-custom-times]
20052 "--"
20053 ["Goto Calendar" org-goto-calendar t]
20054 ["Date from Calendar" org-date-from-calendar t]
20055 "--"
20056 ["Start/Restart Timer" org-timer-start t]
20057 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20058 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20059 ["Insert Timer String" org-timer t]
20060 ["Insert Timer Item" org-timer-item t])
20061 ("Logging work"
20062 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20063 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20064 ["Clock out" org-clock-out t]
20065 ["Clock cancel" org-clock-cancel t]
20066 "--"
20067 ["Mark as default task" org-clock-mark-default-task t]
20068 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20069 ["Goto running clock" org-clock-goto t]
20070 "--"
20071 ["Display times" org-clock-display t]
20072 ["Create clock table" org-clock-report t]
20073 "--"
20074 ["Record DONE time"
20075 (progn (setq org-log-done (not org-log-done))
20076 (message "Switching to %s will %s record a timestamp"
20077 (car org-done-keywords)
20078 (if org-log-done "automatically" "not")))
20079 :style toggle :selected org-log-done])
20080 "--"
20081 ["Agenda Command..." org-agenda t]
20082 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20083 ("File List for Agenda")
20084 ("Special views current file"
20085 ["TODO Tree" org-show-todo-tree t]
20086 ["Check Deadlines" org-check-deadlines t]
20087 ["Timeline" org-timeline t]
20088 ["Tags/Property tree" org-match-sparse-tree t])
20089 "--"
20090 ["Export/Publish..." org-export t]
20091 ("LaTeX"
20092 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20093 :selected org-cdlatex-mode]
20094 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20095 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20096 ["Modify math symbol" org-cdlatex-math-modify
20097 (org-inside-LaTeX-fragment-p)]
20098 ["Insert citation" org-reftex-citation t]
20099 "--"
20100 ["Template for BEAMER" (progn (require 'org-beamer)
20101 (org-insert-beamer-options-template)) t])
20102 "--"
20103 ("MobileOrg"
20104 ["Push Files and Views" org-mobile-push t]
20105 ["Get Captured and Flagged" org-mobile-pull t]
20106 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20107 "--"
20108 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20109 "--"
20110 ("Documentation"
20111 ["Show Version" org-version t]
20112 ["Info Documentation" org-info t])
20113 ("Customize"
20114 ["Browse Org Group" org-customize t]
20115 "--"
20116 ["Expand This Menu" org-create-customize-menu
20117 (fboundp 'customize-menu-create)])
20118 ["Send bug report" org-submit-bug-report t]
20119 "--"
20120 ("Refresh/Reload"
20121 ["Refresh setup current buffer" org-mode-restart t]
20122 ["Reload Org (after update)" org-reload t]
20123 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
20124 ))
20126 (defun org-info (&optional node)
20127 "Read documentation for Org-mode in the info system.
20128 With optional NODE, go directly to that node."
20129 (interactive)
20130 (info (format "(org)%s" (or node ""))))
20132 ;;;###autoload
20133 (defun org-submit-bug-report ()
20134 "Submit a bug report on Org-mode via mail.
20136 Don't hesitate to report any problems or inaccurate documentation.
20138 If you don't have setup sending mail from (X)Emacs, please copy the
20139 output buffer into your mail program, as it gives us important
20140 information about your Org-mode version and configuration."
20141 (interactive)
20142 (require 'reporter)
20143 (org-load-modules-maybe)
20144 (org-require-autoloaded-modules)
20145 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20146 (reporter-submit-bug-report
20147 "emacs-orgmode@gnu.org"
20148 (org-version nil 'full)
20149 (let (list)
20150 (save-window-excursion
20151 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20152 (delete-other-windows)
20153 (erase-buffer)
20154 (insert "You are about to submit a bug report to the Org-mode mailing list.
20156 We would like to add your full Org-mode and Outline configuration to the
20157 bug report. This greatly simplifies the work of the maintainer and
20158 other experts on the mailing list.
20160 HOWEVER, some variables you have customized may contain private
20161 information. The names of customers, colleagues, or friends, might
20162 appear in the form of file names, tags, todo states, or search strings.
20163 If you answer yes to the prompt, you might want to check and remove
20164 such private information before sending the email.")
20165 (add-text-properties (point-min) (point-max) '(face org-warning))
20166 (when (yes-or-no-p "Include your Org-mode configuration ")
20167 (mapatoms
20168 (lambda (v)
20169 (and (boundp v)
20171 (or (and (symbol-value v)
20173 (and
20174 (get v 'custom-type) (get v 'standard-value)
20175 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20176 (push v list)))))
20177 (kill-buffer (get-buffer "*Warn about privacy*"))
20178 list))
20179 nil nil
20180 "Remember to cover the basics, that is, what you expected to happen and
20181 what in fact did happen. You don't know how to make a good report? See
20183 http://orgmode.org/manual/Feedback.html#Feedback
20185 Your bug report will be posted to the Org-mode mailing list.
20186 ------------------------------------------------------------------------")
20187 (save-excursion
20192 (defun org-install-agenda-files-menu ()
20193 (let ((bl (buffer-list)))
20194 (save-excursion
20195 (while bl
20196 (set-buffer (pop bl))
20197 (if (derived-mode-p 'org-mode) (setq bl nil)))
20198 (when (derived-mode-p 'org-mode)
20199 (easy-menu-change
20200 '("Org") "File List for Agenda"
20201 (append
20202 (list
20203 ["Edit File List" (org-edit-agenda-file-list) t]
20204 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
20205 ["Remove Current File from List" org-remove-file t]
20206 ["Cycle through agenda files" org-cycle-agenda-files t]
20207 ["Occur in all agenda files" org-occur-in-agenda-files t]
20208 "--")
20209 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
20211 ;;;; Documentation
20213 (defun org-require-autoloaded-modules ()
20214 (interactive)
20215 (mapc 'require
20216 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
20217 org-docbook org-exp org-html org-icalendar
20218 org-id org-latex
20219 org-publish org-remember org-table
20220 org-timer org-xoxo)))
20222 ;;;###autoload
20223 (defun org-reload (&optional uncompiled)
20224 "Reload all org lisp files.
20225 With prefix arg UNCOMPILED, load the uncompiled versions."
20226 (interactive "P")
20227 (require 'loadhist)
20228 (let* ((org-dir (org-find-library-dir "org"))
20229 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
20231 (remove-re (mapconcat 'identity
20232 (mapcar (lambda (f) (concat "^" f "$"))
20233 (list (if (featurep 'xemacs)
20234 "org-colview"
20235 "org-colview-xemacs")
20236 "org" "org-loaddefs" "org-version"))
20238 (feats (delete-dups
20239 (mapcar 'file-name-sans-extension
20240 (mapcar 'file-name-nondirectory
20241 (delq nil
20242 (mapcar 'feature-file
20243 features))))))
20244 (lfeat (append
20245 (sort
20246 (setq feats
20247 (delq nil (mapcar
20248 (lambda (f)
20249 (if (and (string-match feature-re f)
20250 (not (string-match remove-re f)))
20251 f nil))
20252 feats)))
20253 'string-lessp)
20254 (list "org-version" "org")))
20255 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
20256 load-uncore load-misses)
20257 (setq load-misses
20258 (delq 't
20259 (mapcar (lambda (f)
20260 (or (load (concat org-dir f) 'noerror nil nil 'mustsuffix)
20261 (and (string= org-dir contrib-dir)
20262 (load (concat contrib-dir f) 'noerror nil nil 'mustsuffix))
20263 (and (load (concat (org-find-library-dir f) f) 'noerror nil nil 'mustsuffix)
20264 (add-to-list 'load-uncore f 'append)
20265 't)
20266 f))
20267 lfeat)))
20268 (if load-uncore
20270 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
20271 (if load-misses
20273 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
20276 ;;;###autoload
20277 (defun org-customize ()
20278 "Call the customize function with org as argument."
20279 (interactive)
20280 (org-load-modules-maybe)
20281 (org-require-autoloaded-modules)
20282 (customize-browse 'org))
20284 (defun org-create-customize-menu ()
20285 "Create a full customization menu for Org-mode, insert it into the menu."
20286 (interactive)
20287 (org-load-modules-maybe)
20288 (org-require-autoloaded-modules)
20289 (if (fboundp 'customize-menu-create)
20290 (progn
20291 (easy-menu-change
20292 '("Org") "Customize"
20293 `(["Browse Org group" org-customize t]
20294 "--"
20295 ,(customize-menu-create 'org)
20296 ["Set" Custom-set t]
20297 ["Save" Custom-save t]
20298 ["Reset to Current" Custom-reset-current t]
20299 ["Reset to Saved" Custom-reset-saved t]
20300 ["Reset to Standard Settings" Custom-reset-standard t]))
20302 (error "Cannot expand menu (outdated version of cus-edit.el)")))
20304 ;;;; Miscellaneous stuff
20306 ;;; Generally useful functions
20308 (defun org-get-at-bol (property)
20309 "Get text property PROPERTY at beginning of line."
20310 (get-text-property (point-at-bol) property))
20312 (defun org-find-text-property-in-string (prop s)
20313 "Return the first non-nil value of property PROP in string S."
20314 (or (get-text-property 0 prop s)
20315 (get-text-property (or (next-single-property-change 0 prop s) 0)
20316 prop s)))
20318 (defun org-display-warning (message) ;; Copied from Emacs-Muse
20319 "Display the given MESSAGE as a warning."
20320 (if (fboundp 'display-warning)
20321 (display-warning 'org message
20322 (if (featurep 'xemacs) 'warning :warning))
20323 (let ((buf (get-buffer-create "*Org warnings*")))
20324 (with-current-buffer buf
20325 (goto-char (point-max))
20326 (insert "Warning (Org): " message)
20327 (unless (bolp)
20328 (newline)))
20329 (display-buffer buf)
20330 (sit-for 0))))
20332 (defun org-eval (form)
20333 "Eval FORM and return result."
20334 (condition-case error
20335 (eval form)
20336 (error (format "%%![Error: %s]" error))))
20338 (defun org-in-clocktable-p ()
20339 "Check if the cursor is in a clocktable."
20340 (let ((pos (point)) start)
20341 (save-excursion
20342 (end-of-line 1)
20344 (setq start (match-beginning 0))
20346 (>= (match-end 0) pos)
20347 start))))
20349 (defun org-in-commented-line ()
20350 "Is point in a line starting with `#'?"
20351 (equal (char-after (point-at-bol)) ?#))
20353 (defun org-in-indented-comment-line ()
20354 "Is point in a line starting with `#' after some white space?"
20355 (save-excursion
20356 (save-match-data
20357 (goto-char (point-at-bol))
20360 (defun org-in-verbatim-emphasis ()
20361 (save-match-data
20362 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
20364 (defun org-goto-marker-or-bmk (marker &optional bookmark)
20365 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
20366 (if (and marker (marker-buffer marker)
20367 (buffer-live-p (marker-buffer marker)))
20368 (progn
20369 (org-pop-to-buffer-same-window (marker-buffer marker))
20370 (if (or (> marker (point-max)) (< marker (point-min)))
20371 (widen))
20372 (goto-char marker)
20373 (org-show-context 'org-goto))
20374 (if bookmark
20375 (bookmark-jump bookmark)
20376 (error "Cannot find location"))))
20378 (defun org-quote-csv-field (s)
20379 "Quote field for inclusion in CSV material."
20382 s))
20384 (defun org-force-self-insert (N)
20385 "Needed to enforce self-insert under remapping."
20386 (interactive "p")
20387 (self-insert-command N))
20389 (defun org-string-width (s)
20390 "Compute width of string, ignoring invisible characters.
20391 This ignores character with invisibility property `org-link', and also
20392 characters with property `org-cwidth', because these will become invisible
20393 upon the next fontification round."
20394 (let (b l)
20395 (when (or (eq t buffer-invisibility-spec)
20396 (assq 'org-link buffer-invisibility-spec))
20397 (while (setq b (text-property-any 0 (length s)
20398 'invisible 'org-link s))
20399 (setq s (concat (substring s 0 b)
20400 (substring s (or (next-single-property-change
20401 b 'invisible s) (length s)))))))
20402 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
20403 (setq s (concat (substring s 0 b)
20404 (substring s (or (next-single-property-change
20405 b 'org-cwidth s) (length s))))))
20406 (setq l (string-width s) b -1)
20407 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
20408 (setq l (- l (get-text-property b 'org-dwidth-n s))))
20409 l))
20411 (defun org-shorten-string (s maxlength)
20412 "Shorten string S so tht it is no longer than MAXLENGTH characters.
20413 If the string is shorter or has length MAXLENGTH, just return the
20414 original string. If it is longer, the functions finds a space in the
20415 string, breaks this string off at that locations and adds three dots
20416 as ellipsis. Including the ellipsis, the string will not be longer
20417 than MAXLENGTH. If finding a good breaking point in the string does
20418 not work, the string is just chopped off in the middle of a word
20419 if necessary."
20420 (if (<= (length s) maxlength)
20421 s
20422 (let* ((n (max (- maxlength 4) 1))
20424 (if (string-match re s)
20425 (concat (match-string 1 s) "...")
20426 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
20428 (defun org-get-indentation (&optional line)
20429 "Get the indentation of the current line, interpreting tabs.
20430 When LINE is given, assume it represents a line and compute its indentation."
20431 (if line
20432 (if (string-match "^ *" (org-remove-tabs line))
20433 (match-end 0))
20434 (save-excursion
20435 (beginning-of-line 1)
20437 (current-column))))
20439 (defun org-get-string-indentation (s)
20440 "What indentation has S due to SPACE and TAB at the beginning of the string?"
20441 (let ((n -1) (i 0) (w tab-width) c)
20442 (catch 'exit
20443 (while (< (setq n (1+ n)) (length s))
20444 (setq c (aref s n))
20445 (cond ((= c ?\ ) (setq i (1+ i)))
20447 (t (throw 'exit t)))))
20448 i))
20450 (defun org-remove-tabs (s &optional width)
20451 "Replace tabulators in S with spaces.
20452 Assumes that s is a single line, starting in column 0."
20453 (setq width (or width tab-width))
20455 (setq s (replace-match
20456 (make-string
20457 (- (* width (/ (+ (match-beginning 0) width) width))
20458 (match-beginning 0)) ?\ )
20459 t t s)))
20460 s)
20462 (defun org-fix-indentation (line ind)
20463 "Fix indentation in LINE.
20464 IND is a cons cell with target and minimum indentation.
20465 If the current indentation in LINE is smaller than the minimum,
20466 leave it alone. If it is larger than ind, set it to the target."
20467 (let* ((l (org-remove-tabs line))
20468 (i (org-get-indentation l))
20469 (i1 (car ind)) (i2 (cdr ind)))
20470 (if (>= i i2) (setq l (substring line i2)))
20471 (if (> i1 0)
20472 (concat (make-string i1 ?\ ) l)
20473 l)))
20475 (defun org-remove-indentation (code &optional n)
20476 "Remove the maximum common indentation from the lines in CODE.
20477 N may optionally be the number of spaces to remove."
20478 (with-temp-buffer
20479 (insert code)
20480 (org-do-remove-indentation n)
20481 (buffer-string)))
20483 (defun org-do-remove-indentation (&optional n)
20484 "Remove the maximum common indentation from the buffer."
20485 (untabify (point-min) (point-max))
20486 (let ((min 10000) re)
20487 (if n
20488 (setq min n)
20489 (goto-char (point-min))
20491 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
20492 (unless (or (= min 0) (= min 10000))
20494 (goto-char (point-min))
20495 (while (re-search-forward re nil t)
20496 (replace-match "")
20497 (end-of-line 1))
20498 min)))
20500 (defun org-fill-template (template alist)
20501 "Find each %key of ALIST in TEMPLATE and replace it."
20502 (let ((case-fold-search nil)
20503 entry key value)
20504 (setq alist (sort (copy-sequence alist)
20505 (lambda (a b) (< (length (car a)) (length (car b))))))
20506 (while (setq entry (pop alist))
20507 (setq template
20508 (replace-regexp-in-string
20509 (concat "%" (regexp-quote (car entry)))
20510 (or (cdr entry) "") template t t)))
20511 template))
20513 (defun org-base-buffer (buffer)
20514 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
20515 (if (not buffer)
20516 buffer
20517 (or (buffer-base-buffer buffer)
20518 buffer)))
20520 (defun org-trim (s)
20521 "Remove whitespace at beginning and end of string."
20524 s)
20526 (defun org-wrap (string &optional width lines)
20527 "Wrap string to either a number of lines, or a width in characters.
20528 If WIDTH is non-nil, the string is wrapped to that width, however many lines
20529 that costs. If there is a word longer than WIDTH, the text is actually
20530 wrapped to the length of that word.
20531 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
20532 many lines, whatever width that takes.
20533 The return value is a list of lines, without newlines at the end."
20535 (maxword (apply 'max (mapcar 'org-string-width words)))
20536 w ll)
20537 (cond (width
20538 (org-do-wrap words (max maxword width)))
20539 (lines
20540 (setq w maxword)
20541 (setq ll (org-do-wrap words maxword))
20542 (if (<= (length ll) lines)
20543 ll
20544 (setq ll words)
20545 (while (> (length ll) lines)
20546 (setq w (1+ w))
20547 (setq ll (org-do-wrap words w)))
20548 ll))
20549 (t (error "Cannot wrap this")))))
20551 (defun org-do-wrap (words width)
20552 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
20553 (let (lines line)
20554 (while words
20555 (setq line (pop words))
20556 (while (and words (< (+ (length line) (length (car words))) width))
20557 (setq line (concat line " " (pop words))))
20558 (setq lines (push line lines)))
20559 (nreverse lines)))
20561 (defun org-split-string (string &optional separators)
20562 "Splits STRING into substrings at SEPARATORS.
20563 No empty strings are returned if there are matches at the beginning
20564 and end of string."
20566 (start 0)
20567 notfirst
20568 (list nil))
20569 (while (and (string-match rexp string
20570 (if (and notfirst
20571 (= start (match-beginning 0))
20572 (< start (length string)))
20573 (1+ start) start))
20574 (< (match-beginning 0) (length string)))
20575 (setq notfirst t)
20576 (or (eq (match-beginning 0) 0)
20577 (and (eq (match-beginning 0) (match-end 0))
20578 (eq (match-beginning 0) start))
20579 (setq list
20580 (cons (substring string start (match-beginning 0))
20581 list)))
20582 (setq start (match-end 0)))
20583 (or (eq start (length string))
20584 (setq list
20585 (cons (substring string start)
20586 list)))
20587 (nreverse list)))
20589 (defun org-quote-vert (s)
20591 (while (string-match "|" s)
20593 s)
20595 (defun org-uuidgen-p (s)
20596 "Is S an ID created by UUIDGEN?"
20597 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
20599 (defun org-in-src-block-p (&optional inside)
20600 "Whether point is in a code source block.
20601 When INSIDE is non-nil, don't consider we are within a src block
20602 when point is at #+BEGIN_SRC or #+END_SRC."
20603 (let (ov)
20604 (or (when (setq ov (overlays-at (point)))
20605 (memq 'org-block-background
20606 (overlay-properties
20607 (car ov))))
20608 (and (not inside)
20609 (save-match-data
20610 (save-excursion
20611 (move-beginning-of-line 1)
20614 (defun org-context ()
20615 "Return a list of contexts of the current cursor position.
20616 If several contexts apply, all are returned.
20617 Each context entry is a list with a symbol naming the context, and
20618 two positions indicating start and end of the context. Possible
20619 contexts are:
20621 :headline anywhere in a headline
20622 :headline-stars on the leading stars in a headline
20623 :todo-keyword on a TODO keyword (including DONE) in a headline
20624 :tags on the TAGS in a headline
20625 :priority on the priority cookie in a headline
20626 :item on the first line of a plain list item
20627 :item-bullet on the bullet/number of a plain list item
20628 :checkbox on the checkbox in a plain list item
20629 :table in an org-mode table
20630 :table-special on a special filed in a table
20631 :table-table in a table.el table
20632 :clocktable in a clocktable
20633 :src-block in a source block
20634 :link on a hyperlink
20635 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
20636 :target on a <<target>>
20637 :radio-target on a <<<radio-target>>>
20638 :latex-fragment on a LaTeX fragment
20639 :latex-preview on a LaTeX fragment with overlaid preview image
20641 This function expects the position to be visible because it uses font-lock
20642 faces as a help to recognize the following contexts: :table-special, :link,
20643 and :keyword."
20644 (let* ((f (get-text-property (point) 'face))
20645 (faces (if (listp f) f (list f)))
20646 (case-fold-search t)
20647 (p (point)) clist o)
20648 ;; First the large context
20649 (cond
20650 ((org-at-heading-p t)
20651 (push (list :headline (point-at-bol) (point-at-eol)) clist)
20652 (when (progn
20653 (beginning-of-line 1)
20654 (looking-at org-todo-line-tags-regexp))
20655 (push (org-point-in-group p 1 :headline-stars) clist)
20656 (push (org-point-in-group p 2 :todo-keyword) clist)
20657 (push (org-point-in-group p 4 :tags) clist))
20658 (goto-char p)
20661 (push (org-point-in-group p 0 :priority) clist)))
20663 ((org-at-item-p)
20664 (push (org-point-in-group p 2 :item-bullet) clist)
20665 (push (list :item (point-at-bol)
20666 (save-excursion (org-end-of-item) (point)))
20667 clist)
20668 (and (org-at-item-checkbox-p)
20669 (push (org-point-in-group p 0 :checkbox) clist)))
20671 ((org-at-table-p)
20672 (push (list :table (org-table-begin) (org-table-end)) clist)
20673 (if (memq 'org-formula faces)
20674 (push (list :table-special
20675 (previous-single-property-change p 'face)
20676 (next-single-property-change p 'face)) clist)))
20677 ((org-at-table-p 'any)
20678 (push (list :table-table) clist)))
20679 (goto-char p)
20681 (let ((case-fold-search t))
20682 ;; New the "medium" contexts: clocktables, source blocks
20683 (cond ((org-in-clocktable-p)
20684 (push (list :clocktable
20686 (search-backward "#+BEGIN: clocktable" nil t))
20687 (match-beginning 0))
20689 (match-end 0))) clist))
20690 ((org-in-src-block-p)
20691 (push (list :src-block
20693 (search-backward "#+BEGIN_SRC" nil t))
20694 (match-beginning 0))
20695 (and (search-forward "#+END_SRC" nil t)
20696 (match-beginning 0))) clist))))
20697 (goto-char p)
20699 ;; Now the small context
20700 (cond
20701 ((org-at-timestamp-p)
20702 (push (org-point-in-group p 0 :timestamp) clist))
20703 ((memq 'org-link faces)
20704 (push (list :link
20705 (previous-single-property-change p 'face)
20706 (next-single-property-change p 'face)) clist))
20707 ((memq 'org-special-keyword faces)
20708 (push (list :keyword
20709 (previous-single-property-change p 'face)
20710 (next-single-property-change p 'face)) clist))
20711 ((org-at-target-p)
20712 (push (org-point-in-group p 0 :target) clist)
20713 (goto-char (1- (match-beginning 0)))
20714 (if (looking-at org-radio-target-regexp)
20715 (push (org-point-in-group p 0 :radio-target) clist))
20716 (goto-char p))
20717 ((setq o (car (delq nil
20718 (mapcar
20719 (lambda (x)
20720 (if (memq x org-latex-fragment-image-overlays) x))
20721 (overlays-at (point))))))
20722 (push (list :latex-fragment
20723 (overlay-start o) (overlay-end o)) clist)
20724 (push (list :latex-preview
20725 (overlay-start o) (overlay-end o)) clist))
20726 ((org-inside-LaTeX-fragment-p)
20727 ;; FIXME: positions wrong.
20728 (push (list :latex-fragment (point) (point)) clist)))
20730 (setq clist (nreverse (delq nil clist)))
20731 clist))
20733 ;; FIXME: Compare with at-regexp-p Do we need both?
20734 (defun org-in-regexp (re &optional nlines visually)
20735 "Check if point is inside a match of regexp.
20736 Normally only the current line is checked, but you can include NLINES extra
20737 lines both before and after point into the search.
20738 If VISUALLY is set, require that the cursor is not after the match but
20739 really on, so that the block visually is on the match."
20740 (catch 'exit
20741 (let ((pos (point))
20742 (eol (point-at-eol (+ 1 (or nlines 0))))
20743 (inc (if visually 1 0)))
20744 (save-excursion
20745 (beginning-of-line (- 1 (or nlines 0)))
20746 (while (re-search-forward re eol t)
20747 (if (and (<= (match-beginning 0) pos)
20748 (>= (+ inc (match-end 0)) pos))
20749 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
20751 (defun org-at-regexp-p (regexp)
20752 "Is point inside a match of REGEXP in the current line?"
20753 (catch 'exit
20754 (save-excursion
20755 (let ((pos (point)) (end (point-at-eol)))
20756 (beginning-of-line 1)
20757 (while (re-search-forward regexp end t)
20758 (if (and (<= (match-beginning 0) pos)
20759 (>= (match-end 0) pos))
20760 (throw 'exit t)))
20761 nil))))
20763 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
20764 "Non-nil when point is between matches of START-RE and END-RE.
20766 Also return a non-nil value when point is on one of the matches.
20768 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
20769 buffer positions. Default values are the positions of headlines
20770 surrounding the point.
20772 The functions returns a cons cell whose car (resp. cdr) is the
20773 position before START-RE (resp. after END-RE)."
20774 (save-match-data
20775 (let ((pos (point))
20776 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
20777 (limit-down (or lim-down (save-excursion (outline-next-heading))))
20778 beg end)
20779 (save-excursion
20780 ;; Point is on a block when on START-RE or if START-RE can be
20781 ;; found before it...
20782 (and (or (org-at-regexp-p start-re)
20783 (re-search-backward start-re limit-up t))
20784 (setq beg (match-beginning 0))
20785 ;; ... and END-RE after it...
20786 (goto-char (match-end 0))
20787 (re-search-forward end-re limit-down t)
20788 (> (setq end (match-end 0)) pos)
20789 ;; ... without another START-RE in-between.
20790 (goto-char (match-beginning 0))
20791 (not (re-search-backward start-re (1+ beg) t))
20792 ;; Return value.
20793 (cons beg end))))))
20795 (defun org-in-block-p (names)
20796 "Non-nil when point belongs to a block whose name belongs to NAMES.
20798 NAMES is a list of strings containing names of blocks.
20800 Return first block name matched, or nil. Beware that in case of
20801 nested blocks, the returned name may not belong to the closest
20802 block from point."
20803 (save-match-data
20804 (catch 'exit
20805 (let ((case-fold-search t)
20806 (lim-up (save-excursion (outline-previous-heading)))
20807 (lim-down (save-excursion (outline-next-heading))))
20808 (mapc (lambda (name)
20809 (let ((n (regexp-quote name)))
20810 (when (org-between-regexps-p
20813 lim-up lim-down)
20814 (throw 'exit n))))
20815 names))
20816 nil)))
20818 (defun org-occur-in-agenda-files (regexp &optional nlines)
20819 "Call `multi-occur' with buffers for all agenda files."
20821 (let* ((files (org-agenda-files))
20822 (tnames (mapcar 'file-truename files))
20823 (extra org-agenda-text-search-extra-files)
20824 f)
20825 (when (eq (car extra) 'agenda-archives)
20826 (setq extra (cdr extra))
20827 (setq files (org-add-archive-files files)))
20828 (while (setq f (pop extra))
20829 (unless (member (file-truename f) tnames)
20830 (add-to-list 'files f 'append)
20831 (add-to-list 'tnames (file-truename f) 'append)))
20832 (multi-occur
20833 (mapcar (lambda (x)
20834 (with-current-buffer
20835 (or (get-file-buffer x) (find-file-noselect x))
20836 (widen)
20837 (current-buffer)))
20838 files)
20839 regexp)))
20841 (if (boundp 'occur-mode-find-occurrence-hook)
20842 ;; Emacs 23
20843 (add-hook 'occur-mode-find-occurrence-hook
20844 (lambda ()
20845 (when (derived-mode-p 'org-mode)
20846 (org-reveal))))
20847 ;; Emacs 22
20848 (defadvice occur-mode-goto-occurrence
20849 (after org-occur-reveal activate)
20850 (and (derived-mode-p 'org-mode) (org-reveal)))
20851 (defadvice occur-mode-goto-occurrence-other-window
20852 (after org-occur-reveal activate)
20853 (and (derived-mode-p 'org-mode) (org-reveal)))
20854 (defadvice occur-mode-display-occurrence
20855 (after org-occur-reveal activate)
20856 (when (derived-mode-p 'org-mode)
20857 (let ((pos (occur-mode-find-occurrence)))
20858 (with-current-buffer (marker-buffer pos)
20859 (save-excursion
20860 (goto-char pos)
20861 (org-reveal)))))))
20863 (defun org-occur-link-in-agenda-files ()
20864 "Create a link and search for it in the agendas.
20865 The link is not stored in `org-stored-links', it is just created
20866 for the search purpose."
20867 (interactive)
20868 (let ((link (condition-case nil
20869 (org-store-link nil)
20870 (error "Unable to create a link to here"))))
20871 (org-occur-in-agenda-files (regexp-quote link))))
20873 (defun org-uniquify (list)
20874 "Remove duplicate elements from LIST."
20875 (let (res)
20876 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
20877 res))
20879 (defun org-delete-all (elts list)
20880 "Remove all elements in ELTS from LIST."
20881 (while elts
20882 (setq list (delete (pop elts) list)))
20883 list)
20885 (defun org-count (cl-item cl-seq)
20886 "Count the number of occurrences of ITEM in SEQ.
20887 Taken from `count' in cl-seq.el with all keyword arguments removed."
20888 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
20889 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
20890 (while (< cl-start cl-end)
20891 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
20892 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
20893 (setq cl-start (1+ cl-start)))
20894 cl-count))
20896 (defun org-remove-if (predicate seq)
20897 "Remove everything from SEQ that fulfills PREDICATE."
20898 (let (res e)
20899 (while seq
20900 (setq e (pop seq))
20901 (if (not (funcall predicate e)) (push e res)))
20902 (nreverse res)))
20904 (defun org-remove-if-not (predicate seq)
20905 "Remove everything from SEQ that does not fulfill PREDICATE."
20906 (let (res e)
20907 (while seq
20908 (setq e (pop seq))
20909 (if (funcall predicate e) (push e res)))
20910 (nreverse res)))
20912 (defun org-reduce (cl-func cl-seq &rest cl-keys)
20913 "Reduce two-argument FUNCTION across SEQ.
20914 Taken from `reduce' in cl-seq.el with all keyword arguments but
20916 (let ((cl-accum (cond ((memq :initial-value cl-keys)
20917 (cadr (memq :initial-value cl-keys)))
20918 (cl-seq (pop cl-seq))
20919 (t (funcall cl-func)))))
20920 (while cl-seq
20921 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
20922 cl-accum))
20924 (defun org-back-over-empty-lines ()
20925 "Move backwards over whitespace, to the beginning of the first empty line.
20926 Returns the number of empty lines passed."
20927 (let ((pos (point)))
20928 (if (cdr (assoc 'heading org-blank-before-new-entry))
20930 (unless (eobp)
20931 (forward-line -1)))
20932 (beginning-of-line 2)
20933 (goto-char (min (point) pos))
20934 (count-lines (point) pos)))
20936 (defun org-skip-whitespace ()
20939 (defun org-point-in-group (point group &optional context)
20940 "Check if POINT is in match-group GROUP.
20941 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
20942 match. If the match group does not exist or point is not inside it,
20943 return nil."
20944 (and (match-beginning group)
20945 (>= point (match-beginning group))
20946 (<= point (match-end group))
20947 (if context
20948 (list context (match-beginning group) (match-end group))
20949 t)))
20951 (defun org-switch-to-buffer-other-window (&rest args)
20952 "Switch to buffer in a second window on the current frame.
20953 In particular, do not allow pop-up frames.
20954 Returns the newly created buffer."
20955 (org-no-popups
20956 (apply 'switch-to-buffer-other-window args)))
20958 (defun org-combine-plists (&rest plists)
20959 "Create a single property list from all plists in PLISTS.
20960 The process starts by copying the first list, and then setting properties
20961 from the other lists. Settings in the last list are the most significant
20962 ones and overrule settings in the other lists."
20963 (let ((rtn (copy-sequence (pop plists)))
20964 p v ls)
20965 (while plists
20966 (setq ls (pop plists))
20967 (while ls
20968 (setq p (pop ls) v (pop ls))
20969 (setq rtn (plist-put rtn p v))))
20970 rtn))
20972 (defun org-replace-escapes (string table)
20973 "Replace %-escapes in STRING with values in TABLE.
20975 The sequences in STRING may contain normal field width and padding information,
20977 so values can contain further %-escapes if they are define later in TABLE."
20978 (let ((tbl (copy-alist table))
20979 (case-fold-search nil)
20980 (pchg 0)
20981 e re rpl)
20982 (while (setq e (pop tbl))
20983 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20984 (when (and (cdr e) (string-match re (cdr e)))
20985 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20986 (safe "SREF"))
20987 (add-text-properties 0 3 (list 'sref sref) safe)
20988 (setcdr e (replace-match safe t t (cdr e)))))
20989 (while (string-match re string)
20990 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20991 (cdr e)))
20992 (setq string (replace-match rpl t t string))))
20993 (while (setq pchg (next-property-change pchg string))
20994 (let ((sref (get-text-property pchg 'sref string)))
20995 (when (and sref (string-match "SREF" string pchg))
20996 (setq string (replace-match sref t t string)))))
20997 string))
20999 (defun org-sublist (list start end)
21000 "Return a section of LIST, from START to END.
21001 Counting starts at 1."
21002 (let (rtn (c start))
21003 (setq list (nthcdr (1- start) list))
21004 (while (and list (<= c end))
21005 (push (pop list) rtn)
21006 (setq c (1+ c)))
21007 (nreverse rtn)))
21009 (defun org-find-base-buffer-visiting (file)
21010 "Like `find-buffer-visiting' but always return the base buffer and
21011 not an indirect buffer."
21012 (let ((buf (or (get-file-buffer file)
21013 (find-buffer-visiting file))))
21014 (if buf
21015 (or (buffer-base-buffer buf) buf)
21016 nil)))
21018 (defun org-image-file-name-regexp (&optional extensions)
21019 "Return regexp matching the file names of images.
21020 If EXTENSIONS is given, only match these."
21021 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21022 (image-file-name-regexp)
21023 (let ((image-file-name-extensions
21024 (or extensions
21025 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21026 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21028 (regexp-opt (nconc (mapcar 'upcase
21029 image-file-name-extensions)
21030 image-file-name-extensions)
21031 t)
21034 (defun org-file-image-p (file &optional extensions)
21035 "Return non-nil if FILE is an image."
21036 (save-match-data
21037 (string-match (org-image-file-name-regexp extensions) file)))
21039 (defun org-get-cursor-date (&optional with-time)
21040 "Return the date at cursor in as a time.
21041 This works in the calendar and in the agenda, anywhere else it just
21042 returns the current time.
21043 If WITH-TIME is non-nil, returns the time of the event at point (in
21044 the agenda) or the current time of the day."
21045 (let (date day defd tp tm hod mod)
21046 (when with-time
21047 (setq tp (get-text-property (point) 'time))
21049 (setq hod (string-to-number (match-string 1 tp))
21050 mod (string-to-number (match-string 2 tp))))
21051 (or tp (setq hod (nth 2 (decode-time (current-time)))
21052 mod (nth 1 (decode-time (current-time))))))
21053 (cond
21054 ((eq major-mode 'calendar-mode)
21055 (setq date (calendar-cursor-to-date)
21056 defd (encode-time 0 (or mod 0) (or hod 0)
21057 (nth 1 date) (nth 0 date) (nth 2 date))))
21058 ((eq major-mode 'org-agenda-mode)
21059 (setq day (get-text-property (point) 'day))
21060 (if day
21061 (setq date (calendar-gregorian-from-absolute day)
21062 defd (encode-time 0 (or mod 0) (or hod 0)
21063 (nth 1 date) (nth 0 date) (nth 2 date))))))
21064 (or defd (current-time))))
21066 (defun org-mark-subtree (&optional up)
21067 "Mark the current subtree.
21068 This puts point at the start of the current subtree, and mark at
21069 the end. If a numeric prefix UP is given, move up into the
21070 hierarchy of headlines by UP levels before marking the subtree."
21071 (interactive "P")
21072 (org-with-limited-levels
21073 (cond ((org-at-heading-p) (beginning-of-line))
21074 ((org-before-first-heading-p) (error "Not in a subtree"))
21075 (t (outline-previous-visible-heading 1))))
21076 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21077 (if (org-called-interactively-p 'any)
21078 (call-interactively 'org-mark-element)
21079 (org-mark-element)))
21082 ;;; Macros
21084 ;; Macros are expanded with `org-macro-replace-all', which relies
21085 ;; internally on `org-macro-expand'.
21087 ;; Default templates for expansion are stored in the buffer-local
21088 ;; variable `org-macro-templates'. This variable is updated by
21089 ;; `org-macro-initialize-templates'.
21091 ;; Along with macros defined through #+MACRO: keyword, default
21092 ;; templates include the following hard-coded macros:
21093 ;; {{{time(format-string)}}}, {{{property(node-property)}}},
21094 ;; {{{input-file}}} and {{{modification-time(format-string)}}}.
21096 ;; During export, {{{author}}}, {{{date}}}, {{{email}}} and
21097 ;; {{{title}}} will also be provided.
21100 (defvar org-macro-templates nil
21101 "Alist containing all macro templates in current buffer.
21102 Associations are in the shape of (NAME . TEMPLATE) where NAME
21103 stands for macro's name and template for its replacement value,
21104 both as strings. This is an internal variable. Do not set it
21105 directly, use instead:
21107 #+MACRO: name template")
21108 (make-variable-buffer-local 'org-macro-templates)
21110 (defun org-macro-expand (macro templates)
21111 "Return expanded MACRO, as a string.
21112 MACRO is an object, obtained, for example, with
21113 `org-element-context'. TEMPLATES is an alist of templates used
21114 for expansion. See `org-macro-templates' for a buffer-local
21115 default value. Return nil if no template was found."
21116 (let ((template
21117 ;; Macro names are case-insensitive.
21118 (cdr (assoc-string (org-element-property :key macro) templates t))))
21119 (when template
21120 (let ((value (replace-regexp-in-string
21122 (lambda (arg)
21123 (or (nth (1- (string-to-number (substring arg 1)))
21124 (org-element-property :args macro))
21125 ;; No argument provided: remove
21126 ;; place-holder.
21127 ""))
21128 template)))
21129 ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
21131 (setq value (eval (read value))))
21132 ;; Return string.
21133 (format "%s" (or value ""))))))
21135 (defun org-macro-replace-all (templates)
21136 "Replace all macros in current buffer by their expansion.
21137 TEMPLATES is an alist of templates used for expansion. See
21138 `org-macro-templates' for a buffer-local default value."
21139 (save-excursion
21140 (goto-char (point-min))
21141 (let (record)
21142 (while (re-search-forward "{{{[-A-Za-z0-9_]" nil t)
21143 (let ((object (org-element-context)))
21144 (when (eq (org-element-type object) 'macro)
21145 (let* ((value (org-macro-expand object templates))
21146 (begin (org-element-property :begin object))
21147 (signature (list begin
21148 object
21149 (org-element-property :args object))))
21150 ;; Avoid circular dependencies by checking if the same
21151 ;; macro with the same arguments is expanded at the same
21152 ;; position twice.
21153 (if (member signature record)
21154 (error "Circular macro expansion: %s"
21155 (org-element-property :key object))
21156 (when value
21157 (push signature record)
21158 (delete-region
21159 begin
21160 ;; Preserve white spaces after the macro.
21161 (progn (goto-char (org-element-property :end object))
21163 (point)))
21164 ;; Leave point before replacement in case of recursive
21165 ;; expansions.
21166 (save-excursion (insert value)))))))))))
21168 (defun org-macro-initialize-templates ()
21169 "Collect macro templates defined in current buffer.
21170 Templates are stored in buffer-local variable
21171 `org-macro-templates'. In addition to buffer-defined macros, the
21175 (let ((case-fold-search t)
21176 (set-template
21177 (lambda (cell)
21178 ;; Add CELL to `org-macro-templates' if there's no
21179 ;; association matching its name already. Otherwise,
21180 ;; replace old association with the new one in that
21181 ;; variable.
21182 (let ((old-template (assoc (car cell) org-macro-templates)))
21183 (if old-template (setcdr old-template (cdr cell))
21184 (push cell org-macro-templates))))))
21185 ;; Install buffer-local macros.
21186 (org-with-wide-buffer
21187 (goto-char (point-min))
21189 (let ((element (org-element-at-point)))
21190 (when (eq (org-element-type element) 'keyword)
21191 (let ((value (org-element-property :value element)))
21193 (funcall set-template
21194 (cons (match-string 1 value)
21195 (or (match-string 2 value) "")))))))))
21196 ;; Install hard-coded macros.
21197 (mapc (lambda (cell) (funcall set-template cell))
21198 (list
21201 (let ((visited-file (buffer-file-name (buffer-base-buffer))))
21202 (when (and visited-file (file-exists-p visited-file))
21203 (mapc (lambda (cell) (funcall set-template cell))
21204 (list
21205 (cons "input-file" (file-name-nondirectory visited-file))
21206 (cons "modification-time"
21208 (prin1-to-string
21209 (nth 5 (file-attributes visited-file)))))))))))
21212 ;;; Indentation
21214 (defun org-indent-line ()
21215 "Indent line depending on context."
21216 (interactive)
21217 (let* ((pos (point))
21218 (itemp (org-at-item-p))
21219 (case-fold-search t)
21221 (inline-task-p (and (featurep 'org-inlinetask)
21222 (org-inlinetask-in-task-p)))
21223 (inline-re (and inline-task-p
21224 (org-inlinetask-outline-regexp)))
21225 column)
21226 (if (and orgstruct-is-++ (eq pos (point)))
21227 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21228 (indent-according-to-mode))
21229 (beginning-of-line 1)
21230 (cond
21231 ;; Headings
21232 ((looking-at org-outline-regexp) (setq column 0))
21233 ;; Included files
21235 ;; Footnote definition
21236 ((looking-at org-footnote-definition-re) (setq column 0))
21237 ;; Literal examples
21239 (setq column (org-get-indentation))) ; do nothing
21240 ;; Lists
21241 ((ignore-errors (goto-char (org-in-item-p)))
21242 (setq column (if itemp
21243 (org-get-indentation)
21244 (org-list-item-body-column (point))))
21245 (goto-char pos))
21246 ;; Drawers
21248 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21249 (save-excursion
21250 (goto-char (1- (match-beginning 1)))
21251 (setq column (current-column))))
21252 ;; Special blocks
21254 (save-excursion
21255 (re-search-backward
21257 (setq column (org-get-indentation (match-string 0))))
21260 (save-excursion
21262 (setq column
21263 (cond ((equal (downcase (match-string 1)) "src")
21264 ;; src blocks: let `org-edit-src-exit' handle them
21265 (org-get-indentation))
21266 ((equal (downcase (match-string 1)) "example")
21267 (max (org-get-indentation)
21268 (org-get-indentation (match-string 0))))
21269 (t
21270 (org-get-indentation (match-string 0))))))
21271 ;; This line has nothing special, look at the previous relevant
21272 ;; line to compute indentation
21273 (t
21274 (beginning-of-line 0)
21275 (while (and (not (bobp))
21276 (not (looking-at org-drawer-regexp))
21277 ;; When point started in an inline task, do not move
21278 ;; above task starting line.
21279 (not (and inline-task-p (looking-at inline-re)))
21280 ;; Skip drawers, blocks, empty lines, verbatim,
21281 ;; comments, tables, footnotes definitions, lists,
21282 ;; inline tasks.
21284 (re-search-backward org-drawer-regexp nil t))
21288 (looking-at org-footnote-definition-re)
21289 (and (ignore-errors (goto-char (org-in-item-p)))
21290 (goto-char
21291 (org-list-get-top-point (org-list-struct))))
21292 (and (not inline-task-p)
21293 (featurep 'org-inlinetask)
21294 (org-inlinetask-in-task-p)
21295 (or (org-inlinetask-goto-beginning) t))))
21296 (beginning-of-line 0))
21297 (cond
21298 ;; There was an heading above.
21300 (if (not org-adapt-indentation)
21301 (setq column 0)
21302 (goto-char (match-end 0))
21303 (setq column (current-column))))
21304 ;; A drawer had started and is unfinished
21305 ((looking-at org-drawer-regexp)
21306 (goto-char (1- (match-beginning 1)))
21307 (setq column (current-column)))
21308 ;; Else, nothing noticeable found: get indentation and go on.
21309 (t (setq column (org-get-indentation))))))
21310 ;; Now apply indentation and move cursor accordingly
21311 (goto-char pos)
21312 (if (<= (current-column) (current-indentation))
21313 (org-indent-line-to column)
21314 (save-excursion (org-indent-line-to column)))
21315 ;; Special polishing for properties, see `org-property-format'
21316 (setq column (current-column))
21317 (beginning-of-line 1)
21318 (if (looking-at
21320 (replace-match (concat (match-string 1)
21321 (format org-property-format
21322 (match-string 2) (match-string 3)))
21323 t t))
21324 (org-move-to-column column))))
21326 (defun org-indent-drawer ()
21327 "Indent the drawer at point."
21328 (interactive)
21329 (let ((p (point))
21330 (e (and (save-excursion (re-search-forward ":END:" nil t))
21331 (match-end 0)))
21332 (folded
21333 (save-excursion
21334 (end-of-line)
21335 (when (overlays-at (point))
21336 (member 'invisible (overlay-properties
21337 (car (overlays-at (point)))))))))
21338 (when folded (org-cycle))
21339 (indent-for-tab-command)
21340 (while (and (move-beginning-of-line 2) (< (point) e))
21341 (indent-for-tab-command))
21342 (goto-char p)
21343 (when folded (org-cycle)))
21344 (message "Drawer at point indented"))
21346 (defun org-indent-block ()
21347 "Indent the block at point."
21348 (interactive)
21349 (let ((p (point))
21350 (case-fold-search t)
21352 (match-end 0)))
21353 (folded
21354 (save-excursion
21355 (end-of-line)
21356 (when (overlays-at (point))
21357 (member 'invisible (overlay-properties
21358 (car (overlays-at (point)))))))))
21359 (when folded (org-cycle))
21360 (indent-for-tab-command)
21361 (while (and (move-beginning-of-line 2) (< (point) e))
21362 (indent-for-tab-command))
21363 (goto-char p)
21364 (when folded (org-cycle)))
21365 (message "Block at point indented"))
21367 (defun org-indent-region (start end)
21368 "Indent region."
21369 (interactive "r")
21370 (save-excursion
21371 (let ((line-end (org-current-line end)))
21372 (goto-char start)
21373 (while (< (org-current-line) line-end)
21374 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
21375 (t (call-interactively 'org-indent-line)))
21376 (move-beginning-of-line 2)))))
21379 ;;; Filling
21381 ;; We use our own fill-paragraph and auto-fill functions.
21383 ;; `org-fill-paragraph' relies on adaptive filling and context
21384 ;; checking. Appropriate `fill-prefix' is computed with
21385 ;; `org-adaptive-fill-function'.
21387 ;; `org-auto-fill-function' takes care of auto-filling. It calls
21388 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
21389 ;; `org-adaptive-fill-function' value. Internally,
21390 ;; `org-comment-line-break-function' breaks the line.
21392 ;; `org-setup-filling' installs filling and auto-filling related
21393 ;; variables during `org-mode' initialization.
21395 (defun org-setup-filling ()
21396 (interactive)
21397 ;; Prevent auto-fill from inserting unwanted new items.
21398 (when (boundp 'fill-nobreak-predicate)
21399 (org-set-local
21400 'fill-nobreak-predicate
21401 (org-uniquify
21402 (append fill-nobreak-predicate
21403 '(org-fill-paragraph-separate-nobreak-p
21404 org-fill-line-break-nobreak-p)))))
21405 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
21406 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
21407 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
21408 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
21410 (defvar org-element-paragraph-separate) ; org-element.el
21411 (defun org-fill-paragraph-separate-nobreak-p ()
21412 "Non-nil when a line break at point would insert a new item."
21413 (looking-at (substring org-element-paragraph-separate 1)))
21415 (defun org-fill-line-break-nobreak-p ()
21416 "Non-nil when a line break at point would create an Org line break."
21417 (save-excursion
21422 (declare-function message-in-body-p "message" ())
21423 (defun org-adaptive-fill-function ()
21424 "Compute a fill prefix for the current line.
21425 Return fill prefix, as a string, or nil if current line isn't
21426 meant to be filled."
21427 (org-with-wide-buffer
21428 (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
21429 ;; FIXME: This is really the job of orgstruct++-mode
21430 (let* ((p (line-beginning-position))
21431 (element (save-excursion (beginning-of-line)
21432 (org-element-at-point)))
21433 (type (org-element-type element))
21434 (post-affiliated (org-element-property :post-affiliated element)))
21435 (unless (and post-affiliated (< p post-affiliated))
21436 (case type
21438 (footnote-definition "")
21439 ((item plain-list)
21440 (make-string (org-list-item-body-column
21441 (or post-affiliated
21442 (org-element-property :begin element)))
21443 ? ))
21444 (paragraph
21445 ;; Fill prefix is usually the same as the current line,
21446 ;; except if the paragraph is at the beginning of an item.
21447 (let ((parent (org-element-property :parent element)))
21448 (cond ((eq (org-element-type parent) 'item)
21449 (make-string (org-list-item-body-column
21450 (org-element-property :begin parent))
21451 ? ))
21453 (match-string 0))
21454 (t ""))))
21455 (comment-block
21456 ;; Only fill contents if P is within block boundaries.
21457 (let* ((cbeg (save-excursion (goto-char post-affiliated)
21458 (forward-line)
21459 (point)))
21460 (cend (save-excursion
21461 (goto-char (org-element-property :end element))
21463 (line-beginning-position))))
21464 (when (and (>= p cbeg) (< p cend))
21466 (match-string 0)
21467 ""))))))))))
21469 (declare-function message-goto-body "message" ())
21470 (defvar message-cite-prefix-regexp) ; From message.el
21471 (defvar org-element-all-objects) ; From org-element.el
21472 (defun org-fill-paragraph (&optional justify)
21473 "Fill element at point, when applicable.
21475 This function only applies to comment blocks, comments, example
21476 blocks and paragraphs. Also, as a special case, re-align table
21477 when point is at one.
21479 If JUSTIFY is non-nil (interactively, with prefix argument),
21480 justify as well. If `sentence-end-double-space' is non-nil, then
21481 period followed by one space does not end a sentence, so don't
21482 break a line there. The variable `fill-column' controls the
21483 width for filling.
21485 For convenience, when point is at a plain list, an item or
21486 a footnote definition, try to fill the first paragraph within."
21487 (interactive)
21488 (if (and (derived-mode-p 'message-mode)
21489 (or (not (message-in-body-p))
21490 (save-excursion (move-beginning-of-line 1)
21491 (looking-at message-cite-prefix-regexp))))
21492 ;; First ensure filling is correct in message-mode.
21493 (let ((fill-paragraph-function
21494 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
21495 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
21496 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
21497 (paragraph-separate
21498 (cadadr (assoc 'paragraph-separate org-fb-vars))))
21499 (fill-paragraph nil))
21500 (save-excursion
21501 ;; Move to end of line in order to get the first paragraph
21502 ;; within a plain list or a footnote definition.
21503 (end-of-line)
21504 (let ((element (org-element-at-point)))
21505 ;; First check if point is in a blank line at the beginning of
21506 ;; the buffer. In that case, ignore filling.
21507 (if (< (point) (org-element-property :begin element)) t
21508 (case (org-element-type element)
21509 ;; Use major mode filling function is src blocks.
21510 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
21511 ;; Align Org tables, leave table.el tables as-is.
21512 (table-row (org-table-align) t)
21513 (table
21514 (when (eq (org-element-property :type element) 'org)
21515 (org-table-align))
21516 t)
21517 (paragraph
21518 ;; Paragraphs may contain `line-break' type objects.
21519 (let ((beg (max (point-min)
21520 (org-element-property :contents-begin element)))
21521 (end (min (point-max)
21522 (org-element-property :contents-end element))))
21523 ;; Do nothing if point is at an affiliated keyword.
21524 (if (< (point) beg) t
21525 (when (derived-mode-p 'message-mode)
21526 ;; In `message-mode', do not fill following
21527 ;; citation in current paragraph nor text before
21528 ;; message body.
21529 (let ((body-start (save-excursion (message-goto-body))))
21530 (when body-start (setq beg (max body-start beg))))
21531 (when (save-excursion
21532 (re-search-forward
21533 (concat "^" message-cite-prefix-regexp) end t))
21534 (setq end (match-beginning 0))))
21535 ;; Fill paragraph, taking line breaks into
21536 ;; consideration. For that, slice the paragraph
21537 ;; using line breaks as separators, and fill the
21538 ;; parts in reverse order to avoid messing with
21539 ;; markers.
21540 (save-excursion
21541 (goto-char end)
21542 (mapc
21543 (lambda (pos)
21544 (fill-region-as-paragraph pos (point) justify)
21545 (goto-char pos))
21546 ;; Find the list of ending positions for line
21547 ;; breaks in the current paragraph. Add paragraph
21548 ;; beginning to include first slice.
21549 (nreverse
21550 (cons
21551 beg
21552 (org-element-map
21553 (org-element--parse-objects
21554 beg end nil org-element-all-objects)
21555 'line-break
21556 (lambda (lb) (org-element-property :end lb)))))))
21557 t)))
21558 ;; Contents of `comment-block' type elements should be
21559 ;; filled as plain text, but only if point is within block
21560 ;; markers.
21561 (comment-block
21562 (let* ((case-fold-search t)
21563 (beg (save-excursion
21564 (goto-char (org-element-property :begin element))
21566 (forward-line)
21567 (point)))
21568 (end (save-excursion
21569 (goto-char (org-element-property :end element))
21571 (line-beginning-position))))
21572 (when (and (>= (point) beg) (< (point) end))
21573 (fill-region-as-paragraph
21574 (save-excursion
21575 (end-of-line)
21577 (line-beginning-position))
21578 (save-excursion
21579 (beginning-of-line)
21581 (line-beginning-position))
21582 justify)))
21583 t)
21584 ;; Fill comments.
21585 (comment (fill-comment-paragraph justify))
21586 ;; Ignore every other element.
21587 (otherwise t)))))))
21589 (defun org-auto-fill-function ()
21590 "Auto-fill function."
21591 ;; Check if auto-filling is meaningful.
21592 (let ((fc (current-fill-column)))
21593 (when (and fc (> (current-column) fc))
21594 (let* ((fill-prefix (org-adaptive-fill-function))
21595 ;; Enforce empty fill prefix, if required. Otherwise, it
21596 ;; will be computed again.
21597 (adaptive-fill-mode (not (equal fill-prefix ""))))
21598 (when fill-prefix (do-auto-fill))))))
21600 (defun org-comment-line-break-function (&optional soft)
21601 "Break line at point and indent, continuing comment if within one.
21602 The inserted newline is marked hard if variable
21603 `use-hard-newlines' is true, unless optional argument SOFT is
21604 non-nil."
21606 (save-excursion (forward-char -1) (delete-horizontal-space))
21607 (delete-horizontal-space)
21608 (indent-to-left-margin)
21609 (insert-before-markers-and-inherit fill-prefix))
21612 ;;; Comments
21614 ;; Org comments syntax is quite complex. It requires the entire line
21615 ;; to be just a comment. Also, even with the right syntax at the
21616 ;; beginning of line, some some elements (i.e. verse-block or
21617 ;; example-block) don't accept comments. Usual Emacs comment commands
21618 ;; cannot cope with those requirements. Therefore, Org replaces them.
21620 ;; Org still relies on `comment-dwim', but cannot trust
21621 ;; `comment-only-p'. So, `comment-region-function' and
21622 ;; `uncomment-region-function' both point
21623 ;; to`org-comment-or-uncomment-region'. Eventually,
21624 ;; `org-insert-comment' takes care of insertion of comments at the
21625 ;; beginning of line.
21627 ;; `org-setup-comments-handling' install comments related variables
21628 ;; during `org-mode' initialization.
21630 (defun org-setup-comments-handling ()
21631 (interactive)
21632 (org-set-local 'comment-use-syntax nil)
21633 (org-set-local 'comment-start "# ")
21635 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
21636 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
21637 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
21639 (defun org-insert-comment ()
21640 "Insert an empty comment above current line.
21641 If the line is empty, insert comment at its beginning."
21642 (beginning-of-line)
21644 (org-indent-line)
21645 (insert "# "))
21647 (defvar comment-empty-lines) ; From newcomment.el.
21648 (defun org-comment-or-uncomment-region (beg end &rest ignore)
21649 "Comment or uncomment each non-blank line in the region.
21650 Uncomment each non-blank line between BEG and END if it only
21651 contains commented lines. Otherwise, comment them."
21652 (save-restriction
21653 ;; Restrict region
21654 (narrow-to-region (save-excursion (goto-char beg)
21656 (line-beginning-position))
21657 (save-excursion (goto-char end)
21659 (line-end-position)))
21660 (let ((uncommentp
21661 ;; UNCOMMENTP is non-nil when every non blank line between
21662 ;; BEG and END is a comment.
21663 (save-excursion
21664 (goto-char (point-min))
21665 (while (and (not (eobp))
21666 (let ((element (org-element-at-point)))
21667 (and (eq (org-element-type element) 'comment)
21668 (goto-char (min (point-max)
21669 (org-element-property
21670 :end element)))))))
21671 (eobp))))
21672 (if uncommentp
21673 ;; Only blank lines and comments in region: uncomment it.
21674 (save-excursion
21675 (goto-char (point-min))
21676 (while (not (eobp))
21678 (replace-match "" nil nil nil 1))
21679 (forward-line)))
21680 ;; Comment each line in region.
21681 (let ((min-indent (point-max)))
21682 ;; First find the minimum indentation across all lines.
21683 (save-excursion
21684 (goto-char (point-min))
21685 (while (and (not (eobp)) (not (zerop min-indent)))
21687 (setq min-indent (min min-indent (current-indentation))))
21688 (forward-line)))
21689 ;; Then loop over all lines.
21690 (save-excursion
21691 (goto-char (point-min))
21692 (while (not (eobp))
21694 (org-move-to-column min-indent t)
21695 (insert comment-start))
21696 (forward-line))))))))
21699 ;;; Other stuff.
21701 (defun org-toggle-fixed-width-section (arg)
21702 "Toggle the fixed-width export.
21703 If there is no active region, the QUOTE keyword at the current headline is
21704 inserted or removed. When present, it causes the text between this headline
21705 and the next to be exported as fixed-width text, and unmodified.
21706 If there is an active region, this command adds or removes a colon as the
21707 first character of this line. If the first character of a line is a colon,
21708 this line is also exported in fixed-width font."
21709 (interactive "P")
21710 (let* ((cc 0)
21711 (regionp (org-region-active-p))
21712 (beg (if regionp (region-beginning) (point)))
21713 (end (if regionp (region-end)))
21714 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
21715 (case-fold-search nil)
21717 off)
21718 (if regionp
21719 (save-excursion
21720 (goto-char beg)
21721 (setq cc (current-column))
21722 (beginning-of-line 1)
21723 (setq off (looking-at re))
21724 (while (> nlines 0)
21725 (setq nlines (1- nlines))
21726 (beginning-of-line 1)
21727 (cond
21728 (arg
21729 (org-move-to-column cc t)
21731 (forward-line -1))
21732 ((and off (looking-at re))
21733 (replace-match "" t t nil 1))
21734 ((not off) (org-move-to-column cc t) (insert ": ")))
21735 (forward-line 1)))
21736 (save-excursion
21737 (org-back-to-heading)
21738 (cond
21739 ((looking-at (format org-heading-keyword-regexp-format
21740 org-quote-string))
21741 (goto-char (match-end 1))
21742 (looking-at (concat " +" org-quote-string))
21743 (replace-match "" t t)
21744 (when (eolp) (insert " ")))
21745 ((looking-at org-outline-regexp)
21746 (goto-char (match-end 0))
21747 (insert org-quote-string " ")))))))
21749 (defun org-reftex-citation ()
21750 "Use reftex-citation to insert a citation into the buffer.
21751 This looks for a line like
21753 #+BIBLIOGRAPHY: foo plain option:-d
21755 and derives from it that foo.bib is the bibliography file relevant
21756 for this document. It then installs the necessary environment for RefTeX
21757 to work in this buffer and calls `reftex-citation' to insert a citation
21758 into the buffer.
21760 Export of such citations to both LaTeX and HTML is handled by the contributed
21761 package org-exp-bibtex by Taru Karttunen."
21762 (interactive)
21763 (let ((reftex-docstruct-symbol 'rds)
21765 rds bib)
21766 (save-excursion
21767 (save-restriction
21768 (widen)
21769 (let ((case-fold-search t)
21771 (if (not (save-excursion
21772 (or (re-search-forward re nil t)
21773 (re-search-backward re nil t))))
21774 (error "No bibliography defined in file")
21775 (setq bib (concat (match-string 1) ".bib")
21776 rds (list (list 'bib bib)))))))
21777 (call-interactively 'reftex-citation)))
21779 ;;;; Functions extending outline functionality
21781 (defun org-beginning-of-line (&optional arg)
21782 "Go to the beginning of the current line. If that is invisible, continue
21783 to a visible line beginning. This makes the function of C-a more intuitive.
21784 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
21785 first attempt, and only move to after the tags when the cursor is already
21786 beyond the end of the headline."
21787 (interactive "P")
21788 (let ((pos (point))
21789 (special (if (consp org-special-ctrl-a/e)
21790 (car org-special-ctrl-a/e)
21791 org-special-ctrl-a/e))
21792 refpos)
21793 (if (org-bound-and-true-p visual-line-mode)
21794 (beginning-of-visual-line 1)
21795 (beginning-of-line 1))
21796 (if (and arg (fboundp 'move-beginning-of-line))
21797 (call-interactively 'move-beginning-of-line)
21798 (if (bobp)
21799 nil
21800 (backward-char 1)
21801 (if (org-truely-invisible-p)
21802 (while (and (not (bobp)) (org-truely-invisible-p))
21803 (backward-char 1)
21804 (beginning-of-line 1))
21805 (forward-char 1))))
21806 (when special
21807 (cond
21808 ((and (looking-at org-complex-heading-regexp)
21809 (= (char-after (match-end 1)) ?\ ))
21810 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
21811 (point-at-eol)))
21812 (goto-char
21813 (if (eq special t)
21814 (cond ((> pos refpos) refpos)
21815 ((= pos (point)) refpos)
21816 (t (point)))
21817 (cond ((> pos (point)) (point))
21818 ((not (eq last-command this-command)) (point))
21819 (t refpos)))))
21820 ((org-at-item-p)
21821 ;; Being at an item and not looking at an the item means point
21822 ;; was previously moved to beginning of a visual line, which
21823 ;; doesn't contain the item. Therefore, do nothing special,
21824 ;; just stay here.
21825 (when (looking-at org-list-full-item-re)
21826 ;; Set special position at first white space character after
21827 ;; bullet, and check-box, if any.
21828 (let ((after-bullet
21829 (let ((box (match-end 3)))
21830 (if (not box) (match-end 1)
21831 (let ((after (char-after box)))
21832 (if (and after (= after ? )) (1+ box) box))))))
21833 ;; Special case: Move point to special position when
21834 ;; currently after it or at beginning of line.
21835 (if (eq special t)
21836 (when (or (> pos after-bullet) (= (point) pos))
21837 (goto-char after-bullet))
21838 ;; Reversed case: Move point to special position when
21839 ;; point was already at beginning of line and command is
21840 ;; repeated.
21841 (when (and (= (point) pos) (eq last-command this-command))
21842 (goto-char after-bullet))))))))
21843 (org-no-warnings
21844 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21846 (defun org-end-of-line (&optional arg)
21847 "Go to the end of the line.
21848 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
21849 tags on the first attempt, and only move to after the tags when
21850 the cursor is already beyond the end of the headline."
21851 (interactive "P")
21852 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
21853 org-special-ctrl-a/e))
21854 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
21855 'end-of-visual-line)
21856 ((fboundp 'move-end-of-line) 'move-end-of-line)
21857 (t 'end-of-line))))
21858 (if (or (not special) arg) (call-interactively move-fun)
21859 (let* ((element (save-excursion (beginning-of-line)
21860 (org-element-at-point)))
21861 (type (org-element-type element)))
21862 (cond
21863 ((memq type '(headline inlinetask))
21864 (let ((pos (point)))
21865 (beginning-of-line 1)
21867 (if (eq special t)
21868 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
21869 (goto-char (match-beginning 1))
21870 (goto-char (match-end 0)))
21871 (if (or (< pos (match-end 0))
21872 (not (eq this-command last-command)))
21873 (goto-char (match-end 0))
21874 (goto-char (match-beginning 1))))
21875 (call-interactively move-fun))))
21876 ((org-element-property :hiddenp element)
21877 ;; If element is hidden, `move-end-of-line' would put point
21878 ;; after it. Use `end-of-line' to stay on current line.
21879 (call-interactively 'end-of-line))
21880 (t (call-interactively move-fun)))))
21881 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21883 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
21884 (define-key org-mode-map "\C-e" 'org-end-of-line)
21886 (defun org-backward-sentence (&optional arg)
21887 "Go to beginning of sentence, or beginning of table field.
21888 This will call `backward-sentence' or `org-table-beginning-of-field',
21889 depending on context."
21890 (interactive "P")
21891 (cond
21892 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
21893 (t (call-interactively 'backward-sentence))))
21895 (defun org-forward-sentence (&optional arg)
21896 "Go to end of sentence, or end of table field.
21897 This will call `forward-sentence' or `org-table-end-of-field',
21898 depending on context."
21899 (interactive "P")
21900 (cond
21901 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
21902 (t (call-interactively 'forward-sentence))))
21904 (define-key org-mode-map "\M-a" 'org-backward-sentence)
21905 (define-key org-mode-map "\M-e" 'org-forward-sentence)
21907 (defun org-kill-line (&optional arg)
21908 "Kill line, to tags or end of line."
21909 (interactive "P")
21910 (cond
21911 ((or (not org-special-ctrl-k)
21912 (bolp)
21913 (not (org-at-heading-p)))
21914 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
21915 org-ctrl-k-protect-subtree)
21916 (if (or (eq org-ctrl-k-protect-subtree 'error)
21917 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
21918 (error "C-k aborted - would kill hidden subtree")))
21919 (call-interactively
21920 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
21922 (kill-region (point) (match-beginning 1))
21923 (org-set-tags nil t))
21924 (t (kill-region (point) (point-at-eol)))))
21926 (define-key org-mode-map "\C-k" 'org-kill-line)
21928 (defun org-yank (&optional arg)
21929 "Yank. If the kill is a subtree, treat it specially.
21930 This command will look at the current kill and check if is a single
21931 subtree, or a series of subtrees[1]. If it passes the test, and if the
21932 cursor is at the beginning of a line or after the stars of a currently
21933 empty headline, then the yank is handled specially. How exactly depends
21934 on the value of the following variables, both set by default.
21936 org-yank-folded-subtrees
21937 When set, the subtree(s) will be folded after insertion, but only
21938 if doing so would now swallow text after the yanked text.
21940 org-yank-adjusted-subtrees
21941 When set, the subtree will be promoted or demoted in order to
21942 fit into the local outline tree structure, which means that the level
21943 will be adjusted so that it becomes the smaller one of the two
21944 *visible* surrounding headings.
21946 Any prefix to this command will cause `yank' to be called directly with
21948 will just
21949 plainly yank the text as it is.
21951 \[1] The test checks if the first non-white line is a heading
21952 and if there are no other headings with fewer stars."
21953 (interactive "P")
21954 (org-yank-generic 'yank arg))
21956 (defun org-yank-generic (command arg)
21957 "Perform some yank-like command.
21959 This function implements the behavior described in the `org-yank'
21960 documentation. However, it has been generalized to work for any
21961 interactive command with similar behavior."
21963 ;; pretend to be command COMMAND
21964 (setq this-command command)
21966 (if arg
21967 (call-interactively command)
21969 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
21970 (and (org-kill-is-subtree-p)
21971 (or (bolp)
21973 (string-match
21975 (buffer-substring (point-at-bol) (point)))))))
21976 swallowp)
21977 (cond
21978 ((and subtreep org-yank-folded-subtrees)
21979 (let ((beg (point))
21980 end)
21981 (if (and subtreep org-yank-adjusted-subtrees)
21982 (org-paste-subtree nil nil 'for-yank)
21983 (call-interactively command))
21985 (setq end (point))
21986 (goto-char beg)
21987 (when (and (bolp) subtreep
21988 (not (setq swallowp
21989 (org-yank-folding-would-swallow-text beg end))))
21990 (org-with-limited-levels
21991 (or (looking-at org-outline-regexp)
21992 (re-search-forward org-outline-regexp-bol end t))
21993 (while (and (< (point) end) (looking-at org-outline-regexp))
21994 (hide-subtree)
21995 (org-cycle-show-empty-lines 'folded)
21996 (condition-case nil
21997 (outline-forward-same-level 1)
21998 (error (goto-char end))))))
21999 (when swallowp
22000 (message
22001 "Inserted text not folded because that would swallow text"))
22003 (goto-char end)
22005 (beginning-of-line 1)
22006 (push-mark beg 'nomsg)))
22007 ((and subtreep org-yank-adjusted-subtrees)
22008 (let ((beg (point-at-bol)))
22009 (org-paste-subtree nil nil 'for-yank)
22010 (push-mark beg 'nomsg)))
22011 (t
22012 (call-interactively command))))))
22014 (defun org-yank-folding-would-swallow-text (beg end)
22015 "Would hide-subtree at BEG swallow any text after END?"
22016 (let (level)
22017 (org-with-limited-levels
22018 (save-excursion
22019 (goto-char beg)
22020 (when (or (looking-at org-outline-regexp)
22021 (re-search-forward org-outline-regexp-bol end t))
22022 (setq level (org-outline-level)))
22023 (goto-char end)
22025 (if (or (eobp)
22026 (and (bolp) (looking-at org-outline-regexp)
22027 (<= (org-outline-level) level)))
22028 nil ; Nothing would be swallowed
22029 t))))) ; something would swallow
22031 (define-key org-mode-map "\C-y" 'org-yank)
22033 (defun org-truely-invisible-p ()
22034 "Check if point is at a character currently not visible.
22035 This version does not only check the character property, but also
22036 `visible-mode'."
22037 ;; Early versions of noutline don't have `outline-invisible-p'.
22038 (if (org-bound-and-true-p visible-mode)
22039 nil
22040 (outline-invisible-p)))
22042 (defun org-invisible-p2 ()
22043 "Check if point is at a character currently not visible."
22044 (save-excursion
22045 (if (and (eolp) (not (bobp))) (backward-char 1))
22046 ;; Early versions of noutline don't have `outline-invisible-p'.
22047 (outline-invisible-p)))
22049 (defun org-back-to-heading (&optional invisible-ok)
22050 "Call `outline-back-to-heading', but provide a better error message."
22051 (condition-case nil
22052 (outline-back-to-heading invisible-ok)
22053 (error (error "Before first headline at position %d in buffer %s"
22054 (point) (current-buffer)))))
22056 (defun org-before-first-heading-p ()
22057 "Before first heading?"
22058 (save-excursion
22059 (end-of-line)
22060 (null (re-search-backward org-outline-regexp-bol nil t))))
22062 (defun org-at-heading-p (&optional ignored)
22063 (outline-on-heading-p t))
22064 ;; Compatibility alias with Org versions < 7.8.03
22065 (defalias 'org-on-heading-p 'org-at-heading-p)
22067 (defun org-at-comment-p nil
22068 "Is cursor in a line starting with a # character?"
22069 (save-excursion
22070 (beginning-of-line)
22071 (looking-at "^#")))
22073 (defun org-at-drawer-p nil
22074 "Is cursor at a drawer keyword?"
22075 (save-excursion
22076 (move-beginning-of-line 1)
22077 (looking-at org-drawer-regexp)))
22079 (defun org-at-block-p nil
22080 "Is cursor at a block keyword?"
22081 (save-excursion
22082 (move-beginning-of-line 1)
22083 (looking-at org-block-regexp)))
22085 (defun org-point-at-end-of-empty-headline ()
22086 "If point is at the end of an empty headline, return t, else nil.
22087 If the heading only contains a TODO keyword, it is still still considered
22088 empty."
22090 (when org-todo-line-regexp
22091 (save-excursion
22092 (beginning-of-line 1)
22093 (let ((case-fold-search nil))
22094 (looking-at org-todo-line-regexp)
22095 (string= (match-string 3) ""))))))
22097 (defun org-at-heading-or-item-p ()
22098 (or (org-at-heading-p) (org-at-item-p)))
22100 (defun org-at-target-p ()
22101 (or (org-in-regexp org-radio-target-regexp)
22102 (org-in-regexp org-target-regexp)))
22103 ;; Compatibility alias with Org versions < 7.8.03
22104 (defalias 'org-on-target-p 'org-at-target-p)
22106 (defun org-up-heading-all (arg)
22107 "Move to the heading line of which the present line is a subheading.
22108 This function considers both visible and invisible heading lines.
22109 With argument, move up ARG levels."
22110 (if (fboundp 'outline-up-heading-all)
22111 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22112 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22114 (defun org-up-heading-safe ()
22115 "Move to the heading line of which the present line is a subheading.
22116 This version will not throw an error. It will return the level of the
22117 headline found, or nil if no higher level is found.
22119 Also, this function will be a lot faster than `outline-up-heading',
22120 because it relies on stars being the outline starters. This can really
22121 make a significant difference in outlines with very many siblings."
22122 (let (start-level re)
22123 (org-back-to-heading t)
22124 (setq start-level (funcall outline-level))
22125 (if (equal start-level 1)
22126 nil
22128 (if (re-search-backward re nil t)
22129 (funcall outline-level)))))
22131 (defun org-first-sibling-p ()
22132 "Is this heading the first child of its parents?"
22133 (interactive)
22134 (let ((re org-outline-regexp-bol)
22135 level l)
22136 (unless (org-at-heading-p t)
22137 (error "Not at a heading"))
22138 (setq level (funcall outline-level))
22139 (save-excursion
22140 (if (not (re-search-backward re nil t))
22141 t
22142 (setq l (funcall outline-level))
22143 (< l level)))))
22145 (defun org-goto-sibling (&optional previous)
22146 "Goto the next sibling, even if it is invisible.
22147 When PREVIOUS is set, go to the previous sibling instead. Returns t
22148 when a sibling was found. When none is found, return nil and don't
22149 move point."
22150 (let ((fun (if previous 're-search-backward 're-search-forward))
22151 (pos (point))
22152 (re org-outline-regexp-bol)
22153 level l)
22154 (when (condition-case nil (org-back-to-heading t) (error nil))
22155 (setq level (funcall outline-level))
22156 (catch 'exit
22157 (or previous (forward-char 1))
22158 (while (funcall fun re nil t)
22159 (setq l (funcall outline-level))
22160 (when (< l level) (goto-char pos) (throw 'exit nil))
22161 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
22162 (goto-char pos)
22163 nil))))
22165 (defun org-show-siblings ()
22166 "Show all siblings of the current headline."
22167 (save-excursion
22168 (while (org-goto-sibling) (org-flag-heading nil)))
22169 (save-excursion
22170 (while (org-goto-sibling 'previous)
22171 (org-flag-heading nil))))
22173 (defun org-goto-first-child ()
22174 "Goto the first child, even if it is invisible.
22175 Return t when a child was found. Otherwise don't move point and
22176 return nil."
22177 (let (level (pos (point)) (re org-outline-regexp-bol))
22178 (when (condition-case nil (org-back-to-heading t) (error nil))
22179 (setq level (outline-level))
22180 (forward-char 1)
22181 (if (and (re-search-forward re nil t) (> (outline-level) level))
22182 (progn (goto-char (match-beginning 0)) t)
22183 (goto-char pos) nil))))
22185 (defun org-show-hidden-entry ()
22186 "Show an entry where even the heading is hidden."
22187 (save-excursion
22188 (org-show-entry)))
22190 (defun org-flag-heading (flag &optional entry)
22191 "Flag the current heading. FLAG non-nil means make invisible.
22192 When ENTRY is non-nil, show the entire entry."
22193 (save-excursion
22194 (org-back-to-heading t)
22195 ;; Check if we should show the entire entry
22196 (if entry
22197 (progn
22198 (org-show-entry)
22199 (save-excursion
22200 (and (outline-next-heading)
22201 (org-flag-heading nil))))
22202 (outline-flag-region (max (point-min) (1- (point)))
22203 (save-excursion (outline-end-of-heading) (point))
22204 flag))))
22206 (defun org-get-next-sibling ()
22207 "Move to next heading of the same level, and return point.
22208 If there is no such heading, return nil.
22209 This is like outline-next-sibling, but invisible headings are ok."
22210 (let ((level (funcall outline-level)))
22211 (outline-next-heading)
22212 (while (and (not (eobp)) (> (funcall outline-level) level))
22213 (outline-next-heading))
22214 (if (or (eobp) (< (funcall outline-level) level))
22215 nil
22216 (point))))
22218 (defun org-get-last-sibling ()
22219 "Move to previous heading of the same level, and return point.
22220 If there is no such heading, return nil."
22221 (let ((opoint (point))
22222 (level (funcall outline-level)))
22223 (outline-previous-heading)
22224 (when (and (/= (point) opoint) (outline-on-heading-p t))
22225 (while (and (> (funcall outline-level) level)
22226 (not (bobp)))
22227 (outline-previous-heading))
22228 (if (< (funcall outline-level) level)
22229 nil
22230 (point)))))
22232 (defun org-end-of-subtree (&optional invisible-ok to-heading)
22233 "Goto to the end of a subtree."
22234 ;; This contains an exact copy of the original function, but it uses
22235 ;; `org-back-to-heading', to make it work also in invisible
22236 ;; trees. And is uses an invisible-ok argument.
22237 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
22238 ;; Furthermore, when used inside Org, finding the end of a large subtree
22239 ;; with many children and grandchildren etc, this can be much faster
22240 ;; than the outline version.
22241 (org-back-to-heading invisible-ok)
22242 (let ((first t)
22243 (level (funcall outline-level)))
22244 (if (and (derived-mode-p 'org-mode) (< level 1000))
22245 ;; A true heading (not a plain list item), in Org-mode
22246 ;; This means we can easily find the end by looking
22247 ;; only for the right number of stars. Using a regexp to do
22248 ;; this is so much faster than using a Lisp loop.
22250 (forward-char 1)
22251 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
22252 ;; something else, do it the slow way
22253 (while (and (not (eobp))
22254 (or first (> (funcall outline-level) level)))
22255 (setq first nil)
22256 (outline-next-heading)))
22257 (unless to-heading
22259 (progn
22260 ;; Go to end of line before heading
22261 (forward-char -1)
22263 ;; leave blank line before heading
22264 (forward-char -1))))))
22265 (point))
22267 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
22268 "Use Org version in org-mode, for dramatic speed-up."
22269 (if (derived-mode-p 'org-mode)
22270 (progn
22271 (org-end-of-subtree nil t)
22272 (unless (eobp) (backward-char 1)))
22273 ad-do-it))
22275 (defun org-end-of-meta-data-and-drawers ()
22276 "Jump to the first text after meta data and drawers in the current entry.
22277 This will move over empty lines, lines with planning time stamps,
22278 clocking lines, and drawers."
22279 (org-back-to-heading t)
22280 (let ((end (save-excursion (outline-next-heading) (point)))
22283 (forward-line 1)
22284 (while (re-search-forward re end t)
22285 (if (not (match-end 1))
22286 ;; empty or planning line
22287 (forward-line 1)
22288 ;; a drawer, find the end
22290 (forward-line 1)))
22292 (point)))
22294 (defun org-forward-heading-same-level (arg &optional invisible-ok)
22295 "Move forward to the arg'th subheading at same level as this one.
22296 Stop at the first and last subheadings of a superior heading.
22297 Normally this only looks at visible headings, but when INVISIBLE-OK is
22298 non-nil it will also look at invisible ones."
22299 (interactive "p")
22300 (org-back-to-heading invisible-ok)
22301 (org-at-heading-p)
22302 (let* ((level (- (match-end 0) (match-beginning 0) 1))
22304 l)
22305 (forward-char 1)
22306 (while (> arg 0)
22307 (while (and (re-search-forward re nil 'move)
22308 (setq l (- (match-end 0) (match-beginning 0) 1))
22309 (= l level)
22310 (not invisible-ok)
22311 (progn (backward-char 1) (outline-invisible-p)))
22312 (if (< l level) (setq arg 1)))
22313 (setq arg (1- arg)))
22314 (beginning-of-line 1)))
22316 (defun org-backward-heading-same-level (arg &optional invisible-ok)
22317 "Move backward to the arg'th subheading at same level as this one.
22318 Stop at the first and last subheadings of a superior heading."
22319 (interactive "p")
22320 (org-back-to-heading)
22321 (org-at-heading-p)
22322 (let* ((level (- (match-end 0) (match-beginning 0) 1))
22324 l)
22325 (while (> arg 0)
22326 (while (and (re-search-backward re nil 'move)
22327 (setq l (- (match-end 0) (match-beginning 0) 1))
22328 (= l level)
22329 (not invisible-ok)
22330 (outline-invisible-p))
22331 (if (< l level) (setq arg 1)))
22332 (setq arg (1- arg)))))
22334 (defun org-forward-element ()
22335 "Move forward by one element.
22336 Move to the next element at the same level, when possible."
22337 (interactive)
22338 (cond ((eobp) (error "Cannot move further down"))
22339 ((org-with-limited-levels (org-at-heading-p))
22340 (let ((origin (point)))
22341 (org-forward-heading-same-level 1)
22342 (unless (org-with-limited-levels (org-at-heading-p))
22343 (goto-char origin)
22344 (error "Cannot move further down"))))
22345 (t
22346 (let* ((elem (org-element-at-point))
22347 (end (org-element-property :end elem))
22348 (parent (org-element-property :parent elem)))
22349 (if (and parent (= (org-element-property :contents-end parent) end))
22350 (goto-char (org-element-property :end parent))
22351 (goto-char end))))))
22353 (defun org-backward-element ()
22354 "Move backward by one element.
22355 Move to the previous element at the same level, when possible."
22356 (interactive)
22357 (cond ((bobp) (error "Cannot move further up"))
22358 ((org-with-limited-levels (org-at-heading-p))
22359 ;; At an headline, move to the previous one, if any, or stay
22360 ;; here.
22361 (let ((origin (point)))
22362 (org-backward-heading-same-level 1)
22363 (unless (org-with-limited-levels (org-at-heading-p))
22364 (goto-char origin)
22365 (error "Cannot move further up"))))
22366 (t
22367 (let* ((trail (org-element-at-point 'keep-trail))
22368 (elem (car trail))
22369 (prev-elem (nth 1 trail))
22370 (beg (org-element-property :begin elem)))
22371 (cond
22372 ;; Move to beginning of current element if point isn't
22373 ;; there already.
22374 ((/= (point) beg) (goto-char beg))
22375 (prev-elem (goto-char (org-element-property :begin prev-elem)))
22376 ((org-before-first-heading-p) (goto-char (point-min)))
22377 (t (org-back-to-heading)))))))
22379 (defun org-up-element ()
22380 "Move to upper element."
22381 (interactive)
22382 (if (org-with-limited-levels (org-at-heading-p))
22383 (unless (org-up-heading-safe) (error "No surrounding element"))
22384 (let* ((elem (org-element-at-point))
22385 (parent (org-element-property :parent elem)))
22386 (if parent (goto-char (org-element-property :begin parent))
22387 (if (org-with-limited-levels (org-before-first-heading-p))
22388 (error "No surrounding element")
22389 (org-with-limited-levels (org-back-to-heading)))))))
22391 (defvar org-element-greater-elements)
22392 (defun org-down-element ()
22393 "Move to inner element."
22394 (interactive)
22395 (let ((element (org-element-at-point)))
22396 (cond
22397 ((memq (org-element-type element) '(plain-list table))
22398 (goto-char (org-element-property :contents-begin element))
22399 (forward-char))
22400 ((memq (org-element-type element) org-element-greater-elements)
22401 ;; If contents are hidden, first disclose them.
22402 (when (org-element-property :hiddenp element) (org-cycle))
22403 (goto-char (or (org-element-property :contents-begin element)
22404 (error "No content for this element"))))
22405 (t (error "No inner element")))))
22407 (defun org-drag-element-backward ()
22408 "Move backward element at point."
22409 (interactive)
22410 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
22411 (let* ((trail (org-element-at-point 'keep-trail))
22412 (elem (car trail))
22413 (prev-elem (nth 1 trail)))
22414 ;; Error out if no previous element or previous element is
22415 ;; a parent of the current one.
22416 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
22417 (error "Cannot drag element backward")
22418 (let ((pos (point)))
22419 (org-element-swap-A-B prev-elem elem)
22420 (goto-char (+ (org-element-property :begin prev-elem)
22421 (- pos (org-element-property :begin elem)))))))))
22423 (defun org-drag-element-forward ()
22424 "Move forward element at point."
22425 (interactive)
22426 (let* ((pos (point))
22427 (elem (org-element-at-point)))
22428 (when (= (point-max) (org-element-property :end elem))
22429 (error "Cannot drag element forward"))
22430 (goto-char (org-element-property :end elem))
22431 (let ((next-elem (org-element-at-point)))
22432 (when (or (org-element-nested-p elem next-elem)
22433 (and (eq (org-element-type next-elem) 'headline)
22434 (not (eq (org-element-type elem) 'headline))))
22435 (goto-char pos)
22436 (error "Cannot drag element forward"))
22437 ;; Compute new position of point: it's shifted by NEXT-ELEM
22438 ;; body's length (without final blanks) and by the length of
22439 ;; blanks between ELEM and NEXT-ELEM.
22440 (let ((size-next (- (save-excursion
22441 (goto-char (org-element-property :end next-elem))
22443 (forward-line)
22444 ;; Small correction if buffer doesn't end
22445 ;; with a newline character.
22446 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
22447 (org-element-property :begin next-elem)))
22448 (size-blank (- (org-element-property :end elem)
22449 (save-excursion
22450 (goto-char (org-element-property :end elem))
22452 (forward-line)
22453 (point)))))
22454 (org-element-swap-A-B elem next-elem)
22455 (goto-char (+ pos size-next size-blank))))))
22457 (defun org-mark-element ()
22458 "Put point at beginning of this element, mark at end.
22460 Interactively, if this command is repeated or (in Transient Mark
22461 mode) if the mark is active, it marks the next element after the
22462 ones already marked."
22463 (interactive)
22464 (let (deactivate-mark)
22465 (if (and (org-called-interactively-p 'any)
22466 (or (and (eq last-command this-command) (mark t))
22467 (and transient-mark-mode mark-active)))
22468 (set-mark
22469 (save-excursion
22470 (goto-char (mark))
22471 (goto-char (org-element-property :end (org-element-at-point)))))
22472 (let ((element (org-element-at-point)))
22473 (end-of-line)
22474 (push-mark (org-element-property :end element) t t)
22475 (goto-char (org-element-property :begin element))))))
22477 (defun org-narrow-to-element ()
22478 "Narrow buffer to current element."
22479 (interactive)
22480 (let ((elem (org-element-at-point)))
22481 (cond
22482 ((eq (car elem) 'headline)
22483 (narrow-to-region
22484 (org-element-property :begin elem)
22485 (org-element-property :end elem)))
22486 ((memq (car elem) org-element-greater-elements)
22487 (narrow-to-region
22488 (org-element-property :contents-begin elem)
22489 (org-element-property :contents-end elem)))
22490 (t
22491 (narrow-to-region
22492 (org-element-property :begin elem)
22493 (org-element-property :end elem))))))
22495 (defun org-transpose-element ()
22496 "Transpose current and previous elements, keeping blank lines between.
22497 Point is moved after both elements."
22498 (interactive)
22499 (org-skip-whitespace)
22500 (let ((end (org-element-property :end (org-element-at-point))))
22501 (org-drag-element-backward)
22502 (goto-char end)))
22504 (defun org-unindent-buffer ()
22505 "Un-indent the visible part of the buffer.
22506 Relative indentation (between items, inside blocks, etc.) isn't
22507 modified."
22508 (interactive)
22509 (unless (eq major-mode 'org-mode)
22510 (error "Cannot un-indent a buffer not in Org mode"))
22511 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
22512 unindent-tree ; For byte-compiler.
22513 (unindent-tree
22514 (function
22515 (lambda (contents)
22516 (mapc
22517 (lambda (element)
22518 (if (memq (org-element-type element) '(headline section))
22519 (funcall unindent-tree (org-element-contents element))
22520 (save-excursion
22521 (save-restriction
22522 (narrow-to-region
22523 (org-element-property :begin element)
22524 (org-element-property :end element))
22525 (org-do-remove-indentation)))))
22526 (reverse contents))))))
22527 (funcall unindent-tree (org-element-contents parse-tree))))
22529 (defun org-show-subtree ()
22530 "Show everything after this heading at deeper levels."
22531 (interactive)
22532 (outline-flag-region
22533 (point)
22534 (save-excursion
22535 (org-end-of-subtree t t))
22536 nil))
22538 (defun org-show-entry ()
22539 "Show the body directly following this heading.
22540 Show the heading too, if it is currently invisible."
22541 (interactive)
22542 (save-excursion
22543 (condition-case nil
22544 (progn
22545 (org-back-to-heading t)
22546 (outline-flag-region
22547 (max (point-min) (1- (point)))
22548 (save-excursion
22549 (if (re-search-forward
22551 (match-beginning 1)
22552 (point-max)))
22553 nil)
22554 (org-cycle-hide-drawers 'children))
22555 (error nil))))
22557 (defun org-make-options-regexp (kwds &optional extra)
22558 "Make a regular expression for keyword lines."
22559 (concat
22565 ;; Make isearch reveal the necessary context
22566 (defun org-isearch-end ()
22567 "Reveal context after isearch exits."
22568 (when isearch-success ; only if search was successful
22569 (if (featurep 'xemacs)
22570 ;; Under XEmacs, the hook is run in the correct place,
22571 ;; we directly show the context.
22572 (org-show-context 'isearch)
22573 ;; In Emacs the hook runs *before* restoring the overlays.
22574 ;; So we have to use a one-time post-command-hook to do this.
22575 ;; (Emacs 22 has a special variable, see function `org-mode')
22576 (unless (and (boundp 'isearch-mode-end-hook-quit)
22577 isearch-mode-end-hook-quit)
22578 ;; Only when the isearch was not quitted.
22579 (org-add-hook 'post-command-hook 'org-isearch-post-command
22580 'append 'local)))))
22582 (defun org-isearch-post-command ()
22583 "Remove self from hook, and show context."
22584 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
22585 (org-show-context 'isearch))
22588 ;;;; Integration with and fixes for other packages
22590 ;;; Imenu support
22592 (defvar org-imenu-markers nil
22593 "All markers currently used by Imenu.")
22594 (make-variable-buffer-local 'org-imenu-markers)
22596 (defun org-imenu-new-marker (&optional pos)
22597 "Return a new marker for use by Imenu, and remember the marker."
22598 (let ((m (make-marker)))
22599 (move-marker m (or pos (point)))
22600 (push m org-imenu-markers)
22601 m))
22603 (defun org-imenu-get-tree ()
22604 "Produce the index for Imenu."
22605 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
22606 (setq org-imenu-markers nil)
22607 (let* ((n org-imenu-depth)
22608 (re (concat "^" (org-get-limited-outline-regexp)))
22609 (subs (make-vector (1+ n) nil))
22610 (last-level 0)
22611 m level head)
22612 (save-excursion
22613 (save-restriction
22614 (widen)
22615 (goto-char (point-max))
22616 (while (re-search-backward re nil t)
22617 (setq level (org-reduced-level (funcall outline-level)))
22618 (when (and (<= level n)
22619 (looking-at org-complex-heading-regexp))
22620 (setq head (org-link-display-format
22621 (org-match-string-no-properties 4))
22622 m (org-imenu-new-marker))
22623 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
22624 (if (>= level last-level)
22625 (push (cons head m) (aref subs level))
22626 (push (cons head (aref subs (1+ level))) (aref subs level))
22627 (loop for i from (1+ level) to n do (aset subs i nil)))
22628 (setq last-level level)))))
22629 (aref subs 1)))
22631 (eval-after-load "imenu"
22632 '(progn
22633 (add-hook 'imenu-after-jump-hook
22634 (lambda ()
22635 (if (derived-mode-p 'org-mode)
22636 (org-show-context 'org-goto))))))
22638 (defun org-link-display-format (link)
22639 "Replace a link with either the description, or the link target
22640 if no description is present"
22641 (save-match-data
22642 (if (string-match org-bracket-link-analytic-regexp link)
22643 (replace-match (if (match-end 5)
22644 (match-string 5 link)
22645 (concat (match-string 1 link)
22646 (match-string 3 link)))
22647 nil t link)
22648 link)))
22650 (defun org-toggle-link-display ()
22651 "Toggle the literal or descriptive display of links."
22652 (interactive)
22653 (if org-descriptive-links
22654 (progn (org-remove-from-invisibility-spec '(org-link))
22655 (org-restart-font-lock)
22656 (setq org-descriptive-links nil))
22657 (progn (add-to-invisibility-spec '(org-link))
22658 (org-restart-font-lock)
22659 (setq org-descriptive-links t))))
22661 ;; Speedbar support
22663 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
22664 "Overlay marking the agenda restriction line in speedbar.")
22665 (overlay-put org-speedbar-restriction-lock-overlay
22666 'face 'org-agenda-restriction-lock)
22667 (overlay-put org-speedbar-restriction-lock-overlay
22668 'help-echo "Agendas are currently limited to this item.")
22669 (org-detach-overlay org-speedbar-restriction-lock-overlay)
22671 (defun org-speedbar-set-agenda-restriction ()
22672 "Restrict future agenda commands to the location at point in speedbar.
22674 (interactive)
22675 (require 'org-agenda)
22676 (let (p m tp np dir txt)
22677 (cond
22678 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22679 'org-imenu t))
22680 (setq m (get-text-property p 'org-imenu-marker))
22681 (with-current-buffer (marker-buffer m)
22682 (goto-char m)
22683 (org-agenda-set-restriction-lock 'subtree)))
22684 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22685 'speedbar-function 'speedbar-find-file))
22686 (setq tp (previous-single-property-change
22687 (1+ p) 'speedbar-function)
22688 np (next-single-property-change
22689 tp 'speedbar-function)
22690 dir (speedbar-line-directory)
22691 txt (buffer-substring-no-properties (or tp (point-min))
22692 (or np (point-max))))
22693 (with-current-buffer (find-file-noselect
22694 (let ((default-directory dir))
22695 (expand-file-name txt)))
22696 (unless (derived-mode-p 'org-mode)
22697 (error "Cannot restrict to non-Org-mode file"))
22698 (org-agenda-set-restriction-lock 'file)))
22699 (t (error "Don't know how to restrict Org-mode's agenda")))
22700 (move-overlay org-speedbar-restriction-lock-overlay
22701 (point-at-bol) (point-at-eol))
22702 (setq current-prefix-arg nil)
22703 (org-agenda-maybe-redo)))
22705 (eval-after-load "speedbar"
22706 '(progn
22707 (speedbar-add-supported-extension ".org")
22708 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
22709 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
22710 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
22711 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
22712 (add-hook 'speedbar-visiting-tag-hook
22713 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
22715 ;;; Fixes and Hacks for problems with other packages
22717 ;; Make flyspell not check words in links, to not mess up our keymap
22718 (defun org-mode-flyspell-verify ()
22719 "Don't let flyspell put overlays at active buttons, or on
22720 {todo,all-time,additional-option-like}-keywords."
22721 (let ((pos (max (1- (point)) (point-min)))
22722 (word (thing-at-point 'word)))
22723 (and (not (get-text-property pos 'keymap))
22724 (not (get-text-property pos 'org-no-flyspell))
22725 (not (member word org-todo-keywords-1))
22726 (not (member word org-all-time-keywords))
22727 (not (member word org-options-keywords))
22728 (not (member word (mapcar 'car org-startup-options)))
22729 (not (member word org-additional-option-like-keywords-for-flyspell)))))
22731 (defun org-remove-flyspell-overlays-in (beg end)
22732 "Remove flyspell overlays in region."
22733 (and (org-bound-and-true-p flyspell-mode)
22734 (fboundp 'flyspell-delete-region-overlays)
22735 (flyspell-delete-region-overlays beg end))
22736 (add-text-properties beg end '(org-no-flyspell t)))
22738 ;; Make `bookmark-jump' shows the jump location if it was hidden.
22739 (eval-after-load "bookmark"
22740 '(if (boundp 'bookmark-after-jump-hook)
22741 ;; We can use the hook
22742 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
22743 ;; Hook not available, use advice
22744 (defadvice bookmark-jump (after org-make-visible activate)
22745 "Make the position visible."
22746 (org-bookmark-jump-unhide))))
22748 ;; Make sure saveplace shows the location if it was hidden
22749 (eval-after-load "saveplace"
22750 '(defadvice save-place-find-file-hook (after org-make-visible activate)
22751 "Make the position visible."
22752 (org-bookmark-jump-unhide)))
22754 ;; Make sure ecb shows the location if it was hidden
22755 (eval-after-load "ecb"
22756 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
22757 "Make hierarchy visible when jumping into location from ECB tree buffer."
22758 (if (derived-mode-p 'org-mode)
22759 (org-show-context))))
22761 (defun org-bookmark-jump-unhide ()
22762 "Unhide the current position, to show the bookmark location."
22763 (and (derived-mode-p 'org-mode)
22764 (or (outline-invisible-p)
22765 (save-excursion (goto-char (max (point-min) (1- (point))))
22766 (outline-invisible-p)))
22767 (org-show-context 'bookmark-jump)))
22769 ;; Make session.el ignore our circular variable
22770 (eval-after-load "session"
22771 '(add-to-list 'session-globals-exclude 'org-mark-ring))
22773 ;;;; Experimental code
22775 (defun org-closed-in-range ()
22776 "Sparse tree of items closed in a certain time range.
22777 Still experimental, may disappear in the future."
22778 (interactive)
22779 ;; Get the time interval from the user.
22780 (let* ((time1 (org-float-time
22781 (org-read-date nil 'to-time nil "Starting date: ")))
22782 (time2 (org-float-time
22783 (org-read-date nil 'to-time nil "End date:")))
22784 ;; callback function
22785 (callback (lambda ()
22786 (let ((time
22787 (org-float-time
22788 (apply 'encode-time
22789 (org-parse-time-string
22790 (match-string 1))))))
22791 ;; check if time in interval
22792 (and (>= time time1) (<= time time2))))))
22793 ;; make tree, check each match with the callback
22796 ;;;; Finish up
22798 (provide 'org)
22800 (run-hooks 'org-load-hook)
22802 ;;; org.el ends here