| blob | 881cd4f3fe13642b6d564af920bda784e64eafaf |
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
83 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
84 ;; some places -- e.g. see the macro org-with-limited-levels.
85 ;;
86 ;; In Org buffers, the value of `outline-regexp' is that of
87 ;; `org-outline-regexp'. The only function still directly relying on
88 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
89 ;; job when `orgstruct-mode' is active.
94 "Regexp to match Org headlines.
95 This is similar to `org-outline-regexp' but additionally makes
99 "Matches an headline, putting stars and text into groups.
102 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
116 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
122 ;; load languages based on value of `org-babel-load-languages'
125 ;;;###autoload
127 "Load the languages defined in `org-babel-load-languages'."
139 org-babel-load-languages))
142 "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes. When a language is
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding. By default only Emacs Lisp (which has no
151 requirements) is loaded."
156 :key-type
199 ;;;; Customization variables
201 "Remove ID property of clones of a subtree.
202 When non-nil, clones of a subtree don't inherit the ID property.
203 Otherwise they inherit the ID property with a new unique
204 identifier."
209 ;;; Version
213 ;;;###autoload
215 "Show the org-mode version in the echo area.
216 With prefix argument HERE, insert it at point.
217 When FULL is non-nil, use a verbose version string.
218 When MESSAGE is non-nil, display a message with the version."
229 org-version
230 git-version
233 org-install-dir
242 _version)))
246 ;;; Compatibility constants
248 ;;; The custom variables
251 "Outline-based notes management and organizer."
257 "Mode hook for Org-mode, run after the mode was turned on."
262 "Hook that is run after org.el has been loaded."
267 "Hook that is run after an Org log buffer is created."
277 "Load all extensions listed in `org-modules'."
282 org-modules)
286 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
295 (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)
296 "Modules that should always be loaded together with org.el.
297 If a description starts with <C>, the file is not part of Emacs
298 and loading it will require that you have downloaded and properly installed
299 the org-mode distribution.
301 You can also use this system to load external packages (i.e. neither Org
302 core modules, nor modules from the CONTRIB directory). Just add symbols
303 to the end of the list. If the package is called org-xyz.el, then you need
304 to add the symbol `xyz', and the package must have a call to
306 (provide 'org-xyz)"
309 :type
340 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
349 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
358 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
374 "Non-nil means make shift-cursor commands select text when possible.
376 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
377 start selecting a region, or enlarge regions started in this way.
378 In Org-mode, in special contexts, these same keys are used for
379 other purposes, important enough to compete with shift selection.
380 Org tries to balance these needs by supporting `shift-select-mode'
381 outside these special contexts, under control of this variable.
383 The default of this variable is nil, to avoid confusing behavior. Shifted
384 cursor keys will then execute Org commands in the following contexts:
385 - on a headline, changing TODO state (left/right) and priority (up/down)
386 - on a time stamp, changing the time
387 - in a plain list item, changing the bullet type
388 - in a property definition line, switching between allowed values
389 - in the BEGIN line of a clock table (changing the time block).
390 Outside these contexts, the commands will throw an error.
392 When this variable is t and the cursor is not in a special
393 context, Org-mode will support shift-selection for making and
394 enlarging regions. To make this more effective, the bullet
395 cycling will no longer happen anywhere in an item line, but only
396 if the cursor is exactly on the bullet.
398 If you set this variable to the symbol `always', then the keys
399 will not be special in headlines, property lines, and item lines,
400 to make shift selection work there as well. If this is what you
401 want, you can use the following alternative commands: `C-c C-t'
402 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
403 can be used to switch TODO sets, `C-c -' to cycle item bullet
404 types, and properties can be edited by hand or in column view.
406 However, when the cursor is on a timestamp, shift-cursor commands
407 will still edit the time stamp - this is just too good to give up.
409 XEmacs user should have this variable set to nil, because
410 `shift-select-mode' is in Emacs 23 or later only."
418 "Shall some commands act upon headlines in the active region?
420 When set to `t', some commands will be performed in all headlines
421 within the active region.
423 When set to `start-level', some commands will be performed in all
424 headlines within the active region, provided that these headlines
425 are of the same level than the first one.
427 When set to a string, those commands will be performed on the
428 matching headlines within the active region. Such string must be
429 a tags/property/todo match as it is used in the agenda tags view.
431 The list of commands is: `org-schedule', `org-deadline',
432 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
433 `org-archive-to-archive-sibling'. The archiving commands skip
434 already archived entries."
444 "Options concerning startup of Org-mode."
449 "Non-nil means entering Org-mode will switch to OVERVIEW.
450 This can also be configured on a per-file basis by adding one of
451 the following lines anywhere in the buffer:
453 #+STARTUP: fold (or `overview', this is equivalent)
454 #+STARTUP: nofold (or `showall', this is equivalent)
455 #+STARTUP: content
456 #+STARTUP: showeverything"
465 "Non-nil means entering Org-mode will set `truncate-lines'.
466 This is useful since some lines containing links can be very long and
467 uninteresting. Also tables look terrible when wrapped."
472 "Non-nil means turn on `org-indent-mode' on startup.
473 This can also be configured on a per-file basis by adding one of
474 the following lines anywhere in the buffer:
476 #+STARTUP: indent
477 #+STARTUP: noindent"
485 When this option is turned on, you can use TeX-like syntax for sub- and
487 considered as a single item - so grouping with {} is normally not
488 needed. For example, the following things will be parsed as single
489 sub- or superscripts.
491 10^24 or 10^tau several digits will be considered 1 item.
492 10^-12 or 10^-tau a leading sign with digits or a word
493 x^2-y^3 will be read as x^2 - y^3, because items are
494 terminated by almost any nonword/nondigit char.
495 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
497 Still, ambiguity is possible - so when in doubt use {} to enclose the
498 sub/superscript. If you set this variable to the symbol `{}',
499 the braces are *required* in order to trigger interpretations as
501 frequently in plain text.
503 Not all export backends support this, but HTML does.
519 "Non-nil means turn on `org-beamer-mode' on startup.
520 This can also be configured on a per-file basis by adding one of
521 the following lines anywhere in the buffer:
523 #+STARTUP: beamer"
529 "Non-nil means align all tables when visiting a file.
530 This is useful when the column width in tables is forced with <N> cookies
531 in table fields. Such tables will look correct only after the first re-align.
532 This can also be configured on a per-file basis by adding one of
533 the following lines anywhere in the buffer:
534 #+STARTUP: align
535 #+STARTUP: noalign"
540 "Non-nil means show inline images when loading a new Org file.
541 This can also be configured on a per-file basis by adding one of
542 the following lines anywhere in the buffer:
543 #+STARTUP: inlineimages
544 #+STARTUP: noinlineimages"
550 "Non-nil means insert the first line setting Org-mode in empty files.
551 When the function `org-mode' is called interactively in an empty file, this
552 normally means that the file name does not automatically trigger Org-mode.
553 To ensure that the file will always be in Org-mode in the future, a
554 line enforcing Org-mode will be inserted into the buffer, if this option
555 has been set."
560 "Non-nil means use alternative key bindings for some keys.
561 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
562 These keys are also used by other packages like shift-selection-mode'
563 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
564 If you want to use Org-mode together with one of these other modes,
565 or more generally if you would like to move some Org-mode commands to
566 other keys, set this variable and configure the keys with the variable
567 `org-disputed-keys'.
569 This option is only relevant at load-time of Org-mode, and must be set
570 *before* org.el is loaded. Changing it requires a restart of Emacs to
571 become effective."
576 "Non-nil means use extra key sequence definitions for certain commands.
577 This happens automatically if you run XEmacs or if `window-system'
578 is nil. This variable lets you do the same manually. You must
579 set it before loading org.
581 Example: on Carbon Emacs 22 running graphically, with an external
582 keyboard on a Powerbook, the default way of setting M-left might
583 not work for either Alt or ESC. Setting this variable will make
584 it work for ESC."
598 "Keys for which Org-mode and other modes compete.
599 This is an alist, cars are the default keys, second element specifies
600 the alternative to use when `org-replace-disputed-keys' is t.
602 Keys can be specified in any syntax supported by `define-key'.
603 The value of this option takes effect only at Org-mode's startup,
604 therefore you'll have to restart Emacs to apply it after changing."
609 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
610 Or return the original if not disputed.
611 Also apply the translations defined in `org-xemacs-key-equivalents'."
616 org-disputed-keys)))
620 key)
630 "Define a key, possibly translated, as returned by `org-key'."
634 "The ellipsis to use in the Org-mode outline.
635 When nil, just use the standard three dots. When a string, use that instead,
636 When a face, use the standard 3 dots, but with the specified face.
637 The change affects only Org-mode (which will then use its own display table).
638 Changing this requires executing `M-x org-mode' in a buffer to become
639 effective."
649 "Keywords in Org-mode."
654 "String to mark deadline entries.
655 A deadline is this string, followed by a time stamp. Should be a word,
656 terminated by a colon. You can insert a schedule keyword and
658 Changes become only effective after restarting Emacs."
663 "String to mark scheduled TODO entries.
664 A schedule is this string, followed by a time stamp. Should be a word,
665 terminated by a colon. You can insert a schedule keyword and
667 Changes become only effective after restarting Emacs."
672 "String used as the prefix for timestamps logging closing a TODO entry."
677 "String used as prefix for timestamps clocking work hours on an item."
689 "Entries starting with this keyword will never be exported.
690 An entry can be toggled between COMMENT and normal with
692 Changes become only effective after restarting Emacs."
697 "Entries starting with this keyword will be exported in fixed-width font.
698 Quoting applies only to the text in the entry following the headline, and does
699 not extend beyond the next headline, even if that is lower level.
700 An entry can be toggled between QUOTE and normal with
707 "Regular expression for specifying repeated events.
711 "Options concerning the general structure of Org-mode files."
716 "Options about how to make context of a location visible."
740 "Non-nil means show full hierarchy when revealing a location.
741 Org-mode often shows locations in an org-mode file which might have
742 been invisible before. When this is set, the hierarchy of headings
743 above the exposed location is shown.
744 Turning this off for example for sparse trees makes them very compact.
745 Instead of t, this can also be an alist specifying this option for different
746 contexts. Valid contexts are
747 agenda when exposing an entry from the agenda
748 org-goto when using the command `org-goto' on key C-c C-j
749 occur-tree when using the command `org-occur' on key C-c /
750 tags-tree when constructing a sparse tree based on tags matches
751 link-search when exposing search matches associated with a link
752 mark-goto when exposing the jump goal of a mark
753 bookmark-jump when exposing a bookmark location
754 isearch when exiting from an incremental search
755 default default for all contexts not set explicitly"
760 "Non-nil means show following heading when revealing a location.
761 Org-mode often shows locations in an org-mode file which might have
762 been invisible before. When this is set, the heading following the
763 match is shown.
764 Turning this off for example for sparse trees makes them very compact,
765 but makes it harder to edit the location of the match. In such a case,
767 Instead of t, this can also be an alist specifying this option for different
768 contexts. See `org-show-hierarchy-above' for valid contexts."
773 "Non-nil means show all sibling heading when revealing a location.
774 Org-mode often shows locations in an org-mode file which might have
775 been invisible before. When this is set, the sibling of the current entry
776 heading are all made visible. If `org-show-hierarchy-above' is t,
777 the same happens on each level of the hierarchy above the current entry.
779 By default this is on for the isearch context, off for all other contexts.
780 Turning this off for example for sparse trees makes them very compact,
781 but makes it harder to edit the location of the match. In such a case,
783 Instead of t, this can also be an alist specifying this option for different
784 contexts. See `org-show-hierarchy-above' for valid contexts."
789 "Non-nil means show the entry below a headline when revealing a location.
790 Org-mode often shows locations in an org-mode file which might have
791 been invisible before. When this is set, the text below the headline that is
792 exposed is also shown.
794 By default this is off for all contexts.
795 Instead of t, this can also be an alist specifying this option for different
796 contexts. See `org-show-hierarchy-above' for valid contexts."
801 "How should indirect tree buffers be displayed?
802 This applies to indirect buffers created with the commands
804 Valid values are:
805 current-window Display in the current window
806 other-window Just display in another window.
807 dedicated-frame Create one new frame, and re-use it each time.
808 new-frame Make a new frame each time. Note that in this case
809 previously-made indirect buffers are kept, and you need to
810 kill these buffers yourself."
820 "Non-nil means activate single letter commands at beginning of a headline.
821 This may also be a function to test for appropriate locations where speed
822 commands should be active."
830 "Alist of additional speed commands.
831 This list will be checked before `org-speed-commands-default'
832 when the variable `org-use-speed-commands' is non-nil
833 and when the cursor is at the beginning of a headline.
834 The car if each entry is a string with a single letter, which must
835 be assigned to `self-insert-command' in the global map.
836 The cdr is either a command to be called interactively, a function
837 to be called, or a form to be evaluated.
838 An entry that is just a list with a single string will be interpreted
839 as a descriptive headline that will be added when listing the speed
840 commands in the Help buffer using the `?' speed command."
852 "Options concerning visibility cycling in Org-mode."
857 "Non-nil means skip CHILDREN state in entries that don't have any."
862 "Maximum level which should still be subject to visibility cycling.
863 Levels higher than this will, for cycling, be treated as text, not a headline.
864 When `org-odd-levels-only' is set, a value of N in this variable actually
865 means 2N-1 stars as the limiting headline.
866 When nil, cycle all levels.
867 Note that the limiting level of cycling is also influenced by
868 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
869 `org-inlinetask-min-level' is, cycling will be limited to levels one less
870 than its value."
877 "Names of drawers. Drawers are not opened by cycling on the headline above.
878 Drawers only open with a TAB on the drawer line itself. A drawer looks like
879 this:
880 :DRAWERNAME:
881 .....
882 :END:
884 the property API.
886 Drawers can be defined on the per-file basis with a line like:
888 #+DRAWERS: HIDDEN STATE PROPERTIES"
894 "Non-nil means entering Org-mode will fold all blocks.
895 This can also be set in on a per-file basis with
897 #+STARTUP: hideblocks
898 #+STARTUP: showblocks"
904 "Cycle globally if cursor is at beginning of buffer and not at a headline.
905 This makes it possible to do global cycling without having to use S-TAB or
907 of the buffer must not be a headline -- it may be empty or some other text.
908 When used in this way, `org-cycle-hook' is disabled temporarily to make
909 sure the cursor stays at the beginning of the buffer. When this option is
910 nil, don't do anything special at the beginning of the buffer."
915 "Non-nil means cycle entry level or item indentation in new empty entries.
917 When the cursor is at the end of an empty headline, i.e with only stars
918 and maybe a TODO keyword, TAB will then switch the entry to become a child,
919 and then all possible ancestor states, before returning to the original state.
920 This makes data entry extremely fast: M-RET to create a new headline,
921 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
923 When the cursor is at the end of an empty plain list item, one TAB will
924 make it a subitem, two or more tabs will back up to make this an item
925 higher up in the item hierarchy."
930 "Where should `org-cycle' emulate TAB.
931 nil Never
932 white Only in completely white lines
933 whitestart Only at the beginning of lines, before the first non-white char
934 t Everywhere except in headlines
935 exc-hl-bol Everywhere except at the start of a headline
936 If TAB is used in a place where it does not emulate TAB, the current subtree
937 visibility is cycled."
944 ))
947 "Number of empty lines needed to keep an empty line between collapsed trees.
948 If you leave an empty line between the end of a subtree and the following
949 headline, this empty line is hidden when the subtree is folded.
950 Org-mode will leave (exactly) one empty line visible if the number of
951 empty lines is equal or larger to the number given in this variable.
952 So the default 2 means at least 2 empty lines after the end of a subtree
953 are needed to produce free space between a collapsed subtree and the
954 following headline.
956 If the number is negative, and the number of empty lines is at least -N,
957 all empty lines are shown.
959 Special case: when 0, never leave empty lines in collapsed view."
965 "Hook that is run before visibility cycling is happening.
966 The function(s) in this hook must accept a single argument which indicates
967 the new state that will be set right after running this hook. The
968 argument is a symbol. Before a global state change, it can have the values
969 `overview', `content', or `all'. Before a local state change, it can have
970 the values `folded', `children', or `subtree'."
975 org-cycle-hide-drawers
976 org-cycle-show-empty-lines
977 org-optimize-window-after-visibility-change)
978 "Hook that is run after `org-cycle' has changed the buffer visibility.
979 The function(s) in this hook must accept a single argument which indicates
980 the new state that was set by the most recent `org-cycle' command. The
981 argument is a symbol. After a global state change, it can have the values
982 `overview', `contents', or `all'. After a local state change, it can have
983 the values `folded', `children', or `subtree'."
988 "Options concerning structure editing in Org-mode."
993 "Non-nil means skip even levels and only use odd levels for the outline.
994 This has the effect that two stars are being added/taken away in
995 promotion/demotion commands. It also influences how levels are
996 handled by the exporters.
997 Changing it requires restart of `font-lock-mode' to become effective
998 for fontification also in regions already fontified.
999 You may also set this on a per-file basis by adding one of the following
1000 lines to the buffer:
1002 #+STARTUP: odd
1003 #+STARTUP: oddeven"
1009 "Non-nil means adapt indentation to outline node level.
1011 When this variable is set, Org assumes that you write outlines by
1012 indenting text in each node to align with the headline (after the stars).
1013 The following issues are influenced by this variable:
1015 - When this is set and the *entire* text in an entry is indented, the
1016 indentation is increased by one space in a demotion command, and
1017 decreased by one in a promotion command. If any line in the entry
1018 body starts with text at column 0, indentation is not changed at all.
1020 - Property drawers and planning information is inserted indented when
1021 this variable s set. When nil, they will not be indented.
1023 - TAB indents a line relative to context. The lines below a headline
1024 will be indented when this variable is set.
1026 Note that this is all about true indentation, by adding and removing
1027 space characters. See also `org-indent.el' which does level-dependent
1028 indentation in a virtual way, i.e. at display time in Emacs."
1033 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1035 When t, `C-a' will bring back the cursor to the beginning of the
1036 headline text, i.e. after the stars and after a possible TODO
1037 keyword. In an item, this will be the position after bullet and
1038 check-box, if any. When the cursor is already at that position,
1039 another `C-a' will bring it to the beginning of the line.
1041 `C-e' will jump to the end of the headline, ignoring the presence
1042 of tags in the headline. A second `C-e' will then jump to the
1043 true end of the line, after any tags. This also means that, when
1044 this variable is non-nil, `C-e' also will never jump beyond the
1045 end of the heading of a folded section, i.e. not after the
1046 ellipses.
1048 When set to the symbol `reversed', the first `C-a' or `C-e' works
1049 normally, going to the true line boundary first. Only a directly
1050 following, identical keypress will bring the cursor to the
1051 special positions.
1053 This may also be a cons cell where the behavior for `C-a' and
1054 `C-e' is set separately."
1073 "Non-nil means `C-k' will behave specially in headlines.
1074 When nil, `C-k' will call the default `kill-line' command.
1075 When t, the following will happen while the cursor is in the headline:
1077 - When the cursor is at the beginning of a headline, kill the entire
1078 line and possible the folded subtree below the line.
1079 - When in the middle of the headline text, kill the headline up to the tags.
1080 - When after the headline text, kill the tags."
1085 "Non-nil means, do not delete a hidden subtree with C-k.
1086 When set to the symbol `error', simply throw an error when C-k is
1087 used to kill (part-of) a headline that has hidden text behind it.
1088 Any other non-nil value will result in a query to the user, if it is
1089 OK to kill that hidden subtree. When nil, kill without remorse."
1098 "Check if in invisible region before inserting or deleting a character.
1099 Valid values are:
1101 nil Do not check, so just do invisible edits.
1102 error Throw an error and do nothing.
1103 show Make point visible, and do the requested edit.
1104 show-and-error Make point visible, then throw an error and abort the edit.
1105 smart Make point visible, and do insertion/deletion if it is
1106 adjacent to visible text and the change feels predictable.
1107 Never delete a previously invisible character or add in the
1108 middle or right after an invisible region. Basically, this
1109 allows insertion and backward-delete right before ellipses.
1110 FIXME: maybe in this case we should not even show?"
1121 "Non-nil means when yanking subtrees, fold them.
1122 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1123 it starts with a heading and all other headings in it are either children
1124 or siblings, then fold all the subtrees. However, do this only if no
1125 text after the yank would be swallowed into a folded tree by this action."
1130 "Non-nil means when yanking subtrees, adjust the level.
1131 With this setting, `org-paste-subtree' is used to insert the subtree, see
1132 this function for details."
1137 "Non-nil means M-RET will split the line at the cursor position.
1138 When nil, it will go to the end of the line before making a
1139 new line.
1140 You may also set this option in a different way for different
1141 contexts. Valid contexts are:
1143 headline when creating a new headline
1144 item when creating a new item
1145 table in a table field
1146 default the value to be used for all contexts not explicitly
1147 customized"
1164 "Non-nil means insert new headings after the current subtree.
1165 When nil, the new heading is created directly after the current line.
1168 for the duration of the command."
1174 "Should `org-insert-heading' leave a blank line before new heading/item?
1175 The value is an alist, with `heading' and `plain-list-item' as CAR,
1176 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1177 which case Org will look at the surrounding headings/items and try to
1178 make an intelligent decision whether to insert a blank line or not.
1180 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1181 set, the setting here is ignored and no empty line is inserted, to avoid
1182 breaking the list structure."
1195 "Hook being run after inserting a new heading."
1201 This currently only means they are never auto-wrapped.
1202 When nil, such lines will be treated like ordinary lines.
1203 See also the QUOTE keyword."
1208 "Non-nil means typing characters in `org-goto' starts incremental search."
1213 "Options concerning sparse trees in Org-mode."
1218 "Non-nil means highlight all matches that define a sparse tree.
1219 The highlights will automatically disappear the next time the buffer is
1220 changed by an edit command."
1225 "Non-nil means any change to the buffer will remove temporary highlights.
1226 Such highlights are created by `org-occur' and `org-clock-display'.
1227 When nil, `C-c C-c needs to be used to get rid of the highlights.
1228 The highlights created by `org-preview-latex-fragment' always need
1229 `C-c C-c' to be removed."
1236 "Hook that is run after `org-occur' has constructed a sparse tree.
1237 This can be used to recenter the window to show as much of the structure
1238 as possible."
1243 "Options concerning imenu and speedbar in Org-mode."
1248 "The maximum level for Imenu access to Org-mode headlines.
1249 This also applied for speedbar access."
1254 "Options concerning tables in Org-mode."
1260 When nil, such lines will be treated like ordinary lines.
1262 When equal to the symbol `optimized', the table editor will be optimized to
1263 do the following:
1264 - Automatic overwrite mode in front of whitespace in table fields.
1265 This makes the structure of the table stay in tact as long as the edited
1266 field does not exceed the column width.
1267 - Minimize the number of realigns. Normally, the table is aligned each time
1268 TAB or RET are pressed to move to another field. With optimization this
1269 happens only if changes to a field might have changed the column width.
1270 Optimization requires replacing the functions `self-insert-command',
1271 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1272 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1273 very good at guessing when a re-align will be necessary, but you can always
1276 If you would like to use the optimized version in Org-mode, but the
1277 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1279 This variable can be used to turn on and off the table editor during a session,
1280 but in order to toggle optimization, a restart is required.
1282 See also the variable `org-table-auto-blank-field'."
1291 "Non-nil means cluster self-insert commands for undo when possible.
1292 If this is set, then, like in the Emacs command loop, 20 consecutive
1293 characters will be undone together.
1294 This is configurable, because there is some impact on typing performance."
1299 "Non-nil means TAB will automatically notice a table.el table.
1300 When it sees such a table, it moves point into it and - if necessary -
1301 calls `table-recognize-table'."
1306 "Options concerning links in Org-mode."
1311 "Buffer-local version of `org-link-abbrev-alist', which see.
1316 "Alist of link abbreviations.
1317 The car of each element is a string, to be replaced at the start of a link.
1319 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1321 [[linkkey:tag][description]]
1323 The 'linkkey' must be a word word, starting with a letter, followed
1324 by letters, numbers, '-' or '_'.
1326 If REPLACE is a string, the tag will simply be appended to create the link.
1329 at that point (see the function `url-hexify-string'). If the string contains
1331 be invoked: this function takes the tag as its only argument and must return
1332 a string.
1334 REPLACE may also be a function that will be called with the tag as the
1335 only argument to create the link, which should be returned as a string.
1337 See the manual for examples."
1347 "Non-nil means Org will display descriptive links.
1348 E.g. [[http://orgmode.org][Org website]] will be displayed as
1350 description. When set to `nil', Org will display the full links
1351 literally.
1353 You can interactively set the value of this variable by calling
1354 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1359 "How the path name in file links should be stored.
1360 Valid values are:
1362 relative Relative to the current directory, i.e. the directory of the file
1363 into which the link is being inserted.
1364 absolute Absolute path, if possible with ~ for home directory.
1365 noabbrev Absolute path, no abbreviation of home directory.
1366 adaptive Use relative path for files in the current directory and sub-
1367 directories of it. For other files, use an absolute path."
1376 "Types of links that should be activated in Org-mode files.
1377 This is a list of symbols, each leading to the activation of a certain link
1378 type. In principle, it does not hurt to turn on most link types - there may
1379 be a small gain when turning off unused link types. The types are:
1381 bracket The recommended [[link][description]] or [[link]] links with hiding.
1382 angle Links in angular brackets that may contain whitespace like
1383 <bbdb:Carsten Dominik>.
1384 plain Plain links in normal text, no whitespace, like http://google.com.
1385 radio Text that is matched by a radio target, see manual for details.
1386 tag Tag settings in a headline (link to tag search).
1387 date Time stamps (link to calendar).
1388 footnote Footnote labels.
1390 Changing this variable requires a restart of Emacs to become effective."
1402 "Function to use for generating link descriptions from links.
1403 When nil, the link location will be used. This function must take
1404 two parameters: the first one is the link, the second one is the
1405 description generated by `org-insert-link'. The function should
1406 return the description to use."
1411 "Options concerning storing links in Org-mode."
1416 "When non-nil, hexify URL when creating a link."
1422 "Format of the description part of a link to an email or usenet message.
1423 The following %-escapes will be replaced by corresponding information:
1431 %s subject
1432 %d date
1433 %m message-id.
1435 You may use normal field width specification between the % and the letter.
1436 This is for example useful to limit the length of the subject.
1450 It should match if the message is from the user him/herself."
1455 "Non-nil means file links from `org-store-link' contain context.
1456 A search string will be added to the file name with :: as separator and
1457 used to find the context when the link is activated by the command
1458 `org-open-at-point'. When this option is t, the entire active region
1459 will be placed in the search string of the file link. If set to a
1460 positive integer, only the first n lines of context will be stored.
1463 negates this setting for the duration of the command."
1468 "Non-nil means keep link in list for entire session.
1470 The command `org-store-link' adds a link pointing to the current
1471 location to an internal list. These links accumulate during a session.
1472 The command `org-insert-link' can be used to insert links into any
1473 Org-mode file (offering completion for all stored links). When this
1475 will be removed from the list, to make completing the unused links
1476 more efficient."
1481 "Options concerning following links in Org-mode."
1486 "Function to translate links with different syntax to Org syntax.
1487 This can be used to translate links created for example by the Planner
1488 or emacs-wiki packages to Org syntax.
1489 The function must accept two parameters, a TYPE containing the link
1491 which is everything after the link protocol. It should return a cons
1492 with possibly modified values of type and path.
1493 Org contains a function for this, so if you set this variable to
1494 `org-translate-link-from-planner', you should be able follow many
1495 links created by planner."
1500 "Hook that is run after a link has been followed."
1505 "Non-nil means on links TAB will follow the link.
1506 Needs to be set before org.el is loaded.
1507 This really should not be used, it does not make sense, and the
1508 implementation is bad."
1513 "Non-nil means on links RET will follow the link."
1519 "Non-nil means mouse-1 on a link will follow the link.
1520 A longer mouse click will still set point. Does not work on XEmacs.
1521 Needs to be set before org.el is loaded."
1526 "Number of different positions to be recorded in the ring.
1527 Changing this requires a restart of Emacs to work correctly."
1532 "Non-nil means internal links in Org files must exactly match a headline.
1533 When nil, the link search tries to match a phrase with all words
1534 in the search text."
1541 query-to-create)))
1549 "Setup the frame configuration for following links.
1550 When following a link with Emacs, it may often be useful to display
1551 this link in another window or frame. This variable can be used to
1552 set this up for the different types of links.
1553 For VM, use any of
1554 `vm-visit-folder'
1555 `vm-visit-folder-other-window'
1556 `vm-visit-folder-other-frame'
1557 For Gnus, use any of
1558 `gnus'
1559 `gnus-other-frame'
1560 `org-gnus-no-new-news'
1561 For FILE, use any of
1562 `find-file'
1563 `find-file-other-window'
1564 `find-file-other-frame'
1565 For Wanderlust use any of
1566 `wl'
1567 `wl-other-frame'
1568 For the calendar, use the variable `calendar-setup'.
1569 For BBDB, it is currently only possible to display the matches in
1570 another window."
1594 "Non-nil means use indirect buffer to display infile links.
1595 Activating internal links (from one location in a file to another location
1596 in the same file) normally just jumps to the location. When the link is
1598 is displayed in
1599 another window. When this option is set, the other window actually displays
1600 an indirect buffer clone of the current buffer, to avoid any visibility
1601 changes to the current buffer."
1606 "Non-nil means `org-open-file' will open non-existing files.
1607 When nil, an error will be generated.
1608 This variable applies only to external applications because they
1609 might choke on non-existing files. If the link is to a file that
1610 will be opened in Emacs, the variable is ignored."
1615 "Non-nil means a link to a directory really means to index.org.
1616 When nil, following a directory link will run dired or open a finder/explorer
1617 window on that directory."
1622 "Function and arguments to call for following mailto links.
1623 This is a list with the first element being a Lisp function, and the
1624 remaining elements being arguments to the function. In string arguments,
1625 %a will be replaced by the address, and %s will be replaced by the subject
1626 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1635 "Non-nil means ask for confirmation before executing shell links.
1636 Shell links can be dangerous: just think about a link
1638 [[shell:rm -rf ~/*][Google Search]]
1641 but really it would remove your entire home directory.
1642 Therefore we advise against setting this variable to nil.
1643 Just change it to `y-or-n-p' if you want to confirm with a
1651 'safe-local-variable
1655 "A regexp to skip confirmation for shell links."
1661 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1662 Elisp links can be dangerous: just think about a link
1667 but really it would remove your entire home directory.
1668 Therefore we advise against setting this variable to nil.
1669 Just change it to `y-or-n-p' if you want to confirm with a
1677 'safe-local-variable
1681 "A regexp to skip confirmation for Elisp links."
1690 "Default file applications on a UNIX or GNU/Linux system.
1701 "Default file applications on a MacOS X system.
1703 for some files for which the OS does not have a good default.
1711 'mswindows-shell-execute
1716 'mswindows-shell-execute
1719 "Default file applications on a Windows NT system.
1724 '(
1729 )
1730 "External applications for opening `file:path' items in a document.
1731 Org-mode uses system defaults for different file types, but
1732 you can use this variable to set the application for a given file
1733 extension. The entries in this list are cons cells where the car identifies
1734 files and the cdr the corresponding command. Possible values for the
1735 file identifier are
1737 ways, depending on its contents:
1739 - Alphanumeric characters only:
1740 Match links with this file extension.
1742 to open PDFs with evince.
1744 - Regular expression: Match links where the
1745 filename matches the regexp. If you want to
1746 use groups here, use shy groups.
1750 to open *.html and *.xhtml with firefox.
1752 - Regular expression which contains (non-shy) groups:
1754 anything after that, matches the regexp.
1755 In a custom command string, %1, %2, etc. are replaced with
1756 the parts of the link that were matched by the groups.
1757 For backwards compatibility, if a command string is given
1758 that does not use any of the group matches, this case is
1759 handled identically to the second one (i.e. match against
1760 file name only).
1761 In a custom lisp form, you can access the group matches with
1762 (match-string n link).
1765 to open [[file:document.pdf::5]] with evince at page 5.
1767 `directory' Matches a directory
1768 `remote' Matches a remote file, accessible through tramp or efs.
1769 Remote files most likely should be visited through Emacs
1770 because external applications cannot handle such paths.
1771 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1772 so all files Emacs knows how to handle. Using this with
1773 command `emacs' will open most files in Emacs. Beware that this
1774 will also open html files inside Emacs, unless you add
1776 t Default for files not matched by any of the other options.
1777 `system' The system command to open files, like `open' on Windows
1778 and Mac OS X, and mailcap under GNU/Linux. This is the command
1779 that will be selected if you call `C-c C-o' with a double
1782 Possible values for the command are:
1783 `emacs' The file will be visited by the current Emacs process.
1784 `default' Use the default application for this file type, which is the
1785 association for t in the list, most likely in the system-specific
1786 part.
1787 This can be used to overrule an unwanted setting in the
1788 system-specific variable.
1790 This command is specified by the entry whose car is `system'.
1791 Most likely, the system-specific version of this variable
1792 does define this command, but you can overrule/replace it
1793 here.
1794 string A command to be executed by a shell; %s will be replaced
1795 by the path to the file.
1796 sexp A Lisp form which will be evaluated. The file path will
1797 be available in the Lisp variable `file'.
1798 For more examples, see the system specific constants
1799 `org-file-apps-defaults-macosx'
1800 `org-file-apps-defaults-windowsnt'
1801 `org-file-apps-defaults-gnu'."
1811 auto-mode))
1820 "The URL of the DOI server."
1826 "Options concerning refiling entries in Org-mode."
1831 "Directory with org files.
1832 This is just a default location to look for Org files. There is no need
1833 at all to put your files into this directory. It is only used in the
1834 following situations:
1836 1. When a capture template specifies a target file that is not an
1837 absolute path. The path will then be interpreted relative to
1838 `org-directory'
1839 2. When a capture note is filed away in an interactive way (when exiting the
1840 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1841 with `org-directory' as the default path."
1848 "Default target for storing notes.
1849 Used as a fall back file for org-remember.el and org-capture.el, for
1850 templates that do not specify a target file."
1856 file))
1859 "The default interface to be used for `org-goto'.
1860 Allowed values are:
1861 outline The interface shows an outline of the relevant file
1862 and the correct heading is found by moving through
1863 the outline or by searching with incremental search.
1864 outline-path-completion Headlines in the current buffer are offered via
1865 completion. This is the interface also used by
1866 the refile command."
1873 "Maximum target level when running `org-goto' with refile interface."
1878 "Non-nil means store new notes at the beginning of a file or entry.
1879 When nil, new notes will be filed to the end of a file or entry.
1880 This can also be a list with cons cells of regular expressions that
1881 are matched against file names, and values."
1892 "Information to record when a task is refiled.
1894 Possible values are:
1896 nil Don't add anything
1897 time Add a time stamp to the task
1898 note Prompt for a note and add it with template `org-log-note-headings'
1900 This option can also be set with on a per-file-basis with
1902 #+STARTUP: nologrefile
1903 #+STARTUP: logrefile
1904 #+STARTUP: lognoterefile
1906 You can have local logging settings for a subtree by setting the LOGGING
1907 property to one or more of these keywords.
1909 When bulk-refiling from the agenda, the value `note' is forbidden and
1910 will temporarily be changed to `time'."
1921 This is a list of cons cells. Each cell contains:
1922 - a specification of the files to be considered, either a list of files,
1923 or a symbol whose function or variable value will be used to retrieve
1924 a file name or a list of file names. If you use `org-agenda-files' for
1925 that, all agenda files will be scanned for targets. Nil means consider
1926 headings in the current buffer.
1927 - A specification of how to find candidate refile targets. This may be
1928 any of:
1930 This tag has to be present in all target headlines, inheritance will
1931 not be considered.
1933 todo keyword.
1935 headlines that are refiling targets.
1936 - a cons cell (:level . N). Any headline of level N is considered a target.
1937 Note that, when `org-odd-levels-only' is set, level corresponds to
1938 order in hierarchy, not to the number of stars.
1939 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1940 Note that, when `org-odd-levels-only' is set, level corresponds to
1941 order in hierarchy, not to the number of stars.
1943 Each element of this list generates a set of possible targets.
1944 The union of these sets is presented (with completion) to
1945 the user by `org-refile'.
1947 You can set the variable `org-refile-target-verify-function' to a function
1948 to verify each headline found by the simple criteria above.
1950 When this variable is nil, all top-level headlines in the current buffer
1951 are used, equivalent to the value `((nil . (:level . 1))'."
1967 "Function to verify if the headline at point should be a refile target.
1968 The function will be called without arguments, with point at the
1969 beginning of the headline. It should return t and leave point
1970 where it is if the headline is a valid target for refiling.
1972 If the target should not be selected, the function must return nil.
1973 In addition to this, it may move point to a place from where the search
1974 should be continued. For example, the function may decide that the entire
1975 subtree of the current entry should be excluded and move point to the end
1976 of the subtree."
1981 "Non-nil means cache refile targets to speed up the process.
1982 The cache for a particular file will be updated automatically when
1983 the buffer has been killed, or when any of the marker used for flagging
1984 refile targets no longer points at a live buffer.
1985 If you have added new entries to a buffer that might themselves be targets,
1986 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1987 find that easier, `C-u C-u C-u C-c C-w'."
1993 "Non-nil means provide refile targets as paths.
1994 So a level 3 headline will be available as level1/level2/level3.
1996 When the value is `file', also include the file name (without directory)
1997 into the path. In this case, you can also stop the completion after
1998 the file name, to get entries inserted as top level in the file.
2000 When `full-file-path', include the full file path."
2009 "Non-nil means complete the outline path in hierarchical steps.
2010 When Org-mode uses the refile interface to select an outline path
2011 \(see variable `org-refile-use-outline-path'), the completion of
2012 the path can be done is a single go, or if can be done in steps down
2013 the headline hierarchy. Going in steps is probably the best if you
2014 do not use a special completion package like `ido' or `icicles'.
2015 However, when using these packages, going in one step can be very
2016 fast, while still showing the whole path to the entry."
2021 "Non-nil means allow to create new nodes as refile targets.
2023 of an existing node. When the value of this variable is `confirm',
2024 new node creation must be confirmed by the user (recommended)
2025 When nil, the completion must match an existing entry.
2027 Note that, if the new heading is not seen by the criteria
2028 listed in `org-refile-targets', multiple instances of the same
2029 heading would be created by trying again to file under the new
2030 heading."
2038 "Non-nil means also refile active region within a subtree.
2040 By default `org-refile' doesn't allow refiling regions if they
2041 don't contain a set of subtrees, but it might be convenient to
2042 do so sometimes: in that case, the first line of the region is
2043 converted to a headline before refiling."
2049 "Options concerning TODO items in Org-mode."
2054 "Options concerning Progress logging in Org-mode."
2061 "The available interpretation symbols for customizing `org-todo-keywords'.
2065 "List of TODO entry keyword sequences and their interpretation.
2068 Each sequence starts with a symbol, either `sequence' or `type',
2069 indicating if the keywords should be interpreted as a sequence of
2070 action steps, or as different types of TODO items. The first
2071 keywords are states requiring action - these states will select a headline
2072 for inclusion into the global TODO list Org-mode produces. If one of
2075 the last keyword is treated as the only DONE state of the sequence.
2078 additional state where no keyword is present. For details about this
2079 cycling, see the manual.
2081 TODO keywords and interpretation can also be set on a per-file basis with
2082 the special #+SEQ_TODO and #+TYP_TODO lines.
2084 Each keyword can optionally specify a character for fast state selection
2085 \(in combination with the variable `org-use-fast-todo-selection')
2086 and specifiers for state change logging, using the same syntax that
2089 indicates to record a time stamp each time this state is selected.
2091 Each keyword may also specify if a timestamp or a note should be
2092 recorded when entering or leaving the state, by adding additional
2093 characters in the parenthesis after the keyword. This looks like this:
2095 record only the time of the state change. With X and Y being either
2097 Y when leaving the state if and only if the *target* state does not
2098 define X. You may omit any of the fast-selection key or X or /Y,
2099 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2101 For backward compatibility, this variable may also be just a list
2102 of keywords. In this case the interpretation (sequence or type) will be
2103 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2113 ;;Quick and dirty way to see
2114 ;;`org-todo-interpretations'. This takes the
2115 ;;place of item arguments
2116 :convert-widget
2123 org-todo-interpretation-widgets))
2124 widget))
2155 "Controls how TODO keywords are interpreted.
2156 This variable is in principle obsolete and is only used for
2157 backward compatibility, if the interpretation of todo keywords is
2158 not given already in `org-todo-keywords'. See that variable for
2159 more information."
2166 "Non-nil means use the fast todo selection scheme with C-c C-t.
2167 This variable describes if and under what circumstances the cycling
2168 mechanism for TODO keywords will be replaced by a single-key, direct
2169 selection scheme.
2171 When nil, fast selection is never used.
2173 When the symbol `prefix', it will be used when `org-todo' is called
2174 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2175 `C-u t' in an agenda buffer.
2177 When t, fast selection is used by default. In this case, the prefix
2178 argument forces cycling instead.
2180 In all cases, the special interface is only used if access keys have
2181 actually been assigned by the user, i.e. if keywords in the configuration
2182 are followed by a letter in parenthesis, like TODO(t)."
2190 "Non-nil means update todo statistics after insert and toggle.
2191 ALL-HEADLINES means update todo statistics by including headlines
2192 with no TODO keyword as well, counting them as not done.
2193 A list of TODO keywords means the same, but skip keywords that are
2194 not in this list.
2196 When this is set, todo statistics is updated in the parent of the
2197 current entry each time a todo state is changed."
2207 "Non-nil means TODO statistics covers just direct children.
2208 When nil, all entries in the subtree are considered.
2209 This has only an effect if `org-provide-todo-statistics' is set.
2210 To set this to nil for only a single subtree, use a COOKIE_DATA
2216 "Hook which is run after the state of a TODO item was changed.
2217 The new state (a string with a TODO keyword, or nil) is available in the
2218 Lisp variable `org-state'."
2223 "Hook for functions that are allowed to block a state change.
2225 Each function gets as its single argument a property list, see
2226 `org-trigger-hook' for more information about this list.
2228 If any of the functions in this hook returns nil, the state change
2232 "Hook for functions that are triggered by a state change.
2234 Each function gets as its single argument a property list with at least
2235 the following elements:
2237 (:type type-of-change :position pos-at-entry-start
2238 :from old-state :to new-state)
2240 Depending on the type, more properties may be present.
2242 This mechanism is currently implemented for:
2244 TODO state changes
2245 ------------------
2246 :type todo-state-change
2247 :from previous state (keyword as a string), or nil, or a symbol
2248 'todo' or 'done', to indicate the general type of state.
2252 "Non-nil means undone TODO entries will block switching the parent to DONE.
2253 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2254 be blocked if any prior sibling is not yet done.
2255 Finally, if the parent is blocked because of ordered siblings of its own,
2256 the child will also be blocked."
2268 "Non-nil means unchecked boxes will block switching the parent to DONE.
2269 When this is nil, checkboxes have no influence on switching TODO states.
2270 When non-nil, you first need to check off all check boxes before the TODO
2271 entry can be switched to DONE.
2272 This variable needs to be set before org.el is loaded, and you need to
2273 restart Emacs after a change to make the change effective. The only way
2274 to change is while Emacs is running is through the customize interface."
2286 "Non-nil means inserting a TODO heading is treated as state change.
2288 logging will apply if appropriate. When nil, the new TODO item will
2289 be inserted directly, and no logging will take place."
2294 "Non-nil means switching TODO states with S-cursor counts as state change.
2295 This is the default behavior. However, setting this to nil allows a
2296 convenient way to select a TODO state and bypass any logging associated
2297 with that."
2302 "Tag changes that should be triggered by TODO state changes.
2303 This is a list. Each entry is
2305 (state-change (tag . flag) .......)
2307 State-change can be a string with a state, and empty string to indicate the
2308 state that has no TODO keyword, or it can be one of the symbols `todo'
2309 or `done', meaning any not-done or done state, respectively."
2323 "Information to record when a task moves to the DONE state.
2325 Possible values are:
2327 nil Don't add anything, just change the keyword
2328 time Add a time stamp to the task
2329 note Prompt for a note and add it with template `org-log-note-headings'
2331 This option can also be set with on a per-file-basis with
2333 #+STARTUP: nologdone
2334 #+STARTUP: logdone
2335 #+STARTUP: lognotedone
2337 You can have local logging settings for a subtree by setting the LOGGING
2338 property to one or more of these keywords."
2346 ;; Normalize old uses of org-log-done.
2353 "Information to record when the scheduling date of a tasks is modified.
2355 Possible values are:
2357 nil Don't add anything, just change the date
2358 time Add a time stamp to the task
2359 note Prompt for a note and add it with template `org-log-note-headings'
2361 This option can also be set with on a per-file-basis with
2363 #+STARTUP: nologreschedule
2364 #+STARTUP: logreschedule
2365 #+STARTUP: lognotereschedule"
2374 "Information to record when the deadline date of a tasks is modified.
2376 Possible values are:
2378 nil Don't add anything, just change the date
2379 time Add a time stamp to the task
2380 note Prompt for a note and add it with template `org-log-note-headings'
2382 This option can also be set with on a per-file-basis with
2384 #+STARTUP: nologredeadline
2385 #+STARTUP: logredeadline
2386 #+STARTUP: lognoteredeadline
2388 You can have local logging settings for a subtree by setting the LOGGING
2389 property to one or more of these keywords."
2398 "Non-nil means record a note when clocking out of an item.
2399 This can also be configured on a per-file basis by adding one of
2400 the following lines anywhere in the buffer:
2402 #+STARTUP: lognoteclock-out
2403 #+STARTUP: nolognoteclock-out"
2409 "Non-nil means the CLOSED time stamp will contain date and time.
2410 When nil, only the date will be recorded."
2424 "Headings for notes added to entries.
2425 The value is an alist, with the car being a symbol indicating the note
2426 context, and the cdr is the heading to be used. The heading may also be the
2427 empty string.
2428 %t in the heading will be replaced by a time stamp.
2429 %T will be an active time stamp instead the default inactive one
2430 %d will be replaced by a short-format time stamp.
2431 %D will be replaced by an active short-format time stamp.
2432 %s will be replaced by the new TODO state, in double quotes.
2433 %S will be replaced by the old TODO state, in double quotes.
2434 %u will be replaced by the user name.
2435 %U will be replaced by the full user name.
2437 In fact, it is not a good idea to change the `state' entry, because
2438 agenda log mode depends on the format of these entries."
2444 "Heading when changing todo state (todo sequence only)"
2458 "Non-nil means insert state change notes and time stamps into a drawer.
2459 When nil, state changes notes will be inserted after the headline and
2460 any scheduling and clock lines, but not inside a drawer.
2462 The value of this variable should be the name of the drawer to use.
2463 LOGBOOK is proposed as the default drawer for this purpose, you can
2464 also set this to a string to define the drawer of your choice.
2468 If this variable is set, `org-log-state-notes-insert-after-drawers'
2469 will be ignored.
2471 You can set the property LOG_INTO_DRAWER to overrule this setting for
2472 a subtree."
2484 "Return the value of `org-log-into-drawer', but let properties overrule.
2485 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2486 used instead of the default value."
2494 "Non-nil means insert state change notes after any drawers in entry.
2495 Only the drawers that *immediately* follow the headline and the
2496 deadline/scheduled line are skipped.
2497 When nil, insert notes right after the heading and perhaps the line
2498 with deadline/scheduling if present.
2500 This variable will have no effect if `org-log-into-drawer' is
2501 set."
2507 "Non-nil means the latest state note will be directly after heading.
2508 When nil, the state change notes will be ordered according to time."
2514 "The TODO state to which a repeater should return the repeating task.
2515 By default this is the first task in a TODO sequence, or the previous state
2516 in a TODO_TYP set. But you can specify another task here.
2517 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2524 "Non-nil means record moving through the DONE state when triggering repeat.
2525 An auto-repeating task is immediately switched back to TODO when
2528 record a closing note, there will be no record of the task moving
2529 through DONE. This variable forces taking a note anyway.
2531 nil Don't force a record
2532 time Record a time stamp
2533 note Prompt for a note and add it with template `org-log-note-headings'
2535 This option can also be set with on a per-file-basis with
2537 #+STARTUP: nologrepeat
2538 #+STARTUP: logrepeat
2539 #+STARTUP: lognoterepeat
2541 You can have local logging settings for a subtree by setting the LOGGING
2542 property to one or more of these keywords."
2552 "Priorities in Org-mode."
2557 "Non-nil means priority commands are active.
2558 When nil, these commands will be disabled, so that you never accidentally
2559 set a priority."
2564 "The highest priority of TODO items. A character like ?A, ?B etc.
2565 Must have a smaller ASCII number than `org-lowest-priority'."
2570 "The lowest priority of TODO items. A character like ?A, ?B etc.
2571 Must have a larger ASCII number than `org-highest-priority'."
2576 "The default priority of TODO items.
2577 This is the priority an item gets if no explicit priority is given.
2578 When starting to cycle on an empty priority the first step in the cycle
2579 depends on `org-priority-start-cycle-with-default'. The resulting first
2580 step priority must not exceed the range from `org-highest-priority' to
2581 `org-lowest-priority' which means that `org-default-priority' has to be
2582 in this range exclusive or inclusive the range boundaries. Else the
2583 first step refuses to set the default and the second will fall back
2584 to (depending on the command used) the highest or lowest priority."
2589 "Non-nil means start with default priority when starting to cycle.
2590 When this is nil, the first step in the cycle will be (depending on the
2591 command used) one higher or lower than the default priority.
2592 See also `org-default-priority'."
2597 "Function to extract the priority from a string.
2598 The string is normally the headline. If this is nil Org computes the
2599 priority from the priority cookie like [#A] in the headline. It returns
2600 an integer, increasing by 1000 for each priority level.
2601 The user can set a different function here, which should take a string
2602 as an argument and return the numeric priority."
2608 "Options concerning time stamps and deadlines in Org-mode."
2613 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2614 When nil, these labeled time stamps are forces into the second line of an
2615 entry, just after the headline. When scheduling from the global TODO list,
2616 the time stamp will always be forced into the second line."
2621 "Formats for `format-time-string' which are used for time stamps.
2625 "Number of minutes to round time stamps to.
2626 These are two values, the first applies when first creating a time stamp.
2627 The second applies when changing it with the commands `S-up' and `S-down'.
2628 When changing the time stamp, this means that it will change in steps
2629 of N minutes, as given by the second value.
2631 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2632 numbers should be factors of 60, so for example 5, 10, 15.
2634 When this is larger than 1, you can still force an exact time stamp by using
2635 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2636 and by using a prefix arg to `S-up/down' to specify the exact number
2637 of minutes to shift."
2647 ;; Normalize old customizations of this variable.
2651 org-time-stamp-rounding-minutes)))
2654 "Non-nil means overlay custom formats over all time stamps.
2655 The formats are defined through the variable `org-time-stamp-custom-formats'.
2656 To turn this on on a per-file basis, insert anywhere in the file:
2657 #+STARTUP: customtime"
2665 "Custom formats for time stamps. See `format-time-string' for the syntax.
2666 These are overlaid over the default ISO format if the variable
2667 `org-display-custom-times' is set. Time like %H:%M should be at the
2668 end of the second format. The custom formats are also honored by export
2669 commands, if custom time display is turned on at the time of export."
2674 "Get the right format for a time string."
2679 f)))
2682 "The format string used when creating CLOCKSUM lines.
2683 This is also used when org-mode generates a time duration."
2689 org-mode generates a time duration."
2694 "The format string used when creating CLOCKSUM lines, or when
2695 org-mode generates a time duration."
2700 "No. of days before expiration during which a deadline becomes active.
2701 This variable governs the display in sparse trees and in the agenda.
2702 When 0 or negative, it means use this number (the absolute value of it)
2703 even if a deadline has a different individual lead time specified.
2705 Custom commands can set this variable in the options section."
2711 "Non-nil means assume future for incomplete date input from user.
2712 This affects the following situations:
2713 1. The user gives a month but not a year.
2716 2. The user gives a day, but no month.
2719 it will be considered as *this* month.
2721 If you set this variable to the symbol `time', then also the following
2722 will work:
2724 3. If the user gives a time.
2725 If the time is before now, it will be interpreted as tomorrow.
2727 Currently none of this works for ISO week specifications.
2729 When this option is nil, the current day, month and year will always be
2730 used as defaults.
2732 See also `org-agenda-jump-prefer-future'."
2740 "Should the agenda jump command prefer the future for incomplete dates?
2741 The default is to do the same as configured in `org-read-date-prefer-future'.
2742 But you can also set a deviating value here.
2743 This may t or nil, or the symbol `org-read-date-prefer-future'."
2749 org-read-date-prefer-future)
2754 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2756 Depending on the system Emacs is running on, certain dates cannot
2757 be represented with the type used internally to represent time.
2758 Dates between 1970-1-1 and 2038-1-1 can always be represented
2759 correctly. Some systems allow for earlier dates, some for later,
2760 some for both. One way to find out it to insert any date into an
2761 Org buffer, putting the cursor on the year and hitting S-up and
2762 S-down to test the range.
2764 When this variable is set to t, the date/time prompt will not let
2765 you specify dates outside the 1970-2037 range, so it is certain that
2766 these dates will work in whatever version of Emacs you are
2767 running, and also that you can move a file from one Emacs implementation
2768 to another. WHenever Org is forcing the year for you, it will display
2769 a message and beep.
2771 When this variable is nil, Org will check if the date is
2772 representable in the specific Emacs implementation you are using.
2773 If not, it will force a year, usually the current year, and beep
2774 to remind you. Currently this setting is not recommended because
2775 the likelihood that you will open your Org files in an Emacs that
2776 has limited date range is not negligible.
2778 A workaround for this problem is to use diary sexp dates for time
2779 stamps outside of this range."
2785 "Non-nil means display current interpretation of date prompt live.
2786 This display will be in an overlay, in the minibuffer."
2791 "Non-nil means pop up a calendar when prompting for a date.
2792 In the calendar, the date can be selected with mouse-1. However, the
2793 minibuffer will also be active, and you can simply enter the date as well.
2794 When nil, only the minibuffer will be available."
2802 "Hook to be used to set up keys for the date/time interface.
2803 Add key definitions to `minibuffer-local-map', which will be a temporary
2804 copy."
2809 "The hour when your day really ends. Must be an integer.
2810 This has influence for the following applications:
2812 the time given here, the day recognized as TODAY is actually yesterday.
2813 - When a date is read from the user and it is still before the time given
2814 here, the current date and time will be assumed to be yesterday, 23:59.
2815 Also, timestamps inserted in capture templates follow this rule.
2817 IMPORTANT: This is a feature whose implementation is and likely will
2818 remain incomplete. Really, it is only here because past midnight seems to
2819 be the favorite working time of John Wiegley :-)"
2824 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2825 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2827 23:59 of the previous day."
2833 "Non-nil means S-down will increase the time in a time stamp.
2834 When nil, S-up will increase."
2839 "Non-nil means make the calendar window follow timestamp changes.
2840 When a timestamp is modified and the calendar window is visible, it will be
2841 moved to the new date."
2846 "Options concerning tags in Org-mode."
2851 "List of tags allowed in Org-mode files.
2852 When this list is nil, Org-mode will base TAG input on what is already in the
2853 buffer.
2854 The value of this variable is an alist, the car of each entry must be a
2855 keyword as a string, the cdr may be a character that is used to select
2856 that tag through the fast-tag-selection interface.
2857 See the manual for details."
2872 "List of tags that will always appear in all Org-mode files.
2873 This is in addition to any in buffer settings or customizations
2874 of `org-tag-alist'.
2875 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2876 The value of this variable is an alist, the car of each entry must be a
2877 keyword as a string, the cdr may be a character that is used to select
2878 that tag through the fast-tag-selection interface.
2879 See the manual for details.
2880 To disable these tags on a per-file basis, insert anywhere in the file:
2881 #+STARTUP: noptag"
2892 "If non-nil, always offer completion for all tags of all agenda files.
2893 Instead of customizing this variable directly, you might want to
2894 set it locally for capture buffers, because there no list of
2895 tags in that file can be created dynamically (there are none).
2897 (add-hook 'org-capture-mode-hook
2898 (lambda ()
2899 (set (make-local-variable
2900 'org-complete-tags-always-offer-all-agenda-tags)
2901 t)))"
2907 "List of tags that can be inherited by all entries in the file.
2908 The tags will be inherited if the variable `org-use-tag-inheritance'
2909 says they should be.
2913 "Non-nil means use fast tag selection scheme.
2914 This is a special interface to select and deselect tags with single keys.
2915 When nil, fast selection is never used.
2916 When the symbol `auto', fast selection is used if and only if selection
2917 characters for tags have been configured, either through the variable
2918 `org-tag-alist' or through a #+TAGS line in the buffer.
2919 When t, fast selection is always used and selection keys are assigned
2920 automatically if necessary."
2928 "Non-nil means fast tag selection exits after first change.
2929 When nil, you have to press RET to exit it.
2930 During fast tag selection, you can toggle this flag with `C-c'.
2931 This variable can also have the value `expert'. In this case, the window
2932 displaying the tags menu is not even shown, until you press C-c again."
2940 "Non-nil means fast tags selection interface will also offer TODO states.
2944 "The column to which tags should be indented in a headline.
2945 If this number is positive, it specifies the column. If it is negative,
2946 it means that the tags should be flushright to that column. For example,
2947 -80 works well for a normal 80 character screen.
2948 When 0, place tags directly after headline text, with only one space in
2949 between."
2954 "Non-nil keeps tags aligned when modifying headlines.
2955 Some operations (i.e. demoting) change the length of a headline and
2956 therefore shift the tags around. With this option turned on, after
2957 each such operation the tags are again aligned to `org-tags-column'."
2962 "Non-nil means tags in levels apply also for sublevels.
2963 When nil, only the tags directly given in a specific line apply there.
2964 This may also be a list of tags that should be inherited, or a regexp that
2965 matches tags that should be inherited. Additional control is possible
2966 with the variable `org-tags-exclude-from-inheritance' which gives an
2967 explicit list of tags to be excluded from inheritance., even if the value of
2968 `org-use-tag-inheritance' would select it for inheritance.
2970 If this option is t, a match early-on in a tree can lead to a large
2971 number of matches in the subtree when constructing the agenda or creating
2972 a sparse tree. If you only want to see the first match in a tree during
2973 a search, check out the variable `org-tags-match-list-sublevels'."
2982 "List of tags that should never be inherited.
2983 This is a way to exclude a few tags from inheritance. For way to do
2984 the opposite, to actively allow inheritance for selected tags,
2985 see the variable `org-use-tag-inheritance'."
2990 "Check if TAG is one that should be inherited."
3002 "Non-nil means list also sublevels of headlines matching a search.
3003 This variable applies to tags/property searches, and also to stuck
3004 projects because this search is based on a tags match as well.
3006 When set to the symbol `indented', sublevels are indented with
3007 leading dots.
3009 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3010 the sublevels of a headline matching a tag search often also match
3011 the same search. Listing all of them can create very long lists.
3012 Setting this variable to nil causes subtrees of a match to be skipped.
3014 This variable is semi-obsolete and probably should always be true. It
3015 is better to limit inheritance to certain tags using the variables
3016 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3024 "When set, tags are sorted using this function as a comparator."
3040 "Options concerning properties in Org-mode."
3045 "How property key/value pairs should be formatted by `indent-line'.
3046 When `indent-line' hits a property definition, it will format the line
3047 according to this format, mainly to make sure that the values are
3048 lined-up with respect to each other."
3053 "Alist of properties and functions to adjust inserted values.
3054 Elements of this alist must be of the form
3056 ([string] [function])
3058 where [string] must be a property name and [function] must be a
3059 lambda expression: this lambda expression must take one argument,
3060 the value to adjust, and return the new value as a string.
3064 and the clock summary:
3067 (let ((clocksum (org-clock-sum-current-item))
3068 (effort (org-duration-string-to-minutes
3070 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3077 "Non-nil means properties apply also for sublevels.
3079 This setting is chiefly used during property searches. Turning it on can
3080 cause significant overhead when doing a search, which is why it is not
3081 on by default.
3083 When nil, only the properties directly given in the current entry count.
3084 When t, every property is inherited. The value may also be a list of
3085 properties that should have inheritance, or a regular expression matching
3086 properties that should be inherited.
3088 However, note that some special properties use inheritance under special
3089 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3091 for valid values of a property.
3093 Note for programmers:
3094 When querying an entry with `org-entry-get', you can control if inheritance
3095 should be used. By default, `org-entry-get' looks only at the local
3096 properties. You can request inheritance by setting the inherit argument
3097 to t (to force inheritance) or to `selective' (to respect the setting
3098 in this variable)."
3107 "Check if PROPERTY is one that should be inherited."
3118 "The default column format, if no other format has been defined.
3119 This variable can be set on the per-file basis by inserting a line
3121 #+COLUMNS: %25ITEM ....."
3126 "The ellipses to be used when a field in column view is truncated.
3127 When this is the empty string, as many characters as possible are shown,
3128 but then there will be no visual indication that the field has been truncated.
3129 When this is a string of length N, the last N characters of a truncated
3130 field are replaced by this string. If the column is narrower than the
3131 ellipses string, only part of the ellipses string will be shown."
3136 "Function that modifies values for display in column view.
3137 For example, it can be used to cut out a certain part from a time stamp.
3138 The function must take 2 arguments:
3140 column-title The title of the column (*not* the property name)
3141 value The value that should be modified.
3143 The function should return the value that should be displayed,
3144 or nil if the normal value should be used."
3149 "The property that is being used to keep track of effort estimates.
3150 Effort estimates given in this property need to have the format H:MM."
3158 "List of property/value pairs that can be inherited by any entry.
3160 These are fixed values, for the preset properties. The user variable
3161 that can be used to add to this list is `org-global-properties'.
3163 The entries in this list are cons cells where the car is a property
3164 name and cdr is a string with the value. If the value represents
3169 "List of property/value pairs that can be inherited by any entry.
3171 This list will be combined with the constant `org-global-properties-fixed'.
3173 The entries in this list are cons cells where the car is a property
3174 name and cdr is a string with the value.
3176 You can set buffer-local values for the same purpose in the variable
3177 `org-file-properties' this by adding lines like
3179 #+PROPERTY: NAME VALUE"
3186 "List of property/value pairs that can be inherited by any entry.
3187 Valid for the current buffer.
3192 "Options concerning agenda views in Org-mode."
3197 "Variable used by org files to set a category for agenda display.
3198 Such files should use a file variable to set it, for example
3202 or contain a special line
3204 #+CATEGORY: ELisp
3206 If the file does not specify a category, then file's base name
3212 "The files to be used for agenda display.
3216 If an entry is a directory, all files in that directory that are matched by
3217 `org-agenda-file-regexp' will be part of the file list.
3219 If the value of the variable is not a list but a single file name, then
3220 the list of agenda files is actually stored and maintained in that file, one
3221 agenda file per line. In this file paths can be given relative to
3222 `org-directory'. Tilde expansion and environment variable substitution
3223 are also made."
3230 "Regular expression to match files for `org-agenda-files'.
3231 If any element in the list in that variable contains a directory instead
3232 of a normal file, all files in that directory that are matched by this
3233 regular expression will be included."
3238 "List of extra files to be searched by text search commands.
3239 These files will be search in addition to the agenda files by the
3240 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3241 Note that these files will only be searched for text search commands,
3242 not for the other agenda views like todo lists, tag searches or the weekly
3243 agenda. This variable is intended to list notes and possibly archive files
3244 that should also be searched by these two commands.
3245 In fact, if the first element in the list is the symbol `agenda-archives',
3246 than all archive files of all agenda files will be added to the search
3247 scope."
3258 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3259 A nil value means to remove them, after a query, from the list."
3264 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3265 The command `org-calendar-goto-agenda' will be bound to this key. The
3266 default is the character `c' because then `c' can be used to switch back and
3267 forth between agenda and calendar."
3272 "The key to be installed in `calendar-mode-map' for adding diary entries.
3273 This option is irrelevant until `org-agenda-diary-file' has been configured
3274 to point to an Org-mode file. When that is the case, the command
3275 `org-agenda-diary-entry' will be bound to the key given here, by default
3276 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3277 if you want to continue doing this, you need to change this to a different
3278 key."
3283 "File to which to add new entries with the `i' key in agenda and calendar.
3284 When this is the symbol `diary-file', the functionality in the Emacs
3285 calendar will be used to add entries to the `diary-file'. But when this
3286 points to a file, `org-agenda-diary-entry' will be used instead."
3300 org-calendar-insert-diary-entry-key
3304 "Options for embedding LaTeX code into Org-mode."
3312 "Options for creating images from LaTeX fragments.
3313 This is a property list with the following properties:
3315 `default' means use the foreground of the default face.
3317 `default' means use the background of the default face.
3318 :scale a scaling factor for the size of the images, to get more pixels
3319 :html-foreground, :html-background, :html-scale
3320 the same numbers for HTML export.
3321 :matchers a list indicating which matchers should be used to
3322 find LaTeX fragments. Valid members of this list are:
3333 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3334 When nil, just push out a message."
3341 Use this to specify additional executable file say a jar file.
3343 When using MathToWeb as the converter, specify the full-path to
3344 your mathtoweb.jar file."
3352 "Command to convert LaTeX fragments to MathML.
3353 Replace format-specifiers in the command as noted below and use
3354 `shell-command' to convert LaTeX to MathML.
3355 %j: Executable file in fully expanded form as specified by
3356 `org-latex-to-mathml-jar-file'.
3357 %I: Input LaTeX file in fully expanded form
3358 %o: Output MathML file
3359 This command is used by `org-create-math-formula'.
3361 When using MathToWeb as the converter, set this to
3370 "Program to convert LaTeX fragments with.
3372 dvipng Process the LaTeX fragments to dvi file, then convert
3373 dvi files to png files using dvipng.
3374 This will also include processing of non-math environments.
3375 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3376 to convert pdf files to png files"
3384 "Path to store latex preview images. A relative path here creates many
3385 directories relative to the processed org files paths. An absolute path
3386 puts all preview images at the same place."
3392 "Return t if `org-latex-to-mathml-convert-command' is usable."
3395 org-latex-to-mathml-convert-command)
3397 org-latex-to-mathml-convert-command))))
3402 t))))))
3409 \[PACKAGES]
3410 \[DEFAULT-PACKAGES]
3411 % The settings below are copied from fullpage.sty
3424 "The document header used for processing LaTeX fragments.
3425 It is imperative that this header make sure that no page number
3426 appears on the page. The package defined in the variables
3427 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3429 will be appended."
3436 "Set the packages alist and make sure it has 3 elements per entry."
3440 x))
3441 val)))
3445 "Get the packages alist and make sure it has 3 elements per entry."
3449 x))
3452 ;; The following variables are defined here because is it also used
3453 ;; when formatting latex fragments. Originally it was part of the
3454 ;; LaTeX exporter, which is why the name includes "export".
3471 )
3472 "Alist of default packages to be inserted in the header.
3473 Change this only if one of the packages here causes an incompatibility
3474 with another package you are using.
3475 The packages in this list are needed by one part or another of Org-mode
3476 to function properly.
3478 - inputenc, fontenc: for basic font and character selection
3479 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3480 for interpreting the entities in `org-entities'. You can skip some of these
3481 packages if you don't use any of the symbols in it.
3482 - graphicx: for including images
3483 - float, wrapfig: for figure placement
3484 - longtable: for long tables
3485 - hyperref: for cross references
3487 Therefore you should not modify this variable unless you know what you
3488 are doing. The one reason to change it anyway is that you might be loading
3489 some other package that conflicts with one of the default packages.
3491 If SNIPPET-FLAG is t, the package also needs to be included when
3492 compiling LaTeX snippets into images for inclusion into HTML."
3506 "Alist of packages to be inserted in every LaTeX header.
3507 These will be inserted after `org-export-latex-default-packages-alist'.
3509 SNIPPET-FLAG, when t, indicates that this package is also needed when
3510 turning LaTeX snippets into images for inclusion into HTML.
3511 Make sure that you only list packages here which:
3512 - you want in every file
3513 - do not conflict with the default packages in
3514 `org-export-latex-default-packages-alist'
3515 - do not conflict with the setup in `org-format-latex-header'."
3529 "Settings for Org-mode appearance."
3534 "Non-nil means fontify only the stars in each headline.
3535 When nil, the entire headline is fontified.
3536 Changing it requires restart of `font-lock-mode' to become effective
3537 also in regions already fontified."
3542 "Non-nil means hide the first N-1 stars in a headline.
3543 This works by using the face `org-hide' for these stars. This
3544 face is white for a light background, and black for a dark
3545 background. You may have to customize the face `org-hide' to
3546 make this work.
3547 Changing it requires restart of `font-lock-mode' to become effective
3548 also in regions already fontified.
3549 You may also set this on a per-file basis by adding one of the following
3550 lines to the buffer:
3552 #+STARTUP: hidestars
3553 #+STARTUP: showstars"
3558 "List of symbols corresponding to keywords to be hidden the org buffer.
3559 For example, a value '(title) for this list will make the document's title
3560 appear in the buffer without the initial #+TITLE: keyword."
3569 "List of properties (as strings) with a special meaning.
3570 The default use of these custom properties is to let the user
3571 hide them with `org-toggle-custom-properties-visibility'."
3578 "Non-nil means change the face of a headline if it is marked DONE.
3579 Normally, only the TODO/DONE keyword indicates the state of a headline.
3580 When this is non-nil, the headline after the keyword is set to the
3581 `org-headline-done' as an additional indication."
3586 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3587 Changing this variable requires a restart of Emacs to take effect."
3592 "Non-nil means fontify the whole line for headings.
3593 This is useful when setting a background color for the
3594 org-level-* faces."
3599 "Non-nil means fontify what is treated specially by the exporters."
3604 "Non-nil mean font-lock should hide the emphasis marker characters."
3609 "Non-nil means show entities as UTF8 characters.
3616 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3622 "Regular expression for matching emphasis.
3623 After a match, the match groups contain these elements:
3624 0 The match of the full regular expression, including the characters
3625 before and after the proper match
3626 1 The character before the proper match, or empty at beginning of line
3627 2 The proper match, including the leading and trailing markers
3628 3 The leading marker like * or /, indicating the type of highlighting
3629 4 The text between the emphasis markers, not including the markers
3636 "Set variable and compute the emphasis regular expression."
3640 org-emphasis-alist org-emphasis-regexp-components)
3652 ;; make sure special characters appear at the right position in the class
3664 ;; Make the regexp
3672 body1
3684 body1
3692 "Components used to build the regular expression for emphasis.
3693 This is a list with five entries. Terminology: In an emphasis string
3697 specify what is allowed/forbidden in each part:
3699 pre Chars allowed as prematch. Beginning of line will be allowed too.
3700 post Chars allowed as postmatch. End of line will be allowed too.
3701 border The chars *forbidden* as border characters.
3703 non-shy groups here, and don't allow newline here.
3704 newline The maximum number of newlines allowed in an emphasis exp.
3706 Use customize to modify this, or restart Emacs after changing it."
3725 )
3726 "Special syntax for emphasized text.
3727 Text starting and ending with a special character will be emphasized, for
3728 example *bold*, _underlined_ and /italic/. This variable sets the marker
3729 characters, the face to be used by font-lock for highlighting in Org-mode
3730 Emacs buffers, and the HTML tags to be used for this.
3731 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3732 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3733 Use customize to modify this, or restart Emacs after changing it."
3748 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3751 ;;; Miscellaneous options
3754 "Completion in Org-mode."
3759 "Non-nil means use ido completion wherever possible.
3760 Note that `ido-mode' must be active for this variable to be relevant.
3761 If you decide to turn this variable on, you might well want to turn off
3762 `org-outline-path-complete-in-steps'.
3763 See also `org-completion-use-iswitchb'."
3768 "Non-nil means use iswitchb completion wherever possible.
3769 Note that `iswitchb-mode' must be active for this variable to be relevant.
3770 If you decide to turn this variable on, you might well want to turn off
3771 `org-outline-path-complete-in-steps'.
3772 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3778 Normal means, no org-mode-specific context."
3782 ;;; Functions and variables from their packages
3783 ;; Declared here to avoid compiler warnings
3785 ;; XEmacs only
3791 ;; Emacs only
3794 ;; Various packages
3813 org-agenda-format-item "org-agenda"
3844 ;;; Autoload and prepare some org modules
3846 ;; Some table stuff that needs to be defined here, because it is used
3847 ;; by the functions setting up org-mode or checking for table context.
3860 "Detect the first line outside a table when searching from within it.
3863 ;; Autoload the functions in org-table.el that are needed by functions here.
3869 ;;;###autoload
3871 "Unconditionally turn on `orgtbl-mode'."
3876 "Return t if the cursor is inside an org-type table.
3877 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3882 org-table-line-regexp)))
3883 nil))
3887 "Return t if and only if we are at a table.el table."
3893 "If there is a table.el table nearby, recognize it and move into it."
3899 nil
3909 t
3914 t)
3915 nil)
3916 nil))
3919 "Return t if the cursor is inside a hline in a table."
3924 nil))
3929 "Apply FUNCTION to the start of all tables in the buffer."
3939 ;; Exclude tables in src/example/verbatim/clocktable blocks
3947 ;; Declare and autoload functions from org-exp.el & Co
3953 ;; Declare and autoload functions from org-agenda.el
3971 "Return non-nil if clock is currently running.
3972 The return value is actually the clock marker."
3977 org-clock-update-time-maybe
3978 org-clocktable-shift)))
3981 "Check if the current buffer contains the running clock.
3982 If yes, offer to stop it and to save the buffer with the changes."
3991 "Check if this line starts a clock table, if yes, shift the time block."
3995 ;;;###autoload
3997 "Set up hooks for clock persistence."
4002 ;; Define the variable already here, to make sure we have it.
4004 "Non-nil if Org-Indent mode is enabled.
4007 ;; Autoload archiving code
4008 ;; The stuff that is needed for cycling and tags has to be defined here.
4011 "Options concerning archiving in Org-mode."
4016 "The location where subtrees should be archived.
4018 The value of this variable is a string, consisting of two parts,
4019 separated by a double-colon. The first part is a filename and
4020 the second part is a headline.
4022 When the filename is omitted, archiving happens in the same file.
4023 %s in the filename will be replaced by the current file
4024 name (without the directory part). Archiving to a different file
4025 is useful to keep archived entries from contributing to the
4026 Org-mode Agenda.
4028 The archived entries will be filed as subtrees of the specified
4029 headline. When the headline is omitted, the subtrees are simply
4030 filed away at the end of the file, as top-level entries. Also in
4031 the heading you can use %s to represent the file name, this can be
4032 useful when using the same archive for a number of different files.
4034 Here are a few examples:
4036 If the current file is Projects.org, archive in file
4037 Projects.org_archive, as top-level trees. This is the default.
4040 Archive in the current file, under the top-level headline
4044 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4047 Archive in file ~/org/archive.org (absolute path), under headlines
4052 items to the datetree. Items are placed in either the CLOSED
4053 date of the item, or the current date if there is no CLOSED date.
4054 The heading will be a subentry to the current date. There doesn't
4055 need to be a heading, but there always needs to be a slash after
4056 datetree. For example, to store archived items directly in the
4060 Archive in file ./basement (relative path), as level 3 trees
4063 You may set this option on a per-file basis by adding to the buffer a
4064 line like
4066 #+ARCHIVE: basement::** Finished Tasks
4068 You may also define it locally for a subtree by setting an ARCHIVE property
4069 in the entry. If such a property is found in an entry, or anywhere up
4070 the hierarchy, it will be used."
4075 "The tag that marks a subtree as archived.
4076 An archived subtree does not open during visibility cycling, and does
4077 not contribute to the agenda listings.
4078 After changing this, font-lock must be restarted in the relevant buffers to
4079 get the proper fontification."
4085 "Non-nil means the agenda will skip any items located in archived trees.
4086 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4087 variable is no longer recommended, you should leave it at the value t.
4088 Instead, use the key `v' to cycle the archives-mode in the agenda."
4094 "Non-nil means ignore archived trees when creating column view."
4100 "Non-nil means `org-cycle' will open archived trees.
4101 An archived tree is a tree marked with the tag ARCHIVE.
4102 When nil, archived trees will stay folded. You can still open them with
4103 normal outline commands like `show-all', but not with the cycling commands."
4109 "Non-nil means sparse tree construction shows matches in archived trees.
4110 When nil, matches in these trees are highlighted, but the trees are kept in
4111 collapsed state."
4117 "The default date type when building a sparse tree.
4118 When this is nil, a date is a scheduled or a deadline timestamp.
4119 Otherwise, these types are allowed:
4121 all: all timestamps
4122 active: only active timestamps (<...>)
4123 inactive: only inactive timestamps (<...)
4124 scheduled: only scheduled timestamps
4125 deadline: only deadline timestamps"
4136 "Re-hide all archived subtrees after a visibility state change."
4147 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4150 "Cycle subtree even if it is archived."
4157 "Re-hide all archived subtrees after a visibility state change."
4174 flag)))
4182 ;; Autoload Column View Code
4190 org-columns-get-format-and-top-level
4191 org-columns-compute
4192 org-columns-remove-overlays))
4194 ;; Autoload ID code
4202 org-id-copy
4203 org-id-get-with-outline-path-completion
4204 org-id-get-with-outline-drilling))
4206 ;;; Variables for pre-computed regular expressions, all buffer local
4224 "Matches a headline and puts everything into groups:
4225 group 1: the stars
4226 group 2: The todo keyword, maybe
4227 group 3: Priority cookie
4228 group 4: True headline
4232 "Printf format to make regexp to match an exact headline.
4233 This regexp will match the headline of any node which has the
4234 exact headline text that is put into the format, but may have any
4238 "Matches a headline and puts TODO state into group 2 if present.
4284 "Regular expression to match a plain time or time range.
4285 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4286 groups carry important information:
4287 0 the full match
4288 1 the first time, range or not
4296 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4297 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4298 groups carry important information:
4299 0 the full match
4300 7 hours of duration
4309 "Regular expression to match a timestamp time or time range.
4310 After a match, the following groups carry important information:
4311 0 the full match
4312 1 date plus weekday, for back referencing to make sure both times are on the same day
4313 2 the first time, range or not
4368 "Variable associated with STARTUP options for org-mode.
4369 Each element is a list of three items: the startup options (as written
4370 in the #+STARTUP line), the corresponding variable, and the value to set
4371 this variable to if the option is found. An optional forth element PUSH
4375 "Update PROPS with KEY and VAL."
4389 "Printf format for a regexp matching an headline with some keyword.
4390 This regexp will match the headline of any node which has the
4391 exact keyword that is put into the format. The keyword isn't in
4395 "Printf format for a regexp matching an headline, possibly with some keyword.
4396 This regexp can match any headline with the specified keyword, or
4397 without a keyword. The keyword isn't in any group by default,
4401 "Precompute regular expressions for current buffer."
4421 kwds kws0 kwsa key log value cat arch tags const links hw dws
4422 tail sep kws1 prio props ftags drawers beamer-p
4444 ;; general TODO-like setup
4456 links)))
4463 props))))
4468 ftags
4478 l var val)
4508 ;; search for property blocks
4517 props)))))))
4534 ;; Process the TODO keywords
4536 ;; Use the global values as if they had been given locally.
4548 kws)))
4551 kwsa nil
4554 ;; 1 2
4562 kw)
4564 kws0)
4581 ;; Process the constants
4589 ;; Process the tags.
4600 tgs))
4608 ;; Compute the regular expressions and other local variables.
4609 ;; Using `org-outline-regexp-bol' would complicate them much,
4610 ;; because of the fixed white space at the end of that string.
4618 org-drawer-regexp
4622 org-not-done-keywords
4624 org-todo-regexp
4628 org-not-done-regexp
4632 org-not-done-heading-regexp
4634 org-todo-line-regexp
4636 org-complex-heading-regexp
4643 org-complex-heading-regexp-format
4648 ;; Stats cookies can be stuck to body.
4655 org-todo-line-tags-regexp
4662 org-deadline-time-regexp
4664 org-deadline-line-regexp
4666 org-scheduled-regexp
4668 org-scheduled-time-regexp
4670 org-closed-time-regexp
4672 org-keyword-time-regexp
4678 org-keyword-time-not-clock-regexp
4684 org-maybe-keyword-time-regexp
4690 org-all-time-keywords
4693 org-clock-string org-closed-string))
4694 )
4699 "Return the contents of FILE, as a string."
4713 "Extract the log state setting from a TODO keyword string.
4727 "Remove a pair of parenthesis at the end of each string in LIST."
4731 x))
4732 list))
4735 "Assign fast keys to a keyword-key alist.
4736 Respect keys that are already there."
4754 ;;; Some variables used in various places
4761 "Function to be called when `C-c C-c' is used.
4765 ;; FIXME: Occasionally check by commenting these, to make sure
4766 ;; no other functions uses these, forgetting to let-bind them.
4771 ;; Defined somewhere in this file, but used before definition.
4777 ;;;; Define the Org-mode
4779 ;; We use a before-change function to check if a table might need
4780 ;; an update.
4782 "Indicates that a table might need an update.
4783 This variable is set by `org-before-change-function'.
4786 "Every change indicates that a table might need an update."
4801 (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"))
4804 ;; Other stuff we need.
4812 ;; (require 'org-compat) moved higher up in the file before it is first used
4819 ;; babel
4828 ;;;###autoload
4830 "Outline-based notes management and organizer, alias
4833 Org-mode develops organizational tasks around a NOTES file which
4834 contains information about projects as plain text. Org-mode is
4835 implemented on top of outline-mode, which is ideal to keep the content
4836 of large files well structured. It supports ToDo items, deadlines and
4837 time stamps, which magically appear in the diary listing of the Emacs
4838 calendar. Tables are easily created with a built-in table editor.
4839 Plain text URL-like links connect to websites, emails (VM), Usenet
4840 messages (Gnus), BBDB entries, and any files related to the project.
4841 For printing and sharing of notes, an Org-mode file (or a part of it)
4842 can be exported as a structured ASCII or HTML file.
4844 The following commands are available:
4848 ;; Get rid of Outline menus, they are not needed
4849 ;; Need to do this here because define-derived-mode sets up
4850 ;; the keymap so late. Still, it is a waste to call this each time
4851 ;; we switch another buffer into org-mode.
4854 ;; Assume this is Greg's port, it uses easymenu
4880 org-display-table 4
4883 org-ellipsis)))
4888 ;; tag faces set outside customize.... force initialization.
4890 ;; Calc embedded
4896 ;; Activate before-change-function
4900 ;; Check for running clock before killing a buffer
4902 ;; Indentation.
4905 ;; Initialize radio targets.
4907 ;; Filling and auto-filling.
4909 ;; Comments.
4911 ;; Beginning/end of defun
4914 ;; Next error for sparse trees
4916 ;; Make sure dependence stuff works reliably, even for users who set it
4917 ;; too late :-(
4929 ;; Align options lines
4931 'align-mode-rules-list
4936 ;; Imenu
4940 ;; Make isearch reveal context
4943 ;; Emacs 21 and XEmacs make use of the hook
4945 ;; Emacs 22 deals with this through a special variable
4949 ;; Turn on org-beamer-mode?
4952 ;; Setup the pcomplete hooks
4965 ;; If empty file that did not turn on org-mode automatically, make it to.
4982 ;; Try to set org-hide correctly
4994 "unspecified-bg"
5005 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5015 "Return today date, considering `org-extend-today-until'."
5020 ;;;; Font-Lock stuff, including the activators
5051 "Regular expression used to analyze links.
5052 Here is what the match groups contain after a match:
5053 1: http:
5054 2: http
5055 3: path
5056 4: [desc]
5064 "Number of stacked braces for sub/superscript matching.
5065 This has to be set before loading org.el to be effective."
5070 "Create a regular expression which will match a balanced sexp.
5071 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5072 as single character strings.
5073 The regexp returned will match the entire expression including the
5074 delimiters. It will also define a single group which contains the
5075 match except for the outermost delimiters. The maximum depth of
5076 stacked delimiters is N. Escaping delimiters is not possible."
5105 "Update the link regular expressions.
5106 This should be called after the variable `org-link-types' has changed."
5110 org-link-re-with-space
5116 org-link-re-with-space2
5122 org-link-re-with-space3
5127 org-angle-link-re
5133 org-plain-link-re
5137 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5138 org-bracket-link-regexp
5140 org-bracket-link-analytic-regexp
5148 org-bracket-link-analytic-regexp++
5156 org-any-link-re
5165 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5168 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5169 "Regular expression matching time strings for analysis.
5170 This one does not require the space after the date, so it can be used
5172 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5188 "Regular expression matching a time stamp or time stamp range.
5194 "Run through the buffer and add overlays to emphasized strings."
5203 'face
5216 rtn))
5219 "Insert or change an emphasis, i.e. a font like bold or italic.
5220 If there is an active region, change that region to a new emphasis.
5221 If there is no region, just insert the marker characters and position
5222 the cursor between them.
5223 CHAR should be either the marker character, or the first character of the
5224 HTML tag associated with that emphasis. If CHAR is a space, the means
5225 to remove the emphasis of the selected region.
5226 If char is not given (for example in an interactive call) it
5227 will be prompted for."
5278 "Run through the buffer and add overlays to links."
5286 nil
5292 t))))
5300 t)))
5303 "When non-nil, fontify code in code blocks."
5310 "When non-nil, allow promoting a top level subtree.
5311 The leading star of the top level headline will be replaced
5312 by a #."
5323 "Fontify #+ lines and blocks, in the correct ways."
5326 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5327 limit t)
5335 end end1 quoting block-type ovl)
5338 ;; a single line of backend-specific content
5346 ; for backend-specific code
5347 t)
5349 ;; Truly a block
5362 beg end
5370 ;; remove old background overlays
5375 ;; add a background overlay
5390 t))
5410 t)
5416 ;; just any other in-buffer setting, but not indented
5420 t)
5424 "Run through the buffer and add overlays to links."
5432 t)))
5435 "Run through the buffer and add overlays to footnotes."
5442 'keymap org-mouse-map
5443 'help-echo
5445 "Footnote definition"
5447 'font-lock-fontified t
5448 'font-lock-multiline t
5452 "Run through the buffer and add overlays to bracketed links."
5456 ;; FIXME: above we should remove the escapes.
5457 ;; but that requires another match, protecting match data,
5458 ;; a lot of overhead for font-lock.
5465 ;; We need to remove the invisible property here. Table narrowing
5466 ;; may have made some of this invisible.
5484 t)))
5487 "Run through the buffer and add overlays to dates."
5499 t)))
5508 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5512 "Run through the buffer and add overlays to target matches."
5520 'keymap org-mouse-map
5524 t)))))
5527 "Find all radio targets in this file and update the regular expression."
5542 t)))
5549 ;; This should be with the exporter code, but we also use if for font-locking
5559 "Compute regular expression for stuff treated specially by exporters."
5566 org-latex-regexps)))
5593 org-entities)))
5597 org-latex-entities)
5598 nil))
5600 ))
5601 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5604 org-export-html-special-string-regexps)))
5609 ))))
5611 'org-latex-and-specials-regexp
5616 "Run through the buffer and add overlays to links."
5620 limit t))
5634 rtn)))
5637 "Restart `font-lock-mode', to force refontification."
5643 "Return a list of all targets in this file.
5644 With optional argument RADIO, only find radio targets."
5646 rtn)
5651 rtn)))
5654 "Make regular expression matching all strings in TARGETS.
5655 The regular expression finds the targets also if there is a line break
5656 between words."
5665 x)
5666 targets
5678 t)))
5681 "Compute the outline level of the heading at point.
5682 This function assumes that the cursor is at the beginning of a line matched
5683 by `outline-regexp'. Otherwise it returns garbage.
5684 If this is called at a normal headline, the level is the number of stars.
5685 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5692 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5699 "Functions that can manipulate `org-font-lock-extra-keywords'.
5700 This is called after `org-font-lock-extra-keywords' is defined, but before
5701 it is installed to be used by font lock. This can be useful if something
5705 "Run `org-font-lock-hook' within LIMIT."
5709 "Set font lock defaults for the current buffer."
5714 ;; Call the hook
5716 ;; Headlines
5723 ;; Table lines
5726 ;; Table internals
5731 ;; Drawers
5734 ;; Properties
5738 ;; Links
5748 ;; TODO keyword
5750 org-todo-regexp)
5752 ;; DONE
5760 nil)
5761 ;; Priorities
5763 ;; Tags
5765 ;; Special keywords
5770 ;; Emphasis
5775 ;; Checkboxes
5776 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5781 ;; Description list items
5784 ;; ARCHIVEd headings
5786 org-outline-regexp-bol
5789 ;; Specials
5793 ;; Code
5795 ;; COMMENT
5801 ;; Blocks and meta lines
5803 )))
5806 ;; Now set the full font-lock-keywords
5813 "Toggle the composition display of entities as UTF8 characters."
5829 "Display or hide properties in `org-custom-properties'."
5846 org-custom-properties)))))))
5849 "Find an entity to fontify."
5855 limit t)
5870 nil))))
5873 "Fontify string S like in Org-mode."
5885 "Get the right face for match N in font-lock matching of headlines."
5898 "Get the right face for a TODO keyword KWD.
5899 If KWD is a number, get the corresponding match group."
5907 "Create a face list that inherits INHERIT, but sets the foreground color.
5908 When FACE-OR-COLOR is not a string, just return it."
5912 face-or-color)
5913 face-or-color))
5916 "Add the special tag faces."
5925 "Add the special priority faces."
5933 org-priority-faces)))
5938 "Get the right face for a TODO keyword KWD.
5939 If KWD is a number, get the corresponding match group."
5946 "Remove fontification and activation overlays from links."
5951 deactivate-mark buffer-file-name buffer-file-truename)
5955 invisible t intangible t
5956 org-no-flyspell t org-emphasis t))
5966 "Remove specific display properties that have been added by font lock.
5967 The will remove the raise properties that are used to show superscripts
5968 and subscripts."
5978 "Add raise properties to sub/superscripts."
5982 org-match-substring-regexp
5983 org-match-substring-with-braces-regexp)
5984 limit t)
5994 ;; FIXME: Should we go back one character here, for a_b^c
5995 ;; (goto-char (1- pos)) ;????????????????????
5997 t
5999 'display
6015 t)))))
6017 ;;;; Visibility cycling, including org-goto and indirect buffer
6019 ;;; Cycling
6028 ;;;###autoload
6030 "TAB-action and visibility cycling for Org-mode.
6032 This is the command invoked in Org-mode by the TAB key. Its main purpose
6033 is outline visibility cycling, but it also invokes other actions
6034 in special contexts.
6036 - When this function is called with a prefix argument, rotate the entire
6037 buffer through 3 states (global cycling)
6038 1. OVERVIEW: Show only top-level headlines.
6039 2. CONTENTS: Show all headlines of all levels, but no body text.
6040 3. SHOW ALL: Show everything.
6041 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6042 determined by the variable `org-startup-folded', and by any VISIBILITY
6043 properties in the buffer.
6044 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6045 including any drawers.
6047 - When inside a table, re-align the table and move to the next field.
6049 - When point is at the beginning of a headline, rotate the subtree started
6050 by this line through 3 different states (local cycling)
6051 1. FOLDED: Only the main headline is shown.
6052 2. CHILDREN: The main headline and the direct children are shown.
6053 From this state, you can move to one of the children
6054 and zoom in further.
6055 3. SUBTREE: Show the entire subtree, including body text.
6056 If there is no subtree, switch directly from CHILDREN to FOLDED.
6058 - When point is at the beginning of an empty headline and the variable
6059 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6060 of the headline by demoting and promoting it to likely levels. This
6061 speeds up creation document structure by pressing TAB once or several
6062 times right after creating a new headline.
6064 - When there is a numeric prefix, go up to a heading with level ARG, do
6065 a `show-subtree' and return to the previous cursor position. If ARG
6066 is negative, go up that many levels.
6068 - When point is not at the beginning of a headline, execute the global
6069 binding for TAB, which is re-indenting the line. See the option
6070 `org-cycle-emulate-tab' for details.
6072 - Special case: if point is at the beginning of the buffer and there is
6073 no headline in line 1, this function will act as if called with prefix arg
6074 (C-u TAB, same as S-TAB) also when called without prefix arg.
6075 But only if also the variable `org-cycle-global-at-bob' is t."
6085 org-inlinetask-min-level
6090 limit-level)))
6093 outline-regexp
6101 org-cycle-hook))
6105 ;; special case: use global cycling
6119 ;; Table: enter it or move to the next field.
6130 ;; Global cycling: delegate to `org-cycle-internal-global'.
6133 ;; Drawers: delegate to `org-flag-drawer'.
6141 ;; Show-subtree, ARG levels up from here.
6149 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6157 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6164 ;; From there: TAB emulation and template completion.
6186 t
6195 "Do the global cycling action."
6196 ;; Hack to avoid display of messages for .org attachments in Gnus
6201 ;; We just created the overview - now do table of contents
6202 ;; This can be slow in very large buffers, so indicate action
6212 ;; We just showed the table of contents - now show everything
6220 ;; Default action: go to overview
6228 "Do the local cycling action."
6230 ;; First, determine end of headline (EOH), end of subtree or item
6231 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6255 ;; Determine end invisible part of buffer (EOL)
6257 ;; XEmacs doesn't have `next-single-char-property-change'
6267 ;; Find out what to do next and set `this-command'
6270 ;; Nothing is hidden behind this heading
6282 org-cycle-skip-children-state-if-no-children))))
6283 ;; Entire subtree is hidden in one line: children view
6289 ;; FIXME: This slows down the func way too much.
6290 ;; How keep drawers hidden in subtree anyway?
6291 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6292 ;; (org-cycle-hide-drawers 'subtree))
6294 ;; Fold every list in subtree to top-level items.
6316 ;; We just showed the children, or no children are there,
6317 ;; now show everything.
6324 ;; Default action: hide the subtree.
6331 ;;;###autoload
6333 "Cycle the global visibility. For details see `org-cycle'.
6335 With a numeric prefix, show all headlines up to that level."
6351 "Set the visibility required by startup options and properties."
6366 "Switch subtree visibilities according to :VISIBILITY: property."
6373 nil t)
6397 ;; This function uses outline-regexp instead of the more fundamental
6398 ;; org-outline-regexp so that org-cycle-global works outside of Org
6399 ;; buffers, where outline-regexp is needed.
6401 "Switch to overview mode, showing only top-level headlines.
6402 Really, this shows all headlines with level equal or greater than the level
6403 of the first headline in the buffer. This is important, because if the
6404 first headline is not level one, then (hide-sublevels 1) gives confusing
6405 results."
6416 "Show all headlines in the buffer, like a table of contents.
6417 With numerical argument N, show content up to level N."
6420 ;; Visit all headings and show their offspring
6427 t)
6436 "Adjust the window after a change in outline visibility.
6437 This function is the default value of the hook `org-cycle-hook'."
6447 "Remove outline overlays that do not contain non-white stuff."
6457 "Fix visibility issues after moving a subtree."
6458 ;; First, find a reasonable region to look at:
6459 ;; Start two siblings above, end three below
6477 ;; Properly fold already folded siblings
6488 "Show empty lines above all visible headlines.
6489 The region to be covered depends on STATE when called through
6490 `org-cycle-hook'. Lisp program can use t for STATE to get the
6491 entire buffer covered. Note that an empty line is only shown if there
6492 are at least `org-cycle-separator-lines' empty lines before the headline."
6502 beg end b e)
6526 ;; Never hide empty lines at the end of the file.
6536 "Move to the parent and re-show empty lines before visible headlines."
6542 "Return `org-agenda-files' list, plus all open org-mode files.
6543 This is useful for operations that need to scan all of a user's
6544 open and agenda-wise Org files."
6552 files))
6555 "Return the beginning position of the current entry."
6559 "Return the end position of the current entry."
6563 "Re-hide all drawers after a visibility state change."
6578 "When FLAG is non-nil, hide the drawer we are within.
6579 Otherwise make it visible."
6591 "Is the end of the current subtree visible?"
6596 "Move cursor to the first headline and recenter the headline.
6597 Optional argument N means put the headline into the Nth line of the window."
6603 ;;; Saving and restoring visibility
6606 "Return a list of the locations of all outline overlays.
6607 These are overlays with the `invisible' property value `outline'.
6608 The return value is a list of cons cells, with start and stop
6609 positions for each overlay.
6610 If USE-MARKERS is set, return the positions as markers."
6628 "Create visibility overlays for all positions in DATA.
6629 DATA should have been made by `org-outline-overlay-data'."
6637 data)))))
6639 ;;; Folding of blocks
6646 "Call FUNCTION at the head of all source blocks in the current buffer.
6647 Optional arguments START and END can be used to limit the range."
6659 "Toggle the visibility of all blocks in the current buffer."
6663 "Fold all blocks in the current buffer."
6669 "Unfold all blocks in the current buffer."
6675 "Toggle visibility of block at point."
6686 "Toggle the visibility of the current block."
6693 ov)
6709 ;; make the block accessible to isearch
6711 ov 'isearch-open-invisible
6722 ;; org-tab-after-check-for-cycling-hook
6724 ;; Remove overlays when changing major mode
6729 ;;; Org-goto
6735 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6751 nil)
6752 (org-defkey map "q" 'org-goto-quit)
6753 (org-defkey map "n" 'outline-next-visible-heading)
6754 (org-defkey map "p" 'outline-previous-visible-heading)
6755 (org-defkey map "f" 'outline-forward-same-level)
6756 (org-defkey map "b" 'outline-backward-same-level)
6757 (org-defkey map "u" 'outline-up-heading))
6758 (org-defkey map "/" 'org-occur)
6759 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6760 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6761 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6762 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6763 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6764 map))
6766 (defconst org-goto-help
6767 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6768 RET=jump to location [Q]uit and return to previous location
6769 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6771 (defvar org-goto-start-pos) ; dynamically scoped parameter
6773 ;; FIXME: Docstring does not mention both interfaces
6774 (defun org-goto (&optional alternative-interface)
6775 "Look up a different location in the current file, keeping current visibility.
6777 When you want look-up or go to a different location in a
6778 document, the fastest way is often to fold the entire buffer and
6779 then dive into the tree. This method has the disadvantage, that
6780 the previous location will be folded, which may not be what you
6781 want.
6783 This command works around this by showing a copy of the current
6784 buffer in an indirect buffer, in overview mode. You can dive
6785 into the tree in that copy, use org-occur and incremental search
6786 to find a location. When pressing RET or `Q', the command
6787 returns to the original buffer in which the visibility is still
6788 unchanged. After RET it will also jump to the location selected
6789 in the indirect buffer and expose the headline hierarchy above.
6791 With a prefix argument, use the alternative interface: e.g. if
6792 `org-goto-interface' is 'outline use 'outline-path-completion."
6793 (interactive "P")
6794 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6795 (org-refile-use-outline-path t)
6796 (org-refile-target-verify-function nil)
6797 (interface
6798 (if (not alternative-interface)
6799 org-goto-interface
6800 (if (eq org-goto-interface 'outline)
6801 'outline-path-completion
6802 'outline)))
6803 (org-goto-start-pos (point))
6804 (selected-point
6805 (if (eq interface 'outline)
6806 (car (org-get-location (current-buffer) org-goto-help))
6807 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6808 (org-refile-check-position pa)
6809 (nth 3 pa)))))
6810 (if selected-point
6811 (progn
6812 (org-mark-ring-push org-goto-start-pos)
6813 (goto-char selected-point)
6814 (if (or (outline-invisible-p) (org-invisible-p2))
6815 (org-show-context 'org-goto)))
6816 (message "Quit"))))
6818 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6819 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6820 (defvar org-goto-local-auto-isearch-map) ; defined below
6822 (defun org-get-location (buf help)
6823 "Let the user select a location in the Org-mode buffer BUF.
6824 This function uses a recursive edit. It returns the selected position
6825 or nil."
6826 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6827 (isearch-hide-immediately nil)
6828 (isearch-search-fun-function
6829 (lambda () 'org-goto-local-search-headings))
6830 (org-goto-selected-point org-goto-exit-command)
6831 (pop-up-frames nil)
6832 (special-display-buffer-names nil)
6833 (special-display-regexps nil)
6834 (special-display-function nil))
6835 (save-excursion
6836 (save-window-excursion
6837 (delete-other-windows)
6838 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6839 (org-pop-to-buffer-same-window
6840 (condition-case nil
6841 (make-indirect-buffer (current-buffer) "*org-goto*")
6842 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6843 (with-output-to-temp-buffer "*Help*"
6844 (princ help))
6845 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6846 (setq buffer-read-only nil)
6847 (let ((org-startup-truncated t)
6848 (org-startup-folded nil)
6849 (org-startup-align-all-tables nil))
6850 (org-mode)
6851 (org-overview))
6852 (setq buffer-read-only t)
6853 (if (and (boundp 'org-goto-start-pos)
6854 (integer-or-marker-p org-goto-start-pos))
6855 (let ((org-show-hierarchy-above t)
6856 (org-show-siblings t)
6857 (org-show-following-heading t))
6858 (goto-char org-goto-start-pos)
6859 (and (outline-invisible-p) (org-show-context)))
6860 (goto-char (point-min)))
6861 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6862 (message "Select location and press RET")
6863 (use-local-map org-goto-map)
6864 (recursive-edit)
6865 ))
6866 (kill-buffer "*org-goto*")
6867 (cons org-goto-selected-point org-goto-exit-command)))
6869 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6870 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6871 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6872 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6874 (defun org-goto-local-search-headings (string bound noerror)
6875 "Search and make sure that any matches are in headlines."
6876 (catch 'return
6877 (while (if isearch-forward
6878 (search-forward string bound noerror)
6879 (search-backward string bound noerror))
6880 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6881 (and (member :headline context)
6882 (not (member :tags context))))
6883 (throw 'return (point))))))
6885 (defun org-goto-local-auto-isearch ()
6886 "Start isearch."
6887 (interactive)
6888 (goto-char (point-min))
6889 (let ((keys (this-command-keys)))
6890 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6891 (isearch-mode t)
6892 (isearch-process-search-char (string-to-char keys)))))
6894 (defun org-goto-ret (&optional arg)
6895 "Finish `org-goto' by going to the new location."
6896 (interactive "P")
6897 (setq org-goto-selected-point (point)
6898 org-goto-exit-command 'return)
6899 (throw 'exit nil))
6901 (defun org-goto-left ()
6902 "Finish `org-goto' by going to the new location."
6903 (interactive)
6904 (if (org-at-heading-p)
6905 (progn
6906 (beginning-of-line 1)
6907 (setq org-goto-selected-point (point)
6908 org-goto-exit-command 'left)
6909 (throw 'exit nil))
6910 (error "Not on a heading")))
6912 (defun org-goto-right ()
6913 "Finish `org-goto' by going to the new location."
6914 (interactive)
6915 (if (org-at-heading-p)
6916 (progn
6917 (setq org-goto-selected-point (point)
6918 org-goto-exit-command 'right)
6919 (throw 'exit nil))
6920 (error "Not on a heading")))
6922 (defun org-goto-quit ()
6923 "Finish `org-goto' without cursor motion."
6924 (interactive)
6925 (setq org-goto-selected-point nil)
6926 (setq org-goto-exit-command 'quit)
6927 (throw 'exit nil))
6929 ;;; Indirect buffer display of subtrees
6931 (defvar org-indirect-dedicated-frame nil
6932 "This is the frame being used for indirect tree display.")
6933 (defvar org-last-indirect-buffer nil)
6935 (defun org-tree-to-indirect-buffer (&optional arg)
6936 "Create indirect buffer and narrow it to current subtree.
6937 With a numerical prefix ARG, go up to this level and then take that tree.
6938 If ARG is negative, go up that many levels.
6940 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6941 indirect buffer previously made with this command, to avoid proliferation of
6942 indirect buffers. However, when you call the command with a \
6944 when `org-indirect-buffer-display' is `new-frame', the last buffer
6945 is kept so that you can work with several indirect buffers at the same time.
6946 If `org-indirect-buffer-display' is `dedicated-frame', the \
6948 requests that a new frame be made for the new buffer, so that the dedicated
6949 frame is not changed."
6950 (interactive "P")
6951 (let ((cbuf (current-buffer))
6952 (cwin (selected-window))
6953 (pos (point))
6954 beg end level heading ibuf)
6955 (save-excursion
6956 (org-back-to-heading t)
6957 (when (numberp arg)
6958 (setq level (org-outline-level))
6959 (if (< arg 0) (setq arg (+ level arg)))
6960 (while (> (setq level (org-outline-level)) arg)
6961 (org-up-heading-safe)))
6962 (setq beg (point)
6963 heading (org-get-heading))
6964 (org-end-of-subtree t t)
6965 (if (org-at-heading-p) (backward-char 1))
6966 (setq end (point)))
6967 (if (and (buffer-live-p org-last-indirect-buffer)
6968 (not (eq org-indirect-buffer-display 'new-frame))
6969 (not arg))
6970 (kill-buffer org-last-indirect-buffer))
6971 (setq ibuf (org-get-indirect-buffer cbuf)
6972 org-last-indirect-buffer ibuf)
6973 (cond
6974 ((or (eq org-indirect-buffer-display 'new-frame)
6975 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6976 (select-frame (make-frame))
6977 (delete-other-windows)
6978 (org-pop-to-buffer-same-window ibuf)
6979 (org-set-frame-title heading))
6980 ((eq org-indirect-buffer-display 'dedicated-frame)
6981 (raise-frame
6982 (select-frame (or (and org-indirect-dedicated-frame
6983 (frame-live-p org-indirect-dedicated-frame)
6984 org-indirect-dedicated-frame)
6985 (setq org-indirect-dedicated-frame (make-frame)))))
6986 (delete-other-windows)
6987 (org-pop-to-buffer-same-window ibuf)
6988 (org-set-frame-title (concat "Indirect: " heading)))
6989 ((eq org-indirect-buffer-display 'current-window)
6990 (org-pop-to-buffer-same-window ibuf))
6991 ((eq org-indirect-buffer-display 'other-window)
6992 (pop-to-buffer ibuf))
6993 (t (error "Invalid value")))
6994 (if (featurep 'xemacs)
6995 (save-excursion (org-mode) (turn-on-font-lock)))
6996 (narrow-to-region beg end)
6997 (show-all)
6998 (goto-char pos)
6999 (run-hook-with-args 'org-cycle-hook 'all)
7000 (and (window-live-p cwin) (select-window cwin))))
7002 (defun org-get-indirect-buffer (&optional buffer)
7003 (setq buffer (or buffer (current-buffer)))
7004 (let ((n 1) (base (buffer-name buffer)) bname)
7005 (while (buffer-live-p
7006 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7007 (setq n (1+ n)))
7008 (condition-case nil
7009 (make-indirect-buffer buffer bname 'clone)
7010 (error (make-indirect-buffer buffer bname)))))
7012 (defun org-set-frame-title (title)
7013 "Set the title of the current frame to the string TITLE."
7014 ;; FIXME: how to name a single frame in XEmacs???
7015 (unless (featurep 'xemacs)
7016 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7018 ;;;; Structure editing
7020 ;;; Inserting headlines
7022 (defun org-previous-line-empty-p ()
7023 (save-excursion
7024 (and (not (bobp))
7025 (or (beginning-of-line 0) t)
7026 (save-match-data
7029 (defun org-insert-heading (&optional force-heading invisible-ok)
7030 "Insert a new heading or item with same depth at point.
7031 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7032 If point is at the beginning of a headline, insert a sibling before the
7033 current headline. If point is not at the beginning, split the line,
7034 create the new headline with the text in the current line after point
7035 \(but see also the variable `org-M-RET-may-split-line').
7037 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7038 This is important for non-interactive uses of the command."
7039 (interactive "P")
7040 (if (or (= (buffer-size) 0)
7041 (and (not (save-excursion
7042 (and (ignore-errors (org-back-to-heading invisible-ok))
7043 (org-at-heading-p))))
7044 (or force-heading (not (org-in-item-p)))))
7045 (progn
7047 (run-hooks 'org-insert-heading-hook))
7048 (when (or force-heading (not (org-insert-item)))
7049 (let* ((empty-line-p nil)
7050 (level nil)
7051 (on-heading (org-at-heading-p))
7052 (head (save-excursion
7053 (condition-case nil
7054 (progn
7055 (org-back-to-heading invisible-ok)
7056 (when (and (not on-heading)
7057 (featurep 'org-inlinetask)
7058 (integerp org-inlinetask-min-level)
7059 (>= (length (match-string 0))
7060 org-inlinetask-min-level))
7061 ;; Find a heading level before the inline task
7062 (while (and (setq level (org-up-heading-safe))
7063 (>= level org-inlinetask-min-level)))
7064 (if (org-at-heading-p)
7065 (org-back-to-heading invisible-ok)
7066 (error "This should not happen")))
7067 (setq empty-line-p (org-previous-line-empty-p))
7068 (match-string 0))
7069 (error "*"))))
7070 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7071 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7072 pos hide-previous previous-pos)
7073 (cond
7074 ((and (org-at-heading-p) (bolp)
7075 (or (bobp)
7076 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7077 ;; insert before the current line
7078 (open-line (if blank 2 1)))
7079 ((and (bolp)
7080 (not org-insert-heading-respect-content)
7081 (or (bobp)
7082 (save-excursion
7083 (backward-char 1) (not (outline-invisible-p)))))
7084 ;; insert right here
7085 nil)
7086 (t
7087 ;; somewhere in the line
7088 (save-excursion
7089 (setq previous-pos (point-at-bol))
7090 (end-of-line)
7091 (setq hide-previous (outline-invisible-p)))
7092 (and org-insert-heading-respect-content (org-show-subtree))
7093 (let ((split
7094 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7095 (save-excursion
7096 (let ((p (point)))
7097 (goto-char (point-at-bol))
7098 (and (looking-at org-complex-heading-regexp)
7099 (match-beginning 4)
7100 (> p (match-beginning 4)))))))
7101 tags pos)
7102 (cond
7103 (org-insert-heading-respect-content
7104 (org-end-of-subtree nil t)
7105 (when (featurep 'org-inlinetask)
7106 (while (and (not (eobp))
7108 (>= (length (match-string 1))
7109 org-inlinetask-min-level))
7110 (org-end-of-subtree nil t)))
7111 (or (bolp) (newline))
7112 (or (org-previous-line-empty-p)
7113 (and blank (newline)))
7114 (open-line 1))
7115 ((org-at-heading-p)
7116 (when hide-previous
7117 (show-children)
7118 (org-show-entry))
7120 (setq tags (and (match-end 2) (match-string 2)))
7121 (and (match-end 1)
7122 (delete-region (match-beginning 1) (match-end 1)))
7123 (setq pos (point-at-bol))
7124 (or split (end-of-line 1))
7125 (delete-horizontal-space)
7127 (buffer-substring (point-at-bol) (point)))
7128 (insert " "))
7129 (newline (if blank 2 1))
7130 (when tags
7131 (save-excursion
7132 (goto-char pos)
7133 (end-of-line 1)
7134 (insert " " tags)
7135 (org-set-tags nil 'align))))
7136 (t
7137 (or split (end-of-line 1))
7138 (newline (if blank 2 1)))))))
7139 (insert head) (just-one-space)
7140 (setq pos (point))
7141 (end-of-line 1)
7142 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7143 (when (and org-insert-heading-respect-content hide-previous)
7144 (save-excursion
7145 (goto-char previous-pos)
7146 (hide-subtree)))
7147 (run-hooks 'org-insert-heading-hook)))))
7149 (defun org-get-heading (&optional no-tags no-todo)
7150 "Return the heading of the current entry, without the stars.
7151 When NO-TAGS is non-nil, don't include tags.
7152 When NO-TODO is non-nil, don't include TODO keywords."
7153 (save-excursion
7154 (org-back-to-heading t)
7155 (cond
7156 ((and no-tags no-todo)
7157 (looking-at org-complex-heading-regexp)
7158 (match-string 4))
7159 (no-tags
7160 (looking-at (concat org-outline-regexp
7163 (match-string 1))
7164 (no-todo
7165 (looking-at org-todo-line-regexp)
7166 (match-string 3))
7167 (t (looking-at org-heading-regexp)
7168 (match-string 2)))))
7170 (defun org-heading-components ()
7171 "Return the components of the current heading.
7172 This is a list with the following elements:
7173 - the level as an integer
7174 - the reduced level, different if `org-odd-levels-only' is set.
7175 - the TODO keyword, or nil
7176 - the priority character, like ?A, or nil if no priority is given
7177 - the headline text itself, or the tags string if no headline text
7178 - the tags string, or nil."
7179 (save-excursion
7180 (org-back-to-heading t)
7181 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7182 (list (length (match-string 1))
7183 (org-reduced-level (length (match-string 1)))
7184 (org-match-string-no-properties 2)
7185 (and (match-end 3) (aref (match-string 3) 2))
7186 (org-match-string-no-properties 4)
7187 (org-match-string-no-properties 5)))))
7189 (defun org-get-entry ()
7190 "Get the entry text, after heading, entire subtree."
7191 (save-excursion
7192 (org-back-to-heading t)
7193 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7195 (defun org-insert-heading-after-current ()
7196 "Insert a new heading with same level as current, after current subtree."
7197 (interactive)
7198 (org-back-to-heading)
7199 (org-insert-heading)
7200 (org-move-subtree-down)
7201 (end-of-line 1))
7203 (defun org-insert-heading-respect-content ()
7204 (interactive)
7205 (let ((org-insert-heading-respect-content t))
7206 (org-insert-heading t)))
7208 (defun org-insert-todo-heading-respect-content (&optional force-state)
7209 (interactive "P")
7210 (let ((org-insert-heading-respect-content t))
7211 (org-insert-todo-heading force-state t)))
7213 (defun org-insert-todo-heading (arg &optional force-heading)
7214 "Insert a new heading with the same level and TODO state as current heading.
7215 If the heading has no TODO state, or if the state is DONE, use the first
7216 state (TODO by default). Also with prefix arg, force first state."
7217 (interactive "P")
7218 (when (or force-heading (not (org-insert-item 'checkbox)))
7219 (org-insert-heading force-heading)
7220 (save-excursion
7221 (org-back-to-heading)
7222 (outline-previous-heading)
7223 (looking-at org-todo-line-regexp))
7224 (let*
7225 ((new-mark-x
7226 (if (or arg
7227 (not (match-beginning 2))
7228 (member (match-string 2) org-done-keywords))
7229 (car org-todo-keywords-1)
7230 (match-string 2)))
7231 (new-mark
7232 (or
7233 (run-hook-with-args-until-success
7234 'org-todo-get-default-hook new-mark-x nil)
7235 new-mark-x)))
7236 (beginning-of-line 1)
7237 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7238 (if org-treat-insert-todo-heading-as-state-change
7239 (org-todo new-mark)
7240 (insert new-mark " "))))
7241 (when org-provide-todo-statistics
7242 (org-update-parent-todo-statistics))))
7244 (defun org-insert-subheading (arg)
7245 "Insert a new subheading and demote it.
7246 Works for outline headings and for plain lists alike."
7247 (interactive "P")
7248 (org-insert-heading arg)
7249 (cond
7250 ((org-at-heading-p) (org-do-demote))
7251 ((org-at-item-p) (org-indent-item))))
7253 (defun org-insert-todo-subheading (arg)
7254 "Insert a new subheading with TODO keyword or checkbox and demote it.
7255 Works for outline headings and for plain lists alike."
7256 (interactive "P")
7257 (org-insert-todo-heading arg)
7258 (cond
7259 ((org-at-heading-p) (org-do-demote))
7260 ((org-at-item-p) (org-indent-item))))
7262 ;;; Promotion and Demotion
7264 (defvar org-after-demote-entry-hook nil
7265 "Hook run after an entry has been demoted.
7266 The cursor will be at the beginning of the entry.
7267 When a subtree is being demoted, the hook will be called for each node.")
7269 (defvar org-after-promote-entry-hook nil
7270 "Hook run after an entry has been promoted.
7271 The cursor will be at the beginning of the entry.
7272 When a subtree is being promoted, the hook will be called for each node.")
7274 (defun org-promote-subtree ()
7275 "Promote the entire subtree.
7276 See also `org-promote'."
7277 (interactive)
7278 (save-excursion
7279 (org-with-limited-levels (org-map-tree 'org-promote)))
7280 (org-fix-position-after-promote))
7282 (defun org-demote-subtree ()
7283 "Demote the entire subtree. See `org-demote'.
7284 See also `org-promote'."
7285 (interactive)
7286 (save-excursion
7287 (org-with-limited-levels (org-map-tree 'org-demote)))
7288 (org-fix-position-after-promote))
7291 (defun org-do-promote ()
7292 "Promote the current heading higher up the tree.
7293 If the region is active in `transient-mark-mode', promote all headings
7294 in the region."
7295 (interactive)
7296 (save-excursion
7297 (if (org-region-active-p)
7298 (org-map-region 'org-promote (region-beginning) (region-end))
7299 (org-promote)))
7300 (org-fix-position-after-promote))
7302 (defun org-do-demote ()
7303 "Demote the current heading lower down the tree.
7304 If the region is active in `transient-mark-mode', demote all headings
7305 in the region."
7306 (interactive)
7307 (save-excursion
7308 (if (org-region-active-p)
7309 (org-map-region 'org-demote (region-beginning) (region-end))
7310 (org-demote)))
7311 (org-fix-position-after-promote))
7313 (defun org-fix-position-after-promote ()
7314 "Make sure that after pro/demotion cursor position is right."
7315 (let ((pos (point)))
7316 (when (save-excursion
7317 (beginning-of-line 1)
7318 (looking-at org-todo-line-regexp)
7319 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7320 (cond ((eobp) (insert " "))
7321 ((eolp) (insert " "))
7322 ((equal (char-after) ?\ ) (forward-char 1))))))
7324 (defun org-current-level ()
7325 "Return the level of the current entry, or nil if before the first headline.
7326 The level is the number of stars at the beginning of the headline."
7327 (save-excursion
7328 (org-with-limited-levels
7329 (if (ignore-errors (org-back-to-heading t))
7330 (funcall outline-level)))))
7332 (defun org-get-previous-line-level ()
7333 "Return the outline depth of the last headline before the current line.
7334 Returns 0 for the first headline in the buffer, and nil if before the
7335 first headline."
7336 (let ((current-level (org-current-level))
7337 (prev-level (when (> (line-number-at-pos) 1)
7338 (save-excursion
7339 (beginning-of-line 0)
7340 (org-current-level)))))
7341 (cond ((null current-level) nil) ; Before first headline
7342 ((null prev-level) 0) ; At first headline
7343 (prev-level))))
7345 (defun org-reduced-level (l)
7346 "Compute the effective level of a heading.
7347 This takes into account the setting of `org-odd-levels-only'."
7348 (cond
7349 ((zerop l) 0)
7350 (org-odd-levels-only (1+ (floor (/ l 2))))
7351 (t l)))
7353 (defun org-level-increment ()
7354 "Return the number of stars that will be added or removed at a
7355 time to headlines when structure editing, based on the value of
7356 `org-odd-levels-only'."
7357 (if org-odd-levels-only 2 1))
7359 (defun org-get-valid-level (level &optional change)
7360 "Rectify a level change under the influence of `org-odd-levels-only'
7361 LEVEL is a current level, CHANGE is by how much the level should be
7362 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7363 even level numbers will become the next higher odd number."
7364 (if org-odd-levels-only
7365 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7366 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7367 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7368 (max 1 (+ level (or change 0)))))
7370 (if (boundp 'define-obsolete-function-alias)
7371 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7372 (define-obsolete-function-alias 'org-get-legal-level
7373 'org-get-valid-level)
7374 (define-obsolete-function-alias 'org-get-legal-level
7375 'org-get-valid-level "23.1")))
7377 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7378 ;; ̀org-with-limited-levels'
7379 (defun org-promote ()
7380 "Promote the current heading higher up the tree.
7381 If the region is active in `transient-mark-mode', promote all headings
7382 in the region."
7383 (org-back-to-heading t)
7384 (let* ((level (save-match-data (funcall outline-level)))
7385 (after-change-functions (remove 'flyspell-after-change-function
7386 after-change-functions))
7387 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7388 (diff (abs (- level (length up-head) -1))))
7389 (cond ((and (= level 1) org-called-with-limited-levels
7390 org-allow-promoting-top-level-subtree)
7391 (replace-match "# " nil t))
7392 ((= level 1)
7393 (error "Cannot promote to level 0. UNDO to recover if necessary"))
7394 (t (replace-match up-head nil t)))
7395 ;; Fixup tag positioning
7396 (unless (= level 1)
7397 (and org-auto-align-tags (org-set-tags nil t))
7398 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7399 (run-hooks 'org-after-promote-entry-hook)))
7401 (defun org-demote ()
7402 "Demote the current heading lower down the tree.
7403 If the region is active in `transient-mark-mode', demote all headings
7404 in the region."
7405 (org-back-to-heading t)
7406 (let* ((level (save-match-data (funcall outline-level)))
7407 (after-change-functions (remove 'flyspell-after-change-function
7408 after-change-functions))
7409 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7410 (diff (abs (- level (length down-head) -1))))
7411 (replace-match down-head nil t)
7412 ;; Fixup tag positioning
7413 (and org-auto-align-tags (org-set-tags nil t))
7414 (if org-adapt-indentation (org-fixup-indentation diff))
7415 (run-hooks 'org-after-demote-entry-hook)))
7417 (defun org-cycle-level ()
7418 "Cycle the level of an empty headline through possible states.
7419 This goes first to child, then to parent, level, then up the hierarchy.
7420 After top level, it switches back to sibling level."
7421 (interactive)
7422 (let ((org-adapt-indentation nil))
7423 (when (org-point-at-end-of-empty-headline)
7424 (setq this-command 'org-cycle-level) ; Only needed for caching
7425 (let ((cur-level (org-current-level))
7426 (prev-level (org-get-previous-line-level)))
7427 (cond
7428 ;; If first headline in file, promote to top-level.
7429 ((= prev-level 0)
7430 (loop repeat (/ (- cur-level 1) (org-level-increment))
7431 do (org-do-promote)))
7432 ;; If same level as prev, demote one.
7433 ((= prev-level cur-level)
7434 (org-do-demote))
7435 ;; If parent is top-level, promote to top level if not already.
7436 ((= prev-level 1)
7437 (loop repeat (/ (- cur-level 1) (org-level-increment))
7438 do (org-do-promote)))
7439 ;; If top-level, return to prev-level.
7440 ((= cur-level 1)
7441 (loop repeat (/ (- prev-level 1) (org-level-increment))
7442 do (org-do-demote)))
7443 ;; If less than prev-level, promote one.
7444 ((< cur-level prev-level)
7445 (org-do-promote))
7446 ;; If deeper than prev-level, promote until higher than
7447 ;; prev-level.
7448 ((> cur-level prev-level)
7449 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7450 do (org-do-promote))))
7451 t))))
7453 (defun org-map-tree (fun)
7454 "Call FUN for every heading underneath the current one."
7455 (org-back-to-heading)
7456 (let ((level (funcall outline-level)))
7457 (save-excursion
7458 (funcall fun)
7459 (while (and (progn
7460 (outline-next-heading)
7461 (> (funcall outline-level) level))
7462 (not (eobp)))
7463 (funcall fun)))))
7465 (defun org-map-region (fun beg end)
7466 "Call FUN for every heading between BEG and END."
7467 (let ((org-ignore-region t))
7468 (save-excursion
7469 (setq end (copy-marker end))
7470 (goto-char beg)
7471 (if (and (re-search-forward org-outline-regexp-bol nil t)
7472 (< (point) end))
7473 (funcall fun))
7474 (while (and (progn
7475 (outline-next-heading)
7476 (< (point) end))
7477 (not (eobp)))
7478 (funcall fun)))))
7480 (defvar org-property-end-re) ; silence byte-compiler
7481 (defun org-fixup-indentation (diff)
7482 "Change the indentation in the current entry by DIFF.
7483 However, if any line in the current entry has no indentation, or if it
7484 would end up with no indentation after the change, nothing at all is done."
7485 (save-excursion
7486 (let ((end (save-excursion (outline-next-heading)
7487 (point-marker)))
7488 (prohibit (if (> diff 0)
7491 col)
7492 (unless (save-excursion (end-of-line 1)
7493 (re-search-forward prohibit end t))
7494 (while (and (< (point) end)
7496 (goto-char (match-end 0))
7497 (setq col (current-column))
7498 (if (< diff 0) (replace-match ""))
7499 (org-indent-to-column (+ diff col))))
7500 (move-marker end nil))))
7502 (defun org-convert-to-odd-levels ()
7503 "Convert an org-mode file with all levels allowed to one with odd levels.
7504 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7505 level 5 etc."
7506 (interactive)
7507 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7508 (let ((outline-level 'org-outline-level)
7509 (org-odd-levels-only nil) n)
7510 (save-excursion
7511 (goto-char (point-min))
7513 (setq n (- (length (match-string 0)) 2))
7514 (while (>= (setq n (1- n)) 0)
7515 (org-demote))
7516 (end-of-line 1))))))
7518 (defun org-convert-to-oddeven-levels ()
7519 "Convert an org-mode file with only odd levels to one with odd/even levels.
7520 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7521 file contains a section with an even level, conversion would
7522 destroy the structure of the file. An error is signaled in this
7523 case."
7524 (interactive)
7525 (goto-char (point-min))
7526 ;; First check if there are no even levels
7528 (org-show-context t)
7529 (error "Not all levels are odd in this file. Conversion not possible"))
7530 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7531 (let ((outline-regexp org-outline-regexp)
7532 (outline-level 'org-outline-level)
7533 (org-odd-levels-only nil) n)
7534 (save-excursion
7535 (goto-char (point-min))
7537 (setq n (/ (1- (length (match-string 0))) 2))
7538 (while (>= (setq n (1- n)) 0)
7539 (org-promote))
7540 (end-of-line 1))))))
7542 (defun org-tr-level (n)
7543 "Make N odd if required."
7544 (if org-odd-levels-only (1+ (/ n 2)) n))
7546 ;;; Vertical tree motion, cutting and pasting of subtrees
7548 (defun org-move-subtree-up (&optional arg)
7549 "Move the current subtree up past ARG headlines of the same level."
7550 (interactive "p")
7551 (org-move-subtree-down (- (prefix-numeric-value arg))))
7553 (defun org-move-subtree-down (&optional arg)
7554 "Move the current subtree down past ARG headlines of the same level."
7555 (interactive "p")
7556 (setq arg (prefix-numeric-value arg))
7557 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7558 'org-get-last-sibling))
7559 (ins-point (make-marker))
7560 (cnt (abs arg))
7561 (col (current-column))
7562 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7563 ;; Select the tree
7564 (org-back-to-heading)
7565 (setq beg0 (point))
7566 (save-excursion
7567 (setq ne-beg (org-back-over-empty-lines))
7568 (setq beg (point)))
7569 (save-match-data
7570 (save-excursion (outline-end-of-heading)
7571 (setq folded (outline-invisible-p)))
7572 (outline-end-of-subtree))
7573 (outline-next-heading)
7574 (setq ne-end (org-back-over-empty-lines))
7575 (setq end (point))
7576 (goto-char beg0)
7577 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7578 ;; include less whitespace
7579 (save-excursion
7580 (goto-char beg)
7581 (forward-line (- ne-beg ne-end))
7582 (setq beg (point))))
7583 ;; Find insertion point, with error handling
7584 (while (> cnt 0)
7585 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7586 (progn (goto-char beg0)
7587 (error "Cannot move past superior level or buffer limit")))
7588 (setq cnt (1- cnt)))
7589 (if (> arg 0)
7590 ;; Moving forward - still need to move over subtree
7591 (progn (org-end-of-subtree t t)
7592 (save-excursion
7593 (org-back-over-empty-lines)
7594 (or (bolp) (newline)))))
7595 (setq ne-ins (org-back-over-empty-lines))
7596 (move-marker ins-point (point))
7597 (setq txt (buffer-substring beg end))
7598 (org-save-markers-in-region beg end)
7599 (delete-region beg end)
7600 (org-remove-empty-overlays-at beg)
7601 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7602 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7604 (let ((bbb (point)))
7605 (insert-before-markers txt)
7606 (org-reinstall-markers-in-region bbb)
7607 (move-marker ins-point bbb))
7609 (setq ins-end (point))
7610 (goto-char ins-point)
7611 (org-skip-whitespace)
7612 (when (and (< arg 0)
7613 (org-first-sibling-p)
7614 (> ne-ins ne-beg))
7615 ;; Move whitespace back to beginning
7616 (save-excursion
7617 (goto-char ins-end)
7618 (let ((kill-whole-line t))
7619 (kill-line (- ne-ins ne-beg)) (point)))
7621 (move-marker ins-point nil)
7622 (if folded
7623 (hide-subtree)
7624 (org-show-entry)
7625 (show-children)
7626 (org-cycle-hide-drawers 'children))
7627 (org-clean-visibility-after-subtree-move)
7628 ;; move back to the initial column we were at
7629 (move-to-column col)))
7631 (defvar org-subtree-clip ""
7632 "Clipboard for cut and paste of subtrees.
7633 This is actually only a copy of the kill, because we use the normal kill
7634 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7636 (defvar org-subtree-clip-folded nil
7637 "Was the last copied subtree folded?
7638 This is used to fold the tree back after pasting.")
7640 (defun org-cut-subtree (&optional n)
7641 "Cut the current subtree into the clipboard.
7642 With prefix arg N, cut this many sequential subtrees.
7643 This is a short-hand for marking the subtree and then cutting it."
7644 (interactive "p")
7645 (org-copy-subtree n 'cut))
7647 (defun org-copy-subtree (&optional n cut force-store-markers)
7648 "Cut the current subtree into the clipboard.
7649 With prefix arg N, cut this many sequential subtrees.
7650 This is a short-hand for marking the subtree and then copying it.
7651 If CUT is non-nil, actually cut the subtree.
7652 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7653 of some markers in the region, even if CUT is non-nil. This is
7654 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7655 (interactive "p")
7656 (let (beg end folded (beg0 (point)))
7657 (if (org-called-interactively-p 'any)
7658 (org-back-to-heading nil) ; take what looks like a subtree
7659 (org-back-to-heading t)) ; take what is really there
7660 (org-back-over-empty-lines)
7661 (setq beg (point))
7663 (save-match-data
7664 (save-excursion (outline-end-of-heading)
7665 (setq folded (outline-invisible-p)))
7666 (condition-case nil
7667 (org-forward-heading-same-level (1- n) t)
7668 (error nil))
7669 (org-end-of-subtree t t))
7670 (org-back-over-empty-lines)
7671 (setq end (point))
7672 (goto-char beg0)
7673 (when (> end beg)
7674 (setq org-subtree-clip-folded folded)
7675 (when (or cut force-store-markers)
7676 (org-save-markers-in-region beg end))
7677 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7678 (setq org-subtree-clip (current-kill 0))
7679 (message "%s: Subtree(s) with %d characters"
7680 (if cut "Cut" "Copied")
7681 (length org-subtree-clip)))))
7683 (defun org-paste-subtree (&optional level tree for-yank)
7684 "Paste the clipboard as a subtree, with modification of headline level.
7685 The entire subtree is promoted or demoted in order to match a new headline
7686 level.
7688 If the cursor is at the beginning of a headline, the same level as
7689 that headline is used to paste the tree
7691 If not, the new level is derived from the *visible* headings
7692 before and after the insertion point, and taken to be the inferior headline
7693 level of the two. So if the previous visible heading is level 3 and the
7694 next is level 4 (or vice versa), level 4 will be used for insertion.
7695 This makes sure that the subtree remains an independent subtree and does
7696 not swallow low level entries.
7698 You can also force a different level, either by using a numeric prefix
7699 argument, or by inserting the heading marker by hand. For example, if the
7702 If optional TREE is given, use this text instead of the kill ring.
7704 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7705 move back over whitespace before inserting, and move point to the end of
7706 the inserted text when done."
7707 (interactive "P")
7708 (setq tree (or tree (and kill-ring (current-kill 0))))
7709 (unless (org-kill-is-subtree-p tree)
7710 (error "%s"
7711 (substitute-command-keys
7713 (org-with-limited-levels
7714 (let* ((visp (not (outline-invisible-p)))
7715 (txt tree)
7717 (old-level (if (string-match org-outline-regexp-bol txt)
7718 (- (match-end 0) (match-beginning 0) 1)
7719 -1))
7720 (force-level (cond (level (prefix-numeric-value level))
7722 (string-match
7724 (point-at-bol) (point))))
7725 (- (match-end 1) (match-beginning 1)))
7726 ((and (bolp)
7727 (looking-at org-outline-regexp))
7728 (- (match-end 0) (point) 1))))
7729 (previous-level (save-excursion
7730 (condition-case nil
7731 (progn
7732 (outline-previous-visible-heading 1)
7733 (if (looking-at ^re_)
7734 (- (match-end 0) (match-beginning 0) 1)
7735 1))
7736 (error 1))))
7737 (next-level (save-excursion
7738 (condition-case nil
7739 (progn
7740 (or (looking-at org-outline-regexp)
7741 (outline-next-visible-heading 1))
7742 (if (looking-at ^re_)
7743 (- (match-end 0) (match-beginning 0) 1)
7744 1))
7745 (error 1))))
7746 (new-level (or force-level (max previous-level next-level)))
7747 (shift (if (or (= old-level -1)
7748 (= new-level -1)
7749 (= old-level new-level))
7750 0
7751 (- new-level old-level)))
7752 (delta (if (> shift 0) -1 1))
7753 (func (if (> shift 0) 'org-demote 'org-promote))
7754 (org-odd-levels-only nil)
7755 beg end newend)
7756 ;; Remove the forced level indicator
7757 (if force-level
7758 (delete-region (point-at-bol) (point)))
7759 ;; Paste
7760 (beginning-of-line (if (bolp) 1 2))
7761 (unless for-yank (org-back-over-empty-lines))
7762 (setq beg (point))
7763 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7764 (insert-before-markers txt)
7766 (setq newend (point))
7767 (org-reinstall-markers-in-region beg)
7768 (setq end (point))
7769 (goto-char beg)
7771 (setq beg (point))
7772 (if (and (outline-invisible-p) visp)
7773 (save-excursion (outline-show-heading)))
7774 ;; Shift if necessary
7775 (unless (= shift 0)
7776 (save-restriction
7777 (narrow-to-region beg end)
7778 (while (not (= shift 0))
7779 (org-map-region func (point-min) (point-max))
7780 (setq shift (+ delta shift)))
7781 (goto-char (point-min))
7782 (setq newend (point-max))))
7783 (when (or (org-called-interactively-p 'interactive) for-yank)
7784 (message "Clipboard pasted as level %d subtree" new-level))
7785 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7786 kill-ring
7787 (eq org-subtree-clip (current-kill 0))
7788 org-subtree-clip-folded)
7789 ;; The tree was folded before it was killed/copied
7790 (hide-subtree))
7791 (and for-yank (goto-char newend)))))
7793 (defun org-kill-is-subtree-p (&optional txt)
7794 "Check if the current kill is an outline subtree, or a set of trees.
7795 Returns nil if kill does not start with a headline, or if the first
7796 headline level is not the largest headline level in the tree.
7797 So this will actually accept several entries of equal levels as well,
7798 which is OK for `org-paste-subtree'.
7799 If optional TXT is given, check this string instead of the current kill."
7800 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7801 (re (org-get-limited-outline-regexp))
7802 (^re (concat "^" re))
7803 (start-level (and kill
7804 (string-match
7806 kill)
7807 (- (match-end 2) (match-beginning 2) 1)))
7808 (start (1+ (or (match-beginning 2) -1))))
7809 (if (not start-level)
7810 (progn
7811 nil) ;; does not even start with a heading
7812 (catch 'exit
7813 (while (setq start (string-match ^re kill (1+ start)))
7814 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7815 (throw 'exit nil)))
7816 t))))
7818 (defvar org-markers-to-move nil
7819 "Markers that should be moved with a cut-and-paste operation.
7820 Those markers are stored together with their positions relative to
7821 the start of the region.")
7823 (defun org-save-markers-in-region (beg end)
7824 "Check markers in region.
7825 If these markers are between BEG and END, record their position relative
7826 to BEG, so that after moving the block of text, we can put the markers back
7827 into place.
7828 This function gets called just before an entry or tree gets cut from the
7829 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7830 called immediately, to move the markers with the entries."
7831 (setq org-markers-to-move nil)
7832 (when (featurep 'org-clock)
7833 (org-clock-save-markers-for-cut-and-paste beg end))
7834 (when (featurep 'org-agenda)
7835 (org-agenda-save-markers-for-cut-and-paste beg end)))
7837 (defun org-check-and-save-marker (marker beg end)
7838 "Check if MARKER is between BEG and END.
7839 If yes, remember the marker and the distance to BEG."
7840 (when (and (marker-buffer marker)
7841 (equal (marker-buffer marker) (current-buffer)))
7842 (if (and (>= marker beg) (< marker end))
7843 (push (cons marker (- marker beg)) org-markers-to-move))))
7845 (defun org-reinstall-markers-in-region (beg)
7846 "Move all remembered markers to their position relative to BEG."
7847 (mapc (lambda (x)
7848 (move-marker (car x) (+ beg (cdr x))))
7849 org-markers-to-move)
7850 (setq org-markers-to-move nil))
7852 (defun org-narrow-to-subtree ()
7853 "Narrow buffer to the current subtree."
7854 (interactive)
7855 (save-excursion
7856 (save-match-data
7857 (org-with-limited-levels
7858 (narrow-to-region
7859 (progn (org-back-to-heading t) (point))
7860 (progn (org-end-of-subtree t t)
7861 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7862 (point)))))))
7864 (defun org-narrow-to-block ()
7865 "Narrow buffer to the current block."
7866 (interactive)
7867 (let* ((case-fold-search t)
7870 (if blockp
7871 (narrow-to-region (car blockp) (cdr blockp))
7872 (error "Not in a block"))))
7874 (eval-when-compile
7875 (defvar org-property-drawer-re))
7877 (defvar org-property-start-re) ;; defined below
7878 (defun org-clone-subtree-with-time-shift (n &optional shift)
7879 "Clone the task (subtree) at point N times.
7880 The clones will be inserted as siblings.
7882 In interactive use, the user will be prompted for the number of
7883 clones to be produced, and for a time SHIFT, which may be a
7884 repeater as used in time stamps, for example `+3d'.
7886 When a valid repeater is given and the entry contains any time
7887 stamps, the clones will become a sequence in time, with time
7888 stamps in the subtree shifted for each clone produced. If SHIFT
7889 is nil or the empty string, time stamps will be left alone. The
7890 ID property of the original subtree is removed.
7892 If the original subtree did contain time stamps with a repeater,
7893 the following will happen:
7894 - the repeater will be removed in each clone
7895 - an additional clone will be produced, with the current, unshifted
7896 date(s) in the entry.
7897 - the original entry will be placed *after* all the clones, with
7898 repeater intact.
7899 - the start days in the repeater in the original entry will be shifted
7900 to past the last clone.
7901 In this way you can spell out a number of instances of a repeating task,
7902 and still retain the repeater to cover future instances of the task."
7903 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7904 (let (beg end template task idprop
7905 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7906 (drawer-re org-drawer-regexp))
7907 (if (not (and (integerp n) (> n 0)))
7908 (error "Invalid number of replications %s" n))
7911 shift)))
7912 (error "Invalid shift specification %s" shift))
7913 (when doshift
7914 (setq shift-n (string-to-number (match-string 1 shift))
7915 shift-what (cdr (assoc (match-string 2 shift)
7916 '(("d" . day) ("w" . week)
7917 ("m" . month) ("y" . year))))))
7918 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7919 (setq nmin 1 nmax n)
7920 (org-back-to-heading t)
7921 (setq beg (point))
7922 (setq idprop (org-entry-get nil "ID"))
7923 (org-end-of-subtree t t)
7925 (setq end (point))
7926 (setq template (buffer-substring beg end))
7927 (when (and doshift
7929 (delete-region beg end)
7930 (setq end beg)
7931 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7932 (goto-char end)
7933 (loop for n from nmin to nmax do
7934 ;; prepare clone
7935 (with-temp-buffer
7936 (insert template)
7937 (org-mode)
7938 (goto-char (point-min))
7939 (org-show-subtree)
7940 (and idprop (if org-clone-delete-id
7941 (org-entry-delete nil "ID")
7942 (org-id-get-create t)))
7943 (unless (= n 0)
7945 (kill-whole-line))
7946 (goto-char (point-min))
7947 (while (re-search-forward drawer-re nil t)
7948 (mapc (lambda (d)
7949 (org-remove-empty-drawer-at d (point))) org-drawers)))
7950 (goto-char (point-min))
7951 (when doshift
7952 (while (re-search-forward org-ts-regexp-both nil t)
7953 (org-timestamp-change (* n shift-n) shift-what))
7954 (unless (= n n-no-remove)
7955 (goto-char (point-min))
7956 (while (re-search-forward org-ts-regexp nil t)
7957 (save-excursion
7958 (goto-char (match-beginning 0))
7960 (delete-region (match-beginning 1) (match-end 1)))))))
7961 (setq task (buffer-string)))
7962 (insert task))
7963 (goto-char beg)))
7965 ;;; Outline Sorting
7967 (defun org-sort (with-case)
7968 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7969 Optional argument WITH-CASE means sort case-sensitively."
7970 (interactive "P")
7971 (cond
7972 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7973 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7974 (t
7975 (org-call-with-arg 'org-sort-entries with-case))))
7977 (defun org-sort-remove-invisible (s)
7978 (remove-text-properties 0 (length s) org-rm-props s)
7979 (while (string-match org-bracket-link-regexp s)
7980 (setq s (replace-match (if (match-end 2)
7981 (match-string 3 s)
7982 (match-string 1 s)) t t s)))
7983 s)
7985 (defvar org-priority-regexp) ; defined later in the file
7987 (defvar org-after-sorting-entries-or-items-hook nil
7988 "Hook that is run after a bunch of entries or items have been sorted.
7989 When children are sorted, the cursor is in the parent line when this
7990 hook gets called. When a region or a plain list is sorted, the cursor
7991 will be in the first entry of the sorted region/list.")
7993 (defun org-sort-entries
7994 (&optional with-case sorting-type getkey-func compare-func property)
7995 "Sort entries on a certain level of an outline tree.
7996 If there is an active region, the entries in the region are sorted.
7997 Else, if the cursor is before the first entry, sort the top-level items.
7998 Else, the children of the entry at point are sorted.
8000 Sorting can be alphabetically, numerically, by date/time as given by
8001 a time stamp, by a property or by priority.
8003 The command prompts for the sorting type unless it has been given to the
8004 function through the SORTING-TYPE argument, which needs to be a character,
8005 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8006 precise meaning of each character:
8008 n Numerically, by converting the beginning of the entry/item to a number.
8009 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8010 t By date/time, either the first active time stamp in the entry, or, if
8011 none exist, by the first inactive one.
8012 s By the scheduled date/time.
8013 d By deadline date/time.
8014 c By creation time, which is assumed to be the first inactive time stamp
8015 at the beginning of a line.
8016 p By priority according to the cookie.
8017 r By the value of a property.
8019 Capital letters will reverse the sort order.
8021 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8022 called with point at the beginning of the record. It must return either
8023 a string or a number that should serve as the sorting key for that record.
8025 Comparing entries ignores case by default. However, with an optional argument
8026 WITH-CASE, the sorting considers case as well."
8027 (interactive "P")
8028 (let ((case-func (if with-case 'identity 'downcase))
8029 start beg end stars re re2
8030 txt what tmp)
8031 ;; Find beginning and end of region to sort
8032 (cond
8033 ((org-region-active-p)
8034 ;; we will sort the region
8035 (setq end (region-end)
8036 what "region")
8037 (goto-char (region-beginning))
8038 (if (not (org-at-heading-p)) (outline-next-heading))
8039 (setq start (point)))
8040 ((or (org-at-heading-p)
8041 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8042 ;; we will sort the children of the current headline
8043 (org-back-to-heading)
8044 (setq start (point)
8045 end (progn (org-end-of-subtree t t)
8047 (org-back-over-empty-lines)
8048 (point))
8049 what "children")
8050 (goto-char start)
8051 (show-subtree)
8052 (outline-next-heading))
8053 (t
8054 ;; we will sort the top-level entries in this file
8055 (goto-char (point-min))
8056 (or (org-at-heading-p) (outline-next-heading))
8057 (setq start (point))
8058 (goto-char (point-max))
8059 (beginning-of-line 1)
8061 ;; File ends in a non-white line
8062 (end-of-line 1)
8064 (setq end (point-max))
8065 (setq what "top-level")
8066 (goto-char start)
8067 (show-all)))
8069 (setq beg (point))
8070 (if (>= beg end) (error "Nothing to sort"))
8073 (setq stars (match-string 1)
8074 re (concat "^" (regexp-quote stars) " +")
8076 txt (buffer-substring beg end))
8078 (if (and (not (equal stars "*")) (string-match re2 txt))
8079 (error "Region to sort contains a level above the first entry"))
8081 (unless sorting-type
8082 (message
8083 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8085 A/N/T/S/D/C/P/O/F means reversed:"
8086 what)
8087 (setq sorting-type (read-char-exclusive))
8089 (and (= (downcase sorting-type) ?f)
8090 (setq getkey-func
8091 (org-icompleting-read "Sort using function: "
8092 obarray 'fboundp t nil nil))
8093 (setq getkey-func (intern getkey-func)))
8095 (and (= (downcase sorting-type) ?r)
8096 (setq property
8097 (org-icompleting-read "Property: "
8098 (mapcar 'list (org-buffer-property-keys t))
8099 nil t))))
8101 (message "Sorting entries...")
8103 (save-restriction
8104 (narrow-to-region start end)
8105 (let ((dcst (downcase sorting-type))
8106 (case-fold-search nil)
8107 (now (current-time)))
8108 (sort-subr
8109 (/= dcst sorting-type)
8110 ;; This function moves to the beginning character of the "record" to
8111 ;; be sorted.
8112 (lambda nil
8113 (if (re-search-forward re nil t)
8114 (goto-char (match-beginning 0))
8115 (goto-char (point-max))))
8116 ;; This function moves to the last character of the "record" being
8117 ;; sorted.
8118 (lambda nil
8119 (save-match-data
8120 (condition-case nil
8121 (outline-forward-same-level 1)
8122 (error
8123 (goto-char (point-max))))))
8124 ;; This function returns the value that gets sorted against.
8125 (lambda nil
8126 (cond
8127 ((= dcst ?n)
8128 (if (looking-at org-complex-heading-regexp)
8129 (string-to-number (match-string 4))
8130 nil))
8131 ((= dcst ?a)
8132 (if (looking-at org-complex-heading-regexp)
8133 (funcall case-func (match-string 4))
8134 nil))
8135 ((= dcst ?t)
8136 (let ((end (save-excursion (outline-next-heading) (point))))
8137 (if (or (re-search-forward org-ts-regexp end t)
8138 (re-search-forward org-ts-regexp-both end t))
8139 (org-time-string-to-seconds (match-string 0))
8140 (org-float-time now))))
8141 ((= dcst ?c)
8142 (let ((end (save-excursion (outline-next-heading) (point))))
8143 (if (re-search-forward
8145 end t)
8146 (org-time-string-to-seconds (match-string 0))
8147 (org-float-time now))))
8148 ((= dcst ?s)
8149 (let ((end (save-excursion (outline-next-heading) (point))))
8150 (if (re-search-forward org-scheduled-time-regexp end t)
8151 (org-time-string-to-seconds (match-string 1))
8152 (org-float-time now))))
8153 ((= dcst ?d)
8154 (let ((end (save-excursion (outline-next-heading) (point))))
8155 (if (re-search-forward org-deadline-time-regexp end t)
8156 (org-time-string-to-seconds (match-string 1))
8157 (org-float-time now))))
8158 ((= dcst ?p)
8159 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8160 (string-to-char (match-string 2))
8161 org-default-priority))
8162 ((= dcst ?r)
8163 (or (org-entry-get nil property) ""))
8164 ((= dcst ?o)
8165 (if (looking-at org-complex-heading-regexp)
8166 (- 9999 (length (member (match-string 2)
8167 org-todo-keywords-1)))))
8168 ((= dcst ?f)
8169 (if getkey-func
8170 (progn
8171 (setq tmp (funcall getkey-func))
8172 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8173 tmp)
8174 (error "Invalid key function `%s'" getkey-func)))
8175 (t (error "Invalid sorting type `%c'" sorting-type))))
8176 nil
8177 (cond
8178 ((= dcst ?a) 'string<)
8179 ((= dcst ?f) compare-func)
8180 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8181 (run-hooks 'org-after-sorting-entries-or-items-hook)
8182 (message "Sorting entries...done")))
8184 (defun org-do-sort (table what &optional with-case sorting-type)
8185 "Sort TABLE of WHAT according to SORTING-TYPE.
8186 The user will be prompted for the SORTING-TYPE if the call to this
8187 function does not specify it. WHAT is only for the prompt, to indicate
8188 what is being sorted. The sorting key will be extracted from
8189 the car of the elements of the table.
8190 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8191 (unless sorting-type
8192 (message
8193 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8194 what)
8195 (setq sorting-type (read-char-exclusive)))
8196 (let ((dcst (downcase sorting-type))
8197 extractfun comparefun)
8198 ;; Define the appropriate functions
8199 (cond
8200 ((= dcst ?n)
8201 (setq extractfun 'string-to-number
8202 comparefun (if (= dcst sorting-type) '< '>)))
8203 ((= dcst ?a)
8204 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8205 (lambda(x) (downcase (org-sort-remove-invisible x))))
8206 comparefun (if (= dcst sorting-type)
8207 'string<
8208 (lambda (a b) (and (not (string< a b))
8209 (not (string= a b)))))))
8210 ((= dcst ?t)
8211 (setq extractfun
8212 (lambda (x)
8213 (if (or (string-match org-ts-regexp x)
8214 (string-match org-ts-regexp-both x))
8215 (org-float-time
8216 (org-time-string-to-time (match-string 0 x)))
8217 0))
8218 comparefun (if (= dcst sorting-type) '< '>)))
8219 (t (error "Invalid sorting type `%c'" sorting-type)))
8221 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8222 table)
8223 (lambda (a b) (funcall comparefun (car a) (car b))))))
8226 ;;; The orgstruct minor mode
8228 ;; Define a minor mode which can be used in other modes in order to
8229 ;; integrate the org-mode structure editing commands.
8231 ;; This is really a hack, because the org-mode structure commands use
8232 ;; keys which normally belong to the major mode. Here is how it
8233 ;; works: The minor mode defines all the keys necessary to operate the
8234 ;; structure commands, but wraps the commands into a function which
8235 ;; tests if the cursor is currently at a headline or a plain list
8236 ;; item. If that is the case, the structure command is used,
8237 ;; temporarily setting many Org-mode variables like regular
8238 ;; expressions for filling etc. However, when any of those keys is
8239 ;; used at a different location, function uses `key-binding' to look
8240 ;; up if the key has an associated command in another currently active
8241 ;; keymap (minor modes, major mode, global), and executes that
8242 ;; command. There might be problems if any of the keys is otherwise
8243 ;; used as a prefix key.
8245 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8246 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8247 ;; addresses this by checking explicitly for both bindings.
8249 (defvar orgstruct-mode-map (make-sparse-keymap)
8250 "Keymap for the minor `orgstruct-mode'.")
8252 (defvar org-local-vars nil
8253 "List of local variables, for use by `orgstruct-mode'.")
8255 ;;;###autoload
8256 (define-minor-mode orgstruct-mode
8257 "Toggle the minor mode `orgstruct-mode'.
8258 This mode is for using Org-mode structure commands in other
8259 modes. The following keys behave as if Org-mode were active, if
8260 the cursor is on a headline, or on a plain list item (both as
8261 defined by Org-mode).
8263 M-up Move entry/item up
8264 M-down Move entry/item down
8265 M-left Promote
8266 M-right Demote
8267 M-S-up Move entry/item up
8268 M-S-down Move entry/item down
8269 M-S-left Promote subtree
8270 M-S-right Demote subtree
8271 M-q Fill paragraph and items like in Org-mode
8272 C-c ^ Sort entries
8273 C-c - Cycle list bullet
8274 TAB Cycle item visibility
8275 M-RET Insert new heading/item
8276 S-M-RET Insert new TODO heading / Checkbox item
8277 C-c C-c Set tags / toggle checkbox"
8278 nil " OrgStruct" nil
8279 (org-load-modules-maybe)
8280 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8282 ;;;###autoload
8283 (defun turn-on-orgstruct ()
8284 "Unconditionally turn on `orgstruct-mode'."
8285 (orgstruct-mode 1))
8287 (defvar org-fb-vars nil)
8288 (make-variable-buffer-local 'org-fb-vars)
8289 (defun orgstruct++-mode (&optional arg)
8290 "Toggle `orgstruct-mode', the enhanced version of it.
8291 In addition to setting orgstruct-mode, this also exports all
8292 indentation and autofilling variables from org-mode into the
8293 buffer. It will also recognize item context in multiline items."
8294 (interactive "P")
8295 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8296 (if (< arg 1)
8297 (progn (orgstruct-mode -1)
8298 (mapc (lambda(v)
8299 (org-set-local (car v)
8300 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8301 org-fb-vars))
8302 (orgstruct-mode 1)
8303 (setq org-fb-vars nil)
8304 (let (var val)
8305 (mapc
8306 (lambda (x)
8307 (when (string-match
8309 (symbol-name (car x)))
8310 (setq var (car x) val (nth 1 x))
8311 (push (list var `(quote ,(eval var))) org-fb-vars)
8312 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8313 org-local-vars)
8314 (org-set-local 'orgstruct-is-++ t))))
8316 (defvar orgstruct-is-++ nil
8317 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8318 (make-variable-buffer-local 'orgstruct-is-++)
8320 ;;;###autoload
8321 (defun turn-on-orgstruct++ ()
8322 "Unconditionally turn on `orgstruct++-mode'."
8323 (orgstruct++-mode 1))
8325 (defun orgstruct-error ()
8326 "Error when there is no default binding for a structure key."
8327 (interactive)
8328 (error "This key has no function outside structure elements"))
8330 (defun orgstruct-setup ()
8331 "Setup orgstruct keymaps."
8332 (let ((nfunc 0)
8333 (bindings
8334 (list
8335 '([(meta up)] org-metaup)
8336 '([(meta down)] org-metadown)
8337 '([(meta left)] org-metaleft)
8338 '([(meta right)] org-metaright)
8339 '([(meta shift up)] org-shiftmetaup)
8340 '([(meta shift down)] org-shiftmetadown)
8341 '([(meta shift left)] org-shiftmetaleft)
8342 '([(meta shift right)] org-shiftmetaright)
8343 '([?\e (up)] org-metaup)
8344 '([?\e (down)] org-metadown)
8345 '([?\e (left)] org-metaleft)
8346 '([?\e (right)] org-metaright)
8347 '([?\e (shift up)] org-shiftmetaup)
8348 '([?\e (shift down)] org-shiftmetadown)
8349 '([?\e (shift left)] org-shiftmetaleft)
8350 '([?\e (shift right)] org-shiftmetaright)
8351 '([(shift up)] org-shiftup)
8352 '([(shift down)] org-shiftdown)
8353 '([(shift left)] org-shiftleft)
8354 '([(shift right)] org-shiftright)
8355 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8356 '("\M-q" fill-paragraph)
8357 '("\C-c^" org-sort)
8358 '("\C-c-" org-cycle-list-bullet)))
8359 elt key fun cmd)
8360 (while (setq elt (pop bindings))
8361 (setq nfunc (1+ nfunc))
8362 (setq key (org-key (car elt))
8363 fun (nth 1 elt)
8364 cmd (orgstruct-make-binding fun nfunc key))
8365 (org-defkey orgstruct-mode-map key cmd))
8367 ;; Prevent an error for users who forgot to make autoloads
8368 (require 'org-element)
8370 ;; Special treatment needed for TAB and RET
8371 (org-defkey orgstruct-mode-map [(tab)]
8372 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8373 (org-defkey orgstruct-mode-map "\C-i"
8374 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8376 (org-defkey orgstruct-mode-map "\M-\C-m"
8377 (orgstruct-make-binding 'org-insert-heading 105
8378 "\M-\C-m" [(meta return)]))
8379 (org-defkey orgstruct-mode-map [(meta return)]
8380 (orgstruct-make-binding 'org-insert-heading 106
8381 [(meta return)] "\M-\C-m"))
8383 (org-defkey orgstruct-mode-map [(shift meta return)]
8384 (orgstruct-make-binding 'org-insert-todo-heading 107
8385 [(meta return)] "\M-\C-m"))
8387 (org-defkey orgstruct-mode-map "\e\C-m"
8388 (orgstruct-make-binding 'org-insert-heading 108
8389 "\e\C-m" [?\e (return)]))
8390 (org-defkey orgstruct-mode-map [?\e (return)]
8391 (orgstruct-make-binding 'org-insert-heading 109
8392 [?\e (return)] "\e\C-m"))
8393 (org-defkey orgstruct-mode-map [?\e (shift return)]
8394 (orgstruct-make-binding 'org-insert-todo-heading 110
8395 [?\e (return)] "\e\C-m"))
8397 (unless org-local-vars
8398 (setq org-local-vars (org-get-local-variables)))
8400 t))
8402 (defun orgstruct-make-binding (fun n &rest keys)
8403 "Create a function for binding in the structure minor mode.
8404 FUN is the command to call inside a table. N is used to create a unique
8405 command name. KEYS are keys that should be checked in for a command
8406 to execute outside of tables."
8407 (eval
8408 (list 'defun
8409 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8410 '(arg)
8412 "Outside of structure, run the binding of `"
8413 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8414 "'.")
8415 '(interactive "p")
8416 (list 'if
8417 `(org-context-p 'headline 'item
8418 (and orgstruct-is-++
8419 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8420 'item-body))
8421 (list 'org-run-like-in-org-mode (list 'quote fun))
8422 (list 'let '(orgstruct-mode)
8423 (list 'call-interactively
8424 (append '(or)
8425 (mapcar (lambda (k)
8426 (list 'key-binding k))
8427 keys)
8428 '('orgstruct-error))))))))
8430 (defun org-contextualize-keys (alist contexts)
8431 "Return valid elements in ALIST depending on CONTEXTS.
8433 `org-agenda-custom-commands' or `org-capture-templates' are the
8434 values used for ALIST, and `org-agenda-custom-commands-contexts'
8435 or `org-capture-templates-contexts' are the associated contexts
8436 definitions."
8437 (let ((contexts
8438 ;; normalize contexts
8439 (mapcar
8440 (lambda(c) (cond ((listp (cadr c))
8441 (list (car c) (car c) (cadr c)))
8442 ((string= "" (cadr c))
8443 (list (car c) (car c) (caddr c)))
8444 (t c))) contexts))
8445 (a alist) c r s)
8446 ;; loop over all commands or templates
8447 (while (setq c (pop a))
8448 (let (vrules repl)
8449 (cond
8450 ((not (assoc (car c) contexts))
8451 (push c r))
8452 ((and (assoc (car c) contexts)
8453 (setq vrules (org-contextualize-validate-key
8454 (car c) contexts)))
8455 (mapc (lambda (vr)
8456 (when (not (equal (car vr) (cadr vr)))
8457 (setq repl vr))) vrules)
8458 (if (not repl) (push c r)
8459 (push (cadr repl) s)
8460 (push
8461 (cons (car c)
8462 (cdr (or (assoc (cadr repl) alist)
8463 (error "Undefined key `%s' as contextual replacement for `%s'"
8464 (cadr repl) (car c)))))
8465 r))))))
8466 ;; Return limited ALIST, possibly with keys modified, and deduplicated
8467 (delq
8468 nil
8469 (delete-dups
8470 (mapcar (lambda (x)
8471 (let ((tpl (car x)))
8472 (when (not (delq
8473 nil
8474 (mapcar (lambda(y)
8475 (equal y tpl)) s))) x)))
8476 (reverse r))))))
8478 (defun org-contextualize-validate-key (key contexts)
8479 "Check CONTEXTS for agenda or capture KEY."
8480 (let (r rr res)
8481 (while (setq r (pop contexts))
8482 (mapc
8483 (lambda (rr)
8484 (when
8485 (and (equal key (car r))
8486 (if (functionp rr) (funcall rr)
8487 (or (and (eq (car rr) 'in-file)
8488 (buffer-file-name)
8489 (string-match (cdr rr) (buffer-file-name)))
8490 (and (eq (car rr) 'in-mode)
8491 (string-match (cdr rr) (symbol-name major-mode)))
8492 (when (and (eq (car rr) 'not-in-file)
8493 (buffer-file-name))
8494 (not (string-match (cdr rr) (buffer-file-name))))
8495 (when (eq (car rr) 'not-in-mode)
8496 (not (string-match (cdr rr) (symbol-name major-mode)))))))
8497 (push r res)))
8498 (car (last r))))
8499 (delete-dups (delq nil res))))
8501 (defun org-context-p (&rest contexts)
8502 "Check if local context is any of CONTEXTS.
8503 Possible values in the list of contexts are `table', `headline', and `item'."
8504 (let ((pos (point)))
8505 (goto-char (point-at-bol))
8506 (prog1 (or (and (memq 'table contexts)
8508 (and (memq 'headline contexts)
8509 (looking-at org-outline-regexp))
8510 (and (memq 'item contexts)
8512 (and (memq 'item-body contexts)
8513 (org-in-item-p)))
8514 (goto-char pos))))
8516 (defun org-get-local-variables ()
8517 "Return a list of all local variables in an Org mode buffer."
8518 (let (varlist)
8519 (with-current-buffer (get-buffer-create "*Org tmp*")
8520 (erase-buffer)
8521 (org-mode)
8522 (setq varlist (buffer-local-variables)))
8523 (kill-buffer "*Org tmp*")
8524 (delq nil
8525 (mapcar
8526 (lambda (x)
8527 (setq x
8528 (if (symbolp x)
8529 (list x)
8530 (list (car x) (list 'quote (cdr x)))))
8531 (if (string-match
8532 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
8533 (symbol-name (car x)))
8534 x nil))
8535 varlist))))
8537 (defun org-clone-local-variables (from-buffer &optional regexp)
8538 "Clone local variables from FROM-BUFFER.
8539 Optional argument REGEXP selects variables to clone."
8540 (mapc
8541 (lambda (pair)
8542 (and (symbolp (car pair))
8543 (or (null regexp)
8544 (string-match regexp (symbol-name (car pair))))
8545 (set (make-local-variable (car pair))
8546 (cdr pair))))
8547 (buffer-local-variables from-buffer)))
8549 ;;;###autoload
8550 (defun org-run-like-in-org-mode (cmd)
8551 "Run a command, pretending that the current buffer is in Org-mode.
8552 This will temporarily bind local variables that are typically bound in
8553 Org-mode to the values they have in Org-mode, and then interactively
8554 call CMD."
8555 (org-load-modules-maybe)
8556 (unless org-local-vars
8557 (setq org-local-vars (org-get-local-variables)))
8558 (eval (list 'let org-local-vars
8559 (list 'call-interactively (list 'quote cmd)))))
8561 ;;;; Archiving
8563 (defun org-get-category (&optional pos force-refresh)
8564 "Get the category applying to position POS."
8565 (save-match-data
8566 (if force-refresh (org-refresh-category-properties))
8567 (let ((pos (or pos (point))))
8568 (or (get-text-property pos 'org-category)
8569 (progn (org-refresh-category-properties)
8570 (get-text-property pos 'org-category))))))
8572 (defun org-refresh-category-properties ()
8573 "Refresh category text properties in the buffer."
8574 (let ((case-fold-search t)
8575 (inhibit-read-only t)
8576 (def-cat (cond
8577 ((null org-category)
8578 (if buffer-file-name
8579 (file-name-sans-extension
8580 (file-name-nondirectory buffer-file-name))
8581 "???"))
8582 ((symbolp org-category) (symbol-name org-category))
8583 (t org-category)))
8584 beg end cat pos optionp)
8585 (org-unmodified
8586 (save-excursion
8587 (save-restriction
8588 (widen)
8589 (goto-char (point-min))
8590 (put-text-property (point) (point-max) 'org-category def-cat)
8591 (while (re-search-forward
8593 (setq pos (match-end 0)
8594 optionp (equal (char-after (match-beginning 0)) ?#)
8595 cat (org-trim (match-string 2)))
8596 (if optionp
8597 (setq beg (point-at-bol) end (point-max))
8598 (org-back-to-heading t)
8599 (setq beg (point) end (org-end-of-subtree t t)))
8600 (put-text-property beg end 'org-category cat)
8601 (put-text-property beg end 'org-category-position beg)
8602 (goto-char pos)))))))
8605 ;;;; Link Stuff
8607 ;;; Link abbreviations
8609 (defun org-link-expand-abbrev (link)
8610 "Apply replacements as defined in `org-link-abbrev-alist'."
8612 (let* ((key (match-string 1 link))
8613 (as (or (assoc key org-link-abbrev-alist-local)
8614 (assoc key org-link-abbrev-alist)))
8615 (tag (and (match-end 2) (match-string 3 link)))
8616 rpl)
8617 (if (not as)
8618 link
8619 (setq rpl (cdr as))
8620 (cond
8621 ((symbolp rpl) (funcall rpl tag))
8623 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
8624 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8625 ((string-match "%h" rpl)
8626 (replace-match (url-hexify-string (or tag "")) t t rpl))
8627 (t (concat rpl tag)))))
8628 link))
8630 ;;; Storing and inserting links
8632 (defvar org-insert-link-history nil
8633 "Minibuffer history for links inserted with `org-insert-link'.")
8635 (defvar org-stored-links nil
8636 "Contains the links stored with `org-store-link'.")
8638 (defvar org-store-link-plist nil
8639 "Plist with info about the most recently link created with `org-store-link'.")
8641 (defvar org-link-protocols nil
8642 "Link protocols added to Org-mode using `org-add-link-type'.")
8644 (defvar org-store-link-functions nil
8645 "List of functions that are called to create and store a link.
8646 Each function will be called in turn until one returns a non-nil
8647 value. Each function should check if it is responsible for creating
8648 this link (for example by looking at the major mode).
8649 If not, it must exit and return nil.
8650 If yes, it should return a non-nil value after a calling
8651 `org-store-link-props' with a list of properties and values.
8652 Special properties are:
8656 This is obligatory as well.
8657 :description Optional default description for the second pair
8658 of brackets in an Org-mode link. The user can still change
8659 this when inserting this link into an Org-mode buffer.
8661 In addition to these, any additional properties can be specified
8662 and then used in capture templates.")
8664 (defun org-add-link-type (type &optional follow export)
8665 "Add TYPE to the list of `org-link-types'.
8666 Re-compute all regular expressions depending on `org-link-types'
8668 FOLLOW and EXPORT are two functions.
8670 FOLLOW should take the link path as the single argument and do whatever
8671 is necessary to follow the link, for example find a file or display
8672 a mail message.
8674 EXPORT should format the link path for export to one of the export formats.
8675 It should be a function accepting three arguments:
8678 desc the description of the link, if any, or a description added by
8679 org-export-normalize-links if there is none
8680 format the export format, a symbol like `html' or `latex' or `ascii'..
8682 The function may use the FORMAT information to return different values
8683 depending on the format. The return value will be put literally into
8684 the exported file. If the return value is nil, this means Org should
8685 do what it normally does with links which do not have EXPORT defined.
8687 Org-mode has a built-in default for exporting links. If you are happy with
8688 this default, there is no need to define an export function for the link
8689 type. For a simple example of an export function, see `org-bbdb.el'."
8690 (add-to-list 'org-link-types type t)
8691 (org-make-link-regexps)
8692 (if (assoc type org-link-protocols)
8693 (setcdr (assoc type org-link-protocols) (list follow export))
8694 (push (list type follow export) org-link-protocols)))
8696 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
8697 (defvar org-link-to-org-use-id) ; Defined in org-id.el
8699 ;;;###autoload
8700 (defun org-store-link (arg)
8702 This link is added to `org-stored-links' and can later be inserted
8705 For some link types, a prefix arg is interpreted:
8706 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8707 For file links, arg negates `org-context-in-file-links'."
8708 (interactive "P")
8709 (org-load-modules-maybe)
8710 (setq org-store-link-plist nil) ; reset
8711 (org-with-limited-levels
8712 (let (link cpltxt desc description search txt custom-id agenda-link)
8713 (cond
8715 ((run-hook-with-args-until-success 'org-store-link-functions)
8716 (setq link (plist-get org-store-link-plist :link)
8717 desc (or (plist-get org-store-link-plist :description) link)))
8719 ((org-src-edit-buffer-p)
8720 (let (label gc)
8721 (while (or (not label)
8722 (save-excursion
8723 (save-restriction
8724 (widen)
8725 (goto-char (point-min))
8726 (re-search-forward
8727 (regexp-quote (format org-coderef-label-format label))
8728 nil t))))
8729 (when label (message "Label exists already") (sit-for 2))
8730 (setq label (read-string "Code line label: " label)))
8731 (end-of-line 1)
8732 (setq link (format org-coderef-label-format label))
8733 (setq gc (- 79 (length link)))
8734 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8735 (insert link)
8736 (setq link (concat "(" label ")") desc nil)))
8738 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8739 ;; We are in the agenda, link to referenced location
8740 (let ((m (or (get-text-property (point) 'org-hd-marker)
8741 (get-text-property (point) 'org-marker))))
8742 (when m
8743 (org-with-point-at m
8744 (setq agenda-link
8745 (if (org-called-interactively-p 'any)
8746 (call-interactively 'org-store-link)
8747 (org-store-link nil)))))))
8749 ((eq major-mode 'calendar-mode)
8750 (let ((cd (calendar-cursor-to-date)))
8751 (setq link
8752 (format-time-string
8753 (car org-time-stamp-formats)
8754 (apply 'encode-time
8755 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8756 nil nil nil))))
8757 (org-store-link-props :type "calendar" :date cd)))
8759 ((eq major-mode 'help-mode)
8760 (setq link (concat "help:" (save-excursion
8761 (goto-char (point-min))
8762 (looking-at "^[^ ]+")
8763 (match-string 0))))
8764 (org-store-link-props :type "help"))
8766 ((eq major-mode 'w3-mode)
8767 (setq cpltxt (if (and (buffer-name)
8768 (not (string-match "Untitled" (buffer-name))))
8769 (buffer-name)
8770 (url-view-url t))
8771 link (url-view-url t))
8772 (org-store-link-props :type "w3" :url (url-view-url t)))
8774 ((eq major-mode 'w3m-mode)
8775 (setq cpltxt (or w3m-current-title w3m-current-url)
8776 link w3m-current-url)
8777 (org-store-link-props :type "w3m" :url (url-view-url t)))
8779 ((setq search (run-hook-with-args-until-success
8780 'org-create-file-search-functions))
8781 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8782 "::" search))
8783 (setq cpltxt (or description link)))
8785 ((eq major-mode 'image-mode)
8786 (setq cpltxt (concat "file:"
8787 (abbreviate-file-name buffer-file-name))
8788 link cpltxt)
8789 (org-store-link-props :type "image" :file buffer-file-name))
8791 ((eq major-mode 'dired-mode)
8792 ;; link to the file in the current line
8793 (let ((file (dired-get-filename nil t)))
8794 (setq file (if file
8795 (abbreviate-file-name
8796 (expand-file-name (dired-get-filename nil t)))
8797 ;; otherwise, no file so use current directory.
8798 default-directory))
8799 (setq cpltxt (concat "file:" file)
8800 link cpltxt)))
8802 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
8803 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8804 (cond
8806 (setq cpltxt
8807 (concat "file:"
8808 (abbreviate-file-name
8809 (buffer-file-name (buffer-base-buffer)))
8810 "::" (match-string 1))
8811 link cpltxt))
8812 ((and (featurep 'org-id)
8813 (or (eq org-link-to-org-use-id t)
8814 (and (org-called-interactively-p 'any)
8815 (or (eq org-link-to-org-use-id 'create-if-interactive)
8816 (and (eq org-link-to-org-use-id
8817 'create-if-interactive-and-no-custom-id)
8818 (not custom-id))))
8819 (and org-link-to-org-use-id (org-entry-get nil "ID"))))
8820 ;; We can make a link using the ID.
8821 (setq link (condition-case nil
8822 (prog1 (org-id-store-link)
8823 (setq desc (plist-get org-store-link-plist :description)))
8824 (error
8825 ;; probably before first headline, link to file only
8826 (concat "file:"
8827 (abbreviate-file-name
8828 (buffer-file-name (buffer-base-buffer))))))))
8829 (t
8830 ;; Just link to current headline
8831 (setq cpltxt (concat "file:"
8832 (abbreviate-file-name
8833 (buffer-file-name (buffer-base-buffer)))))
8834 ;; Add a context search string
8835 (when (org-xor org-context-in-file-links arg)
8836 (setq txt (cond
8837 ((org-at-heading-p) nil)
8838 ((org-region-active-p)
8839 (buffer-substring (region-beginning) (region-end)))))
8841 (setq cpltxt
8842 (concat cpltxt "::"
8843 (condition-case nil
8844 (org-make-org-heading-search-string txt)
8845 (error "")))
8846 desc (or (nth 4 (ignore-errors
8847 (org-heading-components))) "NONE"))))
8849 (setq cpltxt (substring cpltxt 0 -2)))
8850 (setq link cpltxt))))
8852 ((buffer-file-name (buffer-base-buffer))
8853 ;; Just link to this file here.
8854 (setq cpltxt (concat "file:"
8855 (abbreviate-file-name
8856 (buffer-file-name (buffer-base-buffer)))))
8857 ;; Add a context string
8858 (when (org-xor org-context-in-file-links arg)
8859 (setq txt (if (org-region-active-p)
8860 (buffer-substring (region-beginning) (region-end))
8861 (buffer-substring (point-at-bol) (point-at-eol))))
8862 ;; Only use search option if there is some text.
8864 (setq cpltxt
8865 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8866 desc "NONE")))
8867 (setq link cpltxt))
8869 ((org-called-interactively-p 'interactive)
8870 (error "Cannot link to a buffer which is not visiting a file"))
8872 (t (setq link nil)))
8874 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8875 (setq link (or link cpltxt)
8876 desc (or desc cpltxt))
8877 (if (equal desc "NONE") (setq desc nil))
8879 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8880 (progn
8881 (setq org-stored-links
8882 (cons (list link desc) org-stored-links))
8883 (message "Stored: %s" (or desc link))
8884 (when custom-id
8885 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8886 "::#" custom-id))
8887 (setq org-stored-links
8888 (cons (list link desc) org-stored-links))))
8889 (or agenda-link (and link (org-make-link-string link desc)))))))
8891 (defun org-store-link-props (&rest plist)
8892 "Store link properties, extract names and addresses."
8893 (let (x adr)
8894 (when (setq x (plist-get plist :from))
8895 (setq adr (mail-extract-address-components x))
8896 (setq plist (plist-put plist :fromname (car adr)))
8897 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8898 (when (setq x (plist-get plist :to))
8899 (setq adr (mail-extract-address-components x))
8900 (setq plist (plist-put plist :toname (car adr)))
8901 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8902 (let ((from (plist-get plist :from))
8903 (to (plist-get plist :to)))
8904 (when (and from to org-from-is-user-regexp)
8905 (setq plist
8906 (plist-put plist :fromto
8907 (if (string-match org-from-is-user-regexp from)
8908 (concat "to %t")
8909 (concat "from %f"))))))
8910 (setq org-store-link-plist plist))
8912 (defun org-add-link-props (&rest plist)
8913 "Add these properties to the link property list."
8914 (let (key value)
8915 (while plist
8916 (setq key (pop plist) value (pop plist))
8917 (setq org-store-link-plist
8918 (plist-put org-store-link-plist key value)))))
8920 (defun org-email-link-description (&optional fmt)
8921 "Return the description part of an email link.
8922 This takes information from `org-store-link-plist' and formats it
8923 according to FMT (default from `org-email-link-description-format')."
8924 (setq fmt (or fmt org-email-link-description-format))
8925 (let* ((p org-store-link-plist)
8926 (to (plist-get p :toaddress))
8927 (from (plist-get p :fromaddress))
8928 (table
8929 (list
8930 (cons "%c" (plist-get p :fromto))
8931 (cons "%F" (plist-get p :from))
8932 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8933 (cons "%T" (plist-get p :to))
8934 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8935 (cons "%s" (plist-get p :subject))
8936 (cons "%d" (plist-get p :date))
8937 (cons "%m" (plist-get p :message-id)))))
8938 (when (string-match "%c" fmt)
8939 ;; Check if the user wrote this message
8940 (if (and org-from-is-user-regexp from to
8941 (save-match-data (string-match org-from-is-user-regexp from)))
8942 (setq fmt (replace-match "to %t" t t fmt))
8943 (setq fmt (replace-match "from %f" t t fmt))))
8944 (org-replace-escapes fmt table)))
8946 (defun org-make-org-heading-search-string (&optional string heading)
8947 "Make search string for STRING or current headline."
8948 (interactive)
8949 (let ((s (or string (org-get-heading)))
8950 (lines org-context-in-file-links))
8951 (unless (and string (not heading))
8952 ;; We are using a headline, clean up garbage in there.
8953 (if (string-match org-todo-regexp s)
8954 (setq s (replace-match "" t t s)))
8956 (setq s (replace-match "" t t s)))
8957 (setq s (org-trim s))
8960 (setq s (replace-match "" t t s)))
8961 (while (string-match org-ts-regexp s)
8962 (setq s (replace-match "" t t s))))
8963 (or string (setq s (concat "*" s))) ; Add * for headlines
8964 (when (and string (integerp lines) (> lines 0))
8966 (when (< lines (length slines))
8967 (setq s (mapconcat
8968 'identity
8969 (reverse (nthcdr (- (length slines) lines)
8973 (defun org-make-link-string (link &optional description)
8974 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8976 (error "Empty link"))
8977 (when (and description
8978 (stringp description)
8980 (setq description nil))
8981 (when (stringp description)
8982 ;; Remove brackets from the description, they are fatal.
8984 (setq description (replace-match "{" t t description)))
8986 (setq description (replace-match "}" t t description))))
8987 (when (equal link description)
8988 ;; No description needed, it is identical
8989 (setq description nil))
8990 (when (and (not description)
8991 (not (string-match (org-image-file-name-regexp) link))
8992 (not (equal link (org-link-escape link))))
8993 (setq description (org-extract-attributes link)))
8994 (setq link
8995 (cond ((string-match (org-image-file-name-regexp) link) link)
8996 ((string-match org-link-types-re link)
8997 (concat (match-string 1 link)
8998 (org-link-escape (substring link (match-end 1)))))
8999 (t (org-link-escape link))))
9000 (concat "[[" link "]"
9001 (if description (concat "[" description "]") "")
9002 "]"))
9004 (defconst org-link-escape-chars
9005 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9006 "List of characters that should be escaped in link.
9007 This is the list that is used for internal purposes.")
9009 (defconst org-link-escape-chars-browser
9010 '(?\ )
9011 "List of escapes for characters that are problematic in links.
9012 This is the list that is used before handing over to the browser.")
9014 (defun org-link-escape (text &optional table merge)
9015 "Return percent escaped representation of TEXT.
9016 TEXT is a string with the text to escape.
9017 Optional argument TABLE is a list with characters that should be
9018 escaped. When nil, `org-link-escape-chars' is used.
9019 If optional argument MERGE is set, merge TABLE into
9020 `org-link-escape-chars'."
9021 (cond
9022 ((and table merge)
9023 (mapc (lambda (defchr)
9024 (unless (member defchr table)
9025 (setq table (cons defchr table)))) org-link-escape-chars))
9026 ((null table)
9027 (setq table org-link-escape-chars)))
9028 (mapconcat
9029 (lambda (char)
9030 (if (or (member char table)
9031 (and (or (< char 32) (= char 37) (> char 126))
9032 org-url-hexify-p))
9033 (mapconcat (lambda (sequence-element)
9034 (format "%%%.2X" sequence-element))
9035 (or (encode-coding-char char 'utf-8)
9036 (error "Unable to percent escape character: %s"
9037 (char-to-string char))) "")
9038 (char-to-string char))) text ""))
9040 (defun org-link-unescape (str)
9041 "Unhex hexified Unicode strings as returned from the JavaScript function
9042 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
9043 (unless (and (null str) (string= "" str))
9044 (let ((pos 0) (case-fold-search t) unhexed)
9046 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9047 (setq str (replace-match unhexed t t str))
9048 (setq pos (+ pos (length unhexed))))))
9049 str)
9051 (defun org-link-unescape-compound (hex)
9052 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
9053 Note: this function also decodes single byte encodings like
9055 (save-match-data
9056 (let* ((bytes (cdr (split-string hex "%")))
9057 (ret "")
9058 (eat 0)
9059 (sum 0))
9060 (while bytes
9061 (let* ((val (string-to-number (pop bytes) 16))
9062 (shift-xor
9063 (if (= 0 eat)
9064 (cond
9065 ((>= val 252) (cons 6 252))
9066 ((>= val 248) (cons 5 248))
9067 ((>= val 240) (cons 4 240))
9068 ((>= val 224) (cons 3 224))
9069 ((>= val 192) (cons 2 192))
9070 (t (cons 0 0)))
9071 (cons 6 128))))
9072 (if (>= val 192) (setq eat (car shift-xor)))
9073 (setq val (logxor val (cdr shift-xor)))
9074 (setq sum (+ (lsh sum (car shift-xor)) val))
9075 (if (> eat 0) (setq eat (- eat 1)))
9076 (cond
9077 ((= 0 eat) ;multi byte
9078 (setq ret (concat ret (org-char-to-string sum)))
9079 (setq sum 0))
9080 ((not bytes) ; single byte(s)
9081 (setq ret (org-link-unescape-single-byte-sequence hex))))
9082 )) ;; end (while bytes
9083 ret )))
9085 (defun org-link-unescape-single-byte-sequence (hex)
9086 "Unhexify hex-encoded single byte character sequences."
9087 (mapconcat (lambda (byte)
9088 (char-to-string (string-to-number byte 16)))
9089 (cdr (split-string hex "%")) ""))
9091 (defun org-xor (a b)
9092 "Exclusive or."
9093 (if a (not b) b))
9095 (defun org-fixup-message-id-for-http (s)
9096 "Replace special characters in a message id, so it can be used in an http query."
9097 (when (string-match "%" s)
9098 (setq s (mapconcat (lambda (c)
9099 (if (eq c ?%)
9100 "%25"
9101 (char-to-string c)))
9102 s "")))
9103 (while (string-match "<" s)
9104 (setq s (replace-match "%3C" t t s)))
9105 (while (string-match ">" s)
9106 (setq s (replace-match "%3E" t t s)))
9107 (while (string-match "@" s)
9108 (setq s (replace-match "%40" t t s)))
9109 s)
9111 (defun org-link-prettify (link)
9112 "Return a human-readable representation of LINK.
9113 The car of LINK must be a raw link the cdr of LINK must be either
9114 a link description or nil."
9115 (let ((desc (or (cadr link) "<no description>")))
9116 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9117 "<" (car link) ">")))
9119 ;;;###autoload
9120 (defun org-insert-link-global ()
9121 "Insert a link like Org-mode does.
9122 This command can be called in any mode to insert a link in Org-mode syntax."
9123 (interactive)
9124 (org-load-modules-maybe)
9125 (org-run-like-in-org-mode 'org-insert-link))
9127 (defun org-insert-all-links (&optional keep)
9128 "Insert all links in `org-stored-links'."
9129 (interactive "P")
9130 (let ((links (copy-sequence org-stored-links)) l)
9131 (while (setq l (if keep (pop links) (pop org-stored-links)))
9132 (insert "- ")
9133 (org-insert-link nil (car l) (cadr l))
9136 (defun org-link-fontify-links-to-this-file ()
9137 "Fontify links to the current file in `org-stored-links'."
9138 (let ((f (buffer-file-name)) a b)
9139 (setq a (mapcar (lambda(l)
9140 (let ((ll (car l)))
9142 (equal f (expand-file-name (match-string 1 ll))))
9143 ll)))
9144 org-stored-links))
9145 (when (featurep 'org-id)
9146 (setq b (mapcar (lambda(l)
9147 (let ((ll (car l)))
9149 (equal f (expand-file-name
9150 (or (org-id-find-id-file
9151 (match-string 1 ll)) ""))))
9152 ll)))
9153 org-stored-links)))
9154 (mapcar (lambda(l)
9155 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9156 (delq nil (append a b)))))
9158 (defvar org-link-links-in-this-file nil)
9159 (defun org-insert-link (&optional complete-file link-location default-description)
9160 "Insert a link. At the prompt, enter the link.
9162 Completion can be used to insert any of the link protocol prefixes like
9163 http or ftp in use.
9165 The history can be used to select a link previously stored with
9166 `org-store-link'. When the empty string is entered (i.e. if you just
9167 press RET at the prompt), the link defaults to the most recently
9168 stored link. As SPC triggers completion in the minibuffer, you need to
9169 use M-SPC or C-q SPC to force the insertion of a space character.
9171 You will also be prompted for a description, and if one is given, it will
9172 be displayed in the buffer instead of the link.
9174 If there is already a link at point, this command will allow you to edit link
9175 and description parts.
9178 be selected using completion. The path to the file will be relative to the
9179 current directory if the file is in the current directory or a subdirectory.
9180 Otherwise, the link will be the absolute path as completed in the minibuffer
9181 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9182 option `org-link-file-path-type'.
9185 the current directory or below.
9188 `org-keep-stored-link-after-insertion'.
9190 If `org-make-link-description-function' is non-nil, this function will be
9191 called with the link target, and the result will be the default
9192 link description.
9194 If the LINK-LOCATION parameter is non-nil, this value will be
9195 used as the link location instead of reading one interactively.
9197 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9198 be used as the default description."
9199 (interactive "P")
9200 (let* ((wcf (current-window-configuration))
9201 (region (if (org-region-active-p)
9202 (buffer-substring (region-beginning) (region-end))))
9203 (remove (and region (list (region-beginning) (region-end))))
9204 (desc region)
9205 tmphist ; byte-compile incorrectly complains about this
9206 (link link-location)
9207 (abbrevs org-link-abbrev-alist-local)
9208 entry file all-prefixes auto-desc)
9209 (cond
9210 (link-location) ; specified by arg, just use it.
9211 ((org-in-regexp org-bracket-link-regexp 1)
9212 ;; We do have a link at point, and we are going to edit it.
9213 (setq remove (list (match-beginning 0) (match-end 0)))
9214 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9215 (setq link (read-string "Link: "
9216 (org-link-unescape
9217 (org-match-string-no-properties 1)))))
9218 ((or (org-in-regexp org-angle-link-re)
9219 (org-in-regexp org-plain-link-re))
9220 ;; Convert to bracket link
9221 (setq remove (list (match-beginning 0) (match-end 0))
9222 link (read-string "Link: "
9223 (org-remove-angle-brackets (match-string 0)))))
9224 ((member complete-file '((4) (16)))
9225 ;; Completing read for file names.
9226 (setq link (org-file-complete-link complete-file)))
9227 (t
9228 ;; Read link, with completion for stored links.
9229 (org-link-fontify-links-to-this-file)
9230 (org-switch-to-buffer-other-window "*Org Links*")
9231 (with-current-buffer "*Org Links*"
9232 (erase-buffer)
9233 (insert "Insert a link.
9235 (when org-stored-links
9237 (insert (mapconcat 'org-link-prettify
9239 (goto-char (point-min)))
9240 (let ((cw (selected-window)))
9241 (select-window (get-buffer-window "*Org Links*" 'visible))
9242 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9243 (unless (pos-visible-in-window-p (point-max))
9244 (org-fit-window-to-buffer))
9245 (and (window-live-p cw) (select-window cw)))
9246 ;; Fake a link history, containing the stored links.
9247 (setq tmphist (append (mapcar 'car org-stored-links)
9248 org-insert-link-history))
9249 (setq all-prefixes (append (mapcar 'car abbrevs)
9250 (mapcar 'car org-link-abbrev-alist)
9251 org-link-types))
9252 (unwind-protect
9253 (progn
9254 (setq link
9255 (let ((org-completion-use-ido nil)
9256 (org-completion-use-iswitchb nil))
9257 (org-completing-read
9258 "Link: "
9259 (append
9260 (mapcar (lambda (x) (list (concat x ":")))
9261 all-prefixes)
9262 (mapcar 'car org-stored-links)
9263 (mapcar 'cadr org-stored-links))
9264 nil nil nil
9265 'tmphist
9266 (caar org-stored-links))))
9268 (error "No link selected"))
9269 (mapc (lambda(l)
9270 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9271 org-stored-links)
9272 (if (or (member link all-prefixes)
9273 (and (equal ":" (substring link -1))
9274 (member (substring link 0 -1) all-prefixes)
9275 (setq link (substring link 0 -1))))
9276 (setq link (org-link-try-special-completion link))))
9277 (set-window-configuration wcf)
9278 (kill-buffer "*Org Links*"))
9279 (setq entry (assoc link org-stored-links))
9280 (or entry (push link org-insert-link-history))
9281 (setq desc (or desc (nth 1 entry)))))
9283 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9284 (not org-keep-stored-link-after-insertion))
9285 (setq org-stored-links (delq (assoc link org-stored-links)
9286 org-stored-links)))
9288 (if (string-match org-plain-link-re link)
9289 ;; URL-like link, normalize the use of angular brackets.
9290 (setq link (org-remove-angle-brackets link)))
9292 ;; Check if we are linking to the current file with a search option
9293 ;; If yes, simplify the link by using only the search option.
9294 (when (and buffer-file-name
9296 (let* ((path (match-string 1 link))
9297 (case-fold-search nil)
9298 (search (match-string 2 link)))
9299 (save-match-data
9300 (if (equal (file-truename buffer-file-name) (file-truename path))
9301 ;; We are linking to this same file, with a search option
9302 (setq link search)))))
9304 ;; Check if we can/should use a relative path. If yes, simplify the link
9306 (let* ((type (match-string 1 link))
9307 (path (match-string 2 link))
9308 (origpath path)
9309 (case-fold-search nil))
9310 (cond
9311 ((or (eq org-link-file-path-type 'absolute)
9312 (equal complete-file '(16)))
9313 (setq path (abbreviate-file-name (expand-file-name path))))
9314 ((eq org-link-file-path-type 'noabbrev)
9315 (setq path (expand-file-name path)))
9316 ((eq org-link-file-path-type 'relative)
9317 (setq path (file-relative-name path)))
9318 (t
9319 (save-match-data
9320 (if (string-match (concat "^" (regexp-quote
9321 (expand-file-name
9322 (file-name-as-directory
9323 default-directory))))
9324 (expand-file-name path))
9325 ;; We are linking a file with relative path name.
9326 (setq path (substring (expand-file-name path)
9327 (match-end 0)))
9328 (setq path (abbreviate-file-name (expand-file-name path)))))))
9329 (setq link (concat type path))
9330 (if (equal desc origpath)
9331 (setq desc path))))
9333 (if org-make-link-description-function
9334 (setq desc
9335 (or (condition-case nil
9336 (funcall org-make-link-description-function link desc)
9337 (error (progn (message "Can't get link description from `%s'"
9338 (symbol-name org-make-link-description-function))
9339 (sit-for 2) nil)))
9340 (read-string "Description: " default-description)))
9341 (if default-description (setq desc default-description)
9342 (setq desc (or (and auto-desc desc)
9343 (read-string "Description: " desc)))))
9346 (if remove (apply 'delete-region remove))
9347 (insert (org-make-link-string link desc))))
9349 (defun org-link-try-special-completion (type)
9350 "If there is completion support for link type TYPE, offer it."
9351 (let ((fun (intern (concat "org-" type "-complete-link"))))
9352 (if (functionp fun)
9353 (funcall fun)
9354 (read-string "Link (no completion support): " (concat type ":")))))
9356 (defun org-file-complete-link (&optional arg)
9357 "Create a file link using completion."
9358 (let (file link)
9359 (setq file (read-file-name "File: "))
9360 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9361 (pwd1 (file-name-as-directory (abbreviate-file-name
9362 (expand-file-name ".")))))
9363 (cond
9364 ((equal arg '(16))
9365 (setq link (concat
9366 "file:"
9367 (abbreviate-file-name (expand-file-name file)))))
9369 (setq link (concat "file:" (match-string 1 file))))
9371 (expand-file-name file))
9372 (setq link (concat
9373 "file:" (match-string 1 (expand-file-name file)))))
9374 (t (setq link (concat "file:" file)))))
9375 link))
9377 (defun org-completing-read (&rest args)
9378 "Completing-read with SPACE being a normal character."
9379 (let ((enable-recursive-minibuffers t)
9380 (minibuffer-local-completion-map
9381 (copy-keymap minibuffer-local-completion-map)))
9382 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9383 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9384 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9385 (apply 'org-icompleting-read args)))
9387 (defun org-completing-read-no-i (&rest args)
9388 (let (org-completion-use-ido org-completion-use-iswitchb)
9389 (apply 'org-completing-read args)))
9391 (defun org-iswitchb-completing-read (prompt choices &rest args)
9392 "Use iswitch as a completing-read replacement to choose from choices.
9393 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9394 from."
9395 (let* ((iswitchb-use-virtual-buffers nil)
9396 (iswitchb-make-buflist-hook
9397 (lambda ()
9398 (setq iswitchb-temp-buflist choices))))
9399 (iswitchb-read-buffer prompt)))
9401 (defun org-icompleting-read (&rest args)
9402 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9403 (org-without-partial-completion
9404 (if (and org-completion-use-ido
9405 (fboundp 'ido-completing-read)
9406 (boundp 'ido-mode) ido-mode
9407 (listp (second args)))
9408 (let ((ido-enter-matching-directory nil))
9409 (apply 'ido-completing-read (concat (car args))
9410 (if (consp (car (nth 1 args)))
9411 (mapcar 'car (nth 1 args))
9412 (nth 1 args))
9413 (cddr args)))
9414 (if (and org-completion-use-iswitchb
9415 (boundp 'iswitchb-mode) iswitchb-mode
9416 (listp (second args)))
9417 (apply 'org-iswitchb-completing-read (concat (car args))
9418 (if (consp (car (nth 1 args)))
9419 (mapcar 'car (nth 1 args))
9420 (nth 1 args))
9421 (cddr args))
9422 (apply 'completing-read args)))))
9424 (defun org-extract-attributes (s)
9425 "Extract the attributes cookie from a string and set as text property."
9426 (let (a attr (start 0) key value)
9427 (save-match-data
9429 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9431 (setq key (match-string 1 a) value (match-string 2 a)
9432 start (match-end 0)
9433 attr (plist-put attr (intern key) value))))
9434 (org-add-props s nil 'org-attr attr))
9435 s))
9437 (defun org-extract-attributes-from-string (tag)
9438 (let (key value attr)
9440 (setq key (match-string 1 tag) value (match-string 2 tag)
9441 tag (replace-match "" t t tag)
9442 attr (plist-put attr (intern key) value)))
9443 (cons tag attr)))
9445 (defun org-attributes-to-string (plist)
9446 "Format a property list into an HTML attribute list."
9447 (let ((s "") key value)
9448 (while plist
9449 (setq key (pop plist) value (pop plist))
9450 (and value
9452 s))
9454 ;;; Opening/following a link
9456 (defvar org-link-search-failed nil)
9458 (defvar org-open-link-functions nil
9459 "Hook for functions finding a plain text link.
9460 These functions must take a single argument, the link content.
9461 They will be called for links that look like [[link text][description]]
9465 These functions will be called *before* Org attempts to resolve the
9466 link by doing text searches in the current buffer - so if you want a
9468 handle this as a special case.
9470 When the function does handle the link, it must return a non-nil value.
9471 If it decides that it is not responsible for this link, it must return
9472 nil to indicate that that Org-mode can continue with other options
9473 like exact and fuzzy text search.")
9475 (defun org-next-link ()
9476 "Move forward to the next link.
9477 If the link is in hidden text, expose it."
9478 (interactive)
9479 (when (and org-link-search-failed (eq this-command last-command))
9480 (goto-char (point-min))
9481 (message "Link search wrapped back to beginning of buffer"))
9482 (setq org-link-search-failed nil)
9483 (let* ((pos (point))
9484 (ct (org-context))
9485 (a (assoc :link ct)))
9486 (if a (goto-char (nth 2 a)))
9487 (if (re-search-forward org-any-link-re nil t)
9488 (progn
9489 (goto-char (match-beginning 0))
9490 (if (outline-invisible-p) (org-show-context)))
9491 (goto-char pos)
9492 (setq org-link-search-failed t)
9493 (error "No further link found"))))
9495 (defun org-previous-link ()
9496 "Move backward to the previous link.
9497 If the link is in hidden text, expose it."
9498 (interactive)
9499 (when (and org-link-search-failed (eq this-command last-command))
9500 (goto-char (point-max))
9501 (message "Link search wrapped back to end of buffer"))
9502 (setq org-link-search-failed nil)
9503 (let* ((pos (point))
9504 (ct (org-context))
9505 (a (assoc :link ct)))
9506 (if a (goto-char (nth 1 a)))
9507 (if (re-search-backward org-any-link-re nil t)
9508 (progn
9509 (goto-char (match-beginning 0))
9510 (if (outline-invisible-p) (org-show-context)))
9511 (goto-char pos)
9512 (setq org-link-search-failed t)
9513 (error "No further link found"))))
9515 (defun org-translate-link (s)
9516 "Translate a link string if a translation function has been defined."
9517 (if (and org-link-translation-function
9518 (fboundp org-link-translation-function)
9520 (progn
9521 (setq s (funcall org-link-translation-function
9522 (match-string 1 s) (match-string 2 s)))
9523 (concat (car s) ":" (cdr s)))
9524 s))
9526 (defun org-translate-link-from-planner (type path)
9527 "Translate a link from Emacs Planner syntax so that Org can follow it.
9528 This is still an experimental function, your mileage may vary."
9529 (cond
9530 ((member type '("http" "https" "news" "ftp"))
9531 ;; standard Internet links are the same.
9532 nil)
9533 ((and (equal type "irc") (string-match "^//" path))
9534 ;; Planner has two / at the beginning of an irc link, we have 1.
9535 ;; We should have zero, actually....
9536 (setq path (substring path 1)))
9537 ((and (equal type "lisp") (string-match "^/" path))
9538 ;; Planner has a slash, we do not.
9539 (setq type "elisp" path (substring path 1)))
9541 ;; A typical message link. Planner has the id after the final slash,
9542 ;; we separate it with a hash mark
9543 (setq path (concat (match-string 1 path) "#"
9544 (org-remove-angle-brackets (match-string 2 path)))))
9545 )
9546 (cons type path))
9548 (defun org-find-file-at-mouse (ev)
9549 "Open file link or URL at mouse."
9550 (interactive "e")
9551 (mouse-set-point ev)
9552 (org-open-at-point 'in-emacs))
9554 (defun org-open-at-mouse (ev)
9555 "Open file link or URL at mouse.
9556 See the docstring of `org-open-file' for details."
9557 (interactive "e")
9558 (mouse-set-point ev)
9559 (if (eq major-mode 'org-agenda-mode)
9560 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9561 (org-open-at-point))
9563 (defvar org-window-config-before-follow-link nil
9564 "The window configuration before following a link.
9565 This is saved in case the need arises to restore it.")
9567 (defvar org-open-link-marker (make-marker)
9568 "Marker pointing to the location where `org-open-at-point; was called.")
9570 ;;;###autoload
9571 (defun org-open-at-point-global ()
9572 "Follow a link like Org-mode does.
9573 This command can be called in any mode to follow a link that has
9574 Org-mode syntax."
9575 (interactive)
9576 (org-run-like-in-org-mode 'org-open-at-point))
9578 ;;;###autoload
9579 (defun org-open-link-from-string (s &optional arg reference-buffer)
9580 "Open a link in the string S, as if it was in Org-mode."
9582 (let ((reference-buffer (or reference-buffer (current-buffer))))
9583 (with-temp-buffer
9584 (let ((org-inhibit-startup (not reference-buffer)))
9585 (org-mode)
9586 (insert s)
9587 (goto-char (point-min))
9588 (when reference-buffer
9589 (setq org-link-abbrev-alist-local
9590 (with-current-buffer reference-buffer
9591 org-link-abbrev-alist-local)))
9592 (org-open-at-point arg reference-buffer)))))
9594 (defvar org-open-at-point-functions nil
9595 "Hook that is run when following a link at point.
9597 Functions in this hook must return t if they identify and follow
9598 a link at point. If they don't find anything interesting at point,
9599 they must return nil.")
9601 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
9602 (defun org-open-at-point (&optional arg reference-buffer)
9603 "Open link at or after point.
9604 If there is no link at point, this function will search forward up to
9605 the end of the current line.
9606 Normally, files will be opened by an appropriate application. If the
9607 optional prefix argument ARG is non-nil, Emacs will visit the file.
9608 With a double prefix argument, try to open outside of Emacs, in the
9609 application the system uses for this file type."
9610 (interactive "P")
9611 ;; if in a code block, then open the block's results
9612 (unless (call-interactively #'org-babel-open-src-block-result)
9613 (org-load-modules-maybe)
9614 (move-marker org-open-link-marker (point))
9615 (setq org-window-config-before-follow-link (current-window-configuration))
9616 (org-remove-occur-highlights nil nil t)
9617 (cond
9618 ((and (org-at-heading-p)
9619 (not (org-at-timestamp-p t))
9620 (not (org-in-regexp
9625 (not (get-text-property (point) 'org-linked-text)))
9626 (or (org-offer-links-in-entry arg)
9627 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9628 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9629 ((and (org-at-timestamp-p t)
9630 (not (org-in-regexp org-bracket-link-regexp)))
9631 (org-follow-timestamp-link))
9632 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9633 (not (org-in-regexp org-bracket-link-regexp)))
9634 (org-footnote-action))
9635 (t
9636 (let (type path link line search (pos (point)))
9637 (catch 'match
9638 (save-excursion
9640 (when (org-in-regexp org-bracket-link-regexp 1)
9641 (setq link (org-extract-attributes
9642 (org-link-unescape (org-match-string-no-properties 1))))
9644 (setq link (replace-match " " t t link)))
9645 (setq link (org-link-expand-abbrev link))
9646 (cond
9647 ((or (file-name-absolute-p link)
9649 (setq type "file" path link))
9650 ((string-match org-link-re-with-space3 link)
9651 (setq type (match-string 1 link) path (match-string 2 link)))
9653 (setq type "help" path (match-string 1 link)))
9654 (t (setq type "thisfile" path link)))
9655 (throw 'match t)))
9657 (when (get-text-property (point) 'org-linked-text)
9658 (setq type "thisfile"
9659 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9660 (1+ (point)) (point))
9661 path (buffer-substring
9662 (or (previous-single-property-change pos 'org-linked-text)
9663 (point-min))
9664 (or (next-single-property-change pos 'org-linked-text)
9665 (point-max))))
9666 (throw 'match t))
9668 (save-excursion
9669 (when (or (org-in-regexp org-angle-link-re)
9670 (and (goto-char (car (org-in-regexp org-plain-link-re)))
9672 (setq type (match-string 1)
9673 path (org-link-unescape (match-string 2)))
9674 (throw 'match t)))
9675 (save-excursion
9677 (setq type "tags"
9678 path (match-string 1))
9679 (while (string-match ":" path)
9680 (setq path (replace-match "+" t t path)))
9681 (throw 'match t)))
9683 (setq type "tree-match"
9684 path (match-string 1))
9685 (throw 'match t)))
9686 (unless path
9687 (error "No link found"))
9689 ;; switch back to reference buffer
9690 ;; needed when if called in a temporary buffer through
9691 ;; org-open-link-from-string
9692 (with-current-buffer (or reference-buffer (current-buffer))
9694 ;; Remove any trailing spaces in path
9696 (setq path (replace-match "" t t path)))
9697 (if (and org-link-translation-function
9698 (fboundp org-link-translation-function))
9699 ;; Check if we need to translate the link
9700 (let ((tmp (funcall org-link-translation-function type path)))
9701 (setq type (car tmp) path (cdr tmp))))
9703 (cond
9705 ((assoc type org-link-protocols)
9706 (funcall (nth 1 (assoc type org-link-protocols)) path))
9708 ((equal type "help")
9709 (let ((f-or-v (intern path)))
9710 (cond ((fboundp f-or-v)
9711 (describe-function f-or-v))
9712 ((boundp f-or-v)
9713 (describe-variable f-or-v))
9714 (t (error "Not a known function or variable")))))
9716 ((equal type "mailto")
9717 (let ((cmd (car org-link-mailto-program))
9718 (args (cdr org-link-mailto-program)) args1
9719 (address path) (subject "") a)
9721 (setq address (match-string 1 path)
9722 subject (org-link-escape (match-string 2 path))))
9723 (while args
9724 (cond
9725 ((not (stringp (car args))) (push (pop args) args1))
9726 (t (setq a (pop args))
9727 (if (string-match "%a" a)
9728 (setq a (replace-match address t t a)))
9729 (if (string-match "%s" a)
9730 (setq a (replace-match subject t t a)))
9731 (push a args1))))
9732 (apply cmd (nreverse args1))))
9734 ((member type '("http" "https" "ftp" "news"))
9735 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9736 (org-link-escape
9737 path org-link-escape-chars-browser)
9738 path))))
9740 ((string= type "doi")
9741 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
9742 (org-link-escape
9743 path org-link-escape-chars-browser)
9744 path))))
9746 ((member type '("message"))
9747 (browse-url (concat type ":" path)))
9749 ((string= type "tags")
9750 (org-tags-view arg path))
9752 ((string= type "tree-match")
9755 ((string= type "file")
9757 (setq line (string-to-number (match-string 1 path))
9758 path (substring path 0 (match-beginning 0)))
9760 (setq search (match-string 1 path)
9761 path (substring path 0 (match-beginning 0)))))
9762 (if (string-match "[*?{]" (file-name-nondirectory path))
9763 (dired path)
9764 (org-open-file path arg line search)))
9766 ((string= type "shell")
9767 (let ((buf (generate-new-buffer "*Org Shell Output"))
9768 (cmd path))
9769 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9770 (string-match org-confirm-shell-link-not-regexp cmd))
9771 (not org-confirm-shell-link-function)
9772 (funcall org-confirm-shell-link-function
9774 (org-add-props cmd nil
9775 'face 'org-warning))))
9776 (progn
9777 (message "Executing %s" cmd)
9778 (shell-command cmd buf)
9779 (if (featurep 'midnight)
9780 (setq clean-buffer-list-kill-buffer-names
9781 (cons buf clean-buffer-list-kill-buffer-names))))
9782 (error "Abort"))))
9784 ((string= type "elisp")
9785 (let ((cmd path))
9786 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9787 (string-match org-confirm-elisp-link-not-regexp cmd))
9788 (not org-confirm-elisp-link-function)
9789 (funcall org-confirm-elisp-link-function
9791 (org-add-props cmd nil
9792 'face 'org-warning))))
9793 (message "%s => %s" cmd
9794 (if (equal (string-to-char cmd) ?\()
9795 (eval (read cmd))
9796 (call-interactively (read cmd))))
9797 (error "Abort"))))
9799 ((and (string= type "thisfile")
9800 (run-hook-with-args-until-success
9801 'org-open-link-functions path)))
9803 ((string= type "thisfile")
9804 (if arg
9805 (switch-to-buffer-other-window
9806 (org-get-buffer-for-internal-link (current-buffer)))
9807 (org-mark-ring-push))
9808 (let ((cmd `(org-link-search
9809 ,path
9810 ,(cond ((equal arg '(4)) ''occur)
9811 ((equal arg '(16)) ''org-occur))
9812 ,pos)))
9813 (condition-case nil (let ((org-link-search-inhibit-query t))
9814 (eval cmd))
9815 (error (progn (widen) (eval cmd))))))
9817 (t (browse-url-at-point)))))))
9818 (move-marker org-open-link-marker nil)
9819 (run-hook-with-args 'org-follow-link-hook)))
9821 (defun org-offer-links-in-entry (&optional nth zero)
9822 "Offer links in the current entry and follow the selected link.
9823 If there is only one link, follow it immediately as well.
9824 If NTH is an integer, immediately pick the NTH link found.
9825 If ZERO is a string, check also this string for a link, and if
9826 there is one, offer it as link number zero."
9830 (cnt ?0)
9831 (in-emacs (if (integerp nth) nil nth))
9832 have-zero end links link c)
9833 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9834 (push (match-string 0 zero) links)
9835 (setq cnt (1- cnt) have-zero t))
9836 (save-excursion
9837 (org-back-to-heading t)
9838 (setq end (save-excursion (outline-next-heading) (point)))
9839 (while (re-search-forward re end t)
9840 (push (match-string 0) links))
9841 (setq links (org-uniquify (reverse links))))
9843 (cond
9844 ((null links)
9845 (message "No links"))
9846 ((equal (length links) 1)
9847 (setq link (list (car links))))
9848 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9849 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9850 (t ; we have to select a link
9851 (save-excursion
9852 (save-window-excursion
9853 (delete-other-windows)
9854 (with-output-to-temp-buffer "*Select Link*"
9855 (mapc (lambda (l)
9856 (if (not (string-match org-bracket-link-regexp l))
9858 (org-remove-angle-brackets l)))
9859 (if (match-end 3)
9861 (match-string 3 l) (match-string 1 l)))
9863 (match-string 1 l))))))
9864 links))
9865 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9866 (message "Select link to open, RET to open all:")
9867 (setq c (read-char-exclusive))
9868 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9869 (when (equal c ?q) (error "Abort"))
9870 (if (equal c ?\C-m)
9871 (setq link links)
9872 (setq nth (- c ?0))
9873 (if have-zero (setq nth (1+ nth)))
9874 (unless (and (integerp nth) (>= (length links) nth))
9875 (error "Invalid link selection"))
9876 (setq link (list (nth (1- nth) links))))))
9877 (if link
9878 (let ((buf (current-buffer)))
9879 (dolist (l link)
9880 (org-open-link-from-string l in-emacs buf))
9881 t)
9882 nil)))
9884 ;; Add special file links that specify the way of opening
9886 (org-add-link-type "file+sys" 'org-open-file-with-system)
9887 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9888 (defun org-open-file-with-system (path)
9889 "Open file at PATH using the system way of opening it."
9890 (org-open-file path 'system))
9891 (defun org-open-file-with-emacs (path)
9892 "Open file at PATH in Emacs."
9893 (org-open-file path 'emacs))
9894 (defun org-remove-file-link-modifiers ()
9895 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9896 (goto-char (point-min))
9898 (org-if-unprotected
9899 (replace-match "file:" t t))))
9900 (eval-after-load "org-exp"
9901 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9902 'org-remove-file-link-modifiers))
9904 ;;;; Time estimates
9906 (defun org-get-effort (&optional pom)
9907 "Get the effort estimate for the current entry."
9908 (org-entry-get pom org-effort-property))
9910 ;;; File search
9912 (defvar org-create-file-search-functions nil
9913 "List of functions to construct the right search string for a file link.
9914 These functions are called in turn with point at the location to
9915 which the link should point.
9917 A function in the hook should first test if it would like to
9918 handle this file type, for example by checking the `major-mode'
9919 or the file extension. If it decides not to handle this file, it
9920 should just return nil to give other functions a chance. If it
9921 does handle the file, it must return the search string to be used
9922 when following the link. The search string will be part of the
9923 file link, given after a double colon, and `org-open-at-point'
9924 will automatically search for it. If special measures must be
9925 taken to make the search successful, another function should be
9926 added to the companion hook `org-execute-file-search-functions',
9927 which see.
9929 A function in this hook may also use `setq' to set the variable
9930 `description' to provide a suggestion for the descriptive text to
9931 be used for this link when it gets inserted into an Org-mode
9934 (defvar org-execute-file-search-functions nil
9935 "List of functions to execute a file search triggered by a link.
9937 Functions added to this hook must accept a single argument, the
9938 search string that was part of the file link, the part after the
9939 double colon. The function must first check if it would like to
9940 handle this search, for example by checking the `major-mode' or
9941 the file extension. If it decides not to handle this search, it
9942 should just return nil to give other functions a chance. If it
9943 does handle the search, it must return a non-nil value to keep
9944 other functions from trying.
9946 Each function can access the current prefix argument through the
9947 variable `current-prefix-argument'. Note that a single prefix is
9948 used to force opening a link in Emacs, so it may be good to only
9949 use a numeric or double prefix to guide the search function.
9951 In case this is needed, a function in this hook can also restore
9952 the window configuration before `org-open-at-point' was called using:
9954 (set-window-configuration org-window-config-before-follow-link)")
9956 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9957 (defun org-link-search (s &optional type avoid-pos stealth)
9958 "Search for a link search option.
9959 If S is surrounded by forward slashes, it is interpreted as a
9960 regular expression. In org-mode files, this will create an `org-occur'
9961 sparse tree. In ordinary files, `occur' will be used to list matches.
9962 If the current buffer is in `dired-mode', grep will be used to search
9963 in all files. If AVOID-POS is given, ignore matches near that position.
9965 When optional argument STEALTH is non-nil, do not modify
9966 visibility around point, thus ignoring
9967 `org-show-hierarchy-above', `org-show-following-heading' and
9968 `org-show-siblings' variables."
9969 (let ((case-fold-search t)
9973 org-emphasis-alist)
9975 (pos (point))
9976 (pre nil) (post nil)
9977 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9978 (cond
9979 ;; First check if there are any special search functions
9980 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9981 ;; Now try the builtin stuff
9982 ((and (equal (string-to-char s0) ?#)
9983 (> (length s0) 1)
9984 (save-excursion
9985 (goto-char (point-min))
9986 (and
9987 (re-search-forward
9989 (setq type 'dedicated
9990 pos (match-beginning 0))))
9991 ;; There is an exact target for this
9992 (goto-char pos)
9993 (org-back-to-heading t)))
9994 ((save-excursion
9995 (goto-char (point-min))
9996 (and
9997 (re-search-forward
9998 (concat "<<" (regexp-quote s0) ">>") nil t)
9999 (setq type 'dedicated
10000 pos (match-beginning 0))))
10001 ;; There is an exact target for this
10002 (goto-char pos))
10003 ((save-excursion
10004 (goto-char (point-min))
10005 (and
10006 (re-search-forward
10008 (setq type 'dedicated pos (match-beginning 0))))
10009 ;; Found an invisible target.
10010 (goto-char pos))
10011 ((save-excursion
10012 (goto-char (point-min))
10013 (and
10014 (re-search-forward
10016 (setq type 'dedicated pos (match-beginning 0))))
10017 ;; Found an element with a matching #+name affiliated keyword.
10018 (goto-char pos))
10020 (save-excursion
10021 (goto-char (point-min))
10022 (and
10023 (re-search-forward
10024 (concat "[^[]" (regexp-quote
10025 (format org-coderef-label-format
10026 (match-string 1 s0))))
10027 nil t)
10028 (setq type 'dedicated
10029 pos (1+ (match-beginning 0))))))
10030 ;; There is a coderef target for this
10031 (goto-char pos))
10033 ;; A regular expression
10034 (cond
10035 ((derived-mode-p 'org-mode)
10036 (org-occur (match-string 1 s)))
10037 ;;((eq major-mode 'dired-mode)
10038 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
10039 (t (org-do-occur (match-string 1 s)))))
10040 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10041 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10042 (goto-char (point-min))
10043 (cond
10044 ((let (case-fold-search)
10045 (re-search-forward (format org-complex-heading-regexp-format
10046 (regexp-quote s))
10047 nil t))
10048 ;; OK, found a match
10049 (setq type 'dedicated)
10050 (goto-char (match-beginning 0)))
10051 ((and (not org-link-search-inhibit-query)
10052 (eq org-link-search-must-match-exact-headline 'query-to-create)
10053 (y-or-n-p "No match - create this as a new heading? "))
10054 (goto-char (point-max))
10055 (or (bolp) (newline))
10057 (beginning-of-line 0))
10058 (t
10059 (goto-char pos)
10060 (error "No match"))))
10061 (t
10062 ;; A normal search string
10063 (when (equal (string-to-char s) ?*)
10064 ;; Anchor on headlines, post may include tags.
10067 s (substring s 1)))
10068 (remove-text-properties
10069 0 (length s)
10070 '(face nil mouse-face nil keymap nil fontified nil) s)
10071 ;; Make a series of regular expressions to find a match
10080 re4 (concat "[^a-zA-Z_]" re4_)
10082 re1 (concat pre re2 post)
10083 re3 (concat pre (if pre re4_ re4) post)
10084 re5 (concat pre ".*" re4)
10085 re2 (concat pre re2)
10086 re2a (concat pre (if pre re2a_ re2a))
10087 re4 (concat pre (if pre re4_ re4))
10091 ))
10092 (cond
10093 ((eq type 'org-occur) (org-occur reall))
10094 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10095 (t (goto-char (point-min))
10096 (setq type 'fuzzy)
10097 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10098 (org-search-not-self 1 re1 nil t)
10099 (org-search-not-self 1 re2 nil t)
10100 (org-search-not-self 1 re2a nil t)
10101 (org-search-not-self 1 re3 nil t)
10102 (org-search-not-self 1 re4 nil t)
10103 (org-search-not-self 1 re5 nil t)
10104 )
10105 (goto-char (match-beginning 1))
10106 (goto-char pos)
10107 (error "No match"))))))
10108 (and (derived-mode-p 'org-mode)
10109 (not stealth)
10110 (org-show-context 'link-search))
10111 type))
10113 (defun org-search-not-self (group &rest args)
10114 "Execute `re-search-forward', but only accept matches that do not
10115 enclose the position of `org-open-link-marker'."
10116 (let ((m org-open-link-marker))
10117 (catch 'exit
10118 (while (apply 're-search-forward args)
10119 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10120 (goto-char (match-end group))
10121 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10122 (> (match-beginning 0) (marker-position m))
10123 (< (match-end 0) (marker-position m)))
10124 (save-match-data
10125 (or (not (org-in-regexp
10126 org-bracket-link-analytic-regexp 1))
10127 (not (match-end 4)) ; no description
10128 (and (<= (match-beginning 4) (point))
10129 (>= (match-end 4) (point))))))
10130 (throw 'exit (point))))))))
10132 (defun org-get-buffer-for-internal-link (buffer)
10133 "Return a buffer to be used for displaying the link target of internal links."
10134 (cond
10135 ((not org-display-internal-link-with-indirect-buffer)
10136 buffer)
10137 ((string-match "(Clone)$" (buffer-name buffer))
10138 (message "Buffer is already a clone, not making another one")
10139 ;; we also do not modify visibility in this case
10140 buffer)
10141 (t ; make a new indirect buffer for displaying the link
10142 (let* ((bn (buffer-name buffer))
10143 (ibn (concat bn "(Clone)"))
10144 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10145 (with-current-buffer ib (org-overview))
10146 ib))))
10148 (defun org-do-occur (regexp &optional cleanup)
10149 "Call the Emacs command `occur'.
10150 If CLEANUP is non-nil, remove the printout of the regular expression
10151 in the *Occur* buffer. This is useful if the regex is long and not useful
10152 to read."
10153 (occur regexp)
10154 (when cleanup
10155 (let ((cwin (selected-window)) win beg end)
10156 (when (setq win (get-buffer-window "*Occur*"))
10157 (select-window win))
10158 (goto-char (point-min))
10159 (when (re-search-forward "match[a-z]+" nil t)
10160 (setq beg (match-end 0))
10162 (setq end (1- (match-beginning 0)))))
10163 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10164 (goto-char (point-min))
10165 (select-window cwin))))
10167 ;;; The mark ring for links jumps
10169 (defvar org-mark-ring nil
10170 "Mark ring for positions before jumps in Org-mode.")
10171 (defvar org-mark-ring-last-goto nil
10172 "Last position in the mark ring used to go back.")
10173 ;; Fill and close the ring
10174 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10175 (loop for i from 1 to org-mark-ring-length do
10176 (push (make-marker) org-mark-ring))
10177 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10178 org-mark-ring)
10180 (defun org-mark-ring-push (&optional pos buffer)
10181 "Put the current position or POS into the mark ring and rotate it."
10182 (interactive)
10183 (setq pos (or pos (point)))
10184 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10185 (move-marker (car org-mark-ring)
10186 (or pos (point))
10187 (or buffer (current-buffer)))
10188 (message "%s"
10189 (substitute-command-keys
10192 (defun org-mark-ring-goto (&optional n)
10193 "Jump to the previous position in the mark ring.
10194 With prefix arg N, jump back that many stored positions. When
10195 called several times in succession, walk through the entire ring.
10196 Org-mode commands jumping to a different position in the current file,
10197 or to another Org-mode file, automatically push the old position
10198 onto the ring."
10199 (interactive "p")
10200 (let (p m)
10201 (if (eq last-command this-command)
10202 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10203 (setq p org-mark-ring))
10204 (setq org-mark-ring-last-goto p)
10205 (setq m (car p))
10206 (org-pop-to-buffer-same-window (marker-buffer m))
10207 (goto-char m)
10208 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10210 (defun org-remove-angle-brackets (s)
10211 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10212 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10213 s)
10214 (defun org-add-angle-brackets (s)
10215 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10216 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10217 s)
10218 (defun org-remove-double-quotes (s)
10221 s)
10223 ;;; Following specific links
10225 (defun org-follow-timestamp-link ()
10226 "Open an agenda view for the time-stamp date/range at point."
10227 (cond
10228 ((org-at-date-range-p t)
10229 (let ((org-agenda-start-on-weekday)
10230 (t1 (match-string 1))
10231 (t2 (match-string 2)) tt1 tt2)
10232 (setq tt1 (time-to-days (org-time-string-to-time t1))
10233 tt2 (time-to-days (org-time-string-to-time t2)))
10234 (let ((org-agenda-buffer-tmp-name
10235 (format "*Org Agenda(a:%s)"
10236 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10237 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10238 ((org-at-timestamp-p t)
10239 (let ((org-agenda-buffer-tmp-name
10240 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10241 (org-agenda-list nil (time-to-days (org-time-string-to-time
10242 (substring (match-string 1) 0 10)))
10243 1)))
10244 (t (error "This should not happen"))))
10247 ;;; Following file links
10248 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10249 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10250 (declare-function mailcap-mime-info
10251 "mailcap" (string &optional request no-decode))
10252 (defvar org-wait nil)
10253 (defun org-open-file (path &optional in-emacs line search)
10254 "Open the file at PATH.
10255 First, this expands any special file name abbreviations. Then the
10256 configuration variable `org-file-apps' is checked if it contains an
10257 entry for this file type, and if yes, the corresponding command is launched.
10259 If no application is found, Emacs simply visits the file.
10261 With optional prefix argument IN-EMACS, Emacs will visit the file.
10263 prefix arg, Org tries to avoid opening in Emacs
10264 and to use an external application to visit the file.
10266 Optional LINE specifies a line to go to, optional SEARCH a string
10267 to search for. If LINE or SEARCH is given, the file will be
10268 opened in Emacs, unless an entry from org-file-apps that makes
10269 use of groups in a regexp matches.
10271 If you want to change the way frames are used when following a
10272 link, please customize `org-link-frame-setup'.
10274 If the file does not exist, an error is thrown."
10275 (let* ((file (if (equal path "")
10276 buffer-file-name
10277 (substitute-in-file-name (expand-file-name path))))
10278 (file-apps (append org-file-apps (org-default-apps)))
10279 (apps (org-remove-if
10280 'org-file-apps-entry-match-against-dlink-p file-apps))
10281 (apps-dlink (org-remove-if-not
10282 'org-file-apps-entry-match-against-dlink-p file-apps))
10283 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10284 (dirp (if remp nil (file-directory-p file)))
10285 (file (if (and dirp org-open-directory-means-index-dot-org)
10286 (concat (file-name-as-directory file) "index.org")
10287 file))
10288 (a-m-a-p (assq 'auto-mode apps))
10289 (dfile (downcase file))
10290 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10291 (link (cond ((and (eq line nil)
10292 (eq search nil))
10293 file)
10294 (line
10295 (concat file "::" (number-to-string line)))
10296 (search
10297 (concat file "::" search))))
10298 (dlink (downcase link))
10299 (old-buffer (current-buffer))
10300 (old-pos (point))
10301 (old-mode major-mode)
10302 ext cmd link-match-data)
10304 (setq ext (match-string 1 dfile))
10306 (setq ext (match-string 1 dfile))))
10307 (cond
10308 ((member in-emacs '((16) system))
10309 (setq cmd (cdr (assoc 'system apps))))
10310 (in-emacs (setq cmd 'emacs))
10311 (t
10312 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10313 (and dirp (cdr (assoc 'directory apps)))
10314 ; first, try matching against apps-dlink
10315 ; if we get a match here, store the match data for later
10316 (let ((match (assoc-default dlink apps-dlink
10317 'string-match)))
10318 (if match
10319 (progn (setq link-match-data (match-data))
10320 match)
10321 (progn (setq in-emacs (or in-emacs line search))
10322 nil))) ; if we have no match in apps-dlink,
10323 ; always open the file in emacs if line or search
10324 ; is given (for backwards compatibility)
10325 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10326 'string-match)
10327 (cdr (assoc ext apps))
10328 (cdr (assoc t apps))))))
10329 (when (eq cmd 'system)
10330 (setq cmd (cdr (assoc 'system apps))))
10331 (when (eq cmd 'default)
10332 (setq cmd (cdr (assoc t apps))))
10333 (when (eq cmd 'mailcap)
10334 (require 'mailcap)
10335 (mailcap-parse-mailcaps)
10336 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10337 (command (mailcap-mime-info mime-type)))
10338 (if (stringp command)
10339 (setq cmd command)
10340 (setq cmd 'emacs))))
10341 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10342 (not (file-exists-p file))
10343 (not org-open-non-existing-files))
10344 (error "No such file: %s" file))
10345 (cond
10347 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10349 (setq cmd (replace-match "%s" t t cmd)))
10350 (while (string-match "%s" cmd)
10351 (setq cmd (replace-match
10352 (save-match-data
10353 (shell-quote-argument
10354 (convert-standard-filename file)))
10355 t t cmd)))
10357 ;; Replace "%1", "%2" etc. in command with group matches from regex
10358 (save-match-data
10359 (let ((match-index 1)
10360 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10361 (set-match-data link-match-data)
10362 (while (<= match-index number-of-groups)
10363 (let ((regex (concat "%" (number-to-string match-index)))
10364 (replace-with (match-string match-index dlink)))
10365 (while (string-match regex cmd)
10366 (setq cmd (replace-match replace-with t t cmd))))
10367 (setq match-index (+ match-index 1)))))
10369 (save-window-excursion
10370 (start-process-shell-command cmd nil cmd)
10371 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10372 ))
10373 ((or (stringp cmd)
10374 (eq cmd 'emacs))
10375 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10376 (widen)
10377 (if line (org-goto-line line)
10378 (if search (org-link-search search))))
10379 ((consp cmd)
10380 (let ((file (convert-standard-filename file)))
10381 (save-match-data
10382 (set-match-data link-match-data)
10383 (eval cmd))))
10384 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10385 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10386 (or (not (equal old-buffer (current-buffer)))
10387 (not (equal old-pos (point))))
10388 (org-mark-ring-push old-pos old-buffer))))
10390 (defun org-file-apps-entry-match-against-dlink-p (entry)
10391 "This function returns non-nil if `entry' uses a regular
10392 expression which should be matched against the whole link by
10393 org-open-file.
10395 It assumes that is the case when the entry uses a regular
10396 expression which has at least one grouping construct and the
10397 action is either a lisp form or a command string containing
10398 '%1', i.e. using at least one subexpression match as a
10399 parameter."
10400 (let ((selector (car entry))
10401 (action (cdr entry)))
10402 (if (stringp selector)
10403 (and (> (regexp-opt-depth selector) 0)
10404 (or (and (stringp action)
10405 (string-match "%[0-9]" action))
10406 (consp action)))
10407 nil)))
10409 (defun org-default-apps ()
10410 "Return the default applications for this operating system."
10411 (cond
10412 ((eq system-type 'darwin)
10413 org-file-apps-defaults-macosx)
10414 ((eq system-type 'windows-nt)
10415 org-file-apps-defaults-windowsnt)
10416 (t org-file-apps-defaults-gnu)))
10418 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10419 "Convert extensions to regular expressions in the cars of LIST.
10420 Also, weed out any non-string entries, because the return value is used
10421 only for regexp matching.
10422 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10423 point to the symbol `emacs', indicating that the file should
10424 be opened in Emacs."
10425 (append
10426 (delq nil
10427 (mapcar (lambda (x)
10428 (if (not (stringp (car x)))
10429 nil
10431 x
10433 list))
10434 (if add-auto-mode
10435 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10437 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10438 (defun org-file-remote-p (file)
10439 "Test whether FILE specifies a location on a remote system.
10440 Return non-nil if the location is indeed remote.
10444 (cond ((fboundp 'file-remote-p)
10445 (file-remote-p file))
10446 ((fboundp 'tramp-handle-file-remote-p)
10447 (tramp-handle-file-remote-p file))
10448 ((and (boundp 'ange-ftp-name-format)
10449 (string-match (car ange-ftp-name-format) file))
10450 t)))
10453 ;;;; Refiling
10455 (defun org-get-org-file ()
10456 "Read a filename, with default directory `org-directory'."
10457 (let ((default (or org-default-notes-file remember-data-file)))
10458 (read-file-name (format "File name [%s]: " default)
10459 (file-name-as-directory org-directory)
10460 default)))
10462 (defun org-notes-order-reversed-p ()
10463 "Check if the current file should receive notes in reversed order."
10464 (cond
10465 ((not org-reverse-note-order) nil)
10466 ((eq t org-reverse-note-order) t)
10467 ((not (listp org-reverse-note-order)) nil)
10468 (t (catch 'exit
10469 (let ((all org-reverse-note-order)
10470 entry)
10471 (while (setq entry (pop all))
10472 (if (string-match (car entry) buffer-file-name)
10473 (throw 'exit (cdr entry))))
10474 nil)))))
10476 (defvar org-refile-target-table nil
10477 "The list of refile targets, created by `org-refile'.")
10479 (defvar org-agenda-new-buffers nil
10480 "Buffers created to visit agenda files.")
10482 (defvar org-refile-cache nil
10483 "Cache for refile targets.")
10485 (defvar org-refile-markers nil
10486 "All the markers used for caching refile locations.")
10488 (defun org-refile-marker (pos)
10489 "Get a new refile marker, but only if caching is in use."
10490 (if (not org-refile-use-cache)
10491 pos
10492 (let ((m (make-marker)))
10493 (move-marker m pos)
10494 (push m org-refile-markers)
10495 m)))
10497 (defun org-refile-cache-clear ()
10498 "Clear the refile cache and disable all the markers."
10499 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10500 (setq org-refile-markers nil)
10501 (setq org-refile-cache nil)
10502 (message "Refile cache has been cleared"))
10504 (defun org-refile-cache-check-set (set)
10505 "Check if all the markers in the cache still have live buffers."
10506 (let (marker)
10507 (catch 'exit
10508 (while (and set (setq marker (nth 3 (pop set))))
10509 ;; if org-refile-use-outline-path is 'file, marker may be nil
10510 (when (and marker (null (marker-buffer marker)))
10511 (message "not found") (sit-for 3)
10512 (throw 'exit nil)))
10513 t)))
10515 (defun org-refile-cache-put (set &rest identifiers)
10516 "Push the refile targets SET into the cache, under IDENTIFIERS."
10517 (let* ((key (sha1 (prin1-to-string identifiers)))
10518 (entry (assoc key org-refile-cache)))
10519 (if entry
10520 (setcdr entry set)
10521 (push (cons key set) org-refile-cache))))
10523 (defun org-refile-cache-get (&rest identifiers)
10524 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10525 (cond
10526 ((not org-refile-cache) nil)
10527 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10528 (t
10529 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10530 org-refile-cache))))
10531 (and set (org-refile-cache-check-set set) set)))))
10533 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10534 "Produce a table with refile targets."
10535 (let ((case-fold-search nil)
10536 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10537 (entries (or org-refile-targets '((nil . (:level . 1)))))
10538 targets tgs txt re files f desc descre fast-path-p level pos0)
10539 (message "Getting targets...")
10540 (with-current-buffer (or default-buffer (current-buffer))
10541 (while (setq entry (pop entries))
10542 (setq files (car entry) desc (cdr entry))
10543 (setq fast-path-p nil)
10544 (cond
10545 ((null files) (setq files (list (current-buffer))))
10546 ((eq files 'org-agenda-files)
10547 (setq files (org-agenda-files 'unrestricted)))
10548 ((and (symbolp files) (fboundp files))
10549 (setq files (funcall files)))
10550 ((and (symbolp files) (boundp files))
10551 (setq files (symbol-value files))))
10552 (if (stringp files) (setq files (list files)))
10553 (cond
10554 ((eq (car desc) :tag)
10556 ((eq (car desc) :todo)
10558 ((eq (car desc) :regexp)
10559 (setq descre (cdr desc)))
10560 ((eq (car desc) :level)
10562 (if org-odd-levels-only
10563 (1- (* 2 (cdr desc)))
10564 (cdr desc)))
10566 ((eq (car desc) :maxlevel)
10567 (setq fast-path-p t)
10569 (if org-odd-levels-only
10570 (1- (* 2 (cdr desc)))
10571 (cdr desc)))
10573 (t (error "Bad refiling target description %s" desc)))
10574 (while (setq f (pop files))
10575 (with-current-buffer
10576 (if (bufferp f) f (org-get-agenda-file-buffer f))
10577 (or
10578 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10579 (progn
10580 (if (bufferp f) (setq f (buffer-file-name
10581 (buffer-base-buffer f))))
10582 (setq f (and f (expand-file-name f)))
10583 (if (eq org-refile-use-outline-path 'file)
10584 (push (list (file-name-nondirectory f) f nil nil) tgs))
10585 (save-excursion
10586 (save-restriction
10587 (widen)
10588 (goto-char (point-min))
10589 (while (re-search-forward descre nil t)
10590 (goto-char (setq pos0 (point-at-bol)))
10591 (catch 'next
10592 (when org-refile-target-verify-function
10593 (save-match-data
10594 (or (funcall org-refile-target-verify-function)
10595 (throw 'next t))))
10596 (when (and (looking-at org-complex-heading-regexp)
10597 (not (member (match-string 4) excluded-entries))
10598 (match-string 4))
10599 (setq level (org-reduced-level
10600 (- (match-end 1) (match-beginning 1)))
10601 txt (org-link-display-format (match-string 4))
10603 re (format org-complex-heading-regexp-format
10604 (regexp-quote (match-string 4))))
10605 (when org-refile-use-outline-path
10606 (setq txt (mapconcat
10607 'org-protect-slash
10608 (append
10609 (if (eq org-refile-use-outline-path
10610 'file)
10611 (list (file-name-nondirectory
10612 (buffer-file-name
10613 (buffer-base-buffer))))
10614 (if (eq org-refile-use-outline-path
10615 'full-file-path)
10616 (list (buffer-file-name
10617 (buffer-base-buffer)))))
10618 (org-get-outline-path fast-path-p
10619 level txt)
10620 (list txt))
10621 "/")))
10622 (push (list txt f re (org-refile-marker (point)))
10623 tgs)))
10624 (when (= (point) pos0)
10625 ;; verification function has not moved point
10626 (goto-char (point-at-eol))))))))
10627 (when org-refile-use-cache
10628 (org-refile-cache-put tgs (buffer-file-name) descre))
10629 (setq targets (append tgs targets))
10630 ))))
10631 (message "Getting targets...done")
10632 (nreverse targets)))
10634 (defun org-protect-slash (s)
10635 (while (string-match "/" s)
10637 s)
10639 (defvar org-olpa (make-vector 20 nil))
10641 (defun org-get-outline-path (&optional fastp level heading)
10642 "Return the outline path to the current entry, as a list.
10644 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10645 routine which makes outline path derivations for an entire file,
10646 avoiding backtracing. Refile target collection makes use of that."
10647 (if fastp
10648 (progn
10649 (if (> level 19)
10650 (error "Outline path failure, more than 19 levels"))
10651 (loop for i from level upto 19 do
10652 (aset org-olpa i nil))
10653 (prog1
10654 (delq nil (append org-olpa nil))
10655 (aset org-olpa level heading)))
10656 (let (rtn case-fold-search)
10657 (save-excursion
10658 (save-restriction
10659 (widen)
10660 (while (org-up-heading-safe)
10661 (when (looking-at org-complex-heading-regexp)
10662 (push (org-match-string-no-properties 4) rtn)))
10663 rtn)))))
10665 (defun org-format-outline-path (path &optional width prefix)
10666 "Format the outline path PATH for display.
10667 Width is the maximum number of characters that is available.
10668 Prefix is a prefix to be included in the returned string,
10669 such as the file name."
10670 (setq width (or width 79))
10671 (if prefix (setq width (- width (length prefix))))
10672 (if (not path)
10673 (or prefix "")
10674 (let* ((nsteps (length path))
10675 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10676 (maxwidth (if (<= total-width width)
10677 10000 ;; everything fits
10678 ;; we need to shorten the level headings
10679 (/ (- width nsteps) nsteps)))
10680 (org-odd-levels-only nil)
10681 (n 0)
10682 (total (1+ (length prefix))))
10683 (setq maxwidth (max maxwidth 10))
10684 (concat prefix
10685 (mapconcat
10686 (lambda (h)
10687 (setq n (1+ n))
10688 (if (and (= n nsteps) (< maxwidth 10000))
10689 (setq maxwidth (- total-width total)))
10690 (if (< (length h) maxwidth)
10691 (progn (setq total (+ total (length h) 1)) h)
10692 (setq h (substring h 0 (- maxwidth 2))
10693 total (+ total maxwidth 1))
10695 (setq h (substring h 0 (match-beginning 0))))
10696 (setq h (concat h "..")))
10697 (org-add-props h nil 'face
10698 (nth (% (1- n) org-n-level-faces)
10699 org-level-faces))
10700 h)
10701 path "/")))))
10703 (defun org-display-outline-path (&optional file current)
10704 "Display the current outline path in the echo area."
10705 (interactive "P")
10706 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10707 (case-fold-search nil)
10708 (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
10709 (if current (setq path (append path
10710 (save-excursion
10711 (org-back-to-heading t)
10712 (if (looking-at org-complex-heading-regexp)
10713 (list (match-string 4)))))))
10714 (message "%s"
10715 (org-format-outline-path
10716 path
10717 (1- (frame-width))
10718 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10720 (defvar org-refile-history nil
10721 "History for refiling operations.")
10723 (defvar org-after-refile-insert-hook nil
10724 "Hook run after `org-refile' has inserted its stuff at the new location.
10725 Note that this is still *before* the stuff will be removed from
10726 the *old* location.")
10728 (defvar org-capture-last-stored-marker)
10729 (defun org-refile (&optional goto default-buffer rfloc)
10730 "Move the entry or entries at point to another heading.
10731 The list of target headings is compiled using the information in
10732 `org-refile-targets', which see.
10734 At the target location, the entry is filed as a subitem of the target
10735 heading. Depending on `org-reverse-note-order', the new subitem will
10736 either be the first or the last subitem.
10738 If there is an active region, all entries in that region will be moved.
10739 However, the region must fulfill the requirement that the first heading
10740 is the first one sets the top-level of the moved text - at most siblings
10741 below it are allowed.
10743 With prefix arg GOTO, the command will only visit the target location
10744 and not actually move anything.
10747 go to the location where the last refiling operation has put the subtree.
10748 With a prefix argument of `2', refile to the running clock.
10750 RFLOC can be a refile location obtained in a different way.
10752 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10754 If you are using target caching (see `org-refile-use-cache'),
10755 you have to clear the target cache in order to find new targets.
10756 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10757 prefix argument (`C-u C-u C-u C-c C-w')."
10759 (interactive "P")
10760 (if (member goto '(0 (64)))
10761 (org-refile-cache-clear)
10762 (let* ((cbuf (current-buffer))
10763 (regionp (org-region-active-p))
10764 (region-start (and regionp (region-beginning)))
10765 (region-end (and regionp (region-end)))
10766 (region-length (and regionp (- region-end region-start)))
10767 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10768 pos it nbuf file re level reversed)
10769 (setq last-command nil)
10770 (when regionp
10771 (goto-char region-start)
10772 (or (bolp) (goto-char (point-at-bol)))
10773 (setq region-start (point))
10774 (unless (or (org-kill-is-subtree-p
10775 (buffer-substring region-start region-end))
10776 (prog1 org-refile-active-region-within-subtree
10777 (org-toggle-heading)))
10778 (error "The region is not a (sequence of) subtree(s)")))
10779 (if (equal goto '(16))
10780 (org-refile-goto-last-stored)
10781 (when (or
10782 (and (equal goto 2)
10783 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10784 (prog1
10785 (setq it (list (or org-clock-heading "running clock")
10786 (buffer-file-name
10787 (marker-buffer org-clock-hd-marker))
10788 ""
10789 (marker-position org-clock-hd-marker)))
10790 (setq goto nil)))
10791 (setq it (or rfloc
10792 (let (heading-text)
10793 (save-excursion
10794 (unless goto
10795 (org-back-to-heading t)
10796 (setq heading-text
10797 (nth 4 (org-heading-components))))
10798 (org-refile-get-location
10799 (cond (goto "Goto")
10800 (regionp "Refile region to")
10803 default-buffer
10804 (and (not (equal '(4) goto))
10805 org-refile-allow-creating-parent-nodes)
10806 goto))))))
10807 (setq file (nth 1 it)
10808 re (nth 2 it)
10809 pos (nth 3 it))
10810 (if (and (not goto)
10811 pos
10812 (equal (buffer-file-name) file)
10813 (if regionp
10814 (and (>= pos region-start)
10815 (<= pos region-end))
10816 (and (>= pos (point))
10817 (< pos (save-excursion
10818 (org-end-of-subtree t t))))))
10819 (error "Cannot refile to position inside the tree or region"))
10821 (setq nbuf (or (find-buffer-visiting file)
10822 (find-file-noselect file)))
10823 (if goto
10824 (progn
10825 (org-pop-to-buffer-same-window nbuf)
10826 (goto-char pos)
10827 (org-show-context 'org-goto))
10828 (if regionp
10829 (progn
10830 (org-kill-new (buffer-substring region-start region-end))
10831 (org-save-markers-in-region region-start region-end))
10832 (org-copy-subtree 1 nil t))
10833 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10834 (find-file-noselect file)))
10835 (setq reversed (org-notes-order-reversed-p))
10836 (save-excursion
10837 (save-restriction
10838 (widen)
10839 (if pos
10840 (progn
10841 (goto-char pos)
10842 (looking-at org-outline-regexp)
10843 (setq level (org-get-valid-level (funcall outline-level) 1))
10844 (goto-char
10845 (if reversed
10846 (or (outline-next-heading) (point-max))
10847 (or (save-excursion (org-get-next-sibling))
10848 (org-end-of-subtree t t)
10849 (point-max)))))
10850 (setq level 1)
10851 (if (not reversed)
10852 (goto-char (point-max))
10853 (goto-char (point-min))
10854 (or (outline-next-heading) (goto-char (point-max)))))
10855 (if (not (bolp)) (newline))
10856 (org-paste-subtree level)
10857 (when org-log-refile
10858 (org-add-log-setup 'refile nil nil 'findpos
10859 org-log-refile)
10860 (unless (eq org-log-refile 'note)
10861 (save-excursion (org-add-log-note))))
10862 (and org-auto-align-tags
10863 (let ((org-loop-over-headlines-in-active-region nil))
10864 (org-set-tags nil t)))
10865 (bookmark-set "org-refile-last-stored")
10866 ;; If we are refiling for capture, make sure that the
10867 ;; last-capture pointers point here
10868 (when (org-bound-and-true-p org-refile-for-capture)
10869 (bookmark-set "org-capture-last-stored-marker")
10870 (move-marker org-capture-last-stored-marker (point)))
10871 (if (fboundp 'deactivate-mark) (deactivate-mark))
10872 (run-hooks 'org-after-refile-insert-hook))))
10873 (if regionp
10874 (delete-region (point) (+ (point) region-length))
10875 (org-cut-subtree))
10876 (when (featurep 'org-inlinetask)
10877 (org-inlinetask-remove-END-maybe))
10878 (setq org-markers-to-move nil)
10881 (defun org-refile-goto-last-stored ()
10882 "Go to the location where the last refile was stored."
10883 (interactive)
10884 (bookmark-jump "org-refile-last-stored")
10885 (message "This is the location of the last refile"))
10887 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10888 no-exclude)
10889 "Prompt the user for a refile location, using PROMPT.
10890 PROMPT should not be suffixed with a colon and a space, because
10891 this function appends the default value from
10892 `org-refile-history' automatically, if that is not empty.
10893 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10894 this is used for the GOTO interface."
10895 (let ((org-refile-targets org-refile-targets)
10896 (org-refile-use-outline-path org-refile-use-outline-path)
10897 excluded-entries)
10898 (when (and (derived-mode-p 'org-mode)
10899 (not org-refile-use-cache)
10900 (not no-exclude))
10901 (org-map-tree
10902 (lambda()
10903 (setq excluded-entries
10904 (append excluded-entries (list (org-get-heading t t)))))))
10905 (setq org-refile-target-table
10906 (org-refile-get-targets default-buffer excluded-entries)))
10907 (unless org-refile-target-table
10908 (error "No refile targets"))
10909 (let* ((prompt (concat prompt
10910 (and (car org-refile-history)
10911 (concat " (default " (car org-refile-history) ")"))
10912 ": "))
10913 (cbuf (current-buffer))
10914 (partial-completion-mode nil)
10915 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10916 (cfunc (if (and org-refile-use-outline-path
10917 org-outline-path-complete-in-steps)
10918 'org-olpath-completing-read
10919 'org-icompleting-read))
10920 (extra (if org-refile-use-outline-path "/" ""))
10921 (filename (and cfn (expand-file-name cfn)))
10922 (tbl (mapcar
10923 (lambda (x)
10924 (if (and (not (member org-refile-use-outline-path
10925 '(file full-file-path)))
10926 (not (equal filename (nth 1 x))))
10927 (cons (concat (car x) extra " ("
10928 (file-name-nondirectory (nth 1 x)) ")")
10929 (cdr x))
10930 (cons (concat (car x) extra) (cdr x))))
10931 org-refile-target-table))
10932 (completion-ignore-case t)
10933 pa answ parent-target child parent old-hist)
10934 (setq old-hist org-refile-history)
10935 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10936 nil 'org-refile-history (car org-refile-history)))
10937 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10938 (org-refile-check-position pa)
10939 (if pa
10940 (progn
10941 (when (or (not org-refile-history)
10942 (not (eq old-hist org-refile-history))
10943 (not (equal (car pa) (car org-refile-history))))
10944 (setq org-refile-history
10945 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10946 org-refile-history
10947 (cdr org-refile-history))))
10948 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10949 (pop org-refile-history)))
10950 pa)
10952 (progn
10953 (setq parent (match-string 1 answ)
10954 child (match-string 2 answ))
10955 (setq parent-target (or (assoc parent tbl)
10956 (assoc (concat parent "/") tbl)))
10957 (when (and parent-target
10958 (or (eq new-nodes t)
10959 (and (eq new-nodes 'confirm)
10961 child)))))
10962 (org-refile-new-child parent-target child)))
10963 (error "Invalid target location")))))
10965 (declare-function org-string-nw-p "org-macs.el" (s))
10966 (defun org-refile-check-position (refile-pointer)
10967 "Check if the refile pointer matches the readline to which it points."
10968 (let* ((file (nth 1 refile-pointer))
10969 (re (nth 2 refile-pointer))
10970 (pos (nth 3 refile-pointer))
10971 buffer)
10972 (when (org-string-nw-p re)
10973 (setq buffer (if (markerp pos)
10974 (marker-buffer pos)
10975 (or (find-buffer-visiting file)
10976 (find-file-noselect file))))
10977 (with-current-buffer buffer
10978 (save-excursion
10979 (save-restriction
10980 (widen)
10981 (goto-char pos)
10982 (beginning-of-line 1)
10983 (unless (org-looking-at-p re)
10984 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10986 (defun org-refile-new-child (parent-target child)
10987 "Use refile target PARENT-TARGET to add new CHILD below it."
10988 (unless parent-target
10989 (error "Cannot find parent for new node"))
10990 (let ((file (nth 1 parent-target))
10991 (pos (nth 3 parent-target))
10992 level)
10993 (with-current-buffer (or (find-buffer-visiting file)
10994 (find-file-noselect file))
10995 (save-excursion
10996 (save-restriction
10997 (widen)
10998 (if pos
10999 (goto-char pos)
11000 (goto-char (point-max))
11001 (if (not (bolp)) (newline)))
11002 (when (looking-at org-outline-regexp)
11003 (setq level (funcall outline-level))
11004 (org-end-of-subtree t t))
11005 (org-back-over-empty-lines)
11007 (if pos (org-get-valid-level level 1) 1) ?*)
11009 (beginning-of-line 0)
11010 (list (concat (car parent-target) "/" child) file "" (point)))))))
11012 (defun org-olpath-completing-read (prompt collection &rest args)
11013 "Read an outline path like a file name."
11014 (let ((thetable collection)
11015 (org-completion-use-ido nil) ; does not work with ido.
11016 (org-completion-use-iswitchb nil)) ; or iswitchb
11017 (apply
11018 'org-icompleting-read prompt
11019 (lambda (string predicate &optional flag)
11020 (let (rtn r f (l (length string)))
11021 (cond
11022 ((eq flag nil)
11023 ;; try completion
11024 (try-completion string thetable))
11025 ((eq flag t)
11026 ;; all-completions
11027 (setq rtn (all-completions string thetable predicate))
11028 (mapcar
11029 (lambda (x)
11030 (setq r (substring x l))
11031 (if (string-match " ([^)]*)$" x)
11032 (setq f (match-string 0 x))
11033 (setq f ""))
11034 (if (string-match "/" r)
11035 (concat string (substring r 0 (match-end 0)) f)
11036 x))
11037 rtn))
11038 ((eq flag 'lambda)
11039 ;; exact match?
11040 (assoc string thetable)))))
11041 args)))
11043 ;;;; Dynamic blocks
11045 (defun org-find-dblock (name)
11046 "Find the first dynamic block with name NAME in the buffer.
11047 If not found, stay at current position and return nil."
11048 (let ((case-fold-search t) pos)
11049 (save-excursion
11050 (goto-char (point-min))
11051 (setq pos (and (re-search-forward
11053 (match-beginning 0))))
11054 (if pos (goto-char pos))
11055 pos))
11057 (defconst org-dblock-start-re
11059 "Matches the start line of a dynamic block, with parameters.")
11062 "Matches the end of a dynamic block.")
11064 (defun org-create-dblock (plist)
11065 "Create a dynamic block section, with parameters taken from PLIST.
11066 PLIST must contain a :name entry which is used as name of the block."
11068 (end-of-line 1)
11069 (newline))
11070 (let ((col (current-column))
11071 (name (plist-get plist :name)))
11072 (insert "#+BEGIN: " name)
11073 (while plist
11074 (if (eq (car plist) :name)
11075 (setq plist (cddr plist))
11076 (insert " " (prin1-to-string (pop plist)))))
11078 (beginning-of-line -2)))
11080 (defun org-prepare-dblock ()
11081 "Prepare dynamic block for refresh.
11082 This empties the block, puts the cursor at the insert position and returns
11083 the property list including an extra property :name with the block name."
11084 (unless (looking-at org-dblock-start-re)
11085 (error "Not at a dynamic block"))
11086 (let* ((begdel (1+ (match-end 0)))
11087 (name (org-no-properties (match-string 1)))
11088 (params (append (list :name name)
11089 (read (concat "(" (match-string 3) ")")))))
11090 (save-excursion
11091 (beginning-of-line 1)
11093 (setq params (plist-put params :indentation-column (current-column))))
11094 (unless (re-search-forward org-dblock-end-re nil t)
11095 (error "Dynamic block not terminated"))
11096 (setq params
11097 (append params
11098 (list :content (buffer-substring
11099 begdel (match-beginning 0)))))
11100 (delete-region begdel (match-beginning 0))
11101 (goto-char begdel)
11102 (open-line 1)
11103 params))
11105 (defun org-map-dblocks (&optional command)
11106 "Apply COMMAND to all dynamic blocks in the current buffer.
11107 If COMMAND is not given, use `org-update-dblock'."
11108 (let ((cmd (or command 'org-update-dblock)))
11109 (save-excursion
11110 (goto-char (point-min))
11111 (while (re-search-forward org-dblock-start-re nil t)
11112 (goto-char (match-beginning 0))
11113 (save-excursion
11114 (condition-case nil
11115 (funcall cmd)
11116 (error (message "Error during update of dynamic block"))))
11117 (unless (re-search-forward org-dblock-end-re nil t)
11118 (error "Dynamic block not terminated"))))))
11120 (defun org-dblock-update (&optional arg)
11121 "User command for updating dynamic blocks.
11122 Update the dynamic block at point. With prefix ARG, update all dynamic
11123 blocks in the buffer."
11124 (interactive "P")
11125 (if arg
11126 (org-update-all-dblocks)
11127 (or (looking-at org-dblock-start-re)
11128 (org-beginning-of-dblock))
11129 (org-update-dblock)))
11131 (defun org-update-dblock ()
11132 "Update the dynamic block at point.
11133 This means to empty the block, parse for parameters and then call
11134 the correct writing function."
11135 (interactive)
11136 (save-window-excursion
11137 (let* ((pos (point))
11138 (line (org-current-line))
11139 (params (org-prepare-dblock))
11140 (name (plist-get params :name))
11141 (indent (plist-get params :indentation-column))
11142 (cmd (intern (concat "org-dblock-write:" name))))
11143 (message "Updating dynamic block `%s' at line %d..." name line)
11144 (funcall cmd params)
11145 (message "Updating dynamic block `%s' at line %d...done" name line)
11146 (goto-char pos)
11147 (when (and indent (> indent 0))
11148 (setq indent (make-string indent ?\ ))
11149 (save-excursion
11150 (org-beginning-of-dblock)
11151 (forward-line 1)
11152 (while (not (looking-at org-dblock-end-re))
11153 (insert indent)
11154 (beginning-of-line 2))
11155 (when (looking-at org-dblock-end-re)
11157 (replace-match ""))
11158 (insert indent)))))))
11160 (defun org-beginning-of-dblock ()
11161 "Find the beginning of the dynamic block at point.
11162 Error if there is no such block at point."
11163 (let ((pos (point))
11164 beg)
11165 (end-of-line 1)
11166 (if (and (re-search-backward org-dblock-start-re nil t)
11167 (setq beg (match-beginning 0))
11168 (re-search-forward org-dblock-end-re nil t)
11169 (> (match-end 0) pos))
11170 (goto-char beg)
11171 (goto-char pos)
11172 (error "Not in a dynamic block"))))
11174 (defun org-update-all-dblocks ()
11175 "Update all dynamic blocks in the buffer.
11176 This function can be used in a hook."
11177 (interactive)
11178 (when (derived-mode-p 'org-mode)
11179 (org-map-dblocks 'org-update-dblock)))
11182 ;;;; Completion
11184 (defconst org-additional-option-like-keywords
11185 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11186 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11187 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11188 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11189 "BEGIN:" "END:"
11190 "ORGTBL" "TBLFM:" "TBLNAME:"
11191 "BEGIN_EXAMPLE" "END_EXAMPLE"
11192 "BEGIN_VERBATIM" "END_VERBATIM"
11193 "BEGIN_QUOTE" "END_QUOTE"
11194 "BEGIN_VERSE" "END_VERSE"
11195 "BEGIN_CENTER" "END_CENTER"
11196 "BEGIN_SRC" "END_SRC"
11197 "BEGIN_RESULT" "END_RESULT"
11198 "BEGIN_lstlisting" "END_lstlisting"
11199 "NAME:" "RESULTS:"
11200 "HEADER:" "HEADERS:"
11201 "COLUMNS:" "PROPERTY:"
11202 "CAPTION:" "LABEL:"
11203 "SETUPFILE:"
11204 "INCLUDE:"
11205 "BIND:"
11206 "MACRO:"))
11208 (defconst org-options-keywords
11209 '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
11210 "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
11211 "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
11212 "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
11213 "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
11214 "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:" "STYLE:"
11215 "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
11217 (defconst org-additional-option-like-keywords-for-flyspell
11218 (delete-dups
11219 (split-string
11220 (mapconcat (lambda(k)
11221 (replace-regexp-in-string
11223 (concat k " " (downcase k) " " (upcase k))))
11224 (append org-options-keywords org-additional-option-like-keywords)
11225 " ")
11226 " +" t)))
11228 (defcustom org-structure-template-alist
11229 '(
11242 ("L" "#+LaTeX: "
11246 ("H" "#+HTML: "
11249 ("A" "#+ASCII: ")
11250 ("i" "#+INDEX: ?"
11251 "#+INDEX: ?")
11252 ("I" "#+INCLUDE: %file ?"
11254 )
11255 "Structure completion elements.
11256 This is a list of abbreviation keys and values. The value gets inserted
11257 if you type `<' followed by the key and then press the completion key,
11258 usually `M-TAB'. %file will be replaced by a file name after prompting
11259 for the file using completion. The cursor will be placed at the position
11260 of the `?` in the template.
11261 There are two templates for each key, the first uses the original Org syntax,
11262 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11263 the default when the /org-mtags.el/ module has been loaded. See also the
11264 variable `org-mtags-prefer-muse-templates'."
11265 :group 'org-completion
11266 :type '(repeat
11267 (string :tag "Key")
11268 (string :tag "Template")
11269 (string :tag "Muse Template")))
11271 (defun org-try-structure-completion ()
11272 "Try to complete a structure template before point.
11274 expands them."
11275 (let ((l (buffer-substring (point-at-bol) (point)))
11276 a)
11279 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11280 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11281 (match-beginning 1)) a)
11282 t)))
11284 (defun org-complete-expand-structure-template (start cell)
11285 "Expand a structure template."
11286 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11287 (rpl (nth (if musep 2 1) cell))
11288 (ind ""))
11289 (delete-region start (point))
11291 (cond
11292 ((bolp))
11294 (setq ind (buffer-substring (point-at-bol) (point))))
11295 (t (newline))))
11296 (setq start (point))
11297 (if (string-match "%file" rpl)
11298 (setq rpl (replace-match
11299 (concat
11301 (save-match-data
11302 (abbreviate-file-name (read-file-name "Include file: ")))
11304 t t rpl)))
11307 (insert rpl)
11310 ;;;; TODO, DEADLINE, Comments
11312 (defun org-toggle-comment ()
11313 "Change the COMMENT state of an entry."
11314 (interactive)
11315 (save-excursion
11316 (org-back-to-heading)
11317 (let (case-fold-search)
11318 (cond
11319 ((looking-at (format org-heading-keyword-regexp-format
11320 org-comment-string))
11321 (goto-char (match-end 1))
11322 (looking-at (concat " +" org-comment-string))
11323 (replace-match "" t t)
11324 (when (eolp) (insert " ")))
11325 ((looking-at org-outline-regexp)
11326 (goto-char (match-end 0))
11327 (insert org-comment-string " "))))))
11329 (defvar org-last-todo-state-is-todo nil
11330 "This is non-nil when the last TODO state change led to a TODO state.
11331 If the last change removed the TODO tag or switched to DONE, then
11332 this is nil.")
11334 (defvar org-setting-tags nil) ; dynamically skipped
11336 (defvar org-todo-setup-filter-hook nil
11337 "Hook for functions that pre-filter todo specs.
11338 Each function takes a todo spec and returns either nil or the spec
11339 transformed into canonical form." )
11341 (defvar org-todo-get-default-hook nil
11342 "Hook for functions that get a default item for todo.
11343 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11344 nil or a string to be used for the todo mark." )
11346 (defvar org-agenda-headline-snapshot-before-repeat)
11348 (defun org-current-effective-time ()
11349 "Return current time adjusted for `org-extend-today-until' variable."
11350 (let* ((ct (org-current-time))
11351 (dct (decode-time ct))
11352 (ct1
11353 (if (and org-use-effective-time
11354 (< (nth 2 dct) org-extend-today-until))
11355 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11356 ct)))
11357 ct1))
11359 (defun org-todo-yesterday (&optional arg)
11360 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11361 (interactive "P")
11362 (if (eq major-mode 'org-agenda-mode)
11363 (apply 'org-agenda-todo-yesterday arg)
11364 (let* ((hour (third (decode-time
11365 (org-current-time))))
11366 (org-extend-today-until (1+ hour)))
11367 (org-todo arg))))
11369 (defun org-todo (&optional arg)
11370 "Change the TODO state of an item.
11371 The state of an item is given by a keyword at the start of the heading,
11372 like
11373 *** TODO Write paper
11374 *** DONE Call mom
11376 The different keywords are specified in the variable `org-todo-keywords'.
11378 So for this example: when the item starts with TODO, it is changed to DONE.
11379 When it starts with DONE, the DONE is removed. And when neither TODO nor
11380 DONE are present, add TODO at the beginning of the heading.
11383 state.
11384 With numeric prefix arg, switch to that state.
11386 keywords (nextset).
11388 With a numeric prefix arg of 0, inhibit note taking for the change.
11390 For calling through lisp, arg is also interpreted in the following way:
11391 'none -> empty state
11393 'done -> switch to DONE
11394 'nextset -> switch to the next set of keywords
11395 'previousset -> switch to the previous set of keywords
11397 really is a member of `org-todo-keywords'."
11398 (interactive "P")
11399 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11400 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11401 'region-start-level 'region))
11402 org-loop-over-headlines-in-active-region)
11403 (org-map-entries
11404 `(org-todo ,arg)
11405 org-loop-over-headlines-in-active-region
11406 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11407 (if (equal arg '(16)) (setq arg 'nextset))
11408 (let ((org-blocker-hook org-blocker-hook)
11409 (case-fold-search nil))
11410 (when (equal arg '(64))
11411 (setq arg nil org-blocker-hook nil))
11412 (when (and org-blocker-hook
11413 (or org-inhibit-blocking
11414 (org-entry-get nil "NOBLOCKING")))
11415 (setq org-blocker-hook nil))
11416 (save-excursion
11417 (catch 'exit
11418 (org-back-to-heading t)
11419 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11422 (let* ((match-data (match-data))
11423 (startpos (point-at-bol))
11424 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11425 (org-log-done org-log-done)
11426 (org-log-repeat org-log-repeat)
11427 (org-todo-log-states org-todo-log-states)
11428 (org-inhibit-logging
11429 (if (equal arg 0)
11430 (progn (setq arg nil) 'note) org-inhibit-logging))
11431 (this (match-string 1))
11432 (hl-pos (match-beginning 0))
11433 (head (org-get-todo-sequence-head this))
11434 (ass (assoc head org-todo-kwd-alist))
11435 (interpret (nth 1 ass))
11436 (done-word (nth 3 ass))
11437 (final-done-word (nth 4 ass))
11438 (org-last-state (or this ""))
11439 (completion-ignore-case t)
11440 (member (member this org-todo-keywords-1))
11441 (tail (cdr member))
11442 (org-state (cond
11443 ((and org-todo-key-trigger
11444 (or (and (equal arg '(4))
11445 (eq org-use-fast-todo-selection 'prefix))
11446 (and (not arg) org-use-fast-todo-selection
11447 (not (eq org-use-fast-todo-selection
11448 'prefix)))))
11449 ;; Use fast selection
11450 (org-fast-todo-selection))
11451 ((and (equal arg '(4))
11452 (or (not org-use-fast-todo-selection)
11453 (not org-todo-key-trigger)))
11454 ;; Read a state with completion
11455 (org-icompleting-read
11456 "State: " (mapcar (lambda(x) (list x))
11457 org-todo-keywords-1)
11458 nil t))
11459 ((eq arg 'right)
11460 (if this
11461 (if tail (car tail) nil)
11462 (car org-todo-keywords-1)))
11463 ((eq arg 'left)
11464 (if (equal member org-todo-keywords-1)
11465 nil
11466 (if this
11467 (nth (- (length org-todo-keywords-1)
11468 (length tail) 2)
11469 org-todo-keywords-1)
11470 (org-last org-todo-keywords-1))))
11471 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11472 (setq arg nil))) ; hack to fall back to cycling
11473 (arg
11474 ;; user or caller requests a specific state
11475 (cond
11476 ((equal arg "") nil)
11477 ((eq arg 'none) nil)
11478 ((eq arg 'done) (or done-word (car org-done-keywords)))
11479 ((eq arg 'nextset)
11480 (or (car (cdr (member head org-todo-heads)))
11481 (car org-todo-heads)))
11482 ((eq arg 'previousset)
11483 (let ((org-todo-heads (reverse org-todo-heads)))
11484 (or (car (cdr (member head org-todo-heads)))
11485 (car org-todo-heads))))
11486 ((car (member arg org-todo-keywords-1)))
11487 ((stringp arg)
11488 (error "State `%s' not valid in this file" arg))
11489 ((nth (1- (prefix-numeric-value arg))
11490 org-todo-keywords-1))))
11491 ((null member) (or head (car org-todo-keywords-1)))
11492 ((equal this final-done-word) nil) ;; -> make empty
11493 ((null tail) nil) ;; -> first entry
11494 ((memq interpret '(type priority))
11495 (if (eq this-command last-command)
11496 (car tail)
11497 (if (> (length tail) 0)
11498 (or done-word (car org-done-keywords))
11499 nil)))
11500 (t
11501 (car tail))))
11502 (org-state (or
11503 (run-hook-with-args-until-success
11504 'org-todo-get-default-hook org-state org-last-state)
11505 org-state))
11506 (next (if org-state (concat " " org-state " ") " "))
11507 (change-plist (list :type 'todo-state-change :from this :to org-state
11508 :position startpos))
11509 dolog now-done-p)
11510 (when org-blocker-hook
11511 (setq org-last-todo-state-is-todo
11512 (not (member this org-done-keywords)))
11513 (unless (save-excursion
11514 (save-match-data
11515 (org-with-wide-buffer
11516 (run-hook-with-args-until-failure
11517 'org-blocker-hook change-plist))))
11518 (if (org-called-interactively-p 'interactive)
11519 (error "TODO state change from %s to %s blocked" this org-state)
11520 ;; fail silently
11521 (message "TODO state change from %s to %s blocked" this org-state)
11522 (throw 'exit nil))))
11523 (store-match-data match-data)
11524 (replace-match next t t)
11525 (unless (pos-visible-in-window-p hl-pos)
11526 (message "TODO state changed to %s" (org-trim next)))
11527 (unless head
11528 (setq head (org-get-todo-sequence-head org-state)
11529 ass (assoc head org-todo-kwd-alist)
11530 interpret (nth 1 ass)
11531 done-word (nth 3 ass)
11532 final-done-word (nth 4 ass)))
11533 (when (memq arg '(nextset previousset))
11534 (message "Keyword-Set %d/%d: %s"
11535 (- (length org-todo-sets) -1
11536 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11537 (length org-todo-sets)
11538 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11539 (setq org-last-todo-state-is-todo
11540 (not (member org-state org-done-keywords)))
11541 (setq now-done-p (and (member org-state org-done-keywords)
11542 (not (member this org-done-keywords))))
11543 (and logging (org-local-logging logging))
11544 (when (and (or org-todo-log-states org-log-done)
11545 (not (eq org-inhibit-logging t))
11546 (not (memq arg '(nextset previousset))))
11547 ;; we need to look at recording a time and note
11548 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11549 (nth 2 (assoc this org-todo-log-states))))
11550 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11551 (setq dolog 'time))
11552 (when (and org-state
11553 (member org-state org-not-done-keywords)
11554 (not (member this org-not-done-keywords)))
11555 ;; This is now a todo state and was not one before
11556 ;; If there was a CLOSED time stamp, get rid of it.
11557 (org-add-planning-info nil nil 'closed))
11558 (when (and now-done-p org-log-done)
11559 ;; It is now done, and it was not done before
11560 (org-add-planning-info 'closed (org-current-effective-time))
11561 (if (and (not dolog) (eq 'note org-log-done))
11562 (org-add-log-setup 'done org-state this 'findpos 'note)))
11563 (when (and org-state dolog)
11564 ;; This is a non-nil state, and we need to log it
11565 (org-add-log-setup 'state org-state this 'findpos dolog)))
11566 ;; Fixup tag positioning
11567 (org-todo-trigger-tag-changes org-state)
11568 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11569 (when org-provide-todo-statistics
11570 (org-update-parent-todo-statistics))
11571 (run-hooks 'org-after-todo-state-change-hook)
11572 (if (and arg (not (member org-state org-done-keywords)))
11573 (setq head (org-get-todo-sequence-head org-state)))
11574 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11575 ;; Do we need to trigger a repeat?
11576 (when now-done-p
11577 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11578 ;; This is for the agenda, take a snapshot of the headline.
11579 (save-match-data
11580 (setq org-agenda-headline-snapshot-before-repeat
11581 (org-get-heading))))
11582 (org-auto-repeat-maybe org-state))
11583 ;; Fixup cursor location if close to the keyword
11584 (if (and (outline-on-heading-p)
11585 (not (bolp))
11586 (save-excursion (beginning-of-line 1)
11587 (looking-at org-todo-line-regexp))
11588 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11589 (progn
11590 (goto-char (or (match-end 2) (match-end 1)))
11591 (and (looking-at " ") (just-one-space))))
11592 (when org-trigger-hook
11593 (save-excursion
11594 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11596 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11597 "Block turning an entry into a TODO, using the hierarchy.
11598 This checks whether the current task should be blocked from state
11599 changes. Such blocking occurs when:
11601 1. The task has children which are not all in a completed state.
11603 2. A task has a parent with the property :ORDERED:, and there
11604 are siblings prior to the current task with incomplete
11605 status.
11607 3. The parent of the task is blocked because it has siblings that should
11608 be done first, or is child of a block grandparent TODO entry."
11610 (if (not org-enforce-todo-dependencies)
11611 t ; if locally turned off don't block
11612 (catch 'dont-block
11613 ;; If this is not a todo state change, or if this entry is already DONE,
11614 ;; do not block
11615 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11616 (member (plist-get change-plist :from)
11617 (cons 'done org-done-keywords))
11618 (member (plist-get change-plist :to)
11619 (cons 'todo org-not-done-keywords))
11620 (not (plist-get change-plist :to)))
11621 (throw 'dont-block t))
11622 ;; If this task has children, and any are undone, it's blocked
11623 (save-excursion
11624 (org-back-to-heading t)
11625 (let ((this-level (funcall outline-level)))
11626 (outline-next-heading)
11627 (let ((child-level (funcall outline-level)))
11628 (while (and (not (eobp))
11629 (> child-level this-level))
11630 ;; this todo has children, check whether they are all
11631 ;; completed
11632 (if (and (not (org-entry-is-done-p))
11633 (org-entry-is-todo-p))
11634 (throw 'dont-block nil))
11635 (outline-next-heading)
11636 (setq child-level (funcall outline-level))))))
11637 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11638 ;; any previous siblings are undone, it's blocked
11639 (save-excursion
11640 (org-back-to-heading t)
11641 (let* ((pos (point))
11642 (parent-pos (and (org-up-heading-safe) (point))))
11643 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11644 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11645 (forward-line 1)
11646 (re-search-forward org-not-done-heading-regexp pos t))
11647 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11648 ;; Search further up the hierarchy, to see if an ancestor is blocked
11649 (while t
11650 (goto-char parent-pos)
11651 (if (not (looking-at org-not-done-heading-regexp))
11652 (throw 'dont-block t)) ; do not block, parent is not a TODO
11653 (setq pos (point))
11654 (setq parent-pos (and (org-up-heading-safe) (point)))
11655 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11656 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11657 (forward-line 1)
11658 (re-search-forward org-not-done-heading-regexp pos t))
11659 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11661 (defcustom org-track-ordered-property-with-tag nil
11662 "Should the ORDERED property also be shown as a tag?
11663 The ORDERED property decides if an entry should require subtasks to be
11664 completed in sequence. Since a property is not very visible, setting
11665 this option means that toggling the ORDERED property with the command
11666 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11667 not relevant for the behavior, but it makes things more visible.
11669 Note that toggling the tag with tags commands will not change the property
11670 and therefore not influence behavior!
11672 This can be t, meaning the tag ORDERED should be used, It can also be a
11673 string to select a different tag for this task."
11674 :group 'org-todo
11675 :type '(choice
11676 (const :tag "No tracking" nil)
11677 (const :tag "Track with ORDERED tag" t)
11678 (string :tag "Use other tag")))
11680 (defun org-toggle-ordered-property ()
11681 "Toggle the ORDERED property of the current entry.
11682 For better visibility, you can track the value of this property with a tag.
11683 See variable `org-track-ordered-property-with-tag'."
11684 (interactive)
11685 (let* ((t1 org-track-ordered-property-with-tag)
11686 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11687 (save-excursion
11688 (org-back-to-heading)
11689 (if (org-entry-get nil "ORDERED")
11690 (progn
11691 (org-delete-property "ORDERED")
11692 (and tag (org-toggle-tag tag 'off))
11693 (message "Subtasks can be completed in arbitrary order"))
11694 (org-entry-put nil "ORDERED" "t")
11695 (and tag (org-toggle-tag tag 'on))
11696 (message "Subtasks must be completed in sequence")))))
11698 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11699 (defun org-block-todo-from-checkboxes (change-plist)
11700 "Block turning an entry into a TODO, using checkboxes.
11701 This checks whether the current task should be blocked from state
11702 changes because there are unchecked boxes in this entry."
11703 (if (not org-enforce-todo-checkbox-dependencies)
11704 t ; if locally turned off don't block
11705 (catch 'dont-block
11706 ;; If this is not a todo state change, or if this entry is already DONE,
11707 ;; do not block
11708 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11709 (member (plist-get change-plist :from)
11710 (cons 'done org-done-keywords))
11711 (member (plist-get change-plist :to)
11712 (cons 'todo org-not-done-keywords))
11713 (not (plist-get change-plist :to)))
11714 (throw 'dont-block t))
11715 ;; If this task has checkboxes that are not checked, it's blocked
11716 (save-excursion
11717 (org-back-to-heading t)
11718 (let ((beg (point)) end)
11719 (outline-next-heading)
11720 (setq end (point))
11721 (goto-char beg)
11722 (if (org-list-search-forward
11723 (concat (org-item-beginning-re)
11726 end t)
11727 (progn
11728 (if (boundp 'org-blocked-by-checkboxes)
11729 (setq org-blocked-by-checkboxes t))
11730 (throw 'dont-block nil)))))
11731 t))) ; do not block
11733 (defun org-entry-blocked-p ()
11734 "Is the current entry blocked?"
11735 (if (org-entry-get nil "NOBLOCKING")
11736 nil ;; Never block this entry
11737 (not
11738 (run-hook-with-args-until-failure
11739 'org-blocker-hook
11740 (list :type 'todo-state-change
11741 :position (point)
11742 :from 'todo
11743 :to 'done)))))
11745 (defun org-update-statistics-cookies (all)
11746 "Update the statistics cookie, either from TODO or from checkboxes.
11747 This should be called with the cursor in a line with a statistics cookie."
11748 (interactive "P")
11749 (if all
11750 (progn
11751 (org-update-checkbox-count 'all)
11752 (org-map-entries 'org-update-parent-todo-statistics))
11753 (if (not (org-at-heading-p))
11754 (org-update-checkbox-count)
11755 (let ((pos (move-marker (make-marker) (point)))
11756 end l1 l2)
11757 (ignore-errors (org-back-to-heading t))
11758 (if (not (org-at-heading-p))
11759 (org-update-checkbox-count)
11760 (setq l1 (org-outline-level))
11761 (setq end (save-excursion
11762 (outline-next-heading)
11763 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11764 (point)))
11765 (if (and (save-excursion
11766 (re-search-forward
11768 (not (save-excursion (re-search-forward
11770 (org-update-checkbox-count)
11771 (if (and l2 (> l2 l1))
11772 (progn
11773 (goto-char end)
11774 (org-update-parent-todo-statistics))
11775 (goto-char pos)
11776 (beginning-of-line 1)
11777 (while (re-search-forward
11779 (point-at-eol) t)
11780 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11781 (goto-char pos)
11782 (move-marker pos nil)))))
11784 (defvar org-entry-property-inherited-from) ;; defined below
11785 (defun org-update-parent-todo-statistics ()
11786 "Update any statistics cookie in the parent of the current headline.
11787 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11788 the entire subtree and this will travel up the hierarchy and update
11789 statistics everywhere."
11790 (let* ((prop (save-excursion (org-up-heading-safe)
11791 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11792 (recursive (or (not org-hierarchical-todo-statistics)
11794 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11795 0))
11796 (first t)
11798 level ltoggle l1 new ndel
11799 (cnt-all 0) (cnt-done 0) is-percent kwd
11800 checkbox-beg ov ovs ove cookie-present)
11801 (catch 'exit
11802 (save-excursion
11803 (beginning-of-line 1)
11804 (setq ltoggle (funcall outline-level))
11805 ;; Three situations are to consider:
11807 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11808 ;; to the top-level ancestor on the headline;
11810 ;; 2. If parent has "recursive" property, repeat up to the
11811 ;; headline setting that property, taking inheritance into
11812 ;; account;
11814 ;; 3. Else, move up to direct parent and proceed only once.
11815 (while (and (setq level (org-up-heading-safe))
11816 (or recursive first)
11817 (>= (point) lim))
11818 (setq first nil cookie-present nil)
11819 (unless (and level
11820 (not (string-match
11822 (downcase (or (org-entry-get nil "COOKIE_DATA")
11823 "")))))
11824 (throw 'exit nil))
11825 (while (re-search-forward box-re (point-at-eol) t)
11826 (setq cnt-all 0 cnt-done 0 cookie-present t)
11827 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11828 (save-match-data
11829 (unless (outline-next-heading) (throw 'exit nil))
11830 (while (and (looking-at org-complex-heading-regexp)
11831 (> (setq l1 (length (match-string 1))) level))
11832 (setq kwd (and (or recursive (= l1 ltoggle))
11833 (match-string 2)))
11834 (if (or (eq org-provide-todo-statistics 'all-headlines)
11835 (and (listp org-provide-todo-statistics)
11836 (or (member kwd org-provide-todo-statistics)
11837 (member kwd org-done-keywords))))
11838 (setq cnt-all (1+ cnt-all))
11839 (if (eq org-provide-todo-statistics t)
11840 (and kwd (setq cnt-all (1+ cnt-all)))))
11841 (and (member kwd org-done-keywords)
11842 (setq cnt-done (1+ cnt-done)))
11843 (outline-next-heading)))
11844 (setq new
11845 (if is-percent
11846 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11847 (format "[%d/%d]" cnt-done cnt-all))
11848 ndel (- (match-end 0) checkbox-beg))
11849 ;; handle overlays when updating cookie from column view
11850 (when (setq ov (car (overlays-at checkbox-beg)))
11851 (setq ovs (overlay-start ov) ove (overlay-end ov))
11852 (delete-overlay ov))
11853 (goto-char checkbox-beg)
11854 (insert new)
11855 (delete-region (point) (+ (point) ndel))
11856 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11857 (when ov (move-overlay ov ovs ove)))
11858 (when cookie-present
11859 (run-hook-with-args 'org-after-todo-statistics-hook
11860 cnt-done (- cnt-all cnt-done))))))
11861 (run-hooks 'org-todo-statistics-hook)))
11863 (defvar org-after-todo-statistics-hook nil
11864 "Hook that is called after a TODO statistics cookie has been updated.
11865 Each function is called with two arguments: the number of not-done entries
11866 and the number of done entries.
11868 For example, the following function, when added to this hook, will switch
11869 an entry to DONE when all children are done, and back to TODO when new
11870 entries are set to a TODO status. Note that this hook is only called
11871 when there is a statistics cookie in the headline!
11873 (defun org-summary-todo (n-done n-not-done)
11875 (let (org-log-done org-log-states) ; turn off logging
11877 ")
11879 (defvar org-todo-statistics-hook nil
11880 "Hook that is run whenever Org thinks TODO statistics should be updated.
11881 This hook runs even if there is no statistics cookie present, in which case
11882 `org-after-todo-statistics-hook' would not run.")
11884 (defun org-todo-trigger-tag-changes (state)
11885 "Apply the changes defined in `org-todo-state-tags-triggers'."
11886 (let ((l org-todo-state-tags-triggers)
11887 changes)
11888 (when (or (not state) (equal state ""))
11889 (setq changes (append changes (cdr (assoc "" l)))))
11890 (when (and (stringp state) (> (length state) 0))
11891 (setq changes (append changes (cdr (assoc state l)))))
11892 (when (member state org-not-done-keywords)
11893 (setq changes (append changes (cdr (assoc 'todo l)))))
11894 (when (member state org-done-keywords)
11895 (setq changes (append changes (cdr (assoc 'done l)))))
11896 (dolist (c changes)
11897 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11899 (defun org-local-logging (value)
11900 "Get logging settings from a property VALUE."
11901 (let* (words w a)
11902 ;; directly set the variables, they are already local.
11903 (setq org-log-done nil
11904 org-log-repeat nil
11905 org-todo-log-states nil)
11906 (setq words (org-split-string value))
11907 (while (setq w (pop words))
11908 (cond
11909 ((setq a (assoc w org-startup-options))
11910 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11911 (set (nth 1 a) (nth 2 a))))
11912 ((setq a (org-extract-log-state-settings w))
11913 (and (member (car a) org-todo-keywords-1)
11914 (push a org-todo-log-states)))))))
11916 (defun org-get-todo-sequence-head (kwd)
11917 "Return the head of the TODO sequence to which KWD belongs.
11918 If KWD is not set, check if there is a text property remembering the
11919 right sequence."
11920 (let (p)
11921 (cond
11922 ((not kwd)
11923 (or (get-text-property (point-at-bol) 'org-todo-head)
11924 (progn
11925 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11926 nil (point-at-eol)))
11927 (get-text-property p 'org-todo-head))))
11928 ((not (member kwd org-todo-keywords-1))
11929 (car org-todo-keywords-1))
11930 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11932 (defun org-fast-todo-selection ()
11933 "Fast TODO keyword selection with single keys.
11934 Returns the new TODO keyword, or nil if no state change should occur."
11935 (let* ((fulltable org-todo-key-alist)
11936 (done-keywords org-done-keywords) ;; needed for the faces.
11937 (maxlen (apply 'max (mapcar
11938 (lambda (x)
11939 (if (stringp (car x)) (string-width (car x)) 0))
11940 fulltable)))
11941 (expert nil)
11942 (fwidth (+ maxlen 3 1 3))
11943 (ncol (/ (- (window-width) 4) fwidth))
11944 tg cnt e c tbl
11945 groups ingroup)
11946 (save-excursion
11947 (save-window-excursion
11948 (if expert
11949 (set-buffer (get-buffer-create " *Org todo*"))
11950 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11951 (erase-buffer)
11952 (org-set-local 'org-done-keywords done-keywords)
11953 (setq tbl fulltable cnt 0)
11954 (while (setq e (pop tbl))
11955 (cond
11956 ((equal e '(:startgroup))
11957 (push '() groups) (setq ingroup t)
11958 (when (not (= cnt 0))
11959 (setq cnt 0)
11961 (insert "{ "))
11962 ((equal e '(:endgroup))
11963 (setq ingroup nil cnt 0)
11965 ((equal e '(:newline))
11966 (when (not (= cnt 0))
11967 (setq cnt 0)
11969 (setq e (car tbl))
11970 (while (equal (car tbl) '(:newline))
11972 (setq tbl (cdr tbl)))))
11973 (t
11974 (setq tg (car e) c (cdr e))
11975 (if ingroup (push tg (car groups)))
11976 (setq tg (org-add-props tg nil 'face
11977 (org-get-todo-face tg)))
11978 (if (and (= cnt 0) (not ingroup)) (insert " "))
11979 (insert "[" c "] " tg (make-string
11980 (- fwidth 4 (length tg)) ?\ ))
11981 (when (= (setq cnt (1+ cnt)) ncol)
11983 (if ingroup (insert " "))
11984 (setq cnt 0)))))
11986 (goto-char (point-min))
11987 (if (not expert) (org-fit-window-to-buffer))
11988 (message "[a-z..]:Set [SPC]:clear")
11989 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11990 (cond
11991 ((or (= c ?\C-g)
11992 (and (= c ?q) (not (rassoc c fulltable))))
11993 (setq quit-flag t))
11994 ((= c ?\ ) nil)
11995 ((setq e (rassoc c fulltable) tg (car e))
11996 tg)
11997 (t (setq quit-flag t)))))))
11999 (defun org-entry-is-todo-p ()
12000 (member (org-get-todo-state) org-not-done-keywords))
12002 (defun org-entry-is-done-p ()
12003 (member (org-get-todo-state) org-done-keywords))
12005 (defun org-get-todo-state ()
12006 (save-excursion
12007 (org-back-to-heading t)
12008 (and (looking-at org-todo-line-regexp)
12009 (match-end 2)
12010 (match-string 2))))
12012 (defun org-at-date-range-p (&optional inactive-ok)
12013 "Is the cursor inside a date range?"
12014 (interactive)
12015 (save-excursion
12016 (catch 'exit
12017 (let ((pos (point)))
12019 (skip-chars-backward "<[")
12020 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12021 (>= (match-end 0) pos)
12022 (throw 'exit t))
12024 (skip-chars-backward "<[")
12025 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12026 (>= (match-end 0) pos)
12027 (throw 'exit t)))
12028 nil)))
12030 (defun org-get-repeat (&optional tagline)
12031 "Check if there is a deadline/schedule with repeater in this entry."
12032 (save-match-data
12033 (save-excursion
12034 (org-back-to-heading t)
12035 (and (re-search-forward (if tagline
12037 org-repeat-re)
12038 (org-entry-end-position) t)
12039 (match-string-no-properties 1)))))
12041 (defvar org-last-changed-timestamp)
12042 (defvar org-last-inserted-timestamp)
12043 (defvar org-log-post-message)
12044 (defvar org-log-note-purpose)
12045 (defvar org-log-note-how)
12046 (defvar org-log-note-extra)
12047 (defun org-auto-repeat-maybe (done-word)
12048 "Check if the current headline contains a repeated deadline/schedule.
12049 If yes, set TODO state back to what it was and change the base date
12050 of repeating deadline/scheduled time stamps to new date.
12051 This function is run automatically after each state change to a DONE state."
12052 ;; last-state is dynamically scoped into this function
12053 (let* ((repeat (org-get-repeat))
12054 (aa (assoc org-last-state org-todo-kwd-alist))
12055 (interpret (nth 1 aa))
12056 (head (nth 2 aa))
12057 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12058 (msg "Entry repeats: ")
12059 (org-log-done nil)
12060 (org-todo-log-states nil)
12061 re type n what ts time to-state)
12062 (when repeat
12063 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12064 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12065 org-todo-repeat-to-state))
12066 (unless (and to-state (member to-state org-todo-keywords-1))
12067 (setq to-state (if (eq interpret 'type) org-last-state head)))
12068 (org-todo to-state)
12069 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12070 (org-entry-put nil "LAST_REPEAT" (format-time-string
12071 (org-time-stamp-format t t))))
12072 (when org-log-repeat
12073 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12074 (memq 'org-add-log-note post-command-hook))
12075 ;; OK, we are already setup for some record
12076 (if (eq org-log-repeat 'note)
12077 ;; make sure we take a note, not only a time stamp
12078 (setq org-log-note-how 'note))
12079 ;; Set up for taking a record
12080 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12081 org-last-state
12082 'findpos org-log-repeat)))
12083 (org-back-to-heading t)
12084 (org-add-planning-info nil nil 'closed)
12088 (while (re-search-forward
12089 re (save-excursion (outline-next-heading) (point)) t)
12090 (setq type (if (match-end 1) org-scheduled-string
12091 (if (match-end 3) org-deadline-string "Plain:"))
12092 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12094 (setq n (string-to-number (match-string 2 ts))
12095 what (match-string 3 ts))
12096 (if (equal what "w") (setq n (* n 7) what "d"))
12098 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12099 ;; Preparation, see if we need to modify the start date for the change
12100 (when (match-end 1)
12101 (setq time (save-match-data (org-time-string-to-time ts)))
12102 (cond
12103 ((equal (match-string 1 ts) ".")
12104 ;; Shift starting date to today
12105 (org-timestamp-change
12106 (- (org-today) (time-to-days time))
12107 'day))
12108 ((equal (match-string 1 ts) "+")
12109 (let ((nshiftmax 10) (nshift 0))
12110 (while (or (= nshift 0)
12111 (<= (time-to-days time)
12112 (time-to-days (current-time))))
12113 (when (= (incf nshift) nshiftmax)
12114 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12115 (error "Abort")))
12116 (org-timestamp-change n (cdr (assoc what whata)))
12117 (org-at-timestamp-p t)
12118 (setq ts (match-string 1))
12119 (setq time (save-match-data (org-time-string-to-time ts)))))
12120 (org-timestamp-change (- n) (cdr (assoc what whata)))
12121 ;; rematch, so that we have everything in place for the real shift
12122 (org-at-timestamp-p t)
12123 (setq ts (match-string 1))
12125 (org-timestamp-change n (cdr (assoc what whata)))
12126 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12127 (setq org-log-post-message msg)
12128 (message "%s" msg))))
12130 (defun org-show-todo-tree (arg)
12131 "Make a compact tree which shows all headlines marked with TODO.
12132 The tree will show the lines where the regexp matches, and all higher
12133 headlines above the match.
12135 With a numeric prefix N, construct a sparse tree for the Nth element
12136 of `org-todo-keywords-1'."
12137 (interactive "P")
12138 (let ((case-fold-search nil)
12139 (kwd-re
12140 (cond ((null arg) org-not-done-regexp)
12141 ((equal arg '(4))
12142 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12143 (mapcar 'list org-todo-keywords-1))))
12147 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12148 (regexp-quote (nth (1- (prefix-numeric-value arg))
12149 org-todo-keywords-1)))
12150 (t (error "Invalid prefix argument: %s" arg)))))
12151 (message "%d TODO entries found"
12152 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12154 (defun org-deadline (&optional remove time)
12156 With argument REMOVE, remove any deadline from the item.
12157 With argument TIME, set the deadline at the corresponding date. TIME
12159 (interactive "P")
12160 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12161 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12162 'region-start-level 'region))
12163 org-loop-over-headlines-in-active-region)
12164 (org-map-entries
12165 `(org-deadline ',remove ,time)
12166 org-loop-over-headlines-in-active-region
12167 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12168 (let* ((old-date (org-entry-get nil "DEADLINE"))
12169 (repeater (and old-date
12170 (string-match
12172 old-date)
12173 (match-string 1 old-date))))
12174 (if remove
12175 (progn
12176 (when (and old-date org-log-redeadline)
12177 (org-add-log-setup 'deldeadline nil old-date 'findpos
12178 org-log-redeadline))
12179 (org-remove-timestamp-with-keyword org-deadline-string)
12180 (message "Item no longer has a deadline."))
12181 (org-add-planning-info 'deadline time 'closed)
12182 (when (and old-date org-log-redeadline
12183 (not (equal old-date
12184 (substring org-last-inserted-timestamp 1 -1))))
12185 (org-add-log-setup 'redeadline nil old-date 'findpos
12186 org-log-redeadline))
12187 (when repeater
12188 (save-excursion
12189 (org-back-to-heading t)
12190 (when (re-search-forward (concat org-deadline-string " "
12191 org-last-inserted-timestamp)
12192 (save-excursion
12193 (outline-next-heading) (point)) t)
12194 (goto-char (1- (match-end 0)))
12195 (insert " " repeater)
12196 (setq org-last-inserted-timestamp
12197 (concat (substring org-last-inserted-timestamp 0 -1)
12198 " " repeater
12199 (substring org-last-inserted-timestamp -1))))))
12200 (message "Deadline on %s" org-last-inserted-timestamp)))))
12202 (defun org-schedule (&optional remove time)
12203 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12204 With argument REMOVE, remove any scheduling date from the item.
12205 With argument TIME, scheduled at the corresponding date. TIME can
12207 (interactive "P")
12208 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12209 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12210 'region-start-level 'region))
12211 org-loop-over-headlines-in-active-region)
12212 (org-map-entries
12213 `(org-schedule ',remove ,time)
12214 org-loop-over-headlines-in-active-region
12215 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12216 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12217 (repeater (and old-date
12218 (string-match
12220 old-date)
12221 (match-string 1 old-date))))
12222 (if remove
12223 (progn
12224 (when (and old-date org-log-reschedule)
12225 (org-add-log-setup 'delschedule nil old-date 'findpos
12226 org-log-reschedule))
12227 (org-remove-timestamp-with-keyword org-scheduled-string)
12228 (message "Item is no longer scheduled."))
12229 (org-add-planning-info 'scheduled time 'closed)
12230 (when (and old-date org-log-reschedule
12231 (not (equal old-date
12232 (substring org-last-inserted-timestamp 1 -1))))
12233 (org-add-log-setup 'reschedule nil old-date 'findpos
12234 org-log-reschedule))
12235 (when repeater
12236 (save-excursion
12237 (org-back-to-heading t)
12238 (when (re-search-forward (concat org-scheduled-string " "
12239 org-last-inserted-timestamp)
12240 (save-excursion
12241 (outline-next-heading) (point)) t)
12242 (goto-char (1- (match-end 0)))
12243 (insert " " repeater)
12244 (setq org-last-inserted-timestamp
12245 (concat (substring org-last-inserted-timestamp 0 -1)
12246 " " repeater
12247 (substring org-last-inserted-timestamp -1))))))
12248 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12250 (defun org-get-scheduled-time (pom &optional inherit)
12251 "Get the scheduled time as a time tuple, of a format suitable
12252 for calling org-schedule with, or if there is no scheduling,
12253 returns nil."
12254 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12255 (when time
12256 (apply 'encode-time (org-parse-time-string time)))))
12258 (defun org-get-deadline-time (pom &optional inherit)
12259 "Get the deadline as a time tuple, of a format suitable for
12260 calling org-deadline with, or if there is no scheduling, returns
12261 nil."
12262 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12263 (when time
12264 (apply 'encode-time (org-parse-time-string time)))))
12266 (defun org-remove-timestamp-with-keyword (keyword)
12267 "Remove all time stamps with KEYWORD in the current entry."
12269 beg)
12270 (save-excursion
12271 (org-back-to-heading t)
12272 (setq beg (point))
12273 (outline-next-heading)
12274 (while (re-search-backward re beg t)
12275 (replace-match "")
12277 (equal (char-before) ?\ ))
12278 (backward-delete-char 1)
12280 (point-at-bol) (point-at-eol)))
12281 (delete-region (point-at-bol)
12282 (min (point-max) (1+ (point-at-eol))))))))))
12284 (defun org-add-planning-info (what &optional time &rest remove)
12285 "Insert new timestamp with keyword in the line directly after the headline.
12286 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12287 If non is given, the user is prompted for a date.
12288 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12289 be removed."
12290 (interactive)
12291 (let (org-time-was-given org-end-time-was-given ts
12292 end default-time default-input)
12294 (catch 'exit
12295 (when (and (memq what '(scheduled deadline))
12296 (or (not time)
12297 (and (stringp time)
12298 (string-match "^[-+]+[0-9]" time))))
12299 ;; Try to get a default date/time from existing timestamp
12300 (save-excursion
12301 (org-back-to-heading t)
12302 (setq end (save-excursion (outline-next-heading) (point)))
12303 (when (re-search-forward (if (eq what 'scheduled)
12304 org-scheduled-time-regexp
12305 org-deadline-time-regexp)
12306 end t)
12307 (setq ts (match-string 1)
12308 default-time
12309 (apply 'encode-time (org-parse-time-string ts))
12310 default-input (and ts (org-get-compact-tod ts))))))
12311 (when what
12312 (setq time
12313 (if (stringp time)
12314 ;; This is a string (relative or absolute), set proper date
12315 (apply 'encode-time
12316 (org-read-date-analyze
12317 time default-time (decode-time default-time)))
12318 ;; If necessary, get the time from the user
12319 (or time (org-read-date nil 'to-time nil nil
12320 default-time default-input)))))
12322 (when (and org-insert-labeled-timestamps-at-point
12323 (member what '(scheduled deadline)))
12324 (insert
12325 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12326 (org-insert-time-stamp time org-time-was-given
12327 nil nil nil (list org-end-time-was-given))
12328 (setq what nil))
12329 (save-excursion
12330 (save-restriction
12331 (let (col list elt ts buffer-invisibility-spec)
12332 (org-back-to-heading t)
12334 (goto-char (match-end 1))
12335 (setq col (current-column))
12336 (goto-char (match-end 0))
12338 (when (and (not what)
12339 (not (looking-at
12341 org-keyword-time-not-clock-regexp))))
12342 ;; Nothing to add, nothing to remove...... :-)
12343 (throw 'exit nil))
12344 (if (and (not (looking-at org-outline-regexp))
12347 (not (equal (match-string 1) org-clock-string)))
12348 (narrow-to-region (match-beginning 0) (match-end 0))
12350 (backward-char 1)
12351 (narrow-to-region (point) (point))
12352 (and org-adapt-indentation (org-indent-to-column col)))
12353 ;; Check if we have to remove something.
12354 (setq list (cons what remove))
12355 (while list
12356 (setq elt (pop list))
12357 (when (or (and (eq elt 'scheduled)
12358 (re-search-forward org-scheduled-time-regexp nil t))
12359 (and (eq elt 'deadline)
12360 (re-search-forward org-deadline-time-regexp nil t))
12361 (and (eq elt 'closed)
12362 (re-search-forward org-closed-time-regexp nil t)))
12363 (replace-match "")
12364 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12366 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12367 (when what
12368 (insert
12369 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12370 (cond ((eq what 'scheduled) org-scheduled-string)
12371 ((eq what 'deadline) org-deadline-string)
12372 ((eq what 'closed) org-closed-string))
12373 " ")
12374 (setq ts (org-insert-time-stamp
12375 time
12376 (or org-time-was-given
12377 (and (eq what 'closed) org-log-done-with-time))
12378 (eq what 'closed)
12379 nil nil (list org-end-time-was-given)))
12380 (insert
12381 (if (not (or (bolp) (eq (char-before) ?\ )
12382 (memq (char-after) '(32 10))
12383 (eobp))) " " ""))
12384 (end-of-line 1))
12385 (goto-char (point-min))
12386 (widen)
12389 (delete-region (1- (point)) (point-at-eol)))
12390 ts))))))
12392 (defvar org-log-note-marker (make-marker))
12393 (defvar org-log-note-purpose nil)
12394 (defvar org-log-note-state nil)
12395 (defvar org-log-note-previous-state nil)
12396 (defvar org-log-note-how nil)
12397 (defvar org-log-note-extra nil)
12398 (defvar org-log-note-window-configuration nil)
12399 (defvar org-log-note-return-to (make-marker))
12400 (defvar org-log-note-effective-time nil
12401 "Remembered current time so that dynamically scoped
12402 `org-extend-today-until' affects tha timestamps in state change
12403 log")
12405 (defvar org-log-post-message nil
12406 "Message to be displayed after a log note has been stored.
12407 The auto-repeater uses this.")
12409 (defun org-add-note ()
12410 "Add a note to the current entry.
12411 This is done in the same way as adding a state change note."
12412 (interactive)
12413 (org-add-log-setup 'note nil nil 'findpos nil))
12415 (defvar org-property-end-re)
12416 (defun org-add-log-setup (&optional purpose state prev-state
12417 findpos how extra)
12418 "Set up the post command hook to take a note.
12419 If this is about to TODO state change, the new state is expected in STATE.
12420 When FINDPOS is non-nil, find the correct position for the note in
12421 the current entry. If not, assume that it can be inserted at point.
12422 HOW is an indicator what kind of note should be created.
12423 EXTRA is additional text that will be inserted into the notes buffer."
12424 (let* ((org-log-into-drawer (org-log-into-drawer))
12425 (drawer (cond ((stringp org-log-into-drawer)
12426 org-log-into-drawer)
12427 (org-log-into-drawer "LOGBOOK"))))
12428 (save-restriction
12429 (save-excursion
12430 (when findpos
12431 (org-back-to-heading t)
12432 (narrow-to-region (point) (save-excursion
12433 (outline-next-heading) (point)))
12437 (goto-char (match-end 0))
12438 (cond
12439 (drawer
12441 nil t)
12442 (progn
12443 (goto-char (match-end 0))
12444 (or org-log-states-order-reversed
12445 (and (re-search-forward org-property-end-re nil t)
12446 (goto-char (1- (match-beginning 0))))))
12448 (beginning-of-line 0)
12449 (org-indent-line)
12450 (beginning-of-line 2)
12451 (org-indent-line)
12452 (end-of-line 0)))
12453 ((and org-log-state-notes-insert-after-drawers
12454 (save-excursion
12455 (forward-line) (looking-at org-drawer-regexp)))
12456 (forward-line)
12457 (while (looking-at org-drawer-regexp)
12458 (goto-char (match-end 0))
12459 (re-search-forward org-property-end-re (point-max) t)
12460 (forward-line))
12461 (forward-line -1)))
12462 (unless org-log-states-order-reversed
12464 (org-skip-over-state-notes)
12466 (move-marker org-log-note-marker (point))
12467 (setq org-log-note-purpose purpose
12468 org-log-note-state state
12469 org-log-note-previous-state prev-state
12470 org-log-note-how how
12471 org-log-note-extra extra
12472 org-log-note-effective-time (org-current-effective-time))
12473 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12475 (defun org-skip-over-state-notes ()
12476 "Skip past the list of State notes in an entry."
12478 (when (ignore-errors (goto-char (org-in-item-p)))
12479 (let* ((struct (org-list-struct))
12480 (prevs (org-list-prevs-alist struct)))
12482 (goto-char (or (org-list-get-next-item (point) struct prevs)
12483 (org-list-get-item-end (point) struct)))))))
12485 (defun org-add-log-note (&optional purpose)
12486 "Pop up a window for taking a note, and add this note later at point."
12487 (remove-hook 'post-command-hook 'org-add-log-note)
12488 (setq org-log-note-window-configuration (current-window-configuration))
12489 (delete-other-windows)
12490 (move-marker org-log-note-return-to (point))
12491 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12492 (goto-char org-log-note-marker)
12493 (org-switch-to-buffer-other-window "*Org Note*")
12494 (erase-buffer)
12495 (if (memq org-log-note-how '(time state))
12496 (let (current-prefix-arg) (org-store-log-note))
12497 (let ((org-inhibit-startup t)) (org-mode))
12498 (insert (format "# Insert note for %s.
12500 (cond
12501 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12502 ((eq org-log-note-purpose 'done) "closed todo item")
12503 ((eq org-log-note-purpose 'state)
12505 (or org-log-note-previous-state "")
12506 (or org-log-note-state "")))
12507 ((eq org-log-note-purpose 'reschedule)
12508 "rescheduling")
12509 ((eq org-log-note-purpose 'delschedule)
12510 "no longer scheduled")
12511 ((eq org-log-note-purpose 'redeadline)
12512 "changing deadline")
12513 ((eq org-log-note-purpose 'deldeadline)
12514 "removing deadline")
12515 ((eq org-log-note-purpose 'refile)
12516 "refiling")
12517 ((eq org-log-note-purpose 'note)
12518 "this entry")
12519 (t (error "This should not happen")))))
12520 (if org-log-note-extra (insert org-log-note-extra))
12521 (org-set-local 'org-finish-function 'org-store-log-note)
12522 (run-hooks 'org-log-buffer-setup-hook)))
12524 (defvar org-note-abort nil) ; dynamically scoped
12525 (defun org-store-log-note ()
12526 "Finish taking a log note, and insert it to where it belongs."
12527 (let ((txt (buffer-string))
12528 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12529 lines ind bul)
12530 (kill-buffer (current-buffer))
12532 (setq txt (replace-match "" t t txt)))
12534 (setq txt (replace-match "" t t txt)))
12537 (setq note
12538 (org-replace-escapes
12539 note
12540 (list (cons "%u" (user-login-name))
12541 (cons "%U" user-full-name)
12542 (cons "%t" (format-time-string
12543 (org-time-stamp-format 'long 'inactive)
12544 org-log-note-effective-time))
12545 (cons "%T" (format-time-string
12546 (org-time-stamp-format 'long nil)
12547 org-log-note-effective-time))
12548 (cons "%d" (format-time-string
12549 (org-time-stamp-format nil 'inactive)
12550 org-log-note-effective-time))
12551 (cons "%D" (format-time-string
12552 (org-time-stamp-format nil nil)
12553 org-log-note-effective-time))
12554 (cons "%s" (if org-log-note-state
12556 ""))
12557 (cons "%S" (if org-log-note-previous-state
12561 (push note lines))
12562 (when (or current-prefix-arg org-note-abort)
12563 (when org-log-into-drawer
12564 (org-remove-empty-drawer-at
12565 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12566 org-log-note-marker))
12567 (setq lines nil))
12568 (when lines
12569 (with-current-buffer (marker-buffer org-log-note-marker)
12570 (save-excursion
12571 (goto-char org-log-note-marker)
12572 (move-marker org-log-note-marker nil)
12573 (end-of-line 1)
12575 (setq ind (save-excursion
12576 (if (ignore-errors (goto-char (org-in-item-p)))
12577 (let ((struct (org-list-struct)))
12578 (org-list-get-ind
12579 (org-list-get-top-point struct) struct))
12581 (cond
12582 ((and (org-at-heading-p)
12583 org-adapt-indentation)
12584 (1+ (org-current-level)))
12585 ((org-at-heading-p) 0)
12586 (t (org-get-indentation))))))
12587 (setq bul (org-list-bullet-string "-"))
12588 (org-indent-line-to ind)
12589 (insert bul (pop lines))
12590 (let ((ind-body (+ (length bul) ind)))
12591 (while lines
12593 (org-indent-line-to ind-body)
12594 (insert (pop lines))))
12595 (message "Note stored")
12596 (org-back-to-heading t)
12597 (org-cycle-hide-drawers 'children)))))
12598 (set-window-configuration org-log-note-window-configuration)
12599 (with-current-buffer (marker-buffer org-log-note-return-to)
12600 (goto-char org-log-note-return-to))
12601 (move-marker org-log-note-return-to nil)
12602 (and org-log-post-message (message "%s" org-log-post-message)))
12604 (defun org-remove-empty-drawer-at (drawer pos)
12605 "Remove an empty drawer DRAWER at position POS.
12606 POS may also be a marker."
12607 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12608 (save-excursion
12609 (save-restriction
12610 (widen)
12611 (goto-char pos)
12612 (if (org-in-regexp
12614 (replace-match ""))))))
12616 (defvar org-ts-type nil)
12617 (defun org-sparse-tree (&optional arg type)
12618 "Create a sparse tree, prompt for the details.
12619 This command can create sparse trees. You first need to select the type
12620 of match used to create the tree:
12622 t Show all TODO entries.
12623 T Show entries with a specific TODO keyword.
12624 m Show entries selected by a tags/property match.
12625 p Enter a property name and its value (both with completion on existing
12626 names/values) and show entries with that property.
12627 r Show entries matching a regular expression (`/' can be used as well).
12628 b Show deadlines and scheduled items before a date.
12629 a Show deadlines and scheduled items after a date.
12630 d Show deadlines due within `org-deadline-warning-days'.
12631 D Show deadlines and scheduled items between a date range."
12632 (interactive "P")
12633 (let (ans kwd value ts-type)
12634 (setq type (or type org-sparse-tree-default-date-type))
12635 (setq org-ts-type type)
12636 (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"
12637 (cond ((eq type 'all) "all timestamps")
12638 ((eq type 'scheduled) "only scheduled")
12639 ((eq type 'deadline) "only deadline")
12640 ((eq type 'active) "only active timestamps")
12641 ((eq type 'inactive) "only inactive timestamps")
12642 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
12643 (t "scheduled/deadline")))
12644 (setq ans (read-char-exclusive))
12645 (cond
12646 ((equal ans ?c)
12647 (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
12648 ((equal ans ?d)
12649 (call-interactively 'org-check-deadlines))
12650 ((equal ans ?b)
12651 (call-interactively 'org-check-before-date))
12652 ((equal ans ?a)
12653 (call-interactively 'org-check-after-date))
12654 ((equal ans ?D)
12655 (call-interactively 'org-check-dates-range))
12656 ((equal ans ?t)
12657 (org-show-todo-tree nil))
12658 ((equal ans ?T)
12659 (org-show-todo-tree '(4)))
12660 ((member ans '(?T ?m))
12661 (call-interactively 'org-match-sparse-tree))
12662 ((member ans '(?p ?P))
12663 (setq kwd (org-icompleting-read "Property: "
12664 (mapcar 'list (org-buffer-property-keys))))
12665 (setq value (org-icompleting-read "Value: "
12666 (mapcar 'list (org-property-values kwd))))
12669 (org-match-sparse-tree arg (concat kwd "=" value)))
12670 ((member ans '(?r ?R ?/))
12671 (call-interactively 'org-occur))
12674 (defvar org-occur-highlights nil
12675 "List of overlays used for occur matches.")
12676 (make-variable-buffer-local 'org-occur-highlights)
12677 (defvar org-occur-parameters nil
12678 "Parameters of the active org-occur calls.
12679 This is a list, each call to org-occur pushes as cons cell,
12680 containing the regular expression and the callback, onto the list.
12681 The list can contain several entries if `org-occur' has been called
12682 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12683 will only contain one set of parameters. When the highlights are
12684 removed (for example with `C-c C-c', or with the next edit (depending
12685 on `org-remove-highlights-with-change'), this variable is emptied
12686 as well.")
12687 (make-variable-buffer-local 'org-occur-parameters)
12689 (defun org-occur (regexp &optional keep-previous callback)
12690 "Make a compact tree which shows all matches of REGEXP.
12691 The tree will show the lines where the regexp matches, and all higher
12692 headlines above the match. It will also show the heading after the match,
12693 to make sure editing the matching entry is easy.
12694 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12695 call to `org-occur' will be kept, to allow stacking of calls to this
12696 command.
12697 If CALLBACK is non-nil, it is a function which is called to confirm
12698 that the match should indeed be shown."
12700 (when (equal regexp "")
12701 (error "Regexp cannot be empty"))
12702 (unless keep-previous
12703 (org-remove-occur-highlights nil nil t))
12704 (push (cons regexp callback) org-occur-parameters)
12705 (let ((cnt 0))
12706 (save-excursion
12707 (goto-char (point-min))
12708 (if (or (not keep-previous) ; do not want to keep
12709 (not org-occur-highlights)) ; no previous matches
12710 ;; hide everything
12711 (org-overview))
12712 (while (re-search-forward regexp nil t)
12713 (when (or (not callback)
12714 (save-match-data (funcall callback)))
12715 (setq cnt (1+ cnt))
12716 (when org-highlight-sparse-tree-matches
12717 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12718 (org-show-context 'occur-tree))))
12719 (when org-remove-highlights-with-change
12720 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12721 nil 'local))
12722 (unless org-sparse-tree-open-archived-trees
12723 (org-hide-archived-subtrees (point-min) (point-max)))
12724 (run-hooks 'org-occur-hook)
12725 (if (org-called-interactively-p 'interactive)
12726 (message "%d match(es) for regexp %s" cnt regexp))
12727 cnt))
12729 (defun org-occur-next-match (&optional n reset)
12730 "Function for `next-error-function' to find sparse tree matches.
12731 N is the number of matches to move, when negative move backwards.
12732 RESET is entirely ignored - this function always goes back to the
12733 starting point when no match is found."
12734 (let* ((limit (if (< n 0) (point-min) (point-max)))
12735 (search-func (if (< n 0)
12736 'previous-single-char-property-change
12737 'next-single-char-property-change))
12738 (n (abs n))
12739 (pos (point))
12740 p1)
12741 (catch 'exit
12742 (while (setq p1 (funcall search-func (point) 'org-type))
12743 (when (equal p1 limit)
12744 (goto-char pos)
12745 (error "No more matches"))
12746 (when (equal (get-char-property p1 'org-type) 'org-occur)
12747 (setq n (1- n))
12748 (when (= n 0)
12749 (goto-char p1)
12750 (throw 'exit (point))))
12751 (goto-char p1))
12752 (goto-char p1)
12753 (error "No more matches"))))
12755 (defun org-show-context (&optional key)
12756 "Make sure point and context are visible.
12757 How much context is shown depends upon the variables
12758 `org-show-hierarchy-above', `org-show-following-heading',
12759 `org-show-entry-below' and `org-show-siblings'."
12760 (let ((heading-p (org-at-heading-p t))
12761 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12762 (following-p (org-get-alist-option org-show-following-heading key))
12763 (entry-p (org-get-alist-option org-show-entry-below key))
12764 (siblings-p (org-get-alist-option org-show-siblings key)))
12765 (catch 'exit
12766 ;; Show heading or entry text
12767 (if (and heading-p (not entry-p))
12768 (org-flag-heading nil) ; only show the heading
12769 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12770 (org-show-hidden-entry))) ; show entire entry
12771 (when following-p
12772 ;; Show next sibling, or heading below text
12773 (save-excursion
12774 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12775 (org-flag-heading nil))))
12776 (when siblings-p (org-show-siblings))
12777 (when hierarchy-p
12778 ;; show all higher headings, possibly with siblings
12779 (save-excursion
12780 (while (and (condition-case nil
12781 (progn (org-up-heading-all 1) t)
12782 (error nil))
12783 (not (bobp)))
12784 (org-flag-heading nil)
12785 (when siblings-p (org-show-siblings))))))))
12787 (defvar org-reveal-start-hook nil
12788 "Hook run before revealing a location.")
12790 (defun org-reveal (&optional siblings)
12791 "Show current entry, hierarchy above it, and the following headline.
12792 This can be used to show a consistent set of context around locations
12793 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12794 not t for the search context.
12796 With optional argument SIBLINGS, on each level of the hierarchy all
12797 siblings are shown. This repairs the tree structure to what it would
12798 look like when opened with hierarchical calls to `org-cycle'.
12800 go to the parent and show the
12801 entire tree."
12802 (interactive "P")
12803 (run-hooks 'org-reveal-start-hook)
12804 (let ((org-show-hierarchy-above t)
12805 (org-show-following-heading t)
12806 (org-show-siblings (if siblings t org-show-siblings)))
12807 (org-show-context nil))
12808 (when (equal siblings '(16))
12809 (save-excursion
12810 (when (org-up-heading-safe)
12811 (org-show-subtree)
12812 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12814 (defun org-highlight-new-match (beg end)
12815 "Highlight from BEG to END and mark the highlight is an occur headline."
12816 (let ((ov (make-overlay beg end)))
12817 (overlay-put ov 'face 'secondary-selection)
12818 (overlay-put ov 'org-type 'org-occur)
12819 (push ov org-occur-highlights)))
12821 (defun org-remove-occur-highlights (&optional beg end noremove)
12822 "Remove the occur highlights from the buffer.
12823 BEG and END are ignored. If NOREMOVE is nil, remove this function
12824 from the `before-change-functions' in the current buffer."
12825 (interactive)
12826 (unless org-inhibit-highlight-removal
12827 (mapc 'delete-overlay org-occur-highlights)
12828 (setq org-occur-highlights nil)
12829 (setq org-occur-parameters nil)
12830 (unless noremove
12831 (remove-hook 'before-change-functions
12832 'org-remove-occur-highlights 'local))))
12834 ;;;; Priorities
12837 "Regular expression matching the priority indicator.")
12839 (defvar org-remove-priority-next-time nil)
12841 (defun org-priority-up ()
12842 "Increase the priority of the current item."
12843 (interactive)
12844 (org-priority 'up))
12846 (defun org-priority-down ()
12847 "Decrease the priority of the current item."
12848 (interactive)
12849 (org-priority 'down))
12851 (defun org-priority (&optional action show)
12852 "Change the priority of an item.
12853 ACTION can be `set', `up', `down', or a character."
12854 (interactive "P")
12855 (if (equal action '(4))
12856 (org-show-priority)
12857 (unless org-enable-priority-commands
12858 (error "Priority commands are disabled"))
12859 (setq action (or action 'set))
12860 (let (current new news have remove)
12861 (save-excursion
12862 (org-back-to-heading t)
12863 (if (looking-at org-priority-regexp)
12864 (setq current (string-to-char (match-string 2))
12865 have t))
12866 (cond
12867 ((eq action 'remove)
12868 (setq remove t new ?\ ))
12869 ((or (eq action 'set)
12870 (if (featurep 'xemacs) (characterp action) (integerp action)))
12871 (if (not (eq action 'set))
12872 (setq new action)
12873 (message "Priority %c-%c, SPC to remove: "
12874 org-highest-priority org-lowest-priority)
12875 (save-match-data
12876 (setq new (read-char-exclusive))))
12877 (if (and (= (upcase org-highest-priority) org-highest-priority)
12878 (= (upcase org-lowest-priority) org-lowest-priority))
12879 (setq new (upcase new)))
12880 (cond ((equal new ?\ ) (setq remove t))
12881 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12882 (error "Priority must be between `%c' and `%c'"
12883 org-highest-priority org-lowest-priority))))
12884 ((eq action 'up)
12885 (setq new (if have
12886 (1- current) ; normal cycling
12887 ;; last priority was empty
12888 (if (eq last-command this-command)
12889 org-lowest-priority ; wrap around empty to lowest
12890 ;; default
12891 (if org-priority-start-cycle-with-default
12892 org-default-priority
12893 (1- org-default-priority))))))
12894 ((eq action 'down)
12895 (setq new (if have
12896 (1+ current) ; normal cycling
12897 ;; last priority was empty
12898 (if (eq last-command this-command)
12899 org-highest-priority ; wrap around empty to highest
12900 ;; default
12901 (if org-priority-start-cycle-with-default
12902 org-default-priority
12903 (1+ org-default-priority))))))
12904 (t (error "Invalid action")))
12905 (if (or (< (upcase new) org-highest-priority)
12906 (> (upcase new) org-lowest-priority))
12907 (if (and (memq action '(up down))
12908 (not have) (not (eq last-command this-command)))
12909 ;; `new' is from default priority
12910 (error
12911 "The default can not be set, see `org-default-priority' why")
12912 ;; normal cycling: `new' is beyond highest/lowest priority
12913 ;; and is wrapped around to the empty priority
12914 (setq remove t)))
12915 (setq news (format "%c" new))
12916 (if have
12917 (if remove
12918 (replace-match "" t t nil 1)
12919 (replace-match news t t nil 2))
12920 (if remove
12921 (error "No priority cookie found in line")
12922 (let ((case-fold-search nil))
12923 (looking-at org-todo-line-regexp))
12924 (if (match-end 2)
12925 (progn
12926 (goto-char (match-end 2))
12927 (insert " [#" news "]"))
12928 (goto-char (match-beginning 3))
12929 (insert "[#" news "] "))))
12930 (org-preserve-lc (org-set-tags nil 'align)))
12931 (if remove
12932 (message "Priority removed")
12933 (message "Priority of current item set to %s" news)))))
12935 (defun org-show-priority ()
12936 "Show the priority of the current item.
12937 This priority is composed of the main priority given with the [#A] cookies,
12938 and by additional input from the age of a schedules or deadline entry."
12939 (interactive)
12940 (let ((pri (if (eq major-mode 'org-agenda-mode)
12941 (org-get-at-bol 'priority)
12942 (save-excursion
12943 (save-match-data
12944 (beginning-of-line)
12945 (and (looking-at org-heading-regexp)
12946 (org-get-priority (match-string 0))))))))
12947 (message "Priority is %d" (if pri pri -1000))))
12949 (defun org-get-priority (s)
12950 "Find priority cookie and return priority."
12951 (if (functionp org-get-priority-function)
12952 (funcall org-get-priority-function)
12953 (save-match-data
12954 (if (not (string-match org-priority-regexp s))
12955 (* 1000 (- org-lowest-priority org-default-priority))
12956 (* 1000 (- org-lowest-priority
12957 (string-to-char (match-string 2 s))))))))
12959 ;;;; Tags
12961 (defvar org-agenda-archives-mode)
12962 (defvar org-map-continue-from nil
12963 "Position from where mapping should continue.
12964 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12966 (defvar org-scanner-tags nil
12967 "The current tag list while the tags scanner is running.")
12968 (defvar org-trust-scanner-tags nil
12969 "Should `org-get-tags-at' use the tags for the scanner.
12970 This is for internal dynamical scoping only.
12971 When this is non-nil, the function `org-get-tags-at' will return the value
12972 of `org-scanner-tags' instead of building the list by itself. This
12973 can lead to large speed-ups when the tags scanner is used in a file with
12974 many entries, and when the list of tags is retrieved, for example to
12975 obtain a list of properties. Building the tags list for each entry in such
12976 a file becomes an N^2 operation - but with this variable set, it scales
12977 as N.")
12979 (defun org-scan-tags (action matcher todo-only &optional start-level)
12980 "Scan headline tags with inheritance and produce output ACTION.
12982 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12983 or `agenda' to produce an entry list for an agenda view. It can also be
12984 a Lisp form or a function that should be called at each matched headline, in
12985 this case the return value is a list of all return values from these calls.
12987 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12988 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12989 only lines with a not-done TODO keyword are included in the output.
12990 This should be the same variable that was scoped into
12991 and set by `org-make-tags-matcher' when it constructed MATCHER.
12993 START-LEVEL can be a string with asterisks, reducing the scope to
12994 headlines matching this string."
12995 (require 'org-agenda)
12996 (let* ((re (concat "^"
12997 (if start-level
12998 ;; Get the correct level to match
13000 org-outline-regexp)
13004 (props (list 'face 'default
13005 'done-face 'org-agenda-done
13006 'undone-face 'default
13007 'mouse-face 'highlight
13008 'org-not-done-regexp org-not-done-regexp
13009 'org-todo-regexp org-todo-regexp
13010 'org-complex-heading-regexp org-complex-heading-regexp
13011 'help-echo
13012 (format "mouse-2 or RET jump to org file %s"
13013 (abbreviate-file-name
13014 (or (buffer-file-name (buffer-base-buffer))
13015 (buffer-name (buffer-base-buffer)))))))
13016 (case-fold-search nil)
13017 (org-map-continue-from nil)
13018 lspos tags tags-list
13019 (tags-alist (list (cons 0 org-file-tags)))
13020 (llast 0) rtn rtn1 level category i txt
13021 todo marker entry priority)
13022 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13023 (setq action (list 'lambda nil action)))
13024 (save-excursion
13025 (goto-char (point-min))
13026 (when (eq action 'sparse-tree)
13027 (org-overview)
13028 (org-remove-occur-highlights))
13029 (while (re-search-forward re nil t)
13030 (setq org-map-continue-from nil)
13031 (catch :skip
13032 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13033 tags (if (match-end 4) (org-match-string-no-properties 4)))
13034 (goto-char (setq lspos (match-beginning 0)))
13035 (setq level (org-reduced-level (funcall outline-level))
13036 category (org-get-category))
13037 (setq i llast llast level)
13038 ;; remove tag lists from same and sublevels
13039 (while (>= i level)
13040 (when (setq entry (assoc i tags-alist))
13041 (setq tags-alist (delete entry tags-alist)))
13042 (setq i (1- i)))
13043 ;; add the next tags
13044 (when tags
13045 (setq tags (org-split-string tags ":")
13046 tags-alist
13047 (cons (cons level tags) tags-alist)))
13048 ;; compile tags for current headline
13049 (setq tags-list
13050 (if org-use-tag-inheritance
13051 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13052 tags)
13053 org-scanner-tags tags-list)
13054 (when org-use-tag-inheritance
13055 (setcdr (car tags-alist)
13056 (mapcar (lambda (x)
13057 (setq x (copy-sequence x))
13058 (org-add-prop-inherited x))
13059 (cdar tags-alist))))
13060 (when (and tags org-use-tag-inheritance
13061 (or (not (eq t org-use-tag-inheritance))
13062 org-tags-exclude-from-inheritance))
13063 ;; selective inheritance, remove uninherited ones
13064 (setcdr (car tags-alist)
13065 (org-remove-uninherited-tags (cdar tags-alist))))
13066 (when (and
13068 ;; eval matcher only when the todo condition is OK
13069 (and (or (not todo-only) (member todo org-not-done-keywords))
13070 (let ((case-fold-search t) (org-trust-scanner-tags t))
13071 (eval matcher)))
13073 ;; Call the skipper, but return t if it does not skip,
13074 ;; so that the `and' form continues evaluating
13075 (progn
13076 (unless (eq action 'sparse-tree) (org-agenda-skip))
13077 t)
13079 ;; Check if timestamps are deselecting this entry
13080 (or (not todo-only)
13081 (and (member todo org-not-done-keywords)
13082 (or (not org-agenda-tags-todo-honor-ignore-options)
13083 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
13085 ;; Extra check for the archive tag
13086 ;; FIXME: Does the skipper already do this????
13087 (or
13088 (not (member org-archive-tag tags-list))
13089 ;; we have an archive tag, should we use this anyway?
13090 (or (not org-agenda-skip-archived-trees)
13091 (and (eq action 'agenda) org-agenda-archives-mode))))
13093 ;; select this headline
13095 (cond
13096 ((eq action 'sparse-tree)
13097 (and org-highlight-sparse-tree-matches
13098 (org-get-heading) (match-end 0)
13099 (org-highlight-new-match
13100 (match-beginning 1) (match-end 1)))
13101 (org-show-context 'tags-tree))
13102 ((eq action 'agenda)
13103 (setq txt (org-agenda-format-item
13104 ""
13105 (concat
13106 (if (eq org-tags-match-list-sublevels 'indented)
13107 (make-string (1- level) ?.) "")
13108 (org-get-heading))
13109 category
13110 tags-list)
13111 priority (org-get-priority txt))
13112 (goto-char lspos)
13113 (setq marker (org-agenda-new-marker))
13114 (org-add-props txt props
13115 'org-marker marker 'org-hd-marker marker 'org-category category
13116 'todo-state todo
13117 'priority priority 'type "tagsmatch")
13118 (push txt rtn))
13119 ((functionp action)
13120 (setq org-map-continue-from nil)
13121 (save-excursion
13122 (setq rtn1 (funcall action))
13123 (push rtn1 rtn)))
13124 (t (error "Invalid action")))
13126 ;; if we are to skip sublevels, jump to end of subtree
13127 (unless org-tags-match-list-sublevels
13128 (org-end-of-subtree t)
13129 (backward-char 1))))
13130 ;; Get the correct position from where to continue
13131 (if org-map-continue-from
13132 (goto-char org-map-continue-from)
13133 (and (= (point) lspos) (end-of-line 1)))))
13134 (when (and (eq action 'sparse-tree)
13135 (not org-sparse-tree-open-archived-trees))
13136 (org-hide-archived-subtrees (point-min) (point-max)))
13137 (nreverse rtn)))
13139 (defun org-remove-uninherited-tags (tags)
13140 "Remove all tags that are not inherited from the list TAGS."
13141 (cond
13142 ((eq org-use-tag-inheritance t)
13143 (if org-tags-exclude-from-inheritance
13144 (org-delete-all org-tags-exclude-from-inheritance tags)
13145 tags))
13146 ((not org-use-tag-inheritance) nil)
13147 ((stringp org-use-tag-inheritance)
13148 (delq nil (mapcar
13149 (lambda (x)
13150 (if (and (string-match org-use-tag-inheritance x)
13151 (not (member x org-tags-exclude-from-inheritance)))
13152 x nil))
13153 tags)))
13154 ((listp org-use-tag-inheritance)
13155 (delq nil (mapcar
13156 (lambda (x)
13157 (if (member x org-use-tag-inheritance) x nil))
13158 tags)))))
13160 (defun org-match-sparse-tree (&optional todo-only match)
13161 "Create a sparse tree according to tags string MATCH.
13162 MATCH can contain positive and negative selection of tags, like
13164 If optional argument TODO-ONLY is non-nil, only select lines that are
13165 also TODO lines."
13166 (interactive "P")
13167 (org-agenda-prepare-buffers (list (current-buffer)))
13168 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13170 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13172 (defvar org-cached-props nil)
13173 (defun org-cached-entry-get (pom property)
13174 (if (or (eq t org-use-property-inheritance)
13175 (and (stringp org-use-property-inheritance)
13176 (string-match org-use-property-inheritance property))
13177 (and (listp org-use-property-inheritance)
13178 (member property org-use-property-inheritance)))
13179 ;; Caching is not possible, check it directly
13180 (org-entry-get pom property 'inherit)
13181 ;; Get all properties, so that we can do complicated checks easily
13182 (cdr (assoc property (or org-cached-props
13183 (setq org-cached-props
13184 (org-entry-properties pom)))))))
13186 (defun org-global-tags-completion-table (&optional files)
13187 "Return the list of all tags in all agenda buffer/files.
13188 Optional FILES argument is a list of files which can be used
13189 instead of the agenda files."
13190 (save-excursion
13191 (org-uniquify
13192 (delq nil
13193 (apply 'append
13194 (mapcar
13195 (lambda (file)
13196 (set-buffer (find-file-noselect file))
13197 (append (org-get-buffer-tags)
13198 (mapcar (lambda (x) (if (stringp (car-safe x))
13199 (list (car-safe x)) nil))
13200 org-tag-alist)))
13201 (if (and files (car files))
13202 files
13203 (org-agenda-files))))))))
13205 (defun org-make-tags-matcher (match)
13206 "Create the TAGS/TODO matcher form for the selection string MATCH.
13208 The variable `todo-only' is scoped dynamically into this function.
13209 It will be set to t if the matcher restricts matching to TODO entries,
13210 otherwise will not be touched.
13212 Returns a cons of the selection string MATCH and the constructed
13213 lisp form implementing the matcher. The matcher is to be evaluated
13214 at an Org entry, with point on the headline, and returns t if the
13215 entry matches the selection string MATCH. The returned lisp form
13216 references two variables with information about the entry, which
13217 must be bound around the form's evaluation: todo, the TODO keyword
13218 at the entry (or nil of none); and tags-list, the list of all tags
13219 at the entry including inherited ones. Additionally, the category
13220 of the entry (if any) must be specified as the text property
13221 'org-category on the headline.
13223 See also `org-scan-tags'.
13224 "
13225 (declare (special todo-only))
13226 (unless (boundp 'todo-only)
13227 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13228 (unless match
13229 ;; Get a new match request, with completion
13230 (let ((org-last-tags-completion-table
13231 (org-global-tags-completion-table)))
13232 (setq match (org-completing-read-no-i
13233 "Match: " 'org-tags-completion-function nil nil nil
13234 'org-tags-history))))
13236 ;; Parse the string and create a lisp form
13237 (let ((match0 match)
13238 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13239 minus tag mm
13240 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13241 orterms term orlist re-p str-p level-p level-op time-p
13242 prop-p pn pv po gv rest)
13243 (if (string-match "/+" match)
13244 ;; match contains also a todo-matching request
13245 (progn
13246 (setq tagsmatch (substring match 0 (match-beginning 0))
13247 todomatch (substring match (match-end 0)))
13248 (if (string-match "^!" todomatch)
13249 (setq todo-only t todomatch (substring todomatch 1)))
13251 (setq todomatch nil)))
13252 ;; only matching tags
13253 (setq tagsmatch match todomatch nil))
13255 ;; Make the tags matcher
13257 (setq tagsmatcher t)
13258 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13259 (while (setq term (pop orterms))
13261 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13262 (while (string-match re term)
13263 (setq rest (substring term (match-end 0))
13264 minus (and (match-end 1)
13265 (equal (match-string 1 term) "-"))
13266 tag (save-match-data (replace-regexp-in-string
13268 (match-string 2 term)))
13269 re-p (equal (string-to-char tag) ?{)
13270 level-p (match-end 4)
13271 prop-p (match-end 5)
13272 mm (cond
13273 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13274 (level-p
13275 (setq level-op (org-op-to-function (match-string 3 term)))
13276 `(,level-op level ,(string-to-number
13277 (match-string 4 term))))
13278 (prop-p
13279 (setq pn (match-string 5 term)
13280 po (match-string 6 term)
13281 pv (match-string 7 term)
13282 re-p (equal (string-to-char pv) ?{)
13284 time-p (save-match-data
13286 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13287 (if time-p (setq pv (org-matcher-time pv)))
13288 (setq po (org-op-to-function po (if time-p 'time str-p)))
13289 (cond
13290 ((equal pn "CATEGORY")
13291 (setq gv '(get-text-property (point) 'org-category)))
13292 ((equal pn "TODO")
13293 (setq gv 'todo))
13294 (t
13295 (setq gv `(org-cached-entry-get nil ,pn))))
13296 (if re-p
13297 (if (eq po 'org<>)
13298 `(not (string-match ,pv (or ,gv "")))
13299 `(string-match ,pv (or ,gv "")))
13300 (if str-p
13301 `(,po (or ,gv "") ,pv)
13302 `(,po (string-to-number (or ,gv ""))
13303 ,(string-to-number pv) ))))
13304 (t `(member ,tag tags-list)))
13305 mm (if minus (list 'not mm) mm)
13306 term rest)
13307 (push mm tagsmatcher))
13308 (push (if (> (length tagsmatcher) 1)
13309 (cons 'and tagsmatcher)
13310 (car tagsmatcher))
13311 orlist)
13312 (setq tagsmatcher nil))
13313 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13314 (setq tagsmatcher
13315 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13316 ;; Make the todo matcher
13318 (setq todomatcher t)
13319 (setq orterms (org-split-string todomatch "|") orlist nil)
13320 (while (setq term (pop orterms))
13321 (while (string-match re term)
13322 (setq minus (and (match-end 1)
13323 (equal (match-string 1 term) "-"))
13324 kwd (match-string 2 term)
13325 re-p (equal (string-to-char kwd) ?{)
13326 term (substring term (match-end 0))
13327 mm (if re-p
13328 `(string-match ,(substring kwd 1 -1) todo)
13329 (list 'equal 'todo kwd))
13330 mm (if minus (list 'not mm) mm))
13331 (push mm todomatcher))
13332 (push (if (> (length todomatcher) 1)
13333 (cons 'and todomatcher)
13334 (car todomatcher))
13335 orlist)
13336 (setq todomatcher nil))
13337 (setq todomatcher (if (> (length orlist) 1)
13338 (cons 'or orlist) (car orlist))))
13340 ;; Return the string and lisp forms of the matcher
13341 (setq matcher (if todomatcher
13342 (list 'and tagsmatcher todomatcher)
13343 tagsmatcher))
13344 (when todo-only
13345 (setq matcher (list 'and '(member todo org-not-done-keywords)
13346 matcher)))
13347 (cons match0 matcher)))
13349 (defun org-op-to-function (op &optional stringp)
13350 "Turn an operator into the appropriate function."
13351 (setq op
13352 (cond
13353 ((equal op "<" ) '(< string< org-time<))
13354 ((equal op ">" ) '(> org-string> org-time>))
13355 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13356 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13357 ((member op '("=" "==")) '(= string= org-time=))
13358 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13359 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13361 (defun org<> (a b) (not (= a b)))
13362 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13363 (defun org-string>= (a b) (not (string< a b)))
13364 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13365 (defun org-string<> (a b) (not (string= a b)))
13366 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13367 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13368 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13369 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13370 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13371 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13372 (defun org-2ft (s)
13373 "Convert S to a floating point time.
13374 If S is already a number, just return it. If it is a string, parse
13375 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13376 (cond
13377 ((numberp s) s)
13378 ((stringp s)
13379 (condition-case nil
13380 (float-time (apply 'encode-time (org-parse-time-string s)))
13381 (error 0.)))
13382 (t 0.)))
13384 (defun org-time-today ()
13385 "Time in seconds today at 0:00.
13386 Returns the float number of seconds since the beginning of the
13387 epoch to the beginning of today (00:00)."
13388 (float-time (apply 'encode-time
13389 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13391 (defun org-matcher-time (s)
13392 "Interpret a time comparison value."
13393 (save-match-data
13394 (cond
13395 ((string= s "<now>") (float-time))
13396 ((string= s "<today>") (org-time-today))
13397 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13398 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13400 (+ (org-time-today)
13401 (* (string-to-number (match-string 1 s))
13402 (cdr (assoc (match-string 2 s)
13403 '(("d" . 86400.0) ("w" . 604800.0)
13404 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13405 (t (org-2ft s)))))
13407 (defun org-match-any-p (re list)
13408 "Does re match any element of list?"
13409 (setq list (mapcar (lambda (x) (string-match re x)) list))
13410 (delq nil list))
13412 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13413 (defvar org-tags-overlay (make-overlay 1 1))
13414 (org-detach-overlay org-tags-overlay)
13416 (defun org-get-local-tags-at (&optional pos)
13417 "Get a list of tags defined in the current headline."
13418 (org-get-tags-at pos 'local))
13420 (defun org-get-local-tags ()
13421 "Get a list of tags defined in the current headline."
13422 (org-get-tags-at nil 'local))
13424 (defun org-get-tags-at (&optional pos local)
13425 "Get a list of all headline tags applicable at POS.
13426 POS defaults to point. If tags are inherited, the list contains
13427 the targets in the same sequence as the headlines appear, i.e.
13428 the tags of the current headline come last.
13429 When LOCAL is non-nil, only return tags from the current headline,
13430 ignore inherited ones."
13431 (interactive)
13432 (if (and org-trust-scanner-tags
13433 (or (not pos) (equal pos (point)))
13434 (not local))
13435 org-scanner-tags
13436 (let (tags ltags lastpos parent)
13437 (save-excursion
13438 (save-restriction
13439 (widen)
13440 (goto-char (or pos (point)))
13441 (save-match-data
13442 (catch 'done
13443 (condition-case nil
13444 (progn
13445 (org-back-to-heading t)
13446 (while (not (equal lastpos (point)))
13447 (setq lastpos (point))
13448 (when (looking-at
13450 (setq ltags (org-split-string
13451 (org-match-string-no-properties 1) ":"))
13452 (when parent
13453 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13454 (setq tags (append
13455 (if parent
13456 (org-remove-uninherited-tags ltags)
13457 ltags)
13458 tags)))
13459 (or org-use-tag-inheritance (throw 'done t))
13460 (if local (throw 'done t))
13461 (or (org-up-heading-safe) (error nil))
13462 (setq parent t)))
13463 (error nil)))))
13464 (if local
13465 tags
13466 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13468 (defun org-add-prop-inherited (s)
13469 (add-text-properties 0 (length s) '(inherited t) s)
13470 s)
13472 (defun org-toggle-tag (tag &optional onoff)
13473 "Toggle the tag TAG for the current line.
13474 If ONOFF is `on' or `off', don't toggle but set to this state."
13475 (let (res current)
13476 (save-excursion
13477 (org-back-to-heading t)
13479 (point-at-eol) t)
13480 (progn
13481 (setq current (match-string 1))
13482 (replace-match ""))
13483 (setq current ""))
13484 (setq current (nreverse (org-split-string current ":")))
13485 (cond
13486 ((eq onoff 'on)
13487 (setq res t)
13488 (or (member tag current) (push tag current)))
13489 ((eq onoff 'off)
13490 (or (not (member tag current)) (setq current (delete tag current))))
13491 (t (if (member tag current)
13492 (setq current (delete tag current))
13493 (setq res t)
13494 (push tag current))))
13495 (end-of-line 1)
13496 (if current
13497 (progn
13498 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13499 (org-set-tags nil t))
13500 (delete-horizontal-space))
13501 (run-hooks 'org-after-tags-change-hook))
13502 res))
13504 (defun org-align-tags-here (to-col)
13505 ;; Assumes that this is a headline
13506 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13507 (beginning-of-line 1)
13509 (< pos (match-beginning 2)))
13510 (progn
13511 (setq tags-l (- (match-end 2) (match-beginning 2)))
13512 (goto-char (match-beginning 1))
13513 (insert " ")
13514 (delete-region (point) (1+ (match-beginning 2)))
13515 (setq ncol (max (current-column)
13516 (1+ col)
13517 (if (> to-col 0)
13518 to-col
13519 (- (abs to-col) tags-l))))
13520 (setq p (point))
13521 (insert (make-string (- ncol (current-column)) ?\ ))
13522 (setq ncol (current-column))
13523 (when indent-tabs-mode (tabify p (point-at-eol)))
13524 (org-move-to-column (min ncol col) t))
13525 (goto-char pos))))
13527 (defun org-set-tags-command (&optional arg just-align)
13528 "Call the set-tags command for the current entry."
13529 (interactive "P")
13530 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13531 (org-set-tags arg just-align)
13532 (save-excursion
13533 (org-back-to-heading t)
13534 (org-set-tags arg just-align))))
13536 (defun org-set-tags-to (data)
13537 "Set the tags of the current entry to DATA, replacing the current tags.
13538 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13539 If DATA is nil or the empty string, any tags will be removed."
13540 (interactive "sTags: ")
13541 (setq data
13542 (cond
13543 ((eq data nil) "")
13544 ((equal data "") "")
13545 ((stringp data)
13546 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13547 ":"))
13548 ((listp data)
13549 (concat ":" (mapconcat 'identity data ":") ":"))))
13550 (when data
13551 (save-excursion
13552 (org-back-to-heading t)
13553 (when (looking-at org-complex-heading-regexp)
13554 (if (match-end 5)
13555 (progn
13556 (goto-char (match-beginning 5))
13557 (insert data)
13558 (delete-region (point) (point-at-eol))
13559 (org-set-tags nil 'align))
13560 (goto-char (point-at-eol))
13561 (insert " " data)
13562 (org-set-tags nil 'align)))
13563 (beginning-of-line 1)
13565 (delete-region (match-beginning 1) (match-end 1))))))
13567 (defun org-align-all-tags ()
13568 "Align the tags i all headings."
13569 (interactive)
13570 (save-excursion
13571 (or (ignore-errors (org-back-to-heading t))
13572 (outline-next-heading))
13573 (if (org-at-heading-p)
13574 (org-set-tags t)
13575 (message "No headings"))))
13577 (defvar org-indent-indentation-per-level)
13578 (defun org-set-tags (&optional arg just-align)
13579 "Set the tags for the current headline.
13580 With prefix ARG, realign all tags in headings in the current buffer."
13581 (interactive "P")
13582 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13583 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13584 'region-start-level 'region))
13585 org-loop-over-headlines-in-active-region)
13586 (org-map-entries
13587 ;; We don't use ARG and JUST-ALIGN here these args are not
13588 ;; useful when looping over headlines
13589 `(org-set-tags)
13590 org-loop-over-headlines-in-active-region
13591 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13592 (let* ((re org-outline-regexp-bol)
13593 (current (unless arg (org-get-tags-string)))
13594 (col (current-column))
13595 (org-setting-tags t)
13596 table current-tags inherited-tags ; computed below when needed
13597 tags p0 c0 c1 rpl di tc level)
13598 (if arg
13599 (save-excursion
13600 (goto-char (point-min))
13601 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13602 (while (re-search-forward re nil t)
13603 (org-set-tags nil t)
13604 (end-of-line 1)))
13605 (message "All tags realigned to column %d" org-tags-column))
13606 (if just-align
13607 (setq tags current)
13608 ;; Get a new set of tags from the user
13609 (save-excursion
13610 (setq table (append org-tag-persistent-alist
13611 (or org-tag-alist (org-get-buffer-tags))
13612 (and
13613 org-complete-tags-always-offer-all-agenda-tags
13614 (org-global-tags-completion-table
13615 (org-agenda-files))))
13616 org-last-tags-completion-table table
13617 current-tags (org-split-string current ":")
13618 inherited-tags (nreverse
13619 (nthcdr (length current-tags)
13620 (nreverse (org-get-tags-at))))
13621 tags
13622 (if (or (eq t org-use-fast-tag-selection)
13623 (and org-use-fast-tag-selection
13624 (delq nil (mapcar 'cdr table))))
13625 (org-fast-tag-selection
13626 current-tags inherited-tags table
13627 (if org-fast-tag-selection-include-todo
13628 org-todo-key-alist))
13629 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13630 (org-trim
13631 (org-icompleting-read "Tags: "
13632 'org-tags-completion-function
13633 nil nil current 'org-tags-history))))))
13634 (while (string-match "[-+&]+" tags)
13635 ;; No boolean logic, just a list
13636 (setq tags (replace-match ":" t t tags))))
13638 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13640 (if org-tags-sort-function
13641 (setq tags (mapconcat 'identity
13642 (sort (org-split-string
13643 tags (org-re "[^[:alnum:]_@#%]+"))
13644 org-tags-sort-function) ":")))
13647 (setq tags "")
13648 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13649 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13651 ;; Insert new tags at the correct column
13652 (beginning-of-line 1)
13653 (setq level (or (and (looking-at org-outline-regexp)
13654 (- (match-end 0) (point) 1))
13655 1))
13656 (cond
13657 ((and (equal current "") (equal tags "")))
13658 ((re-search-forward
13660 (point-at-eol) t)
13661 (if (equal tags "")
13662 (setq rpl "")
13663 (goto-char (match-beginning 0))
13664 (setq c0 (current-column)
13665 ;; compute offset for the case of org-indent-mode active
13666 di (if org-indent-mode
13667 (* (1- org-indent-indentation-per-level) (1- level))
13668 0)
13669 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13670 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13671 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13672 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13673 (replace-match rpl t t)
13674 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13675 tags)
13676 (t (error "Tags alignment failed")))
13677 (org-move-to-column col)
13678 (unless just-align
13679 (run-hooks 'org-after-tags-change-hook))))))
13681 (defun org-change-tag-in-region (beg end tag off)
13682 "Add or remove TAG for each entry in the region.
13683 This works in the agenda, and also in an org-mode buffer."
13684 (interactive
13685 (list (region-beginning) (region-end)
13686 (let ((org-last-tags-completion-table
13687 (if (derived-mode-p 'org-mode)
13688 (org-get-buffer-tags)
13689 (org-global-tags-completion-table))))
13690 (org-icompleting-read
13691 "Tag: " 'org-tags-completion-function nil nil nil
13692 'org-tags-history))
13693 (progn
13695 (equal (read-char-exclusive) ?r))))
13696 (if (fboundp 'deactivate-mark) (deactivate-mark))
13697 (let ((agendap (equal major-mode 'org-agenda-mode))
13698 l1 l2 m buf pos newhead (cnt 0))
13699 (goto-char end)
13700 (setq l2 (1- (org-current-line)))
13701 (goto-char beg)
13702 (setq l1 (org-current-line))
13703 (loop for l from l1 to l2 do
13704 (org-goto-line l)
13705 (setq m (get-text-property (point) 'org-hd-marker))
13706 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
13707 (and agendap m))
13708 (setq buf (if agendap (marker-buffer m) (current-buffer))
13709 pos (if agendap m (point)))
13710 (with-current-buffer buf
13711 (save-excursion
13712 (save-restriction
13713 (goto-char pos)
13714 (setq cnt (1+ cnt))
13715 (org-toggle-tag tag (if off 'off 'on))
13716 (setq newhead (org-get-heading)))))
13717 (and agendap (org-agenda-change-all-lines newhead m))))
13718 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13720 (defun org-tags-completion-function (string predicate &optional flag)
13721 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13722 (confirm (lambda (x) (stringp (car x)))))
13724 (setq s1 (match-string 1 string)
13725 s2 (match-string 2 string))
13726 (setq s1 "" s2 string))
13727 (cond
13728 ((eq flag nil)
13729 ;; try completion
13730 (setq rtn (try-completion s2 ctable confirm))
13731 (if (stringp rtn)
13732 (setq rtn
13733 (concat s1 s2 (substring rtn (length s2))
13734 (if (and org-add-colon-after-tag-completion
13735 (assoc rtn ctable))
13736 ":" ""))))
13737 rtn)
13738 ((eq flag t)
13739 ;; all-completions
13740 (all-completions s2 ctable confirm)
13741 )
13742 ((eq flag 'lambda)
13743 ;; exact match?
13744 (assoc s2 ctable)))
13745 ))
13747 (defun org-fast-tag-insert (kwd tags face &optional end)
13748 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13749 (insert (format "%-12s" (concat kwd ":"))
13750 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13751 (or end "")))
13753 (defun org-fast-tag-show-exit (flag)
13754 (save-excursion
13755 (org-goto-line 3)
13757 (replace-match ""))
13758 (when flag
13759 (end-of-line 1)
13760 (org-move-to-column (- (window-width) 19) t)
13761 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13763 (defun org-set-current-tags-overlay (current prefix)
13764 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13765 (if (featurep 'xemacs)
13766 (org-overlay-display org-tags-overlay (concat prefix s)
13767 'secondary-selection)
13768 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13769 (org-overlay-display org-tags-overlay (concat prefix s)))))
13771 (defvar org-last-tag-selection-key nil)
13772 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13773 "Fast tag selection with single keys.
13774 CURRENT is the current list of tags in the headline, INHERITED is the
13775 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13776 possibly with grouping information. TODO-TABLE is a similar table with
13777 TODO keywords, should these have keys assigned to them.
13778 If the keys are nil, a-z are automatically assigned.
13779 Returns the new tags string, or nil to not change the current settings."
13780 (let* ((fulltable (append table todo-table))
13781 (maxlen (apply 'max (mapcar
13782 (lambda (x)
13783 (if (stringp (car x)) (string-width (car x)) 0))
13784 fulltable)))
13785 (buf (current-buffer))
13786 (expert (eq org-fast-tag-selection-single-key 'expert))
13787 (buffer-tags nil)
13788 (fwidth (+ maxlen 3 1 3))
13789 (ncol (/ (- (window-width) 4) fwidth))
13790 (i-face 'org-done)
13791 (c-face 'org-todo)
13792 tg cnt e c char c1 c2 ntable tbl rtn
13793 ov-start ov-end ov-prefix
13794 (exit-after-next org-fast-tag-selection-single-key)
13795 (done-keywords org-done-keywords)
13796 groups ingroup)
13797 (save-excursion
13798 (beginning-of-line 1)
13799 (if (looking-at
13801 (setq ov-start (match-beginning 1)
13802 ov-end (match-end 1)
13803 ov-prefix "")
13804 (setq ov-start (1- (point-at-eol))
13805 ov-end (1+ ov-start))
13807 (setq ov-prefix
13808 (concat
13809 (buffer-substring (1- (point)) (point))
13810 (if (> (current-column) org-tags-column)
13811 " "
13812 (make-string (- org-tags-column (current-column)) ?\ ))))))
13813 (move-overlay org-tags-overlay ov-start ov-end)
13814 (save-window-excursion
13815 (if expert
13816 (set-buffer (get-buffer-create " *Org tags*"))
13817 (delete-other-windows)
13818 (split-window-vertically)
13819 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13820 (erase-buffer)
13821 (org-set-local 'org-done-keywords done-keywords)
13824 (org-fast-tag-show-exit exit-after-next)
13825 (org-set-current-tags-overlay current ov-prefix)
13826 (setq tbl fulltable char ?a cnt 0)
13827 (while (setq e (pop tbl))
13828 (cond
13829 ((equal (car e) :startgroup)
13830 (push '() groups) (setq ingroup t)
13831 (when (not (= cnt 0))
13832 (setq cnt 0)
13834 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13835 ((equal (car e) :endgroup)
13836 (setq ingroup nil cnt 0)
13838 ((equal e '(:newline))
13839 (when (not (= cnt 0))
13840 (setq cnt 0)
13842 (setq e (car tbl))
13843 (while (equal (car tbl) '(:newline))
13845 (setq tbl (cdr tbl)))))
13846 (t
13847 (setq tg (copy-sequence (car e)) c2 nil)
13848 (if (cdr e)
13849 (setq c (cdr e))
13850 ;; automatically assign a character.
13851 (setq c1 (string-to-char
13852 (downcase (substring
13853 tg (if (= (string-to-char tg) ?@) 1 0)))))
13854 (if (or (rassoc c1 ntable) (rassoc c1 table))
13855 (while (or (rassoc char ntable) (rassoc char table))
13856 (setq char (1+ char)))
13857 (setq c2 c1))
13858 (setq c (or c2 char)))
13859 (if ingroup (push tg (car groups)))
13860 (setq tg (org-add-props tg nil 'face
13861 (cond
13862 ((not (assoc tg table))
13863 (org-get-todo-face tg))
13864 ((member tg current) c-face)
13865 ((member tg inherited) i-face))))
13866 (if (and (= cnt 0) (not ingroup)) (insert " "))
13867 (insert "[" c "] " tg (make-string
13868 (- fwidth 4 (length tg)) ?\ ))
13869 (push (cons tg c) ntable)
13870 (when (= (setq cnt (1+ cnt)) ncol)
13872 (if ingroup (insert " "))
13873 (setq cnt 0)))))
13874 (setq ntable (nreverse ntable))
13876 (goto-char (point-min))
13877 (if (not expert) (org-fit-window-to-buffer))
13878 (setq rtn
13879 (catch 'exit
13880 (while t
13881 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13882 (if (not groups) "no " "")
13883 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13884 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13885 (setq org-last-tag-selection-key c)
13886 (cond
13888 ((= c ?!)
13889 (setq groups (not groups))
13890 (goto-char (point-min))
13891 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13892 ((= c ?\C-c)
13893 (if (not expert)
13894 (org-fast-tag-show-exit
13895 (setq exit-after-next (not exit-after-next)))
13896 (setq expert nil)
13897 (delete-other-windows)
13898 (set-window-buffer (split-window-vertically) " *Org tags*")
13899 (org-switch-to-buffer-other-window " *Org tags*")
13900 (org-fit-window-to-buffer)))
13901 ((or (= c ?\C-g)
13902 (and (= c ?q) (not (rassoc c ntable))))
13903 (org-detach-overlay org-tags-overlay)
13904 (setq quit-flag t))
13905 ((= c ?\ )
13906 (setq current nil)
13907 (if exit-after-next (setq exit-after-next 'now)))
13909 (condition-case nil
13910 (setq tg (org-icompleting-read
13911 "Tag: "
13912 (or buffer-tags
13913 (with-current-buffer buf
13914 (org-get-buffer-tags)))))
13915 (quit (setq tg "")))
13917 (add-to-list 'buffer-tags (list tg))
13918 (if (member tg current)
13919 (setq current (delete tg current))
13920 (push tg current)))
13921 (if exit-after-next (setq exit-after-next 'now)))
13922 ((setq e (rassoc c todo-table) tg (car e))
13923 (with-current-buffer buf
13924 (save-excursion (org-todo tg)))
13925 (if exit-after-next (setq exit-after-next 'now)))
13926 ((setq e (rassoc c ntable) tg (car e))
13927 (if (member tg current)
13928 (setq current (delete tg current))
13929 (loop for g in groups do
13930 (if (member tg g)
13931 (mapc (lambda (x)
13932 (setq current (delete x current)))
13933 g)))
13934 (push tg current))
13935 (if exit-after-next (setq exit-after-next 'now))))
13937 ;; Create a sorted list
13938 (setq current
13939 (sort current
13940 (lambda (a b)
13941 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13942 (if (eq exit-after-next 'now) (throw 'exit t))
13943 (goto-char (point-min))
13944 (beginning-of-line 2)
13945 (delete-region (point) (point-at-eol))
13946 (org-fast-tag-insert "Current" current c-face)
13947 (org-set-current-tags-overlay current ov-prefix)
13948 (while (re-search-forward
13950 (setq tg (match-string 1))
13951 (add-text-properties
13952 (match-beginning 1) (match-end 1)
13953 (list 'face
13954 (cond
13955 ((member tg current) c-face)
13956 ((member tg inherited) i-face)
13957 (t (get-text-property (match-beginning 1) 'face))))))
13958 (goto-char (point-min)))))
13959 (org-detach-overlay org-tags-overlay)
13960 (if rtn
13961 (mapconcat 'identity current ":")
13962 nil))))
13964 (defun org-get-tags-string ()
13965 "Get the TAGS string in the current headline."
13966 (unless (org-at-heading-p t)
13967 (error "Not on a heading"))
13968 (save-excursion
13969 (beginning-of-line 1)
13971 (org-match-string-no-properties 1)
13972 "")))
13974 (defun org-get-tags ()
13975 "Get the list of tags specified in the current headline."
13976 (org-split-string (org-get-tags-string) ":"))
13978 (defun org-get-buffer-tags ()
13979 "Get a table of all tags used in the buffer, for completion."
13980 (let (tags)
13981 (save-excursion
13982 (goto-char (point-min))
13983 (while (re-search-forward
13985 (when (equal (char-after (point-at-bol 0)) ?*)
13986 (mapc (lambda (x) (add-to-list 'tags x))
13987 (org-split-string (org-match-string-no-properties 1) ":")))))
13988 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13989 (mapcar 'list tags)))
13991 ;;;; The mapping API
13993 (defun org-map-entries (func &optional match scope &rest skip)
13994 "Call FUNC at each headline selected by MATCH in SCOPE.
13996 FUNC is a function or a lisp form. The function will be called without
13997 arguments, with the cursor positioned at the beginning of the headline.
13998 The return values of all calls to the function will be collected and
13999 returned as a list.
14001 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14002 does not need to preserve point. After evaluation, the cursor will be
14003 moved to the end of the line (presumably of the headline of the
14004 processed entry) and search continues from there. Under some
14005 circumstances, this may not produce the wanted results. For example,
14006 if you have removed (e.g. archived) the current (sub)tree it could
14007 mean that the next entry will be skipped entirely. In such cases, you
14008 can specify the position from where search should continue by making
14009 FUNC set the variable `org-map-continue-from' to the desired buffer
14010 position.
14012 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14013 Only headlines that are matched by this query will be considered during
14014 the iteration. When MATCH is nil or t, all headlines will be
14015 visited by the iteration.
14017 SCOPE determines the scope of this command. It can be any of:
14019 nil The current buffer, respecting the restriction if any
14020 tree The subtree started with the entry at point
14021 region The entries within the active region, if any
14022 region-start-level
14023 The entries within the active region, but only those at
14024 the same level than the first one.
14025 file The current buffer, without restriction
14026 file-with-archives
14027 The current buffer, and any archives associated with it
14028 agenda All agenda files
14029 agenda-with-archives
14030 All agenda files with any archive files associated with them
14031 \(file1 file2 ...)
14032 If this is a list, all files in the list will be scanned
14034 The remaining args are treated as settings for the skipping facilities of
14035 the scanner. The following items can be given here:
14037 archive skip trees with the archive tag.
14038 comment skip trees with the COMMENT keyword
14039 function or Emacs Lisp form:
14040 will be used as value for `org-agenda-skip-function', so whenever
14041 the function returns t, FUNC will not be called for that
14042 entry and search will continue from the point where the
14043 function leaves it.
14045 If your function needs to retrieve the tags including inherited tags
14046 at the *current* entry, you can use the value of the variable
14047 `org-scanner-tags' which will be much faster than getting the value
14048 with `org-get-tags-at'. If your function gets properties with
14049 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14050 to t around the call to `org-entry-properties' to get the same speedup.
14051 Note that if your function moves around to retrieve tags and properties at
14052 a *different* entry, you cannot use these techniques."
14053 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14054 (not (org-region-active-p)))
14055 (let* ((org-agenda-archives-mode nil) ; just to make sure
14056 (org-agenda-skip-archived-trees (memq 'archive skip))
14057 (org-agenda-skip-comment-trees (memq 'comment skip))
14058 (org-agenda-skip-function
14059 (car (org-delete-all '(comment archive) skip)))
14060 (org-tags-match-list-sublevels t)
14061 (start-level (eq scope 'region-start-level))
14062 matcher file res
14063 org-todo-keywords-for-agenda
14064 org-done-keywords-for-agenda
14065 org-todo-keyword-alist-for-agenda
14066 org-drawers-for-agenda
14067 org-tag-alist-for-agenda
14068 todo-only)
14070 (cond
14071 ((eq match t) (setq matcher t))
14072 ((eq match nil) (setq matcher t))
14073 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14075 (save-excursion
14076 (save-restriction
14077 (cond ((eq scope 'tree)
14078 (org-back-to-heading t)
14079 (org-narrow-to-subtree)
14080 (setq scope nil))
14081 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14082 (org-region-active-p))
14083 ;; If needed, set start-level to a string like "2"
14084 (when start-level
14085 (save-excursion
14086 (goto-char (region-beginning))
14087 (unless (org-at-heading-p) (outline-next-heading))
14088 (setq start-level (org-current-level))))
14089 (narrow-to-region (region-beginning)
14090 (save-excursion
14091 (goto-char (region-end))
14092 (unless (and (bolp) (org-at-heading-p))
14093 (outline-next-heading))
14094 (point)))
14095 (setq scope nil)))
14097 (if (not scope)
14098 (progn
14099 (org-agenda-prepare-buffers
14100 (list (buffer-file-name (current-buffer))))
14101 (setq res (org-scan-tags func matcher todo-only start-level)))
14102 ;; Get the right scope
14103 (cond
14104 ((and scope (listp scope) (symbolp (car scope)))
14105 (setq scope (eval scope)))
14106 ((eq scope 'agenda)
14107 (setq scope (org-agenda-files t)))
14108 ((eq scope 'agenda-with-archives)
14109 (setq scope (org-agenda-files t))
14110 (setq scope (org-add-archive-files scope)))
14111 ((eq scope 'file)
14112 (setq scope (list (buffer-file-name))))
14113 ((eq scope 'file-with-archives)
14114 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14115 (org-agenda-prepare-buffers scope)
14116 (while (setq file (pop scope))
14117 (with-current-buffer (org-find-base-buffer-visiting file)
14118 (save-excursion
14119 (save-restriction
14120 (widen)
14121 (goto-char (point-min))
14122 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14123 res)))
14125 ;;;; Properties
14127 ;;; Setting and retrieving properties
14129 (defconst org-special-properties
14130 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14131 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14132 "The special properties valid in Org-mode.
14134 These are properties that are not defined in the property drawer,
14135 but in some other way.")
14137 (defconst org-default-properties
14138 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14139 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14140 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14141 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14142 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14143 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14144 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14145 "Some properties that are used by Org-mode for various purposes.
14146 Being in this list makes sure that they are offered for completion.")
14149 "Regular expression matching the first line of a property drawer.")
14152 "Regular expression matching the last line of a property drawer.")
14155 "Regular expression matching the first line of a property drawer.")
14158 "Regular expression matching the first line of a property drawer.")
14160 (defconst org-property-drawer-re
14163 "Matches an entire property drawer.")
14165 (defconst org-clock-drawer-re
14168 "Matches an entire clock drawer.")
14170 (defsubst org-re-property (property)
14171 "Return a regexp matching a PROPERTY line.
14172 Match group 1 will be set to the value."
14175 (defsubst org-re-property-keyword (property)
14176 "Return a regexp matching a PROPERTY line, possibly with no
14177 value for the property."
14180 (defun org-property-action ()
14181 "Do an action on properties."
14182 (interactive)
14183 (let (c)
14184 (org-at-property-p)
14185 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14186 (setq c (read-char-exclusive))
14187 (cond
14188 ((equal c ?s)
14189 (call-interactively 'org-set-property))
14190 ((equal c ?d)
14191 (call-interactively 'org-delete-property))
14192 ((equal c ?D)
14193 (call-interactively 'org-delete-property-globally))
14194 ((equal c ?c)
14195 (call-interactively 'org-compute-property-at-point))
14196 (t (error "No such property action %c" c)))))
14198 (defun org-inc-effort ()
14199 "Increment the value of the effort property in the current entry."
14200 (interactive)
14201 (org-set-effort nil t))
14203 (defun org-set-effort (&optional value increment)
14204 "Set the effort property of the current entry.
14205 With numerical prefix arg, use the nth allowed value, 0 stands for the
14206 10th allowed value.
14208 When INCREMENT is non-nil, set the property to the next allowed value."
14209 (interactive "P")
14210 (if (equal value 0) (setq value 10))
14211 (let* ((completion-ignore-case t)
14212 (prop org-effort-property)
14213 (cur (org-entry-get nil prop))
14214 (allowed (org-property-get-allowed-values nil prop 'table))
14215 (existing (mapcar 'list (org-property-values prop)))
14216 rpl
14217 (val (cond
14218 ((stringp value) value)
14219 ((and allowed (integerp value))
14220 (or (car (nth (1- value) allowed))
14221 (car (org-last allowed))))
14222 ((and allowed increment)
14223 (or (caadr (member (list cur) allowed))
14224 (error "Allowed effort values are not set")))
14225 (allowed
14226 (message "Select 1-9,0, [RET%s]: %s"
14227 (if cur (concat "=" cur) "")
14228 (mapconcat 'car allowed " "))
14229 (setq rpl (read-char-exclusive))
14231 cur
14232 (setq rpl (- rpl ?0))
14233 (if (equal rpl 0) (setq rpl 10))
14234 (if (and (> rpl 0) (<= rpl (length allowed)))
14235 (car (nth (1- rpl) allowed))
14236 (org-completing-read "Effort: " allowed nil))))
14237 (t
14238 (let (org-completion-use-ido org-completion-use-iswitchb)
14239 (org-completing-read
14241 (concat "[" cur "]") "")
14242 ": ")
14243 existing nil nil "" nil cur))))))
14244 (unless (equal (org-entry-get nil prop) val)
14245 (org-entry-put nil prop val))
14246 (message "%s is now %s" prop val)))
14248 (defun org-at-property-p ()
14249 "Is cursor inside a property drawer?"
14250 (save-excursion
14251 (beginning-of-line 1)
14253 (save-match-data ;; Used by calling procedures
14254 (let ((p (point))
14255 (range (unless (org-before-first-heading-p)
14256 (org-get-property-block))))
14257 (and range (<= (car range) p) (< p (cdr range))))))))
14259 (defun org-get-property-block (&optional beg end force)
14260 "Return the (beg . end) range of the body of the property drawer.
14261 BEG and END are the beginning and end of the current subtree, or of
14262 the part before the first headline. If they are not given, they will
14263 be found. If the drawer does not exist and FORCE is non-nil, create
14264 the drawer."
14265 (catch 'exit
14266 (save-excursion
14267 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
14268 (progn (org-back-to-heading t) (point))))
14269 (end (or end (and (not (outline-next-heading)) (point-max))
14270 (point))))
14271 (goto-char beg)
14272 (if (re-search-forward org-property-start-re end t)
14273 (setq beg (1+ (match-end 0)))
14274 (if force
14275 (save-excursion
14276 (org-insert-property-drawer)
14277 (setq end (progn (outline-next-heading) (point))))
14278 (throw 'exit nil))
14279 (goto-char beg)
14280 (if (re-search-forward org-property-start-re end t)
14281 (setq beg (1+ (match-end 0)))))
14282 (if (re-search-forward org-property-end-re end t)
14283 (setq end (match-beginning 0))
14284 (or force (throw 'exit nil))
14285 (goto-char beg)
14286 (setq end beg)
14287 (org-indent-line)
14289 (cons beg end)))))
14291 (defun org-entry-properties (&optional pom which specific)
14292 "Get all properties of the entry at point-or-marker POM.
14293 This includes the TODO keyword, the tags, time strings for deadline,
14294 scheduled, and clocking, and any additional properties defined in the
14295 entry. The return value is an alist, keys may occur multiple times
14296 if the property key was used several times.
14297 POM may also be nil, in which case the current entry is used.
14298 If WHICH is nil or `all', get all properties. If WHICH is
14299 `special' or `standard', only get that subclass. If WHICH
14300 is a string only get exactly this property. SPECIFIC can be a string, the
14301 specific property we are interested in. Specifying it can speed
14302 things up because then unnecessary parsing is avoided."
14303 (setq which (or which 'all))
14304 (org-with-point-at pom
14305 (let ((clockstr (substring org-clock-string 0 -1))
14306 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14307 (case-fold-search nil)
14308 beg end range props sum-props key key1 value string clocksum clocksumt)
14309 (save-excursion
14310 (when (condition-case nil
14311 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14312 (error nil))
14313 (setq beg (point))
14314 (setq sum-props (get-text-property (point) 'org-summaries))
14315 (setq clocksum (get-text-property (point) :org-clock-minutes)
14316 clocksumt (get-text-property (point) :org-clock-minutes-today))
14317 (outline-next-heading)
14318 (setq end (point))
14319 (when (memq which '(all special))
14320 ;; Get the special properties, like TODO and tags
14321 (goto-char beg)
14322 (when (and (or (not specific) (string= specific "TODO"))
14323 (looking-at org-todo-line-regexp) (match-end 2))
14324 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14325 (when (and (or (not specific) (string= specific "PRIORITY"))
14326 (looking-at org-priority-regexp))
14327 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14328 (when (or (not specific) (string= specific "FILE"))
14329 (push (cons "FILE" buffer-file-name) props))
14330 (when (and (or (not specific) (string= specific "TAGS"))
14331 (setq value (org-get-tags-string))
14333 (push (cons "TAGS" value) props))
14334 (when (and (or (not specific) (string= specific "ALLTAGS"))
14335 (setq value (org-get-tags-at)))
14336 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14337 ":"))
14338 props))
14339 (when (or (not specific) (string= specific "BLOCKED"))
14340 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14341 (when (or (not specific)
14342 (member specific
14343 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14344 "TIMESTAMP" "TIMESTAMP_IA")))
14345 (catch 'match
14346 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14347 (setq key (if (match-end 1)
14348 (substring (org-match-string-no-properties 1)
14349 0 -1))
14350 string (if (equal key clockstr)
14351 (org-trim
14352 (buffer-substring-no-properties
14353 (match-beginning 3) (goto-char
14354 (point-at-eol))))
14355 (substring (org-match-string-no-properties 3)
14356 1 -1)))
14357 ;; Get the correct property name from the key. This is
14358 ;; necessary if the user has configured time keywords.
14359 (setq key1 (concat key ":"))
14360 (cond
14361 ((not key)
14362 (setq key
14363 (if (= (char-after (match-beginning 3)) ?\[)
14364 "TIMESTAMP_IA" "TIMESTAMP")))
14365 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14366 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14367 ((equal key1 org-closed-string) (setq key "CLOSED"))
14368 ((equal key1 org-clock-string) (setq key "CLOCK")))
14369 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14370 (progn
14371 (push (cons key string) props)
14372 ;; no need to search further if match is found
14373 (throw 'match t))
14374 (when (or (equal key "CLOCK") (not (assoc key props)))
14375 (push (cons key string) props)))))))
14377 (when (memq which '(all standard))
14378 ;; Get the standard properties, like :PROP: ...
14379 (setq range (org-get-property-block beg end))
14380 (when range
14381 (goto-char (car range))
14382 (while (re-search-forward
14384 (cdr range) t)
14385 (setq key (org-match-string-no-properties 1)
14386 value (org-trim (or (org-match-string-no-properties 2) "")))
14387 (unless (member key excluded)
14388 (push (cons key (or value "")) props)))))
14389 (if clocksum
14390 (push (cons "CLOCKSUM"
14391 (org-columns-number-to-string (/ (float clocksum) 60.)
14392 'add_times))
14393 props))
14394 (if clocksumt
14395 (push (cons "CLOCKSUM_T"
14396 (org-columns-number-to-string (/ (float clocksumt) 60.)
14397 'add_times))
14398 props))
14399 (unless (assoc "CATEGORY" props)
14400 (push (cons "CATEGORY" (org-get-category)) props))
14401 (append sum-props (nreverse props)))))))
14403 (defun org-entry-get (pom property &optional inherit literal-nil)
14404 "Get value of PROPERTY for entry or content at point-or-marker POM.
14405 If INHERIT is non-nil and the entry does not have the property,
14406 then also check higher levels of the hierarchy.
14407 If INHERIT is the symbol `selective', use inheritance only if the setting
14408 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14409 If the property is present but empty, the return value is the empty string.
14410 If the property is not present at all, nil is returned.
14413 do not interpret it as the list atom nil. This is used for inheritance
14415 (org-with-point-at pom
14416 (if (and inherit (if (eq inherit 'selective)
14417 (org-property-inherit-p property)
14418 t))
14419 (org-entry-get-with-inheritance property literal-nil)
14420 (if (member property org-special-properties)
14421 ;; We need a special property. Use `org-entry-properties' to
14422 ;; retrieve it, but specify the wanted property
14423 (cdr (assoc property (org-entry-properties nil 'special property)))
14424 (let* ((range (org-get-property-block))
14425 (props (list (or (assoc property org-file-properties)
14426 (assoc property org-global-properties)
14427 (assoc property org-global-properties-fixed))))
14428 (ap (lambda (key)
14429 (when (re-search-forward
14430 (org-re-property key) (cdr range) t)
14431 (setq props
14432 (org-update-property-plist
14433 key
14434 (if (match-end 1)
14435 (org-match-string-no-properties 1) "")
14436 props)))))
14437 val)
14438 (when (and range (goto-char (car range)))
14439 (funcall ap property)
14440 (goto-char (car range))
14441 (while (funcall ap (concat property "+")))
14442 (setq val (cdr (assoc property props)))
14443 (when val (if literal-nil val (org-not-nil val)))))))))
14445 (defun org-property-or-variable-value (var &optional inherit)
14446 "Check if there is a property fixing the value of VAR.
14447 If yes, return this value. If not, return the current value of the variable."
14448 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14450 (read prop)
14451 (symbol-value var))))
14453 (defun org-entry-delete (pom property)
14454 "Delete the property PROPERTY from entry at point-or-marker POM."
14455 (org-with-point-at pom
14456 (if (member property org-special-properties)
14457 nil ; cannot delete these properties.
14458 (let ((range (org-get-property-block)))
14459 (if (and range
14460 (goto-char (car range))
14461 (re-search-forward
14462 (org-re-property property)
14463 (cdr range) t))
14464 (progn
14465 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14466 t)
14467 nil)))))
14469 ;; Multi-values properties are properties that contain multiple values
14470 ;; These values are assumed to be single words, separated by whitespace.
14471 (defun org-entry-add-to-multivalued-property (pom property value)
14472 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14473 (let* ((old (org-entry-get pom property))
14475 (setq value (org-entry-protect-space value))
14476 (unless (member value values)
14477 (setq values (cons value values))
14478 (org-entry-put pom property
14479 (mapconcat 'identity values " ")))))
14481 (defun org-entry-remove-from-multivalued-property (pom property value)
14482 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14483 (let* ((old (org-entry-get pom property))
14485 (setq value (org-entry-protect-space value))
14486 (when (member value values)
14487 (setq values (delete value values))
14488 (org-entry-put pom property
14489 (mapconcat 'identity values " ")))))
14491 (defun org-entry-member-in-multivalued-property (pom property value)
14492 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14493 (let* ((old (org-entry-get pom property))
14495 (setq value (org-entry-protect-space value))
14496 (member value values)))
14498 (defun org-entry-get-multivalued-property (pom property)
14499 "Return a list of values in a multivalued property."
14500 (let* ((value (org-entry-get pom property))
14502 (mapcar 'org-entry-restore-space values)))
14504 (defun org-entry-put-multivalued-property (pom property &rest values)
14505 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14506 VALUES should be a list of strings. Spaces will be protected."
14507 (org-entry-put pom property
14508 (mapconcat 'org-entry-protect-space values " "))
14509 (let* ((value (org-entry-get pom property))
14511 (mapcar 'org-entry-restore-space values)))
14513 (defun org-entry-protect-space (s)
14514 "Protect spaces and newline in string S."
14515 (while (string-match " " s)
14516 (setq s (replace-match "%20" t t s)))
14518 (setq s (replace-match "%0A" t t s)))
14519 s)
14521 (defun org-entry-restore-space (s)
14522 "Restore spaces and newline in string S."
14523 (while (string-match "%20" s)
14524 (setq s (replace-match " " t t s)))
14525 (while (string-match "%0A" s)
14527 s)
14529 (defvar org-entry-property-inherited-from (make-marker)
14530 "Marker pointing to the entry from where a property was inherited.
14531 Each call to `org-entry-get-with-inheritance' will set this marker to the
14532 location of the entry where the inheritance search matched. If there was
14533 no match, the marker will point nowhere.
14534 Note that also `org-entry-get' calls this function, if the INHERIT flag
14535 is set.")
14537 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14538 "Get PROPERTY of entry or content at point, search higher levels if needed.
14539 The search will stop at the first ancestor which has the property defined.
14541 should be considered as undefined (this is the meaning of nil here).
14543 (move-marker org-entry-property-inherited-from nil)
14544 (let (tmp)
14545 (save-excursion
14546 (save-restriction
14547 (widen)
14548 (catch 'ex
14549 (while t
14550 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14551 (or (ignore-errors (org-back-to-heading t))
14552 (goto-char (point-min)))
14553 (move-marker org-entry-property-inherited-from (point))
14554 (throw 'ex tmp))
14555 (or (ignore-errors (org-up-heading-safe))
14556 (throw 'ex nil))))))
14557 (setq tmp (or tmp
14558 (cdr (assoc property org-file-properties))
14559 (cdr (assoc property org-global-properties))
14560 (cdr (assoc property org-global-properties-fixed))))
14561 (if literal-nil tmp (org-not-nil tmp))))
14563 (defvar org-property-changed-functions nil
14564 "Hook called when the value of a property has changed.
14565 Each hook function should accept two arguments, the name of the property
14566 and the new value.")
14568 (defun org-entry-put (pom property value)
14569 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14570 (org-with-point-at pom
14571 (org-back-to-heading t)
14572 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14573 range)
14574 (cond
14575 ((equal property "TODO")
14577 (not (member value org-todo-keywords-1)))
14579 (if (or (not value)
14581 (setq value 'none))
14582 (org-todo value)
14583 (org-set-tags nil 'align))
14584 ((equal property "PRIORITY")
14586 (string-to-char value) ?\ ))
14587 (org-set-tags nil 'align))
14588 ((equal property "SCHEDULED")
14589 (if (re-search-forward org-scheduled-time-regexp end t)
14590 (cond
14591 ((eq value 'earlier) (org-timestamp-change -1 'day))
14592 ((eq value 'later) (org-timestamp-change 1 'day))
14593 (t (call-interactively 'org-schedule)))
14594 (call-interactively 'org-schedule)))
14595 ((equal property "DEADLINE")
14596 (if (re-search-forward org-deadline-time-regexp end t)
14597 (cond
14598 ((eq value 'earlier) (org-timestamp-change -1 'day))
14599 ((eq value 'later) (org-timestamp-change 1 'day))
14600 (t (call-interactively 'org-deadline)))
14601 (call-interactively 'org-deadline)))
14602 ((member property org-special-properties)
14603 (error "The %s property can not yet be set with `org-entry-put'"
14604 property))
14605 (t ; a non-special property
14606 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14607 (setq range (org-get-property-block beg end 'force))
14608 (goto-char (car range))
14609 (if (re-search-forward
14610 (org-re-property-keyword property) (cdr range) t)
14611 (progn
14612 (delete-region (match-beginning 0) (match-end 0))
14613 (goto-char (match-beginning 0)))
14614 (goto-char (cdr range))
14616 (backward-char 1)
14617 (org-indent-line))
14618 (insert ":" property ":")
14619 (and value (insert " " value))
14620 (org-indent-line)))))
14621 (run-hook-with-args 'org-property-changed-functions property value)))
14623 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14624 "Get all property keys in the current buffer.
14625 With INCLUDE-SPECIALS, also list the special properties that reflect things
14626 like tags and TODO state.
14627 With INCLUDE-DEFAULTS, also include properties that has special meaning
14628 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14629 and others.
14630 With INCLUDE-COLUMNS, also include property names given in COLUMN
14631 formats in the current buffer."
14632 (let (rtn range cfmt s p)
14633 (save-excursion
14634 (save-restriction
14635 (widen)
14636 (goto-char (point-min))
14637 (while (re-search-forward org-property-start-re nil t)
14638 (setq range (org-get-property-block))
14639 (goto-char (car range))
14640 (while (re-search-forward
14642 (cdr range) t)
14643 (add-to-list 'rtn (org-match-string-no-properties 1)))
14644 (outline-next-heading))))
14646 (when include-specials
14647 (setq rtn (append org-special-properties rtn)))
14649 (when include-defaults
14650 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14651 (add-to-list 'rtn org-effort-property))
14653 (when include-columns
14654 (save-excursion
14655 (save-restriction
14656 (widen)
14657 (goto-char (point-min))
14658 (while (re-search-forward
14660 nil t)
14661 (setq cfmt (match-string 2) s 0)
14663 cfmt s)
14664 (setq s (match-end 0)
14665 p (match-string 1 cfmt))
14666 (unless (or (equal p "ITEM")
14667 (member p org-special-properties))
14668 (add-to-list 'rtn (match-string 1 cfmt))))))))
14670 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14672 (defun org-property-values (key)
14673 "Return a list of all values of property KEY in the current buffer."
14674 (save-excursion
14675 (save-restriction
14676 (widen)
14677 (goto-char (point-min))
14678 (let ((re (org-re-property key))
14679 values)
14680 (while (re-search-forward re nil t)
14681 (add-to-list 'values (org-trim (match-string 1))))
14682 (delete "" values)))))
14684 (defun org-insert-property-drawer ()
14685 "Insert a property drawer into the current entry."
14686 (org-back-to-heading t)
14687 (looking-at org-outline-regexp)
14688 (let ((indent (if org-adapt-indentation
14689 (- (match-end 0) (match-beginning 0))
14690 0))
14691 (beg (point))
14693 end hiddenp)
14694 (outline-next-heading)
14695 (setq end (point))
14696 (goto-char beg)
14697 (while (re-search-forward re end t))
14698 (setq hiddenp (outline-invisible-p))
14699 (end-of-line 1)
14702 (if (member (match-string 1) '("CLOCK:" ":END:"))
14703 ;; just skip this line
14704 (beginning-of-line 2)
14705 ;; Drawer start, find the end
14707 (beginning-of-line 1)))
14708 (org-skip-over-state-notes)
14710 (if (eq (char-before) ?*) (forward-char 1))
14712 (beginning-of-line 0)
14713 (org-indent-to-column indent)
14714 (beginning-of-line 2)
14715 (org-indent-to-column indent)
14716 (beginning-of-line 0)
14717 (if hiddenp
14718 (save-excursion
14719 (org-back-to-heading t)
14720 (hide-entry))
14721 (org-flag-drawer t))))
14723 (defun org-insert-drawer (&optional arg drawer)
14724 "Insert a drawer at point.
14726 Optional argument DRAWER, when non-nil, is a string representing
14727 drawer's name. Otherwise, the user is prompted for a name.
14729 If a region is active, insert the drawer around that region
14730 instead.
14732 Point is left between drawer's boundaries."
14733 (interactive "P")
14734 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14735 "LOGBOOK"))
14736 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14737 ;; internally by Org. They are meant to be inserted
14738 ;; automatically.
14739 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14740 ;; Remove system drawers from list. Note: For some reason,
14741 ;; `org-completing-read' ignores the predicate while
14742 ;; `completing-read' handles it fine.
14743 (drawer (if arg "PROPERTIES"
14744 (or drawer
14745 (completing-read
14746 "Drawer: " org-drawers
14747 (lambda (d) (not (member d system-drawers))))))))
14748 (cond
14749 ;; With C-u, fall back on `org-insert-property-drawer'
14750 (arg (org-insert-property-drawer))
14751 ;; With an active region, insert a drawer at point.
14752 ((not (org-region-active-p))
14753 (progn
14756 (forward-line -2)))
14757 ;; Otherwise, insert the drawer at point
14758 (t
14759 (let ((rbeg (region-beginning))
14760 (rend (copy-marker (region-end))))
14761 (unwind-protect
14762 (progn
14763 (goto-char rbeg)
14764 (beginning-of-line)
14765 (when (save-excursion
14766 (re-search-forward org-outline-regexp-bol rend t))
14767 (error "Drawers cannot contain headlines"))
14768 ;; Position point at the beginning of the first
14769 ;; non-blank line in region. Insert drawer's opening
14770 ;; there, then indent it.
14771 (org-skip-whitespace)
14772 (beginning-of-line)
14774 (forward-line -1)
14775 (indent-for-tab-command)
14776 ;; Move point to the beginning of the first blank line
14777 ;; after the last non-blank line in region. Insert
14778 ;; drawer's closing, then indent it.
14779 (goto-char rend)
14782 (deactivate-mark t)
14783 (indent-for-tab-command)
14785 ;; Clear marker, whatever the outcome of insertion is.
14786 (set-marker rend nil)))))))
14788 (defvar org-property-set-functions-alist nil
14789 "Property set function alist.
14790 Each entry should have the following format:
14792 (PROPERTY . READ-FUNCTION)
14794 The read function will be called with the same argument as
14795 `org-completing-read'.")
14797 (defun org-set-property-function (property)
14798 "Get the function that should be used to set PROPERTY.
14799 This is computed according to `org-property-set-functions-alist'."
14800 (or (cdr (assoc property org-property-set-functions-alist))
14801 'org-completing-read))
14803 (defun org-read-property-value (property)
14804 "Read PROPERTY value from user."
14805 (let* ((completion-ignore-case t)
14806 (allowed (org-property-get-allowed-values nil property 'table))
14807 (cur (org-entry-get nil property))
14808 (prompt (concat property " value"
14810 (concat " [" cur "]") "") ": "))
14811 (set-function (org-set-property-function property))
14812 (val (if allowed
14813 (funcall set-function prompt allowed nil
14814 (not (get-text-property 0 'org-unrestricted
14815 (caar allowed))))
14816 (let (org-completion-use-ido org-completion-use-iswitchb)
14817 (funcall set-function prompt
14818 (mapcar 'list (org-property-values property))
14819 nil nil "" nil cur)))))
14820 (if (equal val "")
14821 cur
14822 val)))
14824 (defvar org-last-set-property nil)
14825 (defun org-read-property-name ()
14826 "Read a property name."
14827 (let* ((completion-ignore-case t)
14828 (keys (org-buffer-property-keys nil t t))
14829 (default-prop (or (save-excursion
14830 (save-match-data
14831 (beginning-of-line)
14833 (null (string= (match-string 1) "END"))
14834 (match-string 1))))
14835 org-last-set-property))
14836 (property (org-icompleting-read
14837 (concat "Property"
14838 (if default-prop (concat " [" default-prop "]") "")
14839 ": ")
14840 (mapcar 'list keys)
14841 nil nil nil nil
14842 default-prop
14843 )))
14844 (if (member property keys)
14845 property
14846 (or (cdr (assoc (downcase property)
14847 (mapcar (lambda (x) (cons (downcase x) x))
14848 keys)))
14849 property))))
14851 (defun org-set-property (property value)
14852 "In the current entry, set PROPERTY to VALUE.
14853 When called interactively, this will prompt for a property name, offering
14854 completion on existing and default properties. And then it will prompt
14855 for a value, offering completion either on allowed values (via an inherited
14856 xxx_ALL property) or on existing values in other instances of this property
14857 in the current file."
14858 (interactive (list nil nil))
14859 (let* ((property (or property (org-read-property-name)))
14860 (value (or value (org-read-property-value property)))
14861 (fn (cdr (assoc property org-properties-postprocess-alist))))
14862 (setq org-last-set-property property)
14863 ;; Possibly postprocess the inserted value:
14864 (when fn (setq value (funcall fn value)))
14865 (unless (equal (org-entry-get nil property) value)
14866 (org-entry-put nil property value))))
14868 (defun org-delete-property (property)
14869 "In the current entry, delete PROPERTY."
14870 (interactive
14871 (let* ((completion-ignore-case t)
14872 (prop (org-icompleting-read "Property: "
14873 (org-entry-properties nil 'standard))))
14874 (list prop)))
14875 (message "Property %s %s" property
14876 (if (org-entry-delete nil property)
14877 "deleted"
14878 "was not present in the entry")))
14880 (defun org-delete-property-globally (property)
14881 "Remove PROPERTY globally, from all entries."
14882 (interactive
14883 (let* ((completion-ignore-case t)
14884 (prop (org-icompleting-read
14885 "Globally remove property: "
14886 (mapcar 'list (org-buffer-property-keys)))))
14887 (list prop)))
14888 (save-excursion
14889 (save-restriction
14890 (widen)
14891 (goto-char (point-min))
14892 (let ((cnt 0))
14893 (while (re-search-forward
14894 (org-re-property property)
14895 nil t)
14896 (setq cnt (1+ cnt))
14897 (delete-region (match-beginning 0) (1+ (point-at-eol))))
14900 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14902 (defun org-compute-property-at-point ()
14903 "Compute the property at point.
14904 This looks for an enclosing column format, extracts the operator and
14905 then applies it to the property in the column format's scope."
14906 (interactive)
14907 (unless (org-at-property-p)
14908 (error "Not at a property"))
14909 (let ((prop (org-match-string-no-properties 2)))
14910 (org-columns-get-format-and-top-level)
14911 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14912 (error "No operator defined for property %s" prop))
14913 (org-columns-compute prop)))
14915 (defvar org-property-allowed-value-functions nil
14916 "Hook for functions supplying allowed values for a specific property.
14917 The functions must take a single argument, the name of the property, and
14919 the values, this means that these values are intended as defaults for
14920 completion, but that other values should be allowed too.
14921 The functions must return nil if they are not responsible for this
14922 property.")
14924 (defun org-property-get-allowed-values (pom property &optional table)
14925 "Get allowed values for the property PROPERTY.
14926 When TABLE is non-nil, return an alist that can directly be used for
14927 completion."
14928 (let (vals)
14929 (cond
14930 ((equal property "TODO")
14931 (setq vals (org-with-point-at pom
14932 (append org-todo-keywords-1 '("")))))
14933 ((equal property "PRIORITY")
14934 (let ((n org-lowest-priority))
14935 (while (>= n org-highest-priority)
14936 (push (char-to-string n) vals)
14937 (setq n (1- n)))))
14938 ((member property org-special-properties))
14939 ((setq vals (run-hook-with-args-until-success
14940 'org-property-allowed-value-functions property)))
14941 (t
14942 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14944 (setq vals (car (read-from-string (concat "(" vals ")"))))
14945 (setq vals (mapcar (lambda (x)
14946 (cond ((stringp x) x)
14947 ((numberp x) (number-to-string x))
14948 ((symbolp x) (symbol-name x))
14949 (t "???")))
14950 vals)))))
14951 (when (member ":ETC" vals)
14952 (setq vals (remove ":ETC" vals))
14953 (org-add-props (car vals) '(org-unrestricted t)))
14954 (if table (mapcar 'list vals) vals)))
14956 (defun org-property-previous-allowed-value (&optional previous)
14957 "Switch to the next allowed value for this property."
14958 (interactive)
14959 (org-property-next-allowed-value t))
14961 (defun org-property-next-allowed-value (&optional previous)
14962 "Switch to the next allowed value for this property."
14963 (interactive)
14964 (unless (org-at-property-p)
14965 (error "Not at a property"))
14966 (let* ((key (match-string 2))
14967 (value (match-string 3))
14968 (allowed (or (org-property-get-allowed-values (point) key)
14969 (and (member value '("[ ]" "[-]" "[X]"))
14970 '("[ ]" "[X]"))))
14971 nval)
14972 (unless allowed
14973 (error "Allowed values for this property have not been defined"))
14974 (if previous (setq allowed (reverse allowed)))
14975 (if (member value allowed)
14976 (setq nval (car (cdr (member value allowed)))))
14977 (setq nval (or nval (car allowed)))
14978 (if (equal nval value)
14979 (error "Only one allowed value for this property"))
14980 (org-at-property-p)
14981 (replace-match (concat " :" key ": " nval) t t)
14982 (org-indent-line)
14983 (beginning-of-line 1)
14985 (run-hook-with-args 'org-property-changed-functions key nval)))
14987 (defun org-find-olp (path &optional this-buffer)
14988 "Return a marker pointing to the entry at outline path OLP.
14989 If anything goes wrong, throw an error.
14990 You can wrap this call to catch the error like this:
14992 (condition-case msg
14993 (org-mobile-locate-entry (match-string 4))
14994 (error (nth 1 msg)))
14996 The return value will then be either a string with the error message,
14997 or a marker if everything is OK.
14999 If THIS-BUFFER is set, the outline path does not contain a file,
15000 only headings."
15001 (let* ((file (if this-buffer buffer-file-name (pop path)))
15002 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15003 (level 1)
15004 (lmin 1)
15005 (lmax 1)
15006 limit re end found pos heading cnt flevel)
15007 (unless buffer (error "File not found :%s" file))
15008 (with-current-buffer buffer
15009 (save-excursion
15010 (save-restriction
15011 (widen)
15012 (setq limit (point-max))
15013 (goto-char (point-min))
15014 (while (setq heading (pop path))
15015 (setq re (format org-complex-heading-regexp-format
15016 (regexp-quote heading)))
15017 (setq cnt 0 pos (point))
15018 (while (re-search-forward re end t)
15019 (setq level (- (match-end 1) (match-beginning 1)))
15020 (if (and (>= level lmin) (<= level lmax))
15021 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15022 (when (= cnt 0) (error "Heading not found on level %d: %s"
15023 lmax heading))
15024 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15025 lmax heading))
15026 (goto-char found)
15027 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15028 (setq end (save-excursion (org-end-of-subtree t t))))
15029 (when (org-at-heading-p)
15030 (move-marker (make-marker) (point))))))))
15032 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15033 "Find node HEADING in BUFFER.
15034 Return a marker to the heading if it was found, or nil if not.
15035 If POS-ONLY is set, return just the position instead of a marker.
15037 The heading text must match exact, but it may have a TODO keyword,
15038 a priority cookie and tags in the standard locations."
15039 (with-current-buffer (or buffer (current-buffer))
15040 (save-excursion
15041 (save-restriction
15042 (widen)
15043 (goto-char (point-min))
15044 (let (case-fold-search)
15045 (if (re-search-forward
15046 (format org-complex-heading-regexp-format
15047 (regexp-quote heading)) nil t)
15048 (if pos-only
15049 (match-beginning 0)
15050 (move-marker (make-marker) (match-beginning 0)))))))))
15052 (defun org-find-exact-heading-in-directory (heading &optional dir)
15053 "Find Org node headline HEADING in all .org files in directory DIR.
15054 When the target headline is found, return a marker to this location."
15055 (let ((files (directory-files (or dir default-directory)
15057 file visiting m buffer)
15058 (catch 'found
15059 (while (setq file (pop files))
15060 (message "trying %s" file)
15061 (setq visiting (org-find-base-buffer-visiting file))
15062 (setq buffer (or visiting (find-file-noselect file)))
15063 (setq m (org-find-exact-headline-in-buffer
15064 heading buffer))
15065 (when (and (not m) (not visiting)) (kill-buffer buffer))
15066 (and m (throw 'found m))))))
15068 (defun org-find-entry-with-id (ident)
15069 "Locate the entry that contains the ID property with exact value IDENT.
15070 IDENT can be a string, a symbol or a number, this function will search for
15071 the string representation of it.
15072 Return the position where this entry starts, or nil if there is no such entry."
15073 (interactive "sID: ")
15074 (let ((id (cond
15075 ((stringp ident) ident)
15076 ((symbol-name ident) (symbol-name ident))
15077 ((numberp ident) (number-to-string ident))
15078 (t (error "IDENT %s must be a string, symbol or number" ident))))
15079 (case-fold-search nil))
15080 (save-excursion
15081 (save-restriction
15082 (widen)
15083 (goto-char (point-min))
15084 (when (re-search-forward
15086 nil t)
15087 (org-back-to-heading t)
15088 (point))))))
15090 ;;;; Timestamps
15092 (defvar org-last-changed-timestamp nil)
15093 (defvar org-last-inserted-timestamp nil
15094 "The last time stamp inserted with `org-insert-time-stamp'.")
15095 (defvar org-time-was-given) ; dynamically scoped parameter
15096 (defvar org-end-time-was-given) ; dynamically scoped parameter
15097 (defvar org-ts-what) ; dynamically scoped parameter
15099 (defun org-time-stamp (arg &optional inactive)
15100 "Prompt for a date/time and insert a time stamp.
15101 If the user specifies a time like HH:MM or if this command is
15102 called with at least one prefix argument, the time stamp contains
15103 the date and the time. Otherwise, only the date is be included.
15105 All parts of a date not specified by the user is filled in from
15106 the current date/time. So if you just press return without
15107 typing anything, the time stamp will represent the current
15108 date/time.
15110 If there is already a timestamp at the cursor, it will be
15111 modified.
15113 With two universal prefix arguments, insert an active timestamp
15114 with the current time without prompting the user."
15115 (interactive "P")
15116 (let* ((ts nil)
15117 (default-time
15118 ;; Default time is either today, or, when entering a range,
15119 ;; the range start.
15120 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15121 (save-excursion
15122 (re-search-backward
15124 (- (point) 20) t)))
15125 (apply 'encode-time (org-parse-time-string (match-string 1)))
15126 (current-time)))
15127 (default-input (and ts (org-get-compact-tod ts)))
15128 (repeater (save-excursion
15129 (save-match-data
15130 (beginning-of-line)
15131 (when (re-search-forward
15133 (save-excursion (progn (end-of-line) (point))) t)
15134 (match-string 0)))))
15135 org-time-was-given org-end-time-was-given time)
15136 (cond
15137 ((and (org-at-timestamp-p t)
15138 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15139 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15140 (insert "--")
15141 (setq time (let ((this-command this-command))
15142 (org-read-date arg 'totime nil nil
15143 default-time default-input inactive)))
15144 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15145 ((org-at-timestamp-p t)
15146 (setq time (let ((this-command this-command))
15147 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15148 (when (org-at-timestamp-p t) ; just to get the match data
15149 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15150 (replace-match "")
15151 (setq org-last-changed-timestamp
15152 (org-insert-time-stamp
15153 time (or org-time-was-given arg)
15154 inactive nil nil (list org-end-time-was-given)))
15155 (when repeater (goto-char (1- (point))) (insert " " repeater)
15156 (setq org-last-changed-timestamp
15157 (concat (substring org-last-inserted-timestamp 0 -1)
15158 " " repeater ">"))))
15159 (message "Timestamp updated"))
15160 ((equal arg '(16))
15161 (org-insert-time-stamp (current-time) t))
15162 (t
15163 (setq time (let ((this-command this-command))
15164 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15165 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15166 nil nil (list org-end-time-was-given))))))
15168 ;; FIXME: can we use this for something else, like computing time differences?
15169 (defun org-get-compact-tod (s)
15170 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15171 (let* ((t1 (match-string 1 s))
15172 (h1 (string-to-number (match-string 2 s)))
15173 (m1 (string-to-number (match-string 3 s)))
15174 (t2 (and (match-end 4) (match-string 5 s)))
15175 (h2 (and t2 (string-to-number (match-string 6 s))))
15176 (m2 (and t2 (string-to-number (match-string 7 s))))
15177 dh dm)
15178 (if (not t2)
15179 t1
15180 (setq dh (- h2 h1) dm (- m2 m1))
15181 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15182 (concat t1 "+" (number-to-string dh)
15183 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15185 (defun org-time-stamp-inactive (&optional arg)
15186 "Insert an inactive time stamp.
15187 An inactive time stamp is enclosed in square brackets instead of angle
15188 brackets. It is inactive in the sense that it does not trigger agenda entries,
15189 does not link to the calendar and cannot be changed with the S-cursor keys.
15190 So these are more for recording a certain time/date."
15191 (interactive "P")
15192 (org-time-stamp arg 'inactive))
15194 (defvar org-date-ovl (make-overlay 1 1))
15195 (overlay-put org-date-ovl 'face 'org-date-selected)
15196 (org-detach-overlay org-date-ovl)
15198 (defvar org-ans1) ; dynamically scoped parameter
15199 (defvar org-ans2) ; dynamically scoped parameter
15201 (defvar org-plain-time-of-day-regexp) ; defined below
15203 (defvar org-overriding-default-time nil) ; dynamically scoped
15204 (defvar org-read-date-overlay nil)
15205 (defvar org-dcst nil) ; dynamically scoped
15206 (defvar org-read-date-history nil)
15207 (defvar org-read-date-final-answer nil)
15208 (defvar org-read-date-analyze-futurep nil)
15209 (defvar org-read-date-analyze-forced-year nil)
15210 (defvar org-read-date-inactive)
15212 (defun org-read-date (&optional org-with-time to-time from-string prompt
15213 default-time default-input inactive)
15214 "Read a date, possibly a time, and make things smooth for the user.
15215 The prompt will suggest to enter an ISO date, but you can also enter anything
15216 which will at least partially be understood by `parse-time-string'.
15217 Unrecognized parts of the date will default to the current day, month, year,
15218 hour and minute. If this command is called to replace a timestamp at point,
15219 or to enter the second timestamp of a range, the default time is taken
15220 from the existing stamp. Furthermore, the command prefers the future,
15221 so if you are giving a date where the year is not given, and the day-month
15222 combination is already past in the current year, it will assume you
15223 mean next year. For details, see the manual. A few examples:
15225 3-2-5 --> 2003-02-05
15226 feb 15 --> currentyear-02-15
15227 2/15 --> currentyear-02-15
15228 sep 12 9 --> 2009-09-12
15229 12:45 --> today 12:45
15230 22 sept 0:34 --> currentyear-09-22 0:34
15231 12 --> currentyear-currentmonth-12
15232 Fri --> nearest Friday (today or later)
15233 etc.
15235 Furthermore you can specify a relative date by giving, as the *first* thing
15236 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15237 change in days weeks, months, years.
15238 With a single plus or minus, the date is relative to today. With a double
15239 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15240 +4d --> four days from today
15241 +4 --> same as above
15242 +2w --> two weeks from today
15243 ++5 --> five days from default date
15245 The function understands only English month and weekday abbreviations.
15247 While prompting, a calendar is popped up - you can also select the
15248 date with the mouse (button 1). The calendar shows a period of three
15249 months. To scroll it to other months, use the keys `>' and `<'.
15250 If you don't like the calendar, turn it off with
15251 \(setq org-read-date-popup-calendar nil)
15253 With optional argument TO-TIME, the date will immediately be converted
15254 to an internal time.
15255 With an optional argument ORG-WITH-TIME, the prompt will suggest to
15256 also insert a time. Note that when ORG-WITH-TIME is not set, you can
15257 still enter a time, and this function will inform the calling routine
15258 about this change. The calling routine may then choose to change the
15259 format used to insert the time stamp into the buffer to include the time.
15260 With optional argument FROM-STRING, read from this string instead from
15261 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15262 the time/date that is used for everything that is not specified by the
15263 user."
15264 (require 'parse-time)
15265 (let* ((org-time-stamp-rounding-minutes
15266 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15267 (org-dcst org-display-custom-times)
15268 (ct (org-current-time))
15269 (org-def (or org-overriding-default-time default-time ct))
15270 (org-defdecode (decode-time org-def))
15271 (dummy (progn
15272 (when (< (nth 2 org-defdecode) org-extend-today-until)
15273 (setcar (nthcdr 2 org-defdecode) -1)
15274 (setcar (nthcdr 1 org-defdecode) 59)
15275 (setq org-def (apply 'encode-time org-defdecode)
15276 org-defdecode (decode-time org-def)))))
15277 (calendar-frame-setup nil)
15278 (calendar-setup nil)
15279 (calendar-move-hook nil)
15280 (calendar-view-diary-initially-flag nil)
15281 (calendar-view-holidays-initially-flag nil)
15282 (timestr (format-time-string
15283 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15284 (prompt (concat (if prompt (concat prompt " ") "")
15285 (format "Date+time [%s]: " timestr)))
15286 ans (org-ans0 "") org-ans1 org-ans2 final)
15288 (cond
15289 (from-string (setq ans from-string))
15290 (org-read-date-popup-calendar
15291 (save-excursion
15292 (save-window-excursion
15293 (calendar)
15294 (org-eval-in-calendar '(setq cursor-type nil) t)
15295 (unwind-protect
15296 (progn
15297 (calendar-forward-day (- (time-to-days org-def)
15298 (calendar-absolute-from-gregorian
15299 (calendar-current-date))))
15300 (org-eval-in-calendar nil t)
15301 (let* ((old-map (current-local-map))
15302 (map (copy-keymap calendar-mode-map))
15303 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15304 (org-defkey map (kbd "RET") 'org-calendar-select)
15305 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15306 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15307 (org-defkey minibuffer-local-map [(meta shift left)]
15308 (lambda () (interactive)
15309 (org-eval-in-calendar '(calendar-backward-month 1))))
15310 (org-defkey minibuffer-local-map [(meta shift right)]
15311 (lambda () (interactive)
15312 (org-eval-in-calendar '(calendar-forward-month 1))))
15313 (org-defkey minibuffer-local-map [(meta shift up)]
15314 (lambda () (interactive)
15315 (org-eval-in-calendar '(calendar-backward-year 1))))
15316 (org-defkey minibuffer-local-map [(meta shift down)]
15317 (lambda () (interactive)
15318 (org-eval-in-calendar '(calendar-forward-year 1))))
15319 (org-defkey minibuffer-local-map [?\e (shift left)]
15320 (lambda () (interactive)
15321 (org-eval-in-calendar '(calendar-backward-month 1))))
15322 (org-defkey minibuffer-local-map [?\e (shift right)]
15323 (lambda () (interactive)
15324 (org-eval-in-calendar '(calendar-forward-month 1))))
15325 (org-defkey minibuffer-local-map [?\e (shift up)]
15326 (lambda () (interactive)
15327 (org-eval-in-calendar '(calendar-backward-year 1))))
15328 (org-defkey minibuffer-local-map [?\e (shift down)]
15329 (lambda () (interactive)
15330 (org-eval-in-calendar '(calendar-forward-year 1))))
15331 (org-defkey minibuffer-local-map [(shift up)]
15332 (lambda () (interactive)
15333 (org-eval-in-calendar '(calendar-backward-week 1))))
15334 (org-defkey minibuffer-local-map [(shift down)]
15335 (lambda () (interactive)
15336 (org-eval-in-calendar '(calendar-forward-week 1))))
15337 (org-defkey minibuffer-local-map [(shift left)]
15338 (lambda () (interactive)
15339 (org-eval-in-calendar '(calendar-backward-day 1))))
15340 (org-defkey minibuffer-local-map [(shift right)]
15341 (lambda () (interactive)
15342 (org-eval-in-calendar '(calendar-forward-day 1))))
15343 (org-defkey minibuffer-local-map ">"
15344 (lambda () (interactive)
15345 (org-eval-in-calendar '(scroll-calendar-left 1))))
15346 (org-defkey minibuffer-local-map "<"
15347 (lambda () (interactive)
15348 (org-eval-in-calendar '(scroll-calendar-right 1))))
15349 (org-defkey minibuffer-local-map "\C-v"
15350 (lambda () (interactive)
15351 (org-eval-in-calendar
15352 '(calendar-scroll-left-three-months 1))))
15353 (org-defkey minibuffer-local-map "\M-v"
15354 (lambda () (interactive)
15355 (org-eval-in-calendar
15356 '(calendar-scroll-right-three-months 1))))
15357 (run-hooks 'org-read-date-minibuffer-setup-hook)
15358 (unwind-protect
15359 (progn
15360 (use-local-map map)
15361 (setq org-read-date-inactive inactive)
15362 (add-hook 'post-command-hook 'org-read-date-display)
15363 (setq org-ans0 (read-string prompt default-input
15364 'org-read-date-history nil))
15365 ;; org-ans0: from prompt
15366 ;; org-ans1: from mouse click
15367 ;; org-ans2: from calendar motion
15368 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15369 (remove-hook 'post-command-hook 'org-read-date-display)
15370 (use-local-map old-map)
15371 (when org-read-date-overlay
15372 (delete-overlay org-read-date-overlay)
15373 (setq org-read-date-overlay nil)))))
15374 (bury-buffer "*Calendar*")))))
15376 (t ; Naked prompt only
15377 (unwind-protect
15378 (setq ans (read-string prompt default-input
15379 'org-read-date-history timestr))
15380 (when org-read-date-overlay
15381 (delete-overlay org-read-date-overlay)
15382 (setq org-read-date-overlay nil)))))
15384 (setq final (org-read-date-analyze ans org-def org-defdecode))
15386 (when org-read-date-analyze-forced-year
15387 (message "Year was forced into %s"
15388 (if org-read-date-force-compatible-dates
15389 "compatible range (1970-2037)"
15390 "range representable on this machine"))
15391 (ding))
15393 ;; One round trip to get rid of 34th of August and stuff like that....
15394 (setq final (decode-time (apply 'encode-time final)))
15396 (setq org-read-date-final-answer ans)
15398 (if to-time
15399 (apply 'encode-time final)
15400 (if (and (boundp 'org-time-was-given) org-time-was-given)
15401 (format "%04d-%02d-%02d %02d:%02d"
15402 (nth 5 final) (nth 4 final) (nth 3 final)
15403 (nth 2 final) (nth 1 final))
15404 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15406 (defvar org-def)
15407 (defvar org-defdecode)
15408 (defvar org-with-time)
15409 (defun org-read-date-display ()
15410 "Display the current date prompt interpretation in the minibuffer."
15411 (when org-read-date-display-live
15412 (when org-read-date-overlay
15413 (delete-overlay org-read-date-overlay))
15414 (when (minibufferp (current-buffer))
15415 (save-excursion
15416 (end-of-line 1)
15417 (while (not (equal (buffer-substring
15418 (max (point-min) (- (point) 4)) (point))
15419 " "))
15420 (insert " ")))
15421 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15422 " " (or org-ans1 org-ans2)))
15423 (org-end-time-was-given nil)
15424 (f (org-read-date-analyze ans org-def org-defdecode))
15425 (fmts (if org-dcst
15426 org-time-stamp-custom-formats
15427 org-time-stamp-formats))
15428 (fmt (if (or org-with-time
15429 (and (boundp 'org-time-was-given) org-time-was-given))
15430 (cdr fmts)
15431 (car fmts)))
15432 (txt (format-time-string fmt (apply 'encode-time f)))
15433 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15434 (txt (concat "=> " txt)))
15435 (when (and org-end-time-was-given
15436 (string-match org-plain-time-of-day-regexp txt))
15437 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15438 org-end-time-was-given
15439 (substring txt (match-end 0)))))
15440 (when org-read-date-analyze-futurep
15441 (setq txt (concat txt " (=>F)")))
15442 (setq org-read-date-overlay
15443 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15444 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
15446 (defun org-read-date-analyze (ans org-def org-defdecode)
15447 "Analyze the combined answer of the date prompt."
15448 ;; FIXME: cleanup and comment
15449 (let ((nowdecode (decode-time (current-time)))
15450 delta deltan deltaw deltadef year month day
15451 hour minute second wday pm h2 m2 tl wday1
15452 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15453 (setq org-read-date-analyze-futurep nil
15454 org-read-date-analyze-forced-year nil)
15456 (setq ans "+0"))
15458 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15459 (setq ans (replace-match "" t t ans)
15460 deltan (car delta)
15461 deltaw (nth 1 delta)
15462 deltadef (nth 2 delta)))
15464 ;; Check if there is an iso week date in there. If yes, store the
15465 ;; info and postpone interpreting it until the rest of the parsing
15466 ;; is done.
15467 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15468 (setq iso-year (if (match-end 1)
15469 (org-small-year-to-year
15470 (string-to-number (match-string 1 ans))))
15471 iso-weekday (if (match-end 3)
15472 (string-to-number (match-string 3 ans)))
15473 iso-week (string-to-number (match-string 2 ans)))
15474 (setq ans (replace-match "" t t ans)))
15476 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15477 (when (string-match
15479 (setq year (if (match-end 2)
15480 (string-to-number (match-string 2 ans))
15481 (progn (setq kill-year t)
15482 (string-to-number (format-time-string "%Y"))))
15483 month (string-to-number (match-string 3 ans))
15484 day (string-to-number (match-string 4 ans)))
15485 (if (< year 100) (setq year (+ 2000 year)))
15487 t nil ans)))
15489 ;; Help matching dotted european dates
15490 (when (string-match
15491 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15492 (setq year (if (match-end 3)
15493 (string-to-number (match-string 3 ans))
15494 (progn (setq kill-year t)
15495 (string-to-number (format-time-string "%Y"))))
15496 day (string-to-number (match-string 1 ans))
15497 month (string-to-number (match-string 2 ans))
15499 t nil ans)))
15501 ;; Help matching american dates, like 5/30 or 5/30/7
15502 (when (string-match
15503 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15504 (setq year (if (match-end 4)
15505 (string-to-number (match-string 4 ans))
15506 (progn (setq kill-year t)
15507 (string-to-number (format-time-string "%Y"))))
15508 month (string-to-number (match-string 1 ans))
15509 day (string-to-number (match-string 2 ans)))
15510 (if (< year 100) (setq year (+ 2000 year)))
15512 t nil ans)))
15513 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15514 ;; If there is a time with am/pm, and *no* time without it, we convert
15515 ;; so that matching will be successful.
15516 (loop for i from 1 to 2 do ; twice, for end time as well
15519 (setq hour (string-to-number (match-string 1 ans))
15520 minute (if (match-end 3)
15521 (string-to-number (match-string 3 ans))
15522 0)
15523 pm (equal ?p
15524 (string-to-char (downcase (match-string 4 ans)))))
15525 (if (and (= hour 12) (not pm))
15526 (setq hour 0)
15527 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15528 (setq ans (replace-match (format "%02d:%02d" hour minute)
15529 t t ans))))
15531 ;; Check if a time range is given as a duration
15532 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15533 (setq hour (string-to-number (match-string 1 ans))
15534 h2 (+ hour (string-to-number (match-string 3 ans)))
15535 minute (string-to-number (match-string 2 ans))
15536 m2 (+ minute (if (match-end 5) (string-to-number
15537 (match-string 5 ans))0)))
15538 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15539 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15540 t t ans)))
15542 ;; Check if there is a time range
15543 (when (boundp 'org-end-time-was-given)
15544 (setq org-time-was-given nil)
15545 (when (and (string-match org-plain-time-of-day-regexp ans)
15546 (match-end 8))
15547 (setq org-end-time-was-given (match-string 8 ans))
15548 (setq ans (concat (substring ans 0 (match-beginning 7))
15549 (substring ans (match-end 7))))))
15551 (setq tl (parse-time-string ans)
15552 day (or (nth 3 tl) (nth 3 org-defdecode))
15553 month (or (nth 4 tl)
15554 (if (and org-read-date-prefer-future
15555 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15556 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15557 (nth 4 org-defdecode)))
15558 year (or (and (not kill-year) (nth 5 tl))
15559 (if (and org-read-date-prefer-future
15560 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15561 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15562 (nth 5 org-defdecode)))
15563 hour (or (nth 2 tl) (nth 2 org-defdecode))
15564 minute (or (nth 1 tl) (nth 1 org-defdecode))
15565 second (or (nth 0 tl) 0)
15566 wday (nth 6 tl))
15568 (when (and (eq org-read-date-prefer-future 'time)
15569 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15570 (equal day (nth 3 nowdecode))
15571 (equal month (nth 4 nowdecode))
15572 (equal year (nth 5 nowdecode))
15573 (nth 2 tl)
15574 (or (< (nth 2 tl) (nth 2 nowdecode))
15575 (and (= (nth 2 tl) (nth 2 nowdecode))
15576 (nth 1 tl)
15577 (< (nth 1 tl) (nth 1 nowdecode)))))
15578 (setq day (1+ day)
15579 futurep t))
15581 ;; Special date definitions below
15582 (cond
15583 (iso-week
15584 ;; There was an iso week
15585 (require 'cal-iso)
15586 (setq futurep nil)
15587 (setq year (or iso-year year)
15588 day (or iso-weekday wday 1)
15589 wday nil ; to make sure that the trigger below does not match
15590 iso-date (calendar-gregorian-from-absolute
15591 (calendar-absolute-from-iso
15592 (list iso-week day year))))
15593 ; FIXME: Should we also push ISO weeks into the future?
15594 ; (when (and org-read-date-prefer-future
15595 ; (not iso-year)
15596 ; (< (calendar-absolute-from-gregorian iso-date)
15597 ; (time-to-days (current-time))))
15598 ; (setq year (1+ year)
15599 ; iso-date (calendar-gregorian-from-absolute
15600 ; (calendar-absolute-from-iso
15601 ; (list iso-week day year)))))
15602 (setq month (car iso-date)
15603 year (nth 2 iso-date)
15604 day (nth 1 iso-date)))
15605 (deltan
15606 (setq futurep nil)
15607 (unless deltadef
15608 (let ((now (decode-time (current-time))))
15609 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15610 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15611 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15612 ((equal deltaw "m") (setq month (+ month deltan)))
15613 ((equal deltaw "y") (setq year (+ year deltan)))))
15614 ((and wday (not (nth 3 tl)))
15615 ;; Weekday was given, but no day, so pick that day in the week
15616 ;; on or after the derived date.
15617 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15618 (unless (equal wday wday1)
15619 (setq day (+ day (% (- wday wday1 -7) 7))))))
15620 (if (and (boundp 'org-time-was-given)
15621 (nth 2 tl))
15622 (setq org-time-was-given t))
15623 (if (< year 100) (setq year (+ 2000 year)))
15624 ;; Check of the date is representable
15625 (if org-read-date-force-compatible-dates
15626 (progn
15627 (if (< year 1970)
15628 (setq year 1970 org-read-date-analyze-forced-year t))
15629 (if (> year 2037)
15630 (setq year 2037 org-read-date-analyze-forced-year t)))
15631 (condition-case nil
15632 (ignore (encode-time second minute hour day month year))
15633 (error
15634 (setq year (nth 5 org-defdecode))
15635 (setq org-read-date-analyze-forced-year t))))
15636 (setq org-read-date-analyze-futurep futurep)
15637 (list second minute hour day month year)))
15639 (defvar parse-time-weekdays)
15640 (defun org-read-date-get-relative (s today default)
15641 "Check string S for special relative date string.
15642 TODAY and DEFAULT are internal times, for today and for a default.
15643 Return shift list (N what def-flag)
15645 N is the number of WHATs to shift.
15646 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15647 the DEFAULT date rather than TODAY."
15648 (require 'parse-time)
15649 (when (and
15650 (string-match
15651 (concat
15656 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15657 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15658 (string-to-char (substring (match-string 1 s) -1))
15659 ?+))
15660 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15661 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15662 (what (if (match-end 3) (match-string 3 s) "d"))
15663 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15664 (date (if rel default today))
15665 (wday (nth 6 (decode-time date)))
15666 delta)
15667 (if wday1
15668 (progn
15669 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15670 (if (= dir ?-) (setq delta (- delta 7)))
15671 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15672 (list delta "d" rel))
15673 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15675 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15676 "Turn a user-specified date into the internal representation.
15677 The internal representation needed by the calendar is (month day year).
15678 This is a wrapper to handle the brain-dead convention in calendar that
15679 user function argument order change dependent on argument order."
15680 (if (boundp 'calendar-date-style)
15681 (cond
15682 ((eq calendar-date-style 'american)
15683 (list arg1 arg2 arg3))
15684 ((eq calendar-date-style 'european)
15685 (list arg2 arg1 arg3))
15686 ((eq calendar-date-style 'iso)
15687 (list arg2 arg3 arg1)))
15688 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15689 (if (org-bound-and-true-p european-calendar-style)
15690 (list arg2 arg1 arg3)
15691 (list arg1 arg2 arg3)))))
15693 (defun org-eval-in-calendar (form &optional keepdate)
15694 "Eval FORM in the calendar window and return to current window.
15695 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
15696 otherwise stick to the current value of `org-ans2'."
15697 (let ((sf (selected-frame))
15698 (sw (selected-window)))
15699 (select-window (get-buffer-window "*Calendar*" t))
15700 (eval form)
15701 (when (and (not keepdate) (calendar-cursor-to-date))
15702 (let* ((date (calendar-cursor-to-date))
15703 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15704 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15705 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15706 (select-window sw)
15707 (org-select-frame-set-input-focus sf)))
15709 (defun org-calendar-select ()
15710 "Return to `org-read-date' with the date currently selected.
15711 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15712 (interactive)
15713 (when (calendar-cursor-to-date)
15714 (let* ((date (calendar-cursor-to-date))
15715 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15716 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15717 (if (active-minibuffer-window) (exit-minibuffer))))
15719 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15720 "Insert a date stamp for the date given by the internal TIME.
15721 WITH-HM means use the stamp format that includes the time of the day.
15722 INACTIVE means use square brackets instead of angular ones, so that the
15723 stamp will not contribute to the agenda.
15724 PRE and POST are optional strings to be inserted before and after the
15725 stamp.
15726 The command returns the inserted time stamp."
15727 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15728 stamp)
15729 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15730 (insert-before-markers (or pre ""))
15731 (when (listp extra)
15732 (setq extra (car extra))
15733 (if (and (stringp extra)
15735 (setq extra (format "-%02d:%02d"
15736 (string-to-number (match-string 1 extra))
15737 (string-to-number (match-string 2 extra))))
15738 (setq extra nil)))
15739 (when extra
15740 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15741 (insert-before-markers (setq stamp (format-time-string fmt time)))
15742 (insert-before-markers (or post ""))
15743 (setq org-last-inserted-timestamp stamp)))
15745 (defun org-toggle-time-stamp-overlays ()
15746 "Toggle the use of custom time stamp formats."
15747 (interactive)
15748 (setq org-display-custom-times (not org-display-custom-times))
15749 (unless org-display-custom-times
15750 (let ((p (point-min)) (bmp (buffer-modified-p)))
15751 (while (setq p (next-single-property-change p 'display))
15752 (if (and (get-text-property p 'display)
15753 (eq (get-text-property p 'face) 'org-date))
15754 (remove-text-properties
15755 p (setq p (next-single-property-change p 'display))
15756 '(display t))))
15757 (set-buffer-modified-p bmp)))
15758 (if (featurep 'xemacs)
15759 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15760 (org-restart-font-lock)
15761 (setq org-table-may-need-update t)
15762 (if org-display-custom-times
15763 (message "Time stamps are overlaid with custom format")
15764 (message "Time stamp overlays removed")))
15766 (defun org-display-custom-time (beg end)
15767 "Overlay modified time stamp format over timestamp between BEG and END."
15768 (let* ((ts (buffer-substring beg end))
15769 t1 w1 with-hm tf time str w2 (off 0))
15770 (save-match-data
15771 (setq t1 (org-parse-time-string ts t))
15772 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
15773 (setq off (- (match-end 0) (match-beginning 0)))))
15774 (setq end (- end off))
15775 (setq w1 (- end beg)
15776 with-hm (and (nth 1 t1) (nth 2 t1))
15777 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15778 time (org-fix-decoded-time t1)
15779 str (org-add-props
15780 (format-time-string
15781 (substring tf 1 -1) (apply 'encode-time time))
15782 nil 'mouse-face 'highlight)
15783 w2 (length str))
15784 (if (not (= w2 w1))
15785 (add-text-properties (1+ beg) (+ 2 beg)
15786 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15787 (if (featurep 'xemacs)
15788 (progn
15789 (put-text-property beg end 'invisible t)
15790 (put-text-property beg end 'end-glyph (make-glyph str)))
15791 (put-text-property beg end 'display str))))
15793 (defun org-translate-time (string)
15794 "Translate all timestamps in STRING to custom format.
15795 But do this only if the variable `org-display-custom-times' is set."
15796 (when org-display-custom-times
15797 (save-match-data
15798 (let* ((start 0)
15799 (re org-ts-regexp-both)
15800 t1 with-hm inactive tf time str beg end)
15801 (while (setq start (string-match re string start))
15802 (setq beg (match-beginning 0)
15803 end (match-end 0)
15804 t1 (save-match-data
15805 (org-parse-time-string (substring string beg end) t))
15806 with-hm (and (nth 1 t1) (nth 2 t1))
15807 inactive (equal (substring string beg (1+ beg)) "[")
15808 tf (funcall (if with-hm 'cdr 'car)
15809 org-time-stamp-custom-formats)
15810 time (org-fix-decoded-time t1)
15811 str (format-time-string
15812 (concat
15813 (if inactive "[" "<") (substring tf 1 -1)
15814 (if inactive "]" ">"))
15815 (apply 'encode-time time))
15816 string (replace-match str t t string)
15817 start (+ start (length str)))))))
15818 string)
15820 (defun org-fix-decoded-time (time)
15821 "Set 0 instead of nil for the first 6 elements of time.
15822 Don't touch the rest."
15823 (let ((n 0))
15824 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15826 (defun org-days-to-time (timestamp-string)
15827 "Difference between TIMESTAMP-STRING and now in days."
15828 (- (time-to-days (org-time-string-to-time timestamp-string))
15829 (time-to-days (current-time))))
15831 (defun org-deadline-close (timestamp-string &optional ndays)
15832 "Is the time in TIMESTAMP-STRING close to the current date?"
15833 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15834 (and (< (org-days-to-time timestamp-string) ndays)
15835 (not (org-entry-is-done-p))))
15837 (defun org-get-wdays (ts)
15838 "Get the deadline lead time appropriate for timestring TS."
15839 (cond
15840 ((<= org-deadline-warning-days 0)
15841 ;; 0 or negative, enforce this value no matter what
15842 (- org-deadline-warning-days))
15844 ;; lead time is specified.
15845 (floor (* (string-to-number (match-string 1 ts))
15846 (cdr (assoc (match-string 2 ts)
15847 '(("d" . 1) ("w" . 7)
15848 ("m" . 30.4) ("y" . 365.25)))))))
15849 ;; go for the default.
15850 (t org-deadline-warning-days)))
15852 (defun org-calendar-select-mouse (ev)
15853 "Return to `org-read-date' with the date currently selected.
15854 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15855 (interactive "e")
15856 (mouse-set-point ev)
15857 (when (calendar-cursor-to-date)
15858 (let* ((date (calendar-cursor-to-date))
15859 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15860 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15861 (if (active-minibuffer-window) (exit-minibuffer))))
15863 (defun org-check-deadlines (ndays)
15864 "Check if there are any deadlines due or past due.
15865 A deadline is considered due if it happens within `org-deadline-warning-days'
15866 days from today's date. If the deadline appears in an entry marked DONE,
15867 it is not shown. The prefix arg NDAYS can be used to test that many
15869 (interactive "P")
15870 (let* ((org-warn-days
15871 (cond
15872 ((equal ndays '(4)) 100000)
15873 (ndays (prefix-numeric-value ndays))
15874 (t (abs org-deadline-warning-days))))
15875 (case-fold-search nil)
15877 (callback
15878 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15880 (message "%d deadlines past-due or due within %d days"
15881 (org-occur regexp nil callback)
15882 org-warn-days)))
15884 (defsubst org-re-timestamp (type)
15885 "Return a regexp for timestamp TYPE.
15886 Allowed values for TYPE are:
15888 all: all timestamps
15889 active: only active timestamps (<...>)
15890 inactive: only inactive timestamps ([...])
15891 scheduled: only scheduled timestamps
15892 deadline: only deadline timestamps
15894 When TYPE is nil, fall back on returning a regexp that matches
15895 both scheduled and deadline timestamps."
15896 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
15897 ((eq type 'active) org-ts-regexp)
15901 ((eq type 'scheduled-or-deadline)
15904 (defun org-check-before-date (date)
15905 "Check if there are deadlines or scheduled entries before DATE."
15906 (interactive (list (org-read-date)))
15907 (let ((case-fold-search nil)
15908 (regexp (org-re-timestamp org-ts-type))
15909 (callback
15910 (lambda () (time-less-p
15911 (org-time-string-to-time (match-string 1))
15912 (org-time-string-to-time date)))))
15913 (message "%d entries before %s"
15914 (org-occur regexp nil callback) date)))
15916 (defun org-check-after-date (date)
15917 "Check if there are deadlines or scheduled entries after DATE."
15918 (interactive (list (org-read-date)))
15919 (let ((case-fold-search nil)
15920 (regexp (org-re-timestamp org-ts-type))
15921 (callback
15922 (lambda () (not
15923 (time-less-p
15924 (org-time-string-to-time (match-string 1))
15925 (org-time-string-to-time date))))))
15926 (message "%d entries after %s"
15927 (org-occur regexp nil callback) date)))
15929 (defun org-check-dates-range (start-date end-date)
15930 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15931 (interactive (list (org-read-date nil nil nil "Range starts")
15932 (org-read-date nil nil nil "Range end")))
15933 (let ((case-fold-search nil)
15934 (regexp (org-re-timestamp org-ts-type))
15935 (callback
15936 (lambda ()
15937 (let ((match (match-string 1)))
15938 (and
15939 (not (time-less-p
15940 (org-time-string-to-time match)
15941 (org-time-string-to-time start-date)))
15942 (time-less-p
15943 (org-time-string-to-time match)
15944 (org-time-string-to-time end-date)))))))
15945 (message "%d entries between %s and %s"
15946 (org-occur regexp nil callback) start-date end-date)))
15948 (defun org-evaluate-time-range (&optional to-buffer)
15949 "Evaluate a time range by computing the difference between start and end.
15950 Normally the result is just printed in the echo area, but with prefix arg
15951 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15952 If the time range is actually in a table, the result is inserted into the
15953 next column.
15954 For time difference computation, a year is assumed to be exactly 365
15955 days in order to avoid rounding problems."
15956 (interactive "P")
15957 (or
15958 (org-clock-update-time-maybe)
15959 (save-excursion
15960 (unless (org-at-date-range-p t)
15961 (goto-char (point-at-bol))
15962 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15963 (if (not (org-at-date-range-p t))
15964 (error "Not at a time-stamp range, and none found in current line")))
15965 (let* ((ts1 (match-string 1))
15966 (ts2 (match-string 2))
15967 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15968 (match-end (match-end 0))
15969 (time1 (org-time-string-to-time ts1))
15970 (time2 (org-time-string-to-time ts2))
15971 (t1 (org-float-time time1))
15972 (t2 (org-float-time time2))
15973 (diff (abs (- t2 t1)))
15974 (negative (< (- t2 t1) 0))
15975 ;; (ys (floor (* 365 24 60 60)))
15976 (ds (* 24 60 60))
15977 (hs (* 60 60))
15978 (fy "%dy %dd %02d:%02d")
15979 (fy1 "%dy %dd")
15980 (fd "%dd %02d:%02d")
15981 (fd1 "%dd")
15982 (fh "%02d:%02d")
15983 y d h m align)
15984 (if havetime
15985 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15986 y 0
15987 d (floor (/ diff ds)) diff (mod diff ds)
15988 h (floor (/ diff hs)) diff (mod diff hs)
15989 m (floor (/ diff 60)))
15990 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15991 y 0
15992 d (floor (+ (/ diff ds) 0.5))
15993 h 0 m 0))
15994 (if (not to-buffer)
15995 (message "%s" (org-make-tdiff-string y d h m))
15996 (if (org-at-table-p)
15997 (progn
15998 (goto-char match-end)
15999 (setq align t)
16000 (and (looking-at " *|") (goto-char (match-end 0))))
16001 (goto-char match-end))
16002 (if (looking-at
16004 (replace-match ""))
16005 (if negative (insert " -"))
16006 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16007 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16008 (insert " " (format fh h m))))
16009 (if align (org-table-align))
16010 (message "Time difference inserted")))))
16012 (defun org-make-tdiff-string (y d h m)
16013 (let ((fmt "")
16014 (l nil))
16015 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16016 l (push y l)))
16017 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16018 l (push d l)))
16019 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16020 l (push h l)))
16021 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16022 l (push m l)))
16023 (apply 'format fmt (nreverse l))))
16025 (defun org-time-string-to-time (s &optional buffer pos)
16026 "Convert a timestamp string into internal time."
16027 (condition-case errdata
16028 (apply 'encode-time (org-parse-time-string s))
16030 s (if (not (and buffer pos))
16031 ""
16032 (format " at %d in buffer `%s'" pos buffer))
16033 (cdr errdata)))))
16035 (defun org-time-string-to-seconds (s)
16036 "Convert a timestamp string to a number of seconds."
16037 (org-float-time (org-time-string-to-time s)))
16039 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16040 "Convert a time stamp to an absolute day number.
16041 If there is a specifier for a cyclic time stamp, get the closest date to
16042 DAYNR.
16043 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16044 The variable date is bound by the calendar when this is called."
16045 (cond
16047 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16048 daynr
16049 (+ daynr 1000)))
16051 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16052 (time-to-days (current-time))) (match-string 0 s)
16053 prefer show-all))
16054 (t (time-to-days
16055 (condition-case errdata
16056 (apply 'encode-time (org-parse-time-string s))
16058 s (if (not (and buffer pos))
16059 ""
16060 (format " at %d in buffer `%s'" pos buffer))
16061 (cdr errdata))))))))
16063 (defun org-days-to-iso-week (days)
16064 "Return the iso week number."
16065 (require 'cal-iso)
16066 (car (calendar-iso-from-absolute days)))
16068 (defun org-small-year-to-year (year)
16069 "Convert 2-digit years into 4-digit years.
16070 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16071 The year 2000 cannot be abbreviated. Any year larger than 99
16072 is returned unchanged."
16073 (if (< year 38)
16074 (setq year (+ 2000 year))
16075 (if (< year 100)
16076 (setq year (+ 1900 year))))
16077 year)
16079 (defun org-time-from-absolute (d)
16080 "Return the time corresponding to date D.
16081 D may be an absolute day number, or a calendar-type list (month day year)."
16082 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16083 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16085 (defun org-calendar-holiday ()
16086 "List of holidays, for Diary display in Org-mode."
16087 (require 'holidays)
16088 (let ((hl (funcall
16089 (if (fboundp 'calendar-check-holidays)
16090 'calendar-check-holidays 'check-calendar-holidays) date)))
16091 (if hl (mapconcat 'identity hl "; "))))
16093 (defun org-diary-sexp-entry (sexp entry date)
16094 "Process a SEXP diary ENTRY for DATE."
16095 (require 'diary-lib)
16096 (let ((result (if calendar-debug-sexp
16097 (let ((stack-trace-on-error t))
16098 (eval (car (read-from-string sexp))))
16099 (condition-case nil
16100 (eval (car (read-from-string sexp)))
16101 (error
16102 (beep)
16103 (message "Bad sexp at line %d in %s: %s"
16104 (org-current-line)
16105 (buffer-file-name) sexp)
16106 (sleep-for 2))))))
16107 (cond ((stringp result) (split-string result "; "))
16108 ((and (consp result)
16109 (not (consp (cdr result)))
16110 (stringp (cdr result))) (cdr result))
16111 ((and (consp result)
16112 (stringp (car result))) result)
16113 (result entry))))
16115 (defun org-diary-to-ical-string (frombuf)
16116 "Get iCalendar entries from diary entries in buffer FROMBUF.
16117 This uses the icalendar.el library."
16118 (let* ((tmpdir (if (featurep 'xemacs)
16119 (temp-directory)
16120 temporary-file-directory))
16121 (tmpfile (make-temp-name
16122 (expand-file-name "orgics" tmpdir)))
16123 buf rtn b e)
16124 (with-current-buffer frombuf
16125 (icalendar-export-region (point-min) (point-max) tmpfile)
16126 (setq buf (find-buffer-visiting tmpfile))
16127 (set-buffer buf)
16128 (goto-char (point-min))
16129 (if (re-search-forward "^BEGIN:VEVENT" nil t)
16130 (setq b (match-beginning 0)))
16131 (goto-char (point-max))
16132 (if (re-search-backward "^END:VEVENT" nil t)
16133 (setq e (match-end 0)))
16135 (kill-buffer buf)
16136 (delete-file tmpfile)
16137 rtn))
16139 (defun org-closest-date (start current change prefer show-all)
16140 "Find the date closest to CURRENT that is consistent with START and CHANGE.
16141 When PREFER is `past', return a date that is either CURRENT or past.
16142 When PREFER is `future', return a date that is either CURRENT or future.
16143 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
16144 ;; Make the proper lists from the dates
16145 (catch 'exit
16146 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
16147 dn dw sday cday n1 n2 n0
16148 d m y y1 y2 date1 date2 nmonths nm ny m2)
16150 (setq start (org-date-to-gregorian start)
16151 current (org-date-to-gregorian
16152 (if show-all
16153 current
16154 (time-to-days (current-time))))
16155 sday (calendar-absolute-from-gregorian start)
16156 cday (calendar-absolute-from-gregorian current))
16158 (if (<= cday sday) (throw 'exit sday))
16161 (setq dn (string-to-number (match-string 1 change))
16162 dw (cdr (assoc (match-string 2 change) a1)))
16163 (error "Invalid change specifier: %s" change))
16164 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16165 (cond
16166 ((eq dw 'day)
16167 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16168 n2 (+ n1 dn)))
16169 ((eq dw 'year)
16170 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16171 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16172 (setq date1 (list m d y1)
16173 n1 (calendar-absolute-from-gregorian date1)
16174 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16175 n2 (calendar-absolute-from-gregorian date2)))
16176 ((eq dw 'month)
16177 ;; approx number of month between the two dates
16178 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16179 ;; How often does dn fit in there?
16180 (setq d (nth 1 start) m (car start) y (nth 2 start)
16181 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16182 m (+ m nm)
16183 ny (floor (/ m 12))
16184 y (+ y ny)
16185 m (- m (* ny 12)))
16186 (while (> m 12) (setq m (- m 12) y (1+ y)))
16187 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16188 (setq m2 (+ m dn) y2 y)
16189 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16190 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16191 (while (<= n2 cday)
16192 (setq n1 n2 m m2 y y2)
16193 (setq m2 (+ m dn) y2 y)
16194 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16195 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
16196 ;; Make sure n1 is the earlier date
16197 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16198 (if show-all
16199 (cond
16200 ((eq prefer 'past) (if (= cday n2) n2 n1))
16201 ((eq prefer 'future) (if (= cday n1) n1 n2))
16202 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16203 (cond
16204 ((eq prefer 'past) (if (= cday n2) n2 n1))
16205 ((eq prefer 'future) (if (= cday n1) n1 n2))
16206 (t (if (= cday n1) n1 n2)))))))
16208 (defun org-date-to-gregorian (date)
16209 "Turn any specification of DATE into a Gregorian date for the calendar."
16210 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16211 ((and (listp date) (= (length date) 3)) date)
16212 ((stringp date)
16213 (setq date (org-parse-time-string date))
16214 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16215 ((listp date)
16216 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16218 (defun org-parse-time-string (s &optional nodefault)
16219 "Parse the standard Org-mode time string.
16220 This should be a lot faster than the normal `parse-time-string'.
16221 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16222 hour and minute fields will be nil if not given."
16223 (if (string-match org-ts-regexp0 s)
16224 (list 0
16225 (if (or (match-beginning 8) (not nodefault))
16226 (string-to-number (or (match-string 8 s) "0")))
16227 (if (or (match-beginning 7) (not nodefault))
16228 (string-to-number (or (match-string 7 s) "0")))
16229 (string-to-number (match-string 4 s))
16230 (string-to-number (match-string 3 s))
16231 (string-to-number (match-string 2 s))
16232 nil nil nil)
16233 (error "Not a standard Org-mode time string: %s" s)))
16235 (defun org-timestamp-up (&optional arg)
16236 "Increase the date item at the cursor by one.
16237 If the cursor is on the year, change the year. If it is on the month,
16238 the day or the time, change that.
16239 With prefix ARG, change by that many units."
16240 (interactive "p")
16241 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16243 (defun org-timestamp-down (&optional arg)
16244 "Decrease the date item at the cursor by one.
16245 If the cursor is on the year, change the year. If it is on the month,
16246 the day or the time, change that.
16247 With prefix ARG, change by that many units."
16248 (interactive "p")
16249 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16251 (defun org-timestamp-up-day (&optional arg)
16252 "Increase the date in the time stamp by one day.
16253 With prefix ARG, change that many days."
16254 (interactive "p")
16255 (if (and (not (org-at-timestamp-p t))
16256 (org-at-heading-p))
16257 (org-todo 'up)
16258 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16260 (defun org-timestamp-down-day (&optional arg)
16261 "Decrease the date in the time stamp by one day.
16262 With prefix ARG, change that many days."
16263 (interactive "p")
16264 (if (and (not (org-at-timestamp-p t))
16265 (org-at-heading-p))
16266 (org-todo 'down)
16267 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16269 (defun org-at-timestamp-p (&optional inactive-ok)
16270 "Determine if the cursor is in or at a timestamp."
16271 (interactive)
16272 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16273 (pos (point))
16274 (ans (or (looking-at tsr)
16275 (save-excursion
16277 (if (> (point) (point-min)) (backward-char 1))
16278 (and (looking-at tsr)
16279 (> (- (match-end 0) pos) -1))))))
16280 (and ans
16281 (boundp 'org-ts-what)
16282 (setq org-ts-what
16283 (cond
16284 ((= pos (match-beginning 0)) 'bracket)
16285 ;; Point is considered to be "on the bracket" whether
16286 ;; it's really on it or right after it.
16287 ((= pos (1- (match-end 0))) 'bracket)
16288 ((= pos (match-end 0)) 'after)
16289 ((org-pos-in-match-range pos 2) 'year)
16290 ((org-pos-in-match-range pos 3) 'month)
16291 ((org-pos-in-match-range pos 7) 'hour)
16292 ((org-pos-in-match-range pos 8) 'minute)
16293 ((or (org-pos-in-match-range pos 4)
16294 (org-pos-in-match-range pos 5)) 'day)
16295 ((and (> pos (or (match-end 8) (match-end 5)))
16296 (< pos (match-end 0)))
16297 (- pos (or (match-end 8) (match-end 5))))
16298 (t 'day))))
16299 ans))
16301 (defun org-toggle-timestamp-type ()
16302 "Toggle the type (<active> or [inactive]) of a time stamp."
16303 (interactive)
16304 (when (org-at-timestamp-p t)
16305 (let ((beg (match-beginning 0)) (end (match-end 0))
16306 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16307 (save-excursion
16308 (goto-char beg)
16309 (while (re-search-forward "[][<>]" end t)
16310 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16311 t t)))
16312 (message "Timestamp is now %sactive"
16313 (if (equal (char-after beg) ?<) "" "in")))))
16315 (defvar org-clock-history) ; defined in org-clock.el
16316 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
16317 (defun org-timestamp-change (n &optional what updown)
16318 "Change the date in the time stamp at point.
16319 The date will be changed by N times WHAT. WHAT can be `day', `month',
16320 `year', `minute', `second'. If WHAT is not given, the cursor position
16321 in the timestamp determines what will be changed."
16322 (let ((origin (point)) origin-cat
16323 with-hm inactive
16324 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16325 org-ts-what
16326 extra rem
16327 ts time time0 fixnext clrgx)
16328 (if (not (org-at-timestamp-p t))
16329 (error "Not at a timestamp"))
16330 (if (and (not what) (eq org-ts-what 'bracket))
16331 (org-toggle-timestamp-type)
16332 ;; Point isn't on brackets. Remember the part of the time-stamp
16333 ;; the point was in. Indeed, size of time-stamps may change,
16334 ;; but point must be kept in the same category nonetheless.
16335 (setq origin-cat org-ts-what)
16336 (if (and (not what) (not (eq org-ts-what 'day))
16337 org-display-custom-times
16338 (get-text-property (point) 'display)
16339 (not (get-text-property (1- (point)) 'display)))
16340 (setq org-ts-what 'day))
16341 (setq org-ts-what (or what org-ts-what)
16342 inactive (= (char-after (match-beginning 0)) ?\[)
16343 ts (match-string 0))
16344 (replace-match "")
16345 (if (string-match
16347 ts)
16348 (setq extra (match-string 1 ts)))
16350 (setq with-hm t))
16351 (setq time0 (org-parse-time-string ts))
16352 (when (and updown
16353 (eq org-ts-what 'minute)
16354 (not current-prefix-arg))
16355 ;; This looks like s-up and s-down. Change by one rounding step.
16356 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16357 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16358 (setcar (cdr time0) (+ (nth 1 time0)
16359 (if (> n 0) (- rem) (- dm rem))))))
16360 (setq time
16361 (encode-time (or (car time0) 0)
16362 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16363 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16364 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16365 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16366 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16367 (nthcdr 6 time0)))
16368 (when (and (member org-ts-what '(hour minute))
16369 extra
16371 (setq extra (org-modify-ts-extra
16372 extra
16373 (if (eq org-ts-what 'hour) 2 5)
16374 n dm)))
16375 (when (integerp org-ts-what)
16376 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16377 (if (eq what 'calendar)
16378 (let ((cal-date (org-get-date-from-calendar)))
16379 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16380 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16381 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16382 (setcar time0 (or (car time0) 0))
16383 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16384 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16385 (setq time (apply 'encode-time time0))))
16386 ;; Insert the new time-stamp, and ensure point stays in the same
16387 ;; category as before (i.e. not after the last position in that
16388 ;; category).
16389 (let ((pos (point)))
16390 ;; Stay before inserted string. `save-excursion' is of no use.
16391 (setq org-last-changed-timestamp
16392 (org-insert-time-stamp time with-hm inactive nil nil extra))
16393 (goto-char pos))
16394 (save-match-data
16395 (looking-at org-ts-regexp3)
16396 (goto-char (cond
16397 ;; `day' category ends before `hour' if any, or at
16398 ;; the end of the day name.
16399 ((eq origin-cat 'day)
16400 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16401 ((eq origin-cat 'hour) (min (match-end 7) origin))
16402 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16403 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16404 ;; `year' and `month' have both fixed size: point
16405 ;; couldn't have moved into another part.
16406 (t origin))))
16407 ;; Update clock if on a CLOCK line.
16408 (org-clock-update-time-maybe)
16409 ;; Maybe adjust the closest clock in `org-clock-history'
16410 (when org-clock-adjust-closest
16411 (if (not (and (org-at-clock-log-p)
16412 (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
16413 org-clock-history))))))
16414 (message "No clock to adjust")
16415 (cond ((save-excursion ; fix previous clock?
16416 (re-search-backward org-ts-regexp0 nil t)
16419 ((save-excursion ; fix next clock?
16420 (re-search-backward org-ts-regexp0 nil t)
16423 (save-window-excursion
16424 ;; Find closest clock to point, adjust the previous/next one in history
16425 (let* ((p (save-excursion (org-back-to-heading t)))
16426 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
16427 (clfixnth
16428 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
16429 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
16430 (if (not clfixpos)
16431 (message "No clock to adjust")
16432 (save-excursion
16433 (org-goto-marker-or-bmk clfixpos)
16434 (org-show-subtree)
16435 (when (re-search-forward clrgx nil t)
16436 (goto-char (match-beginning 1))
16437 (let (org-clock-adjust-closest)
16438 (org-timestamp-change n org-ts-what updown))
16439 (message "Clock adjusted in %s for heading: %s"
16440 (file-name-nondirectory (buffer-file-name))
16441 (org-get-heading t t)))))))))
16442 ;; Try to recenter the calendar window, if any.
16443 (if (and org-calendar-follow-timestamp-change
16444 (get-buffer-window "*Calendar*" t)
16445 (memq org-ts-what '(day month year)))
16446 (org-recenter-calendar (time-to-days time))))))
16448 (defun org-modify-ts-extra (s pos n dm)
16449 "Change the different parts of the lead-time and repeat fields in timestamp."
16450 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16451 ng h m new rem)
16452 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16453 (cond
16454 ((or (org-pos-in-match-range pos 2)
16455 (org-pos-in-match-range pos 3))
16456 (setq m (string-to-number (match-string 3 s))
16457 h (string-to-number (match-string 2 s)))
16458 (if (org-pos-in-match-range pos 2)
16459 (setq h (+ h n))
16460 (setq n (* dm (org-no-warnings (signum n))))
16461 (when (not (= 0 (setq rem (% m dm))))
16462 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16463 (setq m (+ m n)))
16464 (if (< m 0) (setq m (+ m 60) h (1- h)))
16465 (if (> m 59) (setq m (- m 60) h (1+ h)))
16466 (setq h (min 24 (max 0 h)))
16467 (setq ng 1 new (format "-%02d:%02d" h m)))
16468 ((org-pos-in-match-range pos 6)
16469 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16470 ((org-pos-in-match-range pos 5)
16471 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16473 ((org-pos-in-match-range pos 9)
16474 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16475 ((org-pos-in-match-range pos 8)
16476 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16478 (when ng
16479 (setq s (concat
16480 (substring s 0 (match-beginning ng))
16481 new
16482 (substring s (match-end ng))))))
16483 s))
16485 (defun org-recenter-calendar (date)
16486 "If the calendar is visible, recenter it to DATE."
16487 (let ((cwin (get-buffer-window "*Calendar*" t)))
16488 (when cwin
16489 (let ((calendar-move-hook nil))
16490 (with-selected-window cwin
16491 (calendar-goto-date (if (listp date) date
16492 (calendar-gregorian-from-absolute date))))))))
16494 (defun org-goto-calendar (&optional arg)
16495 "Go to the Emacs calendar at the current date.
16496 If there is a time stamp in the current line, go to that date.
16497 A prefix ARG can be used to force the current date."
16498 (interactive "P")
16499 (let ((tsr org-ts-regexp) diff
16500 (calendar-move-hook nil)
16501 (calendar-view-holidays-initially-flag nil)
16502 (calendar-view-diary-initially-flag nil))
16503 (if (or (org-at-timestamp-p)
16504 (save-excursion
16505 (beginning-of-line 1)
16506 (looking-at (concat ".*" tsr))))
16507 (let ((d1 (time-to-days (current-time)))
16508 (d2 (time-to-days
16509 (org-time-string-to-time (match-string 1)))))
16510 (setq diff (- d2 d1))))
16511 (calendar)
16512 (calendar-goto-today)
16513 (if (and diff (not arg)) (calendar-forward-day diff))))
16515 (defun org-get-date-from-calendar ()
16516 "Return a list (month day year) of date at point in calendar."
16517 (with-current-buffer "*Calendar*"
16518 (save-match-data
16519 (calendar-cursor-to-date))))
16521 (defun org-date-from-calendar ()
16522 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16523 If there is already a time stamp at the cursor position, update it."
16524 (interactive)
16525 (if (org-at-timestamp-p t)
16526 (org-timestamp-change 0 'calendar)
16527 (let ((cal-date (org-get-date-from-calendar)))
16528 (org-insert-time-stamp
16529 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16531 (defun org-minutes-to-hh:mm-string (m)
16532 "Compute H:MM from a number of minutes."
16533 (let ((h (/ m 60)))
16534 (setq m (- m (* 60 h)))
16535 (format org-time-clocksum-format h m)))
16537 (defun org-hh:mm-string-to-minutes (s)
16538 "Convert a string H:MM to a number of minutes.
16539 If the string is just a number, interpret it as minutes.
16540 In fact, the first hh:mm or number in the string will be taken,
16541 there can be extra stuff in the string.
16542 If no number is found, the return value is 0."
16543 (cond
16544 ((integerp s) s)
16546 (+ (* (string-to-number (match-string 1 s)) 60)
16547 (string-to-number (match-string 2 s))))
16549 (string-to-number (match-string 1 s)))
16550 (t 0)))
16552 (defcustom org-effort-durations
16553 `(("h" . 60)
16554 ("d" . ,(* 60 8))
16555 ("w" . ,(* 60 8 5))
16556 ("m" . ,(* 60 8 5 4))
16557 ("y" . ,(* 60 8 5 40)))
16558 "Conversion factor to minutes for an effort modifier.
16560 Each entry has the form (MODIFIER . MINUTES).
16562 In an effort string, a number followed by MODIFIER is multiplied
16563 by the specified number of MINUTES to obtain an effort in
16564 minutes.
16568 :group 'org-agenda
16569 :version "24.1"
16570 :type '(alist :key-type (string :tag "Modifier")
16571 :value-type (number :tag "Minutes")))
16573 (defun org-duration-string-to-minutes (s &optional output-to-string)
16574 "Convert a duration string S to minutes.
16576 A bare number is interpreted as minutes, modifiers can be set by
16577 customizing `org-effort-durations' (which see).
16579 Entries containing a colon are interpreted as H:MM by
16580 `org-hh:mm-string-to-minutes'."
16581 (let ((result 0)
16583 (regexp-opt (mapcar 'car org-effort-durations))
16585 (while (string-match re s)
16586 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16587 (string-to-number (match-string 1 s))))
16588 (setq s (replace-match "" nil t s)))
16589 (setq result (floor result))
16590 (incf result (org-hh:mm-string-to-minutes s))
16591 (if output-to-string (number-to-string result) result)))
16593 ;;;; Files
16595 (defun org-save-all-org-buffers ()
16596 "Save all Org-mode buffers without user confirmation."
16597 (interactive)
16598 (message "Saving all Org-mode buffers...")
16599 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
16600 (when (featurep 'org-id) (org-id-locations-save))
16601 (message "Saving all Org-mode buffers... done"))
16603 (defun org-revert-all-org-buffers ()
16604 "Revert all Org-mode buffers.
16605 Prompt for confirmation when there are unsaved changes.
16606 Be sure you know what you are doing before letting this function
16607 overwrite your changes.
16609 This function is useful in a setup where one tracks org files
16610 with a version control system, to revert on one machine after pulling
16611 changes from another. I believe the procedure must be like this:
16613 1. M-x org-save-all-org-buffers
16614 2. Pull changes from the other machine, resolve conflicts
16615 3. M-x org-revert-all-org-buffers"
16616 (interactive)
16617 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16618 (error "Abort"))
16619 (save-excursion
16620 (save-window-excursion
16621 (mapc
16622 (lambda (b)
16623 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
16624 (with-current-buffer b buffer-file-name))
16625 (org-pop-to-buffer-same-window b)
16626 (revert-buffer t 'no-confirm)))
16627 (buffer-list))
16628 (when (and (featurep 'org-id) org-id-track-globally)
16629 (org-id-locations-load)))))
16631 ;;;; Agenda files
16633 ;;;###autoload
16634 (defun org-switchb (&optional arg)
16635 "Switch between Org buffers.
16636 With one prefix argument, restrict available buffers to files.
16637 With two prefix arguments, restrict available buffers to agenda files.
16639 Defaults to `iswitchb' for buffer name completion.
16640 Set `org-completion-use-ido' to make it use ido instead."
16641 (interactive "P")
16642 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16643 ((equal arg '(16)) (org-buffer-list 'agenda))
16644 (t (org-buffer-list))))
16645 (org-completion-use-iswitchb org-completion-use-iswitchb)
16646 (org-completion-use-ido org-completion-use-ido))
16647 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16648 (setq org-completion-use-iswitchb t))
16649 (org-pop-to-buffer-same-window
16650 (org-icompleting-read "Org buffer: "
16651 (mapcar 'list (mapcar 'buffer-name blist))
16652 nil t))))
16654 ;;; Define some older names previously used for this functionality
16655 ;;;###autoload
16656 (defalias 'org-ido-switchb 'org-switchb)
16657 ;;;###autoload
16658 (defalias 'org-iswitchb 'org-switchb)
16660 (defun org-buffer-list (&optional predicate exclude-tmp)
16661 "Return a list of Org buffers.
16662 PREDICATE can be `export', `files' or `agenda'.
16664 export restrict the list to Export buffers.
16665 files restrict the list to buffers visiting Org files.
16666 agenda restrict the list to buffers visiting agenda files.
16668 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16669 (let* ((bfn nil)
16670 (agenda-files (and (eq predicate 'agenda)
16671 (mapcar 'file-truename (org-agenda-files t))))
16672 (filter
16673 (cond
16674 ((eq predicate 'files)
16675 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
16676 ((eq predicate 'export)
16677 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16678 ((eq predicate 'agenda)
16679 (lambda (b)
16680 (with-current-buffer b
16681 (and (derived-mode-p 'org-mode)
16682 (setq bfn (buffer-file-name b))
16683 (member (file-truename bfn) agenda-files)))))
16684 (t (lambda (b) (with-current-buffer b
16685 (or (derived-mode-p 'org-mode)
16686 (string-match "\*Org .*Export"
16687 (buffer-name b)))))))))
16688 (delq nil
16689 (mapcar
16690 (lambda(b)
16691 (if (and (funcall filter b)
16692 (or (not exclude-tmp)
16693 (not (string-match "tmp" (buffer-name b)))))
16694 b
16695 nil))
16696 (buffer-list)))))
16698 (defun org-agenda-files (&optional unrestricted archives)
16699 "Get the list of agenda files.
16700 Optional UNRESTRICTED means return the full list even if a restriction
16701 is currently in place.
16702 When ARCHIVES is t, include all archive files that are really being
16703 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16704 `org-agenda-archives-mode' is t."
16705 (let ((files
16706 (cond
16707 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16708 ((stringp org-agenda-files) (org-read-agenda-file-list))
16709 ((listp org-agenda-files) org-agenda-files)
16710 (t (error "Invalid value of `org-agenda-files'")))))
16711 (setq files (apply 'append
16712 (mapcar (lambda (f)
16713 (if (file-directory-p f)
16714 (directory-files
16715 f t org-agenda-file-regexp)
16716 (list f)))
16717 files)))
16718 (when org-agenda-skip-unavailable-files
16719 (setq files (delq nil
16720 (mapcar (function
16721 (lambda (file)
16722 (and (file-readable-p file) file)))
16723 files))))
16724 (when (or (eq archives t)
16725 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16726 (setq files (org-add-archive-files files)))
16727 files))
16729 (defun org-agenda-file-p (&optional file)
16730 "Return non-nil, if FILE is an agenda file.
16731 If FILE is omitted, use the file associated with the current
16732 buffer."
16733 (member (or file (buffer-file-name))
16734 (org-agenda-files t)))
16736 (defun org-edit-agenda-file-list ()
16737 "Edit the list of agenda files.
16738 Depending on setup, this either uses customize to edit the variable
16739 `org-agenda-files', or it visits the file that is holding the list. In the
16740 latter case, the buffer is set up in a way that saving it automatically kills
16741 the buffer and restores the previous window configuration."
16742 (interactive)
16743 (if (stringp org-agenda-files)
16744 (let ((cw (current-window-configuration)))
16745 (find-file org-agenda-files)
16746 (org-set-local 'org-window-configuration cw)
16747 (org-add-hook 'after-save-hook
16748 (lambda ()
16749 (set-window-configuration
16750 (prog1 org-window-configuration
16751 (kill-buffer (current-buffer))))
16752 (org-install-agenda-files-menu)
16753 (message "New agenda file list installed"))
16754 nil 'local)
16755 (message "%s" (substitute-command-keys
16757 (customize-variable 'org-agenda-files)))
16759 (defun org-store-new-agenda-file-list (list)
16760 "Set new value for the agenda file list and save it correctly."
16761 (if (stringp org-agenda-files)
16762 (let ((fe (org-read-agenda-file-list t)) b u)
16763 (while (setq b (find-buffer-visiting org-agenda-files))
16764 (kill-buffer b))
16765 (with-temp-file org-agenda-files
16766 (insert
16767 (mapconcat
16768 (lambda (f) ;; Keep un-expanded entries.
16769 (if (setq u (assoc f fe))
16770 (cdr u)
16771 f))
16774 (let ((org-mode-hook nil) (org-inhibit-startup t)
16775 (org-insert-mode-line-in-empty-file nil))
16776 (setq org-agenda-files list)
16777 (customize-save-variable 'org-agenda-files org-agenda-files))))
16779 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16780 "Read the list of agenda files from a file.
16781 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16782 filenames, used by `org-store-new-agenda-file-list' to write back
16783 un-expanded file names."
16784 (when (file-directory-p org-agenda-files)
16785 (error "`org-agenda-files' cannot be a single directory"))
16786 (when (stringp org-agenda-files)
16787 (with-temp-buffer
16788 (insert-file-contents org-agenda-files)
16789 (mapcar
16790 (lambda (f)
16791 (let ((e (expand-file-name (substitute-in-file-name f)
16792 org-directory)))
16793 (if pair-with-expansion
16794 (cons e f)
16795 e)))
16798 ;;;###autoload
16799 (defun org-cycle-agenda-files ()
16800 "Cycle through the files in `org-agenda-files'.
16801 If the current buffer visits an agenda file, find the next one in the list.
16802 If the current buffer does not, find the first agenda file."
16803 (interactive)
16804 (let* ((fs (org-agenda-files t))
16805 (files (append fs (list (car fs))))
16806 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16807 file)
16808 (unless files (error "No agenda files"))
16809 (catch 'exit
16810 (while (setq file (pop files))
16811 (if (equal (file-truename file) tcf)
16812 (when (car files)
16813 (find-file (car files))
16814 (throw 'exit t))))
16815 (find-file (car fs)))
16816 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16818 (defun org-agenda-file-to-front (&optional to-end)
16819 "Move/add the current file to the top of the agenda file list.
16820 If the file is not present in the list, it is added to the front. If it is
16821 present, it is moved there. With optional argument TO-END, add/move to the
16822 end of the list."
16823 (interactive "P")
16824 (let ((org-agenda-skip-unavailable-files nil)
16825 (file-alist (mapcar (lambda (x)
16826 (cons (file-truename x) x))
16827 (org-agenda-files t)))
16828 (ctf (file-truename buffer-file-name))
16829 x had)
16830 (setq x (assoc ctf file-alist) had x)
16832 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16833 (if to-end
16834 (setq file-alist (append (delq x file-alist) (list x)))
16835 (setq file-alist (cons x (delq x file-alist))))
16836 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16837 (org-install-agenda-files-menu)
16838 (message "File %s to %s of agenda file list"
16839 (if had "moved" "added") (if to-end "end" "front"))))
16841 (defun org-remove-file (&optional file)
16842 "Remove current file from the list of files in variable `org-agenda-files'.
16843 These are the files which are being checked for agenda entries.
16844 Optional argument FILE means use this file instead of the current."
16845 (interactive)
16846 (let* ((org-agenda-skip-unavailable-files nil)
16847 (file (or file buffer-file-name))
16848 (true-file (file-truename file))
16849 (afile (abbreviate-file-name file))
16850 (files (delq nil (mapcar
16851 (lambda (x)
16852 (if (equal true-file
16853 (file-truename x))
16854 nil x))
16855 (org-agenda-files t)))))
16856 (if (not (= (length files) (length (org-agenda-files t))))
16857 (progn
16858 (org-store-new-agenda-file-list files)
16859 (org-install-agenda-files-menu)
16860 (message "Removed file: %s" afile))
16861 (message "File was not in list: %s (not removed)" afile))))
16863 (defun org-file-menu-entry (file)
16864 (vector file (list 'find-file file) t))
16866 (defun org-check-agenda-file (file)
16867 "Make sure FILE exists. If not, ask user what to do."
16868 (when (not (file-exists-p file))
16869 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16870 (abbreviate-file-name file))
16871 (let ((r (downcase (read-char-exclusive))))
16872 (cond
16873 ((equal r ?r)
16874 (org-remove-file file)
16875 (throw 'nextfile t))
16876 (t (error "Abort"))))))
16878 (defun org-get-agenda-file-buffer (file)
16879 "Get a buffer visiting FILE. If the buffer needs to be created, add
16880 it to the list of buffers which might be released later."
16881 (let ((buf (org-find-base-buffer-visiting file)))
16882 (if buf
16883 buf ; just return it
16884 ;; Make a new buffer and remember it
16885 (setq buf (find-file-noselect file))
16886 (if buf (push buf org-agenda-new-buffers))
16887 buf)))
16889 (defun org-release-buffers (blist)
16890 "Release all buffers in list, asking the user for confirmation when needed.
16891 When a buffer is unmodified, it is just killed. When modified, it is saved
16892 \(if the user agrees) and then killed."
16893 (let (buf file)
16894 (while (setq buf (pop blist))
16895 (setq file (buffer-file-name buf))
16896 (when (and (buffer-modified-p buf)
16897 file
16898 (y-or-n-p (format "Save file %s? " file)))
16899 (with-current-buffer buf (save-buffer)))
16900 (kill-buffer buf))))
16902 (defun org-agenda-prepare-buffers (files)
16903 "Create buffers for all agenda files, protect archived trees and comments."
16904 (interactive)
16905 (let ((pa '(:org-archived t))
16906 (pc '(:org-comment t))
16907 (pall '(:org-archived t :org-comment t))
16908 (inhibit-read-only t)
16909 (rea (concat ":" org-archive-tag ":"))
16910 bmp file re)
16911 (save-excursion
16912 (save-restriction
16913 (while (setq file (pop files))
16914 (catch 'nextfile
16915 (if (bufferp file)
16916 (set-buffer file)
16917 (org-check-agenda-file file)
16918 (set-buffer (org-get-agenda-file-buffer file)))
16919 (widen)
16920 (setq bmp (buffer-modified-p))
16921 (org-refresh-category-properties)
16922 (setq org-todo-keywords-for-agenda
16923 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16924 (setq org-done-keywords-for-agenda
16925 (append org-done-keywords-for-agenda org-done-keywords))
16926 (setq org-todo-keyword-alist-for-agenda
16927 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16928 (setq org-drawers-for-agenda
16929 (append org-drawers-for-agenda org-drawers))
16930 (setq org-tag-alist-for-agenda
16931 (append org-tag-alist-for-agenda org-tag-alist))
16933 (save-excursion
16934 (remove-text-properties (point-min) (point-max) pall)
16935 (when org-agenda-skip-archived-trees
16936 (goto-char (point-min))
16937 (while (re-search-forward rea nil t)
16938 (if (org-at-heading-p t)
16939 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16940 (goto-char (point-min))
16941 (setq re (format org-heading-keyword-regexp-format
16942 org-comment-string))
16943 (while (re-search-forward re nil t)
16944 (add-text-properties
16945 (match-beginning 0) (org-end-of-subtree t) pc)))
16946 (set-buffer-modified-p bmp)))))
16947 (setq org-todo-keywords-for-agenda
16948 (org-uniquify org-todo-keywords-for-agenda))
16949 (setq org-todo-keyword-alist-for-agenda
16950 (org-uniquify org-todo-keyword-alist-for-agenda)
16951 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16953 ;;;; Embedded LaTeX
16955 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16956 "Keymap for the minor `org-cdlatex-mode'.")
16958 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16959 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16960 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16961 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16962 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16964 (defvar org-cdlatex-texmathp-advice-is-done nil
16965 "Flag remembering if we have applied the advice to texmathp already.")
16967 (define-minor-mode org-cdlatex-mode
16968 "Toggle the minor `org-cdlatex-mode'.
16969 This mode supports entering LaTeX environment and math in LaTeX fragments
16970 in Org-mode.
16972 nil " OCDL" nil
16973 (when org-cdlatex-mode
16974 (require 'cdlatex)
16975 (run-hooks 'cdlatex-mode-hook)
16976 (cdlatex-compute-tables))
16977 (unless org-cdlatex-texmathp-advice-is-done
16978 (setq org-cdlatex-texmathp-advice-is-done t)
16979 (defadvice texmathp (around org-math-always-on activate)
16980 "Always return t in org-mode buffers.
16981 This is because we want to insert math symbols without dollars even outside
16982 the LaTeX math segments. If Orgmode thinks that point is actually inside
16983 an embedded LaTeX fragment, let texmathp do its job.
16985 (interactive)
16986 (let (p)
16987 (cond
16988 ((not (derived-mode-p 'org-mode)) ad-do-it)
16989 ((eq this-command 'cdlatex-math-symbol)
16990 (setq ad-return-value t
16991 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16992 (t
16993 (let ((p (org-inside-LaTeX-fragment-p)))
16994 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16995 (setq ad-return-value t
16996 texmathp-why '("Org-mode embedded math" . 0))
16997 (if p ad-do-it)))))))))
16999 (defun turn-on-org-cdlatex ()
17000 "Unconditionally turn on `org-cdlatex-mode'."
17001 (org-cdlatex-mode 1))
17003 (defun org-inside-LaTeX-fragment-p ()
17004 "Test if point is inside a LaTeX fragment.
17006 sequence appearing also before point.
17007 Even though the matchers for math are configurable, this function assumes
17009 delimiters are skipped when they have been removed by customization.
17010 The return value is nil, or a cons cell with the delimiter and the
17011 position of this delimiter.
17013 This function does a reasonably good job, but can locally be fooled by
17014 for example currency specifications. For example it will assume being in
17016 fragments that are properly closed, but during editing, we have to live
17017 with the uncertainty caused by missing closing delimiters. This function
17018 looks only before point, not after."
17019 (catch 'exit
17020 (let ((pos (point))
17021 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
17022 (lim (progn
17024 (point)))
17025 dd-on str (start 0) m re)
17026 (goto-char pos)
17027 (when dodollar
17029 re (nth 1 (assoc "$" org-latex-regexps)))
17030 (while (string-match re str start)
17031 (cond
17032 ((= (match-end 0) (length str))
17033 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
17034 ((= (match-end 0) (- (length str) 5))
17035 (throw 'exit nil))
17036 (t (setq start (match-end 0))))))
17037 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17038 (goto-char pos)
17039 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
17040 (and (match-beginning 2) (throw 'exit nil))
17041 ;; count $$
17043 (setq dd-on (not dd-on)))
17044 (goto-char pos)
17045 (if dd-on (cons "$$" m))))))
17047 (defun org-inside-latex-macro-p ()
17048 "Is point inside a LaTeX macro or its arguments?"
17049 (save-match-data
17050 (org-in-regexp
17053 (defun org-try-cdlatex-tab ()
17054 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17055 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17056 - inside a LaTeX fragment, or
17057 - after the first word in a line, where an abbreviation expansion could
17058 insert a LaTeX environment."
17059 (when org-cdlatex-mode
17060 (cond
17061 ;; Before any word on the line: No expansion possible.
17063 ;; Just after first word on the line: Expand it. Make sure it
17064 ;; cannot happen on headlines, though.
17065 ((save-excursion
17066 (skip-chars-backward "a-zA-Z0-9*")
17068 (and (bolp) (not (org-at-heading-p))))
17069 (cdlatex-tab) t)
17070 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
17072 (defun org-cdlatex-underscore-caret (&optional arg)
17073 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17074 Revert to the normal definition outside of these fragments."
17075 (interactive "P")
17076 (if (org-inside-LaTeX-fragment-p)
17077 (call-interactively 'cdlatex-sub-superscript)
17078 (let (org-cdlatex-mode)
17079 (call-interactively (key-binding (vector last-input-event))))))
17081 (defun org-cdlatex-math-modify (&optional arg)
17082 "Execute `cdlatex-math-modify' in LaTeX fragments.
17083 Revert to the normal definition outside of these fragments."
17084 (interactive "P")
17085 (if (org-inside-LaTeX-fragment-p)
17086 (call-interactively 'cdlatex-math-modify)
17087 (let (org-cdlatex-mode)
17088 (call-interactively (key-binding (vector last-input-event))))))
17090 (defvar org-latex-fragment-image-overlays nil
17091 "List of overlays carrying the images of latex fragments.")
17092 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
17094 (defun org-remove-latex-fragment-image-overlays ()
17095 "Remove all overlays with LaTeX fragment images in current buffer."
17096 (mapc 'delete-overlay org-latex-fragment-image-overlays)
17097 (setq org-latex-fragment-image-overlays nil))
17099 (defun org-preview-latex-fragment (&optional subtree)
17100 "Preview the LaTeX fragment at point, or all locally or globally.
17101 If the cursor is in a LaTeX fragment, create the image and overlay
17102 it over the source code. If there is no fragment at point, display
17103 all fragments in the current text, from one headline to the next. With
17104 prefix SUBTREE, display all fragments in the current subtree. With a
17106 the cursor is before the first headline,
17107 display all fragments in the buffer.
17109 (interactive "P")
17110 (unless buffer-file-name
17111 (error "Can't preview LaTeX fragment in a non-file buffer"))
17112 (org-remove-latex-fragment-image-overlays)
17113 (save-excursion
17114 (save-restriction
17115 (let (beg end at msg)
17116 (cond
17117 ((or (equal subtree '(16))
17118 (not (save-excursion
17119 (re-search-backward org-outline-regexp-bol nil t))))
17120 (setq beg (point-min) end (point-max)
17121 msg "Creating images for buffer...%s"))
17122 ((equal subtree '(4))
17123 (org-back-to-heading)
17124 (setq beg (point) end (org-end-of-subtree t)
17125 msg "Creating images for subtree...%s"))
17126 (t
17127 (if (setq at (org-inside-LaTeX-fragment-p))
17128 (goto-char (max (point-min) (- (cdr at) 2)))
17129 (org-back-to-heading))
17130 (setq beg (point) end (progn (outline-next-heading) (point))
17131 msg (if at "Creating image...%s"
17132 "Creating images for entry...%s"))))
17133 (message msg "")
17134 (narrow-to-region beg end)
17135 (goto-char beg)
17136 (org-format-latex
17137 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
17138 (file-name-nondirectory
17139 buffer-file-name)))
17140 default-directory 'overlays msg at 'forbuffer
17141 org-latex-create-formula-image-program)
17142 (message msg "done. Use `C-c C-c' to remove images.")))))
17144 (defvar org-latex-regexps
17146 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17149 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
17153 "Regular expressions for matching embedded LaTeX.")
17155 (defvar org-export-have-math nil) ;; dynamic scoping
17156 (defun org-format-latex (prefix &optional dir overlays msg at
17157 forbuffer processing-type)
17158 "Replace LaTeX fragments with links to an image, and produce images.
17159 Some of the options can be changed using the variable
17160 `org-format-latex-options'."
17161 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
17162 (let* ((prefixnodir (file-name-nondirectory prefix))
17163 (absprefix (expand-file-name prefix dir))
17164 (todir (file-name-directory absprefix))
17165 (opt org-format-latex-options)
17166 (matchers (plist-get opt :matchers))
17167 (re-list org-latex-regexps)
17168 (org-format-latex-header-extra
17169 (plist-get (org-infile-export-plist) :latex-header-extra))
17170 (cnt 0) txt hash link beg end re e checkdir
17171 executables-checked string
17172 m n block-type block linkfile movefile ov)
17173 ;; Check the different regular expressions
17174 (while (setq e (pop re-list))
17175 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
17177 (when (member m matchers)
17178 (goto-char (point-min))
17179 (while (re-search-forward re nil t)
17180 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
17181 (not (get-text-property (match-beginning n)
17182 'org-protected))
17183 (or (not overlays)
17184 (not (eq (get-char-property (match-beginning n)
17185 'org-overlay-type)
17186 'org-latex-overlay))))
17187 (setq org-export-have-math t)
17188 (cond
17189 ((eq processing-type 'verbatim)
17190 ;; Leave the text verbatim, just protect it
17191 (add-text-properties (match-beginning n) (match-end n)
17192 '(org-protected t)))
17193 ((eq processing-type 'mathjax)
17194 ;; Prepare for MathJax processing
17195 (setq string (match-string n))
17196 (if (member m '("$" "$1"))
17197 (save-excursion
17198 (delete-region (match-beginning n) (match-end n))
17199 (goto-char (match-beginning n))
17202 '(org-protected t))))
17203 (add-text-properties (match-beginning n) (match-end n)
17204 '(org-protected t))))
17205 ((or (eq processing-type 'dvipng)
17206 (eq processing-type 'imagemagick))
17207 ;; Process to an image
17208 (setq txt (match-string n)
17209 beg (match-beginning n) end (match-end n)
17210 cnt (1+ cnt))
17211 (let (print-length print-level) ; make sure full list is printed
17212 (setq hash (sha1 (prin1-to-string
17213 (list org-format-latex-header
17214 org-format-latex-header-extra
17215 org-export-latex-default-packages-alist
17216 org-export-latex-packages-alist
17217 org-format-latex-options
17218 forbuffer txt)))
17219 linkfile (format "%s_%s.png" prefix hash)
17220 movefile (format "%s_%s.png" absprefix hash)))
17221 (setq link (concat block "[[file:" linkfile "]]" block))
17222 (if msg (message msg cnt))
17223 (goto-char beg)
17224 (unless checkdir ; make sure the directory exists
17225 (setq checkdir t)
17226 (or (file-directory-p todir) (make-directory todir t)))
17227 (cond
17228 ((eq processing-type 'dvipng)
17229 (unless executables-checked
17230 (org-check-external-command
17231 "latex" "needed to convert LaTeX fragments to images")
17232 (org-check-external-command
17233 "dvipng" "needed to convert LaTeX fragments to images")
17234 (setq executables-checked t))
17235 (unless (file-exists-p movefile)
17236 (org-create-formula-image-with-dvipng
17237 txt movefile opt forbuffer)))
17238 ((eq processing-type 'imagemagick)
17239 (unless executables-checked
17240 (org-check-external-command
17241 "convert" "you need to install imagemagick")
17242 (setq executables-checked t))
17243 (unless (file-exists-p movefile)
17244 (org-create-formula-image-with-imagemagick
17245 txt movefile opt forbuffer))))
17246 (if overlays
17247 (progn
17248 (mapc (lambda (o)
17249 (if (eq (overlay-get o 'org-overlay-type)
17250 'org-latex-overlay)
17251 (delete-overlay o)))
17252 (overlays-in beg end))
17253 (setq ov (make-overlay beg end))
17254 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17255 (if (featurep 'xemacs)
17256 (progn
17257 (overlay-put ov 'invisible t)
17258 (overlay-put
17259 ov 'end-glyph
17260 (make-glyph (vector 'png :file movefile))))
17261 (overlay-put
17262 ov 'display
17263 (list 'image :type 'png :file movefile :ascent 'center)))
17264 (push ov org-latex-fragment-image-overlays)
17265 (goto-char end))
17266 (delete-region beg end)
17267 (insert (org-add-props link
17268 (list 'org-latex-src
17269 (replace-regexp-in-string
17271 'org-latex-src-embed-type
17272 (if block-type 'paragraph 'character))))))
17273 ((eq processing-type 'mathml)
17274 ;; Process to MathML
17275 (unless executables-checked
17276 (unless (save-match-data (org-format-latex-mathml-available-p))
17277 (error "LaTeX to MathML converter not configured"))
17278 (setq executables-checked t))
17279 (setq txt (match-string n)
17280 beg (match-beginning n) end (match-end n)
17281 cnt (1+ cnt))
17282 (if msg (message msg cnt))
17283 (goto-char beg)
17284 (delete-region beg end)
17285 (insert (org-format-latex-as-mathml
17286 txt block-type prefix dir)))
17287 (t
17288 (error "Unknown conversion type %s for latex fragments"
17289 processing-type)))))))))
17291 (defun org-create-math-formula (latex-frag &optional mathml-file)
17292 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17293 Use `org-latex-to-mathml-convert-command'. If the conversion is
17295 elements otherwise return nil. When MATHML-FILE is specified,
17296 write the results in to that file. When invoked as an
17297 interactive command, prompt for LATEX-FRAG, with initial value
17298 set to the current active region and echo the results for user
17299 inspection."
17300 (interactive (list (let ((frag (when (org-region-active-p)
17301 (buffer-substring-no-properties
17302 (region-beginning) (region-end)))))
17303 (read-string "LaTeX Fragment: " frag nil frag))))
17304 (unless latex-frag (error "Invalid latex-frag"))
17305 (let* ((tmp-in-file (file-relative-name
17306 (make-temp-name (expand-file-name "ltxmathml-in"))))
17307 (ignore (write-region latex-frag nil tmp-in-file))
17308 (tmp-out-file (file-relative-name
17309 (make-temp-name (expand-file-name "ltxmathml-out"))))
17310 (cmd (format-spec
17311 org-latex-to-mathml-convert-command
17312 `((?j . ,(shell-quote-argument
17313 (expand-file-name org-latex-to-mathml-jar-file)))
17314 (?I . ,(shell-quote-argument tmp-in-file))
17315 (?o . ,(shell-quote-argument tmp-out-file)))))
17316 mathml shell-command-output)
17317 (when (org-called-interactively-p 'any)
17318 (unless (org-format-latex-mathml-available-p)
17319 (error "LaTeX to MathML converter not configured")))
17320 (message "Running %s" cmd)
17321 (setq shell-command-output (shell-command-to-string cmd))
17322 (setq mathml
17323 (when (file-readable-p tmp-out-file)
17324 (with-current-buffer (find-file-noselect tmp-out-file t)
17325 (goto-char (point-min))
17326 (when (re-search-forward
17327 (concat
17328 (regexp-quote
17331 (regexp-quote "</math>")) nil t)
17332 (prog1 (match-string 0) (kill-buffer))))))
17333 (cond
17334 (mathml
17335 (setq mathml
17337 (when mathml-file
17338 (write-region mathml nil mathml-file))
17339 (when (org-called-interactively-p 'any)
17340 (message mathml)))
17341 ((message "LaTeX to MathML conversion failed")
17342 (message shell-command-output)))
17343 (delete-file tmp-in-file)
17344 (when (file-exists-p tmp-out-file)
17345 (delete-file tmp-out-file))
17346 mathml))
17348 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17349 prefix &optional dir)
17350 "Use `org-create-math-formula' but check local cache first."
17351 (let* ((absprefix (expand-file-name prefix dir))
17352 (print-length nil) (print-level nil)
17353 (formula-id (concat
17354 "formula-"
17355 (sha1
17356 (prin1-to-string
17357 (list latex-frag
17358 org-latex-to-mathml-convert-command)))))
17359 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17360 (formula-cache-dir (file-name-directory formula-cache)))
17362 (unless (file-directory-p formula-cache-dir)
17363 (make-directory formula-cache-dir t))
17365 (unless (file-exists-p formula-cache)
17366 (org-create-math-formula latex-frag formula-cache))
17368 (if (file-exists-p formula-cache)
17369 ;; Successful conversion. Return the link to MathML file.
17370 (org-add-props
17371 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17373 'org-latex-src-embed-type (if latex-frag-type
17374 'paragraph 'character)))
17375 ;; Failed conversion. Return the LaTeX fragment verbatim
17376 (add-text-properties
17377 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17378 latex-frag)))
17380 ;; This function borrows from Ganesh Swami's latex2png.el
17381 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
17382 "This calls dvipng."
17383 (require 'org-latex)
17384 (let* ((tmpdir (if (featurep 'xemacs)
17385 (temp-directory)
17386 temporary-file-directory))
17387 (texfilebase (make-temp-name
17388 (expand-file-name "orgtex" tmpdir)))
17389 (texfile (concat texfilebase ".tex"))
17390 (dvifile (concat texfilebase ".dvi"))
17391 (pngfile (concat texfilebase ".png"))
17392 (fnh (if (featurep 'xemacs)
17393 (font-height (face-font 'default))
17394 (face-attribute 'default :height nil)))
17395 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17396 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17397 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17398 "Black"))
17399 (bg (or (plist-get options (if buffer :background :html-background))
17400 "Transparent")))
17401 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17402 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17403 (with-temp-file texfile
17404 (insert (org-splice-latex-header
17405 org-format-latex-header
17406 org-export-latex-default-packages-alist
17407 org-export-latex-packages-alist t
17408 org-format-latex-header-extra))
17410 (require 'org-latex)
17411 (org-export-latex-fix-inputenc))
17412 (let ((dir default-directory))
17413 (condition-case nil
17414 (progn
17415 (cd tmpdir)
17416 (call-process "latex" nil nil nil texfile))
17417 (error nil))
17418 (cd dir))
17419 (if (not (file-exists-p dvifile))
17420 (progn (message "Failed to create dvi file from %s" texfile) nil)
17421 (condition-case nil
17422 (if (featurep 'xemacs)
17423 (call-process "dvipng" nil nil nil
17424 "-fg" fg "-bg" bg
17425 "-T" "tight"
17426 "-o" pngfile
17427 dvifile)
17428 (call-process "dvipng" nil nil nil
17429 "-fg" fg "-bg" bg
17430 "-D" dpi
17431 ;;"-x" scale "-y" scale
17432 "-T" "tight"
17433 "-o" pngfile
17434 dvifile))
17435 (error nil))
17436 (if (not (file-exists-p pngfile))
17437 (if org-format-latex-signal-error
17438 (error "Failed to create png file from %s" texfile)
17439 (message "Failed to create png file from %s" texfile)
17440 nil)
17441 ;; Use the requested file name and clean up
17442 (copy-file pngfile tofile 'replace)
17443 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
17444 (if (file-exists-p (concat texfilebase e))
17445 (delete-file (concat texfilebase e))))
17446 pngfile))))
17448 (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
17449 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
17450 "This calls convert, which is included into imagemagick."
17451 (require 'org-latex)
17452 (let* ((tmpdir (if (featurep 'xemacs)
17453 (temp-directory)
17454 temporary-file-directory))
17455 (texfilebase (make-temp-name
17456 (expand-file-name "orgtex" tmpdir)))
17457 (texfile (concat texfilebase ".tex"))
17458 (pdffile (concat texfilebase ".pdf"))
17459 (pngfile (concat texfilebase ".png"))
17460 (fnh (if (featurep 'xemacs)
17461 (font-height (face-font 'default))
17462 (face-attribute 'default :height nil)))
17463 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17464 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17465 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17466 "black"))
17467 (bg (or (plist-get options (if buffer :background :html-background))
17468 "white")))
17469 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
17470 (setq fg (org-latex-color-format fg)))
17471 (if (eq bg 'default) (setq bg (org-latex-color :background))
17472 (setq bg (org-latex-color-format
17473 (if (string= bg "Transparent")(setq bg "white")))))
17474 (with-temp-file texfile
17475 (insert (org-splice-latex-header
17476 org-format-latex-header
17477 org-export-latex-default-packages-alist
17478 org-export-latex-packages-alist t
17479 org-format-latex-header-extra))
17485 string
17488 (require 'org-latex)
17489 (org-export-latex-fix-inputenc))
17490 (let ((dir default-directory) cmd cmds latex-frags-cmds)
17491 (condition-case nil
17492 (progn
17493 (cd tmpdir)
17494 (setq cmds org-latex-to-pdf-process)
17495 (while cmds
17496 (setq latex-frags-cmds (pop cmds))
17497 (if (listp latex-frags-cmds)
17498 (setq cmds nil)
17499 (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
17500 (while latex-frags-cmds
17501 (setq cmd (pop latex-frags-cmds))
17502 (while (string-match "%b" cmd)
17503 (setq cmd (replace-match
17504 (save-match-data
17505 (shell-quote-argument texfile))
17506 t t cmd)))
17507 (while (string-match "%f" cmd)
17508 (setq cmd (replace-match
17509 (save-match-data
17510 (shell-quote-argument (file-name-nondirectory texfile)))
17511 t t cmd)))
17512 (while (string-match "%o" cmd)
17513 (setq cmd (replace-match
17514 (save-match-data
17515 (shell-quote-argument (file-name-directory texfile)))
17516 t t cmd)))
17517 (setq cmd (split-string cmd))
17518 (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
17519 (error nil))
17520 (cd dir))
17521 (if (not (file-exists-p pdffile))
17522 (progn (message "Failed to create pdf file from %s" texfile) nil)
17523 (condition-case nil
17524 (if (featurep 'xemacs)
17525 (call-process "convert" nil nil nil
17526 "-density" "96"
17527 "-trim"
17528 "-antialias"
17529 pdffile
17530 "-quality" "100"
17531 ;; "-sharpen" "0x1.0"
17532 pngfile)
17533 (call-process "convert" nil nil nil
17534 "-density" dpi
17535 "-trim"
17536 "-antialias"
17537 pdffile
17538 "-quality" "100"
17539 ; "-sharpen" "0x1.0"
17540 pngfile))
17541 (error nil))
17542 (if (not (file-exists-p pngfile))
17543 (if org-format-latex-signal-error
17544 (error "Failed to create png file from %s" texfile)
17545 (message "Failed to create png file from %s" texfile)
17546 nil)
17547 ;; Use the requested file name and clean up
17548 (copy-file pngfile tofile 'replace)
17549 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
17550 (if (file-exists-p (concat texfilebase e))
17551 (delete-file (concat texfilebase e))))
17552 pngfile))))
17554 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17555 "Fill a LaTeX header template TPL.
17556 In the template, the following place holders will be recognized:
17559 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17561 [NO-PACKAGES] do not include PKG
17562 [EXTRA] the string EXTRA
17563 [NO-EXTRA] do not include EXTRA
17565 For backward compatibility, if both the positive and the negative place
17567 assumed to be present at the end of the template.
17568 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17569 EXTRA is a string.
17570 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17571 (let (rpl (end ""))
17573 (setq rpl (if (or (match-end 1) (not def-pkg))
17574 "" (org-latex-packages-to-string def-pkg snippets-p t))
17575 tpl (replace-match rpl t t tpl))
17576 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17579 (setq rpl (if (or (match-end 1) (not pkg))
17580 "" (org-latex-packages-to-string pkg snippets-p t))
17581 tpl (replace-match rpl t t tpl))
17582 (if pkg (setq end
17584 (org-latex-packages-to-string pkg snippets-p)))))
17587 (setq rpl (if (or (match-end 1) (not extra))
17589 tpl (replace-match rpl t t tpl))
17595 tpl)))
17597 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17599 (setq pkg (mapconcat (lambda(p)
17600 (cond
17601 ((stringp p) p)
17602 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17603 (format "%% Package %s omitted" (cadr p)))
17604 ((equal "" (car p))
17606 (t
17608 (car p) (cadr p)))))
17609 pkg
17613 (defun org-dvipng-color (attr)
17614 "Return a RGB color specification for dvipng."
17615 (apply 'format "rgb %s %s %s"
17616 (mapcar 'org-normalize-color
17617 (if (featurep 'xemacs)
17618 (color-rgb-components
17619 (face-property 'default
17620 (cond ((eq attr :foreground) 'foreground)
17621 ((eq attr :background) 'background))))
17622 (color-values (face-attribute 'default attr nil))))))
17624 (defun org-latex-color (attr)
17625 "Return a RGB color for the LaTeX color package."
17626 (apply 'format "%s,%s,%s"
17627 (mapcar 'org-normalize-color
17628 (if (featurep 'xemacs)
17629 (color-rgb-components
17630 (face-property 'default
17631 (cond ((eq attr :foreground) 'foreground)
17632 ((eq attr :background) 'background))))
17633 (color-values (face-attribute 'default attr nil))))))
17635 (defun org-latex-color-format (color-name)
17636 "Convert COLOR-NAME to a RGB color value."
17637 (apply 'format "%s,%s,%s"
17638 (mapcar 'org-normalize-color
17639 (color-values color-name))))
17641 (defun org-normalize-color (value)
17642 "Return string to be used as color value for an RGB component."
17643 (format "%g" (/ value 65535.0)))
17645 ;; Image display
17648 (defvar org-inline-image-overlays nil)
17649 (make-variable-buffer-local 'org-inline-image-overlays)
17651 (defun org-toggle-inline-images (&optional include-linked)
17652 "Toggle the display of inline images.
17653 INCLUDE-LINKED is passed to `org-display-inline-images'."
17654 (interactive "P")
17655 (if org-inline-image-overlays
17656 (progn
17657 (org-remove-inline-images)
17658 (message "Inline image display turned off"))
17659 (org-display-inline-images include-linked)
17660 (if org-inline-image-overlays
17661 (message "%d images displayed inline"
17662 (length org-inline-image-overlays))
17663 (message "No images to display inline"))))
17665 (defun org-redisplay-inline-images ()
17666 "Refresh the display of inline images."
17667 (interactive)
17668 (if (not org-inline-image-overlays)
17669 (org-toggle-inline-images)
17670 (org-toggle-inline-images)
17671 (org-toggle-inline-images)))
17673 (defun org-display-inline-images (&optional include-linked refresh beg end)
17674 "Display inline images.
17675 Normally only links without a description part are inlined, because this
17676 is how it will work for export. When INCLUDE-LINKED is set, also links
17677 with a description part will be inlined. This can be nice for a quick
17678 look at those images, but it does not reflect what exported files will look
17679 like.
17680 When REFRESH is set, refresh existing images between BEG and END.
17681 This will create new image displays only if necessary.
17682 BEG and END default to the buffer boundaries."
17683 (interactive "P")
17684 (unless refresh
17685 (org-remove-inline-images)
17686 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17687 (save-excursion
17688 (save-restriction
17689 (widen)
17690 (setq beg (or beg (point-min)) end (or end (point-max)))
17691 (goto-char beg)
17693 (substring (org-image-file-name-regexp) 0 -2)
17695 old file ov img)
17696 (while (re-search-forward re end t)
17697 (setq old (get-char-property-and-overlay (match-beginning 1)
17698 'org-image-overlay))
17699 (setq file (expand-file-name
17700 (concat (or (match-string 3) "") (match-string 4))))
17701 (when (file-exists-p file)
17702 (if (and (car-safe old) refresh)
17703 (image-refresh (overlay-get (cdr old) 'display))
17704 (setq img (save-match-data (create-image file)))
17705 (when img
17706 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17707 (overlay-put ov 'display img)
17708 (overlay-put ov 'face 'default)
17709 (overlay-put ov 'org-image-overlay t)
17710 (overlay-put ov 'modification-hooks
17711 (list 'org-display-inline-remove-overlay))
17712 (push ov org-inline-image-overlays)))))))))
17714 (define-obsolete-function-alias
17715 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
17717 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
17718 "Remove inline-display overlay if a corresponding region is modified."
17719 (let ((inhibit-modification-hooks t))
17720 (when (and ov after)
17721 (delete ov org-inline-image-overlays)
17722 (delete-overlay ov))))
17724 (defun org-remove-inline-images ()
17725 "Remove inline display of images."
17726 (interactive)
17727 (mapc 'delete-overlay org-inline-image-overlays)
17728 (setq org-inline-image-overlays nil))
17730 ;;;; Key bindings
17732 ;; Outline functions from `outline-mode-prefix-map'
17733 ;; that can be remapped in Org:
17734 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17735 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17736 (define-key org-mode-map [remap outline-forward-same-level]
17737 'org-forward-heading-same-level)
17738 (define-key org-mode-map [remap outline-backward-same-level]
17739 'org-backward-heading-same-level)
17740 (define-key org-mode-map [remap show-branches]
17741 'org-kill-note-or-show-branches)
17742 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17743 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17744 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17746 ;; Outline functions from `outline-mode-prefix-map' that can not
17747 ;; be remapped in Org:
17748 ;;
17749 ;; - the column "key binding" shows whether the Outline function is still
17750 ;; available in Org mode on the same key that it has been bound to in
17751 ;; Outline mode:
17752 ;; - "overridden": key used for a different functionality in Org mode
17753 ;; - else: key still bound to the same Outline function in Org mode
17754 ;;
17755 ;; | Outline function | key binding | Org replacement |
17756 ;; |------------------------------------+-------------+-----------------------|
17757 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17758 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17759 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17760 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
17761 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17762 ;; | `show-entry' | overridden | no replacement |
17763 ;; | `show-children' | `C-c C-i' | visibility cycling |
17764 ;; | `show-branches' | `C-c C-k' | still same function |
17765 ;; | `show-subtree' | overridden | visibility cycling |
17766 ;; | `show-all' | overridden | no replacement |
17767 ;; | `hide-subtree' | overridden | visibility cycling |
17768 ;; | `hide-body' | overridden | no replacement |
17769 ;; | `hide-entry' | overridden | visibility cycling |
17770 ;; | `hide-leaves' | overridden | no replacement |
17771 ;; | `hide-sublevels' | overridden | no replacement |
17772 ;; | `hide-other' | overridden | no replacement |
17774 ;; Make `C-c C-x' a prefix key
17775 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17777 ;; TAB key with modifiers
17778 (org-defkey org-mode-map "\C-i" 'org-cycle)
17779 (org-defkey org-mode-map [(tab)] 'org-cycle)
17780 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17782 ;; The following line is necessary under Suse GNU/Linux
17783 (unless (featurep 'xemacs)
17784 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17785 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17786 (define-key org-mode-map [backtab] 'org-shifttab)
17788 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17789 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17790 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17792 ;; Cursor keys with modifiers
17793 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17794 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17795 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17796 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17798 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17799 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17800 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17801 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17803 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17804 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17805 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17806 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17808 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17809 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17810 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17811 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17813 ;; Babel keys
17814 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17815 (mapc (lambda (pair)
17816 (define-key org-babel-map (car pair) (cdr pair)))
17817 org-babel-key-bindings)
17819 ;;; Extra keys for tty access.
17820 ;; We only set them when really needed because otherwise the
17821 ;; menus don't show the simple keys
17823 (when (or org-use-extra-keys
17824 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17825 (not window-system))
17826 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17827 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17828 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17829 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17830 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17831 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17832 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17833 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17834 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17835 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17836 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17837 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17838 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17839 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17840 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17841 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17842 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17843 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17844 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17845 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17846 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17847 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17848 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17849 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17850 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17851 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17852 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17853 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17855 ;; All the other keys
17857 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17858 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17859 (if (boundp 'narrow-map)
17860 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17861 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17862 (if (boundp 'narrow-map)
17863 (org-defkey narrow-map "b" 'org-narrow-to-block)
17864 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17865 (if (boundp 'narrow-map)
17866 (org-defkey narrow-map "e" 'org-narrow-to-element)
17867 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
17868 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
17869 (org-defkey org-mode-map "\M-}" 'org-forward-element)
17870 (org-defkey org-mode-map "\M-{" 'org-backward-element)
17871 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
17872 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
17873 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
17874 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
17875 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17876 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17877 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17878 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17879 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17880 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17881 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17882 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17883 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17884 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17885 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17886 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17887 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17888 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17889 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17891 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17892 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17893 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17894 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17895 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17896 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17897 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17898 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17899 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17900 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
17901 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17902 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17903 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17904 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17905 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17906 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17907 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17908 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17909 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17910 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17911 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17913 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17914 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17915 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17916 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17917 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17918 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17919 (org-defkey org-mode-map "\C-c^" 'org-sort)
17920 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17921 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17922 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17923 (org-defkey org-mode-map "\C-m" 'org-return)
17924 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17925 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17926 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17927 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17928 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17929 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17930 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17931 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17932 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17933 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17934 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17935 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17936 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17937 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17938 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17939 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17940 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17941 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17942 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17943 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17944 (org-defkey org-mode-map "\M-h" 'org-mark-element)
17945 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17946 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17948 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17949 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17950 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17952 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17953 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17954 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
17955 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
17956 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17957 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17958 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
17959 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17960 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17961 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17962 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17963 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17964 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
17966 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17967 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17968 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17969 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
17970 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17971 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17972 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17973 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17975 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17976 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17977 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17978 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17979 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17981 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17983 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17985 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17986 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17988 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17991 (when (featurep 'xemacs)
17992 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17995 (defconst org-speed-commands-default
17996 '(
17997 ("Outline Navigation")
17998 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17999 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
18000 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
18001 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
18002 ("u" . (org-speed-move-safe 'outline-up-heading))
18003 ("j" . org-goto)
18004 ("g" . (org-refile t))
18005 ("Outline Visibility")
18006 ("c" . org-cycle)
18007 ("C" . org-shifttab)
18008 (" " . org-display-outline-path)
18009 (":" . org-columns)
18010 ("Outline Structure Editing")
18011 ("U" . org-shiftmetaup)
18012 ("D" . org-shiftmetadown)
18013 ("r" . org-metaright)
18014 ("l" . org-metaleft)
18015 ("R" . org-shiftmetaright)
18016 ("L" . org-shiftmetaleft)
18017 ("i" . (progn (forward-char 1) (call-interactively
18018 'org-insert-heading-respect-content)))
18019 ("^" . org-sort)
18020 ("w" . org-refile)
18021 ("a" . org-archive-subtree-default-with-confirmation)
18022 ("." . org-mark-subtree)
18023 ("#" . org-toggle-comment)
18024 ("Clock Commands")
18025 ("I" . org-clock-in)
18026 ("O" . org-clock-out)
18027 ("Meta Data Editing")
18028 ("t" . org-todo)
18029 ("," . (org-priority))
18030 ("0" . (org-priority ?\ ))
18031 ("1" . (org-priority ?A))
18032 ("2" . (org-priority ?B))
18033 ("3" . (org-priority ?C))
18034 (";" . org-set-tags-command)
18035 ("e" . org-set-effort)
18036 ("E" . org-inc-effort)
18037 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
18038 (org-entry-put (point) "APPT_WARNTIME" m)))
18039 ("Agenda Views etc")
18040 ("v" . org-agenda)
18041 ("/" . org-sparse-tree)
18042 ("Misc")
18043 ("o" . org-open-at-point)
18044 ("?" . org-speed-command-help)
18045 ("<" . (org-agenda-set-restriction-lock 'subtree))
18046 (">" . (org-agenda-remove-restriction-lock))
18047 )
18048 "The default speed commands.")
18050 (defun org-print-speed-command (e)
18051 (if (> (length (car e)) 1)
18052 (progn
18054 (princ (car e))
18056 (princ (make-string (length (car e)) ?-))
18058 (princ (car e))
18059 (princ " ")
18060 (if (symbolp (cdr e))
18061 (princ (symbol-name (cdr e)))
18062 (prin1 (cdr e)))
18065 (defun org-speed-command-help ()
18066 "Show the available speed commands."
18067 (interactive)
18068 (if (not org-use-speed-commands)
18069 (error "Speed commands are not activated, customize `org-use-speed-commands'")
18070 (with-output-to-temp-buffer "*Help*"
18072 (mapc 'org-print-speed-command org-speed-commands-user)
18075 (mapc 'org-print-speed-command org-speed-commands-default))
18076 (with-current-buffer "*Help*"
18077 (setq truncate-lines t))))
18079 (defun org-speed-move-safe (cmd)
18080 "Execute CMD, but make sure that the cursor always ends up in a headline.
18081 If not, return to the original position and throw an error."
18082 (interactive)
18083 (let ((pos (point)))
18084 (call-interactively cmd)
18085 (unless (and (bolp) (org-at-heading-p))
18086 (goto-char pos)
18087 (error "Boundary reached while executing %s" cmd))))
18089 (defvar org-self-insert-command-undo-counter 0)
18091 (defvar org-table-auto-blank-field) ; defined in org-table.el
18092 (defvar org-speed-command nil)
18094 (define-obsolete-function-alias
18095 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
18097 (defun org-speed-command-activate (keys)
18098 "Hook for activating single-letter speed commands.
18099 `org-speed-commands-default' specifies a minimal command set.
18100 Use `org-speed-commands-user' for further customization."
18101 (when (or (and (bolp) (looking-at org-outline-regexp))
18102 (and (functionp org-use-speed-commands)
18103 (funcall org-use-speed-commands)))
18104 (cdr (assoc keys (append org-speed-commands-user
18105 org-speed-commands-default)))))
18107 (define-obsolete-function-alias
18108 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
18110 (defun org-babel-speed-command-activate (keys)
18111 "Hook for activating single-letter code block commands."
18112 (when (and (bolp) (looking-at org-babel-src-block-regexp))
18113 (cdr (assoc keys org-babel-key-bindings))))
18115 (defcustom org-speed-command-hook
18116 '(org-speed-command-default-hook org-babel-speed-command-hook)
18117 "Hook for activating speed commands at strategic locations.
18118 Hook functions are called in sequence until a valid handler is
18119 found.
18121 Each hook takes a single argument, a user-pressed command key
18122 which is also a `self-insert-command' from the global map.
18124 Within the hook, examine the cursor position and the command key
18125 and return nil or a valid handler as appropriate. Handler could
18126 be one of an interactive command, a function, or a form.
18128 Set `org-use-speed-commands' to non-nil value to enable this
18129 hook. The default setting is `org-speed-command-activate'."
18130 :group 'org-structure
18131 :version "24.1"
18132 :type 'hook)
18134 (defun org-self-insert-command (N)
18135 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18136 If the cursor is in a table looking at whitespace, the whitespace is
18137 overwritten, and the table is not marked as requiring realignment."
18138 (interactive "p")
18139 (org-check-before-invisible-edit 'insert)
18140 (cond
18141 ((and org-use-speed-commands
18142 (setq org-speed-command
18143 (run-hook-with-args-until-success
18144 'org-speed-command-hook (this-command-keys))))
18145 (cond
18146 ((commandp org-speed-command)
18147 (setq this-command org-speed-command)
18148 (call-interactively org-speed-command))
18149 ((functionp org-speed-command)
18150 (funcall org-speed-command))
18151 ((and org-speed-command (listp org-speed-command))
18152 (eval org-speed-command))
18153 (t (let (org-use-speed-commands)
18154 (call-interactively 'org-self-insert-command)))))
18155 ((and
18156 (org-table-p)
18157 (progn
18158 ;; check if we blank the field, and if that triggers align
18159 (and (featurep 'org-table) org-table-auto-blank-field
18160 (member last-command
18161 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
18163 ;; got extra space, this field does not determine column width
18164 (let (org-table-may-need-update) (org-table-blank-field))
18165 ;; no extra space, this field may determine column width
18166 (org-table-blank-field)))
18167 t)
18168 (eq N 1)
18170 (let (org-table-may-need-update)
18171 (goto-char (1- (match-end 0)))
18172 (backward-delete-char 1)
18173 (goto-char (match-beginning 0))
18174 (self-insert-command N)))
18175 (t
18176 (setq org-table-may-need-update t)
18177 (self-insert-command N)
18178 (org-fix-tags-on-the-fly)
18179 (if org-self-insert-cluster-for-undo
18180 (if (not (eq last-command 'org-self-insert-command))
18181 (setq org-self-insert-command-undo-counter 1)
18182 (if (>= org-self-insert-command-undo-counter 20)
18183 (setq org-self-insert-command-undo-counter 1)
18184 (and (> org-self-insert-command-undo-counter 0)
18185 buffer-undo-list (listp buffer-undo-list)
18186 (not (cadr buffer-undo-list)) ; remove nil entry
18187 (setcdr buffer-undo-list (cddr buffer-undo-list)))
18188 (setq org-self-insert-command-undo-counter
18189 (1+ org-self-insert-command-undo-counter))))))))
18191 (defun org-check-before-invisible-edit (kind)
18192 "Check is editing if kind KIND would be dangerous with invisible text around.
18193 The detailed reaction depends on the user option `org-catch-invisible-edits'."
18194 ;; First, try to get out of here as quickly as possible, to reduce overhead
18195 (if (and org-catch-invisible-edits
18196 (or (not (boundp 'visible-mode)) (not visible-mode))
18197 (or (get-char-property (point) 'invisible)
18198 (get-char-property (max (point-min) (1- (point))) 'invisible)))
18199 ;; OK, we need to take a closer look
18200 (let* ((invisible-at-point (get-char-property (point) 'invisible))
18201 (invisible-before-point (if (bobp) nil (get-char-property
18202 (1- (point)) 'invisible)))
18203 (border-and-ok-direction
18204 (or
18205 ;; Check if we are acting predictably before invisible text
18206 (and invisible-at-point (not invisible-before-point)
18207 (memq kind '(insert delete-backward)))
18208 ;; Check if we are acting predictably after invisible text
18209 ;; This works not well, and I have turned it off. It seems
18210 ;; better to always show and stop after invisible text.
18211 ;; (and (not invisible-at-point) invisible-before-point
18212 ;; (memq kind '(insert delete)))
18213 )))
18214 (when (or (memq invisible-at-point '(outline org-hide-block t))
18215 (memq invisible-before-point '(outline org-hide-block t)))
18216 (if (eq org-catch-invisible-edits 'error)
18217 (error "Editing in invisible areas is prohibited - make visible first"))
18218 (if (and org-custom-properties-overlays
18219 (y-or-n-p "Display invisible properties in this buffer? "))
18220 (org-toggle-custom-properties-visibility)
18221 ;; Make the area visible
18222 (save-excursion
18223 (if invisible-before-point
18224 (goto-char (previous-single-char-property-change
18225 (point) 'invisible)))
18226 (org-cycle))
18227 (cond
18228 ((eq org-catch-invisible-edits 'show)
18229 ;; That's it, we do the edit after showing
18230 (message
18231 "Unfolding invisible region around point before editing")
18232 (sit-for 1))
18233 ((and (eq org-catch-invisible-edits 'smart)
18234 border-and-ok-direction)
18235 (message "Unfolding invisible region around point before editing"))
18236 (t
18237 ;; Don't do the edit, make the user repeat it in full visibility
18238 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
18240 (defun org-fix-tags-on-the-fly ()
18241 (when (and (equal (char-after (point-at-bol)) ?*)
18242 (org-at-heading-p))
18243 (org-align-tags-here org-tags-column)))
18245 (defun org-delete-backward-char (N)
18246 "Like `delete-backward-char', insert whitespace at field end in tables.
18247 When deleting backwards, in tables this function will insert whitespace in
18249 still be marked for re-alignment if the field did fill the entire column,
18250 because, in this case the deletion might narrow the column."
18251 (interactive "p")
18252 (org-check-before-invisible-edit 'delete-backward)
18253 (if (and (org-table-p)
18254 (eq N 1)
18255 (string-match "|" (buffer-substring (point-at-bol) (point)))
18256 (looking-at ".*?|"))
18257 (let ((pos (point))
18259 (c org-table-may-need-update))
18260 (backward-delete-char N)
18261 (if (not overwrite-mode)
18262 (progn
18263 (skip-chars-forward "^|")
18264 (insert " ")
18265 (goto-char (1- pos))))
18266 ;; noalign: if there were two spaces at the end, this field
18267 ;; does not determine the width of the column.
18268 (if noalign (setq org-table-may-need-update c)))
18269 (backward-delete-char N)
18270 (org-fix-tags-on-the-fly)))
18272 (defun org-delete-char (N)
18273 "Like `delete-char', but insert whitespace at field end in tables.
18274 When deleting characters, in tables this function will insert whitespace in
18276 still be marked for re-alignment if the field did fill the entire column,
18277 because, in this case the deletion might narrow the column."
18278 (interactive "p")
18279 (org-check-before-invisible-edit 'delete)
18280 (if (and (org-table-p)
18281 (not (bolp))
18282 (not (= (char-after) ?|))
18283 (eq N 1))
18284 (if (looking-at ".*?|")
18285 (let ((pos (point))
18287 (c org-table-may-need-update))
18288 (replace-match (concat
18289 (substring (match-string 0) 1 -1)
18290 " |"))
18291 (goto-char pos)
18292 ;; noalign: if there were two spaces at the end, this field
18293 ;; does not determine the width of the column.
18294 (if noalign (setq org-table-may-need-update c)))
18295 (delete-char N))
18296 (delete-char N)
18297 (org-fix-tags-on-the-fly)))
18299 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
18300 (put 'org-self-insert-command 'delete-selection t)
18301 (put 'orgtbl-self-insert-command 'delete-selection t)
18302 (put 'org-delete-char 'delete-selection 'supersede)
18303 (put 'org-delete-backward-char 'delete-selection 'supersede)
18304 (put 'org-yank 'delete-selection 'yank)
18306 ;; Make `flyspell-mode' delay after some commands
18307 (put 'org-self-insert-command 'flyspell-delayed t)
18308 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
18309 (put 'org-delete-char 'flyspell-delayed t)
18310 (put 'org-delete-backward-char 'flyspell-delayed t)
18312 ;; Make pabbrev-mode expand after org-mode commands
18313 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
18314 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
18316 ;; How to do this: Measure non-white length of current string
18317 ;; If equal to column width, we should realign.
18319 (defun org-remap (map &rest commands)
18320 "In MAP, remap the functions given in COMMANDS.
18321 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
18322 (let (new old)
18323 (while commands
18324 (setq old (pop commands) new (pop commands))
18325 (if (fboundp 'command-remapping)
18326 (org-defkey map (vector 'remap old) new)
18327 (substitute-key-definition old new map global-map)))))
18329 (when (eq org-enable-table-editor 'optimized)
18330 ;; If the user wants maximum table support, we need to hijack
18331 ;; some standard editing functions
18332 (org-remap org-mode-map
18333 'self-insert-command 'org-self-insert-command
18334 'delete-char 'org-delete-char
18335 'delete-backward-char 'org-delete-backward-char)
18336 (org-defkey org-mode-map "|" 'org-force-self-insert))
18338 (defvar org-ctrl-c-ctrl-c-hook nil
18339 "Hook for functions attaching themselves to `C-c C-c'.
18341 This can be used to add additional functionality to the C-c C-c
18342 key which executes context-dependent commands. This hook is run
18343 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
18344 run after the last test.
18346 Each function will be called with no arguments. The function
18347 must check if the context is appropriate for it to act. If yes,
18348 it should do its thing and then return a non-nil value. If the
18349 context is wrong, just do nothing and return nil.")
18351 (defvar org-ctrl-c-ctrl-c-final-hook nil
18352 "Hook for functions attaching themselves to `C-c C-c'.
18354 This can be used to add additional functionality to the C-c C-c
18355 key which executes context-dependent commands. This hook is run
18356 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
18357 before the first test.
18359 Each function will be called with no arguments. The function
18360 must check if the context is appropriate for it to act. If yes,
18361 it should do its thing and then return a non-nil value. If the
18362 context is wrong, just do nothing and return nil.")
18364 (defvar org-tab-first-hook nil
18365 "Hook for functions to attach themselves to TAB.
18366 See `org-ctrl-c-ctrl-c-hook' for more information.
18367 This hook runs as the first action when TAB is pressed, even before
18368 `org-cycle' messes around with the `outline-regexp' to cater for
18369 inline tasks and plain list item folding.
18370 If any function in this hook returns t, any other actions that
18371 would have been caused by TAB (such as table field motion or visibility
18372 cycling) will not occur.")
18374 (defvar org-tab-after-check-for-table-hook nil
18375 "Hook for functions to attach themselves to TAB.
18376 See `org-ctrl-c-ctrl-c-hook' for more information.
18377 This hook runs after it has been established that the cursor is not in a
18378 table, but before checking if the cursor is in a headline or if global cycling
18379 should be done.
18380 If any function in this hook returns t, not other actions like visibility
18381 cycling will be done.")
18383 (defvar org-tab-after-check-for-cycling-hook nil
18384 "Hook for functions to attach themselves to TAB.
18385 See `org-ctrl-c-ctrl-c-hook' for more information.
18386 This hook runs after it has been established that not table field motion and
18387 not visibility should be done because of current context. This is probably
18388 the place where a package like yasnippets can hook in.")
18390 (defvar org-tab-before-tab-emulation-hook nil
18391 "Hook for functions to attach themselves to TAB.
18392 See `org-ctrl-c-ctrl-c-hook' for more information.
18393 This hook runs after every other options for TAB have been exhausted, but
18396 (defvar org-metaleft-hook nil
18397 "Hook for functions attaching themselves to `M-left'.
18398 See `org-ctrl-c-ctrl-c-hook' for more information.")
18399 (defvar org-metaright-hook nil
18400 "Hook for functions attaching themselves to `M-right'.
18401 See `org-ctrl-c-ctrl-c-hook' for more information.")
18402 (defvar org-metaup-hook nil
18403 "Hook for functions attaching themselves to `M-up'.
18404 See `org-ctrl-c-ctrl-c-hook' for more information.")
18405 (defvar org-metadown-hook nil
18406 "Hook for functions attaching themselves to `M-down'.
18407 See `org-ctrl-c-ctrl-c-hook' for more information.")
18408 (defvar org-shiftmetaleft-hook nil
18409 "Hook for functions attaching themselves to `M-S-left'.
18410 See `org-ctrl-c-ctrl-c-hook' for more information.")
18411 (defvar org-shiftmetaright-hook nil
18412 "Hook for functions attaching themselves to `M-S-right'.
18413 See `org-ctrl-c-ctrl-c-hook' for more information.")
18414 (defvar org-shiftmetaup-hook nil
18415 "Hook for functions attaching themselves to `M-S-up'.
18416 See `org-ctrl-c-ctrl-c-hook' for more information.")
18417 (defvar org-shiftmetadown-hook nil
18418 "Hook for functions attaching themselves to `M-S-down'.
18419 See `org-ctrl-c-ctrl-c-hook' for more information.")
18420 (defvar org-metareturn-hook nil
18421 "Hook for functions attaching themselves to `M-RET'.
18422 See `org-ctrl-c-ctrl-c-hook' for more information.")
18423 (defvar org-shiftup-hook nil
18424 "Hook for functions attaching themselves to `S-up'.
18425 See `org-ctrl-c-ctrl-c-hook' for more information.")
18426 (defvar org-shiftup-final-hook nil
18427 "Hook for functions attaching themselves to `S-up'.
18428 This one runs after all other options except shift-select have been excluded.
18429 See `org-ctrl-c-ctrl-c-hook' for more information.")
18430 (defvar org-shiftdown-hook nil
18431 "Hook for functions attaching themselves to `S-down'.
18432 See `org-ctrl-c-ctrl-c-hook' for more information.")
18433 (defvar org-shiftdown-final-hook nil
18434 "Hook for functions attaching themselves to `S-down'.
18435 This one runs after all other options except shift-select have been excluded.
18436 See `org-ctrl-c-ctrl-c-hook' for more information.")
18437 (defvar org-shiftleft-hook nil
18438 "Hook for functions attaching themselves to `S-left'.
18439 See `org-ctrl-c-ctrl-c-hook' for more information.")
18440 (defvar org-shiftleft-final-hook nil
18441 "Hook for functions attaching themselves to `S-left'.
18442 This one runs after all other options except shift-select have been excluded.
18443 See `org-ctrl-c-ctrl-c-hook' for more information.")
18444 (defvar org-shiftright-hook nil
18445 "Hook for functions attaching themselves to `S-right'.
18446 See `org-ctrl-c-ctrl-c-hook' for more information.")
18447 (defvar org-shiftright-final-hook nil
18448 "Hook for functions attaching themselves to `S-right'.
18449 This one runs after all other options except shift-select have been excluded.
18450 See `org-ctrl-c-ctrl-c-hook' for more information.")
18452 (defun org-modifier-cursor-error ()
18453 "Throw an error, a modified cursor command was applied in wrong context."
18454 (error "This command is active in special context like tables, headlines or items"))
18456 (defun org-shiftselect-error ()
18457 "Throw an error because Shift-Cursor command was applied in wrong context."
18458 (if (and (boundp 'shift-select-mode) shift-select-mode)
18459 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
18460 (error "This command works only in special context like headlines or timestamps")))
18462 (defun org-call-for-shift-select (cmd)
18463 (let ((this-command-keys-shift-translated t))
18464 (call-interactively cmd)))
18466 (defun org-shifttab (&optional arg)
18467 "Global visibility cycling or move to previous table field.
18468 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
18469 on context.
18470 See the individual commands for more information."
18471 (interactive "P")
18472 (cond
18473 ((org-at-table-p) (call-interactively 'org-table-previous-field))
18474 ((integerp arg)
18475 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18476 (message "Content view to level: %d" arg)
18477 (org-content (prefix-numeric-value arg2))
18478 (setq org-cycle-global-status 'overview)))
18479 (t (call-interactively 'org-global-cycle))))
18481 (defun org-shiftmetaleft ()
18482 "Promote subtree or delete table column.
18483 Calls `org-promote-subtree', `org-outdent-item-tree', or
18484 `org-table-delete-column', depending on context. See the
18485 individual commands for more information."
18486 (interactive)
18487 (cond
18488 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18489 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18490 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18491 ((if (not (org-region-active-p)) (org-at-item-p)
18492 (save-excursion (goto-char (region-beginning))
18493 (org-at-item-p)))
18494 (call-interactively 'org-outdent-item-tree))
18495 (t (org-modifier-cursor-error))))
18497 (defun org-shiftmetaright ()
18498 "Demote subtree or insert table column.
18499 Calls `org-demote-subtree', `org-indent-item-tree', or
18500 `org-table-insert-column', depending on context. See the
18501 individual commands for more information."
18502 (interactive)
18503 (cond
18504 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18505 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18506 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18507 ((if (not (org-region-active-p)) (org-at-item-p)
18508 (save-excursion (goto-char (region-beginning))
18509 (org-at-item-p)))
18510 (call-interactively 'org-indent-item-tree))
18511 (t (org-modifier-cursor-error))))
18513 (defun org-shiftmetaup (&optional arg)
18514 "Move subtree up or kill table row.
18515 Calls `org-move-subtree-up' or `org-table-kill-row' or
18516 `org-move-item-up' or `org-timestamp-up', depending on context.
18517 See the individual commands for more information."
18518 (interactive "P")
18519 (cond
18520 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18521 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18522 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18523 ((org-at-item-p) (call-interactively 'org-move-item-up))
18524 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18525 (call-interactively 'org-timestamp-up)))
18526 (t (org-modifier-cursor-error))))
18528 (defun org-shiftmetadown (&optional arg)
18529 "Move subtree down or insert table row.
18530 Calls `org-move-subtree-down' or `org-table-insert-row' or
18531 `org-move-item-down' or `org-timestamp-up', depending on context.
18532 See the individual commands for more information."
18533 (interactive "P")
18534 (cond
18535 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18536 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18537 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18538 ((org-at-item-p) (call-interactively 'org-move-item-down))
18539 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18540 (call-interactively 'org-timestamp-down)))
18541 (t (org-modifier-cursor-error))))
18543 (defsubst org-hidden-tree-error ()
18544 (error
18545 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18547 (defun org-metaleft (&optional arg)
18548 "Promote heading or move table column to left.
18549 Calls `org-do-promote' or `org-table-move-column', depending on context.
18550 With no specific context, calls the Emacs default `backward-word'.
18551 See the individual commands for more information."
18552 (interactive "P")
18553 (cond
18554 ((run-hook-with-args-until-success 'org-metaleft-hook))
18555 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18556 ((org-with-limited-levels
18557 (or (org-at-heading-p)
18558 (and (org-region-active-p)
18559 (save-excursion
18560 (goto-char (region-beginning))
18561 (org-at-heading-p)))))
18562 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18563 (call-interactively 'org-do-promote))
18564 ;; At an inline task.
18565 ((org-at-heading-p)
18566 (call-interactively 'org-inlinetask-promote))
18567 ((or (org-at-item-p)
18568 (and (org-region-active-p)
18569 (save-excursion
18570 (goto-char (region-beginning))
18571 (org-at-item-p))))
18572 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18573 (call-interactively 'org-outdent-item))
18574 (t (call-interactively 'backward-word))))
18576 (defun org-metaright (&optional arg)
18577 "Demote a subtree, a list item or move table column to right.
18578 In front of a drawer or a block keyword, indent it correctly.
18579 With no specific context, calls the Emacs default `forward-word'.
18580 See the individual commands for more information."
18581 (interactive "P")
18582 (cond
18583 ((run-hook-with-args-until-success 'org-metaright-hook))
18584 ((org-at-table-p) (call-interactively 'org-table-move-column))
18585 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18586 ((org-at-block-p) (call-interactively 'org-indent-block))
18587 ((org-with-limited-levels
18588 (or (org-at-heading-p)
18589 (and (org-region-active-p)
18590 (save-excursion
18591 (goto-char (region-beginning))
18592 (org-at-heading-p)))))
18593 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18594 (call-interactively 'org-do-demote))
18595 ;; At an inline task.
18596 ((org-at-heading-p)
18597 (call-interactively 'org-inlinetask-demote))
18598 ((or (org-at-item-p)
18599 (and (org-region-active-p)
18600 (save-excursion
18601 (goto-char (region-beginning))
18602 (org-at-item-p))))
18603 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18604 (call-interactively 'org-indent-item))
18605 (t (call-interactively 'forward-word))))
18607 (defun org-check-for-hidden (what)
18608 "Check if there are hidden headlines/items in the current visual line.
18609 WHAT can be either `headlines' or `items'. If the current line is
18610 an outline or item heading and it has a folded subtree below it,
18611 this function returns t, nil otherwise."
18612 (let ((re (cond
18613 ((eq what 'headlines) org-outline-regexp-bol)
18614 ((eq what 'items) (org-item-beginning-re))
18615 (t (error "This should not happen"))))
18616 beg end)
18617 (save-excursion
18618 (catch 'exit
18619 (unless (org-region-active-p)
18620 (setq beg (point-at-bol))
18621 (beginning-of-line 2)
18622 (while (and (not (eobp)) ;; this is like `next-line'
18623 (get-char-property (1- (point)) 'invisible))
18624 (beginning-of-line 2))
18625 (setq end (point))
18626 (goto-char beg)
18627 (goto-char (point-at-eol))
18628 (setq end (max end (point)))
18629 (while (re-search-forward re end t)
18630 (if (get-char-property (match-beginning 0) 'invisible)
18631 (throw 'exit t))))
18632 nil))))
18634 (autoload 'org-element-at-point "org-element")
18636 (declare-function org-element-at-point "org-element" (&optional keep-trail))
18637 (declare-function org-element-type "org-element" (element))
18638 (declare-function org-element-context "org-element" ())
18639 (declare-function org-element-contents "org-element" (element))
18640 (declare-function org-element-property "org-element" (property element))
18641 (declare-function org-element-paragraph-parser "org-element" (limit))
18642 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
18643 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
18644 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
18645 (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
18646 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
18648 (defun org-metaup (&optional arg)
18649 "Move subtree up or move table row up.
18650 Calls `org-move-subtree-up' or `org-table-move-row' or
18651 `org-move-item-up', depending on context. See the individual commands
18652 for more information."
18653 (interactive "P")
18654 (cond
18655 ((run-hook-with-args-until-success 'org-metaup-hook))
18656 ((org-region-active-p)
18657 (let* ((a (min (region-beginning) (region-end)))
18658 (b (1- (max (region-beginning) (region-end))))
18659 (c (save-excursion (goto-char a)
18660 (move-beginning-of-line 0)))
18661 (d (save-excursion (goto-char a)
18662 (move-end-of-line 0) (point))))
18663 (transpose-regions a b c d)
18664 (goto-char c)))
18665 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18666 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18667 ((org-at-item-p) (call-interactively 'org-move-item-up))
18668 (t (org-drag-element-backward))))
18670 (defun org-metadown (&optional arg)
18671 "Move subtree down or move table row down.
18672 Calls `org-move-subtree-down' or `org-table-move-row' or
18673 `org-move-item-down', depending on context. See the individual
18674 commands for more information."
18675 (interactive "P")
18676 (cond
18677 ((run-hook-with-args-until-success 'org-metadown-hook))
18678 ((org-region-active-p)
18679 (let* ((a (min (region-beginning) (region-end)))
18680 (b (max (region-beginning) (region-end)))
18681 (c (save-excursion (goto-char b)
18682 (move-beginning-of-line 1)))
18683 (d (save-excursion (goto-char b)
18684 (move-end-of-line 1) (1+ (point)))))
18685 (transpose-regions a b c d)
18686 (goto-char d)))
18687 ((org-at-table-p) (call-interactively 'org-table-move-row))
18688 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18689 ((org-at-item-p) (call-interactively 'org-move-item-down))
18690 (t (org-drag-element-forward))))
18692 (defun org-shiftup (&optional arg)
18693 "Increase item in timestamp or increase priority of current headline.
18694 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18695 depending on context. See the individual commands for more information."
18696 (interactive "P")
18697 (cond
18698 ((run-hook-with-args-until-success 'org-shiftup-hook))
18699 ((and org-support-shift-select (org-region-active-p))
18700 (org-call-for-shift-select 'previous-line))
18701 ((org-at-timestamp-p t)
18702 (call-interactively (if org-edit-timestamp-down-means-later
18703 'org-timestamp-down 'org-timestamp-up)))
18704 ((and (not (eq org-support-shift-select 'always))
18705 org-enable-priority-commands
18706 (org-at-heading-p))
18707 (call-interactively 'org-priority-up))
18708 ((and (not org-support-shift-select) (org-at-item-p))
18709 (call-interactively 'org-previous-item))
18710 ((org-clocktable-try-shift 'up arg))
18711 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18712 (org-support-shift-select
18713 (org-call-for-shift-select 'previous-line))
18714 (t (org-shiftselect-error))))
18716 (defun org-shiftdown (&optional arg)
18717 "Decrease item in timestamp or decrease priority of current headline.
18718 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18719 depending on context. See the individual commands for more information."
18720 (interactive "P")
18721 (cond
18722 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18723 ((and org-support-shift-select (org-region-active-p))
18724 (org-call-for-shift-select 'next-line))
18725 ((org-at-timestamp-p t)
18726 (call-interactively (if org-edit-timestamp-down-means-later
18727 'org-timestamp-up 'org-timestamp-down)))
18728 ((and (not (eq org-support-shift-select 'always))
18729 org-enable-priority-commands
18730 (org-at-heading-p))
18731 (call-interactively 'org-priority-down))
18732 ((and (not org-support-shift-select) (org-at-item-p))
18733 (call-interactively 'org-next-item))
18734 ((org-clocktable-try-shift 'down arg))
18735 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18736 (org-support-shift-select
18737 (org-call-for-shift-select 'next-line))
18738 (t (org-shiftselect-error))))
18740 (defun org-shiftright (&optional arg)
18741 "Cycle the thing at point or in the current line, depending on context.
18742 Depending on context, this does one of the following:
18744 - switch a timestamp at point one day into the future
18745 - on a headline, switch to the next TODO keyword.
18746 - on an item, switch entire list to the next bullet type
18747 - on a property line, switch to the next allowed value
18748 - on a clocktable definition line, move time block into the future"
18749 (interactive "P")
18750 (cond
18751 ((run-hook-with-args-until-success 'org-shiftright-hook))
18752 ((and org-support-shift-select (org-region-active-p))
18753 (org-call-for-shift-select 'forward-char))
18754 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18755 ((and (not (eq org-support-shift-select 'always))
18756 (org-at-heading-p))
18757 (let ((org-inhibit-logging
18758 (not org-treat-S-cursor-todo-selection-as-state-change))
18759 (org-inhibit-blocking
18760 (not org-treat-S-cursor-todo-selection-as-state-change)))
18761 (org-call-with-arg 'org-todo 'right)))
18762 ((or (and org-support-shift-select
18763 (not (eq org-support-shift-select 'always))
18764 (org-at-item-bullet-p))
18765 (and (not org-support-shift-select) (org-at-item-p)))
18766 (org-call-with-arg 'org-cycle-list-bullet nil))
18767 ((and (not (eq org-support-shift-select 'always))
18768 (org-at-property-p))
18769 (call-interactively 'org-property-next-allowed-value))
18770 ((org-clocktable-try-shift 'right arg))
18771 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18772 (org-support-shift-select
18773 (org-call-for-shift-select 'forward-char))
18774 (t (org-shiftselect-error))))
18776 (defun org-shiftleft (&optional arg)
18777 "Cycle the thing at point or in the current line, depending on context.
18778 Depending on context, this does one of the following:
18780 - switch a timestamp at point one day into the past
18781 - on a headline, switch to the previous TODO keyword.
18782 - on an item, switch entire list to the previous bullet type
18783 - on a property line, switch to the previous allowed value
18784 - on a clocktable definition line, move time block into the past"
18785 (interactive "P")
18786 (cond
18787 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18788 ((and org-support-shift-select (org-region-active-p))
18789 (org-call-for-shift-select 'backward-char))
18790 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18791 ((and (not (eq org-support-shift-select 'always))
18792 (org-at-heading-p))
18793 (let ((org-inhibit-logging
18794 (not org-treat-S-cursor-todo-selection-as-state-change))
18795 (org-inhibit-blocking
18796 (not org-treat-S-cursor-todo-selection-as-state-change)))
18797 (org-call-with-arg 'org-todo 'left)))
18798 ((or (and org-support-shift-select
18799 (not (eq org-support-shift-select 'always))
18800 (org-at-item-bullet-p))
18801 (and (not org-support-shift-select) (org-at-item-p)))
18802 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18803 ((and (not (eq org-support-shift-select 'always))
18804 (org-at-property-p))
18805 (call-interactively 'org-property-previous-allowed-value))
18806 ((org-clocktable-try-shift 'left arg))
18807 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18808 (org-support-shift-select
18809 (org-call-for-shift-select 'backward-char))
18810 (t (org-shiftselect-error))))
18812 (defun org-shiftcontrolright ()
18813 "Switch to next TODO set."
18814 (interactive)
18815 (cond
18816 ((and org-support-shift-select (org-region-active-p))
18817 (org-call-for-shift-select 'forward-word))
18818 ((and (not (eq org-support-shift-select 'always))
18819 (org-at-heading-p))
18820 (org-call-with-arg 'org-todo 'nextset))
18821 (org-support-shift-select
18822 (org-call-for-shift-select 'forward-word))
18823 (t (org-shiftselect-error))))
18825 (defun org-shiftcontrolleft ()
18826 "Switch to previous TODO set."
18827 (interactive)
18828 (cond
18829 ((and org-support-shift-select (org-region-active-p))
18830 (org-call-for-shift-select 'backward-word))
18831 ((and (not (eq org-support-shift-select 'always))
18832 (org-at-heading-p))
18833 (org-call-with-arg 'org-todo 'previousset))
18834 (org-support-shift-select
18835 (org-call-for-shift-select 'backward-word))
18836 (t (org-shiftselect-error))))
18838 (defun org-shiftcontrolup ()
18839 "Change timestamps synchronously up in CLOCK log lines."
18840 (interactive)
18841 (cond ((and (not org-support-shift-select)
18842 (org-at-clock-log-p)
18843 (org-at-timestamp-p t))
18844 (org-clock-timestamps-up))
18845 (t (org-shiftselect-error))))
18847 (defun org-shiftcontroldown ()
18848 "Change timestamps synchronously down in CLOCK log lines."
18849 (interactive)
18850 (cond ((and (not org-support-shift-select)
18851 (org-at-clock-log-p)
18852 (org-at-timestamp-p t))
18853 (org-clock-timestamps-down))
18854 (t (org-shiftselect-error))))
18856 (defun org-ctrl-c-ret ()
18857 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18858 (interactive)
18859 (cond
18860 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18861 (t (call-interactively 'org-insert-heading))))
18863 (defun org-find-visible ()
18864 (let ((s (point)))
18865 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18866 (get-char-property s 'invisible)))
18867 s))
18868 (defun org-find-invisible ()
18869 (let ((s (point)))
18870 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18871 (not (get-char-property s 'invisible))))
18872 s))
18874 (defun org-copy-visible (beg end)
18875 "Copy the visible parts of the region."
18876 (interactive "r")
18877 (let (snippets s)
18878 (save-excursion
18879 (save-restriction
18880 (narrow-to-region beg end)
18881 (setq s (goto-char (point-min)))
18882 (while (not (= (point) (point-max)))
18883 (goto-char (org-find-invisible))
18884 (push (buffer-substring s (point)) snippets)
18885 (setq s (goto-char (org-find-visible))))))
18886 (kill-new (apply 'concat (nreverse snippets)))))
18888 (defun org-copy-special ()
18889 "Copy region in table or copy current subtree.
18890 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18891 See the individual commands for more information."
18892 (interactive)
18893 (call-interactively
18894 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18896 (defun org-cut-special ()
18897 "Cut region in table or cut current subtree.
18898 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18899 See the individual commands for more information."
18900 (interactive)
18901 (call-interactively
18902 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18904 (defun org-paste-special (arg)
18905 "Paste rectangular region into table, or past subtree relative to level.
18906 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18907 See the individual commands for more information."
18908 (interactive "P")
18909 (if (org-at-table-p)
18910 (org-table-paste-rectangle)
18911 (org-paste-subtree arg)))
18913 (defun org-edit-special (&optional arg)
18914 "Call a special editor for the stuff at point.
18915 When at a table, call the formula editor with `org-table-edit-formulas'.
18916 When at the first line of an src example, call `org-edit-src-code'.
18917 When in an #+include line, visit the include file. Otherwise call
18918 `ffap' to visit the file at point."
18919 (interactive)
18920 ;; possibly prep session before editing source
18921 (when arg
18922 (let* ((info (org-babel-get-src-block-info))
18923 (lang (nth 0 info))
18924 (params (nth 2 info))
18925 (session (cdr (assoc :session params))))
18926 (when (and info session) ;; we are in a source-code block with a session
18927 (funcall
18928 (intern (concat "org-babel-prep-session:" lang)) session params))))
18929 (cond ;; proceed with `org-edit-special'
18930 ((save-excursion
18931 (beginning-of-line 1)
18932 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18933 (find-file (org-trim (match-string 1))))
18934 ((org-edit-src-code))
18935 ((org-edit-fixed-width-region))
18936 ((org-at-table.el-p)
18937 (org-edit-src-code))
18938 ((or (org-at-table-p)
18939 (save-excursion
18940 (beginning-of-line 1)
18942 (call-interactively 'org-table-edit-formulas))
18943 (t (call-interactively 'ffap))))
18945 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18946 (defun org-ctrl-c-ctrl-c (&optional arg)
18947 "Set tags in headline, or update according to changed information at point.
18949 This command does many different things, depending on context:
18951 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18952 this is what we do.
18954 - If the cursor is on a statistics cookie, update it.
18956 - If the cursor is in a headline, prompt for tags and insert them
18957 into the current line, aligned to `org-tags-column'. When called
18958 with prefix arg, realign all tags in the current buffer.
18960 - If the cursor is in one of the special #+KEYWORD lines, this
18961 triggers scanning the buffer for these lines and updating the
18962 information.
18964 - If the cursor is inside a table, realign the table. This command
18965 works even if the automatic table editor has been turned off.
18967 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18968 the entire table.
18970 - If the cursor is at a footnote reference or definition, jump to
18971 the corresponding definition or references, respectively.
18973 - If the cursor is a the beginning of a dynamic block, update it.
18975 - If the current buffer is a capture buffer, close note and file it.
18977 - If the cursor is on a <<<target>>>, update radio targets and
18978 corresponding links in this buffer.
18980 - If the cursor is on a numbered item in a plain list, renumber the
18981 ordered list.
18983 - If the cursor is on a checkbox, toggle it.
18985 - If the cursor is on a code block, evaluate it. The variable
18986 `org-confirm-babel-evaluate' can be used to control prompting
18987 before code block evaluation, by default every code block
18988 evaluation requires confirmation. Code block evaluation can be
18989 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18990 (interactive "P")
18991 (let ((org-enable-table-editor t))
18992 (cond
18993 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18994 org-occur-highlights
18995 org-latex-fragment-image-overlays)
18996 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18997 (org-remove-occur-highlights)
18998 (org-remove-latex-fragment-image-overlays)
18999 (message "Temporary highlights/overlays removed from current buffer"))
19000 ((and (local-variable-p 'org-finish-function (current-buffer))
19001 (fboundp org-finish-function))
19002 (funcall org-finish-function))
19003 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
19004 ((org-in-regexp org-ts-regexp-both)
19005 (org-timestamp-change 0 'day))
19006 ((or (looking-at org-property-start-re)
19007 (org-at-property-p))
19008 (call-interactively 'org-property-action))
19009 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
19011 (or (org-at-heading-p) (org-at-item-p)))
19012 (call-interactively 'org-update-statistics-cookies))
19013 ((org-at-heading-p) (call-interactively 'org-set-tags))
19014 ((org-at-table.el-p)
19015 (message "Use C-c ' to edit table.el tables"))
19016 ((org-at-table-p)
19017 (org-table-maybe-eval-formula)
19018 (if arg
19019 (call-interactively 'org-table-recalculate)
19020 (org-table-maybe-recalculate-line))
19021 (call-interactively 'org-table-align)
19022 (orgtbl-send-table 'maybe))
19023 ((or (org-footnote-at-reference-p)
19024 (org-footnote-at-definition-p))
19025 (call-interactively 'org-footnote-action))
19026 ((org-at-item-checkbox-p)
19027 ;; Cursor at a checkbox: repair list and update checkboxes. Send
19028 ;; list only if at top item.
19029 (let* ((cbox (match-string 1))
19030 (struct (org-list-struct))
19031 (old-struct (copy-tree struct))
19032 (parents (org-list-parents-alist struct))
19033 (orderedp (org-entry-get nil "ORDERED"))
19034 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19035 block-item)
19036 ;; Use a light version of `org-toggle-checkbox' to avoid
19037 ;; computing list structure twice.
19038 (let ((new-box (cond
19039 ((equal arg '(16)) "[-]")
19040 ((equal arg '(4)) nil)
19041 ((equal "[X]" cbox) "[ ]")
19042 (t "[X]"))))
19043 (if (and firstp arg)
19044 ;; If at first item of sub-list, remove check-box from
19045 ;; every item at the same level.
19046 (mapc
19047 (lambda (pos) (org-list-set-checkbox pos struct new-box))
19048 (org-list-get-all-items
19049 (point-at-bol) struct (org-list-prevs-alist struct)))
19050 (org-list-set-checkbox (point-at-bol) struct new-box)))
19051 ;; Replicate `org-list-write-struct', while grabbing a return
19052 ;; value from `org-list-struct-fix-box'.
19053 (org-list-struct-fix-ind struct parents 2)
19054 (org-list-struct-fix-item-end struct)
19055 (let ((prevs (org-list-prevs-alist struct)))
19056 (org-list-struct-fix-bul struct prevs)
19057 (org-list-struct-fix-ind struct parents)
19058 (setq block-item
19059 (org-list-struct-fix-box struct parents prevs orderedp)))
19060 (org-list-struct-apply-struct struct old-struct)
19061 (org-update-checkbox-count-maybe)
19062 (when block-item
19063 (message
19064 "Checkboxes were removed due to unchecked box at line %d"
19065 (org-current-line block-item)))
19066 (when firstp (org-list-send-list 'maybe))))
19067 ((org-at-item-p)
19068 ;; Cursor at an item: repair list. Do checkbox related actions
19069 ;; only if function was called with an argument. Send list only
19070 ;; if at top item.
19071 (let* ((struct (org-list-struct))
19072 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19073 old-struct)
19074 (when arg
19075 (setq old-struct (copy-tree struct))
19076 (if firstp
19077 ;; If at first item of sub-list, add check-box to every
19078 ;; item at the same level.
19079 (mapc
19080 (lambda (pos)
19081 (unless (org-list-get-checkbox pos struct)
19082 (org-list-set-checkbox pos struct "[ ]")))
19083 (org-list-get-all-items
19084 (point-at-bol) struct (org-list-prevs-alist struct)))
19085 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
19086 (org-list-write-struct
19087 struct (org-list-parents-alist struct) old-struct)
19088 (when arg (org-update-checkbox-count-maybe))
19089 (when firstp (org-list-send-list 'maybe))))
19090 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
19091 ;; Dynamic block
19092 (beginning-of-line 1)
19093 (save-excursion (org-update-dblock)))
19094 ((save-excursion
19095 (let ((case-fold-search t))
19096 (beginning-of-line 1)
19098 (cond
19099 ((or (equal (match-string 1) "TBLFM")
19100 (equal (match-string 1) "tblfm"))
19101 ;; Recalculate the table before this line
19102 (save-excursion
19103 (beginning-of-line 1)
19105 (if (org-at-table-p)
19106 (org-call-with-arg 'org-table-recalculate (or arg t)))))
19107 (t
19108 (let ((org-inhibit-startup-visibility-stuff t)
19109 (org-startup-align-all-tables nil))
19110 (when (boundp 'org-table-coordinate-overlays)
19111 (mapc 'delete-overlay org-table-coordinate-overlays)
19112 (setq org-table-coordinate-overlays nil))
19113 (org-save-outline-visibility 'use-markers (org-mode-restart)))
19114 (message "Local setup has been refreshed"))))
19115 ((org-clock-update-time-maybe))
19116 (t
19117 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19118 (error "C-c C-c can do nothing useful at this location"))))))
19120 (defun org-mode-restart ()
19121 "Restart Org-mode, to scan again for special lines.
19122 Also updates the keyword regular expressions."
19123 (interactive)
19124 (org-mode)
19125 (message "Org-mode restarted"))
19127 (defun org-kill-note-or-show-branches ()
19128 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
19129 (interactive)
19130 (if (not org-finish-function)
19131 (progn
19132 (hide-subtree)
19133 (call-interactively 'show-branches))
19134 (let ((org-note-abort t))
19135 (funcall org-finish-function))))
19137 (defun org-return (&optional indent)
19138 "Goto next table row or insert a newline.
19139 Calls `org-table-next-row' or `newline', depending on context.
19140 See the individual commands for more information."
19141 (interactive)
19142 (let (org-ts-what)
19143 (cond
19144 ((or (bobp) (org-in-src-block-p))
19145 (if indent (newline-and-indent) (newline)))
19146 ((org-at-table-p)
19147 (org-table-justify-field-maybe)
19148 (call-interactively 'org-table-next-row))
19149 ;; when `newline-and-indent' is called within a list, make sure
19150 ;; text moved stays inside the item.
19151 ((and (org-in-item-p) indent)
19152 (if (and (org-at-item-p) (>= (point) (match-end 0)))
19153 (progn
19154 (save-match-data (newline))
19155 (org-indent-line-to (length (match-string 0))))
19156 (let ((ind (org-get-indentation)))
19157 (newline)
19158 (if (org-looking-back org-list-end-re)
19159 (org-indent-line)
19160 (org-indent-line-to ind)))))
19161 ((and org-return-follows-link
19162 (org-at-timestamp-p t)
19163 (not (eq org-ts-what 'after)))
19164 (org-follow-timestamp-link))
19165 ((and org-return-follows-link
19166 (let ((tprop (get-text-property (point) 'face)))
19167 (or (eq tprop 'org-link)
19168 (and (listp tprop) (memq 'org-link tprop)))))
19169 (call-interactively 'org-open-at-point))
19170 ((and (org-at-heading-p)
19171 (looking-at
19173 (org-show-entry)
19174 (end-of-line 1)
19175 (newline))
19176 (t (if indent (newline-and-indent) (newline))))))
19178 (defun org-return-indent ()
19179 "Goto next table row or insert a newline and indent.
19180 Calls `org-table-next-row' or `newline-and-indent', depending on
19181 context. See the individual commands for more information."
19182 (interactive)
19183 (org-return t))
19185 (defun org-ctrl-c-star ()
19186 "Compute table, or change heading status of lines.
19187 Calls `org-table-recalculate' or `org-toggle-heading',
19188 depending on context."
19189 (interactive)
19190 (cond
19191 ((org-at-table-p)
19192 (call-interactively 'org-table-recalculate))
19193 (t
19194 ;; Convert all lines in region to list items
19195 (call-interactively 'org-toggle-heading))))
19197 (defun org-ctrl-c-minus ()
19198 "Insert separator line in table or modify bullet status of line.
19199 Also turns a plain line or a region of lines into list items.
19200 Calls `org-table-insert-hline', `org-toggle-item', or
19201 `org-cycle-list-bullet', depending on context."
19202 (interactive)
19203 (cond
19204 ((org-at-table-p)
19205 (call-interactively 'org-table-insert-hline))
19206 ((org-region-active-p)
19207 (call-interactively 'org-toggle-item))
19208 ((org-in-item-p)
19209 (call-interactively 'org-cycle-list-bullet))
19210 (t
19211 (call-interactively 'org-toggle-item))))
19213 (defun org-toggle-item (arg)
19214 "Convert headings or normal lines to items, items to normal lines.
19215 If there is no active region, only the current line is considered.
19217 If the first non blank line in the region is an headline, convert
19218 all headlines to items, shifting text accordingly.
19220 If it is an item, convert all items to normal lines.
19222 If it is normal text, change region into an item. With a prefix
19223 argument ARG, change each line in region into an item."
19224 (interactive "P")
19225 (let ((shift-text
19226 (function
19227 ;; Shift text in current section to IND, from point to END.
19228 ;; The function leaves point to END line.
19229 (lambda (ind end)
19230 (let ((min-i 1000) (end (copy-marker end)))
19231 ;; First determine the minimum indentation (MIN-I) of
19232 ;; the text.
19233 (save-excursion
19234 (catch 'exit
19235 (while (< (point) end)
19236 (let ((i (org-get-indentation)))
19237 (cond
19238 ;; Skip blank lines and inline tasks.
19240 ((looking-at org-outline-regexp-bol))
19241 ;; We can't find less than 0 indentation.
19242 ((zerop i) (throw 'exit (setq min-i 0)))
19243 ((< i min-i) (setq min-i i))))
19244 (forward-line))))
19245 ;; Then indent each line so that a line indented to
19246 ;; MIN-I becomes indented to IND. Ignore blank lines
19247 ;; and inline tasks in the process.
19248 (let ((delta (- ind min-i)))
19249 (while (< (point) end)
19251 (looking-at org-outline-regexp-bol))
19252 (org-indent-line-to (+ (org-get-indentation) delta)))
19253 (forward-line)))))))
19254 (skip-blanks
19255 (function
19256 ;; Return beginning of first non-blank line, starting from
19257 ;; line at POS.
19258 (lambda (pos)
19259 (save-excursion
19260 (goto-char pos)
19262 (point-at-bol)))))
19263 beg end)
19264 ;; Determine boundaries of changes.
19265 (if (org-region-active-p)
19266 (setq beg (funcall skip-blanks (region-beginning))
19267 end (copy-marker (region-end)))
19268 (setq beg (funcall skip-blanks (point-at-bol))
19269 end (copy-marker (point-at-eol))))
19270 ;; Depending on the starting line, choose an action on the text
19271 ;; between BEG and END.
19272 (org-with-limited-levels
19273 (save-excursion
19274 (goto-char beg)
19275 (cond
19276 ;; Case 1. Start at an item: de-itemize. Note that it only
19277 ;; happens when a region is active: `org-ctrl-c-minus'
19278 ;; would call `org-cycle-list-bullet' otherwise.
19279 ((org-at-item-p)
19280 (while (< (point) end)
19281 (when (org-at-item-p)
19283 (delete-region (point) (match-end 0)))
19284 (forward-line)))
19285 ;; Case 2. Start at an heading: convert to items.
19286 ((org-at-heading-p)
19287 (let* ((bul (org-list-bullet-string "-"))
19288 (bul-len (length bul))
19289 ;; Indentation of the first heading. It should be
19290 ;; relative to the indentation of its parent, if any.
19291 (start-ind (save-excursion
19292 (cond
19293 ((not org-adapt-indentation) 0)
19294 ((not (outline-previous-heading)) 0)
19295 (t (length (match-string 0))))))
19296 ;; Level of first heading. Further headings will be
19297 ;; compared to it to determine hierarchy in the list.
19298 (ref-level (org-reduced-level (org-outline-level))))
19299 (while (< (point) end)
19300 (let* ((level (org-reduced-level (org-outline-level)))
19301 (delta (max 0 (- level ref-level))))
19302 ;; If current headline is less indented than the first
19303 ;; one, set it as reference, in order to preserve
19304 ;; subtrees.
19305 (when (< level ref-level) (setq ref-level level))
19306 (replace-match bul t t)
19307 (org-indent-line-to (+ start-ind (* delta bul-len)))
19308 ;; Ensure all text down to END (or SECTION-END) belongs
19309 ;; to the newly created item.
19310 (let ((section-end (save-excursion
19311 (or (outline-next-heading) (point)))))
19312 (forward-line)
19313 (funcall shift-text
19314 (+ start-ind (* (1+ delta) bul-len))
19315 (min end section-end)))))))
19316 ;; Case 3. Normal line with ARG: turn each non-item line into
19317 ;; an item.
19318 (arg
19319 (while (< (point) end)
19320 (unless (or (org-at-heading-p) (org-at-item-p))
19322 (replace-match
19324 (forward-line)))
19325 ;; Case 4. Normal line without ARG: make the first line of
19326 ;; region an item, and shift indentation of others
19327 ;; lines to set them as item's body.
19328 (t (let* ((bul (org-list-bullet-string "-"))
19329 (bul-len (length bul))
19330 (ref-ind (org-get-indentation)))
19332 (insert bul)
19333 (forward-line)
19334 (while (< (point) end)
19335 ;; Ensure that lines less indented than first one
19336 ;; still get included in item body.
19337 (funcall shift-text
19338 (+ ref-ind bul-len)
19339 (min end (save-excursion (or (outline-next-heading)
19340 (point)))))
19341 (forward-line)))))))))
19343 (defun org-toggle-heading (&optional nstars)
19344 "Convert headings to normal text, or items or text to headings.
19345 If there is no active region, only the current line is considered.
19348 point into heading.
19350 In a region:
19352 - If the first non blank line is an headline, remove the stars
19353 from all headlines in the region.
19355 - If it is a normal line turn each and every normal line (i.e. not an
19356 heading or an item) in the region into a heading.
19358 - If it is a plain list item, turn all plain list items into headings.
19360 When converting a line into a heading, the number of stars is chosen
19361 such that the lines become children of the current entry. However,
19362 when a prefix argument is given, its value determines the number of
19363 stars to add."
19364 (interactive "P")
19365 (let ((skip-blanks
19366 (function
19367 ;; Return beginning of first non-blank line, starting from
19368 ;; line at POS.
19369 (lambda (pos)
19370 (save-excursion
19371 (goto-char pos)
19372 (while (org-at-comment-p) (forward-line))
19374 (point-at-bol)))))
19375 beg end toggled)
19376 ;; Determine boundaries of changes. If a universal prefix has
19377 ;; been given, put the list in a region. If region ends at a bol,
19378 ;; do not consider the last line to be in the region.
19380 (when (and current-prefix-arg (org-at-item-p))
19381 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
19382 (org-mark-element))
19384 (if (org-region-active-p)
19385 (setq beg (funcall skip-blanks (region-beginning))
19386 end (copy-marker (save-excursion
19387 (goto-char (region-end))
19388 (if (bolp) (point) (point-at-eol)))))
19389 (setq beg (funcall skip-blanks (point-at-bol))
19390 end (copy-marker (point-at-eol))))
19391 ;; Ensure inline tasks don't count as headings.
19392 (org-with-limited-levels
19393 (save-excursion
19394 (goto-char beg)
19395 (cond
19396 ;; Case 1. Started at an heading: de-star headings.
19397 ((org-at-heading-p)
19398 (while (< (point) end)
19399 (when (org-at-heading-p t)
19400 (looking-at org-outline-regexp) (replace-match "")
19401 (setq toggled t))
19402 (forward-line)))
19403 ;; Case 2. Started at an item: change items into headlines.
19404 ;; One star will be added by `org-list-to-subtree'.
19405 ((org-at-item-p)
19406 (let* ((stars (make-string
19407 (if nstars
19408 ;; subtract the star that will be added again by
19409 ;; `org-list-to-subtree'
19410 (1- (prefix-numeric-value current-prefix-arg))
19411 (or (org-current-level) 0))
19412 ?*))
19413 (add-stars
19414 (cond (nstars "") ; stars from prefix only
19415 ((equal stars "") "") ; before first heading
19416 (org-odd-levels-only "*") ; inside heading, odd
19417 (t "")))) ; inside heading, oddeven
19418 (while (< (point) end)
19419 (when (org-at-item-p)
19420 ;; Pay attention to cases when region ends before list.
19421 (let* ((struct (org-list-struct))
19422 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
19423 (save-restriction
19424 (narrow-to-region (point) list-end)
19425 (insert
19426 (org-list-to-subtree
19427 (org-list-parse-list t)
19428 '(:istart (concat stars add-stars (funcall get-stars depth))
19429 :icount (concat stars add-stars (funcall get-stars depth)))))))
19430 (setq toggled t))
19431 (forward-line))))
19432 ;; Case 3. Started at normal text: make every line an heading,
19433 ;; skipping headlines and items.
19434 (t (let* ((stars (make-string
19435 (if nstars
19436 (prefix-numeric-value current-prefix-arg)
19437 (or (org-current-level) 0))
19438 ?*))
19439 (add-stars
19440 (cond (nstars "") ; stars from prefix only
19441 ((equal stars "") "*") ; before first heading
19442 (org-odd-levels-only "**") ; inside heading, odd
19443 (t "*"))) ; inside heading, oddeven
19444 (rpl (concat stars add-stars " ")))
19445 (while (< (point) end)
19446 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
19448 (replace-match (concat rpl (match-string 2))) (setq toggled t))
19449 (forward-line)))))))
19450 (unless toggled (message "Cannot toggle heading from here"))))
19452 (defun org-meta-return (&optional arg)
19453 "Insert a new heading or wrap a region in a table.
19454 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
19455 See the individual commands for more information."
19456 (interactive "P")
19457 (cond
19458 ((run-hook-with-args-until-success 'org-metareturn-hook))
19459 ((or (org-at-drawer-p) (org-at-property-p))
19460 (newline-and-indent))
19461 ((org-at-table-p)
19462 (call-interactively 'org-table-wrap-region))
19463 (t (call-interactively 'org-insert-heading))))
19465 ;;; Menu entries
19467 (defsubst org-in-subtree-not-table-p ()
19468 "Are we in a subtree and not in a table?"
19469 (and (not (org-before-first-heading-p))
19470 (not (org-at-table-p))))
19472 ;; Define the Org-mode menus
19473 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
19474 '("Tbl"
19475 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
19476 ["Next Field" org-cycle (org-at-table-p)]
19477 ["Previous Field" org-shifttab (org-at-table-p)]
19478 ["Next Row" org-return (org-at-table-p)]
19479 "--"
19480 ["Blank Field" org-table-blank-field (org-at-table-p)]
19481 ["Edit Field" org-table-edit-field (org-at-table-p)]
19482 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
19483 "--"
19484 ("Column"
19485 ["Move Column Left" org-metaleft (org-at-table-p)]
19486 ["Move Column Right" org-metaright (org-at-table-p)]
19487 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
19488 ["Insert Column" org-shiftmetaright (org-at-table-p)])
19489 ("Row"
19490 ["Move Row Up" org-metaup (org-at-table-p)]
19491 ["Move Row Down" org-metadown (org-at-table-p)]
19492 ["Delete Row" org-shiftmetaup (org-at-table-p)]
19493 ["Insert Row" org-shiftmetadown (org-at-table-p)]
19494 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
19495 "--"
19496 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
19497 ("Rectangle"
19498 ["Copy Rectangle" org-copy-special (org-at-table-p)]
19499 ["Cut Rectangle" org-cut-special (org-at-table-p)]
19500 ["Paste Rectangle" org-paste-special (org-at-table-p)]
19501 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
19502 "--"
19503 ("Calculate"
19504 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
19505 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
19506 ["Edit Formulas" org-edit-special (org-at-table-p)]
19507 "--"
19508 ["Recalculate line" org-table-recalculate (org-at-table-p)]
19509 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
19510 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
19511 "--"
19512 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
19513 "--"
19514 ["Sum Column/Rectangle" org-table-sum
19515 (or (org-at-table-p) (org-region-active-p))]
19516 ["Which Column?" org-table-current-column (org-at-table-p)])
19517 ["Debug Formulas"
19518 org-table-toggle-formula-debugger
19519 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
19520 ["Show Col/Row Numbers"
19521 org-table-toggle-coordinate-overlays
19522 :style toggle
19523 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
19524 "--"
19525 ["Create" org-table-create (and (not (org-at-table-p))
19526 org-enable-table-editor)]
19527 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
19528 ["Import from File" org-table-import (not (org-at-table-p))]
19529 ["Export to File" org-table-export (org-at-table-p)]
19530 "--"
19531 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
19533 (easy-menu-define org-org-menu org-mode-map "Org menu"
19534 '("Org"
19535 ("Show/Hide"
19536 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
19537 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
19538 ["Sparse Tree..." org-sparse-tree t]
19539 ["Reveal Context" org-reveal t]
19540 ["Show All" show-all t]
19541 "--"
19542 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
19543 "--"
19544 ["New Heading" org-insert-heading t]
19545 ("Navigate Headings"
19546 ["Up" outline-up-heading t]
19547 ["Next" outline-next-visible-heading t]
19548 ["Previous" outline-previous-visible-heading t]
19549 ["Next Same Level" outline-forward-same-level t]
19550 ["Previous Same Level" outline-backward-same-level t]
19551 "--"
19552 ["Jump" org-goto t])
19553 ("Edit Structure"
19554 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
19555 "--"
19556 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
19557 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
19558 "--"
19559 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
19560 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
19561 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19562 "--"
19563 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19564 "--"
19565 ["Copy visible text" org-copy-visible t]
19566 "--"
19567 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
19568 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
19569 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
19570 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
19571 "--"
19572 ["Sort Region/Children" org-sort t]
19573 "--"
19574 ["Convert to odd levels" org-convert-to-odd-levels t]
19575 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19576 ("Editing"
19577 ["Emphasis..." org-emphasize t]
19578 ["Edit Source Example" org-edit-special t]
19579 "--"
19580 ["Footnote new/jump" org-footnote-action t]
19581 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19582 ("Archive"
19583 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
19584 "--"
19585 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
19586 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
19587 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
19588 )
19589 "--"
19590 ("Hyperlinks"
19591 ["Store Link (Global)" org-store-link t]
19592 ["Find existing link to here" org-occur-link-in-agenda-files t]
19593 ["Insert Link" org-insert-link t]
19594 ["Follow Link" org-open-at-point t]
19595 "--"
19596 ["Next link" org-next-link t]
19597 ["Previous link" org-previous-link t]
19598 "--"
19599 ["Descriptive Links"
19600 org-toggle-link-display
19601 :style radio
19602 :selected org-descriptive-links
19603 ]
19604 ["Literal Links"
19605 org-toggle-link-display
19606 :style radio
19607 :selected (not org-descriptive-links)])
19608 "--"
19609 ("TODO Lists"
19610 ["TODO/DONE/-" org-todo t]
19611 ("Select keyword"
19612 ["Next keyword" org-shiftright (org-at-heading-p)]
19613 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19614 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19615 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19616 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19617 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19618 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19619 "--"
19620 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19621 :selected org-enforce-todo-dependencies :style toggle :active t]
19622 "Settings for tree at point"
19623 ["Do Children sequentially" org-toggle-ordered-property :style radio
19624 :selected (org-entry-get nil "ORDERED")
19625 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19626 ["Do Children parallel" org-toggle-ordered-property :style radio
19627 :selected (not (org-entry-get nil "ORDERED"))
19628 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19629 "--"
19630 ["Set Priority" org-priority t]
19631 ["Priority Up" org-shiftup t]
19632 ["Priority Down" org-shiftdown t]
19633 "--"
19634 ["Get news from all feeds" org-feed-update-all t]
19635 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19636 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19637 ("TAGS and Properties"
19638 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
19639 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19640 "--"
19641 ["Set property" org-set-property (not (org-before-first-heading-p))]
19642 ["Column view of properties" org-columns t]
19643 ["Insert Column View DBlock" org-insert-columns-dblock t])
19644 ("Dates and Scheduling"
19645 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
19646 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
19647 ("Change Date"
19648 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
19649 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
19650 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
19651 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
19652 ["Compute Time Range" org-evaluate-time-range t]
19653 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
19654 ["Deadline" org-deadline (not (org-before-first-heading-p))]
19655 "--"
19656 ["Custom time format" org-toggle-time-stamp-overlays
19657 :style radio :selected org-display-custom-times]
19658 "--"
19659 ["Goto Calendar" org-goto-calendar t]
19660 ["Date from Calendar" org-date-from-calendar t]
19661 "--"
19662 ["Start/Restart Timer" org-timer-start t]
19663 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19664 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19665 ["Insert Timer String" org-timer t]
19666 ["Insert Timer Item" org-timer-item t])
19667 ("Logging work"
19668 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19669 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19670 ["Clock out" org-clock-out t]
19671 ["Clock cancel" org-clock-cancel t]
19672 "--"
19673 ["Mark as default task" org-clock-mark-default-task t]
19674 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19675 ["Goto running clock" org-clock-goto t]
19676 "--"
19677 ["Display times" org-clock-display t]
19678 ["Create clock table" org-clock-report t]
19679 "--"
19680 ["Record DONE time"
19681 (progn (setq org-log-done (not org-log-done))
19682 (message "Switching to %s will %s record a timestamp"
19683 (car org-done-keywords)
19684 (if org-log-done "automatically" "not")))
19685 :style toggle :selected org-log-done])
19686 "--"
19687 ["Agenda Command..." org-agenda t]
19688 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19689 ("File List for Agenda")
19690 ("Special views current file"
19691 ["TODO Tree" org-show-todo-tree t]
19692 ["Check Deadlines" org-check-deadlines t]
19693 ["Timeline" org-timeline t]
19694 ["Tags/Property tree" org-match-sparse-tree t])
19695 "--"
19696 ["Export/Publish..." org-export t]
19697 ("LaTeX"
19698 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19699 :selected org-cdlatex-mode]
19700 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19701 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19702 ["Modify math symbol" org-cdlatex-math-modify
19703 (org-inside-LaTeX-fragment-p)]
19704 ["Insert citation" org-reftex-citation t]
19705 "--"
19706 ["Template for BEAMER" (progn (require 'org-beamer)
19707 (org-insert-beamer-options-template)) t])
19708 "--"
19709 ("MobileOrg"
19710 ["Push Files and Views" org-mobile-push t]
19711 ["Get Captured and Flagged" org-mobile-pull t]
19712 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19713 "--"
19714 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19715 "--"
19716 ("Documentation"
19717 ["Show Version" org-version t]
19718 ["Info Documentation" org-info t])
19719 ("Customize"
19720 ["Browse Org Group" org-customize t]
19721 "--"
19722 ["Expand This Menu" org-create-customize-menu
19723 (fboundp 'customize-menu-create)])
19724 ["Send bug report" org-submit-bug-report t]
19725 "--"
19726 ("Refresh/Reload"
19727 ["Refresh setup current buffer" org-mode-restart t]
19728 ["Reload Org (after update)" org-reload t]
19729 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19730 ))
19732 (defun org-info (&optional node)
19733 "Read documentation for Org-mode in the info system.
19734 With optional NODE, go directly to that node."
19735 (interactive)
19736 (info (format "(org)%s" (or node ""))))
19738 ;;;###autoload
19739 (defun org-submit-bug-report ()
19740 "Submit a bug report on Org-mode via mail.
19742 Don't hesitate to report any problems or inaccurate documentation.
19744 If you don't have setup sending mail from (X)Emacs, please copy the
19745 output buffer into your mail program, as it gives us important
19746 information about your Org-mode version and configuration."
19747 (interactive)
19748 (require 'reporter)
19749 (org-load-modules-maybe)
19750 (org-require-autoloaded-modules)
19751 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19752 (reporter-submit-bug-report
19753 "emacs-orgmode@gnu.org"
19754 (org-version nil 'full)
19755 (let (list)
19756 (save-window-excursion
19757 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19758 (delete-other-windows)
19759 (erase-buffer)
19760 (insert "You are about to submit a bug report to the Org-mode mailing list.
19762 We would like to add your full Org-mode and Outline configuration to the
19763 bug report. This greatly simplifies the work of the maintainer and
19764 other experts on the mailing list.
19766 HOWEVER, some variables you have customized may contain private
19767 information. The names of customers, colleagues, or friends, might
19768 appear in the form of file names, tags, todo states, or search strings.
19769 If you answer yes to the prompt, you might want to check and remove
19770 such private information before sending the email.")
19771 (add-text-properties (point-min) (point-max) '(face org-warning))
19772 (when (yes-or-no-p "Include your Org-mode configuration ")
19773 (mapatoms
19774 (lambda (v)
19775 (and (boundp v)
19777 (or (and (symbol-value v)
19779 (and
19780 (get v 'custom-type) (get v 'standard-value)
19781 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19782 (push v list)))))
19783 (kill-buffer (get-buffer "*Warn about privacy*"))
19784 list))
19785 nil nil
19786 "Remember to cover the basics, that is, what you expected to happen and
19787 what in fact did happen. You don't know how to make a good report? See
19789 http://orgmode.org/manual/Feedback.html#Feedback
19791 Your bug report will be posted to the Org-mode mailing list.
19792 ------------------------------------------------------------------------")
19793 (save-excursion
19798 (defun org-install-agenda-files-menu ()
19799 (let ((bl (buffer-list)))
19800 (save-excursion
19801 (while bl
19802 (set-buffer (pop bl))
19803 (if (derived-mode-p 'org-mode) (setq bl nil)))
19804 (when (derived-mode-p 'org-mode)
19805 (easy-menu-change
19806 '("Org") "File List for Agenda"
19807 (append
19808 (list
19809 ["Edit File List" (org-edit-agenda-file-list) t]
19810 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19811 ["Remove Current File from List" org-remove-file t]
19812 ["Cycle through agenda files" org-cycle-agenda-files t]
19813 ["Occur in all agenda files" org-occur-in-agenda-files t]
19814 "--")
19815 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19817 ;;;; Documentation
19819 (defun org-require-autoloaded-modules ()
19820 (interactive)
19821 (mapc 'require
19822 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19823 org-docbook org-exp org-html org-icalendar
19824 org-id org-latex
19825 org-publish org-remember org-table
19826 org-timer org-xoxo)))
19828 ;;;###autoload
19829 (defun org-reload (&optional uncompiled)
19830 "Reload all org lisp files.
19831 With prefix arg UNCOMPILED, load the uncompiled versions."
19832 (interactive "P")
19833 (require 'find-func)
19835 (dir-org (file-name-directory (org-find-library-dir "org")))
19836 (dir-org-contrib (ignore-errors
19837 (file-name-directory
19838 (org-find-library-dir "org-contribdir"))))
19839 (babel-files
19840 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19841 (append (list nil "comint" "eval" "exp" "keys"
19842 "lob" "ref" "table" "tangle")
19843 (delq nil
19844 (mapcar
19845 (lambda (lang)
19846 (when (cdr lang) (symbol-name (car lang))))
19847 org-babel-load-languages)))))
19848 (files
19849 (append babel-files
19850 (and dir-org-contrib
19851 (directory-files dir-org-contrib t file-re))
19852 (directory-files dir-org t file-re)))
19853 (remove-re (concat (if (featurep 'xemacs)
19854 "org-colview" "org-colview-xemacs")
19856 (setq files (mapcar 'file-name-sans-extension files))
19857 (setq files (mapcar
19858 (lambda (x) (if (string-match remove-re x) nil x))
19859 files))
19860 (setq files (delq nil files))
19861 (mapc
19862 (lambda (f)
19863 (when (featurep (intern (file-name-nondirectory f)))
19864 (if (and (not uncompiled)
19865 (file-exists-p (concat f ".elc")))
19866 (load (concat f ".elc") nil nil 'nosuffix)
19867 (load (concat f ".el") nil nil 'nosuffix))))
19868 files)
19869 (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
19870 (org-version nil 'full 'message))
19872 ;;;###autoload
19873 (defun org-customize ()
19874 "Call the customize function with org as argument."
19875 (interactive)
19876 (org-load-modules-maybe)
19877 (org-require-autoloaded-modules)
19878 (customize-browse 'org))
19880 (defun org-create-customize-menu ()
19881 "Create a full customization menu for Org-mode, insert it into the menu."
19882 (interactive)
19883 (org-load-modules-maybe)
19884 (org-require-autoloaded-modules)
19885 (if (fboundp 'customize-menu-create)
19886 (progn
19887 (easy-menu-change
19888 '("Org") "Customize"
19889 `(["Browse Org group" org-customize t]
19890 "--"
19891 ,(customize-menu-create 'org)
19892 ["Set" Custom-set t]
19893 ["Save" Custom-save t]
19894 ["Reset to Current" Custom-reset-current t]
19895 ["Reset to Saved" Custom-reset-saved t]
19896 ["Reset to Standard Settings" Custom-reset-standard t]))
19898 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19900 ;;;; Miscellaneous stuff
19902 ;;; Generally useful functions
19904 (defun org-get-at-bol (property)
19905 "Get text property PROPERTY at beginning of line."
19906 (get-text-property (point-at-bol) property))
19908 (defun org-find-text-property-in-string (prop s)
19909 "Return the first non-nil value of property PROP in string S."
19910 (or (get-text-property 0 prop s)
19911 (get-text-property (or (next-single-property-change 0 prop s) 0)
19912 prop s)))
19914 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19915 "Display the given MESSAGE as a warning."
19916 (if (fboundp 'display-warning)
19917 (display-warning 'org message
19918 (if (featurep 'xemacs) 'warning :warning))
19919 (let ((buf (get-buffer-create "*Org warnings*")))
19920 (with-current-buffer buf
19921 (goto-char (point-max))
19922 (insert "Warning (Org): " message)
19923 (unless (bolp)
19924 (newline)))
19925 (display-buffer buf)
19926 (sit-for 0))))
19928 (defun org-eval (form)
19929 "Eval FORM and return result."
19930 (condition-case error
19931 (eval form)
19932 (error (format "%%![Error: %s]" error))))
19934 (defun org-in-clocktable-p ()
19935 "Check if the cursor is in a clocktable."
19936 (let ((pos (point)) start)
19937 (save-excursion
19938 (end-of-line 1)
19940 (setq start (match-beginning 0))
19942 (>= (match-end 0) pos)
19943 start))))
19945 (defun org-in-commented-line ()
19946 "Is point in a line starting with `#'?"
19947 (equal (char-after (point-at-bol)) ?#))
19949 (defun org-in-indented-comment-line ()
19950 "Is point in a line starting with `#' after some white space?"
19951 (save-excursion
19952 (save-match-data
19953 (goto-char (point-at-bol))
19956 (defun org-in-verbatim-emphasis ()
19957 (save-match-data
19958 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19960 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19961 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19962 (if (and marker (marker-buffer marker)
19963 (buffer-live-p (marker-buffer marker)))
19964 (progn
19965 (org-pop-to-buffer-same-window (marker-buffer marker))
19966 (if (or (> marker (point-max)) (< marker (point-min)))
19967 (widen))
19968 (goto-char marker)
19969 (org-show-context 'org-goto))
19970 (if bookmark
19971 (bookmark-jump bookmark)
19972 (error "Cannot find location"))))
19974 (defun org-quote-csv-field (s)
19975 "Quote field for inclusion in CSV material."
19978 s))
19980 (defun org-force-self-insert (N)
19981 "Needed to enforce self-insert under remapping."
19982 (interactive "p")
19983 (self-insert-command N))
19985 (defun org-string-width (s)
19986 "Compute width of string, ignoring invisible characters.
19987 This ignores character with invisibility property `org-link', and also
19988 characters with property `org-cwidth', because these will become invisible
19989 upon the next fontification round."
19990 (let (b l)
19991 (when (or (eq t buffer-invisibility-spec)
19992 (assq 'org-link buffer-invisibility-spec))
19993 (while (setq b (text-property-any 0 (length s)
19994 'invisible 'org-link s))
19995 (setq s (concat (substring s 0 b)
19996 (substring s (or (next-single-property-change
19997 b 'invisible s) (length s)))))))
19998 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19999 (setq s (concat (substring s 0 b)
20000 (substring s (or (next-single-property-change
20001 b 'org-cwidth s) (length s))))))
20002 (setq l (string-width s) b -1)
20003 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
20004 (setq l (- l (get-text-property b 'org-dwidth-n s))))
20005 l))
20007 (defun org-shorten-string (s maxlength)
20008 "Shorten string S so tht it is no longer than MAXLENGTH characters.
20009 If the string is shorter or has length MAXLENGTH, just return the
20010 original string. If it is longer, the functions finds a space in the
20011 string, breaks this string off at that locations and adds three dots
20012 as ellipsis. Including the ellipsis, the string will not be longer
20013 than MAXLENGTH. If finding a good breaking point in the string does
20014 not work, the string is just chopped off in the middle of a word
20015 if necessary."
20016 (if (<= (length s) maxlength)
20017 s
20018 (let* ((n (max (- maxlength 4) 1))
20020 (if (string-match re s)
20021 (concat (match-string 1 s) "...")
20022 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
20024 (defun org-get-indentation (&optional line)
20025 "Get the indentation of the current line, interpreting tabs.
20026 When LINE is given, assume it represents a line and compute its indentation."
20027 (if line
20028 (if (string-match "^ *" (org-remove-tabs line))
20029 (match-end 0))
20030 (save-excursion
20031 (beginning-of-line 1)
20033 (current-column))))
20035 (defun org-get-string-indentation (s)
20036 "What indentation has S due to SPACE and TAB at the beginning of the string?"
20037 (let ((n -1) (i 0) (w tab-width) c)
20038 (catch 'exit
20039 (while (< (setq n (1+ n)) (length s))
20040 (setq c (aref s n))
20041 (cond ((= c ?\ ) (setq i (1+ i)))
20043 (t (throw 'exit t)))))
20044 i))
20046 (defun org-remove-tabs (s &optional width)
20047 "Replace tabulators in S with spaces.
20048 Assumes that s is a single line, starting in column 0."
20049 (setq width (or width tab-width))
20051 (setq s (replace-match
20052 (make-string
20053 (- (* width (/ (+ (match-beginning 0) width) width))
20054 (match-beginning 0)) ?\ )
20055 t t s)))
20056 s)
20058 (defun org-fix-indentation (line ind)
20059 "Fix indentation in LINE.
20060 IND is a cons cell with target and minimum indentation.
20061 If the current indentation in LINE is smaller than the minimum,
20062 leave it alone. If it is larger than ind, set it to the target."
20063 (let* ((l (org-remove-tabs line))
20064 (i (org-get-indentation l))
20065 (i1 (car ind)) (i2 (cdr ind)))
20066 (if (>= i i2) (setq l (substring line i2)))
20067 (if (> i1 0)
20068 (concat (make-string i1 ?\ ) l)
20069 l)))
20071 (defun org-remove-indentation (code &optional n)
20072 "Remove the maximum common indentation from the lines in CODE.
20073 N may optionally be the number of spaces to remove."
20074 (with-temp-buffer
20075 (insert code)
20076 (org-do-remove-indentation n)
20077 (buffer-string)))
20079 (defun org-do-remove-indentation (&optional n)
20080 "Remove the maximum common indentation from the buffer."
20081 (untabify (point-min) (point-max))
20082 (let ((min 10000) re)
20083 (if n
20084 (setq min n)
20085 (goto-char (point-min))
20087 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
20088 (unless (or (= min 0) (= min 10000))
20090 (goto-char (point-min))
20091 (while (re-search-forward re nil t)
20092 (replace-match "")
20093 (end-of-line 1))
20094 min)))
20096 (defun org-fill-template (template alist)
20097 "Find each %key of ALIST in TEMPLATE and replace it."
20098 (let ((case-fold-search nil)
20099 entry key value)
20100 (setq alist (sort (copy-sequence alist)
20101 (lambda (a b) (< (length (car a)) (length (car b))))))
20102 (while (setq entry (pop alist))
20103 (setq template
20104 (replace-regexp-in-string
20105 (concat "%" (regexp-quote (car entry)))
20106 (or (cdr entry) "") template t t)))
20107 template))
20109 (defun org-base-buffer (buffer)
20110 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
20111 (if (not buffer)
20112 buffer
20113 (or (buffer-base-buffer buffer)
20114 buffer)))
20116 (defun org-trim (s)
20117 "Remove whitespace at beginning and end of string."
20120 s)
20122 (defun org-wrap (string &optional width lines)
20123 "Wrap string to either a number of lines, or a width in characters.
20124 If WIDTH is non-nil, the string is wrapped to that width, however many lines
20125 that costs. If there is a word longer than WIDTH, the text is actually
20126 wrapped to the length of that word.
20127 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
20128 many lines, whatever width that takes.
20129 The return value is a list of lines, without newlines at the end."
20131 (maxword (apply 'max (mapcar 'org-string-width words)))
20132 w ll)
20133 (cond (width
20134 (org-do-wrap words (max maxword width)))
20135 (lines
20136 (setq w maxword)
20137 (setq ll (org-do-wrap words maxword))
20138 (if (<= (length ll) lines)
20139 ll
20140 (setq ll words)
20141 (while (> (length ll) lines)
20142 (setq w (1+ w))
20143 (setq ll (org-do-wrap words w)))
20144 ll))
20145 (t (error "Cannot wrap this")))))
20147 (defun org-do-wrap (words width)
20148 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
20149 (let (lines line)
20150 (while words
20151 (setq line (pop words))
20152 (while (and words (< (+ (length line) (length (car words))) width))
20153 (setq line (concat line " " (pop words))))
20154 (setq lines (push line lines)))
20155 (nreverse lines)))
20157 (defun org-split-string (string &optional separators)
20158 "Splits STRING into substrings at SEPARATORS.
20159 No empty strings are returned if there are matches at the beginning
20160 and end of string."
20162 (start 0)
20163 notfirst
20164 (list nil))
20165 (while (and (string-match rexp string
20166 (if (and notfirst
20167 (= start (match-beginning 0))
20168 (< start (length string)))
20169 (1+ start) start))
20170 (< (match-beginning 0) (length string)))
20171 (setq notfirst t)
20172 (or (eq (match-beginning 0) 0)
20173 (and (eq (match-beginning 0) (match-end 0))
20174 (eq (match-beginning 0) start))
20175 (setq list
20176 (cons (substring string start (match-beginning 0))
20177 list)))
20178 (setq start (match-end 0)))
20179 (or (eq start (length string))
20180 (setq list
20181 (cons (substring string start)
20182 list)))
20183 (nreverse list)))
20185 (defun org-quote-vert (s)
20187 (while (string-match "|" s)
20189 s)
20191 (defun org-uuidgen-p (s)
20192 "Is S an ID created by UUIDGEN?"
20193 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
20195 (defun org-in-src-block-p nil
20196 "Whether point is in a code source block."
20197 (let (ov)
20198 (when (setq ov (overlays-at (point)))
20199 (memq 'org-block-background
20200 (overlay-properties
20201 (car ov))))))
20203 (defun org-context ()
20204 "Return a list of contexts of the current cursor position.
20205 If several contexts apply, all are returned.
20206 Each context entry is a list with a symbol naming the context, and
20207 two positions indicating start and end of the context. Possible
20208 contexts are:
20210 :headline anywhere in a headline
20211 :headline-stars on the leading stars in a headline
20212 :todo-keyword on a TODO keyword (including DONE) in a headline
20213 :tags on the TAGS in a headline
20214 :priority on the priority cookie in a headline
20215 :item on the first line of a plain list item
20216 :item-bullet on the bullet/number of a plain list item
20217 :checkbox on the checkbox in a plain list item
20218 :table in an org-mode table
20219 :table-special on a special filed in a table
20220 :table-table in a table.el table
20221 :clocktable in a clocktable
20222 :src-block in a source block
20223 :link on a hyperlink
20224 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
20225 :target on a <<target>>
20226 :radio-target on a <<<radio-target>>>
20227 :latex-fragment on a LaTeX fragment
20228 :latex-preview on a LaTeX fragment with overlaid preview image
20230 This function expects the position to be visible because it uses font-lock
20231 faces as a help to recognize the following contexts: :table-special, :link,
20232 and :keyword."
20233 (let* ((f (get-text-property (point) 'face))
20234 (faces (if (listp f) f (list f)))
20235 (case-fold-search t)
20236 (p (point)) clist o)
20237 ;; First the large context
20238 (cond
20239 ((org-at-heading-p t)
20240 (push (list :headline (point-at-bol) (point-at-eol)) clist)
20241 (when (progn
20242 (beginning-of-line 1)
20243 (looking-at org-todo-line-tags-regexp))
20244 (push (org-point-in-group p 1 :headline-stars) clist)
20245 (push (org-point-in-group p 2 :todo-keyword) clist)
20246 (push (org-point-in-group p 4 :tags) clist))
20247 (goto-char p)
20250 (push (org-point-in-group p 0 :priority) clist)))
20252 ((org-at-item-p)
20253 (push (org-point-in-group p 2 :item-bullet) clist)
20254 (push (list :item (point-at-bol)
20255 (save-excursion (org-end-of-item) (point)))
20256 clist)
20257 (and (org-at-item-checkbox-p)
20258 (push (org-point-in-group p 0 :checkbox) clist)))
20260 ((org-at-table-p)
20261 (push (list :table (org-table-begin) (org-table-end)) clist)
20262 (if (memq 'org-formula faces)
20263 (push (list :table-special
20264 (previous-single-property-change p 'face)
20265 (next-single-property-change p 'face)) clist)))
20266 ((org-at-table-p 'any)
20267 (push (list :table-table) clist)))
20268 (goto-char p)
20270 (let ((case-fold-search t))
20271 ;; New the "medium" contexts: clocktables, source blocks
20272 (cond ((org-in-clocktable-p)
20273 (push (list :clocktable
20275 (search-backward "#+BEGIN: clocktable" nil t))
20276 (match-beginning 0))
20278 (match-end 0))) clist))
20279 ((org-in-src-block-p)
20280 (push (list :src-block
20282 (search-backward "#+BEGIN_SRC" nil t))
20283 (match-beginning 0))
20284 (and (search-forward "#+END_SRC" nil t)
20285 (match-beginning 0))) clist))))
20286 (goto-char p)
20288 ;; Now the small context
20289 (cond
20290 ((org-at-timestamp-p)
20291 (push (org-point-in-group p 0 :timestamp) clist))
20292 ((memq 'org-link faces)
20293 (push (list :link
20294 (previous-single-property-change p 'face)
20295 (next-single-property-change p 'face)) clist))
20296 ((memq 'org-special-keyword faces)
20297 (push (list :keyword
20298 (previous-single-property-change p 'face)
20299 (next-single-property-change p 'face)) clist))
20300 ((org-at-target-p)
20301 (push (org-point-in-group p 0 :target) clist)
20302 (goto-char (1- (match-beginning 0)))
20303 (if (looking-at org-radio-target-regexp)
20304 (push (org-point-in-group p 0 :radio-target) clist))
20305 (goto-char p))
20306 ((setq o (car (delq nil
20307 (mapcar
20308 (lambda (x)
20309 (if (memq x org-latex-fragment-image-overlays) x))
20310 (overlays-at (point))))))
20311 (push (list :latex-fragment
20312 (overlay-start o) (overlay-end o)) clist)
20313 (push (list :latex-preview
20314 (overlay-start o) (overlay-end o)) clist))
20315 ((org-inside-LaTeX-fragment-p)
20316 ;; FIXME: positions wrong.
20317 (push (list :latex-fragment (point) (point)) clist)))
20319 (setq clist (nreverse (delq nil clist)))
20320 clist))
20322 ;; FIXME: Compare with at-regexp-p Do we need both?
20323 (defun org-in-regexp (re &optional nlines visually)
20324 "Check if point is inside a match of regexp.
20325 Normally only the current line is checked, but you can include NLINES extra
20326 lines both before and after point into the search.
20327 If VISUALLY is set, require that the cursor is not after the match but
20328 really on, so that the block visually is on the match."
20329 (catch 'exit
20330 (let ((pos (point))
20331 (eol (point-at-eol (+ 1 (or nlines 0))))
20332 (inc (if visually 1 0)))
20333 (save-excursion
20334 (beginning-of-line (- 1 (or nlines 0)))
20335 (while (re-search-forward re eol t)
20336 (if (and (<= (match-beginning 0) pos)
20337 (>= (+ inc (match-end 0)) pos))
20338 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
20340 (defun org-at-regexp-p (regexp)
20341 "Is point inside a match of REGEXP in the current line?"
20342 (catch 'exit
20343 (save-excursion
20344 (let ((pos (point)) (end (point-at-eol)))
20345 (beginning-of-line 1)
20346 (while (re-search-forward regexp end t)
20347 (if (and (<= (match-beginning 0) pos)
20348 (>= (match-end 0) pos))
20349 (throw 'exit t)))
20350 nil))))
20352 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
20353 "Non-nil when point is between matches of START-RE and END-RE.
20355 Also return a non-nil value when point is on one of the matches.
20357 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
20358 buffer positions. Default values are the positions of headlines
20359 surrounding the point.
20361 The functions returns a cons cell whose car (resp. cdr) is the
20362 position before START-RE (resp. after END-RE)."
20363 (save-match-data
20364 (let ((pos (point))
20365 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
20366 (limit-down (or lim-down (save-excursion (outline-next-heading))))
20367 beg end)
20368 (save-excursion
20369 ;; Point is on a block when on START-RE or if START-RE can be
20370 ;; found before it...
20371 (and (or (org-at-regexp-p start-re)
20372 (re-search-backward start-re limit-up t))
20373 (setq beg (match-beginning 0))
20374 ;; ... and END-RE after it...
20375 (goto-char (match-end 0))
20376 (re-search-forward end-re limit-down t)
20377 (> (setq end (match-end 0)) pos)
20378 ;; ... without another START-RE in-between.
20379 (goto-char (match-beginning 0))
20380 (not (re-search-backward start-re (1+ beg) t))
20381 ;; Return value.
20382 (cons beg end))))))
20384 (defun org-in-block-p (names)
20385 "Non-nil when point belongs to a block whose name belongs to NAMES.
20387 NAMES is a list of strings containing names of blocks.
20389 Return first block name matched, or nil. Beware that in case of
20390 nested blocks, the returned name may not belong to the closest
20391 block from point."
20392 (save-match-data
20393 (catch 'exit
20394 (let ((case-fold-search t)
20395 (lim-up (save-excursion (outline-previous-heading)))
20396 (lim-down (save-excursion (outline-next-heading))))
20397 (mapc (lambda (name)
20398 (let ((n (regexp-quote name)))
20399 (when (org-between-regexps-p
20402 lim-up lim-down)
20403 (throw 'exit n))))
20404 names))
20405 nil)))
20407 (defun org-occur-in-agenda-files (regexp &optional nlines)
20408 "Call `multi-occur' with buffers for all agenda files."
20410 (let* ((files (org-agenda-files))
20411 (tnames (mapcar 'file-truename files))
20412 (extra org-agenda-text-search-extra-files)
20413 f)
20414 (when (eq (car extra) 'agenda-archives)
20415 (setq extra (cdr extra))
20416 (setq files (org-add-archive-files files)))
20417 (while (setq f (pop extra))
20418 (unless (member (file-truename f) tnames)
20419 (add-to-list 'files f 'append)
20420 (add-to-list 'tnames (file-truename f) 'append)))
20421 (multi-occur
20422 (mapcar (lambda (x)
20423 (with-current-buffer
20424 (or (get-file-buffer x) (find-file-noselect x))
20425 (widen)
20426 (current-buffer)))
20427 files)
20428 regexp)))
20430 (if (boundp 'occur-mode-find-occurrence-hook)
20431 ;; Emacs 23
20432 (add-hook 'occur-mode-find-occurrence-hook
20433 (lambda ()
20434 (when (derived-mode-p 'org-mode)
20435 (org-reveal))))
20436 ;; Emacs 22
20437 (defadvice occur-mode-goto-occurrence
20438 (after org-occur-reveal activate)
20439 (and (derived-mode-p 'org-mode) (org-reveal)))
20440 (defadvice occur-mode-goto-occurrence-other-window
20441 (after org-occur-reveal activate)
20442 (and (derived-mode-p 'org-mode) (org-reveal)))
20443 (defadvice occur-mode-display-occurrence
20444 (after org-occur-reveal activate)
20445 (when (derived-mode-p 'org-mode)
20446 (let ((pos (occur-mode-find-occurrence)))
20447 (with-current-buffer (marker-buffer pos)
20448 (save-excursion
20449 (goto-char pos)
20450 (org-reveal)))))))
20452 (defun org-occur-link-in-agenda-files ()
20453 "Create a link and search for it in the agendas.
20454 The link is not stored in `org-stored-links', it is just created
20455 for the search purpose."
20456 (interactive)
20457 (let ((link (condition-case nil
20458 (org-store-link nil)
20459 (error "Unable to create a link to here"))))
20460 (org-occur-in-agenda-files (regexp-quote link))))
20462 (defun org-uniquify (list)
20463 "Remove duplicate elements from LIST."
20464 (let (res)
20465 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
20466 res))
20468 (defun org-delete-all (elts list)
20469 "Remove all elements in ELTS from LIST."
20470 (while elts
20471 (setq list (delete (pop elts) list)))
20472 list)
20474 (defun org-count (cl-item cl-seq)
20475 "Count the number of occurrences of ITEM in SEQ.
20476 Taken from `count' in cl-seq.el with all keyword arguments removed."
20477 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
20478 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
20479 (while (< cl-start cl-end)
20480 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
20481 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
20482 (setq cl-start (1+ cl-start)))
20483 cl-count))
20485 (defun org-remove-if (predicate seq)
20486 "Remove everything from SEQ that fulfills PREDICATE."
20487 (let (res e)
20488 (while seq
20489 (setq e (pop seq))
20490 (if (not (funcall predicate e)) (push e res)))
20491 (nreverse res)))
20493 (defun org-remove-if-not (predicate seq)
20494 "Remove everything from SEQ that does not fulfill PREDICATE."
20495 (let (res e)
20496 (while seq
20497 (setq e (pop seq))
20498 (if (funcall predicate e) (push e res)))
20499 (nreverse res)))
20501 (defun org-reduce (cl-func cl-seq &rest cl-keys)
20502 "Reduce two-argument FUNCTION across SEQ.
20503 Taken from `reduce' in cl-seq.el with all keyword arguments but
20505 (let ((cl-accum (cond ((memq :initial-value cl-keys)
20506 (cadr (memq :initial-value cl-keys)))
20507 (cl-seq (pop cl-seq))
20508 (t (funcall cl-func)))))
20509 (while cl-seq
20510 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
20511 cl-accum))
20513 (defun org-back-over-empty-lines ()
20514 "Move backwards over whitespace, to the beginning of the first empty line.
20515 Returns the number of empty lines passed."
20516 (let ((pos (point)))
20517 (if (cdr (assoc 'heading org-blank-before-new-entry))
20519 (unless (eobp)
20520 (forward-line -1)))
20521 (beginning-of-line 2)
20522 (goto-char (min (point) pos))
20523 (count-lines (point) pos)))
20525 (defun org-skip-whitespace ()
20528 (defun org-point-in-group (point group &optional context)
20529 "Check if POINT is in match-group GROUP.
20530 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
20531 match. If the match group does not exist or point is not inside it,
20532 return nil."
20533 (and (match-beginning group)
20534 (>= point (match-beginning group))
20535 (<= point (match-end group))
20536 (if context
20537 (list context (match-beginning group) (match-end group))
20538 t)))
20540 (defun org-switch-to-buffer-other-window (&rest args)
20541 "Switch to buffer in a second window on the current frame.
20542 In particular, do not allow pop-up frames.
20543 Returns the newly created buffer."
20544 (let (pop-up-frames special-display-buffer-names special-display-regexps
20545 special-display-function)
20546 (apply 'switch-to-buffer-other-window args)))
20548 (defun org-combine-plists (&rest plists)
20549 "Create a single property list from all plists in PLISTS.
20550 The process starts by copying the first list, and then setting properties
20551 from the other lists. Settings in the last list are the most significant
20552 ones and overrule settings in the other lists."
20553 (let ((rtn (copy-sequence (pop plists)))
20554 p v ls)
20555 (while plists
20556 (setq ls (pop plists))
20557 (while ls
20558 (setq p (pop ls) v (pop ls))
20559 (setq rtn (plist-put rtn p v))))
20560 rtn))
20562 (defun org-replace-escapes (string table)
20563 "Replace %-escapes in STRING with values in TABLE.
20565 The sequences in STRING may contain normal field width and padding information,
20567 so values can contain further %-escapes if they are define later in TABLE."
20568 (let ((tbl (copy-alist table))
20569 (case-fold-search nil)
20570 (pchg 0)
20571 e re rpl)
20572 (while (setq e (pop tbl))
20573 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20574 (when (and (cdr e) (string-match re (cdr e)))
20575 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20576 (safe "SREF"))
20577 (add-text-properties 0 3 (list 'sref sref) safe)
20578 (setcdr e (replace-match safe t t (cdr e)))))
20579 (while (string-match re string)
20580 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20581 (cdr e)))
20582 (setq string (replace-match rpl t t string))))
20583 (while (setq pchg (next-property-change pchg string))
20584 (let ((sref (get-text-property pchg 'sref string)))
20585 (when (and sref (string-match "SREF" string pchg))
20586 (setq string (replace-match sref t t string)))))
20587 string))
20589 (defun org-sublist (list start end)
20590 "Return a section of LIST, from START to END.
20591 Counting starts at 1."
20592 (let (rtn (c start))
20593 (setq list (nthcdr (1- start) list))
20594 (while (and list (<= c end))
20595 (push (pop list) rtn)
20596 (setq c (1+ c)))
20597 (nreverse rtn)))
20599 (defun org-find-base-buffer-visiting (file)
20600 "Like `find-buffer-visiting' but always return the base buffer and
20601 not an indirect buffer."
20602 (let ((buf (or (get-file-buffer file)
20603 (find-buffer-visiting file))))
20604 (if buf
20605 (or (buffer-base-buffer buf) buf)
20606 nil)))
20608 (defun org-image-file-name-regexp (&optional extensions)
20609 "Return regexp matching the file names of images.
20610 If EXTENSIONS is given, only match these."
20611 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20612 (image-file-name-regexp)
20613 (let ((image-file-name-extensions
20614 (or extensions
20615 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20616 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20618 (regexp-opt (nconc (mapcar 'upcase
20619 image-file-name-extensions)
20620 image-file-name-extensions)
20621 t)
20624 (defun org-file-image-p (file &optional extensions)
20625 "Return non-nil if FILE is an image."
20626 (save-match-data
20627 (string-match (org-image-file-name-regexp extensions) file)))
20629 (defun org-get-cursor-date ()
20630 "Return the date at cursor in as a time.
20631 This works in the calendar and in the agenda, anywhere else it just
20632 returns the current time."
20633 (let (date day defd)
20634 (cond
20635 ((eq major-mode 'calendar-mode)
20636 (setq date (calendar-cursor-to-date)
20637 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20638 ((eq major-mode 'org-agenda-mode)
20639 (setq day (get-text-property (point) 'day))
20640 (if day
20641 (setq date (calendar-gregorian-from-absolute day)
20642 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20643 (nth 2 date))))))
20644 (or defd (current-time))))
20646 (defun org-mark-subtree (&optional up)
20647 "Mark the current subtree.
20648 This puts point at the start of the current subtree, and mark at
20649 the end. If a numeric prefix UP is given, move up into the
20650 hierarchy of headlines by UP levels before marking the subtree."
20651 (interactive "P")
20652 (org-with-limited-levels
20653 (cond ((org-at-heading-p) (beginning-of-line))
20654 ((org-before-first-heading-p) (error "Not in a subtree"))
20655 (t (outline-previous-visible-heading 1))))
20656 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
20657 (if (org-called-interactively-p 'any)
20658 (call-interactively 'org-mark-element)
20659 (org-mark-element)))
20661 ;;; Indentation
20663 (defun org-indent-line ()
20664 "Indent line depending on context."
20665 (interactive)
20666 (let* ((pos (point))
20667 (itemp (org-at-item-p))
20668 (case-fold-search t)
20670 (inline-task-p (and (featurep 'org-inlinetask)
20671 (org-inlinetask-in-task-p)))
20672 (inline-re (and inline-task-p
20673 (org-inlinetask-outline-regexp)))
20674 column)
20675 (if (and orgstruct-is-++ (eq pos (point)))
20676 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
20677 (indent-according-to-mode))
20678 (beginning-of-line 1)
20679 (cond
20680 ;; Headings
20681 ((looking-at org-outline-regexp) (setq column 0))
20682 ;; Included files
20684 ;; Footnote definition
20685 ((looking-at org-footnote-definition-re) (setq column 0))
20686 ;; Literal examples
20688 (setq column (org-get-indentation))) ; do nothing
20689 ;; Lists
20690 ((ignore-errors (goto-char (org-in-item-p)))
20691 (setq column (if itemp
20692 (org-get-indentation)
20693 (org-list-item-body-column (point))))
20694 (goto-char pos))
20695 ;; Drawers
20697 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20698 (save-excursion
20699 (goto-char (1- (match-beginning 1)))
20700 (setq column (current-column))))
20701 ;; Special blocks
20703 (save-excursion
20704 (re-search-backward
20706 (setq column (org-get-indentation (match-string 0))))
20709 (save-excursion
20711 (setq column
20712 (cond ((equal (downcase (match-string 1)) "src")
20713 ;; src blocks: let `org-edit-src-exit' handle them
20714 (org-get-indentation))
20715 ((equal (downcase (match-string 1)) "example")
20716 (max (org-get-indentation)
20717 (org-get-indentation (match-string 0))))
20718 (t
20719 (org-get-indentation (match-string 0))))))
20720 ;; This line has nothing special, look at the previous relevant
20721 ;; line to compute indentation
20722 (t
20723 (beginning-of-line 0)
20724 (while (and (not (bobp))
20725 (not (looking-at org-drawer-regexp))
20726 ;; When point started in an inline task, do not move
20727 ;; above task starting line.
20728 (not (and inline-task-p (looking-at inline-re)))
20729 ;; Skip drawers, blocks, empty lines, verbatim,
20730 ;; comments, tables, footnotes definitions, lists,
20731 ;; inline tasks.
20733 (re-search-backward org-drawer-regexp nil t))
20737 (looking-at org-footnote-definition-re)
20738 (and (ignore-errors (goto-char (org-in-item-p)))
20739 (goto-char
20740 (org-list-get-top-point (org-list-struct))))
20741 (and (not inline-task-p)
20742 (featurep 'org-inlinetask)
20743 (org-inlinetask-in-task-p)
20744 (or (org-inlinetask-goto-beginning) t))))
20745 (beginning-of-line 0))
20746 (cond
20747 ;; There was an heading above.
20749 (if (not org-adapt-indentation)
20750 (setq column 0)
20751 (goto-char (match-end 0))
20752 (setq column (current-column))))
20753 ;; A drawer had started and is unfinished
20754 ((looking-at org-drawer-regexp)
20755 (goto-char (1- (match-beginning 1)))
20756 (setq column (current-column)))
20757 ;; Else, nothing noticeable found: get indentation and go on.
20758 (t (setq column (org-get-indentation))))))
20759 ;; Now apply indentation and move cursor accordingly
20760 (goto-char pos)
20761 (if (<= (current-column) (current-indentation))
20762 (org-indent-line-to column)
20763 (save-excursion (org-indent-line-to column)))
20764 ;; Special polishing for properties, see `org-property-format'
20765 (setq column (current-column))
20766 (beginning-of-line 1)
20767 (if (looking-at
20769 (replace-match (concat (match-string 1)
20770 (format org-property-format
20771 (match-string 2) (match-string 3)))
20772 t t))
20773 (org-move-to-column column))))
20775 (defun org-indent-drawer ()
20776 "Indent the drawer at point."
20777 (interactive)
20778 (let ((p (point))
20779 (e (and (save-excursion (re-search-forward ":END:" nil t))
20780 (match-end 0)))
20781 (folded
20782 (save-excursion
20783 (end-of-line)
20784 (when (overlays-at (point))
20785 (member 'invisible (overlay-properties
20786 (car (overlays-at (point)))))))))
20787 (when folded (org-cycle))
20788 (indent-for-tab-command)
20789 (while (and (move-beginning-of-line 2) (< (point) e))
20790 (indent-for-tab-command))
20791 (goto-char p)
20792 (when folded (org-cycle)))
20793 (message "Drawer at point indented"))
20795 (defun org-indent-block ()
20796 "Indent the block at point."
20797 (interactive)
20798 (let ((p (point))
20799 (case-fold-search t)
20801 (match-end 0)))
20802 (folded
20803 (save-excursion
20804 (end-of-line)
20805 (when (overlays-at (point))
20806 (member 'invisible (overlay-properties
20807 (car (overlays-at (point)))))))))
20808 (when folded (org-cycle))
20809 (indent-for-tab-command)
20810 (while (and (move-beginning-of-line 2) (< (point) e))
20811 (indent-for-tab-command))
20812 (goto-char p)
20813 (when folded (org-cycle)))
20814 (message "Block at point indented"))
20816 (defun org-indent-region (start end)
20817 "Indent region."
20818 (interactive "r")
20819 (save-excursion
20820 (let ((line-end (org-current-line end)))
20821 (goto-char start)
20822 (while (< (org-current-line) line-end)
20823 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
20824 (t (call-interactively 'org-indent-line)))
20825 (move-beginning-of-line 2)))))
20828 ;;; Filling
20830 ;; We use our own fill-paragraph and auto-fill functions.
20832 ;; `org-fill-paragraph' relies on adaptive filling and context
20833 ;; checking. Appropriate `fill-prefix' is computed with
20834 ;; `org-adaptive-fill-function'.
20836 ;; `org-auto-fill-function' takes care of auto-filling. It calls
20837 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
20838 ;; `org-adaptive-fill-function' value. Internally,
20839 ;; `org-comment-line-break-function' breaks the line.
20841 ;; `org-setup-filling' installs filling and auto-filling related
20842 ;; variables during `org-mode' initialization.
20844 (defun org-setup-filling ()
20845 (interactive)
20846 ;; Prevent auto-fill from inserting unwanted new items.
20847 (when (boundp 'fill-nobreak-predicate)
20848 (org-set-local
20849 'fill-nobreak-predicate
20850 (org-uniquify
20851 (append fill-nobreak-predicate
20852 '(org-fill-paragraph-separate-nobreak-p
20853 org-fill-line-break-nobreak-p)))))
20854 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20855 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
20856 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20857 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
20859 (defvar org-element-paragraph-separate) ; org-element.el
20860 (defun org-fill-paragraph-separate-nobreak-p ()
20861 "Non-nil when a line break at point would insert a new item."
20862 (looking-at (substring org-element-paragraph-separate 1)))
20864 (defun org-fill-line-break-nobreak-p ()
20865 "Non-nil when a line break at point would create an Org line break."
20866 (save-excursion
20871 (declare-function message-in-body-p "message" ())
20872 (defvar org-element--affiliated-re) ; From org-element.el
20873 (defun org-adaptive-fill-function ()
20874 "Compute a fill prefix for the current line.
20875 Return fill prefix, as a string, or nil if current line isn't
20876 meant to be filled."
20877 (org-with-wide-buffer
20878 (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
20879 ;; FIXME: This is really the job of orgstruct++-mode
20880 (let* ((p (line-beginning-position))
20881 (element (save-excursion (beginning-of-line)
20882 (org-element-at-point)))
20883 (type (org-element-type element))
20884 (post-affiliated
20885 (save-excursion
20886 (goto-char (org-element-property :begin element))
20887 (while (looking-at org-element--affiliated-re) (forward-line))
20888 (point))))
20889 (unless (< p post-affiliated)
20890 (case type
20892 (footnote-definition "")
20893 ((item plain-list)
20894 (make-string (org-list-item-body-column post-affiliated) ? ))
20895 (paragraph
20896 ;; Fill prefix is usually the same as the current line,
20897 ;; except if the paragraph is at the beginning of an item.
20898 (let ((parent (org-element-property :parent element)))
20899 (cond ((eq (org-element-type parent) 'item)
20900 (make-string (org-list-item-body-column
20901 (org-element-property :begin parent))
20902 ? ))
20904 (match-string 0))
20905 (t ""))))
20906 (comment-block
20907 ;; Only fill contents if P is within block boundaries.
20908 (let* ((cbeg (save-excursion (goto-char post-affiliated)
20909 (forward-line)
20910 (point)))
20911 (cend (save-excursion
20912 (goto-char (org-element-property :end element))
20914 (line-beginning-position))))
20915 (when (and (>= p cbeg) (< p cend))
20917 (match-string 0)
20918 ""))))))))))
20920 (declare-function message-goto-body "message" ())
20921 (defvar message-cite-prefix-regexp) ; From message.el
20922 (defvar org-element-all-objects) ; From org-element.el
20923 (defun org-fill-paragraph (&optional justify)
20924 "Fill element at point, when applicable.
20926 This function only applies to comment blocks, comments, example
20927 blocks and paragraphs. Also, as a special case, re-align table
20928 when point is at one.
20930 If JUSTIFY is non-nil (interactively, with prefix argument),
20931 justify as well. If `sentence-end-double-space' is non-nil, then
20932 period followed by one space does not end a sentence, so don't
20933 break a line there. The variable `fill-column' controls the
20934 width for filling.
20936 For convenience, when point is at a plain list, an item or
20937 a footnote definition, try to fill the first paragraph within."
20938 ;; Falls back on message-fill-paragraph when necessary
20939 (interactive)
20940 (if (and (derived-mode-p 'message-mode)
20941 (or (not (message-in-body-p))
20942 (save-excursion (move-beginning-of-line 1)
20943 (looking-at message-cite-prefix-regexp))))
20944 (let ((fill-paragraph-function
20945 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
20946 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
20947 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
20948 (paragraph-separate
20949 (cadadr (assoc 'paragraph-separate org-fb-vars))))
20950 (fill-paragraph nil))
20951 (save-excursion
20952 ;; Move to end of line in order to get the first paragraph
20953 ;; within a plain list or a footnote definition.
20954 (end-of-line)
20955 (let ((element (org-element-at-point)))
20956 ;; First check if point is in a blank line at the beginning of
20957 ;; the buffer. In that case, ignore filling.
20958 (if (< (point) (org-element-property :begin element)) t
20959 (case (org-element-type element)
20960 ;; Align Org tables, leave table.el tables as-is.
20961 (table-row (org-table-align) t)
20962 (table
20963 (when (eq (org-element-property :type element) 'org)
20964 (org-table-align))
20965 t)
20966 (paragraph
20967 ;; Paragraphs may contain `line-break' type objects.
20968 (let ((beg (max (point-min)
20969 (org-element-property :contents-begin element)))
20970 (end (min (point-max)
20971 (org-element-property :contents-end element))))
20972 ;; Do nothing if point is at an affiliated keyword.
20973 (if (< (point) beg) t
20974 (when (derived-mode-p 'message-mode)
20975 ;; In `message-mode', do not fill following
20976 ;; citation in current paragraph nor text before
20977 ;; message body.
20978 (let ((body-start (save-excursion (message-goto-body))))
20979 (when body-start (setq beg (max body-start beg))))
20980 (when (save-excursion
20981 (re-search-forward
20982 (concat "^" message-cite-prefix-regexp) end t))
20983 (setq end (match-beginning 0))))
20984 ;; Fill paragraph, taking line breaks into
20985 ;; consideration. For that, slice the paragraph
20986 ;; using line breaks as separators, and fill the
20987 ;; parts in reverse order to avoid messing with
20988 ;; markers.
20989 (save-excursion
20990 (goto-char end)
20991 (mapc
20992 (lambda (pos)
20993 (fill-region-as-paragraph pos (point) justify)
20994 (goto-char pos))
20995 ;; Find the list of ending positions for line
20996 ;; breaks in the current paragraph. Add paragraph
20997 ;; beginning to include first slice.
20998 (nreverse
20999 (cons
21000 beg
21001 (org-element-map
21002 (org-element--parse-objects
21003 beg end nil org-element-all-objects)
21004 'line-break
21005 (lambda (lb) (org-element-property :end lb)))))))
21006 t)))
21007 ;; Contents of `comment-block' type elements should be
21008 ;; filled as plain text, but only if point is within block
21009 ;; markers.
21010 (comment-block
21011 (let* ((case-fold-search t)
21012 (beg (save-excursion
21013 (goto-char (org-element-property :begin element))
21015 (forward-line)
21016 (point)))
21017 (end (save-excursion
21018 (goto-char (org-element-property :end element))
21020 (line-beginning-position))))
21021 (when (and (>= (point) beg) (< (point) end))
21022 (fill-region-as-paragraph
21023 (save-excursion
21024 (end-of-line)
21026 (line-beginning-position))
21027 (save-excursion
21028 (beginning-of-line)
21030 (line-beginning-position))
21031 justify)))
21032 t)
21033 ;; Fill comments.
21034 (comment (fill-comment-paragraph justify))
21035 ;; Ignore every other element.
21036 (otherwise t)))))))
21038 (defun org-auto-fill-function ()
21039 "Auto-fill function."
21040 ;; Check if auto-filling is meaningful.
21041 (let ((fc (current-fill-column)))
21042 (when (and fc (> (current-column) fc))
21043 (let ((fill-prefix (org-adaptive-fill-function)))
21044 (when fill-prefix (do-auto-fill))))))
21046 (defun org-comment-line-break-function (&optional soft)
21047 "Break line at point and indent, continuing comment if within one.
21048 The inserted newline is marked hard if variable
21049 `use-hard-newlines' is true, unless optional argument SOFT is
21050 non-nil."
21052 (save-excursion (forward-char -1) (delete-horizontal-space))
21053 (delete-horizontal-space)
21054 (indent-to-left-margin)
21055 (insert-before-markers-and-inherit fill-prefix))
21058 ;;; Comments
21060 ;; Org comments syntax is quite complex. It requires the entire line
21061 ;; to be just a comment. Also, even with the right syntax at the
21062 ;; beginning of line, some some elements (i.e. verse-block or
21063 ;; example-block) don't accept comments. Usual Emacs comment commands
21064 ;; cannot cope with those requirements. Therefore, Org replaces them.
21066 ;; Org still relies on `comment-dwim', but cannot trust
21067 ;; `comment-only-p'. So, `comment-region-function' and
21068 ;; `uncomment-region-function' both point
21069 ;; to`org-comment-or-uncomment-region'. Eventually,
21070 ;; `org-insert-comment' takes care of insertion of comments at the
21071 ;; beginning of line.
21073 ;; `org-setup-comments-handling' install comments related variables
21074 ;; during `org-mode' initialization.
21076 (defun org-setup-comments-handling ()
21077 (interactive)
21078 (org-set-local 'comment-use-syntax nil)
21079 (org-set-local 'comment-start "# ")
21081 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
21082 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
21083 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
21085 (defun org-insert-comment ()
21086 "Insert an empty comment above current line.
21087 If the line is empty, insert comment at its beginning."
21088 (beginning-of-line)
21090 (org-indent-line)
21091 (insert "# "))
21093 (defvar comment-empty-lines) ; From newcomment.el.
21094 (defun org-comment-or-uncomment-region (beg end &rest ignore)
21095 "Comment or uncomment each non-blank line in the region.
21096 Uncomment each non-blank line between BEG and END if it only
21097 contains commented lines. Otherwise, comment them."
21098 (save-restriction
21099 ;; Restrict region
21100 (narrow-to-region (save-excursion (goto-char beg)
21102 (line-beginning-position))
21103 (save-excursion (goto-char end)
21105 (line-end-position)))
21106 (let ((uncommentp
21107 ;; UNCOMMENTP is non-nil when every non blank line between
21108 ;; BEG and END is a comment.
21109 (save-excursion
21110 (goto-char (point-min))
21111 (while (and (not (eobp))
21112 (let ((element (org-element-at-point)))
21113 (and (eq (org-element-type element) 'comment)
21114 (goto-char (min (point-max)
21115 (org-element-property
21116 :end element)))))))
21117 (eobp))))
21118 (if uncommentp
21119 ;; Only blank lines and comments in region: uncomment it.
21120 (save-excursion
21121 (goto-char (point-min))
21122 (while (not (eobp))
21124 (replace-match "" nil nil nil 1))
21125 (forward-line)))
21126 ;; Comment each line in region.
21127 (let ((min-indent (point-max)))
21128 ;; First find the minimum indentation across all lines.
21129 (save-excursion
21130 (goto-char (point-min))
21131 (while (and (not (eobp)) (not (zerop min-indent)))
21133 (setq min-indent (min min-indent (current-indentation))))
21134 (forward-line)))
21135 ;; Then loop over all lines.
21136 (save-excursion
21137 (goto-char (point-min))
21138 (while (not (eobp))
21140 (org-move-to-column min-indent t)
21141 (insert comment-start))
21142 (forward-line))))))))
21145 ;;; Other stuff.
21147 (defun org-toggle-fixed-width-section (arg)
21148 "Toggle the fixed-width export.
21149 If there is no active region, the QUOTE keyword at the current headline is
21150 inserted or removed. When present, it causes the text between this headline
21151 and the next to be exported as fixed-width text, and unmodified.
21152 If there is an active region, this command adds or removes a colon as the
21153 first character of this line. If the first character of a line is a colon,
21154 this line is also exported in fixed-width font."
21155 (interactive "P")
21156 (let* ((cc 0)
21157 (regionp (org-region-active-p))
21158 (beg (if regionp (region-beginning) (point)))
21159 (end (if regionp (region-end)))
21160 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
21161 (case-fold-search nil)
21163 off)
21164 (if regionp
21165 (save-excursion
21166 (goto-char beg)
21167 (setq cc (current-column))
21168 (beginning-of-line 1)
21169 (setq off (looking-at re))
21170 (while (> nlines 0)
21171 (setq nlines (1- nlines))
21172 (beginning-of-line 1)
21173 (cond
21174 (arg
21175 (org-move-to-column cc t)
21177 (forward-line -1))
21178 ((and off (looking-at re))
21179 (replace-match "" t t nil 1))
21180 ((not off) (org-move-to-column cc t) (insert ": ")))
21181 (forward-line 1)))
21182 (save-excursion
21183 (org-back-to-heading)
21184 (cond
21185 ((looking-at (format org-heading-keyword-regexp-format
21186 org-quote-string))
21187 (goto-char (match-end 1))
21188 (looking-at (concat " +" org-quote-string))
21189 (replace-match "" t t)
21190 (when (eolp) (insert " ")))
21191 ((looking-at org-outline-regexp)
21192 (goto-char (match-end 0))
21193 (insert org-quote-string " ")))))))
21195 (defun org-reftex-citation ()
21196 "Use reftex-citation to insert a citation into the buffer.
21197 This looks for a line like
21199 #+BIBLIOGRAPHY: foo plain option:-d
21201 and derives from it that foo.bib is the bibliography file relevant
21202 for this document. It then installs the necessary environment for RefTeX
21203 to work in this buffer and calls `reftex-citation' to insert a citation
21204 into the buffer.
21206 Export of such citations to both LaTeX and HTML is handled by the contributed
21207 package org-exp-bibtex by Taru Karttunen."
21208 (interactive)
21209 (let ((reftex-docstruct-symbol 'rds)
21211 rds bib)
21212 (save-excursion
21213 (save-restriction
21214 (widen)
21215 (let ((case-fold-search t)
21217 (if (not (save-excursion
21218 (or (re-search-forward re nil t)
21219 (re-search-backward re nil t))))
21220 (error "No bibliography defined in file")
21221 (setq bib (concat (match-string 1) ".bib")
21222 rds (list (list 'bib bib)))))))
21223 (call-interactively 'reftex-citation)))
21225 ;;;; Functions extending outline functionality
21227 (defun org-beginning-of-line (&optional arg)
21228 "Go to the beginning of the current line. If that is invisible, continue
21229 to a visible line beginning. This makes the function of C-a more intuitive.
21230 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
21231 first attempt, and only move to after the tags when the cursor is already
21232 beyond the end of the headline."
21233 (interactive "P")
21234 (let ((pos (point))
21235 (special (if (consp org-special-ctrl-a/e)
21236 (car org-special-ctrl-a/e)
21237 org-special-ctrl-a/e))
21238 refpos)
21239 (if (org-bound-and-true-p line-move-visual)
21240 (beginning-of-visual-line 1)
21241 (beginning-of-line 1))
21242 (if (and arg (fboundp 'move-beginning-of-line))
21243 (call-interactively 'move-beginning-of-line)
21244 (if (bobp)
21245 nil
21246 (backward-char 1)
21247 (if (org-truely-invisible-p)
21248 (while (and (not (bobp)) (org-truely-invisible-p))
21249 (backward-char 1)
21250 (beginning-of-line 1))
21251 (forward-char 1))))
21252 (when special
21253 (cond
21254 ((and (looking-at org-complex-heading-regexp)
21255 (= (char-after (match-end 1)) ?\ ))
21256 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
21257 (point-at-eol)))
21258 (goto-char
21259 (if (eq special t)
21260 (cond ((> pos refpos) refpos)
21261 ((= pos (point)) refpos)
21262 (t (point)))
21263 (cond ((> pos (point)) (point))
21264 ((not (eq last-command this-command)) (point))
21265 (t refpos)))))
21266 ((org-at-item-p)
21267 ;; Being at an item and not looking at an the item means point
21268 ;; was previously moved to beginning of a visual line, which
21269 ;; doesn't contain the item. Therefore, do nothing special,
21270 ;; just stay here.
21271 (when (looking-at org-list-full-item-re)
21272 ;; Set special position at first white space character after
21273 ;; bullet, and check-box, if any.
21274 (let ((after-bullet
21275 (let ((box (match-end 3)))
21276 (if (not box) (match-end 1)
21277 (let ((after (char-after box)))
21278 (if (and after (= after ? )) (1+ box) box))))))
21279 ;; Special case: Move point to special position when
21280 ;; currently after it or at beginning of line.
21281 (if (eq special t)
21282 (when (or (> pos after-bullet) (= (point) pos))
21283 (goto-char after-bullet))
21284 ;; Reversed case: Move point to special position when
21285 ;; point was already at beginning of line and command is
21286 ;; repeated.
21287 (when (and (= (point) pos) (eq last-command this-command))
21288 (goto-char after-bullet))))))))
21289 (org-no-warnings
21290 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21292 (defun org-end-of-line (&optional arg)
21293 "Go to the end of the line.
21294 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
21295 first attempt, and only move to after the tags when the cursor is already
21296 beyond the end of the headline."
21297 (interactive "P")
21298 (let ((special (if (consp org-special-ctrl-a/e)
21299 (cdr org-special-ctrl-a/e)
21300 org-special-ctrl-a/e)))
21301 (cond
21302 ((or (not special) arg
21303 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
21304 (call-interactively
21305 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
21306 ((fboundp 'move-end-of-line) 'move-end-of-line)
21307 (t 'end-of-line))))
21308 ((org-at-heading-p)
21309 (let ((pos (point)))
21310 (beginning-of-line 1)
21312 (if (eq special t)
21313 (if (or (< pos (match-beginning 1))
21314 (= pos (match-end 0)))
21315 (goto-char (match-beginning 1))
21316 (goto-char (match-end 0)))
21317 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
21318 (goto-char (match-end 0))
21319 (goto-char (match-beginning 1))))
21320 (call-interactively (if (fboundp 'move-end-of-line)
21321 'move-end-of-line
21322 'end-of-line)))))
21323 ((org-at-drawer-p)
21324 (move-end-of-line 1)
21325 (when (overlays-at (1- (point))) (backward-char 1)))
21326 ;; At an item: Move before any hidden text.
21327 (t (call-interactively
21328 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
21329 ((fboundp 'move-end-of-line) 'move-end-of-line)
21330 (t 'end-of-line)))))
21331 (org-no-warnings
21332 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21334 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
21335 (define-key org-mode-map "\C-e" 'org-end-of-line)
21337 (defun org-backward-sentence (&optional arg)
21338 "Go to beginning of sentence, or beginning of table field.
21339 This will call `backward-sentence' or `org-table-beginning-of-field',
21340 depending on context."
21341 (interactive "P")
21342 (cond
21343 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
21344 (t (call-interactively 'backward-sentence))))
21346 (defun org-forward-sentence (&optional arg)
21347 "Go to end of sentence, or end of table field.
21348 This will call `forward-sentence' or `org-table-end-of-field',
21349 depending on context."
21350 (interactive "P")
21351 (cond
21352 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
21353 (t (call-interactively 'forward-sentence))))
21355 (define-key org-mode-map "\M-a" 'org-backward-sentence)
21356 (define-key org-mode-map "\M-e" 'org-forward-sentence)
21358 (defun org-kill-line (&optional arg)
21359 "Kill line, to tags or end of line."
21360 (interactive "P")
21361 (cond
21362 ((or (not org-special-ctrl-k)
21363 (bolp)
21364 (not (org-at-heading-p)))
21365 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
21366 org-ctrl-k-protect-subtree)
21367 (if (or (eq org-ctrl-k-protect-subtree 'error)
21368 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
21369 (error "C-k aborted - would kill hidden subtree")))
21370 (call-interactively
21371 (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
21373 (kill-region (point) (match-beginning 1))
21374 (org-set-tags nil t))
21375 (t (kill-region (point) (point-at-eol)))))
21377 (define-key org-mode-map "\C-k" 'org-kill-line)
21379 (defun org-yank (&optional arg)
21380 "Yank. If the kill is a subtree, treat it specially.
21381 This command will look at the current kill and check if is a single
21382 subtree, or a series of subtrees[1]. If it passes the test, and if the
21383 cursor is at the beginning of a line or after the stars of a currently
21384 empty headline, then the yank is handled specially. How exactly depends
21385 on the value of the following variables, both set by default.
21387 org-yank-folded-subtrees
21388 When set, the subtree(s) will be folded after insertion, but only
21389 if doing so would now swallow text after the yanked text.
21391 org-yank-adjusted-subtrees
21392 When set, the subtree will be promoted or demoted in order to
21393 fit into the local outline tree structure, which means that the level
21394 will be adjusted so that it becomes the smaller one of the two
21395 *visible* surrounding headings.
21397 Any prefix to this command will cause `yank' to be called directly with
21399 will just
21400 plainly yank the text as it is.
21402 \[1] The test checks if the first non-white line is a heading
21403 and if there are no other headings with fewer stars."
21404 (interactive "P")
21405 (org-yank-generic 'yank arg))
21407 (defun org-yank-generic (command arg)
21408 "Perform some yank-like command.
21410 This function implements the behavior described in the `org-yank'
21411 documentation. However, it has been generalized to work for any
21412 interactive command with similar behavior."
21414 ;; pretend to be command COMMAND
21415 (setq this-command command)
21417 (if arg
21418 (call-interactively command)
21420 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
21421 (and (org-kill-is-subtree-p)
21422 (or (bolp)
21424 (string-match
21426 (buffer-substring (point-at-bol) (point)))))))
21427 swallowp)
21428 (cond
21429 ((and subtreep org-yank-folded-subtrees)
21430 (let ((beg (point))
21431 end)
21432 (if (and subtreep org-yank-adjusted-subtrees)
21433 (org-paste-subtree nil nil 'for-yank)
21434 (call-interactively command))
21436 (setq end (point))
21437 (goto-char beg)
21438 (when (and (bolp) subtreep
21439 (not (setq swallowp
21440 (org-yank-folding-would-swallow-text beg end))))
21441 (org-with-limited-levels
21442 (or (looking-at org-outline-regexp)
21443 (re-search-forward org-outline-regexp-bol end t))
21444 (while (and (< (point) end) (looking-at org-outline-regexp))
21445 (hide-subtree)
21446 (org-cycle-show-empty-lines 'folded)
21447 (condition-case nil
21448 (outline-forward-same-level 1)
21449 (error (goto-char end))))))
21450 (when swallowp
21451 (message
21452 "Inserted text not folded because that would swallow text"))
21454 (goto-char end)
21456 (beginning-of-line 1)
21457 (push-mark beg 'nomsg)))
21458 ((and subtreep org-yank-adjusted-subtrees)
21459 (let ((beg (point-at-bol)))
21460 (org-paste-subtree nil nil 'for-yank)
21461 (push-mark beg 'nomsg)))
21462 (t
21463 (call-interactively command))))))
21465 (defun org-yank-folding-would-swallow-text (beg end)
21466 "Would hide-subtree at BEG swallow any text after END?"
21467 (let (level)
21468 (org-with-limited-levels
21469 (save-excursion
21470 (goto-char beg)
21471 (when (or (looking-at org-outline-regexp)
21472 (re-search-forward org-outline-regexp-bol end t))
21473 (setq level (org-outline-level)))
21474 (goto-char end)
21476 (if (or (eobp)
21477 (and (bolp) (looking-at org-outline-regexp)
21478 (<= (org-outline-level) level)))
21479 nil ; Nothing would be swallowed
21480 t))))) ; something would swallow
21482 (define-key org-mode-map "\C-y" 'org-yank)
21484 (defun org-truely-invisible-p ()
21485 "Check if point is at a character currently not visible.
21486 This version does not only check the character property, but also
21487 `visible-mode'."
21488 ;; Early versions of noutline don't have `outline-invisible-p'.
21489 (if (org-bound-and-true-p visible-mode)
21490 nil
21491 (outline-invisible-p)))
21493 (defun org-invisible-p2 ()
21494 "Check if point is at a character currently not visible."
21495 (save-excursion
21496 (if (and (eolp) (not (bobp))) (backward-char 1))
21497 ;; Early versions of noutline don't have `outline-invisible-p'.
21498 (outline-invisible-p)))
21500 (defun org-back-to-heading (&optional invisible-ok)
21501 "Call `outline-back-to-heading', but provide a better error message."
21502 (condition-case nil
21503 (outline-back-to-heading invisible-ok)
21504 (error (error "Before first headline at position %d in buffer %s"
21505 (point) (current-buffer)))))
21507 (defun org-before-first-heading-p ()
21508 "Before first heading?"
21509 (save-excursion
21510 (end-of-line)
21511 (null (re-search-backward org-outline-regexp-bol nil t))))
21513 (defun org-at-heading-p (&optional ignored)
21514 (outline-on-heading-p t))
21515 ;; Compatibility alias with Org versions < 7.8.03
21516 (defalias 'org-on-heading-p 'org-at-heading-p)
21518 (defun org-at-comment-p nil
21519 "Is cursor in a line starting with a # character?"
21520 (save-excursion
21521 (beginning-of-line)
21522 (looking-at "^#")))
21524 (defun org-at-drawer-p nil
21525 "Is cursor at a drawer keyword?"
21526 (save-excursion
21527 (move-beginning-of-line 1)
21528 (looking-at org-drawer-regexp)))
21530 (defun org-at-block-p nil
21531 "Is cursor at a block keyword?"
21532 (save-excursion
21533 (move-beginning-of-line 1)
21534 (looking-at org-block-regexp)))
21536 (defun org-point-at-end-of-empty-headline ()
21537 "If point is at the end of an empty headline, return t, else nil.
21538 If the heading only contains a TODO keyword, it is still still considered
21539 empty."
21541 (when org-todo-line-regexp
21542 (save-excursion
21543 (beginning-of-line 1)
21544 (let ((case-fold-search nil))
21545 (looking-at org-todo-line-regexp)
21546 (string= (match-string 3) ""))))))
21548 (defun org-at-heading-or-item-p ()
21549 (or (org-at-heading-p) (org-at-item-p)))
21551 (defun org-at-target-p ()
21552 (or (org-in-regexp org-radio-target-regexp)
21553 (org-in-regexp org-target-regexp)))
21554 ;; Compatibility alias with Org versions < 7.8.03
21555 (defalias 'org-on-target-p 'org-at-target-p)
21557 (defun org-up-heading-all (arg)
21558 "Move to the heading line of which the present line is a subheading.
21559 This function considers both visible and invisible heading lines.
21560 With argument, move up ARG levels."
21561 (if (fboundp 'outline-up-heading-all)
21562 (outline-up-heading-all arg) ; emacs 21 version of outline.el
21563 (outline-up-heading arg t))) ; emacs 22 version of outline.el
21565 (defun org-up-heading-safe ()
21566 "Move to the heading line of which the present line is a subheading.
21567 This version will not throw an error. It will return the level of the
21568 headline found, or nil if no higher level is found.
21570 Also, this function will be a lot faster than `outline-up-heading',
21571 because it relies on stars being the outline starters. This can really
21572 make a significant difference in outlines with very many siblings."
21573 (let (start-level re)
21574 (org-back-to-heading t)
21575 (setq start-level (funcall outline-level))
21576 (if (equal start-level 1)
21577 nil
21579 (if (re-search-backward re nil t)
21580 (funcall outline-level)))))
21582 (defun org-first-sibling-p ()
21583 "Is this heading the first child of its parents?"
21584 (interactive)
21585 (let ((re org-outline-regexp-bol)
21586 level l)
21587 (unless (org-at-heading-p t)
21588 (error "Not at a heading"))
21589 (setq level (funcall outline-level))
21590 (save-excursion
21591 (if (not (re-search-backward re nil t))
21592 t
21593 (setq l (funcall outline-level))
21594 (< l level)))))
21596 (defun org-goto-sibling (&optional previous)
21597 "Goto the next sibling, even if it is invisible.
21598 When PREVIOUS is set, go to the previous sibling instead. Returns t
21599 when a sibling was found. When none is found, return nil and don't
21600 move point."
21601 (let ((fun (if previous 're-search-backward 're-search-forward))
21602 (pos (point))
21603 (re org-outline-regexp-bol)
21604 level l)
21605 (when (condition-case nil (org-back-to-heading t) (error nil))
21606 (setq level (funcall outline-level))
21607 (catch 'exit
21608 (or previous (forward-char 1))
21609 (while (funcall fun re nil t)
21610 (setq l (funcall outline-level))
21611 (when (< l level) (goto-char pos) (throw 'exit nil))
21612 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
21613 (goto-char pos)
21614 nil))))
21616 (defun org-show-siblings ()
21617 "Show all siblings of the current headline."
21618 (save-excursion
21619 (while (org-goto-sibling) (org-flag-heading nil)))
21620 (save-excursion
21621 (while (org-goto-sibling 'previous)
21622 (org-flag-heading nil))))
21624 (defun org-goto-first-child ()
21625 "Goto the first child, even if it is invisible.
21626 Return t when a child was found. Otherwise don't move point and
21627 return nil."
21628 (let (level (pos (point)) (re org-outline-regexp-bol))
21629 (when (condition-case nil (org-back-to-heading t) (error nil))
21630 (setq level (outline-level))
21631 (forward-char 1)
21632 (if (and (re-search-forward re nil t) (> (outline-level) level))
21633 (progn (goto-char (match-beginning 0)) t)
21634 (goto-char pos) nil))))
21636 (defun org-show-hidden-entry ()
21637 "Show an entry where even the heading is hidden."
21638 (save-excursion
21639 (org-show-entry)))
21641 (defun org-flag-heading (flag &optional entry)
21642 "Flag the current heading. FLAG non-nil means make invisible.
21643 When ENTRY is non-nil, show the entire entry."
21644 (save-excursion
21645 (org-back-to-heading t)
21646 ;; Check if we should show the entire entry
21647 (if entry
21648 (progn
21649 (org-show-entry)
21650 (save-excursion
21651 (and (outline-next-heading)
21652 (org-flag-heading nil))))
21653 (outline-flag-region (max (point-min) (1- (point)))
21654 (save-excursion (outline-end-of-heading) (point))
21655 flag))))
21657 (defun org-get-next-sibling ()
21658 "Move to next heading of the same level, and return point.
21659 If there is no such heading, return nil.
21660 This is like outline-next-sibling, but invisible headings are ok."
21661 (let ((level (funcall outline-level)))
21662 (outline-next-heading)
21663 (while (and (not (eobp)) (> (funcall outline-level) level))
21664 (outline-next-heading))
21665 (if (or (eobp) (< (funcall outline-level) level))
21666 nil
21667 (point))))
21669 (defun org-get-last-sibling ()
21670 "Move to previous heading of the same level, and return point.
21671 If there is no such heading, return nil."
21672 (let ((opoint (point))
21673 (level (funcall outline-level)))
21674 (outline-previous-heading)
21675 (when (and (/= (point) opoint) (outline-on-heading-p t))
21676 (while (and (> (funcall outline-level) level)
21677 (not (bobp)))
21678 (outline-previous-heading))
21679 (if (< (funcall outline-level) level)
21680 nil
21681 (point)))))
21683 (defun org-end-of-subtree (&optional invisible-ok to-heading)
21684 "Goto to the end of a subtree."
21685 ;; This contains an exact copy of the original function, but it uses
21686 ;; `org-back-to-heading', to make it work also in invisible
21687 ;; trees. And is uses an invisible-ok argument.
21688 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21689 ;; Furthermore, when used inside Org, finding the end of a large subtree
21690 ;; with many children and grandchildren etc, this can be much faster
21691 ;; than the outline version.
21692 (org-back-to-heading invisible-ok)
21693 (let ((first t)
21694 (level (funcall outline-level)))
21695 (if (and (derived-mode-p 'org-mode) (< level 1000))
21696 ;; A true heading (not a plain list item), in Org-mode
21697 ;; This means we can easily find the end by looking
21698 ;; only for the right number of stars. Using a regexp to do
21699 ;; this is so much faster than using a Lisp loop.
21701 (forward-char 1)
21702 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21703 ;; something else, do it the slow way
21704 (while (and (not (eobp))
21705 (or first (> (funcall outline-level) level)))
21706 (setq first nil)
21707 (outline-next-heading)))
21708 (unless to-heading
21710 (progn
21711 ;; Go to end of line before heading
21712 (forward-char -1)
21714 ;; leave blank line before heading
21715 (forward-char -1))))))
21716 (point))
21718 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21719 "Use Org version in org-mode, for dramatic speed-up."
21720 (if (derived-mode-p 'org-mode)
21721 (progn
21722 (org-end-of-subtree nil t)
21723 (unless (eobp) (backward-char 1)))
21724 ad-do-it))
21726 (defun org-end-of-meta-data-and-drawers ()
21727 "Jump to the first text after meta data and drawers in the current entry.
21728 This will move over empty lines, lines with planning time stamps,
21729 clocking lines, and drawers."
21730 (org-back-to-heading t)
21731 (let ((end (save-excursion (outline-next-heading) (point)))
21734 (forward-line 1)
21735 (while (re-search-forward re end t)
21736 (if (not (match-end 1))
21737 ;; empty or planning line
21738 (forward-line 1)
21739 ;; a drawer, find the end
21741 (forward-line 1)))
21743 (point)))
21745 (defun org-forward-heading-same-level (arg &optional invisible-ok)
21746 "Move forward to the arg'th subheading at same level as this one.
21747 Stop at the first and last subheadings of a superior heading.
21748 Normally this only looks at visible headings, but when INVISIBLE-OK is
21749 non-nil it will also look at invisible ones."
21750 (interactive "p")
21751 (org-back-to-heading invisible-ok)
21752 (org-at-heading-p)
21753 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21755 l)
21756 (forward-char 1)
21757 (while (> arg 0)
21758 (while (and (re-search-forward re nil 'move)
21759 (setq l (- (match-end 0) (match-beginning 0) 1))
21760 (= l level)
21761 (not invisible-ok)
21762 (progn (backward-char 1) (outline-invisible-p)))
21763 (if (< l level) (setq arg 1)))
21764 (setq arg (1- arg)))
21765 (beginning-of-line 1)))
21767 (defun org-backward-heading-same-level (arg &optional invisible-ok)
21768 "Move backward to the arg'th subheading at same level as this one.
21769 Stop at the first and last subheadings of a superior heading."
21770 (interactive "p")
21771 (org-back-to-heading)
21772 (org-at-heading-p)
21773 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21775 l)
21776 (while (> arg 0)
21777 (while (and (re-search-backward re nil 'move)
21778 (setq l (- (match-end 0) (match-beginning 0) 1))
21779 (= l level)
21780 (not invisible-ok)
21781 (outline-invisible-p))
21782 (if (< l level) (setq arg 1)))
21783 (setq arg (1- arg)))))
21785 (defun org-forward-element ()
21786 "Move forward by one element.
21787 Move to the next element at the same level, when possible."
21788 (interactive)
21789 (cond ((eobp) (error "Cannot move further down"))
21790 ((org-with-limited-levels (org-at-heading-p))
21791 (let ((origin (point)))
21792 (org-forward-heading-same-level 1)
21793 (unless (org-with-limited-levels (org-at-heading-p))
21794 (goto-char origin)
21795 (error "Cannot move further down"))))
21796 (t
21797 (let* ((elem (org-element-at-point))
21798 (end (org-element-property :end elem))
21799 (parent (org-element-property :parent elem)))
21800 (if (and parent (= (org-element-property :contents-end parent) end))
21801 (goto-char (org-element-property :end parent))
21802 (goto-char end))))))
21804 (defun org-backward-element ()
21805 "Move backward by one element.
21806 Move to the previous element at the same level, when possible."
21807 (interactive)
21808 (cond ((bobp) (error "Cannot move further up"))
21809 ((org-with-limited-levels (org-at-heading-p))
21810 ;; At an headline, move to the previous one, if any, or stay
21811 ;; here.
21812 (let ((origin (point)))
21813 (org-backward-heading-same-level 1)
21814 (unless (org-with-limited-levels (org-at-heading-p))
21815 (goto-char origin)
21816 (error "Cannot move further up"))))
21817 (t
21818 (let* ((trail (org-element-at-point 'keep-trail))
21819 (elem (car trail))
21820 (prev-elem (nth 1 trail))
21821 (beg (org-element-property :begin elem)))
21822 (cond
21823 ;; Move to beginning of current element if point isn't
21824 ;; there already.
21825 ((/= (point) beg) (goto-char beg))
21826 (prev-elem (goto-char (org-element-property :begin prev-elem)))
21827 ((org-before-first-heading-p) (goto-char (point-min)))
21828 (t (org-back-to-heading)))))))
21830 (defun org-up-element ()
21831 "Move to upper element."
21832 (interactive)
21833 (if (org-with-limited-levels (org-at-heading-p))
21834 (unless (org-up-heading-safe) (error "No surrounding element"))
21835 (let* ((elem (org-element-at-point))
21836 (parent (org-element-property :parent elem)))
21837 (if parent (goto-char (org-element-property :begin parent))
21838 (if (org-with-limited-levels (org-before-first-heading-p))
21839 (error "No surrounding element")
21840 (org-with-limited-levels (org-back-to-heading)))))))
21842 (defvar org-element-greater-elements)
21843 (defun org-down-element ()
21844 "Move to inner element."
21845 (interactive)
21846 (let ((element (org-element-at-point)))
21847 (cond
21848 ((memq (org-element-type element) '(plain-list table))
21849 (goto-char (org-element-property :contents-begin element))
21850 (forward-char))
21851 ((memq (org-element-type element) org-element-greater-elements)
21852 ;; If contents are hidden, first disclose them.
21853 (when (org-element-property :hiddenp element) (org-cycle))
21854 (goto-char (or (org-element-property :contents-begin element)
21855 (error "No content for this element"))))
21856 (t (error "No inner element")))))
21858 (defun org-drag-element-backward ()
21859 "Move backward element at point."
21860 (interactive)
21861 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
21862 (let* ((trail (org-element-at-point 'keep-trail))
21863 (elem (car trail))
21864 (prev-elem (nth 1 trail)))
21865 ;; Error out if no previous element or previous element is
21866 ;; a parent of the current one.
21867 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
21868 (error "Cannot drag element backward")
21869 (let ((pos (point)))
21870 (org-element-swap-A-B prev-elem elem)
21871 (goto-char (+ (org-element-property :begin prev-elem)
21872 (- pos (org-element-property :begin elem)))))))))
21874 (defun org-drag-element-forward ()
21875 "Move forward element at point."
21876 (interactive)
21877 (let* ((pos (point))
21878 (elem (org-element-at-point)))
21879 (when (= (point-max) (org-element-property :end elem))
21880 (error "Cannot drag element forward"))
21881 (goto-char (org-element-property :end elem))
21882 (let ((next-elem (org-element-at-point)))
21883 (when (or (org-element-nested-p elem next-elem)
21884 (and (eq (org-element-type next-elem) 'headline)
21885 (not (eq (org-element-type elem) 'headline))))
21886 (goto-char pos)
21887 (error "Cannot drag element forward"))
21888 ;; Compute new position of point: it's shifted by NEXT-ELEM
21889 ;; body's length (without final blanks) and by the length of
21890 ;; blanks between ELEM and NEXT-ELEM.
21891 (let ((size-next (- (save-excursion
21892 (goto-char (org-element-property :end next-elem))
21894 (forward-line)
21895 ;; Small correction if buffer doesn't end
21896 ;; with a newline character.
21897 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
21898 (org-element-property :begin next-elem)))
21899 (size-blank (- (org-element-property :end elem)
21900 (save-excursion
21901 (goto-char (org-element-property :end elem))
21903 (forward-line)
21904 (point)))))
21905 (org-element-swap-A-B elem next-elem)
21906 (goto-char (+ pos size-next size-blank))))))
21908 (defun org-mark-element ()
21909 "Put point at beginning of this element, mark at end.
21911 Interactively, if this command is repeated or (in Transient Mark
21912 mode) if the mark is active, it marks the next element after the
21913 ones already marked."
21914 (interactive)
21915 (let (deactivate-mark)
21916 (if (and (org-called-interactively-p 'any)
21917 (or (and (eq last-command this-command) (mark t))
21918 (and transient-mark-mode mark-active)))
21919 (set-mark
21920 (save-excursion
21921 (goto-char (mark))
21922 (goto-char (org-element-property :end (org-element-at-point)))))
21923 (let ((element (org-element-at-point)))
21924 (end-of-line)
21925 (push-mark (org-element-property :end element) t t)
21926 (goto-char (org-element-property :begin element))))))
21928 (defun org-narrow-to-element ()
21929 "Narrow buffer to current element."
21930 (interactive)
21931 (let ((elem (org-element-at-point)))
21932 (cond
21933 ((eq (car elem) 'headline)
21934 (narrow-to-region
21935 (org-element-property :begin elem)
21936 (org-element-property :end elem)))
21937 ((memq (car elem) org-element-greater-elements)
21938 (narrow-to-region
21939 (org-element-property :contents-begin elem)
21940 (org-element-property :contents-end elem)))
21941 (t
21942 (narrow-to-region
21943 (org-element-property :begin elem)
21944 (org-element-property :end elem))))))
21946 (defun org-transpose-element ()
21947 "Transpose current and previous elements, keeping blank lines between.
21948 Point is moved after both elements."
21949 (interactive)
21950 (org-skip-whitespace)
21951 (let ((end (org-element-property :end (org-element-at-point))))
21952 (org-drag-element-backward)
21953 (goto-char end)))
21955 (defun org-unindent-buffer ()
21956 "Un-indent the visible part of the buffer.
21957 Relative indentation (between items, inside blocks, etc.) isn't
21958 modified."
21959 (interactive)
21960 (unless (eq major-mode 'org-mode)
21961 (error "Cannot un-indent a buffer not in Org mode"))
21962 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
21963 unindent-tree ; For byte-compiler.
21964 (unindent-tree
21965 (function
21966 (lambda (contents)
21967 (mapc
21968 (lambda (element)
21969 (if (memq (org-element-type element) '(headline section))
21970 (funcall unindent-tree (org-element-contents element))
21971 (save-excursion
21972 (save-restriction
21973 (narrow-to-region
21974 (org-element-property :begin element)
21975 (org-element-property :end element))
21976 (org-do-remove-indentation)))))
21977 (reverse contents))))))
21978 (funcall unindent-tree (org-element-contents parse-tree))))
21980 (defun org-show-subtree ()
21981 "Show everything after this heading at deeper levels."
21982 (interactive)
21983 (outline-flag-region
21984 (point)
21985 (save-excursion
21986 (org-end-of-subtree t t))
21987 nil))
21989 (defun org-show-entry ()
21990 "Show the body directly following this heading.
21991 Show the heading too, if it is currently invisible."
21992 (interactive)
21993 (save-excursion
21994 (condition-case nil
21995 (progn
21996 (org-back-to-heading t)
21997 (outline-flag-region
21998 (max (point-min) (1- (point)))
21999 (save-excursion
22000 (if (re-search-forward
22002 (match-beginning 1)
22003 (point-max)))
22004 nil)
22005 (org-cycle-hide-drawers 'children))
22006 (error nil))))
22008 (defun org-make-options-regexp (kwds &optional extra)
22009 "Make a regular expression for keyword lines."
22010 (concat
22016 ;; Make isearch reveal the necessary context
22017 (defun org-isearch-end ()
22018 "Reveal context after isearch exits."
22019 (when isearch-success ; only if search was successful
22020 (if (featurep 'xemacs)
22021 ;; Under XEmacs, the hook is run in the correct place,
22022 ;; we directly show the context.
22023 (org-show-context 'isearch)
22024 ;; In Emacs the hook runs *before* restoring the overlays.
22025 ;; So we have to use a one-time post-command-hook to do this.
22026 ;; (Emacs 22 has a special variable, see function `org-mode')
22027 (unless (and (boundp 'isearch-mode-end-hook-quit)
22028 isearch-mode-end-hook-quit)
22029 ;; Only when the isearch was not quitted.
22030 (org-add-hook 'post-command-hook 'org-isearch-post-command
22031 'append 'local)))))
22033 (defun org-isearch-post-command ()
22034 "Remove self from hook, and show context."
22035 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
22036 (org-show-context 'isearch))
22039 ;;;; Integration with and fixes for other packages
22041 ;;; Imenu support
22043 (defvar org-imenu-markers nil
22044 "All markers currently used by Imenu.")
22045 (make-variable-buffer-local 'org-imenu-markers)
22047 (defun org-imenu-new-marker (&optional pos)
22048 "Return a new marker for use by Imenu, and remember the marker."
22049 (let ((m (make-marker)))
22050 (move-marker m (or pos (point)))
22051 (push m org-imenu-markers)
22052 m))
22054 (defun org-imenu-get-tree ()
22055 "Produce the index for Imenu."
22056 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
22057 (setq org-imenu-markers nil)
22058 (let* ((n org-imenu-depth)
22059 (re (concat "^" (org-get-limited-outline-regexp)))
22060 (subs (make-vector (1+ n) nil))
22061 (last-level 0)
22062 m level head)
22063 (save-excursion
22064 (save-restriction
22065 (widen)
22066 (goto-char (point-max))
22067 (while (re-search-backward re nil t)
22068 (setq level (org-reduced-level (funcall outline-level)))
22069 (when (and (<= level n)
22070 (looking-at org-complex-heading-regexp))
22071 (setq head (org-link-display-format
22072 (org-match-string-no-properties 4))
22073 m (org-imenu-new-marker))
22074 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
22075 (if (>= level last-level)
22076 (push (cons head m) (aref subs level))
22077 (push (cons head (aref subs (1+ level))) (aref subs level))
22078 (loop for i from (1+ level) to n do (aset subs i nil)))
22079 (setq last-level level)))))
22080 (aref subs 1)))
22082 (eval-after-load "imenu"
22083 '(progn
22084 (add-hook 'imenu-after-jump-hook
22085 (lambda ()
22086 (if (derived-mode-p 'org-mode)
22087 (org-show-context 'org-goto))))))
22089 (defun org-link-display-format (link)
22090 "Replace a link with either the description, or the link target
22091 if no description is present"
22092 (save-match-data
22093 (if (string-match org-bracket-link-analytic-regexp link)
22094 (replace-match (if (match-end 5)
22095 (match-string 5 link)
22096 (concat (match-string 1 link)
22097 (match-string 3 link)))
22098 nil t link)
22099 link)))
22101 (defun org-toggle-link-display ()
22102 "Toggle the literal or descriptive display of links."
22103 (interactive)
22104 (if org-descriptive-links
22105 (progn (org-remove-from-invisibility-spec '(org-link))
22106 (org-restart-font-lock)
22107 (setq org-descriptive-links nil))
22108 (progn (add-to-invisibility-spec '(org-link))
22109 (org-restart-font-lock)
22110 (setq org-descriptive-links t))))
22112 ;; Speedbar support
22114 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
22115 "Overlay marking the agenda restriction line in speedbar.")
22116 (overlay-put org-speedbar-restriction-lock-overlay
22117 'face 'org-agenda-restriction-lock)
22118 (overlay-put org-speedbar-restriction-lock-overlay
22119 'help-echo "Agendas are currently limited to this item.")
22120 (org-detach-overlay org-speedbar-restriction-lock-overlay)
22122 (defun org-speedbar-set-agenda-restriction ()
22123 "Restrict future agenda commands to the location at point in speedbar.
22125 (interactive)
22126 (require 'org-agenda)
22127 (let (p m tp np dir txt)
22128 (cond
22129 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22130 'org-imenu t))
22131 (setq m (get-text-property p 'org-imenu-marker))
22132 (with-current-buffer (marker-buffer m)
22133 (goto-char m)
22134 (org-agenda-set-restriction-lock 'subtree)))
22135 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22136 'speedbar-function 'speedbar-find-file))
22137 (setq tp (previous-single-property-change
22138 (1+ p) 'speedbar-function)
22139 np (next-single-property-change
22140 tp 'speedbar-function)
22141 dir (speedbar-line-directory)
22142 txt (buffer-substring-no-properties (or tp (point-min))
22143 (or np (point-max))))
22144 (with-current-buffer (find-file-noselect
22145 (let ((default-directory dir))
22146 (expand-file-name txt)))
22147 (unless (derived-mode-p 'org-mode)
22148 (error "Cannot restrict to non-Org-mode file"))
22149 (org-agenda-set-restriction-lock 'file)))
22150 (t (error "Don't know how to restrict Org-mode's agenda")))
22151 (move-overlay org-speedbar-restriction-lock-overlay
22152 (point-at-bol) (point-at-eol))
22153 (setq current-prefix-arg nil)
22154 (org-agenda-maybe-redo)))
22156 (eval-after-load "speedbar"
22157 '(progn
22158 (speedbar-add-supported-extension ".org")
22159 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
22160 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
22161 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
22162 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
22163 (add-hook 'speedbar-visiting-tag-hook
22164 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
22166 ;;; Fixes and Hacks for problems with other packages
22168 ;; Make flyspell not check words in links, to not mess up our keymap
22169 (defun org-mode-flyspell-verify ()
22170 "Don't let flyspell put overlays at active buttons, or on
22171 {todo,all-time,additional-option-like}-keywords."
22172 (let ((pos (max (1- (point)) (point-min)))
22173 (word (thing-at-point 'word)))
22174 (and (not (get-text-property pos 'keymap))
22175 (not (get-text-property pos 'org-no-flyspell))
22176 (not (member word org-todo-keywords-1))
22177 (not (member word org-all-time-keywords))
22178 (not (member word org-options-keywords))
22179 (not (member word (mapcar 'car org-startup-options)))
22180 (not (member word org-additional-option-like-keywords-for-flyspell)))))
22182 (defun org-remove-flyspell-overlays-in (beg end)
22183 "Remove flyspell overlays in region."
22184 (and (org-bound-and-true-p flyspell-mode)
22185 (fboundp 'flyspell-delete-region-overlays)
22186 (flyspell-delete-region-overlays beg end))
22187 (add-text-properties beg end '(org-no-flyspell t)))
22189 ;; Make `bookmark-jump' shows the jump location if it was hidden.
22190 (eval-after-load "bookmark"
22191 '(if (boundp 'bookmark-after-jump-hook)
22192 ;; We can use the hook
22193 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
22194 ;; Hook not available, use advice
22195 (defadvice bookmark-jump (after org-make-visible activate)
22196 "Make the position visible."
22197 (org-bookmark-jump-unhide))))
22199 ;; Make sure saveplace shows the location if it was hidden
22200 (eval-after-load "saveplace"
22201 '(defadvice save-place-find-file-hook (after org-make-visible activate)
22202 "Make the position visible."
22203 (org-bookmark-jump-unhide)))
22205 ;; Make sure ecb shows the location if it was hidden
22206 (eval-after-load "ecb"
22207 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
22208 "Make hierarchy visible when jumping into location from ECB tree buffer."
22209 (if (derived-mode-p 'org-mode)
22210 (org-show-context))))
22212 (defun org-bookmark-jump-unhide ()
22213 "Unhide the current position, to show the bookmark location."
22214 (and (derived-mode-p 'org-mode)
22215 (or (outline-invisible-p)
22216 (save-excursion (goto-char (max (point-min) (1- (point))))
22217 (outline-invisible-p)))
22218 (org-show-context 'bookmark-jump)))
22220 ;; Make session.el ignore our circular variable
22221 (eval-after-load "session"
22222 '(add-to-list 'session-globals-exclude 'org-mark-ring))
22224 ;;;; Experimental code
22226 (defun org-closed-in-range ()
22227 "Sparse tree of items closed in a certain time range.
22228 Still experimental, may disappear in the future."
22229 (interactive)
22230 ;; Get the time interval from the user.
22231 (let* ((time1 (org-float-time
22232 (org-read-date nil 'to-time nil "Starting date: ")))
22233 (time2 (org-float-time
22234 (org-read-date nil 'to-time nil "End date:")))
22235 ;; callback function
22236 (callback (lambda ()
22237 (let ((time
22238 (org-float-time
22239 (apply 'encode-time
22240 (org-parse-time-string
22241 (match-string 1))))))
22242 ;; check if time in interval
22243 (and (>= time time1) (<= time time2))))))
22244 ;; make tree, check each match with the callback
22247 ;;;; Finish up
22249 (provide 'org)
22251 (run-hooks 'org-load-hook)
22253 ;;; org.el ends here