| blob | 14bb0d6e88ae025a7c12a08dee12a0e1618790e3 |
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))
136 ;; load languages based on value of `org-babel-load-languages'
139 ;;;###autoload
141 "Load the languages defined in `org-babel-load-languages'."
153 org-babel-load-languages))
156 "Languages which can be evaluated in Org-mode buffers.
157 This list can be used to load support for any of the languages
158 below, note that each language will depend on a different set of
159 system executables and/or Emacs modes. When a language is
161 with `org-babel-execute-src-block' bound by default to C-c
162 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
163 be set to remove code block evaluation from the C-c C-c
164 keybinding. By default only Emacs Lisp (which has no
165 requirements) is loaded."
170 :key-type
213 ;;;; Customization variables
215 "Remove ID property of clones of a subtree.
216 When non-nil, clones of a subtree don't inherit the ID property.
217 Otherwise they inherit the ID property with a new unique
218 identifier."
223 ;;; Version
227 ;;;###autoload
229 "Show the org-mode version in the echo area.
230 With prefix argument HERE, insert it at point.
231 When FULL is non-nil, use a verbose version string.
232 When MESSAGE is non-nil, display a message with the version."
243 org-version
244 git-version
247 org-install-dir
256 _version)))
260 ;;; Compatibility constants
262 ;;; The custom variables
265 "Outline-based notes management and organizer."
271 "Mode hook for Org-mode, run after the mode was turned on."
276 "Hook that is run after org.el has been loaded."
281 "Hook that is run after an Org log buffer is created."
291 "Load all extensions listed in `org-modules'."
296 org-modules)
300 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
309 (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)
310 "Modules that should always be loaded together with org.el.
311 If a description starts with <C>, the file is not part of Emacs
312 and loading it will require that you have downloaded and properly installed
313 the org-mode distribution.
315 You can also use this system to load external packages (i.e. neither Org
316 core modules, nor modules from the CONTRIB directory). Just add symbols
317 to the end of the list. If the package is called org-xyz.el, then you need
318 to add the symbol `xyz', and the package must have a call to
320 (provide 'org-xyz)"
323 :type
354 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
363 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
372 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
388 "Non-nil means make shift-cursor commands select text when possible.
390 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
391 start selecting a region, or enlarge regions started in this way.
392 In Org-mode, in special contexts, these same keys are used for
393 other purposes, important enough to compete with shift selection.
394 Org tries to balance these needs by supporting `shift-select-mode'
395 outside these special contexts, under control of this variable.
397 The default of this variable is nil, to avoid confusing behavior. Shifted
398 cursor keys will then execute Org commands in the following contexts:
399 - on a headline, changing TODO state (left/right) and priority (up/down)
400 - on a time stamp, changing the time
401 - in a plain list item, changing the bullet type
402 - in a property definition line, switching between allowed values
403 - in the BEGIN line of a clock table (changing the time block).
404 Outside these contexts, the commands will throw an error.
406 When this variable is t and the cursor is not in a special
407 context, Org-mode will support shift-selection for making and
408 enlarging regions. To make this more effective, the bullet
409 cycling will no longer happen anywhere in an item line, but only
410 if the cursor is exactly on the bullet.
412 If you set this variable to the symbol `always', then the keys
413 will not be special in headlines, property lines, and item lines,
414 to make shift selection work there as well. If this is what you
415 want, you can use the following alternative commands: `C-c C-t'
416 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
417 can be used to switch TODO sets, `C-c -' to cycle item bullet
418 types, and properties can be edited by hand or in column view.
420 However, when the cursor is on a timestamp, shift-cursor commands
421 will still edit the time stamp - this is just too good to give up.
423 XEmacs user should have this variable set to nil, because
424 `shift-select-mode' is in Emacs 23 or later only."
432 "Shall some commands act upon headlines in the active region?
434 When set to `t', some commands will be performed in all headlines
435 within the active region.
437 When set to `start-level', some commands will be performed in all
438 headlines within the active region, provided that these headlines
439 are of the same level than the first one.
441 When set to a string, those commands will be performed on the
442 matching headlines within the active region. Such string must be
443 a tags/property/todo match as it is used in the agenda tags view.
445 The list of commands is: `org-schedule', `org-deadline',
446 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
447 `org-archive-to-archive-sibling'. The archiving commands skip
448 already archived entries."
458 "Options concerning startup of Org-mode."
463 "Non-nil means entering Org-mode will switch to OVERVIEW.
464 This can also be configured on a per-file basis by adding one of
465 the following lines anywhere in the buffer:
467 #+STARTUP: fold (or `overview', this is equivalent)
468 #+STARTUP: nofold (or `showall', this is equivalent)
469 #+STARTUP: content
470 #+STARTUP: showeverything"
479 "Non-nil means entering Org-mode will set `truncate-lines'.
480 This is useful since some lines containing links can be very long and
481 uninteresting. Also tables look terrible when wrapped."
486 "Non-nil means turn on `org-indent-mode' on startup.
487 This can also be configured on a per-file basis by adding one of
488 the following lines anywhere in the buffer:
490 #+STARTUP: indent
491 #+STARTUP: noindent"
499 When this option is turned on, you can use TeX-like syntax for sub- and
501 considered as a single item - so grouping with {} is normally not
502 needed. For example, the following things will be parsed as single
503 sub- or superscripts.
505 10^24 or 10^tau several digits will be considered 1 item.
506 10^-12 or 10^-tau a leading sign with digits or a word
507 x^2-y^3 will be read as x^2 - y^3, because items are
508 terminated by almost any nonword/nondigit char.
509 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
511 Still, ambiguity is possible - so when in doubt use {} to enclose the
512 sub/superscript. If you set this variable to the symbol `{}',
513 the braces are *required* in order to trigger interpretations as
515 frequently in plain text.
517 Not all export backends support this, but HTML does.
533 "Non-nil means turn on `org-beamer-mode' on startup.
534 This can also be configured on a per-file basis by adding one of
535 the following lines anywhere in the buffer:
537 #+STARTUP: beamer"
543 "Non-nil means align all tables when visiting a file.
544 This is useful when the column width in tables is forced with <N> cookies
545 in table fields. Such tables will look correct only after the first re-align.
546 This can also be configured on a per-file basis by adding one of
547 the following lines anywhere in the buffer:
548 #+STARTUP: align
549 #+STARTUP: noalign"
554 "Non-nil means show inline images when loading a new Org file.
555 This can also be configured on a per-file basis by adding one of
556 the following lines anywhere in the buffer:
557 #+STARTUP: inlineimages
558 #+STARTUP: noinlineimages"
564 "Non-nil means insert the first line setting Org-mode in empty files.
565 When the function `org-mode' is called interactively in an empty file, this
566 normally means that the file name does not automatically trigger Org-mode.
567 To ensure that the file will always be in Org-mode in the future, a
568 line enforcing Org-mode will be inserted into the buffer, if this option
569 has been set."
574 "Non-nil means use alternative key bindings for some keys.
575 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
576 These keys are also used by other packages like shift-selection-mode'
577 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
578 If you want to use Org-mode together with one of these other modes,
579 or more generally if you would like to move some Org-mode commands to
580 other keys, set this variable and configure the keys with the variable
581 `org-disputed-keys'.
583 This option is only relevant at load-time of Org-mode, and must be set
584 *before* org.el is loaded. Changing it requires a restart of Emacs to
585 become effective."
590 "Non-nil means use extra key sequence definitions for certain commands.
591 This happens automatically if you run XEmacs or if `window-system'
592 is nil. This variable lets you do the same manually. You must
593 set it before loading org.
595 Example: on Carbon Emacs 22 running graphically, with an external
596 keyboard on a Powerbook, the default way of setting M-left might
597 not work for either Alt or ESC. Setting this variable will make
598 it work for ESC."
612 "Keys for which Org-mode and other modes compete.
613 This is an alist, cars are the default keys, second element specifies
614 the alternative to use when `org-replace-disputed-keys' is t.
616 Keys can be specified in any syntax supported by `define-key'.
617 The value of this option takes effect only at Org-mode's startup,
618 therefore you'll have to restart Emacs to apply it after changing."
623 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
624 Or return the original if not disputed.
625 Also apply the translations defined in `org-xemacs-key-equivalents'."
630 org-disputed-keys)))
634 key)
644 "Define a key, possibly translated, as returned by `org-key'."
648 "The ellipsis to use in the Org-mode outline.
649 When nil, just use the standard three dots. When a string, use that instead,
650 When a face, use the standard 3 dots, but with the specified face.
651 The change affects only Org-mode (which will then use its own display table).
652 Changing this requires executing `M-x org-mode' in a buffer to become
653 effective."
663 "Keywords in Org-mode."
668 "String to mark deadline entries.
669 A deadline is this string, followed by a time stamp. Should be a word,
670 terminated by a colon. You can insert a schedule keyword and
672 Changes become only effective after restarting Emacs."
677 "String to mark scheduled TODO entries.
678 A schedule is this string, followed by a time stamp. Should be a word,
679 terminated by a colon. You can insert a schedule keyword and
681 Changes become only effective after restarting Emacs."
686 "String used as the prefix for timestamps logging closing a TODO entry."
691 "String used as prefix for timestamps clocking work hours on an item."
703 "Entries starting with this keyword will never be exported.
704 An entry can be toggled between COMMENT and normal with
706 Changes become only effective after restarting Emacs."
711 "Entries starting with this keyword will be exported in fixed-width font.
712 Quoting applies only to the text in the entry following the headline, and does
713 not extend beyond the next headline, even if that is lower level.
714 An entry can be toggled between QUOTE and normal with
721 "Regular expression for specifying repeated events.
725 "Options concerning the general structure of Org-mode files."
730 "Options about how to make context of a location visible."
754 "Non-nil means show full hierarchy when revealing a location.
755 Org-mode often shows locations in an org-mode file which might have
756 been invisible before. When this is set, the hierarchy of headings
757 above the exposed location is shown.
758 Turning this off for example for sparse trees makes them very compact.
759 Instead of t, this can also be an alist specifying this option for different
760 contexts. Valid contexts are
761 agenda when exposing an entry from the agenda
762 org-goto when using the command `org-goto' on key C-c C-j
763 occur-tree when using the command `org-occur' on key C-c /
764 tags-tree when constructing a sparse tree based on tags matches
765 link-search when exposing search matches associated with a link
766 mark-goto when exposing the jump goal of a mark
767 bookmark-jump when exposing a bookmark location
768 isearch when exiting from an incremental search
769 default default for all contexts not set explicitly"
774 "Non-nil means show following heading when revealing a location.
775 Org-mode often shows locations in an org-mode file which might have
776 been invisible before. When this is set, the heading following the
777 match is shown.
778 Turning this off for example for sparse trees makes them very compact,
779 but makes it harder to edit the location of the match. In such a case,
781 Instead of t, this can also be an alist specifying this option for different
782 contexts. See `org-show-hierarchy-above' for valid contexts."
787 "Non-nil means show all sibling heading when revealing a location.
788 Org-mode often shows locations in an org-mode file which might have
789 been invisible before. When this is set, the sibling of the current entry
790 heading are all made visible. If `org-show-hierarchy-above' is t,
791 the same happens on each level of the hierarchy above the current entry.
793 By default this is on for the isearch context, off for all other contexts.
794 Turning this off for example for sparse trees makes them very compact,
795 but makes it harder to edit the location of the match. In such a case,
797 Instead of t, this can also be an alist specifying this option for different
798 contexts. See `org-show-hierarchy-above' for valid contexts."
803 "Non-nil means show the entry below a headline when revealing a location.
804 Org-mode often shows locations in an org-mode file which might have
805 been invisible before. When this is set, the text below the headline that is
806 exposed is also shown.
808 By default this is off for all contexts.
809 Instead of t, this can also be an alist specifying this option for different
810 contexts. See `org-show-hierarchy-above' for valid contexts."
815 "How should indirect tree buffers be displayed?
816 This applies to indirect buffers created with the commands
818 Valid values are:
819 current-window Display in the current window
820 other-window Just display in another window.
821 dedicated-frame Create one new frame, and re-use it each time.
822 new-frame Make a new frame each time. Note that in this case
823 previously-made indirect buffers are kept, and you need to
824 kill these buffers yourself."
834 "Non-nil means activate single letter commands at beginning of a headline.
835 This may also be a function to test for appropriate locations where speed
836 commands should be active."
844 "Alist of additional speed commands.
845 This list will be checked before `org-speed-commands-default'
846 when the variable `org-use-speed-commands' is non-nil
847 and when the cursor is at the beginning of a headline.
848 The car if each entry is a string with a single letter, which must
849 be assigned to `self-insert-command' in the global map.
850 The cdr is either a command to be called interactively, a function
851 to be called, or a form to be evaluated.
852 An entry that is just a list with a single string will be interpreted
853 as a descriptive headline that will be added when listing the speed
854 commands in the Help buffer using the `?' speed command."
866 "Options concerning visibility cycling in Org-mode."
871 "Non-nil means skip CHILDREN state in entries that don't have any."
876 "Maximum level which should still be subject to visibility cycling.
877 Levels higher than this will, for cycling, be treated as text, not a headline.
878 When `org-odd-levels-only' is set, a value of N in this variable actually
879 means 2N-1 stars as the limiting headline.
880 When nil, cycle all levels.
881 Note that the limiting level of cycling is also influenced by
882 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
883 `org-inlinetask-min-level' is, cycling will be limited to levels one less
884 than its value."
891 "Names of drawers. Drawers are not opened by cycling on the headline above.
892 Drawers only open with a TAB on the drawer line itself. A drawer looks like
893 this:
894 :DRAWERNAME:
895 .....
896 :END:
898 the property API.
900 Drawers can be defined on the per-file basis with a line like:
902 #+DRAWERS: HIDDEN STATE PROPERTIES"
908 "Non-nil means entering Org-mode will fold all blocks.
909 This can also be set in on a per-file basis with
911 #+STARTUP: hideblocks
912 #+STARTUP: showblocks"
918 "Cycle globally if cursor is at beginning of buffer and not at a headline.
919 This makes it possible to do global cycling without having to use S-TAB or
921 of the buffer must not be a headline -- it may be empty or some other text.
922 When used in this way, `org-cycle-hook' is disabled temporarily to make
923 sure the cursor stays at the beginning of the buffer. When this option is
924 nil, don't do anything special at the beginning of the buffer."
929 "Non-nil means cycle entry level or item indentation in new empty entries.
931 When the cursor is at the end of an empty headline, i.e with only stars
932 and maybe a TODO keyword, TAB will then switch the entry to become a child,
933 and then all possible ancestor states, before returning to the original state.
934 This makes data entry extremely fast: M-RET to create a new headline,
935 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
937 When the cursor is at the end of an empty plain list item, one TAB will
938 make it a subitem, two or more tabs will back up to make this an item
939 higher up in the item hierarchy."
944 "Where should `org-cycle' emulate TAB.
945 nil Never
946 white Only in completely white lines
947 whitestart Only at the beginning of lines, before the first non-white char
948 t Everywhere except in headlines
949 exc-hl-bol Everywhere except at the start of a headline
950 If TAB is used in a place where it does not emulate TAB, the current subtree
951 visibility is cycled."
958 ))
961 "Number of empty lines needed to keep an empty line between collapsed trees.
962 If you leave an empty line between the end of a subtree and the following
963 headline, this empty line is hidden when the subtree is folded.
964 Org-mode will leave (exactly) one empty line visible if the number of
965 empty lines is equal or larger to the number given in this variable.
966 So the default 2 means at least 2 empty lines after the end of a subtree
967 are needed to produce free space between a collapsed subtree and the
968 following headline.
970 If the number is negative, and the number of empty lines is at least -N,
971 all empty lines are shown.
973 Special case: when 0, never leave empty lines in collapsed view."
979 "Hook that is run before visibility cycling is happening.
980 The function(s) in this hook must accept a single argument which indicates
981 the new state that will be set right after running this hook. The
982 argument is a symbol. Before a global state change, it can have the values
983 `overview', `content', or `all'. Before a local state change, it can have
984 the values `folded', `children', or `subtree'."
989 org-cycle-hide-drawers
990 org-cycle-show-empty-lines
991 org-optimize-window-after-visibility-change)
992 "Hook that is run after `org-cycle' has changed the buffer visibility.
993 The function(s) in this hook must accept a single argument which indicates
994 the new state that was set by the most recent `org-cycle' command. The
995 argument is a symbol. After a global state change, it can have the values
996 `overview', `contents', or `all'. After a local state change, it can have
997 the values `folded', `children', or `subtree'."
1002 "Options concerning structure editing in Org-mode."
1007 "Non-nil means skip even levels and only use odd levels for the outline.
1008 This has the effect that two stars are being added/taken away in
1009 promotion/demotion commands. It also influences how levels are
1010 handled by the exporters.
1011 Changing it requires restart of `font-lock-mode' to become effective
1012 for fontification also in regions already fontified.
1013 You may also set this on a per-file basis by adding one of the following
1014 lines to the buffer:
1016 #+STARTUP: odd
1017 #+STARTUP: oddeven"
1023 "Non-nil means adapt indentation to outline node level.
1025 When this variable is set, Org assumes that you write outlines by
1026 indenting text in each node to align with the headline (after the stars).
1027 The following issues are influenced by this variable:
1029 - When this is set and the *entire* text in an entry is indented, the
1030 indentation is increased by one space in a demotion command, and
1031 decreased by one in a promotion command. If any line in the entry
1032 body starts with text at column 0, indentation is not changed at all.
1034 - Property drawers and planning information is inserted indented when
1035 this variable s set. When nil, they will not be indented.
1037 - TAB indents a line relative to context. The lines below a headline
1038 will be indented when this variable is set.
1040 Note that this is all about true indentation, by adding and removing
1041 space characters. See also `org-indent.el' which does level-dependent
1042 indentation in a virtual way, i.e. at display time in Emacs."
1047 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1049 When t, `C-a' will bring back the cursor to the beginning of the
1050 headline text, i.e. after the stars and after a possible TODO
1051 keyword. In an item, this will be the position after bullet and
1052 check-box, if any. When the cursor is already at that position,
1053 another `C-a' will bring it to the beginning of the line.
1055 `C-e' will jump to the end of the headline, ignoring the presence
1056 of tags in the headline. A second `C-e' will then jump to the
1057 true end of the line, after any tags. This also means that, when
1058 this variable is non-nil, `C-e' also will never jump beyond the
1059 end of the heading of a folded section, i.e. not after the
1060 ellipses.
1062 When set to the symbol `reversed', the first `C-a' or `C-e' works
1063 normally, going to the true line boundary first. Only a directly
1064 following, identical keypress will bring the cursor to the
1065 special positions.
1067 This may also be a cons cell where the behavior for `C-a' and
1068 `C-e' is set separately."
1087 "Non-nil means `C-k' will behave specially in headlines.
1088 When nil, `C-k' will call the default `kill-line' command.
1089 When t, the following will happen while the cursor is in the headline:
1091 - When the cursor is at the beginning of a headline, kill the entire
1092 line and possible the folded subtree below the line.
1093 - When in the middle of the headline text, kill the headline up to the tags.
1094 - When after the headline text, kill the tags."
1099 "Non-nil means, do not delete a hidden subtree with C-k.
1100 When set to the symbol `error', simply throw an error when C-k is
1101 used to kill (part-of) a headline that has hidden text behind it.
1102 Any other non-nil value will result in a query to the user, if it is
1103 OK to kill that hidden subtree. When nil, kill without remorse."
1112 "Check if in invisible region before inserting or deleting a character.
1113 Valid values are:
1115 nil Do not check, so just do invisible edits.
1116 error Throw an error and do nothing.
1117 show Make point visible, and do the requested edit.
1118 show-and-error Make point visible, then throw an error and abort the edit.
1119 smart Make point visible, and do insertion/deletion if it is
1120 adjacent to visible text and the change feels predictable.
1121 Never delete a previously invisible character or add in the
1122 middle or right after an invisible region. Basically, this
1123 allows insertion and backward-delete right before ellipses.
1124 FIXME: maybe in this case we should not even show?"
1135 "Non-nil means when yanking subtrees, fold them.
1136 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1137 it starts with a heading and all other headings in it are either children
1138 or siblings, then fold all the subtrees. However, do this only if no
1139 text after the yank would be swallowed into a folded tree by this action."
1144 "Non-nil means when yanking subtrees, adjust the level.
1145 With this setting, `org-paste-subtree' is used to insert the subtree, see
1146 this function for details."
1151 "Non-nil means M-RET will split the line at the cursor position.
1152 When nil, it will go to the end of the line before making a
1153 new line.
1154 You may also set this option in a different way for different
1155 contexts. Valid contexts are:
1157 headline when creating a new headline
1158 item when creating a new item
1159 table in a table field
1160 default the value to be used for all contexts not explicitly
1161 customized"
1178 "Non-nil means insert new headings after the current subtree.
1179 When nil, the new heading is created directly after the current line.
1182 for the duration of the command."
1188 "Should `org-insert-heading' leave a blank line before new heading/item?
1189 The value is an alist, with `heading' and `plain-list-item' as CAR,
1190 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1191 which case Org will look at the surrounding headings/items and try to
1192 make an intelligent decision whether to insert a blank line or not.
1194 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1195 set, the setting here is ignored and no empty line is inserted, to avoid
1196 breaking the list structure."
1209 "Hook being run after inserting a new heading."
1215 This currently only means they are never auto-wrapped.
1216 When nil, such lines will be treated like ordinary lines.
1217 See also the QUOTE keyword."
1222 "Non-nil means typing characters in `org-goto' starts incremental search."
1227 "Options concerning sparse trees in Org-mode."
1232 "Non-nil means highlight all matches that define a sparse tree.
1233 The highlights will automatically disappear the next time the buffer is
1234 changed by an edit command."
1239 "Non-nil means any change to the buffer will remove temporary highlights.
1240 Such highlights are created by `org-occur' and `org-clock-display'.
1241 When nil, `C-c C-c needs to be used to get rid of the highlights.
1242 The highlights created by `org-preview-latex-fragment' always need
1243 `C-c C-c' to be removed."
1250 "Hook that is run after `org-occur' has constructed a sparse tree.
1251 This can be used to recenter the window to show as much of the structure
1252 as possible."
1257 "Options concerning imenu and speedbar in Org-mode."
1262 "The maximum level for Imenu access to Org-mode headlines.
1263 This also applied for speedbar access."
1268 "Options concerning tables in Org-mode."
1274 When nil, such lines will be treated like ordinary lines.
1276 When equal to the symbol `optimized', the table editor will be optimized to
1277 do the following:
1278 - Automatic overwrite mode in front of whitespace in table fields.
1279 This makes the structure of the table stay in tact as long as the edited
1280 field does not exceed the column width.
1281 - Minimize the number of realigns. Normally, the table is aligned each time
1282 TAB or RET are pressed to move to another field. With optimization this
1283 happens only if changes to a field might have changed the column width.
1284 Optimization requires replacing the functions `self-insert-command',
1285 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1286 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1287 very good at guessing when a re-align will be necessary, but you can always
1290 If you would like to use the optimized version in Org-mode, but the
1291 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1293 This variable can be used to turn on and off the table editor during a session,
1294 but in order to toggle optimization, a restart is required.
1296 See also the variable `org-table-auto-blank-field'."
1305 "Non-nil means cluster self-insert commands for undo when possible.
1306 If this is set, then, like in the Emacs command loop, 20 consecutive
1307 characters will be undone together.
1308 This is configurable, because there is some impact on typing performance."
1313 "Non-nil means TAB will automatically notice a table.el table.
1314 When it sees such a table, it moves point into it and - if necessary -
1315 calls `table-recognize-table'."
1320 "Options concerning links in Org-mode."
1325 "Buffer-local version of `org-link-abbrev-alist', which see.
1330 "Alist of link abbreviations.
1331 The car of each element is a string, to be replaced at the start of a link.
1333 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1335 [[linkkey:tag][description]]
1337 The 'linkkey' must be a word word, starting with a letter, followed
1338 by letters, numbers, '-' or '_'.
1340 If REPLACE is a string, the tag will simply be appended to create the link.
1343 at that point (see the function `url-hexify-string'). If the string contains
1345 be invoked: this function takes the tag as its only argument and must return
1346 a string.
1348 REPLACE may also be a function that will be called with the tag as the
1349 only argument to create the link, which should be returned as a string.
1351 See the manual for examples."
1361 "Non-nil means Org will display descriptive links.
1362 E.g. [[http://orgmode.org][Org website]] will be displayed as
1364 description. When set to `nil', Org will display the full links
1365 literally.
1367 You can interactively set the value of this variable by calling
1368 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1373 "How the path name in file links should be stored.
1374 Valid values are:
1376 relative Relative to the current directory, i.e. the directory of the file
1377 into which the link is being inserted.
1378 absolute Absolute path, if possible with ~ for home directory.
1379 noabbrev Absolute path, no abbreviation of home directory.
1380 adaptive Use relative path for files in the current directory and sub-
1381 directories of it. For other files, use an absolute path."
1390 "Types of links that should be activated in Org-mode files.
1391 This is a list of symbols, each leading to the activation of a certain link
1392 type. In principle, it does not hurt to turn on most link types - there may
1393 be a small gain when turning off unused link types. The types are:
1395 bracket The recommended [[link][description]] or [[link]] links with hiding.
1396 angle Links in angular brackets that may contain whitespace like
1397 <bbdb:Carsten Dominik>.
1398 plain Plain links in normal text, no whitespace, like http://google.com.
1399 radio Text that is matched by a radio target, see manual for details.
1400 tag Tag settings in a headline (link to tag search).
1401 date Time stamps (link to calendar).
1402 footnote Footnote labels.
1404 Changing this variable requires a restart of Emacs to become effective."
1416 "Function to use for generating link descriptions from links.
1417 When nil, the link location will be used. This function must take
1418 two parameters: the first one is the link, the second one is the
1419 description generated by `org-insert-link'. The function should
1420 return the description to use."
1425 "Options concerning storing links in Org-mode."
1430 "When non-nil, hexify URL when creating a link."
1436 "Format of the description part of a link to an email or usenet message.
1437 The following %-escapes will be replaced by corresponding information:
1445 %s subject
1446 %d date
1447 %m message-id.
1449 You may use normal field width specification between the % and the letter.
1450 This is for example useful to limit the length of the subject.
1464 It should match if the message is from the user him/herself."
1469 "Non-nil means file links from `org-store-link' contain context.
1470 A search string will be added to the file name with :: as separator and
1471 used to find the context when the link is activated by the command
1472 `org-open-at-point'. When this option is t, the entire active region
1473 will be placed in the search string of the file link. If set to a
1474 positive integer, only the first n lines of context will be stored.
1477 negates this setting for the duration of the command."
1482 "Non-nil means keep link in list for entire session.
1484 The command `org-store-link' adds a link pointing to the current
1485 location to an internal list. These links accumulate during a session.
1486 The command `org-insert-link' can be used to insert links into any
1487 Org-mode file (offering completion for all stored links). When this
1489 will be removed from the list, to make completing the unused links
1490 more efficient."
1495 "Options concerning following links in Org-mode."
1500 "Function to translate links with different syntax to Org syntax.
1501 This can be used to translate links created for example by the Planner
1502 or emacs-wiki packages to Org syntax.
1503 The function must accept two parameters, a TYPE containing the link
1505 which is everything after the link protocol. It should return a cons
1506 with possibly modified values of type and path.
1507 Org contains a function for this, so if you set this variable to
1508 `org-translate-link-from-planner', you should be able follow many
1509 links created by planner."
1514 "Hook that is run after a link has been followed."
1519 "Non-nil means on links TAB will follow the link.
1520 Needs to be set before org.el is loaded.
1521 This really should not be used, it does not make sense, and the
1522 implementation is bad."
1527 "Non-nil means on links RET will follow the link."
1533 "Non-nil means mouse-1 on a link will follow the link.
1534 A longer mouse click will still set point. Does not work on XEmacs.
1535 Needs to be set before org.el is loaded."
1540 "Number of different positions to be recorded in the ring.
1541 Changing this requires a restart of Emacs to work correctly."
1546 "Non-nil means internal links in Org files must exactly match a headline.
1547 When nil, the link search tries to match a phrase with all words
1548 in the search text."
1555 query-to-create)))
1563 "Setup the frame configuration for following links.
1564 When following a link with Emacs, it may often be useful to display
1565 this link in another window or frame. This variable can be used to
1566 set this up for the different types of links.
1567 For VM, use any of
1568 `vm-visit-folder'
1569 `vm-visit-folder-other-window'
1570 `vm-visit-folder-other-frame'
1571 For Gnus, use any of
1572 `gnus'
1573 `gnus-other-frame'
1574 `org-gnus-no-new-news'
1575 For FILE, use any of
1576 `find-file'
1577 `find-file-other-window'
1578 `find-file-other-frame'
1579 For Wanderlust use any of
1580 `wl'
1581 `wl-other-frame'
1582 For the calendar, use the variable `calendar-setup'.
1583 For BBDB, it is currently only possible to display the matches in
1584 another window."
1608 "Non-nil means use indirect buffer to display infile links.
1609 Activating internal links (from one location in a file to another location
1610 in the same file) normally just jumps to the location. When the link is
1612 is displayed in
1613 another window. When this option is set, the other window actually displays
1614 an indirect buffer clone of the current buffer, to avoid any visibility
1615 changes to the current buffer."
1620 "Non-nil means `org-open-file' will open non-existing files.
1621 When nil, an error will be generated.
1622 This variable applies only to external applications because they
1623 might choke on non-existing files. If the link is to a file that
1624 will be opened in Emacs, the variable is ignored."
1629 "Non-nil means a link to a directory really means to index.org.
1630 When nil, following a directory link will run dired or open a finder/explorer
1631 window on that directory."
1636 "Function and arguments to call for following mailto links.
1637 This is a list with the first element being a Lisp function, and the
1638 remaining elements being arguments to the function. In string arguments,
1639 %a will be replaced by the address, and %s will be replaced by the subject
1640 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1649 "Non-nil means ask for confirmation before executing shell links.
1650 Shell links can be dangerous: just think about a link
1652 [[shell:rm -rf ~/*][Google Search]]
1655 but really it would remove your entire home directory.
1656 Therefore we advise against setting this variable to nil.
1657 Just change it to `y-or-n-p' if you want to confirm with a
1665 'safe-local-variable
1669 "A regexp to skip confirmation for shell links."
1675 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1676 Elisp links can be dangerous: just think about a link
1681 but really it would remove your entire home directory.
1682 Therefore we advise against setting this variable to nil.
1683 Just change it to `y-or-n-p' if you want to confirm with a
1691 'safe-local-variable
1695 "A regexp to skip confirmation for Elisp links."
1704 "Default file applications on a UNIX or GNU/Linux system.
1715 "Default file applications on a MacOS X system.
1717 for some files for which the OS does not have a good default.
1725 'mswindows-shell-execute
1730 'mswindows-shell-execute
1733 "Default file applications on a Windows NT system.
1738 '(
1743 )
1744 "External applications for opening `file:path' items in a document.
1745 Org-mode uses system defaults for different file types, but
1746 you can use this variable to set the application for a given file
1747 extension. The entries in this list are cons cells where the car identifies
1748 files and the cdr the corresponding command. Possible values for the
1749 file identifier are
1751 ways, depending on its contents:
1753 - Alphanumeric characters only:
1754 Match links with this file extension.
1756 to open PDFs with evince.
1758 - Regular expression: Match links where the
1759 filename matches the regexp. If you want to
1760 use groups here, use shy groups.
1764 to open *.html and *.xhtml with firefox.
1766 - Regular expression which contains (non-shy) groups:
1768 anything after that, matches the regexp.
1769 In a custom command string, %1, %2, etc. are replaced with
1770 the parts of the link that were matched by the groups.
1771 For backwards compatibility, if a command string is given
1772 that does not use any of the group matches, this case is
1773 handled identically to the second one (i.e. match against
1774 file name only).
1775 In a custom lisp form, you can access the group matches with
1776 (match-string n link).
1779 to open [[file:document.pdf::5]] with evince at page 5.
1781 `directory' Matches a directory
1782 `remote' Matches a remote file, accessible through tramp or efs.
1783 Remote files most likely should be visited through Emacs
1784 because external applications cannot handle such paths.
1785 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1786 so all files Emacs knows how to handle. Using this with
1787 command `emacs' will open most files in Emacs. Beware that this
1788 will also open html files inside Emacs, unless you add
1790 t Default for files not matched by any of the other options.
1791 `system' The system command to open files, like `open' on Windows
1792 and Mac OS X, and mailcap under GNU/Linux. This is the command
1793 that will be selected if you call `C-c C-o' with a double
1796 Possible values for the command are:
1797 `emacs' The file will be visited by the current Emacs process.
1798 `default' Use the default application for this file type, which is the
1799 association for t in the list, most likely in the system-specific
1800 part.
1801 This can be used to overrule an unwanted setting in the
1802 system-specific variable.
1804 This command is specified by the entry whose car is `system'.
1805 Most likely, the system-specific version of this variable
1806 does define this command, but you can overrule/replace it
1807 here.
1808 string A command to be executed by a shell; %s will be replaced
1809 by the path to the file.
1810 sexp A Lisp form which will be evaluated. The file path will
1811 be available in the Lisp variable `file'.
1812 For more examples, see the system specific constants
1813 `org-file-apps-defaults-macosx'
1814 `org-file-apps-defaults-windowsnt'
1815 `org-file-apps-defaults-gnu'."
1825 auto-mode))
1834 "The URL of the DOI server."
1840 "Options concerning refiling entries in Org-mode."
1845 "Directory with org files.
1846 This is just a default location to look for Org files. There is no need
1847 at all to put your files into this directory. It is only used in the
1848 following situations:
1850 1. When a capture template specifies a target file that is not an
1851 absolute path. The path will then be interpreted relative to
1852 `org-directory'
1853 2. When a capture note is filed away in an interactive way (when exiting the
1854 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1855 with `org-directory' as the default path."
1862 "Default target for storing notes.
1863 Used as a fall back file for org-remember.el and org-capture.el, for
1864 templates that do not specify a target file."
1870 file))
1873 "The default interface to be used for `org-goto'.
1874 Allowed values are:
1875 outline The interface shows an outline of the relevant file
1876 and the correct heading is found by moving through
1877 the outline or by searching with incremental search.
1878 outline-path-completion Headlines in the current buffer are offered via
1879 completion. This is the interface also used by
1880 the refile command."
1887 "Maximum target level when running `org-goto' with refile interface."
1892 "Non-nil means store new notes at the beginning of a file or entry.
1893 When nil, new notes will be filed to the end of a file or entry.
1894 This can also be a list with cons cells of regular expressions that
1895 are matched against file names, and values."
1906 "Information to record when a task is refiled.
1908 Possible values are:
1910 nil Don't add anything
1911 time Add a time stamp to the task
1912 note Prompt for a note and add it with template `org-log-note-headings'
1914 This option can also be set with on a per-file-basis with
1916 #+STARTUP: nologrefile
1917 #+STARTUP: logrefile
1918 #+STARTUP: lognoterefile
1920 You can have local logging settings for a subtree by setting the LOGGING
1921 property to one or more of these keywords.
1923 When bulk-refiling from the agenda, the value `note' is forbidden and
1924 will temporarily be changed to `time'."
1935 This is a list of cons cells. Each cell contains:
1936 - a specification of the files to be considered, either a list of files,
1937 or a symbol whose function or variable value will be used to retrieve
1938 a file name or a list of file names. If you use `org-agenda-files' for
1939 that, all agenda files will be scanned for targets. Nil means consider
1940 headings in the current buffer.
1941 - A specification of how to find candidate refile targets. This may be
1942 any of:
1944 This tag has to be present in all target headlines, inheritance will
1945 not be considered.
1947 todo keyword.
1949 headlines that are refiling targets.
1950 - a cons cell (:level . N). Any headline of level N is considered a target.
1951 Note that, when `org-odd-levels-only' is set, level corresponds to
1952 order in hierarchy, not to the number of stars.
1953 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1954 Note that, when `org-odd-levels-only' is set, level corresponds to
1955 order in hierarchy, not to the number of stars.
1957 Each element of this list generates a set of possible targets.
1958 The union of these sets is presented (with completion) to
1959 the user by `org-refile'.
1961 You can set the variable `org-refile-target-verify-function' to a function
1962 to verify each headline found by the simple criteria above.
1964 When this variable is nil, all top-level headlines in the current buffer
1965 are used, equivalent to the value `((nil . (:level . 1))'."
1981 "Function to verify if the headline at point should be a refile target.
1982 The function will be called without arguments, with point at the
1983 beginning of the headline. It should return t and leave point
1984 where it is if the headline is a valid target for refiling.
1986 If the target should not be selected, the function must return nil.
1987 In addition to this, it may move point to a place from where the search
1988 should be continued. For example, the function may decide that the entire
1989 subtree of the current entry should be excluded and move point to the end
1990 of the subtree."
1995 "Non-nil means cache refile targets to speed up the process.
1996 The cache for a particular file will be updated automatically when
1997 the buffer has been killed, or when any of the marker used for flagging
1998 refile targets no longer points at a live buffer.
1999 If you have added new entries to a buffer that might themselves be targets,
2000 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2001 find that easier, `C-u C-u C-u C-c C-w'."
2007 "Non-nil means provide refile targets as paths.
2008 So a level 3 headline will be available as level1/level2/level3.
2010 When the value is `file', also include the file name (without directory)
2011 into the path. In this case, you can also stop the completion after
2012 the file name, to get entries inserted as top level in the file.
2014 When `full-file-path', include the full file path."
2023 "Non-nil means complete the outline path in hierarchical steps.
2024 When Org-mode uses the refile interface to select an outline path
2025 \(see variable `org-refile-use-outline-path'), the completion of
2026 the path can be done is a single go, or if can be done in steps down
2027 the headline hierarchy. Going in steps is probably the best if you
2028 do not use a special completion package like `ido' or `icicles'.
2029 However, when using these packages, going in one step can be very
2030 fast, while still showing the whole path to the entry."
2035 "Non-nil means allow to create new nodes as refile targets.
2037 of an existing node. When the value of this variable is `confirm',
2038 new node creation must be confirmed by the user (recommended)
2039 When nil, the completion must match an existing entry.
2041 Note that, if the new heading is not seen by the criteria
2042 listed in `org-refile-targets', multiple instances of the same
2043 heading would be created by trying again to file under the new
2044 heading."
2052 "Non-nil means also refile active region within a subtree.
2054 By default `org-refile' doesn't allow refiling regions if they
2055 don't contain a set of subtrees, but it might be convenient to
2056 do so sometimes: in that case, the first line of the region is
2057 converted to a headline before refiling."
2063 "Options concerning TODO items in Org-mode."
2068 "Options concerning Progress logging in Org-mode."
2075 "The available interpretation symbols for customizing `org-todo-keywords'.
2079 "List of TODO entry keyword sequences and their interpretation.
2082 Each sequence starts with a symbol, either `sequence' or `type',
2083 indicating if the keywords should be interpreted as a sequence of
2084 action steps, or as different types of TODO items. The first
2085 keywords are states requiring action - these states will select a headline
2086 for inclusion into the global TODO list Org-mode produces. If one of
2089 the last keyword is treated as the only DONE state of the sequence.
2092 additional state where no keyword is present. For details about this
2093 cycling, see the manual.
2095 TODO keywords and interpretation can also be set on a per-file basis with
2096 the special #+SEQ_TODO and #+TYP_TODO lines.
2098 Each keyword can optionally specify a character for fast state selection
2099 \(in combination with the variable `org-use-fast-todo-selection')
2100 and specifiers for state change logging, using the same syntax that
2103 indicates to record a time stamp each time this state is selected.
2105 Each keyword may also specify if a timestamp or a note should be
2106 recorded when entering or leaving the state, by adding additional
2107 characters in the parenthesis after the keyword. This looks like this:
2109 record only the time of the state change. With X and Y being either
2111 Y when leaving the state if and only if the *target* state does not
2112 define X. You may omit any of the fast-selection key or X or /Y,
2113 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2115 For backward compatibility, this variable may also be just a list
2116 of keywords. In this case the interpretation (sequence or type) will be
2117 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2127 ;;Quick and dirty way to see
2128 ;;`org-todo-interpretations'. This takes the
2129 ;;place of item arguments
2130 :convert-widget
2137 org-todo-interpretation-widgets))
2138 widget))
2169 "Controls how TODO keywords are interpreted.
2170 This variable is in principle obsolete and is only used for
2171 backward compatibility, if the interpretation of todo keywords is
2172 not given already in `org-todo-keywords'. See that variable for
2173 more information."
2180 "Non-nil means use the fast todo selection scheme with C-c C-t.
2181 This variable describes if and under what circumstances the cycling
2182 mechanism for TODO keywords will be replaced by a single-key, direct
2183 selection scheme.
2185 When nil, fast selection is never used.
2187 When the symbol `prefix', it will be used when `org-todo' is called
2188 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2189 `C-u t' in an agenda buffer.
2191 When t, fast selection is used by default. In this case, the prefix
2192 argument forces cycling instead.
2194 In all cases, the special interface is only used if access keys have
2195 actually been assigned by the user, i.e. if keywords in the configuration
2196 are followed by a letter in parenthesis, like TODO(t)."
2204 "Non-nil means update todo statistics after insert and toggle.
2205 ALL-HEADLINES means update todo statistics by including headlines
2206 with no TODO keyword as well, counting them as not done.
2207 A list of TODO keywords means the same, but skip keywords that are
2208 not in this list.
2210 When this is set, todo statistics is updated in the parent of the
2211 current entry each time a todo state is changed."
2221 "Non-nil means TODO statistics covers just direct children.
2222 When nil, all entries in the subtree are considered.
2223 This has only an effect if `org-provide-todo-statistics' is set.
2224 To set this to nil for only a single subtree, use a COOKIE_DATA
2230 "Hook which is run after the state of a TODO item was changed.
2231 The new state (a string with a TODO keyword, or nil) is available in the
2232 Lisp variable `org-state'."
2237 "Hook for functions that are allowed to block a state change.
2239 Each function gets as its single argument a property list, see
2240 `org-trigger-hook' for more information about this list.
2242 If any of the functions in this hook returns nil, the state change
2246 "Hook for functions that are triggered by a state change.
2248 Each function gets as its single argument a property list with at least
2249 the following elements:
2251 (:type type-of-change :position pos-at-entry-start
2252 :from old-state :to new-state)
2254 Depending on the type, more properties may be present.
2256 This mechanism is currently implemented for:
2258 TODO state changes
2259 ------------------
2260 :type todo-state-change
2261 :from previous state (keyword as a string), or nil, or a symbol
2262 'todo' or 'done', to indicate the general type of state.
2266 "Non-nil means undone TODO entries will block switching the parent to DONE.
2267 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2268 be blocked if any prior sibling is not yet done.
2269 Finally, if the parent is blocked because of ordered siblings of its own,
2270 the child will also be blocked."
2282 "Non-nil means unchecked boxes will block switching the parent to DONE.
2283 When this is nil, checkboxes have no influence on switching TODO states.
2284 When non-nil, you first need to check off all check boxes before the TODO
2285 entry can be switched to DONE.
2286 This variable needs to be set before org.el is loaded, and you need to
2287 restart Emacs after a change to make the change effective. The only way
2288 to change is while Emacs is running is through the customize interface."
2300 "Non-nil means inserting a TODO heading is treated as state change.
2302 logging will apply if appropriate. When nil, the new TODO item will
2303 be inserted directly, and no logging will take place."
2308 "Non-nil means switching TODO states with S-cursor counts as state change.
2309 This is the default behavior. However, setting this to nil allows a
2310 convenient way to select a TODO state and bypass any logging associated
2311 with that."
2316 "Tag changes that should be triggered by TODO state changes.
2317 This is a list. Each entry is
2319 (state-change (tag . flag) .......)
2321 State-change can be a string with a state, and empty string to indicate the
2322 state that has no TODO keyword, or it can be one of the symbols `todo'
2323 or `done', meaning any not-done or done state, respectively."
2337 "Information to record when a task moves to the DONE state.
2339 Possible values are:
2341 nil Don't add anything, just change the keyword
2342 time Add a time stamp to the task
2343 note Prompt for a note and add it with template `org-log-note-headings'
2345 This option can also be set with on a per-file-basis with
2347 #+STARTUP: nologdone
2348 #+STARTUP: logdone
2349 #+STARTUP: lognotedone
2351 You can have local logging settings for a subtree by setting the LOGGING
2352 property to one or more of these keywords."
2360 ;; Normalize old uses of org-log-done.
2367 "Information to record when the scheduling date of a tasks is modified.
2369 Possible values are:
2371 nil Don't add anything, just change the date
2372 time Add a time stamp to the task
2373 note Prompt for a note and add it with template `org-log-note-headings'
2375 This option can also be set with on a per-file-basis with
2377 #+STARTUP: nologreschedule
2378 #+STARTUP: logreschedule
2379 #+STARTUP: lognotereschedule"
2388 "Information to record when the deadline date of a tasks is modified.
2390 Possible values are:
2392 nil Don't add anything, just change the date
2393 time Add a time stamp to the task
2394 note Prompt for a note and add it with template `org-log-note-headings'
2396 This option can also be set with on a per-file-basis with
2398 #+STARTUP: nologredeadline
2399 #+STARTUP: logredeadline
2400 #+STARTUP: lognoteredeadline
2402 You can have local logging settings for a subtree by setting the LOGGING
2403 property to one or more of these keywords."
2412 "Non-nil means record a note when clocking out of an item.
2413 This can also be configured on a per-file basis by adding one of
2414 the following lines anywhere in the buffer:
2416 #+STARTUP: lognoteclock-out
2417 #+STARTUP: nolognoteclock-out"
2423 "Non-nil means the CLOSED time stamp will contain date and time.
2424 When nil, only the date will be recorded."
2438 "Headings for notes added to entries.
2439 The value is an alist, with the car being a symbol indicating the note
2440 context, and the cdr is the heading to be used. The heading may also be the
2441 empty string.
2442 %t in the heading will be replaced by a time stamp.
2443 %T will be an active time stamp instead the default inactive one
2444 %d will be replaced by a short-format time stamp.
2445 %D will be replaced by an active short-format time stamp.
2446 %s will be replaced by the new TODO state, in double quotes.
2447 %S will be replaced by the old TODO state, in double quotes.
2448 %u will be replaced by the user name.
2449 %U will be replaced by the full user name.
2451 In fact, it is not a good idea to change the `state' entry, because
2452 agenda log mode depends on the format of these entries."
2458 "Heading when changing todo state (todo sequence only)"
2472 "Non-nil means insert state change notes and time stamps into a drawer.
2473 When nil, state changes notes will be inserted after the headline and
2474 any scheduling and clock lines, but not inside a drawer.
2476 The value of this variable should be the name of the drawer to use.
2477 LOGBOOK is proposed as the default drawer for this purpose, you can
2478 also set this to a string to define the drawer of your choice.
2482 If this variable is set, `org-log-state-notes-insert-after-drawers'
2483 will be ignored.
2485 You can set the property LOG_INTO_DRAWER to overrule this setting for
2486 a subtree."
2498 "Return the value of `org-log-into-drawer', but let properties overrule.
2499 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2500 used instead of the default value."
2509 "Non-nil means insert state change notes after any drawers in entry.
2510 Only the drawers that *immediately* follow the headline and the
2511 deadline/scheduled line are skipped.
2512 When nil, insert notes right after the heading and perhaps the line
2513 with deadline/scheduling if present.
2515 This variable will have no effect if `org-log-into-drawer' is
2516 set."
2522 "Non-nil means the latest state note will be directly after heading.
2523 When nil, the state change notes will be ordered according to time."
2529 "The TODO state to which a repeater should return the repeating task.
2530 By default this is the first task in a TODO sequence, or the previous state
2531 in a TODO_TYP set. But you can specify another task here.
2532 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2539 "Non-nil means record moving through the DONE state when triggering repeat.
2540 An auto-repeating task is immediately switched back to TODO when
2543 record a closing note, there will be no record of the task moving
2544 through DONE. This variable forces taking a note anyway.
2546 nil Don't force a record
2547 time Record a time stamp
2548 note Prompt for a note and add it with template `org-log-note-headings'
2550 This option can also be set with on a per-file-basis with
2552 #+STARTUP: nologrepeat
2553 #+STARTUP: logrepeat
2554 #+STARTUP: lognoterepeat
2556 You can have local logging settings for a subtree by setting the LOGGING
2557 property to one or more of these keywords."
2567 "Priorities in Org-mode."
2572 "Non-nil means priority commands are active.
2573 When nil, these commands will be disabled, so that you never accidentally
2574 set a priority."
2579 "The highest priority of TODO items. A character like ?A, ?B etc.
2580 Must have a smaller ASCII number than `org-lowest-priority'."
2585 "The lowest priority of TODO items. A character like ?A, ?B etc.
2586 Must have a larger ASCII number than `org-highest-priority'."
2591 "The default priority of TODO items.
2592 This is the priority an item gets if no explicit priority is given.
2593 When starting to cycle on an empty priority the first step in the cycle
2594 depends on `org-priority-start-cycle-with-default'. The resulting first
2595 step priority must not exceed the range from `org-highest-priority' to
2596 `org-lowest-priority' which means that `org-default-priority' has to be
2597 in this range exclusive or inclusive the range boundaries. Else the
2598 first step refuses to set the default and the second will fall back
2599 to (depending on the command used) the highest or lowest priority."
2604 "Non-nil means start with default priority when starting to cycle.
2605 When this is nil, the first step in the cycle will be (depending on the
2606 command used) one higher or lower than the default priority.
2607 See also `org-default-priority'."
2612 "Function to extract the priority from a string.
2613 The string is normally the headline. If this is nil Org computes the
2614 priority from the priority cookie like [#A] in the headline. It returns
2615 an integer, increasing by 1000 for each priority level.
2616 The user can set a different function here, which should take a string
2617 as an argument and return the numeric priority."
2623 "Options concerning time stamps and deadlines in Org-mode."
2628 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2629 When nil, these labeled time stamps are forces into the second line of an
2630 entry, just after the headline. When scheduling from the global TODO list,
2631 the time stamp will always be forced into the second line."
2636 "Formats for `format-time-string' which are used for time stamps.
2640 "Number of minutes to round time stamps to.
2641 These are two values, the first applies when first creating a time stamp.
2642 The second applies when changing it with the commands `S-up' and `S-down'.
2643 When changing the time stamp, this means that it will change in steps
2644 of N minutes, as given by the second value.
2646 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2647 numbers should be factors of 60, so for example 5, 10, 15.
2649 When this is larger than 1, you can still force an exact time stamp by using
2650 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2651 and by using a prefix arg to `S-up/down' to specify the exact number
2652 of minutes to shift."
2662 ;; Normalize old customizations of this variable.
2666 org-time-stamp-rounding-minutes)))
2669 "Non-nil means overlay custom formats over all time stamps.
2670 The formats are defined through the variable `org-time-stamp-custom-formats'.
2671 To turn this on on a per-file basis, insert anywhere in the file:
2672 #+STARTUP: customtime"
2680 "Custom formats for time stamps. See `format-time-string' for the syntax.
2681 These are overlaid over the default ISO format if the variable
2682 `org-display-custom-times' is set. Time like %H:%M should be at the
2683 end of the second format. The custom formats are also honored by export
2684 commands, if custom time display is turned on at the time of export."
2689 "Get the right format for a time string."
2694 f)))
2697 "The format string used when creating CLOCKSUM lines.
2698 This is also used when org-mode generates a time duration."
2704 org-mode generates a time duration."
2709 "The format string used when creating CLOCKSUM lines, or when
2710 org-mode generates a time duration."
2715 "No. of days before expiration during which a deadline becomes active.
2716 This variable governs the display in sparse trees and in the agenda.
2717 When 0 or negative, it means use this number (the absolute value of it)
2718 even if a deadline has a different individual lead time specified.
2720 Custom commands can set this variable in the options section."
2726 "Non-nil means assume future for incomplete date input from user.
2727 This affects the following situations:
2728 1. The user gives a month but not a year.
2731 2. The user gives a day, but no month.
2734 it will be considered as *this* month.
2736 If you set this variable to the symbol `time', then also the following
2737 will work:
2739 3. If the user gives a time.
2740 If the time is before now, it will be interpreted as tomorrow.
2742 Currently none of this works for ISO week specifications.
2744 When this option is nil, the current day, month and year will always be
2745 used as defaults.
2747 See also `org-agenda-jump-prefer-future'."
2755 "Should the agenda jump command prefer the future for incomplete dates?
2756 The default is to do the same as configured in `org-read-date-prefer-future'.
2757 But you can also set a deviating value here.
2758 This may t or nil, or the symbol `org-read-date-prefer-future'."
2764 org-read-date-prefer-future)
2769 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2771 Depending on the system Emacs is running on, certain dates cannot
2772 be represented with the type used internally to represent time.
2773 Dates between 1970-1-1 and 2038-1-1 can always be represented
2774 correctly. Some systems allow for earlier dates, some for later,
2775 some for both. One way to find out it to insert any date into an
2776 Org buffer, putting the cursor on the year and hitting S-up and
2777 S-down to test the range.
2779 When this variable is set to t, the date/time prompt will not let
2780 you specify dates outside the 1970-2037 range, so it is certain that
2781 these dates will work in whatever version of Emacs you are
2782 running, and also that you can move a file from one Emacs implementation
2783 to another. WHenever Org is forcing the year for you, it will display
2784 a message and beep.
2786 When this variable is nil, Org will check if the date is
2787 representable in the specific Emacs implementation you are using.
2788 If not, it will force a year, usually the current year, and beep
2789 to remind you. Currently this setting is not recommended because
2790 the likelihood that you will open your Org files in an Emacs that
2791 has limited date range is not negligible.
2793 A workaround for this problem is to use diary sexp dates for time
2794 stamps outside of this range."
2800 "Non-nil means display current interpretation of date prompt live.
2801 This display will be in an overlay, in the minibuffer."
2806 "Non-nil means pop up a calendar when prompting for a date.
2807 In the calendar, the date can be selected with mouse-1. However, the
2808 minibuffer will also be active, and you can simply enter the date as well.
2809 When nil, only the minibuffer will be available."
2817 "Hook to be used to set up keys for the date/time interface.
2818 Add key definitions to `minibuffer-local-map', which will be a temporary
2819 copy."
2824 "The hour when your day really ends. Must be an integer.
2825 This has influence for the following applications:
2827 the time given here, the day recognized as TODAY is actually yesterday.
2828 - When a date is read from the user and it is still before the time given
2829 here, the current date and time will be assumed to be yesterday, 23:59.
2830 Also, timestamps inserted in capture templates follow this rule.
2832 IMPORTANT: This is a feature whose implementation is and likely will
2833 remain incomplete. Really, it is only here because past midnight seems to
2834 be the favorite working time of John Wiegley :-)"
2839 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2840 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2842 23:59 of the previous day."
2848 "Non-nil means S-down will increase the time in a time stamp.
2849 When nil, S-up will increase."
2854 "Non-nil means make the calendar window follow timestamp changes.
2855 When a timestamp is modified and the calendar window is visible, it will be
2856 moved to the new date."
2861 "Options concerning tags in Org-mode."
2866 "List of tags allowed in Org-mode files.
2867 When this list is nil, Org-mode will base TAG input on what is already in the
2868 buffer.
2869 The value of this variable is an alist, the car of each entry must be a
2870 keyword as a string, the cdr may be a character that is used to select
2871 that tag through the fast-tag-selection interface.
2872 See the manual for details."
2887 "List of tags that will always appear in all Org-mode files.
2888 This is in addition to any in buffer settings or customizations
2889 of `org-tag-alist'.
2890 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2891 The value of this variable is an alist, the car of each entry must be a
2892 keyword as a string, the cdr may be a character that is used to select
2893 that tag through the fast-tag-selection interface.
2894 See the manual for details.
2895 To disable these tags on a per-file basis, insert anywhere in the file:
2896 #+STARTUP: noptag"
2907 "If non-nil, always offer completion for all tags of all agenda files.
2908 Instead of customizing this variable directly, you might want to
2909 set it locally for capture buffers, because there no list of
2910 tags in that file can be created dynamically (there are none).
2912 (add-hook 'org-capture-mode-hook
2913 (lambda ()
2914 (set (make-local-variable
2915 'org-complete-tags-always-offer-all-agenda-tags)
2916 t)))"
2922 "List of tags that can be inherited by all entries in the file.
2923 The tags will be inherited if the variable `org-use-tag-inheritance'
2924 says they should be.
2928 "Non-nil means use fast tag selection scheme.
2929 This is a special interface to select and deselect tags with single keys.
2930 When nil, fast selection is never used.
2931 When the symbol `auto', fast selection is used if and only if selection
2932 characters for tags have been configured, either through the variable
2933 `org-tag-alist' or through a #+TAGS line in the buffer.
2934 When t, fast selection is always used and selection keys are assigned
2935 automatically if necessary."
2943 "Non-nil means fast tag selection exits after first change.
2944 When nil, you have to press RET to exit it.
2945 During fast tag selection, you can toggle this flag with `C-c'.
2946 This variable can also have the value `expert'. In this case, the window
2947 displaying the tags menu is not even shown, until you press C-c again."
2955 "Non-nil means fast tags selection interface will also offer TODO states.
2959 "The column to which tags should be indented in a headline.
2960 If this number is positive, it specifies the column. If it is negative,
2961 it means that the tags should be flushright to that column. For example,
2962 -80 works well for a normal 80 character screen.
2963 When 0, place tags directly after headline text, with only one space in
2964 between."
2969 "Non-nil keeps tags aligned when modifying headlines.
2970 Some operations (i.e. demoting) change the length of a headline and
2971 therefore shift the tags around. With this option turned on, after
2972 each such operation the tags are again aligned to `org-tags-column'."
2977 "Non-nil means tags in levels apply also for sublevels.
2978 When nil, only the tags directly given in a specific line apply there.
2979 This may also be a list of tags that should be inherited, or a regexp that
2980 matches tags that should be inherited. Additional control is possible
2981 with the variable `org-tags-exclude-from-inheritance' which gives an
2982 explicit list of tags to be excluded from inheritance., even if the value of
2983 `org-use-tag-inheritance' would select it for inheritance.
2985 If this option is t, a match early-on in a tree can lead to a large
2986 number of matches in the subtree when constructing the agenda or creating
2987 a sparse tree. If you only want to see the first match in a tree during
2988 a search, check out the variable `org-tags-match-list-sublevels'."
2997 "List of tags that should never be inherited.
2998 This is a way to exclude a few tags from inheritance. For way to do
2999 the opposite, to actively allow inheritance for selected tags,
3000 see the variable `org-use-tag-inheritance'."
3005 "Check if TAG is one that should be inherited."
3017 "Non-nil means list also sublevels of headlines matching a search.
3018 This variable applies to tags/property searches, and also to stuck
3019 projects because this search is based on a tags match as well.
3021 When set to the symbol `indented', sublevels are indented with
3022 leading dots.
3024 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3025 the sublevels of a headline matching a tag search often also match
3026 the same search. Listing all of them can create very long lists.
3027 Setting this variable to nil causes subtrees of a match to be skipped.
3029 This variable is semi-obsolete and probably should always be true. It
3030 is better to limit inheritance to certain tags using the variables
3031 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3039 "When set, tags are sorted using this function as a comparator."
3055 "Options concerning properties in Org-mode."
3060 "How property key/value pairs should be formatted by `indent-line'.
3061 When `indent-line' hits a property definition, it will format the line
3062 according to this format, mainly to make sure that the values are
3063 lined-up with respect to each other."
3068 "Alist of properties and functions to adjust inserted values.
3069 Elements of this alist must be of the form
3071 ([string] [function])
3073 where [string] must be a property name and [function] must be a
3074 lambda expression: this lambda expression must take one argument,
3075 the value to adjust, and return the new value as a string.
3079 and the clock summary:
3082 (let ((clocksum (org-clock-sum-current-item))
3083 (effort (org-duration-string-to-minutes
3085 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3092 "Non-nil means properties apply also for sublevels.
3094 This setting is chiefly used during property searches. Turning it on can
3095 cause significant overhead when doing a search, which is why it is not
3096 on by default.
3098 When nil, only the properties directly given in the current entry count.
3099 When t, every property is inherited. The value may also be a list of
3100 properties that should have inheritance, or a regular expression matching
3101 properties that should be inherited.
3103 However, note that some special properties use inheritance under special
3104 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3106 for valid values of a property.
3108 Note for programmers:
3109 When querying an entry with `org-entry-get', you can control if inheritance
3110 should be used. By default, `org-entry-get' looks only at the local
3111 properties. You can request inheritance by setting the inherit argument
3112 to t (to force inheritance) or to `selective' (to respect the setting
3113 in this variable)."
3122 "Check if PROPERTY is one that should be inherited."
3133 "The default column format, if no other format has been defined.
3134 This variable can be set on the per-file basis by inserting a line
3136 #+COLUMNS: %25ITEM ....."
3141 "The ellipses to be used when a field in column view is truncated.
3142 When this is the empty string, as many characters as possible are shown,
3143 but then there will be no visual indication that the field has been truncated.
3144 When this is a string of length N, the last N characters of a truncated
3145 field are replaced by this string. If the column is narrower than the
3146 ellipses string, only part of the ellipses string will be shown."
3151 "Function that modifies values for display in column view.
3152 For example, it can be used to cut out a certain part from a time stamp.
3153 The function must take 2 arguments:
3155 column-title The title of the column (*not* the property name)
3156 value The value that should be modified.
3158 The function should return the value that should be displayed,
3159 or nil if the normal value should be used."
3164 "The property that is being used to keep track of effort estimates.
3165 Effort estimates given in this property need to have the format H:MM."
3173 "List of property/value pairs that can be inherited by any entry.
3175 These are fixed values, for the preset properties. The user variable
3176 that can be used to add to this list is `org-global-properties'.
3178 The entries in this list are cons cells where the car is a property
3179 name and cdr is a string with the value. If the value represents
3184 "List of property/value pairs that can be inherited by any entry.
3186 This list will be combined with the constant `org-global-properties-fixed'.
3188 The entries in this list are cons cells where the car is a property
3189 name and cdr is a string with the value.
3191 You can set buffer-local values for the same purpose in the variable
3192 `org-file-properties' this by adding lines like
3194 #+PROPERTY: NAME VALUE"
3201 "List of property/value pairs that can be inherited by any entry.
3202 Valid for the current buffer.
3207 "Options concerning agenda views in Org-mode."
3212 "Variable used by org files to set a category for agenda display.
3213 Such files should use a file variable to set it, for example
3217 or contain a special line
3219 #+CATEGORY: ELisp
3221 If the file does not specify a category, then file's base name
3227 "The files to be used for agenda display.
3231 If an entry is a directory, all files in that directory that are matched by
3232 `org-agenda-file-regexp' will be part of the file list.
3234 If the value of the variable is not a list but a single file name, then
3235 the list of agenda files is actually stored and maintained in that file, one
3236 agenda file per line. In this file paths can be given relative to
3237 `org-directory'. Tilde expansion and environment variable substitution
3238 are also made."
3245 "Regular expression to match files for `org-agenda-files'.
3246 If any element in the list in that variable contains a directory instead
3247 of a normal file, all files in that directory that are matched by this
3248 regular expression will be included."
3253 "List of extra files to be searched by text search commands.
3254 These files will be search in addition to the agenda files by the
3255 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3256 Note that these files will only be searched for text search commands,
3257 not for the other agenda views like todo lists, tag searches or the weekly
3258 agenda. This variable is intended to list notes and possibly archive files
3259 that should also be searched by these two commands.
3260 In fact, if the first element in the list is the symbol `agenda-archives',
3261 than all archive files of all agenda files will be added to the search
3262 scope."
3273 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3274 A nil value means to remove them, after a query, from the list."
3279 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3280 The command `org-calendar-goto-agenda' will be bound to this key. The
3281 default is the character `c' because then `c' can be used to switch back and
3282 forth between agenda and calendar."
3287 "The key to be installed in `calendar-mode-map' for adding diary entries.
3288 This option is irrelevant until `org-agenda-diary-file' has been configured
3289 to point to an Org-mode file. When that is the case, the command
3290 `org-agenda-diary-entry' will be bound to the key given here, by default
3291 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3292 if you want to continue doing this, you need to change this to a different
3293 key."
3298 "File to which to add new entries with the `i' key in agenda and calendar.
3299 When this is the symbol `diary-file', the functionality in the Emacs
3300 calendar will be used to add entries to the `diary-file'. But when this
3301 points to a file, `org-agenda-diary-entry' will be used instead."
3315 org-calendar-insert-diary-entry-key
3319 "Options for embedding LaTeX code into Org-mode."
3327 "Options for creating images from LaTeX fragments.
3328 This is a property list with the following properties:
3330 `default' means use the foreground of the default face.
3332 `default' means use the background of the default face.
3333 :scale a scaling factor for the size of the images, to get more pixels
3334 :html-foreground, :html-background, :html-scale
3335 the same numbers for HTML export.
3336 :matchers a list indicating which matchers should be used to
3337 find LaTeX fragments. Valid members of this list are:
3348 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3349 When nil, just push out a message."
3356 Use this to specify additional executable file say a jar file.
3358 When using MathToWeb as the converter, specify the full-path to
3359 your mathtoweb.jar file."
3367 "Command to convert LaTeX fragments to MathML.
3368 Replace format-specifiers in the command as noted below and use
3369 `shell-command' to convert LaTeX to MathML.
3370 %j: Executable file in fully expanded form as specified by
3371 `org-latex-to-mathml-jar-file'.
3372 %I: Input LaTeX file in fully expanded form
3373 %o: Output MathML file
3374 This command is used by `org-create-math-formula'.
3376 When using MathToWeb as the converter, set this to
3385 "Program to convert LaTeX fragments with.
3387 dvipng Process the LaTeX fragments to dvi file, then convert
3388 dvi files to png files using dvipng.
3389 This will also include processing of non-math environments.
3390 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3391 to convert pdf files to png files"
3399 "Path to store latex preview images. A relative path here creates many
3400 directories relative to the processed org files paths. An absolute path
3401 puts all preview images at the same place."
3407 "Return t if `org-latex-to-mathml-convert-command' is usable."
3410 org-latex-to-mathml-convert-command)
3412 org-latex-to-mathml-convert-command))))
3417 t))))))
3424 \[PACKAGES]
3425 \[DEFAULT-PACKAGES]
3426 % The settings below are copied from fullpage.sty
3439 "The document header used for processing LaTeX fragments.
3440 It is imperative that this header make sure that no page number
3441 appears on the page. The package defined in the variables
3442 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3444 will be appended."
3451 "Set the packages alist and make sure it has 3 elements per entry."
3455 x))
3456 val)))
3460 "Get the packages alist and make sure it has 3 elements per entry."
3464 x))
3467 ;; The following variables are defined here because is it also used
3468 ;; when formatting latex fragments. Originally it was part of the
3469 ;; LaTeX exporter, which is why the name includes "export".
3486 )
3487 "Alist of default packages to be inserted in the header.
3488 Change this only if one of the packages here causes an incompatibility
3489 with another package you are using.
3490 The packages in this list are needed by one part or another of Org-mode
3491 to function properly.
3493 - inputenc, fontenc: for basic font and character selection
3494 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3495 for interpreting the entities in `org-entities'. You can skip some of these
3496 packages if you don't use any of the symbols in it.
3497 - graphicx: for including images
3498 - float, wrapfig: for figure placement
3499 - longtable: for long tables
3500 - hyperref: for cross references
3502 Therefore you should not modify this variable unless you know what you
3503 are doing. The one reason to change it anyway is that you might be loading
3504 some other package that conflicts with one of the default packages.
3506 If SNIPPET-FLAG is t, the package also needs to be included when
3507 compiling LaTeX snippets into images for inclusion into HTML."
3521 "Alist of packages to be inserted in every LaTeX header.
3522 These will be inserted after `org-export-latex-default-packages-alist'.
3524 SNIPPET-FLAG, when t, indicates that this package is also needed when
3525 turning LaTeX snippets into images for inclusion into HTML.
3526 Make sure that you only list packages here which:
3527 - you want in every file
3528 - do not conflict with the default packages in
3529 `org-export-latex-default-packages-alist'
3530 - do not conflict with the setup in `org-format-latex-header'."
3544 "Settings for Org-mode appearance."
3549 "Non-nil means fontify only the stars in each headline.
3550 When nil, the entire headline is fontified.
3551 Changing it requires restart of `font-lock-mode' to become effective
3552 also in regions already fontified."
3557 "Non-nil means hide the first N-1 stars in a headline.
3558 This works by using the face `org-hide' for these stars. This
3559 face is white for a light background, and black for a dark
3560 background. You may have to customize the face `org-hide' to
3561 make this work.
3562 Changing it requires restart of `font-lock-mode' to become effective
3563 also in regions already fontified.
3564 You may also set this on a per-file basis by adding one of the following
3565 lines to the buffer:
3567 #+STARTUP: hidestars
3568 #+STARTUP: showstars"
3573 "List of symbols corresponding to keywords to be hidden the org buffer.
3574 For example, a value '(title) for this list will make the document's title
3575 appear in the buffer without the initial #+TITLE: keyword."
3584 "List of properties (as strings) with a special meaning.
3585 The default use of these custom properties is to let the user
3586 hide them with `org-toggle-custom-properties-visibility'."
3593 "Non-nil means change the face of a headline if it is marked DONE.
3594 Normally, only the TODO/DONE keyword indicates the state of a headline.
3595 When this is non-nil, the headline after the keyword is set to the
3596 `org-headline-done' as an additional indication."
3601 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3602 Changing this variable requires a restart of Emacs to take effect."
3607 "Non-nil means fontify the whole line for headings.
3608 This is useful when setting a background color for the
3609 org-level-* faces."
3614 "Non-nil means fontify what is treated specially by the exporters."
3619 "Non-nil mean font-lock should hide the emphasis marker characters."
3624 "Non-nil means show entities as UTF8 characters.
3631 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3637 "Regular expression for matching emphasis.
3638 After a match, the match groups contain these elements:
3639 0 The match of the full regular expression, including the characters
3640 before and after the proper match
3641 1 The character before the proper match, or empty at beginning of line
3642 2 The proper match, including the leading and trailing markers
3643 3 The leading marker like * or /, indicating the type of highlighting
3644 4 The text between the emphasis markers, not including the markers
3651 "Set variable and compute the emphasis regular expression."
3655 org-emphasis-alist org-emphasis-regexp-components)
3667 ;; make sure special characters appear at the right position in the class
3679 ;; Make the regexp
3687 body1
3699 body1
3707 "Components used to build the regular expression for emphasis.
3708 This is a list with five entries. Terminology: In an emphasis string
3712 specify what is allowed/forbidden in each part:
3714 pre Chars allowed as prematch. Beginning of line will be allowed too.
3715 post Chars allowed as postmatch. End of line will be allowed too.
3716 border The chars *forbidden* as border characters.
3718 non-shy groups here, and don't allow newline here.
3719 newline The maximum number of newlines allowed in an emphasis exp.
3721 Use customize to modify this, or restart Emacs after changing it."
3740 )
3741 "Special syntax for emphasized text.
3742 Text starting and ending with a special character will be emphasized, for
3743 example *bold*, _underlined_ and /italic/. This variable sets the marker
3744 characters, the face to be used by font-lock for highlighting in Org-mode
3745 Emacs buffers, and the HTML tags to be used for this.
3746 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3747 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3748 Use customize to modify this, or restart Emacs after changing it."
3763 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3766 ;;; Miscellaneous options
3769 "Completion in Org-mode."
3774 "Non-nil means use ido completion wherever possible.
3775 Note that `ido-mode' must be active for this variable to be relevant.
3776 If you decide to turn this variable on, you might well want to turn off
3777 `org-outline-path-complete-in-steps'.
3778 See also `org-completion-use-iswitchb'."
3783 "Non-nil means use iswitchb completion wherever possible.
3784 Note that `iswitchb-mode' must be active for this variable to be relevant.
3785 If you decide to turn this variable on, you might well want to turn off
3786 `org-outline-path-complete-in-steps'.
3787 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3793 Normal means, no org-mode-specific context."
3797 ;;; Functions and variables from their packages
3798 ;; Declared here to avoid compiler warnings
3800 ;; XEmacs only
3806 ;; Emacs only
3809 ;; Various packages
3828 org-agenda-format-item "org-agenda"
3859 ;;; Autoload and prepare some org modules
3861 ;; Some table stuff that needs to be defined here, because it is used
3862 ;; by the functions setting up org-mode or checking for table context.
3875 "Detect the first line outside a table when searching from within it.
3878 ;; Autoload the functions in org-table.el that are needed by functions here.
3884 ;;;###autoload
3886 "Unconditionally turn on `orgtbl-mode'."
3891 "Return t if the cursor is inside an org-type table.
3892 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3897 org-table-line-regexp)))
3898 nil))
3902 "Return t if and only if we are at a table.el table."
3908 "If there is a table.el table nearby, recognize it and move into it."
3914 nil
3924 t
3929 t)
3930 nil)
3931 nil))
3934 "Return t if the cursor is inside a hline in a table."
3939 nil))
3944 "Apply FUNCTION to the start of all tables in the buffer."
3954 ;; Exclude tables in src/example/verbatim/clocktable blocks
3962 ;; Declare and autoload functions from org-exp.el & Co
3968 ;; Declare and autoload functions from org-agenda.el
3986 "Return non-nil if clock is currently running.
3987 The return value is actually the clock marker."
3992 org-clock-update-time-maybe
3993 org-clocktable-shift)))
3996 "Check if the current buffer contains the running clock.
3997 If yes, offer to stop it and to save the buffer with the changes."
4006 "Check if this line starts a clock table, if yes, shift the time block."
4010 ;;;###autoload
4012 "Set up hooks for clock persistence."
4017 ;; Define the variable already here, to make sure we have it.
4019 "Non-nil if Org-Indent mode is enabled.
4022 ;; Autoload archiving code
4023 ;; The stuff that is needed for cycling and tags has to be defined here.
4026 "Options concerning archiving in Org-mode."
4031 "The location where subtrees should be archived.
4033 The value of this variable is a string, consisting of two parts,
4034 separated by a double-colon. The first part is a filename and
4035 the second part is a headline.
4037 When the filename is omitted, archiving happens in the same file.
4038 %s in the filename will be replaced by the current file
4039 name (without the directory part). Archiving to a different file
4040 is useful to keep archived entries from contributing to the
4041 Org-mode Agenda.
4043 The archived entries will be filed as subtrees of the specified
4044 headline. When the headline is omitted, the subtrees are simply
4045 filed away at the end of the file, as top-level entries. Also in
4046 the heading you can use %s to represent the file name, this can be
4047 useful when using the same archive for a number of different files.
4049 Here are a few examples:
4051 If the current file is Projects.org, archive in file
4052 Projects.org_archive, as top-level trees. This is the default.
4055 Archive in the current file, under the top-level headline
4059 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4062 Archive in file ~/org/archive.org (absolute path), under headlines
4067 items to the datetree. Items are placed in either the CLOSED
4068 date of the item, or the current date if there is no CLOSED date.
4069 The heading will be a subentry to the current date. There doesn't
4070 need to be a heading, but there always needs to be a slash after
4071 datetree. For example, to store archived items directly in the
4075 Archive in file ./basement (relative path), as level 3 trees
4078 You may set this option on a per-file basis by adding to the buffer a
4079 line like
4081 #+ARCHIVE: basement::** Finished Tasks
4083 You may also define it locally for a subtree by setting an ARCHIVE property
4084 in the entry. If such a property is found in an entry, or anywhere up
4085 the hierarchy, it will be used."
4090 "The tag that marks a subtree as archived.
4091 An archived subtree does not open during visibility cycling, and does
4092 not contribute to the agenda listings.
4093 After changing this, font-lock must be restarted in the relevant buffers to
4094 get the proper fontification."
4100 "Non-nil means the agenda will skip any items located in archived trees.
4101 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4102 variable is no longer recommended, you should leave it at the value t.
4103 Instead, use the key `v' to cycle the archives-mode in the agenda."
4109 "Non-nil means ignore archived trees when creating column view."
4115 "Non-nil means `org-cycle' will open archived trees.
4116 An archived tree is a tree marked with the tag ARCHIVE.
4117 When nil, archived trees will stay folded. You can still open them with
4118 normal outline commands like `show-all', but not with the cycling commands."
4124 "Non-nil means sparse tree construction shows matches in archived trees.
4125 When nil, matches in these trees are highlighted, but the trees are kept in
4126 collapsed state."
4132 "The default date type when building a sparse tree.
4133 When this is nil, a date is a scheduled or a deadline timestamp.
4134 Otherwise, these types are allowed:
4136 all: all timestamps
4137 active: only active timestamps (<...>)
4138 inactive: only inactive timestamps (<...)
4139 scheduled: only scheduled timestamps
4140 deadline: only deadline timestamps"
4151 "Re-hide all archived subtrees after a visibility state change."
4162 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4165 "Cycle subtree even if it is archived."
4172 "Re-hide all archived subtrees after a visibility state change."
4189 flag)))
4197 ;; Autoload Column View Code
4205 org-columns-get-format-and-top-level
4206 org-columns-compute
4207 org-columns-remove-overlays))
4209 ;; Autoload ID code
4217 org-id-copy
4218 org-id-get-with-outline-path-completion
4219 org-id-get-with-outline-drilling))
4221 ;;; Variables for pre-computed regular expressions, all buffer local
4239 "Matches a headline and puts everything into groups:
4240 group 1: the stars
4241 group 2: The todo keyword, maybe
4242 group 3: Priority cookie
4243 group 4: True headline
4247 "Printf format to make regexp to match an exact headline.
4248 This regexp will match the headline of any node which has the
4249 exact headline text that is put into the format, but may have any
4253 "Matches a headline and puts TODO state into group 2 if present.
4299 "Regular expression to match a plain time or time range.
4300 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4301 groups carry important information:
4302 0 the full match
4303 1 the first time, range or not
4311 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4312 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4313 groups carry important information:
4314 0 the full match
4315 7 hours of duration
4324 "Regular expression to match a timestamp time or time range.
4325 After a match, the following groups carry important information:
4326 0 the full match
4327 1 date plus weekday, for back referencing to make sure both times are on the same day
4328 2 the first time, range or not
4383 "Variable associated with STARTUP options for org-mode.
4384 Each element is a list of three items: the startup options (as written
4385 in the #+STARTUP line), the corresponding variable, and the value to set
4386 this variable to if the option is found. An optional forth element PUSH
4390 "Update PROPS with KEY and VAL."
4404 "Printf format for a regexp matching an headline with some keyword.
4405 This regexp will match the headline of any node which has the
4406 exact keyword that is put into the format. The keyword isn't in
4410 "Printf format for a regexp matching an headline, possibly with some keyword.
4411 This regexp can match any headline with the specified keyword, or
4412 without a keyword. The keyword isn't in any group by default,
4416 "Precompute regular expressions for current buffer."
4436 kwds kws0 kwsa key log value cat arch tags const links hw dws
4437 tail sep kws1 prio props ftags drawers beamer-p
4459 ;; general TODO-like setup
4471 links)))
4478 props))))
4483 ftags
4493 l var val)
4523 ;; search for property blocks
4532 props)))))))
4549 ;; Process the TODO keywords
4551 ;; Use the global values as if they had been given locally.
4563 kws)))
4566 kwsa nil
4569 ;; 1 2
4577 kw)
4579 kws0)
4596 ;; Process the constants
4604 ;; Process the tags.
4615 tgs))
4623 ;; Compute the regular expressions and other local variables.
4624 ;; Using `org-outline-regexp-bol' would complicate them much,
4625 ;; because of the fixed white space at the end of that string.
4633 org-drawer-regexp
4637 org-not-done-keywords
4639 org-todo-regexp
4643 org-not-done-regexp
4647 org-not-done-heading-regexp
4649 org-todo-line-regexp
4651 org-complex-heading-regexp
4658 org-complex-heading-regexp-format
4663 ;; Stats cookies can be stuck to body.
4670 org-todo-line-tags-regexp
4677 org-deadline-time-regexp
4679 org-deadline-line-regexp
4681 org-scheduled-regexp
4683 org-scheduled-time-regexp
4685 org-closed-time-regexp
4687 org-keyword-time-regexp
4693 org-keyword-time-not-clock-regexp
4699 org-maybe-keyword-time-regexp
4705 org-all-time-keywords
4708 org-clock-string org-closed-string))
4709 )
4714 "Return the contents of FILE, as a string."
4728 "Extract the log state setting from a TODO keyword string.
4742 "Remove a pair of parenthesis at the end of each string in LIST."
4746 x))
4747 list))
4750 "Assign fast keys to a keyword-key alist.
4751 Respect keys that are already there."
4769 ;;; Some variables used in various places
4776 "Function to be called when `C-c C-c' is used.
4780 ;; FIXME: Occasionally check by commenting these, to make sure
4781 ;; no other functions uses these, forgetting to let-bind them.
4786 ;; Defined somewhere in this file, but used before definition.
4792 ;;;; Define the Org-mode
4794 ;; We use a before-change function to check if a table might need
4795 ;; an update.
4797 "Indicates that a table might need an update.
4798 This variable is set by `org-before-change-function'.
4801 "Every change indicates that a table might need an update."
4816 (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"))
4819 ;; Other stuff we need.
4827 ;; (require 'org-compat) moved higher up in the file before it is first used
4834 ;; babel
4843 ;;;###autoload
4845 "Outline-based notes management and organizer, alias
4848 Org-mode develops organizational tasks around a NOTES file which
4849 contains information about projects as plain text. Org-mode is
4850 implemented on top of outline-mode, which is ideal to keep the content
4851 of large files well structured. It supports ToDo items, deadlines and
4852 time stamps, which magically appear in the diary listing of the Emacs
4853 calendar. Tables are easily created with a built-in table editor.
4854 Plain text URL-like links connect to websites, emails (VM), Usenet
4855 messages (Gnus), BBDB entries, and any files related to the project.
4856 For printing and sharing of notes, an Org-mode file (or a part of it)
4857 can be exported as a structured ASCII or HTML file.
4859 The following commands are available:
4863 ;; Get rid of Outline menus, they are not needed
4864 ;; Need to do this here because define-derived-mode sets up
4865 ;; the keymap so late. Still, it is a waste to call this each time
4866 ;; we switch another buffer into org-mode.
4869 ;; Assume this is Greg's port, it uses easymenu
4895 org-display-table 4
4898 org-ellipsis)))
4903 ;; tag faces set outside customize.... force initialization.
4905 ;; Calc embedded
4911 ;; Activate before-change-function
4915 ;; Check for running clock before killing a buffer
4917 ;; Indentation.
4920 ;; Initialize radio targets.
4922 ;; Filling and auto-filling.
4924 ;; Comments.
4926 ;; Beginning/end of defun
4929 ;; Next error for sparse trees
4931 ;; Make sure dependence stuff works reliably, even for users who set it
4932 ;; too late :-(
4944 ;; Align options lines
4946 'align-mode-rules-list
4951 ;; Imenu
4955 ;; Make isearch reveal context
4958 ;; Emacs 21 and XEmacs make use of the hook
4960 ;; Emacs 22 deals with this through a special variable
4964 ;; Turn on org-beamer-mode?
4967 ;; Setup the pcomplete hooks
4980 ;; If empty file that did not turn on org-mode automatically, make it to.
4997 ;; Try to set org-hide correctly
5009 "unspecified-bg"
5022 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5032 "Return today date, considering `org-extend-today-until'."
5037 ;;;; Font-Lock stuff, including the activators
5068 "Regular expression used to analyze links.
5069 Here is what the match groups contain after a match:
5070 1: http:
5071 2: http
5072 3: path
5073 4: [desc]
5081 "Number of stacked braces for sub/superscript matching.
5082 This has to be set before loading org.el to be effective."
5087 "Create a regular expression which will match a balanced sexp.
5088 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5089 as single character strings.
5090 The regexp returned will match the entire expression including the
5091 delimiters. It will also define a single group which contains the
5092 match except for the outermost delimiters. The maximum depth of
5093 stacked delimiters is N. Escaping delimiters is not possible."
5122 "Update the link regular expressions.
5123 This should be called after the variable `org-link-types' has changed."
5127 org-link-re-with-space
5133 org-link-re-with-space2
5139 org-link-re-with-space3
5144 org-angle-link-re
5150 org-plain-link-re
5154 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5155 org-bracket-link-regexp
5157 org-bracket-link-analytic-regexp
5165 org-bracket-link-analytic-regexp++
5173 org-any-link-re
5182 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5185 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5186 "Regular expression matching time strings for analysis.
5187 This one does not require the space after the date, so it can be used
5189 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5205 "Regular expression matching a time stamp or time stamp range.
5211 "Run through the buffer and add overlays to emphasized strings."
5220 'face
5233 rtn))
5236 "Insert or change an emphasis, i.e. a font like bold or italic.
5237 If there is an active region, change that region to a new emphasis.
5238 If there is no region, just insert the marker characters and position
5239 the cursor between them.
5240 CHAR should be either the marker character, or the first character of the
5241 HTML tag associated with that emphasis. If CHAR is a space, the means
5242 to remove the emphasis of the selected region.
5243 If char is not given (for example in an interactive call) it
5244 will be prompted for."
5295 "Run through the buffer and add overlays to links."
5310 t))))
5318 t)))
5321 "When non-nil, fontify code in code blocks."
5328 "When non-nil, allow promoting a top level subtree.
5329 The leading star of the top level headline will be replaced
5330 by a #."
5341 "Fontify #+ lines and blocks, in the correct ways."
5344 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5345 limit t)
5353 end end1 quoting block-type ovl)
5356 ;; a single line of backend-specific content
5364 ; for backend-specific code
5365 t)
5367 ;; Truly a block
5380 beg end
5388 ;; remove old background overlays
5393 ;; add a background overlay
5408 t))
5428 t)
5434 ;; just any other in-buffer setting, but not indented
5438 t)
5442 "Run through the buffer and add overlays to links."
5451 t)))
5454 "Run through the buffer and add overlays to footnotes."
5461 'keymap org-mouse-map
5462 'help-echo
5464 "Footnote definition"
5466 'font-lock-fontified t
5467 'font-lock-multiline t
5471 "Run through the buffer and add overlays to bracketed links."
5476 ;; FIXME: above we should remove the escapes.
5477 ;; but that requires another match, protecting match data,
5478 ;; a lot of overhead for font-lock.
5485 ;; We need to remove the invisible property here. Table narrowing
5486 ;; may have made some of this invisible.
5504 t)))
5507 "Run through the buffer and add overlays to dates."
5519 t)))
5528 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5532 "Run through the buffer and add overlays to target matches."
5540 'keymap org-mouse-map
5544 t)))))
5547 "Find all radio targets in this file and update the regular expression."
5562 t)))
5569 ;; This should be with the exporter code, but we also use if for font-locking
5579 "Compute regular expression for stuff treated specially by exporters."
5586 org-latex-regexps)))
5613 org-entities)))
5617 org-latex-entities)
5618 nil))
5620 ))
5621 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5624 org-export-html-special-string-regexps)))
5629 ))))
5631 'org-latex-and-specials-regexp
5636 "Run through the buffer and add overlays to links."
5640 limit t))
5654 rtn)))
5657 "Restart `font-lock-mode', to force refontification."
5663 "Return a list of all targets in this file.
5664 With optional argument RADIO, only find radio targets."
5666 rtn)
5671 rtn)))
5674 "Make regular expression matching all strings in TARGETS.
5675 The regular expression finds the targets also if there is a line break
5676 between words."
5685 x)
5686 targets
5698 t)))
5701 "Compute the outline level of the heading at point.
5702 This function assumes that the cursor is at the beginning of a line matched
5703 by `outline-regexp'. Otherwise it returns garbage.
5704 If this is called at a normal headline, the level is the number of stars.
5705 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5712 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5719 "Functions that can manipulate `org-font-lock-extra-keywords'.
5720 This is called after `org-font-lock-extra-keywords' is defined, but before
5721 it is installed to be used by font lock. This can be useful if something
5725 "Run `org-font-lock-hook' within LIMIT."
5729 "Set font lock defaults for the current buffer."
5734 ;; Call the hook
5736 ;; Headlines
5743 ;; Table lines
5746 ;; Table internals
5751 ;; Drawers
5754 ;; Properties
5758 ;; Links
5768 ;; TODO keyword
5770 org-todo-regexp)
5772 ;; DONE
5780 nil)
5781 ;; Priorities
5783 ;; Tags
5785 ;; Special keywords
5790 ;; Emphasis
5795 ;; Checkboxes
5796 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5801 ;; Description list items
5804 ;; ARCHIVEd headings
5806 org-outline-regexp-bol
5809 ;; Specials
5813 ;; Code
5815 ;; COMMENT
5821 ;; Blocks and meta lines
5823 )))
5826 ;; Now set the full font-lock-keywords
5833 "Toggle the composition display of entities as UTF8 characters."
5849 "Display or hide properties in `org-custom-properties'."
5866 org-custom-properties)))))))
5869 "Find an entity to fontify."
5875 limit t)
5890 nil))))
5893 "Fontify string S like in Org-mode."
5905 "Get the right face for match N in font-lock matching of headlines."
5918 "Get the right face for a TODO keyword KWD.
5919 If KWD is a number, get the corresponding match group."
5927 "Create a face list that inherits INHERIT, but sets the foreground color.
5928 When FACE-OR-COLOR is not a string, just return it."
5932 face-or-color)
5933 face-or-color))
5936 "Add the special tag faces."
5945 "Add the special priority faces."
5953 org-priority-faces)))
5958 "Get the right face for a TODO keyword KWD.
5959 If KWD is a number, get the corresponding match group."
5966 "Remove fontification and activation overlays from links."
5971 deactivate-mark buffer-file-name buffer-file-truename)
5975 invisible t intangible t
5976 org-no-flyspell t org-emphasis t))
5986 "Remove specific display properties that have been added by font lock.
5987 The will remove the raise properties that are used to show superscripts
5988 and subscripts."
5998 "Add raise properties to sub/superscripts."
6002 org-match-substring-regexp
6003 org-match-substring-with-braces-regexp)
6004 limit t)
6014 ;; FIXME: Should we go back one character here, for a_b^c
6015 ;; (goto-char (1- pos)) ;????????????????????
6017 t
6019 'display
6035 t)))))
6037 ;;;; Visibility cycling, including org-goto and indirect buffer
6039 ;;; Cycling
6048 ;;;###autoload
6050 "TAB-action and visibility cycling for Org-mode.
6052 This is the command invoked in Org-mode by the TAB key. Its main purpose
6053 is outline visibility cycling, but it also invokes other actions
6054 in special contexts.
6056 - When this function is called with a prefix argument, rotate the entire
6057 buffer through 3 states (global cycling)
6058 1. OVERVIEW: Show only top-level headlines.
6059 2. CONTENTS: Show all headlines of all levels, but no body text.
6060 3. SHOW ALL: Show everything.
6061 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6062 determined by the variable `org-startup-folded', and by any VISIBILITY
6063 properties in the buffer.
6064 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6065 including any drawers.
6067 - When inside a table, re-align the table and move to the next field.
6069 - When point is at the beginning of a headline, rotate the subtree started
6070 by this line through 3 different states (local cycling)
6071 1. FOLDED: Only the main headline is shown.
6072 2. CHILDREN: The main headline and the direct children are shown.
6073 From this state, you can move to one of the children
6074 and zoom in further.
6075 3. SUBTREE: Show the entire subtree, including body text.
6076 If there is no subtree, switch directly from CHILDREN to FOLDED.
6078 - When point is at the beginning of an empty headline and the variable
6079 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6080 of the headline by demoting and promoting it to likely levels. This
6081 speeds up creation document structure by pressing TAB once or several
6082 times right after creating a new headline.
6084 - When there is a numeric prefix, go up to a heading with level ARG, do
6085 a `show-subtree' and return to the previous cursor position. If ARG
6086 is negative, go up that many levels.
6088 - When point is not at the beginning of a headline, execute the global
6089 binding for TAB, which is re-indenting the line. See the option
6090 `org-cycle-emulate-tab' for details.
6092 - Special case: if point is at the beginning of the buffer and there is
6093 no headline in line 1, this function will act as if called with prefix arg
6094 (C-u TAB, same as S-TAB) also when called without prefix arg.
6095 But only if also the variable `org-cycle-global-at-bob' is t."
6105 org-inlinetask-min-level
6110 limit-level)))
6113 outline-regexp
6121 org-cycle-hook))
6125 ;; special case: use global cycling
6139 ;; Table: enter it or move to the next field.
6150 ;; Global cycling: delegate to `org-cycle-internal-global'.
6153 ;; Drawers: delegate to `org-flag-drawer'.
6161 ;; Show-subtree, ARG levels up from here.
6169 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6177 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6184 ;; From there: TAB emulation and template completion.
6206 t
6215 "Do the global cycling action."
6216 ;; Hack to avoid display of messages for .org attachments in Gnus
6221 ;; We just created the overview - now do table of contents
6222 ;; This can be slow in very large buffers, so indicate action
6232 ;; We just showed the table of contents - now show everything
6240 ;; Default action: go to overview
6248 "Do the local cycling action."
6250 ;; First, determine end of headline (EOH), end of subtree or item
6251 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6271 ;; Determine end invisible part of buffer (EOL)
6273 ;; XEmacs doesn't have `next-single-char-property-change'
6283 ;; Find out what to do next and set `this-command'
6286 ;; Nothing is hidden behind this heading
6298 org-cycle-skip-children-state-if-no-children))))
6299 ;; Entire subtree is hidden in one line: children view
6305 ;; FIXME: This slows down the func way too much.
6306 ;; How keep drawers hidden in subtree anyway?
6307 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6308 ;; (org-cycle-hide-drawers 'subtree))
6310 ;; Fold every list in subtree to top-level items.
6332 ;; We just showed the children, or no children are there,
6333 ;; now show everything.
6340 ;; Default action: hide the subtree.
6347 ;;;###autoload
6349 "Cycle the global visibility. For details see `org-cycle'.
6351 With a numeric prefix, show all headlines up to that level."
6367 "Set the visibility required by startup options and properties."
6382 "Switch subtree visibilities according to :VISIBILITY: property."
6389 nil t)
6413 ;; This function uses outline-regexp instead of the more fundamental
6414 ;; org-outline-regexp so that org-cycle-global works outside of Org
6415 ;; buffers, where outline-regexp is needed.
6417 "Switch to overview mode, showing only top-level headlines.
6418 Really, this shows all headlines with level equal or greater than the level
6419 of the first headline in the buffer. This is important, because if the
6420 first headline is not level one, then (hide-sublevels 1) gives confusing
6421 results."
6432 "Show all headlines in the buffer, like a table of contents.
6433 With numerical argument N, show content up to level N."
6436 ;; Visit all headings and show their offspring
6443 t)
6452 "Adjust the window after a change in outline visibility.
6453 This function is the default value of the hook `org-cycle-hook'."
6463 "Remove outline overlays that do not contain non-white stuff."
6473 "Fix visibility issues after moving a subtree."
6474 ;; First, find a reasonable region to look at:
6475 ;; Start two siblings above, end three below
6493 ;; Properly fold already folded siblings
6504 "Show empty lines above all visible headlines.
6505 The region to be covered depends on STATE when called through
6506 `org-cycle-hook'. Lisp program can use t for STATE to get the
6507 entire buffer covered. Note that an empty line is only shown if there
6508 are at least `org-cycle-separator-lines' empty lines before the headline."
6518 beg end b e)
6542 ;; Never hide empty lines at the end of the file.
6552 "Move to the parent and re-show empty lines before visible headlines."
6558 "Return `org-agenda-files' list, plus all open org-mode files.
6559 This is useful for operations that need to scan all of a user's
6560 open and agenda-wise Org files."
6568 files))
6571 "Return the beginning position of the current entry."
6575 "Return the end position of the current entry."
6579 "Re-hide all drawers after a visibility state change."
6594 "When FLAG is non-nil, hide the drawer we are within.
6595 Otherwise make it visible."
6607 "Is the end of the current subtree visible?"
6612 "Move cursor to the first headline and recenter the headline.
6613 Optional argument N means put the headline into the Nth line of the window."
6619 ;;; Saving and restoring visibility
6622 "Return a list of the locations of all outline overlays.
6623 These are overlays with the `invisible' property value `outline'.
6624 The return value is a list of cons cells, with start and stop
6625 positions for each overlay.
6626 If USE-MARKERS is set, return the positions as markers."
6644 "Create visibility overlays for all positions in DATA.
6645 DATA should have been made by `org-outline-overlay-data'."
6653 data)))))
6655 ;;; Folding of blocks
6662 "Call FUNCTION at the head of all source blocks in the current buffer.
6663 Optional arguments START and END can be used to limit the range."
6675 "Toggle the visibility of all blocks in the current buffer."
6679 "Fold all blocks in the current buffer."
6685 "Unfold all blocks in the current buffer."
6691 "Toggle visibility of block at point."
6702 "Toggle the visibility of the current block."
6709 ov)
6725 ;; make the block accessible to isearch
6727 ov 'isearch-open-invisible
6738 ;; org-tab-after-check-for-cycling-hook
6740 ;; Remove overlays when changing major mode
6745 ;;; Org-goto
6751 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6767 nil)
6768 (org-defkey map "q" 'org-goto-quit)
6769 (org-defkey map "n" 'outline-next-visible-heading)
6770 (org-defkey map "p" 'outline-previous-visible-heading)
6771 (org-defkey map "f" 'outline-forward-same-level)
6772 (org-defkey map "b" 'outline-backward-same-level)
6773 (org-defkey map "u" 'outline-up-heading))
6774 (org-defkey map "/" 'org-occur)
6775 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6776 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6777 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6778 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6779 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6780 map))
6782 (defconst org-goto-help
6783 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6784 RET=jump to location [Q]uit and return to previous location
6785 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6787 (defvar org-goto-start-pos) ; dynamically scoped parameter
6789 ;; FIXME: Docstring does not mention both interfaces
6790 (defun org-goto (&optional alternative-interface)
6791 "Look up a different location in the current file, keeping current visibility.
6793 When you want look-up or go to a different location in a
6794 document, the fastest way is often to fold the entire buffer and
6795 then dive into the tree. This method has the disadvantage, that
6796 the previous location will be folded, which may not be what you
6797 want.
6799 This command works around this by showing a copy of the current
6800 buffer in an indirect buffer, in overview mode. You can dive
6801 into the tree in that copy, use org-occur and incremental search
6802 to find a location. When pressing RET or `Q', the command
6803 returns to the original buffer in which the visibility is still
6804 unchanged. After RET it will also jump to the location selected
6805 in the indirect buffer and expose the headline hierarchy above.
6807 With a prefix argument, use the alternative interface: e.g. if
6808 `org-goto-interface' is 'outline use 'outline-path-completion."
6809 (interactive "P")
6810 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6811 (org-refile-use-outline-path t)
6812 (org-refile-target-verify-function nil)
6813 (interface
6814 (if (not alternative-interface)
6815 org-goto-interface
6816 (if (eq org-goto-interface 'outline)
6817 'outline-path-completion
6818 'outline)))
6819 (org-goto-start-pos (point))
6820 (selected-point
6821 (if (eq interface 'outline)
6822 (car (org-get-location (current-buffer) org-goto-help))
6823 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6824 (org-refile-check-position pa)
6825 (nth 3 pa)))))
6826 (if selected-point
6827 (progn
6828 (org-mark-ring-push org-goto-start-pos)
6829 (goto-char selected-point)
6830 (if (or (outline-invisible-p) (org-invisible-p2))
6831 (org-show-context 'org-goto)))
6832 (message "Quit"))))
6834 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6835 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6836 (defvar org-goto-local-auto-isearch-map) ; defined below
6838 (defun org-get-location (buf help)
6839 "Let the user select a location in the Org-mode buffer BUF.
6840 This function uses a recursive edit. It returns the selected position
6841 or nil."
6842 (org-no-popups
6843 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6844 (isearch-hide-immediately nil)
6845 (isearch-search-fun-function
6846 (lambda () 'org-goto-local-search-headings))
6847 (org-goto-selected-point org-goto-exit-command))
6848 (save-excursion
6849 (save-window-excursion
6850 (delete-other-windows)
6851 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6852 (org-pop-to-buffer-same-window
6853 (condition-case nil
6854 (make-indirect-buffer (current-buffer) "*org-goto*")
6855 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6856 (with-output-to-temp-buffer "*Help*"
6857 (princ help))
6858 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6859 (setq buffer-read-only nil)
6860 (let ((org-startup-truncated t)
6861 (org-startup-folded nil)
6862 (org-startup-align-all-tables nil))
6863 (org-mode)
6864 (org-overview))
6865 (setq buffer-read-only t)
6866 (if (and (boundp 'org-goto-start-pos)
6867 (integer-or-marker-p org-goto-start-pos))
6868 (let ((org-show-hierarchy-above t)
6869 (org-show-siblings t)
6870 (org-show-following-heading t))
6871 (goto-char org-goto-start-pos)
6872 (and (outline-invisible-p) (org-show-context)))
6873 (goto-char (point-min)))
6874 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6875 (message "Select location and press RET")
6876 (use-local-map org-goto-map)
6877 (recursive-edit)
6878 ))
6879 (kill-buffer "*org-goto*")
6880 (cons org-goto-selected-point org-goto-exit-command))))
6882 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6883 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6884 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6885 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6887 (defun org-goto-local-search-headings (string bound noerror)
6888 "Search and make sure that any matches are in headlines."
6889 (catch 'return
6890 (while (if isearch-forward
6891 (search-forward string bound noerror)
6892 (search-backward string bound noerror))
6893 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6894 (and (member :headline context)
6895 (not (member :tags context))))
6896 (throw 'return (point))))))
6898 (defun org-goto-local-auto-isearch ()
6899 "Start isearch."
6900 (interactive)
6901 (goto-char (point-min))
6902 (let ((keys (this-command-keys)))
6903 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6904 (isearch-mode t)
6905 (isearch-process-search-char (string-to-char keys)))))
6907 (defun org-goto-ret (&optional arg)
6908 "Finish `org-goto' by going to the new location."
6909 (interactive "P")
6910 (setq org-goto-selected-point (point)
6911 org-goto-exit-command 'return)
6912 (throw 'exit nil))
6914 (defun org-goto-left ()
6915 "Finish `org-goto' by going to the new location."
6916 (interactive)
6917 (if (org-at-heading-p)
6918 (progn
6919 (beginning-of-line 1)
6920 (setq org-goto-selected-point (point)
6921 org-goto-exit-command 'left)
6922 (throw 'exit nil))
6923 (error "Not on a heading")))
6925 (defun org-goto-right ()
6926 "Finish `org-goto' by going to the new location."
6927 (interactive)
6928 (if (org-at-heading-p)
6929 (progn
6930 (setq org-goto-selected-point (point)
6931 org-goto-exit-command 'right)
6932 (throw 'exit nil))
6933 (error "Not on a heading")))
6935 (defun org-goto-quit ()
6936 "Finish `org-goto' without cursor motion."
6937 (interactive)
6938 (setq org-goto-selected-point nil)
6939 (setq org-goto-exit-command 'quit)
6940 (throw 'exit nil))
6942 ;;; Indirect buffer display of subtrees
6944 (defvar org-indirect-dedicated-frame nil
6945 "This is the frame being used for indirect tree display.")
6946 (defvar org-last-indirect-buffer nil)
6948 (defun org-tree-to-indirect-buffer (&optional arg)
6949 "Create indirect buffer and narrow it to current subtree.
6950 With a numerical prefix ARG, go up to this level and then take that tree.
6951 If ARG is negative, go up that many levels.
6953 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6954 indirect buffer previously made with this command, to avoid proliferation of
6955 indirect buffers. However, when you call the command with a \
6957 when `org-indirect-buffer-display' is `new-frame', the last buffer
6958 is kept so that you can work with several indirect buffers at the same time.
6959 If `org-indirect-buffer-display' is `dedicated-frame', the \
6961 requests that a new frame be made for the new buffer, so that the dedicated
6962 frame is not changed."
6963 (interactive "P")
6964 (let ((cbuf (current-buffer))
6965 (cwin (selected-window))
6966 (pos (point))
6967 beg end level heading ibuf)
6968 (save-excursion
6969 (org-back-to-heading t)
6970 (when (numberp arg)
6971 (setq level (org-outline-level))
6972 (if (< arg 0) (setq arg (+ level arg)))
6973 (while (> (setq level (org-outline-level)) arg)
6974 (org-up-heading-safe)))
6975 (setq beg (point)
6976 heading (org-get-heading))
6977 (org-end-of-subtree t t)
6978 (if (org-at-heading-p) (backward-char 1))
6979 (setq end (point)))
6980 (if (and (buffer-live-p org-last-indirect-buffer)
6981 (not (eq org-indirect-buffer-display 'new-frame))
6982 (not arg))
6983 (kill-buffer org-last-indirect-buffer))
6984 (setq ibuf (org-get-indirect-buffer cbuf)
6985 org-last-indirect-buffer ibuf)
6986 (cond
6987 ((or (eq org-indirect-buffer-display 'new-frame)
6988 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6989 (select-frame (make-frame))
6990 (delete-other-windows)
6991 (org-pop-to-buffer-same-window ibuf)
6992 (org-set-frame-title heading))
6993 ((eq org-indirect-buffer-display 'dedicated-frame)
6994 (raise-frame
6995 (select-frame (or (and org-indirect-dedicated-frame
6996 (frame-live-p org-indirect-dedicated-frame)
6997 org-indirect-dedicated-frame)
6998 (setq org-indirect-dedicated-frame (make-frame)))))
6999 (delete-other-windows)
7000 (org-pop-to-buffer-same-window ibuf)
7001 (org-set-frame-title (concat "Indirect: " heading)))
7002 ((eq org-indirect-buffer-display 'current-window)
7003 (org-pop-to-buffer-same-window ibuf))
7004 ((eq org-indirect-buffer-display 'other-window)
7005 (pop-to-buffer ibuf))
7006 (t (error "Invalid value")))
7007 (if (featurep 'xemacs)
7008 (save-excursion (org-mode) (turn-on-font-lock)))
7009 (narrow-to-region beg end)
7010 (show-all)
7011 (goto-char pos)
7012 (run-hook-with-args 'org-cycle-hook 'all)
7013 (and (window-live-p cwin) (select-window cwin))))
7015 (defun org-get-indirect-buffer (&optional buffer)
7016 (setq buffer (or buffer (current-buffer)))
7017 (let ((n 1) (base (buffer-name buffer)) bname)
7018 (while (buffer-live-p
7019 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7020 (setq n (1+ n)))
7021 (condition-case nil
7022 (make-indirect-buffer buffer bname 'clone)
7023 (error (make-indirect-buffer buffer bname)))))
7025 (defun org-set-frame-title (title)
7026 "Set the title of the current frame to the string TITLE."
7027 ;; FIXME: how to name a single frame in XEmacs???
7028 (unless (featurep 'xemacs)
7029 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7031 ;;;; Structure editing
7033 ;;; Inserting headlines
7035 (defun org-previous-line-empty-p ()
7036 (save-excursion
7037 (and (not (bobp))
7038 (or (beginning-of-line 0) t)
7039 (save-match-data
7042 (defun org-insert-heading (&optional force-heading invisible-ok)
7043 "Insert a new heading or item with same depth at point.
7044 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7045 If point is at the beginning of a headline, insert a sibling before the
7046 current headline. If point is not at the beginning, split the line,
7047 create the new headline with the text in the current line after point
7048 \(but see also the variable `org-M-RET-may-split-line').
7050 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7051 This is important for non-interactive uses of the command."
7052 (interactive "P")
7053 (if (or (= (buffer-size) 0)
7054 (and (not (save-excursion
7055 (and (ignore-errors (org-back-to-heading invisible-ok))
7056 (org-at-heading-p))))
7057 (or force-heading (not (org-in-item-p)))))
7058 (progn
7060 (run-hooks 'org-insert-heading-hook))
7061 (when (or force-heading (not (org-insert-item)))
7062 (let* ((empty-line-p nil)
7063 (level nil)
7064 (on-heading (org-at-heading-p))
7065 (head (save-excursion
7066 (condition-case nil
7067 (progn
7068 (org-back-to-heading invisible-ok)
7069 (when (and (not on-heading)
7070 (featurep 'org-inlinetask)
7071 (integerp org-inlinetask-min-level)
7072 (>= (length (match-string 0))
7073 org-inlinetask-min-level))
7074 ;; Find a heading level before the inline task
7075 (while (and (setq level (org-up-heading-safe))
7076 (>= level org-inlinetask-min-level)))
7077 (if (org-at-heading-p)
7078 (org-back-to-heading invisible-ok)
7079 (error "This should not happen")))
7080 (setq empty-line-p (org-previous-line-empty-p))
7081 (match-string 0))
7082 (error "*"))))
7083 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7084 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7085 pos hide-previous previous-pos)
7086 (cond
7087 ((and (org-at-heading-p) (bolp)
7088 (or (bobp)
7089 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7090 ;; insert before the current line
7091 (open-line (if blank 2 1)))
7092 ((and (bolp)
7093 (not org-insert-heading-respect-content)
7094 (or (bobp)
7095 (save-excursion
7096 (backward-char 1) (not (outline-invisible-p)))))
7097 ;; insert right here
7098 nil)
7099 (t
7100 ;; somewhere in the line
7101 (save-excursion
7102 (setq previous-pos (point-at-bol))
7103 (end-of-line)
7104 (setq hide-previous (outline-invisible-p)))
7105 (and org-insert-heading-respect-content (org-show-subtree))
7106 (let ((split
7107 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7108 (save-excursion
7109 (let ((p (point)))
7110 (goto-char (point-at-bol))
7111 (and (looking-at org-complex-heading-regexp)
7112 (match-beginning 4)
7113 (> p (match-beginning 4)))))))
7114 tags pos)
7115 (cond
7116 (org-insert-heading-respect-content
7117 (org-end-of-subtree nil t)
7118 (when (featurep 'org-inlinetask)
7119 (while (and (not (eobp))
7121 (>= (length (match-string 1))
7122 org-inlinetask-min-level))
7123 (org-end-of-subtree nil t)))
7124 (or (bolp) (newline))
7125 (or (org-previous-line-empty-p)
7126 (and blank (newline)))
7127 (open-line 1))
7128 ((org-at-heading-p)
7129 (when hide-previous
7130 (show-children)
7131 (org-show-entry))
7133 (setq tags (and (match-end 2) (match-string 2)))
7134 (and (match-end 1)
7135 (delete-region (match-beginning 1) (match-end 1)))
7136 (setq pos (point-at-bol))
7137 (or split (end-of-line 1))
7138 (delete-horizontal-space)
7140 (buffer-substring (point-at-bol) (point)))
7141 (insert " "))
7142 (newline (if blank 2 1))
7143 (when tags
7144 (save-excursion
7145 (goto-char pos)
7146 (end-of-line 1)
7147 (insert " " tags)
7148 (org-set-tags nil 'align))))
7149 (t
7150 (or split (end-of-line 1))
7151 (newline (if blank 2 1)))))))
7152 (insert head) (just-one-space)
7153 (setq pos (point))
7154 (end-of-line 1)
7155 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7156 (when (and org-insert-heading-respect-content hide-previous)
7157 (save-excursion
7158 (goto-char previous-pos)
7159 (hide-subtree)))
7160 (run-hooks 'org-insert-heading-hook)))))
7162 (defun org-get-heading (&optional no-tags no-todo)
7163 "Return the heading of the current entry, without the stars.
7164 When NO-TAGS is non-nil, don't include tags.
7165 When NO-TODO is non-nil, don't include TODO keywords."
7166 (save-excursion
7167 (org-back-to-heading t)
7168 (cond
7169 ((and no-tags no-todo)
7170 (looking-at org-complex-heading-regexp)
7171 (match-string 4))
7172 (no-tags
7173 (looking-at (concat org-outline-regexp
7176 (match-string 1))
7177 (no-todo
7178 (looking-at org-todo-line-regexp)
7179 (match-string 3))
7180 (t (looking-at org-heading-regexp)
7181 (match-string 2)))))
7183 (defun org-heading-components ()
7184 "Return the components of the current heading.
7185 This is a list with the following elements:
7186 - the level as an integer
7187 - the reduced level, different if `org-odd-levels-only' is set.
7188 - the TODO keyword, or nil
7189 - the priority character, like ?A, or nil if no priority is given
7190 - the headline text itself, or the tags string if no headline text
7191 - the tags string, or nil."
7192 (save-excursion
7193 (org-back-to-heading t)
7194 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7195 (list (length (match-string 1))
7196 (org-reduced-level (length (match-string 1)))
7197 (org-match-string-no-properties 2)
7198 (and (match-end 3) (aref (match-string 3) 2))
7199 (org-match-string-no-properties 4)
7200 (org-match-string-no-properties 5)))))
7202 (defun org-get-entry ()
7203 "Get the entry text, after heading, entire subtree."
7204 (save-excursion
7205 (org-back-to-heading t)
7206 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7208 (defun org-insert-heading-after-current ()
7209 "Insert a new heading with same level as current, after current subtree."
7210 (interactive)
7211 (org-back-to-heading)
7212 (org-insert-heading)
7213 (org-move-subtree-down)
7214 (end-of-line 1))
7216 (defun org-insert-heading-respect-content ()
7217 (interactive)
7218 (let ((org-insert-heading-respect-content t))
7219 (org-insert-heading t)))
7221 (defun org-insert-todo-heading-respect-content (&optional force-state)
7222 (interactive "P")
7223 (let ((org-insert-heading-respect-content t))
7224 (org-insert-todo-heading force-state t)))
7226 (defun org-insert-todo-heading (arg &optional force-heading)
7227 "Insert a new heading with the same level and TODO state as current heading.
7228 If the heading has no TODO state, or if the state is DONE, use the first
7229 state (TODO by default). Also with prefix arg, force first state."
7230 (interactive "P")
7231 (when (or force-heading (not (org-insert-item 'checkbox)))
7232 (org-insert-heading force-heading)
7233 (save-excursion
7234 (org-back-to-heading)
7235 (outline-previous-heading)
7236 (looking-at org-todo-line-regexp))
7237 (let*
7238 ((new-mark-x
7239 (if (or arg
7240 (not (match-beginning 2))
7241 (member (match-string 2) org-done-keywords))
7242 (car org-todo-keywords-1)
7243 (match-string 2)))
7244 (new-mark
7245 (or
7246 (run-hook-with-args-until-success
7247 'org-todo-get-default-hook new-mark-x nil)
7248 new-mark-x)))
7249 (beginning-of-line 1)
7250 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7251 (if org-treat-insert-todo-heading-as-state-change
7252 (org-todo new-mark)
7253 (insert new-mark " "))))
7254 (when org-provide-todo-statistics
7255 (org-update-parent-todo-statistics))))
7257 (defun org-insert-subheading (arg)
7258 "Insert a new subheading and demote it.
7259 Works for outline headings and for plain lists alike."
7260 (interactive "P")
7261 (org-insert-heading arg)
7262 (cond
7263 ((org-at-heading-p) (org-do-demote))
7264 ((org-at-item-p) (org-indent-item))))
7266 (defun org-insert-todo-subheading (arg)
7267 "Insert a new subheading with TODO keyword or checkbox and demote it.
7268 Works for outline headings and for plain lists alike."
7269 (interactive "P")
7270 (org-insert-todo-heading arg)
7271 (cond
7272 ((org-at-heading-p) (org-do-demote))
7273 ((org-at-item-p) (org-indent-item))))
7275 ;;; Promotion and Demotion
7277 (defvar org-after-demote-entry-hook nil
7278 "Hook run after an entry has been demoted.
7279 The cursor will be at the beginning of the entry.
7280 When a subtree is being demoted, the hook will be called for each node.")
7282 (defvar org-after-promote-entry-hook nil
7283 "Hook run after an entry has been promoted.
7284 The cursor will be at the beginning of the entry.
7285 When a subtree is being promoted, the hook will be called for each node.")
7287 (defun org-promote-subtree ()
7288 "Promote the entire subtree.
7289 See also `org-promote'."
7290 (interactive)
7291 (save-excursion
7292 (org-with-limited-levels (org-map-tree 'org-promote)))
7293 (org-fix-position-after-promote))
7295 (defun org-demote-subtree ()
7296 "Demote the entire subtree. See `org-demote'.
7297 See also `org-promote'."
7298 (interactive)
7299 (save-excursion
7300 (org-with-limited-levels (org-map-tree 'org-demote)))
7301 (org-fix-position-after-promote))
7304 (defun org-do-promote ()
7305 "Promote the current heading higher up the tree.
7306 If the region is active in `transient-mark-mode', promote all headings
7307 in the region."
7308 (interactive)
7309 (save-excursion
7310 (if (org-region-active-p)
7311 (org-map-region 'org-promote (region-beginning) (region-end))
7312 (org-promote)))
7313 (org-fix-position-after-promote))
7315 (defun org-do-demote ()
7316 "Demote the current heading lower down the tree.
7317 If the region is active in `transient-mark-mode', demote all headings
7318 in the region."
7319 (interactive)
7320 (save-excursion
7321 (if (org-region-active-p)
7322 (org-map-region 'org-demote (region-beginning) (region-end))
7323 (org-demote)))
7324 (org-fix-position-after-promote))
7326 (defun org-fix-position-after-promote ()
7327 "Make sure that after pro/demotion cursor position is right."
7328 (let ((pos (point)))
7329 (when (save-excursion
7330 (beginning-of-line 1)
7331 (looking-at org-todo-line-regexp)
7332 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7333 (cond ((eobp) (insert " "))
7334 ((eolp) (insert " "))
7335 ((equal (char-after) ?\ ) (forward-char 1))))))
7337 (defun org-current-level ()
7338 "Return the level of the current entry, or nil if before the first headline.
7339 The level is the number of stars at the beginning of the headline."
7340 (save-excursion
7341 (org-with-limited-levels
7342 (if (ignore-errors (org-back-to-heading t))
7343 (funcall outline-level)))))
7345 (defun org-get-previous-line-level ()
7346 "Return the outline depth of the last headline before the current line.
7347 Returns 0 for the first headline in the buffer, and nil if before the
7348 first headline."
7349 (let ((current-level (org-current-level))
7350 (prev-level (when (> (line-number-at-pos) 1)
7351 (save-excursion
7352 (beginning-of-line 0)
7353 (org-current-level)))))
7354 (cond ((null current-level) nil) ; Before first headline
7355 ((null prev-level) 0) ; At first headline
7356 (prev-level))))
7358 (defun org-reduced-level (l)
7359 "Compute the effective level of a heading.
7360 This takes into account the setting of `org-odd-levels-only'."
7361 (cond
7362 ((zerop l) 0)
7363 (org-odd-levels-only (1+ (floor (/ l 2))))
7364 (t l)))
7366 (defun org-level-increment ()
7367 "Return the number of stars that will be added or removed at a
7368 time to headlines when structure editing, based on the value of
7369 `org-odd-levels-only'."
7370 (if org-odd-levels-only 2 1))
7372 (defun org-get-valid-level (level &optional change)
7373 "Rectify a level change under the influence of `org-odd-levels-only'
7374 LEVEL is a current level, CHANGE is by how much the level should be
7375 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7376 even level numbers will become the next higher odd number."
7377 (if org-odd-levels-only
7378 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7379 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7380 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7381 (max 1 (+ level (or change 0)))))
7383 (if (boundp 'define-obsolete-function-alias)
7384 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7385 (define-obsolete-function-alias 'org-get-legal-level
7386 'org-get-valid-level)
7387 (define-obsolete-function-alias 'org-get-legal-level
7388 'org-get-valid-level "23.1")))
7390 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7391 ;; ̀org-with-limited-levels'
7392 (defun org-promote ()
7393 "Promote the current heading higher up the tree.
7394 If the region is active in `transient-mark-mode', promote all headings
7395 in the region."
7396 (org-back-to-heading t)
7397 (let* ((level (save-match-data (funcall outline-level)))
7398 (after-change-functions (remove 'flyspell-after-change-function
7399 after-change-functions))
7400 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7401 (diff (abs (- level (length up-head) -1))))
7402 (cond ((and (= level 1) org-called-with-limited-levels
7403 org-allow-promoting-top-level-subtree)
7404 (replace-match "# " nil t))
7405 ((= level 1)
7406 (error "Cannot promote to level 0. UNDO to recover if necessary"))
7407 (t (replace-match up-head nil t)))
7408 ;; Fixup tag positioning
7409 (unless (= level 1)
7410 (and org-auto-align-tags (org-set-tags nil t))
7411 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7412 (run-hooks 'org-after-promote-entry-hook)))
7414 (defun org-demote ()
7415 "Demote the current heading lower down the tree.
7416 If the region is active in `transient-mark-mode', demote all headings
7417 in the region."
7418 (org-back-to-heading t)
7419 (let* ((level (save-match-data (funcall outline-level)))
7420 (after-change-functions (remove 'flyspell-after-change-function
7421 after-change-functions))
7422 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7423 (diff (abs (- level (length down-head) -1))))
7424 (replace-match down-head nil t)
7425 ;; Fixup tag positioning
7426 (and org-auto-align-tags (org-set-tags nil t))
7427 (if org-adapt-indentation (org-fixup-indentation diff))
7428 (run-hooks 'org-after-demote-entry-hook)))
7430 (defun org-cycle-level ()
7431 "Cycle the level of an empty headline through possible states.
7432 This goes first to child, then to parent, level, then up the hierarchy.
7433 After top level, it switches back to sibling level."
7434 (interactive)
7435 (let ((org-adapt-indentation nil))
7436 (when (org-point-at-end-of-empty-headline)
7437 (setq this-command 'org-cycle-level) ; Only needed for caching
7438 (let ((cur-level (org-current-level))
7439 (prev-level (org-get-previous-line-level)))
7440 (cond
7441 ;; If first headline in file, promote to top-level.
7442 ((= prev-level 0)
7443 (loop repeat (/ (- cur-level 1) (org-level-increment))
7444 do (org-do-promote)))
7445 ;; If same level as prev, demote one.
7446 ((= prev-level cur-level)
7447 (org-do-demote))
7448 ;; If parent is top-level, promote to top level if not already.
7449 ((= prev-level 1)
7450 (loop repeat (/ (- cur-level 1) (org-level-increment))
7451 do (org-do-promote)))
7452 ;; If top-level, return to prev-level.
7453 ((= cur-level 1)
7454 (loop repeat (/ (- prev-level 1) (org-level-increment))
7455 do (org-do-demote)))
7456 ;; If less than prev-level, promote one.
7457 ((< cur-level prev-level)
7458 (org-do-promote))
7459 ;; If deeper than prev-level, promote until higher than
7460 ;; prev-level.
7461 ((> cur-level prev-level)
7462 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7463 do (org-do-promote))))
7464 t))))
7466 (defun org-map-tree (fun)
7467 "Call FUN for every heading underneath the current one."
7468 (org-back-to-heading)
7469 (let ((level (funcall outline-level)))
7470 (save-excursion
7471 (funcall fun)
7472 (while (and (progn
7473 (outline-next-heading)
7474 (> (funcall outline-level) level))
7475 (not (eobp)))
7476 (funcall fun)))))
7478 (defun org-map-region (fun beg end)
7479 "Call FUN for every heading between BEG and END."
7480 (let ((org-ignore-region t))
7481 (save-excursion
7482 (setq end (copy-marker end))
7483 (goto-char beg)
7484 (if (and (re-search-forward org-outline-regexp-bol nil t)
7485 (< (point) end))
7486 (funcall fun))
7487 (while (and (progn
7488 (outline-next-heading)
7489 (< (point) end))
7490 (not (eobp)))
7491 (funcall fun)))))
7493 (defvar org-property-end-re) ; silence byte-compiler
7494 (defun org-fixup-indentation (diff)
7495 "Change the indentation in the current entry by DIFF.
7496 However, if any line in the current entry has no indentation, or if it
7497 would end up with no indentation after the change, nothing at all is done."
7498 (save-excursion
7499 (let ((end (save-excursion (outline-next-heading)
7500 (point-marker)))
7501 (prohibit (if (> diff 0)
7504 col)
7505 (unless (save-excursion (end-of-line 1)
7506 (re-search-forward prohibit end t))
7507 (while (and (< (point) end)
7509 (goto-char (match-end 0))
7510 (setq col (current-column))
7511 (if (< diff 0) (replace-match ""))
7512 (org-indent-to-column (+ diff col))))
7513 (move-marker end nil))))
7515 (defun org-convert-to-odd-levels ()
7516 "Convert an org-mode file with all levels allowed to one with odd levels.
7517 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7518 level 5 etc."
7519 (interactive)
7520 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7521 (let ((outline-level 'org-outline-level)
7522 (org-odd-levels-only nil) n)
7523 (save-excursion
7524 (goto-char (point-min))
7526 (setq n (- (length (match-string 0)) 2))
7527 (while (>= (setq n (1- n)) 0)
7528 (org-demote))
7529 (end-of-line 1))))))
7531 (defun org-convert-to-oddeven-levels ()
7532 "Convert an org-mode file with only odd levels to one with odd/even levels.
7533 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7534 file contains a section with an even level, conversion would
7535 destroy the structure of the file. An error is signaled in this
7536 case."
7537 (interactive)
7538 (goto-char (point-min))
7539 ;; First check if there are no even levels
7541 (org-show-context t)
7542 (error "Not all levels are odd in this file. Conversion not possible"))
7543 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7544 (let ((outline-regexp org-outline-regexp)
7545 (outline-level 'org-outline-level)
7546 (org-odd-levels-only nil) n)
7547 (save-excursion
7548 (goto-char (point-min))
7550 (setq n (/ (1- (length (match-string 0))) 2))
7551 (while (>= (setq n (1- n)) 0)
7552 (org-promote))
7553 (end-of-line 1))))))
7555 (defun org-tr-level (n)
7556 "Make N odd if required."
7557 (if org-odd-levels-only (1+ (/ n 2)) n))
7559 ;;; Vertical tree motion, cutting and pasting of subtrees
7561 (defun org-move-subtree-up (&optional arg)
7562 "Move the current subtree up past ARG headlines of the same level."
7563 (interactive "p")
7564 (org-move-subtree-down (- (prefix-numeric-value arg))))
7566 (defun org-move-subtree-down (&optional arg)
7567 "Move the current subtree down past ARG headlines of the same level."
7568 (interactive "p")
7569 (setq arg (prefix-numeric-value arg))
7570 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7571 'org-get-last-sibling))
7572 (ins-point (make-marker))
7573 (cnt (abs arg))
7574 (col (current-column))
7575 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7576 ;; Select the tree
7577 (org-back-to-heading)
7578 (setq beg0 (point))
7579 (save-excursion
7580 (setq ne-beg (org-back-over-empty-lines))
7581 (setq beg (point)))
7582 (save-match-data
7583 (save-excursion (outline-end-of-heading)
7584 (setq folded (outline-invisible-p)))
7585 (outline-end-of-subtree))
7586 (outline-next-heading)
7587 (setq ne-end (org-back-over-empty-lines))
7588 (setq end (point))
7589 (goto-char beg0)
7590 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7591 ;; include less whitespace
7592 (save-excursion
7593 (goto-char beg)
7594 (forward-line (- ne-beg ne-end))
7595 (setq beg (point))))
7596 ;; Find insertion point, with error handling
7597 (while (> cnt 0)
7598 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7599 (progn (goto-char beg0)
7600 (error "Cannot move past superior level or buffer limit")))
7601 (setq cnt (1- cnt)))
7602 (if (> arg 0)
7603 ;; Moving forward - still need to move over subtree
7604 (progn (org-end-of-subtree t t)
7605 (save-excursion
7606 (org-back-over-empty-lines)
7607 (or (bolp) (newline)))))
7608 (setq ne-ins (org-back-over-empty-lines))
7609 (move-marker ins-point (point))
7610 (setq txt (buffer-substring beg end))
7611 (org-save-markers-in-region beg end)
7612 (delete-region beg end)
7613 (org-remove-empty-overlays-at beg)
7614 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7615 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7617 (let ((bbb (point)))
7618 (insert-before-markers txt)
7619 (org-reinstall-markers-in-region bbb)
7620 (move-marker ins-point bbb))
7622 (setq ins-end (point))
7623 (goto-char ins-point)
7624 (org-skip-whitespace)
7625 (when (and (< arg 0)
7626 (org-first-sibling-p)
7627 (> ne-ins ne-beg))
7628 ;; Move whitespace back to beginning
7629 (save-excursion
7630 (goto-char ins-end)
7631 (let ((kill-whole-line t))
7632 (kill-line (- ne-ins ne-beg)) (point)))
7634 (move-marker ins-point nil)
7635 (if folded
7636 (hide-subtree)
7637 (org-show-entry)
7638 (show-children)
7639 (org-cycle-hide-drawers 'children))
7640 (org-clean-visibility-after-subtree-move)
7641 ;; move back to the initial column we were at
7642 (move-to-column col)))
7644 (defvar org-subtree-clip ""
7645 "Clipboard for cut and paste of subtrees.
7646 This is actually only a copy of the kill, because we use the normal kill
7647 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7649 (defvar org-subtree-clip-folded nil
7650 "Was the last copied subtree folded?
7651 This is used to fold the tree back after pasting.")
7653 (defun org-cut-subtree (&optional n)
7654 "Cut the current subtree into the clipboard.
7655 With prefix arg N, cut this many sequential subtrees.
7656 This is a short-hand for marking the subtree and then cutting it."
7657 (interactive "p")
7658 (org-copy-subtree n 'cut))
7660 (defun org-copy-subtree (&optional n cut force-store-markers)
7661 "Cut the current subtree into the clipboard.
7662 With prefix arg N, cut this many sequential subtrees.
7663 This is a short-hand for marking the subtree and then copying it.
7664 If CUT is non-nil, actually cut the subtree.
7665 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7666 of some markers in the region, even if CUT is non-nil. This is
7667 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7668 (interactive "p")
7669 (let (beg end folded (beg0 (point)))
7670 (if (org-called-interactively-p 'any)
7671 (org-back-to-heading nil) ; take what looks like a subtree
7672 (org-back-to-heading t)) ; take what is really there
7673 (setq beg (point))
7675 (save-match-data
7676 (save-excursion (outline-end-of-heading)
7677 (setq folded (outline-invisible-p)))
7678 (condition-case nil
7679 (org-forward-heading-same-level (1- n) t)
7680 (error nil))
7681 (org-end-of-subtree t t))
7682 (setq end (point))
7683 (goto-char beg0)
7684 (when (> end beg)
7685 (setq org-subtree-clip-folded folded)
7686 (when (or cut force-store-markers)
7687 (org-save-markers-in-region beg end))
7688 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7689 (setq org-subtree-clip (current-kill 0))
7690 (message "%s: Subtree(s) with %d characters"
7691 (if cut "Cut" "Copied")
7692 (length org-subtree-clip)))))
7694 (defun org-paste-subtree (&optional level tree for-yank)
7695 "Paste the clipboard as a subtree, with modification of headline level.
7696 The entire subtree is promoted or demoted in order to match a new headline
7697 level.
7699 If the cursor is at the beginning of a headline, the same level as
7700 that headline is used to paste the tree
7702 If not, the new level is derived from the *visible* headings
7703 before and after the insertion point, and taken to be the inferior headline
7704 level of the two. So if the previous visible heading is level 3 and the
7705 next is level 4 (or vice versa), level 4 will be used for insertion.
7706 This makes sure that the subtree remains an independent subtree and does
7707 not swallow low level entries.
7709 You can also force a different level, either by using a numeric prefix
7710 argument, or by inserting the heading marker by hand. For example, if the
7713 If optional TREE is given, use this text instead of the kill ring.
7715 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7716 move back over whitespace before inserting, and move point to the end of
7717 the inserted text when done."
7718 (interactive "P")
7719 (setq tree (or tree (and kill-ring (current-kill 0))))
7720 (unless (org-kill-is-subtree-p tree)
7721 (error "%s"
7722 (substitute-command-keys
7724 (org-with-limited-levels
7725 (let* ((visp (not (outline-invisible-p)))
7726 (txt tree)
7728 (old-level (if (string-match org-outline-regexp-bol txt)
7729 (- (match-end 0) (match-beginning 0) 1)
7730 -1))
7731 (force-level (cond (level (prefix-numeric-value level))
7733 (string-match
7735 (point-at-bol) (point))))
7736 (- (match-end 1) (match-beginning 1)))
7737 ((and (bolp)
7738 (looking-at org-outline-regexp))
7739 (- (match-end 0) (point) 1))))
7740 (previous-level (save-excursion
7741 (condition-case nil
7742 (progn
7743 (outline-previous-visible-heading 1)
7744 (if (looking-at ^re_)
7745 (- (match-end 0) (match-beginning 0) 1)
7746 1))
7747 (error 1))))
7748 (next-level (save-excursion
7749 (condition-case nil
7750 (progn
7751 (or (looking-at org-outline-regexp)
7752 (outline-next-visible-heading 1))
7753 (if (looking-at ^re_)
7754 (- (match-end 0) (match-beginning 0) 1)
7755 1))
7756 (error 1))))
7757 (new-level (or force-level (max previous-level next-level)))
7758 (shift (if (or (= old-level -1)
7759 (= new-level -1)
7760 (= old-level new-level))
7761 0
7762 (- new-level old-level)))
7763 (delta (if (> shift 0) -1 1))
7764 (func (if (> shift 0) 'org-demote 'org-promote))
7765 (org-odd-levels-only nil)
7766 beg end newend)
7767 ;; Remove the forced level indicator
7768 (if force-level
7769 (delete-region (point-at-bol) (point)))
7770 ;; Paste
7771 (beginning-of-line (if (bolp) 1 2))
7772 (setq beg (point))
7773 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7774 (insert-before-markers txt)
7776 (setq newend (point))
7777 (org-reinstall-markers-in-region beg)
7778 (setq end (point))
7779 (goto-char beg)
7781 (setq beg (point))
7782 (if (and (outline-invisible-p) visp)
7783 (save-excursion (outline-show-heading)))
7784 ;; Shift if necessary
7785 (unless (= shift 0)
7786 (save-restriction
7787 (narrow-to-region beg end)
7788 (while (not (= shift 0))
7789 (org-map-region func (point-min) (point-max))
7790 (setq shift (+ delta shift)))
7791 (goto-char (point-min))
7792 (setq newend (point-max))))
7793 (when (or (org-called-interactively-p 'interactive) for-yank)
7794 (message "Clipboard pasted as level %d subtree" new-level))
7795 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7796 kill-ring
7797 (eq org-subtree-clip (current-kill 0))
7798 org-subtree-clip-folded)
7799 ;; The tree was folded before it was killed/copied
7800 (hide-subtree))
7801 (and for-yank (goto-char newend)))))
7803 (defun org-kill-is-subtree-p (&optional txt)
7804 "Check if the current kill is an outline subtree, or a set of trees.
7805 Returns nil if kill does not start with a headline, or if the first
7806 headline level is not the largest headline level in the tree.
7807 So this will actually accept several entries of equal levels as well,
7808 which is OK for `org-paste-subtree'.
7809 If optional TXT is given, check this string instead of the current kill."
7810 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7811 (re (org-get-limited-outline-regexp))
7812 (^re (concat "^" re))
7813 (start-level (and kill
7814 (string-match
7816 kill)
7817 (- (match-end 2) (match-beginning 2) 1)))
7818 (start (1+ (or (match-beginning 2) -1))))
7819 (if (not start-level)
7820 (progn
7821 nil) ;; does not even start with a heading
7822 (catch 'exit
7823 (while (setq start (string-match ^re kill (1+ start)))
7824 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7825 (throw 'exit nil)))
7826 t))))
7828 (defvar org-markers-to-move nil
7829 "Markers that should be moved with a cut-and-paste operation.
7830 Those markers are stored together with their positions relative to
7831 the start of the region.")
7833 (defun org-save-markers-in-region (beg end)
7834 "Check markers in region.
7835 If these markers are between BEG and END, record their position relative
7836 to BEG, so that after moving the block of text, we can put the markers back
7837 into place.
7838 This function gets called just before an entry or tree gets cut from the
7839 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7840 called immediately, to move the markers with the entries."
7841 (setq org-markers-to-move nil)
7842 (when (featurep 'org-clock)
7843 (org-clock-save-markers-for-cut-and-paste beg end))
7844 (when (featurep 'org-agenda)
7845 (org-agenda-save-markers-for-cut-and-paste beg end)))
7847 (defun org-check-and-save-marker (marker beg end)
7848 "Check if MARKER is between BEG and END.
7849 If yes, remember the marker and the distance to BEG."
7850 (when (and (marker-buffer marker)
7851 (equal (marker-buffer marker) (current-buffer)))
7852 (if (and (>= marker beg) (< marker end))
7853 (push (cons marker (- marker beg)) org-markers-to-move))))
7855 (defun org-reinstall-markers-in-region (beg)
7856 "Move all remembered markers to their position relative to BEG."
7857 (mapc (lambda (x)
7858 (move-marker (car x) (+ beg (cdr x))))
7859 org-markers-to-move)
7860 (setq org-markers-to-move nil))
7862 (defun org-narrow-to-subtree ()
7863 "Narrow buffer to the current subtree."
7864 (interactive)
7865 (save-excursion
7866 (save-match-data
7867 (org-with-limited-levels
7868 (narrow-to-region
7869 (progn (org-back-to-heading t) (point))
7870 (progn (org-end-of-subtree t t)
7871 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7872 (point)))))))
7874 (defun org-narrow-to-block ()
7875 "Narrow buffer to the current block."
7876 (interactive)
7877 (let* ((case-fold-search t)
7880 (if blockp
7881 (narrow-to-region (car blockp) (cdr blockp))
7882 (error "Not in a block"))))
7884 (eval-when-compile
7885 (defvar org-property-drawer-re))
7887 (defvar org-property-start-re) ;; defined below
7888 (defun org-clone-subtree-with-time-shift (n &optional shift)
7889 "Clone the task (subtree) at point N times.
7890 The clones will be inserted as siblings.
7892 In interactive use, the user will be prompted for the number of
7893 clones to be produced, and for a time SHIFT, which may be a
7894 repeater as used in time stamps, for example `+3d'.
7896 When a valid repeater is given and the entry contains any time
7897 stamps, the clones will become a sequence in time, with time
7898 stamps in the subtree shifted for each clone produced. If SHIFT
7899 is nil or the empty string, time stamps will be left alone. The
7900 ID property of the original subtree is removed.
7902 If the original subtree did contain time stamps with a repeater,
7903 the following will happen:
7904 - the repeater will be removed in each clone
7905 - an additional clone will be produced, with the current, unshifted
7906 date(s) in the entry.
7907 - the original entry will be placed *after* all the clones, with
7908 repeater intact.
7909 - the start days in the repeater in the original entry will be shifted
7910 to past the last clone.
7911 In this way you can spell out a number of instances of a repeating task,
7912 and still retain the repeater to cover future instances of the task."
7913 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7914 (let (beg end template task idprop
7915 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7916 (drawer-re org-drawer-regexp))
7917 (if (not (and (integerp n) (> n 0)))
7918 (error "Invalid number of replications %s" n))
7921 shift)))
7922 (error "Invalid shift specification %s" shift))
7923 (when doshift
7924 (setq shift-n (string-to-number (match-string 1 shift))
7925 shift-what (cdr (assoc (match-string 2 shift)
7926 '(("d" . day) ("w" . week)
7927 ("m" . month) ("y" . year))))))
7928 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7929 (setq nmin 1 nmax n)
7930 (org-back-to-heading t)
7931 (setq beg (point))
7932 (setq idprop (org-entry-get nil "ID"))
7933 (org-end-of-subtree t t)
7935 (setq end (point))
7936 (setq template (buffer-substring beg end))
7937 (when (and doshift
7939 (delete-region beg end)
7940 (setq end beg)
7941 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7942 (goto-char end)
7943 (loop for n from nmin to nmax do
7944 ;; prepare clone
7945 (with-temp-buffer
7946 (insert template)
7947 (org-mode)
7948 (goto-char (point-min))
7949 (org-show-subtree)
7950 (and idprop (if org-clone-delete-id
7951 (org-entry-delete nil "ID")
7952 (org-id-get-create t)))
7953 (unless (= n 0)
7955 (kill-whole-line))
7956 (goto-char (point-min))
7957 (while (re-search-forward drawer-re nil t)
7958 (mapc (lambda (d)
7959 (org-remove-empty-drawer-at d (point))) org-drawers)))
7960 (goto-char (point-min))
7961 (when doshift
7962 (while (re-search-forward org-ts-regexp-both nil t)
7963 (org-timestamp-change (* n shift-n) shift-what))
7964 (unless (= n n-no-remove)
7965 (goto-char (point-min))
7966 (while (re-search-forward org-ts-regexp nil t)
7967 (save-excursion
7968 (goto-char (match-beginning 0))
7970 (delete-region (match-beginning 1) (match-end 1)))))))
7971 (setq task (buffer-string)))
7972 (insert task))
7973 (goto-char beg)))
7975 ;;; Outline Sorting
7977 (defun org-sort (with-case)
7978 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7979 Optional argument WITH-CASE means sort case-sensitively."
7980 (interactive "P")
7981 (cond
7982 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7983 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7984 (t
7985 (org-call-with-arg 'org-sort-entries with-case))))
7987 (defun org-sort-remove-invisible (s)
7988 (remove-text-properties 0 (length s) org-rm-props s)
7989 (while (string-match org-bracket-link-regexp s)
7990 (setq s (replace-match (if (match-end 2)
7991 (match-string 3 s)
7992 (match-string 1 s)) t t s)))
7993 s)
7995 (defvar org-priority-regexp) ; defined later in the file
7997 (defvar org-after-sorting-entries-or-items-hook nil
7998 "Hook that is run after a bunch of entries or items have been sorted.
7999 When children are sorted, the cursor is in the parent line when this
8000 hook gets called. When a region or a plain list is sorted, the cursor
8001 will be in the first entry of the sorted region/list.")
8003 (defun org-sort-entries
8004 (&optional with-case sorting-type getkey-func compare-func property)
8005 "Sort entries on a certain level of an outline tree.
8006 If there is an active region, the entries in the region are sorted.
8007 Else, if the cursor is before the first entry, sort the top-level items.
8008 Else, the children of the entry at point are sorted.
8010 Sorting can be alphabetically, numerically, by date/time as given by
8011 a time stamp, by a property or by priority.
8013 The command prompts for the sorting type unless it has been given to the
8014 function through the SORTING-TYPE argument, which needs to be a character,
8015 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8016 precise meaning of each character:
8018 n Numerically, by converting the beginning of the entry/item to a number.
8019 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8020 o By order of TODO keywords.
8021 t By date/time, either the first active time stamp in the entry, or, if
8022 none exist, by the first inactive one.
8023 s By the scheduled date/time.
8024 d By deadline date/time.
8025 c By creation time, which is assumed to be the first inactive time stamp
8026 at the beginning of a line.
8027 p By priority according to the cookie.
8028 r By the value of a property.
8030 Capital letters will reverse the sort order.
8032 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8033 called with point at the beginning of the record. It must return either
8034 a string or a number that should serve as the sorting key for that record.
8036 Comparing entries ignores case by default. However, with an optional argument
8037 WITH-CASE, the sorting considers case as well."
8038 (interactive "P")
8039 (let ((case-func (if with-case 'identity 'downcase))
8040 (cmstr
8041 ;; The clock marker is lost when using `sort-subr', let's
8042 ;; store the clocking string.
8043 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8044 (save-excursion
8045 (goto-char org-clock-marker)
8046 (looking-back "^.*") (match-string-no-properties 0))))
8047 start beg end stars re re2
8048 txt what tmp)
8049 ;; Find beginning and end of region to sort
8050 (cond
8051 ((org-region-active-p)
8052 ;; we will sort the region
8053 (setq end (region-end)
8054 what "region")
8055 (goto-char (region-beginning))
8056 (if (not (org-at-heading-p)) (outline-next-heading))
8057 (setq start (point)))
8058 ((or (org-at-heading-p)
8059 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8060 ;; we will sort the children of the current headline
8061 (org-back-to-heading)
8062 (setq start (point)
8063 end (progn (org-end-of-subtree t t)
8065 (org-back-over-empty-lines)
8066 (point))
8067 what "children")
8068 (goto-char start)
8069 (show-subtree)
8070 (outline-next-heading))
8071 (t
8072 ;; we will sort the top-level entries in this file
8073 (goto-char (point-min))
8074 (or (org-at-heading-p) (outline-next-heading))
8075 (setq start (point))
8076 (goto-char (point-max))
8077 (beginning-of-line 1)
8079 ;; File ends in a non-white line
8080 (end-of-line 1)
8082 (setq end (point-max))
8083 (setq what "top-level")
8084 (goto-char start)
8085 (show-all)))
8087 (setq beg (point))
8088 (if (>= beg end) (error "Nothing to sort"))
8091 (setq stars (match-string 1)
8092 re (concat "^" (regexp-quote stars) " +")
8094 txt (buffer-substring beg end))
8096 (if (and (not (equal stars "*")) (string-match re2 txt))
8097 (error "Region to sort contains a level above the first entry"))
8099 (unless sorting-type
8100 (message
8101 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8103 A/N/P/R/O/F/T/S/D/C means reversed:"
8104 what)
8105 (setq sorting-type (read-char-exclusive))
8107 (and (= (downcase sorting-type) ?f)
8108 (setq getkey-func
8109 (org-icompleting-read "Sort using function: "
8110 obarray 'fboundp t nil nil))
8111 (setq getkey-func (intern getkey-func)))
8113 (and (= (downcase sorting-type) ?r)
8114 (setq property
8115 (org-icompleting-read "Property: "
8116 (mapcar 'list (org-buffer-property-keys t))
8117 nil t))))
8119 (message "Sorting entries...")
8121 (save-restriction
8122 (narrow-to-region start end)
8123 (let ((dcst (downcase sorting-type))
8124 (case-fold-search nil)
8125 (now (current-time)))
8126 (sort-subr
8127 (/= dcst sorting-type)
8128 ;; This function moves to the beginning character of the "record" to
8129 ;; be sorted.
8130 (lambda nil
8131 (if (re-search-forward re nil t)
8132 (goto-char (match-beginning 0))
8133 (goto-char (point-max))))
8134 ;; This function moves to the last character of the "record" being
8135 ;; sorted.
8136 (lambda nil
8137 (save-match-data
8138 (condition-case nil
8139 (outline-forward-same-level 1)
8140 (error
8141 (goto-char (point-max))))))
8142 ;; This function returns the value that gets sorted against.
8143 (lambda nil
8144 (cond
8145 ((= dcst ?n)
8146 (if (looking-at org-complex-heading-regexp)
8147 (string-to-number (match-string 4))
8148 nil))
8149 ((= dcst ?a)
8150 (if (looking-at org-complex-heading-regexp)
8151 (funcall case-func (match-string 4))
8152 nil))
8153 ((= dcst ?t)
8154 (let ((end (save-excursion (outline-next-heading) (point))))
8155 (if (or (re-search-forward org-ts-regexp end t)
8156 (re-search-forward org-ts-regexp-both end t))
8157 (org-time-string-to-seconds (match-string 0))
8158 (org-float-time now))))
8159 ((= dcst ?c)
8160 (let ((end (save-excursion (outline-next-heading) (point))))
8161 (if (re-search-forward
8163 end t)
8164 (org-time-string-to-seconds (match-string 0))
8165 (org-float-time now))))
8166 ((= dcst ?s)
8167 (let ((end (save-excursion (outline-next-heading) (point))))
8168 (if (re-search-forward org-scheduled-time-regexp end t)
8169 (org-time-string-to-seconds (match-string 1))
8170 (org-float-time now))))
8171 ((= dcst ?d)
8172 (let ((end (save-excursion (outline-next-heading) (point))))
8173 (if (re-search-forward org-deadline-time-regexp end t)
8174 (org-time-string-to-seconds (match-string 1))
8175 (org-float-time now))))
8176 ((= dcst ?p)
8177 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8178 (string-to-char (match-string 2))
8179 org-default-priority))
8180 ((= dcst ?r)
8181 (or (org-entry-get nil property) ""))
8182 ((= dcst ?o)
8183 (if (looking-at org-complex-heading-regexp)
8184 (- 9999 (length (member (match-string 2)
8185 org-todo-keywords-1)))))
8186 ((= dcst ?f)
8187 (if getkey-func
8188 (progn
8189 (setq tmp (funcall getkey-func))
8190 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8191 tmp)
8192 (error "Invalid key function `%s'" getkey-func)))
8193 (t (error "Invalid sorting type `%c'" sorting-type))))
8194 nil
8195 (cond
8196 ((= dcst ?a) 'string<)
8197 ((= dcst ?f) compare-func)
8198 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8199 (run-hooks 'org-after-sorting-entries-or-items-hook)
8200 ;; Reset the clock marker if needed
8201 (when cmstr
8202 (save-excursion
8203 (goto-char start)
8204 (search-forward cmstr nil t)
8205 (move-marker org-clock-marker (point))))
8206 (message "Sorting entries...done")))
8208 (defun org-do-sort (table what &optional with-case sorting-type)
8209 "Sort TABLE of WHAT according to SORTING-TYPE.
8210 The user will be prompted for the SORTING-TYPE if the call to this
8211 function does not specify it. WHAT is only for the prompt, to indicate
8212 what is being sorted. The sorting key will be extracted from
8213 the car of the elements of the table.
8214 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8215 (unless sorting-type
8216 (message
8217 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8218 what)
8219 (setq sorting-type (read-char-exclusive)))
8220 (let ((dcst (downcase sorting-type))
8221 extractfun comparefun)
8222 ;; Define the appropriate functions
8223 (cond
8224 ((= dcst ?n)
8225 (setq extractfun 'string-to-number
8226 comparefun (if (= dcst sorting-type) '< '>)))
8227 ((= dcst ?a)
8228 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8229 (lambda(x) (downcase (org-sort-remove-invisible x))))
8230 comparefun (if (= dcst sorting-type)
8231 'string<
8232 (lambda (a b) (and (not (string< a b))
8233 (not (string= a b)))))))
8234 ((= dcst ?t)
8235 (setq extractfun
8236 (lambda (x)
8237 (if (or (string-match org-ts-regexp x)
8238 (string-match org-ts-regexp-both x))
8239 (org-float-time
8240 (org-time-string-to-time (match-string 0 x)))
8241 0))
8242 comparefun (if (= dcst sorting-type) '< '>)))
8243 (t (error "Invalid sorting type `%c'" sorting-type)))
8245 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8246 table)
8247 (lambda (a b) (funcall comparefun (car a) (car b))))))
8250 ;;; The orgstruct minor mode
8252 ;; Define a minor mode which can be used in other modes in order to
8253 ;; integrate the org-mode structure editing commands.
8255 ;; This is really a hack, because the org-mode structure commands use
8256 ;; keys which normally belong to the major mode. Here is how it
8257 ;; works: The minor mode defines all the keys necessary to operate the
8258 ;; structure commands, but wraps the commands into a function which
8259 ;; tests if the cursor is currently at a headline or a plain list
8260 ;; item. If that is the case, the structure command is used,
8261 ;; temporarily setting many Org-mode variables like regular
8262 ;; expressions for filling etc. However, when any of those keys is
8263 ;; used at a different location, function uses `key-binding' to look
8264 ;; up if the key has an associated command in another currently active
8265 ;; keymap (minor modes, major mode, global), and executes that
8266 ;; command. There might be problems if any of the keys is otherwise
8267 ;; used as a prefix key.
8269 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8270 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8271 ;; addresses this by checking explicitly for both bindings.
8273 (defvar orgstruct-mode-map (make-sparse-keymap)
8274 "Keymap for the minor `orgstruct-mode'.")
8276 (defvar org-local-vars nil
8277 "List of local variables, for use by `orgstruct-mode'.")
8279 ;;;###autoload
8280 (define-minor-mode orgstruct-mode
8281 "Toggle the minor mode `orgstruct-mode'.
8282 This mode is for using Org-mode structure commands in other
8283 modes. The following keys behave as if Org-mode were active, if
8284 the cursor is on a headline, or on a plain list item (both as
8285 defined by Org-mode).
8287 M-up Move entry/item up
8288 M-down Move entry/item down
8289 M-left Promote
8290 M-right Demote
8291 M-S-up Move entry/item up
8292 M-S-down Move entry/item down
8293 M-S-left Promote subtree
8294 M-S-right Demote subtree
8295 M-q Fill paragraph and items like in Org-mode
8296 C-c ^ Sort entries
8297 C-c - Cycle list bullet
8298 TAB Cycle item visibility
8299 M-RET Insert new heading/item
8300 S-M-RET Insert new TODO heading / Checkbox item
8301 C-c C-c Set tags / toggle checkbox"
8302 nil " OrgStruct" nil
8303 (org-load-modules-maybe)
8304 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8306 ;;;###autoload
8307 (defun turn-on-orgstruct ()
8308 "Unconditionally turn on `orgstruct-mode'."
8309 (orgstruct-mode 1))
8311 (defvar org-fb-vars nil)
8312 (make-variable-buffer-local 'org-fb-vars)
8313 (defun orgstruct++-mode (&optional arg)
8314 "Toggle `orgstruct-mode', the enhanced version of it.
8315 In addition to setting orgstruct-mode, this also exports all
8316 indentation and autofilling variables from org-mode into the
8317 buffer. It will also recognize item context in multiline items."
8318 (interactive "P")
8319 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8320 (if (< arg 1)
8321 (progn (orgstruct-mode -1)
8322 (mapc (lambda(v)
8323 (org-set-local (car v)
8324 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8325 org-fb-vars))
8326 (orgstruct-mode 1)
8327 (setq org-fb-vars nil)
8328 (let (var val)
8329 (mapc
8330 (lambda (x)
8331 (when (string-match
8333 (symbol-name (car x)))
8334 (setq var (car x) val (nth 1 x))
8335 (push (list var `(quote ,(eval var))) org-fb-vars)
8336 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8337 org-local-vars)
8338 (org-set-local 'orgstruct-is-++ t))))
8340 (defvar orgstruct-is-++ nil
8341 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8342 (make-variable-buffer-local 'orgstruct-is-++)
8344 ;;;###autoload
8345 (defun turn-on-orgstruct++ ()
8346 "Unconditionally turn on `orgstruct++-mode'."
8347 (orgstruct++-mode 1))
8349 (defun orgstruct-error ()
8350 "Error when there is no default binding for a structure key."
8351 (interactive)
8352 (error "This key has no function outside structure elements"))
8354 (defun orgstruct-setup ()
8355 "Setup orgstruct keymaps."
8356 (let ((nfunc 0)
8357 (bindings
8358 (list
8359 '([(meta up)] org-metaup)
8360 '([(meta down)] org-metadown)
8361 '([(meta left)] org-metaleft)
8362 '([(meta right)] org-metaright)
8363 '([(meta shift up)] org-shiftmetaup)
8364 '([(meta shift down)] org-shiftmetadown)
8365 '([(meta shift left)] org-shiftmetaleft)
8366 '([(meta shift right)] org-shiftmetaright)
8367 '([?\e (up)] org-metaup)
8368 '([?\e (down)] org-metadown)
8369 '([?\e (left)] org-metaleft)
8370 '([?\e (right)] org-metaright)
8371 '([?\e (shift up)] org-shiftmetaup)
8372 '([?\e (shift down)] org-shiftmetadown)
8373 '([?\e (shift left)] org-shiftmetaleft)
8374 '([?\e (shift right)] org-shiftmetaright)
8375 '([(shift up)] org-shiftup)
8376 '([(shift down)] org-shiftdown)
8377 '([(shift left)] org-shiftleft)
8378 '([(shift right)] org-shiftright)
8379 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8380 '("\M-q" fill-paragraph)
8381 '("\C-c^" org-sort)
8382 '("\C-c-" org-cycle-list-bullet)))
8383 elt key fun cmd)
8384 (while (setq elt (pop bindings))
8385 (setq nfunc (1+ nfunc))
8386 (setq key (org-key (car elt))
8387 fun (nth 1 elt)
8388 cmd (orgstruct-make-binding fun nfunc key))
8389 (org-defkey orgstruct-mode-map key cmd))
8391 ;; Prevent an error for users who forgot to make autoloads
8392 (require 'org-element)
8394 ;; Special treatment needed for TAB and RET
8395 (org-defkey orgstruct-mode-map [(tab)]
8396 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8397 (org-defkey orgstruct-mode-map "\C-i"
8398 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8400 (org-defkey orgstruct-mode-map "\M-\C-m"
8401 (orgstruct-make-binding 'org-insert-heading 105
8402 "\M-\C-m" [(meta return)]))
8403 (org-defkey orgstruct-mode-map [(meta return)]
8404 (orgstruct-make-binding 'org-insert-heading 106
8405 [(meta return)] "\M-\C-m"))
8407 (org-defkey orgstruct-mode-map [(shift meta return)]
8408 (orgstruct-make-binding 'org-insert-todo-heading 107
8409 [(meta return)] "\M-\C-m"))
8411 (org-defkey orgstruct-mode-map "\e\C-m"
8412 (orgstruct-make-binding 'org-insert-heading 108
8413 "\e\C-m" [?\e (return)]))
8414 (org-defkey orgstruct-mode-map [?\e (return)]
8415 (orgstruct-make-binding 'org-insert-heading 109
8416 [?\e (return)] "\e\C-m"))
8417 (org-defkey orgstruct-mode-map [?\e (shift return)]
8418 (orgstruct-make-binding 'org-insert-todo-heading 110
8419 [?\e (return)] "\e\C-m"))
8421 (unless org-local-vars
8422 (setq org-local-vars (org-get-local-variables)))
8424 t))
8426 (defun orgstruct-make-binding (fun n &rest keys)
8427 "Create a function for binding in the structure minor mode.
8428 FUN is the command to call inside a table. N is used to create a unique
8429 command name. KEYS are keys that should be checked in for a command
8430 to execute outside of tables."
8431 (eval
8432 (list 'defun
8433 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8434 '(arg)
8436 "Outside of structure, run the binding of `"
8437 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8438 "'.")
8439 '(interactive "p")
8440 (list 'if
8441 `(org-context-p 'headline 'item
8442 (and orgstruct-is-++
8443 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8444 'item-body))
8445 (list 'org-run-like-in-org-mode (list 'quote fun))
8446 (list 'let '(orgstruct-mode)
8447 (list 'call-interactively
8448 (append '(or)
8449 (mapcar (lambda (k)
8450 (list 'key-binding k))
8451 keys)
8452 '('orgstruct-error))))))))
8454 (defun org-contextualize-keys (alist contexts)
8455 "Return valid elements in ALIST depending on CONTEXTS.
8457 `org-agenda-custom-commands' or `org-capture-templates' are the
8458 values used for ALIST, and `org-agenda-custom-commands-contexts'
8459 or `org-capture-templates-contexts' are the associated contexts
8460 definitions."
8461 (let ((contexts
8462 ;; normalize contexts
8463 (mapcar
8464 (lambda(c) (cond ((listp (cadr c))
8465 (list (car c) (car c) (cadr c)))
8466 ((string= "" (cadr c))
8467 (list (car c) (car c) (caddr c)))
8468 (t c))) contexts))
8469 (a alist) c r s)
8470 ;; loop over all commands or templates
8471 (while (setq c (pop a))
8472 (let (vrules repl)
8473 (cond
8474 ((not (assoc (car c) contexts))
8475 (push c r))
8476 ((and (assoc (car c) contexts)
8477 (setq vrules (org-contextualize-validate-key
8478 (car c) contexts)))
8479 (mapc (lambda (vr)
8480 (when (not (equal (car vr) (cadr vr)))
8481 (setq repl vr))) vrules)
8482 (if (not repl) (push c r)
8483 (push (cadr repl) s)
8484 (push
8485 (cons (car c)
8486 (cdr (or (assoc (cadr repl) alist)
8487 (error "Undefined key `%s' as contextual replacement for `%s'"
8488 (cadr repl) (car c)))))
8489 r))))))
8490 ;; Return limited ALIST, possibly with keys modified, and deduplicated
8491 (delq
8492 nil
8493 (delete-dups
8494 (mapcar (lambda (x)
8495 (let ((tpl (car x)))
8496 (when (not (delq
8497 nil
8498 (mapcar (lambda(y)
8499 (equal y tpl)) s))) x)))
8500 (reverse r))))))
8502 (defun org-contextualize-validate-key (key contexts)
8503 "Check CONTEXTS for agenda or capture KEY."
8504 (let (r rr res)
8505 (while (setq r (pop contexts))
8506 (mapc
8507 (lambda (rr)
8508 (when
8509 (and (equal key (car r))
8510 (if (functionp rr) (funcall rr)
8511 (or (and (eq (car rr) 'in-file)
8512 (buffer-file-name)
8513 (string-match (cdr rr) (buffer-file-name)))
8514 (and (eq (car rr) 'in-mode)
8515 (string-match (cdr rr) (symbol-name major-mode)))
8516 (when (and (eq (car rr) 'not-in-file)
8517 (buffer-file-name))
8518 (not (string-match (cdr rr) (buffer-file-name))))
8519 (when (eq (car rr) 'not-in-mode)
8520 (not (string-match (cdr rr) (symbol-name major-mode)))))))
8521 (push r res)))
8522 (car (last r))))
8523 (delete-dups (delq nil res))))
8525 (defun org-context-p (&rest contexts)
8526 "Check if local context is any of CONTEXTS.
8527 Possible values in the list of contexts are `table', `headline', and `item'."
8528 (let ((pos (point)))
8529 (goto-char (point-at-bol))
8530 (prog1 (or (and (memq 'table contexts)
8532 (and (memq 'headline contexts)
8533 (looking-at org-outline-regexp))
8534 (and (memq 'item contexts)
8536 (and (memq 'item-body contexts)
8537 (org-in-item-p)))
8538 (goto-char pos))))
8540 (defun org-get-local-variables ()
8541 "Return a list of all local variables in an Org mode buffer."
8542 (let (varlist)
8543 (with-current-buffer (get-buffer-create "*Org tmp*")
8544 (erase-buffer)
8545 (org-mode)
8546 (setq varlist (buffer-local-variables)))
8547 (kill-buffer "*Org tmp*")
8548 (delq nil
8549 (mapcar
8550 (lambda (x)
8551 (setq x
8552 (if (symbolp x)
8553 (list x)
8554 (list (car x) (list 'quote (cdr x)))))
8555 (if (string-match
8556 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
8557 (symbol-name (car x)))
8558 x nil))
8559 varlist))))
8561 (defun org-clone-local-variables (from-buffer &optional regexp)
8562 "Clone local variables from FROM-BUFFER.
8563 Optional argument REGEXP selects variables to clone."
8564 (mapc
8565 (lambda (pair)
8566 (and (symbolp (car pair))
8567 (or (null regexp)
8568 (string-match regexp (symbol-name (car pair))))
8569 (set (make-local-variable (car pair))
8570 (cdr pair))))
8571 (buffer-local-variables from-buffer)))
8573 ;;;###autoload
8574 (defun org-run-like-in-org-mode (cmd)
8575 "Run a command, pretending that the current buffer is in Org-mode.
8576 This will temporarily bind local variables that are typically bound in
8577 Org-mode to the values they have in Org-mode, and then interactively
8578 call CMD."
8579 (org-load-modules-maybe)
8580 (unless org-local-vars
8581 (setq org-local-vars (org-get-local-variables)))
8582 (eval (list 'let org-local-vars
8583 (list 'call-interactively (list 'quote cmd)))))
8585 ;;;; Archiving
8587 (defun org-get-category (&optional pos force-refresh)
8588 "Get the category applying to position POS."
8589 (save-match-data
8590 (if force-refresh (org-refresh-category-properties))
8591 (let ((pos (or pos (point))))
8592 (or (get-text-property pos 'org-category)
8593 (progn (org-refresh-category-properties)
8594 (get-text-property pos 'org-category))))))
8596 (defun org-refresh-category-properties ()
8597 "Refresh category text properties in the buffer."
8598 (let ((case-fold-search t)
8599 (inhibit-read-only t)
8600 (def-cat (cond
8601 ((null org-category)
8602 (if buffer-file-name
8603 (file-name-sans-extension
8604 (file-name-nondirectory buffer-file-name))
8605 "???"))
8606 ((symbolp org-category) (symbol-name org-category))
8607 (t org-category)))
8608 beg end cat pos optionp)
8609 (org-unmodified
8610 (save-excursion
8611 (save-restriction
8612 (widen)
8613 (goto-char (point-min))
8614 (put-text-property (point) (point-max) 'org-category def-cat)
8615 (while (re-search-forward
8617 (setq pos (match-end 0)
8618 optionp (equal (char-after (match-beginning 0)) ?#)
8619 cat (org-trim (match-string 2)))
8620 (if optionp
8621 (setq beg (point-at-bol) end (point-max))
8622 (org-back-to-heading t)
8623 (setq beg (point) end (org-end-of-subtree t t)))
8624 (put-text-property beg end 'org-category cat)
8625 (put-text-property beg end 'org-category-position beg)
8626 (goto-char pos)))))))
8629 ;;;; Link Stuff
8631 ;;; Link abbreviations
8633 (defun org-link-expand-abbrev (link)
8634 "Apply replacements as defined in `org-link-abbrev-alist'."
8636 (let* ((key (match-string 1 link))
8637 (as (or (assoc key org-link-abbrev-alist-local)
8638 (assoc key org-link-abbrev-alist)))
8639 (tag (and (match-end 2) (match-string 3 link)))
8640 rpl)
8641 (if (not as)
8642 link
8643 (setq rpl (cdr as))
8644 (cond
8645 ((symbolp rpl) (funcall rpl tag))
8647 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
8648 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8649 ((string-match "%h" rpl)
8650 (replace-match (url-hexify-string (or tag "")) t t rpl))
8651 (t (concat rpl tag)))))
8652 link))
8654 ;;; Storing and inserting links
8656 (defvar org-insert-link-history nil
8657 "Minibuffer history for links inserted with `org-insert-link'.")
8659 (defvar org-stored-links nil
8660 "Contains the links stored with `org-store-link'.")
8662 (defvar org-store-link-plist nil
8663 "Plist with info about the most recently link created with `org-store-link'.")
8665 (defvar org-link-protocols nil
8666 "Link protocols added to Org-mode using `org-add-link-type'.")
8668 (defvar org-store-link-functions nil
8669 "List of functions that are called to create and store a link.
8670 Each function will be called in turn until one returns a non-nil
8671 value. Each function should check if it is responsible for creating
8672 this link (for example by looking at the major mode).
8673 If not, it must exit and return nil.
8674 If yes, it should return a non-nil value after a calling
8675 `org-store-link-props' with a list of properties and values.
8676 Special properties are:
8680 This is obligatory as well.
8681 :description Optional default description for the second pair
8682 of brackets in an Org-mode link. The user can still change
8683 this when inserting this link into an Org-mode buffer.
8685 In addition to these, any additional properties can be specified
8686 and then used in capture templates.")
8688 (defun org-add-link-type (type &optional follow export)
8689 "Add TYPE to the list of `org-link-types'.
8690 Re-compute all regular expressions depending on `org-link-types'
8692 FOLLOW and EXPORT are two functions.
8694 FOLLOW should take the link path as the single argument and do whatever
8695 is necessary to follow the link, for example find a file or display
8696 a mail message.
8698 EXPORT should format the link path for export to one of the export formats.
8699 It should be a function accepting three arguments:
8702 desc the description of the link, if any, or a description added by
8703 org-export-normalize-links if there is none
8704 format the export format, a symbol like `html' or `latex' or `ascii'..
8706 The function may use the FORMAT information to return different values
8707 depending on the format. The return value will be put literally into
8708 the exported file. If the return value is nil, this means Org should
8709 do what it normally does with links which do not have EXPORT defined.
8711 Org-mode has a built-in default for exporting links. If you are happy with
8712 this default, there is no need to define an export function for the link
8713 type. For a simple example of an export function, see `org-bbdb.el'."
8714 (add-to-list 'org-link-types type t)
8715 (org-make-link-regexps)
8716 (if (assoc type org-link-protocols)
8717 (setcdr (assoc type org-link-protocols) (list follow export))
8718 (push (list type follow export) org-link-protocols)))
8720 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
8721 (defvar org-link-to-org-use-id) ; Defined in org-id.el
8723 ;;;###autoload
8724 (defun org-store-link (arg)
8726 This link is added to `org-stored-links' and can later be inserted
8729 For some link types, a prefix arg is interpreted:
8730 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8731 For file links, arg negates `org-context-in-file-links'."
8732 (interactive "P")
8733 (org-load-modules-maybe)
8734 (setq org-store-link-plist nil) ; reset
8735 (org-with-limited-levels
8736 (let (link cpltxt desc description search txt custom-id agenda-link)
8737 (cond
8739 ((run-hook-with-args-until-success 'org-store-link-functions)
8740 (setq link (plist-get org-store-link-plist :link)
8741 desc (or (plist-get org-store-link-plist :description) link)))
8743 ((org-src-edit-buffer-p)
8744 (let (label gc)
8745 (while (or (not label)
8746 (save-excursion
8747 (save-restriction
8748 (widen)
8749 (goto-char (point-min))
8750 (re-search-forward
8751 (regexp-quote (format org-coderef-label-format label))
8752 nil t))))
8753 (when label (message "Label exists already") (sit-for 2))
8754 (setq label (read-string "Code line label: " label)))
8755 (end-of-line 1)
8756 (setq link (format org-coderef-label-format label))
8757 (setq gc (- 79 (length link)))
8758 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8759 (insert link)
8760 (setq link (concat "(" label ")") desc nil)))
8762 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8763 ;; We are in the agenda, link to referenced location
8764 (let ((m (or (get-text-property (point) 'org-hd-marker)
8765 (get-text-property (point) 'org-marker))))
8766 (when m
8767 (org-with-point-at m
8768 (setq agenda-link
8769 (if (org-called-interactively-p 'any)
8770 (call-interactively 'org-store-link)
8771 (org-store-link nil)))))))
8773 ((eq major-mode 'calendar-mode)
8774 (let ((cd (calendar-cursor-to-date)))
8775 (setq link
8776 (format-time-string
8777 (car org-time-stamp-formats)
8778 (apply 'encode-time
8779 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8780 nil nil nil))))
8781 (org-store-link-props :type "calendar" :date cd)))
8783 ((eq major-mode 'help-mode)
8784 (setq link (concat "help:" (save-excursion
8785 (goto-char (point-min))
8786 (looking-at "^[^ ]+")
8787 (match-string 0))))
8788 (org-store-link-props :type "help"))
8790 ((eq major-mode 'w3-mode)
8791 (setq cpltxt (if (and (buffer-name)
8792 (not (string-match "Untitled" (buffer-name))))
8793 (buffer-name)
8794 (url-view-url t))
8795 link (url-view-url t))
8796 (org-store-link-props :type "w3" :url (url-view-url t)))
8798 ((eq major-mode 'w3m-mode)
8799 (setq cpltxt (or w3m-current-title w3m-current-url)
8800 link w3m-current-url)
8801 (org-store-link-props :type "w3m" :url (url-view-url t)))
8803 ((setq search (run-hook-with-args-until-success
8804 'org-create-file-search-functions))
8805 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8806 "::" search))
8807 (setq cpltxt (or description link)))
8809 ((eq major-mode 'image-mode)
8810 (setq cpltxt (concat "file:"
8811 (abbreviate-file-name buffer-file-name))
8812 link cpltxt)
8813 (org-store-link-props :type "image" :file buffer-file-name))
8815 ((eq major-mode 'dired-mode)
8816 ;; link to the file in the current line
8817 (let ((file (dired-get-filename nil t)))
8818 (setq file (if file
8819 (abbreviate-file-name
8820 (expand-file-name (dired-get-filename nil t)))
8821 ;; otherwise, no file so use current directory.
8822 default-directory))
8823 (setq cpltxt (concat "file:" file)
8824 link cpltxt)))
8826 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
8827 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8828 (cond
8830 (setq cpltxt
8831 (concat "file:"
8832 (abbreviate-file-name
8833 (buffer-file-name (buffer-base-buffer)))
8834 "::" (match-string 1))
8835 link cpltxt))
8836 ((and (featurep 'org-id)
8837 (or (eq org-link-to-org-use-id t)
8838 (and (org-called-interactively-p 'any)
8839 (or (eq org-link-to-org-use-id 'create-if-interactive)
8840 (and (eq org-link-to-org-use-id
8841 'create-if-interactive-and-no-custom-id)
8842 (not custom-id))))
8843 (and org-link-to-org-use-id (org-entry-get nil "ID"))))
8844 ;; We can make a link using the ID.
8845 (setq link (condition-case nil
8846 (prog1 (org-id-store-link)
8847 (setq desc (plist-get org-store-link-plist :description)))
8848 (error
8849 ;; probably before first headline, link to file only
8850 (concat "file:"
8851 (abbreviate-file-name
8852 (buffer-file-name (buffer-base-buffer))))))))
8853 (t
8854 ;; Just link to current headline
8855 (setq cpltxt (concat "file:"
8856 (abbreviate-file-name
8857 (buffer-file-name (buffer-base-buffer)))))
8858 ;; Add a context search string
8859 (when (org-xor org-context-in-file-links arg)
8860 (setq txt (cond
8861 ((org-at-heading-p) nil)
8862 ((org-region-active-p)
8863 (buffer-substring (region-beginning) (region-end)))))
8865 (setq cpltxt
8866 (concat cpltxt "::"
8867 (condition-case nil
8868 (org-make-org-heading-search-string txt)
8869 (error "")))
8870 desc (or (nth 4 (ignore-errors
8871 (org-heading-components))) "NONE"))))
8873 (setq cpltxt (substring cpltxt 0 -2)))
8874 (setq link cpltxt))))
8876 ((buffer-file-name (buffer-base-buffer))
8877 ;; Just link to this file here.
8878 (setq cpltxt (concat "file:"
8879 (abbreviate-file-name
8880 (buffer-file-name (buffer-base-buffer)))))
8881 ;; Add a context string
8882 (when (org-xor org-context-in-file-links arg)
8883 (setq txt (if (org-region-active-p)
8884 (buffer-substring (region-beginning) (region-end))
8885 (buffer-substring (point-at-bol) (point-at-eol))))
8886 ;; Only use search option if there is some text.
8888 (setq cpltxt
8889 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8890 desc "NONE")))
8891 (setq link cpltxt))
8893 ((org-called-interactively-p 'interactive)
8894 (error "Cannot link to a buffer which is not visiting a file"))
8896 (t (setq link nil)))
8898 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8899 (setq link (or link cpltxt)
8900 desc (or desc cpltxt))
8901 (if (equal desc "NONE") (setq desc nil))
8903 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8904 (progn
8905 (setq org-stored-links
8906 (cons (list link desc) org-stored-links))
8907 (message "Stored: %s" (or desc link))
8908 (when custom-id
8909 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8910 "::#" custom-id))
8911 (setq org-stored-links
8912 (cons (list link desc) org-stored-links))))
8913 (or agenda-link (and link (org-make-link-string link desc)))))))
8915 (defun org-store-link-props (&rest plist)
8916 "Store link properties, extract names and addresses."
8917 (let (x adr)
8918 (when (setq x (plist-get plist :from))
8919 (setq adr (mail-extract-address-components x))
8920 (setq plist (plist-put plist :fromname (car adr)))
8921 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8922 (when (setq x (plist-get plist :to))
8923 (setq adr (mail-extract-address-components x))
8924 (setq plist (plist-put plist :toname (car adr)))
8925 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8926 (let ((from (plist-get plist :from))
8927 (to (plist-get plist :to)))
8928 (when (and from to org-from-is-user-regexp)
8929 (setq plist
8930 (plist-put plist :fromto
8931 (if (string-match org-from-is-user-regexp from)
8932 (concat "to %t")
8933 (concat "from %f"))))))
8934 (setq org-store-link-plist plist))
8936 (defun org-add-link-props (&rest plist)
8937 "Add these properties to the link property list."
8938 (let (key value)
8939 (while plist
8940 (setq key (pop plist) value (pop plist))
8941 (setq org-store-link-plist
8942 (plist-put org-store-link-plist key value)))))
8944 (defun org-email-link-description (&optional fmt)
8945 "Return the description part of an email link.
8946 This takes information from `org-store-link-plist' and formats it
8947 according to FMT (default from `org-email-link-description-format')."
8948 (setq fmt (or fmt org-email-link-description-format))
8949 (let* ((p org-store-link-plist)
8950 (to (plist-get p :toaddress))
8951 (from (plist-get p :fromaddress))
8952 (table
8953 (list
8954 (cons "%c" (plist-get p :fromto))
8955 (cons "%F" (plist-get p :from))
8956 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8957 (cons "%T" (plist-get p :to))
8958 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8959 (cons "%s" (plist-get p :subject))
8960 (cons "%d" (plist-get p :date))
8961 (cons "%m" (plist-get p :message-id)))))
8962 (when (string-match "%c" fmt)
8963 ;; Check if the user wrote this message
8964 (if (and org-from-is-user-regexp from to
8965 (save-match-data (string-match org-from-is-user-regexp from)))
8966 (setq fmt (replace-match "to %t" t t fmt))
8967 (setq fmt (replace-match "from %f" t t fmt))))
8968 (org-replace-escapes fmt table)))
8970 (defun org-make-org-heading-search-string (&optional string heading)
8971 "Make search string for STRING or current headline."
8972 (interactive)
8973 (let ((s (or string (org-get-heading)))
8974 (lines org-context-in-file-links))
8975 (unless (and string (not heading))
8976 ;; We are using a headline, clean up garbage in there.
8977 (if (string-match org-todo-regexp s)
8978 (setq s (replace-match "" t t s)))
8980 (setq s (replace-match "" t t s)))
8981 (setq s (org-trim s))
8984 (setq s (replace-match "" t t s)))
8985 (while (string-match org-ts-regexp s)
8986 (setq s (replace-match "" t t s))))
8987 (or string (setq s (concat "*" s))) ; Add * for headlines
8988 (when (and string (integerp lines) (> lines 0))
8990 (when (< lines (length slines))
8991 (setq s (mapconcat
8992 'identity
8993 (reverse (nthcdr (- (length slines) lines)
8997 (defun org-make-link-string (link &optional description)
8998 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9000 (error "Empty link"))
9001 (when (and description
9002 (stringp description)
9004 (setq description nil))
9005 (when (stringp description)
9006 ;; Remove brackets from the description, they are fatal.
9008 (setq description (replace-match "{" t t description)))
9010 (setq description (replace-match "}" t t description))))
9011 (when (equal link description)
9012 ;; No description needed, it is identical
9013 (setq description nil))
9014 (when (and (not description)
9015 (not (string-match (org-image-file-name-regexp) link))
9016 (not (equal link (org-link-escape link))))
9017 (setq description (org-extract-attributes link)))
9018 (setq link
9019 (cond ((string-match (org-image-file-name-regexp) link) link)
9020 ((string-match org-link-types-re link)
9021 (concat (match-string 1 link)
9022 (org-link-escape (substring link (match-end 1)))))
9023 (t (org-link-escape link))))
9024 (concat "[[" link "]"
9025 (if description (concat "[" description "]") "")
9026 "]"))
9028 (defconst org-link-escape-chars
9029 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9030 "List of characters that should be escaped in link.
9031 This is the list that is used for internal purposes.")
9033 (defconst org-link-escape-chars-browser
9034 '(?\ )
9035 "List of escapes for characters that are problematic in links.
9036 This is the list that is used before handing over to the browser.")
9038 (defun org-link-escape (text &optional table merge)
9039 "Return percent escaped representation of TEXT.
9040 TEXT is a string with the text to escape.
9041 Optional argument TABLE is a list with characters that should be
9042 escaped. When nil, `org-link-escape-chars' is used.
9043 If optional argument MERGE is set, merge TABLE into
9044 `org-link-escape-chars'."
9045 (cond
9046 ((and table merge)
9047 (mapc (lambda (defchr)
9048 (unless (member defchr table)
9049 (setq table (cons defchr table)))) org-link-escape-chars))
9050 ((null table)
9051 (setq table org-link-escape-chars)))
9052 (mapconcat
9053 (lambda (char)
9054 (if (or (member char table)
9055 (and (or (< char 32) (= char 37) (> char 126))
9056 org-url-hexify-p))
9057 (mapconcat (lambda (sequence-element)
9058 (format "%%%.2X" sequence-element))
9059 (or (encode-coding-char char 'utf-8)
9060 (error "Unable to percent escape character: %s"
9061 (char-to-string char))) "")
9062 (char-to-string char))) text ""))
9064 (defun org-link-unescape (str)
9065 "Unhex hexified Unicode strings as returned from the JavaScript function
9066 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9067 (unless (and (null str) (string= "" str))
9068 (let ((pos 0) (case-fold-search t) unhexed)
9070 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9071 (setq str (replace-match unhexed t t str))
9072 (setq pos (+ pos (length unhexed))))))
9073 str)
9075 (defun org-link-unescape-compound (hex)
9076 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9077 Note: this function also decodes single byte encodings like
9078 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9079 (save-match-data
9080 (let* ((bytes (cdr (split-string hex "%")))
9081 (ret "")
9082 (eat 0)
9083 (sum 0))
9084 (while bytes
9085 (let* ((val (string-to-number (pop bytes) 16))
9086 (shift-xor
9087 (if (= 0 eat)
9088 (cond
9089 ((>= val 252) (cons 6 252))
9090 ((>= val 248) (cons 5 248))
9091 ((>= val 240) (cons 4 240))
9092 ((>= val 224) (cons 3 224))
9093 ((>= val 192) (cons 2 192))
9094 (t (cons 0 0)))
9095 (cons 6 128))))
9096 (if (>= val 192) (setq eat (car shift-xor)))
9097 (setq val (logxor val (cdr shift-xor)))
9098 (setq sum (+ (lsh sum (car shift-xor)) val))
9099 (if (> eat 0) (setq eat (- eat 1)))
9100 (cond
9101 ((= 0 eat) ;multi byte
9102 (setq ret (concat ret (org-char-to-string sum)))
9103 (setq sum 0))
9104 ((not bytes) ; single byte(s)
9105 (setq ret (org-link-unescape-single-byte-sequence hex))))
9106 )) ;; end (while bytes
9107 ret )))
9109 (defun org-link-unescape-single-byte-sequence (hex)
9110 "Unhexify hex-encoded single byte character sequences."
9111 (mapconcat (lambda (byte)
9112 (char-to-string (string-to-number byte 16)))
9113 (cdr (split-string hex "%")) ""))
9115 (defun org-xor (a b)
9116 "Exclusive or."
9117 (if a (not b) b))
9119 (defun org-fixup-message-id-for-http (s)
9120 "Replace special characters in a message id, so it can be used in an http query."
9121 (when (string-match "%" s)
9122 (setq s (mapconcat (lambda (c)
9123 (if (eq c ?%)
9124 "%25"
9125 (char-to-string c)))
9126 s "")))
9127 (while (string-match "<" s)
9128 (setq s (replace-match "%3C" t t s)))
9129 (while (string-match ">" s)
9130 (setq s (replace-match "%3E" t t s)))
9131 (while (string-match "@" s)
9132 (setq s (replace-match "%40" t t s)))
9133 s)
9135 (defun org-link-prettify (link)
9136 "Return a human-readable representation of LINK.
9137 The car of LINK must be a raw link the cdr of LINK must be either
9138 a link description or nil."
9139 (let ((desc (or (cadr link) "<no description>")))
9140 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9141 "<" (car link) ">")))
9143 ;;;###autoload
9144 (defun org-insert-link-global ()
9145 "Insert a link like Org-mode does.
9146 This command can be called in any mode to insert a link in Org-mode syntax."
9147 (interactive)
9148 (org-load-modules-maybe)
9149 (org-run-like-in-org-mode 'org-insert-link))
9151 (defun org-insert-all-links (&optional keep)
9152 "Insert all links in `org-stored-links'."
9153 (interactive "P")
9154 (let ((links (copy-sequence org-stored-links)) l)
9155 (while (setq l (if keep (pop links) (pop org-stored-links)))
9156 (insert "- ")
9157 (org-insert-link nil (car l) (cadr l))
9160 (defun org-link-fontify-links-to-this-file ()
9161 "Fontify links to the current file in `org-stored-links'."
9162 (let ((f (buffer-file-name)) a b)
9163 (setq a (mapcar (lambda(l)
9164 (let ((ll (car l)))
9166 (equal f (expand-file-name (match-string 1 ll))))
9167 ll)))
9168 org-stored-links))
9169 (when (featurep 'org-id)
9170 (setq b (mapcar (lambda(l)
9171 (let ((ll (car l)))
9173 (equal f (expand-file-name
9174 (or (org-id-find-id-file
9175 (match-string 1 ll)) ""))))
9176 ll)))
9177 org-stored-links)))
9178 (mapcar (lambda(l)
9179 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9180 (delq nil (append a b)))))
9182 (defvar org-link-links-in-this-file nil)
9183 (defun org-insert-link (&optional complete-file link-location default-description)
9184 "Insert a link. At the prompt, enter the link.
9186 Completion can be used to insert any of the link protocol prefixes like
9187 http or ftp in use.
9189 The history can be used to select a link previously stored with
9190 `org-store-link'. When the empty string is entered (i.e. if you just
9191 press RET at the prompt), the link defaults to the most recently
9192 stored link. As SPC triggers completion in the minibuffer, you need to
9193 use M-SPC or C-q SPC to force the insertion of a space character.
9195 You will also be prompted for a description, and if one is given, it will
9196 be displayed in the buffer instead of the link.
9198 If there is already a link at point, this command will allow you to edit link
9199 and description parts.
9202 be selected using completion. The path to the file will be relative to the
9203 current directory if the file is in the current directory or a subdirectory.
9204 Otherwise, the link will be the absolute path as completed in the minibuffer
9205 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9206 option `org-link-file-path-type'.
9209 the current directory or below.
9212 `org-keep-stored-link-after-insertion'.
9214 If `org-make-link-description-function' is non-nil, this function will be
9215 called with the link target, and the result will be the default
9216 link description.
9218 If the LINK-LOCATION parameter is non-nil, this value will be
9219 used as the link location instead of reading one interactively.
9221 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9222 be used as the default description."
9223 (interactive "P")
9224 (let* ((wcf (current-window-configuration))
9225 (region (if (org-region-active-p)
9226 (buffer-substring (region-beginning) (region-end))))
9227 (remove (and region (list (region-beginning) (region-end))))
9228 (desc region)
9229 tmphist ; byte-compile incorrectly complains about this
9230 (link link-location)
9231 (abbrevs org-link-abbrev-alist-local)
9232 entry file all-prefixes auto-desc)
9233 (cond
9234 (link-location) ; specified by arg, just use it.
9235 ((org-in-regexp org-bracket-link-regexp 1)
9236 ;; We do have a link at point, and we are going to edit it.
9237 (setq remove (list (match-beginning 0) (match-end 0)))
9238 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9239 (setq link (read-string "Link: "
9240 (org-link-unescape
9241 (org-match-string-no-properties 1)))))
9242 ((or (org-in-regexp org-angle-link-re)
9243 (org-in-regexp org-plain-link-re))
9244 ;; Convert to bracket link
9245 (setq remove (list (match-beginning 0) (match-end 0))
9246 link (read-string "Link: "
9247 (org-remove-angle-brackets (match-string 0)))))
9248 ((member complete-file '((4) (16)))
9249 ;; Completing read for file names.
9250 (setq link (org-file-complete-link complete-file)))
9251 (t
9252 ;; Read link, with completion for stored links.
9253 (org-link-fontify-links-to-this-file)
9254 (org-switch-to-buffer-other-window "*Org Links*")
9255 (with-current-buffer "*Org Links*"
9256 (erase-buffer)
9257 (insert "Insert a link.
9259 (when org-stored-links
9261 (insert (mapconcat 'org-link-prettify
9263 (goto-char (point-min)))
9264 (let ((cw (selected-window)))
9265 (select-window (get-buffer-window "*Org Links*" 'visible))
9266 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9267 (unless (pos-visible-in-window-p (point-max))
9268 (org-fit-window-to-buffer))
9269 (and (window-live-p cw) (select-window cw)))
9270 ;; Fake a link history, containing the stored links.
9271 (setq tmphist (append (mapcar 'car org-stored-links)
9272 org-insert-link-history))
9273 (setq all-prefixes (append (mapcar 'car abbrevs)
9274 (mapcar 'car org-link-abbrev-alist)
9275 org-link-types))
9276 (unwind-protect
9277 (progn
9278 (setq link
9279 (let ((org-completion-use-ido nil)
9280 (org-completion-use-iswitchb nil))
9281 (org-completing-read
9282 "Link: "
9283 (append
9284 (mapcar (lambda (x) (list (concat x ":")))
9285 all-prefixes)
9286 (mapcar 'car org-stored-links)
9287 (mapcar 'cadr org-stored-links))
9288 nil nil nil
9289 'tmphist
9290 (caar org-stored-links))))
9292 (error "No link selected"))
9293 (mapc (lambda(l)
9294 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9295 org-stored-links)
9296 (if (or (member link all-prefixes)
9297 (and (equal ":" (substring link -1))
9298 (member (substring link 0 -1) all-prefixes)
9299 (setq link (substring link 0 -1))))
9300 (setq link (org-link-try-special-completion link))))
9301 (set-window-configuration wcf)
9302 (kill-buffer "*Org Links*"))
9303 (setq entry (assoc link org-stored-links))
9304 (or entry (push link org-insert-link-history))
9305 (setq desc (or desc (nth 1 entry)))))
9307 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9308 (not org-keep-stored-link-after-insertion))
9309 (setq org-stored-links (delq (assoc link org-stored-links)
9310 org-stored-links)))
9312 (if (string-match org-plain-link-re link)
9313 ;; URL-like link, normalize the use of angular brackets.
9314 (setq link (org-remove-angle-brackets link)))
9316 ;; Check if we are linking to the current file with a search
9317 ;; option If yes, simplify the link by using only the search
9318 ;; option.
9319 (when (and buffer-file-name
9321 (let* ((path (match-string 1 link))
9322 (case-fold-search nil)
9323 (search (match-string 2 link)))
9324 (save-match-data
9325 (if (equal (file-truename buffer-file-name) (file-truename path))
9326 ;; We are linking to this same file, with a search option
9327 (setq link search)))))
9329 ;; Check if we can/should use a relative path. If yes, simplify the link
9331 (let* ((type (match-string 1 link))
9332 (path (match-string 2 link))
9333 (origpath path)
9334 (case-fold-search nil))
9335 (cond
9336 ((or (eq org-link-file-path-type 'absolute)
9337 (equal complete-file '(16)))
9338 (setq path (abbreviate-file-name (expand-file-name path))))
9339 ((eq org-link-file-path-type 'noabbrev)
9340 (setq path (expand-file-name path)))
9341 ((eq org-link-file-path-type 'relative)
9342 (setq path (file-relative-name path)))
9343 (t
9344 (save-match-data
9345 (if (string-match (concat "^" (regexp-quote
9346 (expand-file-name
9347 (file-name-as-directory
9348 default-directory))))
9349 (expand-file-name path))
9350 ;; We are linking a file with relative path name.
9351 (setq path (substring (expand-file-name path)
9352 (match-end 0)))
9353 (setq path (abbreviate-file-name (expand-file-name path)))))))
9354 (setq link (concat type path))
9355 (if (equal desc origpath)
9356 (setq desc path))))
9358 (if org-make-link-description-function
9359 (setq desc
9360 (or (condition-case nil
9361 (funcall org-make-link-description-function link desc)
9362 (error (progn (message "Can't get link description from `%s'"
9363 (symbol-name org-make-link-description-function))
9364 (sit-for 2) nil)))
9365 (read-string "Description: " default-description)))
9366 (if default-description (setq desc default-description)
9367 (setq desc (or (and auto-desc desc)
9368 (read-string "Description: " desc)))))
9371 (if remove (apply 'delete-region remove))
9372 (insert (org-make-link-string link desc))))
9374 (defun org-link-try-special-completion (type)
9375 "If there is completion support for link type TYPE, offer it."
9376 (let ((fun (intern (concat "org-" type "-complete-link"))))
9377 (if (functionp fun)
9378 (funcall fun)
9379 (read-string "Link (no completion support): " (concat type ":")))))
9381 (defun org-file-complete-link (&optional arg)
9382 "Create a file link using completion."
9383 (let (file link)
9384 (setq file (read-file-name "File: "))
9385 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9386 (pwd1 (file-name-as-directory (abbreviate-file-name
9387 (expand-file-name ".")))))
9388 (cond
9389 ((equal arg '(16))
9390 (setq link (concat
9391 "file:"
9392 (abbreviate-file-name (expand-file-name file)))))
9394 (setq link (concat "file:" (match-string 1 file))))
9396 (expand-file-name file))
9397 (setq link (concat
9398 "file:" (match-string 1 (expand-file-name file)))))
9399 (t (setq link (concat "file:" file)))))
9400 link))
9402 (defun org-completing-read (&rest args)
9403 "Completing-read with SPACE being a normal character."
9404 (let ((enable-recursive-minibuffers t)
9405 (minibuffer-local-completion-map
9406 (copy-keymap minibuffer-local-completion-map)))
9407 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9408 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9409 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9410 (apply 'org-icompleting-read args)))
9412 (defun org-completing-read-no-i (&rest args)
9413 (let (org-completion-use-ido org-completion-use-iswitchb)
9414 (apply 'org-completing-read args)))
9416 (defun org-iswitchb-completing-read (prompt choices &rest args)
9417 "Use iswitch as a completing-read replacement to choose from choices.
9418 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9419 from."
9420 (let* ((iswitchb-use-virtual-buffers nil)
9421 (iswitchb-make-buflist-hook
9422 (lambda ()
9423 (setq iswitchb-temp-buflist choices))))
9424 (iswitchb-read-buffer prompt)))
9426 (defun org-icompleting-read (&rest args)
9427 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9428 (org-without-partial-completion
9429 (if (and org-completion-use-ido
9430 (fboundp 'ido-completing-read)
9431 (boundp 'ido-mode) ido-mode
9432 (listp (second args)))
9433 (let ((ido-enter-matching-directory nil))
9434 (apply 'ido-completing-read (concat (car args))
9435 (if (consp (car (nth 1 args)))
9436 (mapcar 'car (nth 1 args))
9437 (nth 1 args))
9438 (cddr args)))
9439 (if (and org-completion-use-iswitchb
9440 (boundp 'iswitchb-mode) iswitchb-mode
9441 (listp (second args)))
9442 (apply 'org-iswitchb-completing-read (concat (car args))
9443 (if (consp (car (nth 1 args)))
9444 (mapcar 'car (nth 1 args))
9445 (nth 1 args))
9446 (cddr args))
9447 (apply 'completing-read args)))))
9449 (defun org-extract-attributes (s)
9450 "Extract the attributes cookie from a string and set as text property."
9451 (let (a attr (start 0) key value)
9452 (save-match-data
9454 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9456 (setq key (match-string 1 a) value (match-string 2 a)
9457 start (match-end 0)
9458 attr (plist-put attr (intern key) value))))
9459 (org-add-props s nil 'org-attr attr))
9460 s))
9462 (defun org-extract-attributes-from-string (tag)
9463 (let (key value attr)
9465 (setq key (match-string 1 tag) value (match-string 2 tag)
9466 tag (replace-match "" t t tag)
9467 attr (plist-put attr (intern key) value)))
9468 (cons tag attr)))
9470 (defun org-attributes-to-string (plist)
9471 "Format a property list into an HTML attribute list."
9472 (let ((s "") key value)
9473 (while plist
9474 (setq key (pop plist) value (pop plist))
9475 (and value
9477 s))
9479 ;;; Opening/following a link
9481 (defvar org-link-search-failed nil)
9483 (defvar org-open-link-functions nil
9484 "Hook for functions finding a plain text link.
9485 These functions must take a single argument, the link content.
9486 They will be called for links that look like [[link text][description]]
9490 These functions will be called *before* Org attempts to resolve the
9491 link by doing text searches in the current buffer - so if you want a
9493 handle this as a special case.
9495 When the function does handle the link, it must return a non-nil value.
9496 If it decides that it is not responsible for this link, it must return
9497 nil to indicate that that Org-mode can continue with other options
9498 like exact and fuzzy text search.")
9500 (defun org-next-link ()
9501 "Move forward to the next link.
9502 If the link is in hidden text, expose it."
9503 (interactive)
9504 (when (and org-link-search-failed (eq this-command last-command))
9505 (goto-char (point-min))
9506 (message "Link search wrapped back to beginning of buffer"))
9507 (setq org-link-search-failed nil)
9508 (let* ((pos (point))
9509 (ct (org-context))
9510 (a (assoc :link ct)))
9511 (if a (goto-char (nth 2 a)))
9512 (if (re-search-forward org-any-link-re nil t)
9513 (progn
9514 (goto-char (match-beginning 0))
9515 (if (outline-invisible-p) (org-show-context)))
9516 (goto-char pos)
9517 (setq org-link-search-failed t)
9518 (error "No further link found"))))
9520 (defun org-previous-link ()
9521 "Move backward to the previous link.
9522 If the link is in hidden text, expose it."
9523 (interactive)
9524 (when (and org-link-search-failed (eq this-command last-command))
9525 (goto-char (point-max))
9526 (message "Link search wrapped back to end of buffer"))
9527 (setq org-link-search-failed nil)
9528 (let* ((pos (point))
9529 (ct (org-context))
9530 (a (assoc :link ct)))
9531 (if a (goto-char (nth 1 a)))
9532 (if (re-search-backward org-any-link-re nil t)
9533 (progn
9534 (goto-char (match-beginning 0))
9535 (if (outline-invisible-p) (org-show-context)))
9536 (goto-char pos)
9537 (setq org-link-search-failed t)
9538 (error "No further link found"))))
9540 (defun org-translate-link (s)
9541 "Translate a link string if a translation function has been defined."
9542 (if (and org-link-translation-function
9543 (fboundp org-link-translation-function)
9545 (progn
9546 (setq s (funcall org-link-translation-function
9547 (match-string 1 s) (match-string 2 s)))
9548 (concat (car s) ":" (cdr s)))
9549 s))
9551 (defun org-translate-link-from-planner (type path)
9552 "Translate a link from Emacs Planner syntax so that Org can follow it.
9553 This is still an experimental function, your mileage may vary."
9554 (cond
9555 ((member type '("http" "https" "news" "ftp"))
9556 ;; standard Internet links are the same.
9557 nil)
9558 ((and (equal type "irc") (string-match "^//" path))
9559 ;; Planner has two / at the beginning of an irc link, we have 1.
9560 ;; We should have zero, actually....
9561 (setq path (substring path 1)))
9562 ((and (equal type "lisp") (string-match "^/" path))
9563 ;; Planner has a slash, we do not.
9564 (setq type "elisp" path (substring path 1)))
9566 ;; A typical message link. Planner has the id after the final slash,
9567 ;; we separate it with a hash mark
9568 (setq path (concat (match-string 1 path) "#"
9569 (org-remove-angle-brackets (match-string 2 path)))))
9570 )
9571 (cons type path))
9573 (defun org-find-file-at-mouse (ev)
9574 "Open file link or URL at mouse."
9575 (interactive "e")
9576 (mouse-set-point ev)
9577 (org-open-at-point 'in-emacs))
9579 (defun org-open-at-mouse (ev)
9580 "Open file link or URL at mouse.
9581 See the docstring of `org-open-file' for details."
9582 (interactive "e")
9583 (mouse-set-point ev)
9584 (if (eq major-mode 'org-agenda-mode)
9585 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9586 (org-open-at-point))
9588 (defvar org-window-config-before-follow-link nil
9589 "The window configuration before following a link.
9590 This is saved in case the need arises to restore it.")
9592 (defvar org-open-link-marker (make-marker)
9593 "Marker pointing to the location where `org-open-at-point; was called.")
9595 ;;;###autoload
9596 (defun org-open-at-point-global ()
9597 "Follow a link like Org-mode does.
9598 This command can be called in any mode to follow a link that has
9599 Org-mode syntax."
9600 (interactive)
9601 (org-run-like-in-org-mode 'org-open-at-point))
9603 ;;;###autoload
9604 (defun org-open-link-from-string (s &optional arg reference-buffer)
9605 "Open a link in the string S, as if it was in Org-mode."
9607 (let ((reference-buffer (or reference-buffer (current-buffer))))
9608 (with-temp-buffer
9609 (let ((org-inhibit-startup (not reference-buffer)))
9610 (org-mode)
9611 (insert s)
9612 (goto-char (point-min))
9613 (when reference-buffer
9614 (setq org-link-abbrev-alist-local
9615 (with-current-buffer reference-buffer
9616 org-link-abbrev-alist-local)))
9617 (org-open-at-point arg reference-buffer)))))
9619 (defvar org-open-at-point-functions nil
9620 "Hook that is run when following a link at point.
9622 Functions in this hook must return t if they identify and follow
9623 a link at point. If they don't find anything interesting at point,
9624 they must return nil.")
9626 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
9627 (defun org-open-at-point (&optional arg reference-buffer)
9628 "Open link at or after point.
9629 If there is no link at point, this function will search forward up to
9630 the end of the current line.
9631 Normally, files will be opened by an appropriate application. If the
9632 optional prefix argument ARG is non-nil, Emacs will visit the file.
9633 With a double prefix argument, try to open outside of Emacs, in the
9634 application the system uses for this file type."
9635 (interactive "P")
9636 ;; if in a code block, then open the block's results
9637 (unless (call-interactively #'org-babel-open-src-block-result)
9638 (org-load-modules-maybe)
9639 (move-marker org-open-link-marker (point))
9640 (setq org-window-config-before-follow-link (current-window-configuration))
9641 (org-remove-occur-highlights nil nil t)
9642 (cond
9643 ((and (org-at-heading-p)
9644 (not (org-at-timestamp-p t))
9645 (not (org-in-regexp
9650 (not (get-text-property (point) 'org-linked-text)))
9651 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
9652 (lk (car lkall))
9653 (lkend (cdr lkall)))
9654 (when lk
9655 (prog1 (search-forward lk nil lkend)
9656 (goto-char (match-beginning 0))
9657 (org-open-at-point))))
9658 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9659 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9660 ((and (org-at-timestamp-p t)
9661 (not (org-in-regexp org-bracket-link-regexp)))
9662 (org-follow-timestamp-link))
9663 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9664 (not (org-in-regexp org-any-link-re)))
9665 (org-footnote-action))
9666 (t
9667 (let (type path link line search (pos (point)))
9668 (catch 'match
9669 (save-excursion
9671 (when (org-in-regexp org-bracket-link-regexp 1)
9672 (setq link (org-extract-attributes
9673 (org-link-unescape (org-match-string-no-properties 1))))
9675 (setq link (replace-match " " t t link)))
9676 (setq link (org-link-expand-abbrev link))
9677 (cond
9678 ((or (file-name-absolute-p link)
9680 (setq type "file" path link))
9681 ((string-match org-link-re-with-space3 link)
9682 (setq type (match-string 1 link) path (match-string 2 link)))
9684 (setq type "help" path (match-string 1 link)))
9685 (t (setq type "thisfile" path link)))
9686 (throw 'match t)))
9688 (when (get-text-property (point) 'org-linked-text)
9689 (setq type "thisfile"
9690 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9691 (1+ (point)) (point))
9692 path (buffer-substring
9693 (or (previous-single-property-change pos 'org-linked-text)
9694 (point-min))
9695 (or (next-single-property-change pos 'org-linked-text)
9696 (point-max))))
9697 (throw 'match t))
9699 (save-excursion
9700 (let ((plinkpos (org-in-regexp org-plain-link-re)))
9701 (when (or (org-in-regexp org-angle-link-re)
9702 (and plinkpos (goto-char (car plinkpos))
9704 (setq type (match-string 1)
9705 path (org-link-unescape (match-string 2)))
9706 (throw 'match t))))
9707 (save-excursion
9709 (setq type "tags"
9710 path (match-string 1))
9711 (while (string-match ":" path)
9712 (setq path (replace-match "+" t t path)))
9713 (throw 'match t)))
9715 (setq type "tree-match"
9716 path (match-string 1))
9717 (throw 'match t)))
9718 (unless path
9719 (user-error "No link found"))
9721 ;; switch back to reference buffer
9722 ;; needed when if called in a temporary buffer through
9723 ;; org-open-link-from-string
9724 (with-current-buffer (or reference-buffer (current-buffer))
9726 ;; Remove any trailing spaces in path
9728 (setq path (replace-match "" t t path)))
9729 (if (and org-link-translation-function
9730 (fboundp org-link-translation-function))
9731 ;; Check if we need to translate the link
9732 (let ((tmp (funcall org-link-translation-function type path)))
9733 (setq type (car tmp) path (cdr tmp))))
9735 (cond
9737 ((assoc type org-link-protocols)
9738 (funcall (nth 1 (assoc type org-link-protocols)) path))
9740 ((equal type "help")
9741 (let ((f-or-v (intern path)))
9742 (cond ((fboundp f-or-v)
9743 (describe-function f-or-v))
9744 ((boundp f-or-v)
9745 (describe-variable f-or-v))
9746 (t (error "Not a known function or variable")))))
9748 ((equal type "mailto")
9749 (let ((cmd (car org-link-mailto-program))
9750 (args (cdr org-link-mailto-program)) args1
9751 (address path) (subject "") a)
9753 (setq address (match-string 1 path)
9754 subject (org-link-escape (match-string 2 path))))
9755 (while args
9756 (cond
9757 ((not (stringp (car args))) (push (pop args) args1))
9758 (t (setq a (pop args))
9759 (if (string-match "%a" a)
9760 (setq a (replace-match address t t a)))
9761 (if (string-match "%s" a)
9762 (setq a (replace-match subject t t a)))
9763 (push a args1))))
9764 (apply cmd (nreverse args1))))
9766 ((member type '("http" "https" "ftp" "news"))
9767 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9768 (org-link-escape
9769 path org-link-escape-chars-browser)
9770 path))))
9772 ((string= type "doi")
9773 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
9774 (org-link-escape
9775 path org-link-escape-chars-browser)
9776 path))))
9778 ((member type '("message"))
9779 (browse-url (concat type ":" path)))
9781 ((string= type "tags")
9782 (org-tags-view arg path))
9784 ((string= type "tree-match")
9787 ((string= type "file")
9789 (setq line (string-to-number (match-string 1 path))
9790 path (substring path 0 (match-beginning 0)))
9792 (setq search (match-string 1 path)
9793 path (substring path 0 (match-beginning 0)))))
9794 (if (string-match "[*?{]" (file-name-nondirectory path))
9795 (dired path)
9796 (org-open-file path arg line search)))
9798 ((string= type "shell")
9799 (let ((buf (generate-new-buffer "*Org Shell Output"))
9800 (cmd path))
9801 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9802 (string-match org-confirm-shell-link-not-regexp cmd))
9803 (not org-confirm-shell-link-function)
9804 (funcall org-confirm-shell-link-function
9806 (org-add-props cmd nil
9807 'face 'org-warning))))
9808 (progn
9809 (message "Executing %s" cmd)
9810 (shell-command cmd buf)
9811 (if (featurep 'midnight)
9812 (setq clean-buffer-list-kill-buffer-names
9813 (cons buf clean-buffer-list-kill-buffer-names))))
9814 (error "Abort"))))
9816 ((string= type "elisp")
9817 (let ((cmd path))
9818 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9819 (string-match org-confirm-elisp-link-not-regexp cmd))
9820 (not org-confirm-elisp-link-function)
9821 (funcall org-confirm-elisp-link-function
9823 (org-add-props cmd nil
9824 'face 'org-warning))))
9825 (message "%s => %s" cmd
9826 (if (equal (string-to-char cmd) ?\()
9827 (eval (read cmd))
9828 (call-interactively (read cmd))))
9829 (error "Abort"))))
9831 ((and (string= type "thisfile")
9832 (run-hook-with-args-until-success
9833 'org-open-link-functions path)))
9835 ((string= type "thisfile")
9836 (if arg
9837 (switch-to-buffer-other-window
9838 (org-get-buffer-for-internal-link (current-buffer)))
9839 (org-mark-ring-push))
9840 (let ((cmd `(org-link-search
9841 ,path
9842 ,(cond ((equal arg '(4)) ''occur)
9843 ((equal arg '(16)) ''org-occur))
9844 ,pos)))
9845 (condition-case nil (let ((org-link-search-inhibit-query t))
9846 (eval cmd))
9847 (error (progn (widen) (eval cmd))))))
9849 (t (browse-url-at-point)))))))
9850 (move-marker org-open-link-marker nil)
9851 (run-hook-with-args 'org-follow-link-hook)))
9853 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
9854 "Offer links in the current entry and return the selected link.
9855 If there is only one link, return it.
9856 If NTH is an integer, return the NTH link found.
9857 If ZERO is a string, check also this string for a link, and if
9858 there is one, return it."
9859 (with-current-buffer buffer
9860 (save-excursion
9861 (save-restriction
9862 (widen)
9863 (goto-char marker)
9867 (cnt ?0)
9868 (in-emacs (if (integerp nth) nil nth))
9869 have-zero end links link c)
9870 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9871 (push (match-string 0 zero) links)
9872 (setq cnt (1- cnt) have-zero t))
9873 (save-excursion
9874 (org-back-to-heading t)
9875 (setq end (save-excursion (outline-next-heading) (point)))
9876 (while (re-search-forward re end t)
9877 (push (match-string 0) links))
9878 (setq links (org-uniquify (reverse links))))
9879 (cond
9880 ((null links)
9881 (message "No links"))
9882 ((equal (length links) 1)
9883 (setq link (car links)))
9884 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9885 (setq link (nth (if have-zero nth (1- nth)) links)))
9886 (t ; we have to select a link
9887 (save-excursion
9888 (save-window-excursion
9889 (delete-other-windows)
9890 (with-output-to-temp-buffer "*Select Link*"
9891 (mapc (lambda (l)
9892 (if (not (string-match org-bracket-link-regexp l))
9894 (org-remove-angle-brackets l)))
9895 (if (match-end 3)
9897 (match-string 3 l) (match-string 1 l)))
9899 (match-string 1 l))))))
9900 links))
9901 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9902 (message "Select link to open, RET to open all:")
9903 (setq c (read-char-exclusive))
9904 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9905 (when (equal c ?q) (error "Abort"))
9906 (if (equal c ?\C-m)
9907 (setq link links)
9908 (setq nth (- c ?0))
9909 (if have-zero (setq nth (1+ nth)))
9910 (unless (and (integerp nth) (>= (length links) nth))
9911 (error "Invalid link selection"))
9912 (setq link (nth (1- nth) links)))))
9913 (cons link end))))))
9915 ;; Add special file links that specify the way of opening
9917 (org-add-link-type "file+sys" 'org-open-file-with-system)
9918 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9919 (defun org-open-file-with-system (path)
9920 "Open file at PATH using the system way of opening it."
9921 (org-open-file path 'system))
9922 (defun org-open-file-with-emacs (path)
9923 "Open file at PATH in Emacs."
9924 (org-open-file path 'emacs))
9925 (defun org-remove-file-link-modifiers ()
9926 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9927 (goto-char (point-min))
9929 (org-if-unprotected
9930 (replace-match "file:" t t))))
9931 (eval-after-load "org-exp"
9932 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9933 'org-remove-file-link-modifiers))
9935 ;;;; Time estimates
9937 (defun org-get-effort (&optional pom)
9938 "Get the effort estimate for the current entry."
9939 (org-entry-get pom org-effort-property))
9941 ;;; File search
9943 (defvar org-create-file-search-functions nil
9944 "List of functions to construct the right search string for a file link.
9945 These functions are called in turn with point at the location to
9946 which the link should point.
9948 A function in the hook should first test if it would like to
9949 handle this file type, for example by checking the `major-mode'
9950 or the file extension. If it decides not to handle this file, it
9951 should just return nil to give other functions a chance. If it
9952 does handle the file, it must return the search string to be used
9953 when following the link. The search string will be part of the
9954 file link, given after a double colon, and `org-open-at-point'
9955 will automatically search for it. If special measures must be
9956 taken to make the search successful, another function should be
9957 added to the companion hook `org-execute-file-search-functions',
9958 which see.
9960 A function in this hook may also use `setq' to set the variable
9961 `description' to provide a suggestion for the descriptive text to
9962 be used for this link when it gets inserted into an Org-mode
9965 (defvar org-execute-file-search-functions nil
9966 "List of functions to execute a file search triggered by a link.
9968 Functions added to this hook must accept a single argument, the
9969 search string that was part of the file link, the part after the
9970 double colon. The function must first check if it would like to
9971 handle this search, for example by checking the `major-mode' or
9972 the file extension. If it decides not to handle this search, it
9973 should just return nil to give other functions a chance. If it
9974 does handle the search, it must return a non-nil value to keep
9975 other functions from trying.
9977 Each function can access the current prefix argument through the
9978 variable `current-prefix-argument'. Note that a single prefix is
9979 used to force opening a link in Emacs, so it may be good to only
9980 use a numeric or double prefix to guide the search function.
9982 In case this is needed, a function in this hook can also restore
9983 the window configuration before `org-open-at-point' was called using:
9985 (set-window-configuration org-window-config-before-follow-link)")
9987 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9988 (defun org-link-search (s &optional type avoid-pos stealth)
9989 "Search for a link search option.
9990 If S is surrounded by forward slashes, it is interpreted as a
9991 regular expression. In org-mode files, this will create an `org-occur'
9992 sparse tree. In ordinary files, `occur' will be used to list matches.
9993 If the current buffer is in `dired-mode', grep will be used to search
9994 in all files. If AVOID-POS is given, ignore matches near that position.
9996 When optional argument STEALTH is non-nil, do not modify
9997 visibility around point, thus ignoring
9998 `org-show-hierarchy-above', `org-show-following-heading' and
9999 `org-show-siblings' variables."
10000 (let ((case-fold-search t)
10004 org-emphasis-alist)
10006 (pos (point))
10007 (pre nil) (post nil)
10008 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10009 (cond
10010 ;; First check if there are any special search functions
10011 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10012 ;; Now try the builtin stuff
10013 ((and (equal (string-to-char s0) ?#)
10014 (> (length s0) 1)
10015 (save-excursion
10016 (goto-char (point-min))
10017 (and
10018 (re-search-forward
10020 (setq type 'dedicated
10021 pos (match-beginning 0))))
10022 ;; There is an exact target for this
10023 (goto-char pos)
10024 (org-back-to-heading t)))
10025 ((save-excursion
10026 (goto-char (point-min))
10027 (and
10028 (re-search-forward
10029 (concat "<<" (regexp-quote s0) ">>") nil t)
10030 (setq type 'dedicated
10031 pos (match-beginning 0))))
10032 ;; There is an exact target for this
10033 (goto-char pos))
10034 ((save-excursion
10035 (goto-char (point-min))
10036 (and
10037 (re-search-forward
10039 (setq type 'dedicated pos (match-beginning 0))))
10040 ;; Found an invisible target.
10041 (goto-char pos))
10042 ((save-excursion
10043 (goto-char (point-min))
10044 (and
10045 (re-search-forward
10047 (setq type 'dedicated pos (match-beginning 0))))
10048 ;; Found an element with a matching #+name affiliated keyword.
10049 (goto-char pos))
10051 (save-excursion
10052 (goto-char (point-min))
10053 (and
10054 (re-search-forward
10055 (concat "[^[]" (regexp-quote
10056 (format org-coderef-label-format
10057 (match-string 1 s0))))
10058 nil t)
10059 (setq type 'dedicated
10060 pos (1+ (match-beginning 0))))))
10061 ;; There is a coderef target for this
10062 (goto-char pos))
10064 ;; A regular expression
10065 (cond
10066 ((derived-mode-p 'org-mode)
10067 (org-occur (match-string 1 s)))
10068 ;;((eq major-mode 'dired-mode)
10069 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
10070 (t (org-do-occur (match-string 1 s)))))
10071 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10072 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10073 (goto-char (point-min))
10074 (cond
10075 ((let (case-fold-search)
10076 (re-search-forward (format org-complex-heading-regexp-format
10077 (regexp-quote s))
10078 nil t))
10079 ;; OK, found a match
10080 (setq type 'dedicated)
10081 (goto-char (match-beginning 0)))
10082 ((and (not org-link-search-inhibit-query)
10083 (eq org-link-search-must-match-exact-headline 'query-to-create)
10084 (y-or-n-p "No match - create this as a new heading? "))
10085 (goto-char (point-max))
10086 (or (bolp) (newline))
10088 (beginning-of-line 0))
10089 (t
10090 (goto-char pos)
10091 (error "No match"))))
10092 (t
10093 ;; A normal search string
10094 (when (equal (string-to-char s) ?*)
10095 ;; Anchor on headlines, post may include tags.
10098 s (substring s 1)))
10099 (remove-text-properties
10100 0 (length s)
10101 '(face nil mouse-face nil keymap nil fontified nil) s)
10102 ;; Make a series of regular expressions to find a match
10111 re4 (concat "[^a-zA-Z_]" re4_)
10113 re1 (concat pre re2 post)
10114 re3 (concat pre (if pre re4_ re4) post)
10115 re5 (concat pre ".*" re4)
10116 re2 (concat pre re2)
10117 re2a (concat pre (if pre re2a_ re2a))
10118 re4 (concat pre (if pre re4_ re4))
10122 ))
10123 (cond
10124 ((eq type 'org-occur) (org-occur reall))
10125 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10126 (t (goto-char (point-min))
10127 (setq type 'fuzzy)
10128 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10129 (org-search-not-self 1 re1 nil t)
10130 (org-search-not-self 1 re2 nil t)
10131 (org-search-not-self 1 re2a nil t)
10132 (org-search-not-self 1 re3 nil t)
10133 (org-search-not-self 1 re4 nil t)
10134 (org-search-not-self 1 re5 nil t)
10135 )
10136 (goto-char (match-beginning 1))
10137 (goto-char pos)
10138 (error "No match"))))))
10139 (and (derived-mode-p 'org-mode)
10140 (not stealth)
10141 (org-show-context 'link-search))
10142 type))
10144 (defun org-search-not-self (group &rest args)
10145 "Execute `re-search-forward', but only accept matches that do not
10146 enclose the position of `org-open-link-marker'."
10147 (let ((m org-open-link-marker))
10148 (catch 'exit
10149 (while (apply 're-search-forward args)
10150 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10151 (goto-char (match-end group))
10152 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10153 (> (match-beginning 0) (marker-position m))
10154 (< (match-end 0) (marker-position m)))
10155 (save-match-data
10156 (or (not (org-in-regexp
10157 org-bracket-link-analytic-regexp 1))
10158 (not (match-end 4)) ; no description
10159 (and (<= (match-beginning 4) (point))
10160 (>= (match-end 4) (point))))))
10161 (throw 'exit (point))))))))
10163 (defun org-get-buffer-for-internal-link (buffer)
10164 "Return a buffer to be used for displaying the link target of internal links."
10165 (cond
10166 ((not org-display-internal-link-with-indirect-buffer)
10167 buffer)
10168 ((string-match "(Clone)$" (buffer-name buffer))
10169 (message "Buffer is already a clone, not making another one")
10170 ;; we also do not modify visibility in this case
10171 buffer)
10172 (t ; make a new indirect buffer for displaying the link
10173 (let* ((bn (buffer-name buffer))
10174 (ibn (concat bn "(Clone)"))
10175 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10176 (with-current-buffer ib (org-overview))
10177 ib))))
10179 (defun org-do-occur (regexp &optional cleanup)
10180 "Call the Emacs command `occur'.
10181 If CLEANUP is non-nil, remove the printout of the regular expression
10182 in the *Occur* buffer. This is useful if the regex is long and not useful
10183 to read."
10184 (occur regexp)
10185 (when cleanup
10186 (let ((cwin (selected-window)) win beg end)
10187 (when (setq win (get-buffer-window "*Occur*"))
10188 (select-window win))
10189 (goto-char (point-min))
10190 (when (re-search-forward "match[a-z]+" nil t)
10191 (setq beg (match-end 0))
10193 (setq end (1- (match-beginning 0)))))
10194 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10195 (goto-char (point-min))
10196 (select-window cwin))))
10198 ;;; The mark ring for links jumps
10200 (defvar org-mark-ring nil
10201 "Mark ring for positions before jumps in Org-mode.")
10202 (defvar org-mark-ring-last-goto nil
10203 "Last position in the mark ring used to go back.")
10204 ;; Fill and close the ring
10205 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10206 (loop for i from 1 to org-mark-ring-length do
10207 (push (make-marker) org-mark-ring))
10208 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10209 org-mark-ring)
10211 (defun org-mark-ring-push (&optional pos buffer)
10212 "Put the current position or POS into the mark ring and rotate it."
10213 (interactive)
10214 (setq pos (or pos (point)))
10215 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10216 (move-marker (car org-mark-ring)
10217 (or pos (point))
10218 (or buffer (current-buffer)))
10219 (message "%s"
10220 (substitute-command-keys
10223 (defun org-mark-ring-goto (&optional n)
10224 "Jump to the previous position in the mark ring.
10225 With prefix arg N, jump back that many stored positions. When
10226 called several times in succession, walk through the entire ring.
10227 Org-mode commands jumping to a different position in the current file,
10228 or to another Org-mode file, automatically push the old position
10229 onto the ring."
10230 (interactive "p")
10231 (let (p m)
10232 (if (eq last-command this-command)
10233 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10234 (setq p org-mark-ring))
10235 (setq org-mark-ring-last-goto p)
10236 (setq m (car p))
10237 (org-pop-to-buffer-same-window (marker-buffer m))
10238 (goto-char m)
10239 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10241 (defun org-remove-angle-brackets (s)
10242 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10243 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10244 s)
10245 (defun org-add-angle-brackets (s)
10246 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10247 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10248 s)
10249 (defun org-remove-double-quotes (s)
10252 s)
10254 ;;; Following specific links
10256 (defun org-follow-timestamp-link ()
10257 "Open an agenda view for the time-stamp date/range at point."
10258 (cond
10259 ((org-at-date-range-p t)
10260 (let ((org-agenda-start-on-weekday)
10261 (t1 (match-string 1))
10262 (t2 (match-string 2)) tt1 tt2)
10263 (setq tt1 (time-to-days (org-time-string-to-time t1))
10264 tt2 (time-to-days (org-time-string-to-time t2)))
10265 (let ((org-agenda-buffer-tmp-name
10266 (format "*Org Agenda(a:%s)"
10267 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10268 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10269 ((org-at-timestamp-p t)
10270 (let ((org-agenda-buffer-tmp-name
10271 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10272 (org-agenda-list nil (time-to-days (org-time-string-to-time
10273 (substring (match-string 1) 0 10)))
10274 1)))
10275 (t (error "This should not happen"))))
10278 ;;; Following file links
10279 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10280 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10281 (declare-function mailcap-mime-info
10282 "mailcap" (string &optional request no-decode))
10283 (defvar org-wait nil)
10284 (defun org-open-file (path &optional in-emacs line search)
10285 "Open the file at PATH.
10286 First, this expands any special file name abbreviations. Then the
10287 configuration variable `org-file-apps' is checked if it contains an
10288 entry for this file type, and if yes, the corresponding command is launched.
10290 If no application is found, Emacs simply visits the file.
10292 With optional prefix argument IN-EMACS, Emacs will visit the file.
10294 prefix arg, Org tries to avoid opening in Emacs
10295 and to use an external application to visit the file.
10297 Optional LINE specifies a line to go to, optional SEARCH a string
10298 to search for. If LINE or SEARCH is given, the file will be
10299 opened in Emacs, unless an entry from org-file-apps that makes
10300 use of groups in a regexp matches.
10302 If you want to change the way frames are used when following a
10303 link, please customize `org-link-frame-setup'.
10305 If the file does not exist, an error is thrown."
10306 (let* ((file (if (equal path "")
10307 buffer-file-name
10308 (substitute-in-file-name (expand-file-name path))))
10309 (file-apps (append org-file-apps (org-default-apps)))
10310 (apps (org-remove-if
10311 'org-file-apps-entry-match-against-dlink-p file-apps))
10312 (apps-dlink (org-remove-if-not
10313 'org-file-apps-entry-match-against-dlink-p file-apps))
10314 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10315 (dirp (if remp nil (file-directory-p file)))
10316 (file (if (and dirp org-open-directory-means-index-dot-org)
10317 (concat (file-name-as-directory file) "index.org")
10318 file))
10319 (a-m-a-p (assq 'auto-mode apps))
10320 (dfile (downcase file))
10321 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10322 (link (cond ((and (eq line nil)
10323 (eq search nil))
10324 file)
10325 (line
10326 (concat file "::" (number-to-string line)))
10327 (search
10328 (concat file "::" search))))
10329 (dlink (downcase link))
10330 (old-buffer (current-buffer))
10331 (old-pos (point))
10332 (old-mode major-mode)
10333 ext cmd link-match-data)
10335 (setq ext (match-string 1 dfile))
10337 (setq ext (match-string 1 dfile))))
10338 (cond
10339 ((member in-emacs '((16) system))
10340 (setq cmd (cdr (assoc 'system apps))))
10341 (in-emacs (setq cmd 'emacs))
10342 (t
10343 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10344 (and dirp (cdr (assoc 'directory apps)))
10345 ; first, try matching against apps-dlink
10346 ; if we get a match here, store the match data for later
10347 (let ((match (assoc-default dlink apps-dlink
10348 'string-match)))
10349 (if match
10350 (progn (setq link-match-data (match-data))
10351 match)
10352 (progn (setq in-emacs (or in-emacs line search))
10353 nil))) ; if we have no match in apps-dlink,
10354 ; always open the file in emacs if line or search
10355 ; is given (for backwards compatibility)
10356 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10357 'string-match)
10358 (cdr (assoc ext apps))
10359 (cdr (assoc t apps))))))
10360 (when (eq cmd 'system)
10361 (setq cmd (cdr (assoc 'system apps))))
10362 (when (eq cmd 'default)
10363 (setq cmd (cdr (assoc t apps))))
10364 (when (eq cmd 'mailcap)
10365 (require 'mailcap)
10366 (mailcap-parse-mailcaps)
10367 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10368 (command (mailcap-mime-info mime-type)))
10369 (if (stringp command)
10370 (setq cmd command)
10371 (setq cmd 'emacs))))
10372 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10373 (not (file-exists-p file))
10374 (not org-open-non-existing-files))
10375 (error "No such file: %s" file))
10376 (cond
10378 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10380 (setq cmd (replace-match "%s" t t cmd)))
10381 (while (string-match "%s" cmd)
10382 (setq cmd (replace-match
10383 (save-match-data
10384 (shell-quote-argument
10385 (convert-standard-filename file)))
10386 t t cmd)))
10388 ;; Replace "%1", "%2" etc. in command with group matches from regex
10389 (save-match-data
10390 (let ((match-index 1)
10391 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10392 (set-match-data link-match-data)
10393 (while (<= match-index number-of-groups)
10394 (let ((regex (concat "%" (number-to-string match-index)))
10395 (replace-with (match-string match-index dlink)))
10396 (while (string-match regex cmd)
10397 (setq cmd (replace-match replace-with t t cmd))))
10398 (setq match-index (+ match-index 1)))))
10400 (save-window-excursion
10401 (start-process-shell-command cmd nil cmd)
10402 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10403 ))
10404 ((or (stringp cmd)
10405 (eq cmd 'emacs))
10406 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10407 (widen)
10408 (if line (org-goto-line line)
10409 (if search (org-link-search search))))
10410 ((consp cmd)
10411 (let ((file (convert-standard-filename file)))
10412 (save-match-data
10413 (set-match-data link-match-data)
10414 (eval cmd))))
10415 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10416 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10417 (or (not (equal old-buffer (current-buffer)))
10418 (not (equal old-pos (point))))
10419 (org-mark-ring-push old-pos old-buffer))))
10421 (defun org-file-apps-entry-match-against-dlink-p (entry)
10422 "This function returns non-nil if `entry' uses a regular
10423 expression which should be matched against the whole link by
10424 org-open-file.
10426 It assumes that is the case when the entry uses a regular
10427 expression which has at least one grouping construct and the
10428 action is either a lisp form or a command string containing
10429 '%1', i.e. using at least one subexpression match as a
10430 parameter."
10431 (let ((selector (car entry))
10432 (action (cdr entry)))
10433 (if (stringp selector)
10434 (and (> (regexp-opt-depth selector) 0)
10435 (or (and (stringp action)
10436 (string-match "%[0-9]" action))
10437 (consp action)))
10438 nil)))
10440 (defun org-default-apps ()
10441 "Return the default applications for this operating system."
10442 (cond
10443 ((eq system-type 'darwin)
10444 org-file-apps-defaults-macosx)
10445 ((eq system-type 'windows-nt)
10446 org-file-apps-defaults-windowsnt)
10447 (t org-file-apps-defaults-gnu)))
10449 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10450 "Convert extensions to regular expressions in the cars of LIST.
10451 Also, weed out any non-string entries, because the return value is used
10452 only for regexp matching.
10453 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10454 point to the symbol `emacs', indicating that the file should
10455 be opened in Emacs."
10456 (append
10457 (delq nil
10458 (mapcar (lambda (x)
10459 (if (not (stringp (car x)))
10460 nil
10462 x
10464 list))
10465 (if add-auto-mode
10466 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10468 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10469 (defun org-file-remote-p (file)
10470 "Test whether FILE specifies a location on a remote system.
10471 Return non-nil if the location is indeed remote.
10475 (cond ((fboundp 'file-remote-p)
10476 (file-remote-p file))
10477 ((fboundp 'tramp-handle-file-remote-p)
10478 (tramp-handle-file-remote-p file))
10479 ((and (boundp 'ange-ftp-name-format)
10480 (string-match (car ange-ftp-name-format) file))
10481 t)))
10484 ;;;; Refiling
10486 (defun org-get-org-file ()
10487 "Read a filename, with default directory `org-directory'."
10488 (let ((default (or org-default-notes-file remember-data-file)))
10489 (read-file-name (format "File name [%s]: " default)
10490 (file-name-as-directory org-directory)
10491 default)))
10493 (defun org-notes-order-reversed-p ()
10494 "Check if the current file should receive notes in reversed order."
10495 (cond
10496 ((not org-reverse-note-order) nil)
10497 ((eq t org-reverse-note-order) t)
10498 ((not (listp org-reverse-note-order)) nil)
10499 (t (catch 'exit
10500 (let ((all org-reverse-note-order)
10501 entry)
10502 (while (setq entry (pop all))
10503 (if (string-match (car entry) buffer-file-name)
10504 (throw 'exit (cdr entry))))
10505 nil)))))
10507 (defvar org-refile-target-table nil
10508 "The list of refile targets, created by `org-refile'.")
10510 (defvar org-agenda-new-buffers nil
10511 "Buffers created to visit agenda files.")
10513 (defvar org-refile-cache nil
10514 "Cache for refile targets.")
10516 (defvar org-refile-markers nil
10517 "All the markers used for caching refile locations.")
10519 (defun org-refile-marker (pos)
10520 "Get a new refile marker, but only if caching is in use."
10521 (if (not org-refile-use-cache)
10522 pos
10523 (let ((m (make-marker)))
10524 (move-marker m pos)
10525 (push m org-refile-markers)
10526 m)))
10528 (defun org-refile-cache-clear ()
10529 "Clear the refile cache and disable all the markers."
10530 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10531 (setq org-refile-markers nil)
10532 (setq org-refile-cache nil)
10533 (message "Refile cache has been cleared"))
10535 (defun org-refile-cache-check-set (set)
10536 "Check if all the markers in the cache still have live buffers."
10537 (let (marker)
10538 (catch 'exit
10539 (while (and set (setq marker (nth 3 (pop set))))
10540 ;; if org-refile-use-outline-path is 'file, marker may be nil
10541 (when (and marker (null (marker-buffer marker)))
10542 (message "not found") (sit-for 3)
10543 (throw 'exit nil)))
10544 t)))
10546 (defun org-refile-cache-put (set &rest identifiers)
10547 "Push the refile targets SET into the cache, under IDENTIFIERS."
10548 (let* ((key (sha1 (prin1-to-string identifiers)))
10549 (entry (assoc key org-refile-cache)))
10550 (if entry
10551 (setcdr entry set)
10552 (push (cons key set) org-refile-cache))))
10554 (defun org-refile-cache-get (&rest identifiers)
10555 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10556 (cond
10557 ((not org-refile-cache) nil)
10558 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10559 (t
10560 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10561 org-refile-cache))))
10562 (and set (org-refile-cache-check-set set) set)))))
10564 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10565 "Produce a table with refile targets."
10566 (let ((case-fold-search nil)
10567 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10568 (entries (or org-refile-targets '((nil . (:level . 1)))))
10569 targets tgs txt re files f desc descre fast-path-p level pos0)
10570 (message "Getting targets...")
10571 (with-current-buffer (or default-buffer (current-buffer))
10572 (while (setq entry (pop entries))
10573 (setq files (car entry) desc (cdr entry))
10574 (setq fast-path-p nil)
10575 (cond
10576 ((null files) (setq files (list (current-buffer))))
10577 ((eq files 'org-agenda-files)
10578 (setq files (org-agenda-files 'unrestricted)))
10579 ((and (symbolp files) (fboundp files))
10580 (setq files (funcall files)))
10581 ((and (symbolp files) (boundp files))
10582 (setq files (symbol-value files))))
10583 (if (stringp files) (setq files (list files)))
10584 (cond
10585 ((eq (car desc) :tag)
10587 ((eq (car desc) :todo)
10589 ((eq (car desc) :regexp)
10590 (setq descre (cdr desc)))
10591 ((eq (car desc) :level)
10593 (if org-odd-levels-only
10594 (1- (* 2 (cdr desc)))
10595 (cdr desc)))
10597 ((eq (car desc) :maxlevel)
10598 (setq fast-path-p t)
10600 (if org-odd-levels-only
10601 (1- (* 2 (cdr desc)))
10602 (cdr desc)))
10604 (t (error "Bad refiling target description %s" desc)))
10605 (while (setq f (pop files))
10606 (with-current-buffer
10607 (if (bufferp f) f (org-get-agenda-file-buffer f))
10608 (or
10609 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10610 (progn
10611 (if (bufferp f) (setq f (buffer-file-name
10612 (buffer-base-buffer f))))
10613 (setq f (and f (expand-file-name f)))
10614 (if (eq org-refile-use-outline-path 'file)
10615 (push (list (file-name-nondirectory f) f nil nil) tgs))
10616 (save-excursion
10617 (save-restriction
10618 (widen)
10619 (goto-char (point-min))
10620 (while (re-search-forward descre nil t)
10621 (goto-char (setq pos0 (point-at-bol)))
10622 (catch 'next
10623 (when org-refile-target-verify-function
10624 (save-match-data
10625 (or (funcall org-refile-target-verify-function)
10626 (throw 'next t))))
10627 (when (and (looking-at org-complex-heading-regexp)
10628 (not (member (match-string 4) excluded-entries))
10629 (match-string 4))
10630 (setq level (org-reduced-level
10631 (- (match-end 1) (match-beginning 1)))
10632 txt (org-link-display-format (match-string 4))
10634 re (format org-complex-heading-regexp-format
10635 (regexp-quote (match-string 4))))
10636 (when org-refile-use-outline-path
10637 (setq txt (mapconcat
10638 'org-protect-slash
10639 (append
10640 (if (eq org-refile-use-outline-path
10641 'file)
10642 (list (file-name-nondirectory
10643 (buffer-file-name
10644 (buffer-base-buffer))))
10645 (if (eq org-refile-use-outline-path
10646 'full-file-path)
10647 (list (buffer-file-name
10648 (buffer-base-buffer)))))
10649 (org-get-outline-path fast-path-p
10650 level txt)
10651 (list txt))
10652 "/")))
10653 (push (list txt f re (org-refile-marker (point)))
10654 tgs)))
10655 (when (= (point) pos0)
10656 ;; verification function has not moved point
10657 (goto-char (point-at-eol))))))))
10658 (when org-refile-use-cache
10659 (org-refile-cache-put tgs (buffer-file-name) descre))
10660 (setq targets (append tgs targets))
10661 ))))
10662 (message "Getting targets...done")
10663 (nreverse targets)))
10665 (defun org-protect-slash (s)
10666 (while (string-match "/" s)
10668 s)
10670 (defvar org-olpa (make-vector 20 nil))
10672 (defun org-get-outline-path (&optional fastp level heading)
10673 "Return the outline path to the current entry, as a list.
10675 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10676 routine which makes outline path derivations for an entire file,
10677 avoiding backtracing. Refile target collection makes use of that."
10678 (if fastp
10679 (progn
10680 (if (> level 19)
10681 (error "Outline path failure, more than 19 levels"))
10682 (loop for i from level upto 19 do
10683 (aset org-olpa i nil))
10684 (prog1
10685 (delq nil (append org-olpa nil))
10686 (aset org-olpa level heading)))
10687 (let (rtn case-fold-search)
10688 (save-excursion
10689 (save-restriction
10690 (widen)
10691 (while (org-up-heading-safe)
10692 (when (looking-at org-complex-heading-regexp)
10693 (push (org-match-string-no-properties 4) rtn)))
10694 rtn)))))
10696 (defun org-format-outline-path (path &optional width prefix)
10697 "Format the outline path PATH for display.
10698 Width is the maximum number of characters that is available.
10699 Prefix is a prefix to be included in the returned string,
10700 such as the file name."
10701 (setq width (or width 79))
10702 (if prefix (setq width (- width (length prefix))))
10703 (if (not path)
10704 (or prefix "")
10705 (let* ((nsteps (length path))
10706 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10707 (maxwidth (if (<= total-width width)
10708 10000 ;; everything fits
10709 ;; we need to shorten the level headings
10710 (/ (- width nsteps) nsteps)))
10711 (org-odd-levels-only nil)
10712 (n 0)
10713 (total (1+ (length prefix))))
10714 (setq maxwidth (max maxwidth 10))
10715 (concat prefix
10716 (mapconcat
10717 (lambda (h)
10718 (setq n (1+ n))
10719 (if (and (= n nsteps) (< maxwidth 10000))
10720 (setq maxwidth (- total-width total)))
10721 (if (< (length h) maxwidth)
10722 (progn (setq total (+ total (length h) 1)) h)
10723 (setq h (substring h 0 (- maxwidth 2))
10724 total (+ total maxwidth 1))
10726 (setq h (substring h 0 (match-beginning 0))))
10727 (setq h (concat h "..")))
10728 (org-add-props h nil 'face
10729 (nth (% (1- n) org-n-level-faces)
10730 org-level-faces))
10731 h)
10732 path "/")))))
10734 (defun org-display-outline-path (&optional file current)
10735 "Display the current outline path in the echo area."
10736 (interactive "P")
10737 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10738 (case-fold-search nil)
10739 (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
10740 (if current (setq path (append path
10741 (save-excursion
10742 (org-back-to-heading t)
10743 (if (looking-at org-complex-heading-regexp)
10744 (list (match-string 4)))))))
10745 (message "%s"
10746 (org-format-outline-path
10747 path
10748 (1- (frame-width))
10749 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10751 (defvar org-refile-history nil
10752 "History for refiling operations.")
10754 (defvar org-after-refile-insert-hook nil
10755 "Hook run after `org-refile' has inserted its stuff at the new location.
10756 Note that this is still *before* the stuff will be removed from
10757 the *old* location.")
10759 (defvar org-capture-last-stored-marker)
10760 (defun org-refile (&optional goto default-buffer rfloc)
10761 "Move the entry or entries at point to another heading.
10762 The list of target headings is compiled using the information in
10763 `org-refile-targets', which see.
10765 At the target location, the entry is filed as a subitem of the target
10766 heading. Depending on `org-reverse-note-order', the new subitem will
10767 either be the first or the last subitem.
10769 If there is an active region, all entries in that region will be moved.
10770 However, the region must fulfill the requirement that the first heading
10771 is the first one sets the top-level of the moved text - at most siblings
10772 below it are allowed.
10774 With prefix arg GOTO, the command will only visit the target location
10775 and not actually move anything.
10778 go to the location where the last refiling operation has put the subtree.
10779 With a prefix argument of `2', refile to the running clock.
10781 RFLOC can be a refile location obtained in a different way.
10783 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10785 If you are using target caching (see `org-refile-use-cache'),
10786 you have to clear the target cache in order to find new targets.
10787 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10788 prefix argument (`C-u C-u C-u C-c C-w')."
10790 (interactive "P")
10791 (if (member goto '(0 (64)))
10792 (org-refile-cache-clear)
10793 (let* ((cbuf (current-buffer))
10794 (regionp (org-region-active-p))
10795 (region-start (and regionp (region-beginning)))
10796 (region-end (and regionp (region-end)))
10797 (region-length (and regionp (- region-end region-start)))
10798 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10799 pos it nbuf file re level reversed)
10800 (setq last-command nil)
10801 (when regionp
10802 (goto-char region-start)
10803 (or (bolp) (goto-char (point-at-bol)))
10804 (setq region-start (point))
10805 (unless (or (org-kill-is-subtree-p
10806 (buffer-substring region-start region-end))
10807 (prog1 org-refile-active-region-within-subtree
10808 (org-toggle-heading)))
10809 (error "The region is not a (sequence of) subtree(s)")))
10810 (if (equal goto '(16))
10811 (org-refile-goto-last-stored)
10812 (when (or
10813 (and (equal goto 2)
10814 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10815 (prog1
10816 (setq it (list (or org-clock-heading "running clock")
10817 (buffer-file-name
10818 (marker-buffer org-clock-hd-marker))
10819 ""
10820 (marker-position org-clock-hd-marker)))
10821 (setq goto nil)))
10822 (setq it (or rfloc
10823 (let (heading-text)
10824 (save-excursion
10825 (unless goto
10826 (org-back-to-heading t)
10827 (setq heading-text
10828 (nth 4 (org-heading-components))))
10829 (org-refile-get-location
10830 (cond (goto "Goto")
10831 (regionp "Refile region to")
10834 default-buffer
10835 (and (not (equal '(4) goto))
10836 org-refile-allow-creating-parent-nodes)
10837 goto))))))
10838 (setq file (nth 1 it)
10839 re (nth 2 it)
10840 pos (nth 3 it))
10841 (if (and (not goto)
10842 pos
10843 (equal (buffer-file-name) file)
10844 (if regionp
10845 (and (>= pos region-start)
10846 (<= pos region-end))
10847 (and (>= pos (point))
10848 (< pos (save-excursion
10849 (org-end-of-subtree t t))))))
10850 (error "Cannot refile to position inside the tree or region"))
10852 (setq nbuf (or (find-buffer-visiting file)
10853 (find-file-noselect file)))
10854 (if goto
10855 (progn
10856 (org-pop-to-buffer-same-window nbuf)
10857 (goto-char pos)
10858 (org-show-context 'org-goto))
10859 (if regionp
10860 (progn
10861 (org-kill-new (buffer-substring region-start region-end))
10862 (org-save-markers-in-region region-start region-end))
10863 (org-copy-subtree 1 nil t))
10864 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10865 (find-file-noselect file)))
10866 (setq reversed (org-notes-order-reversed-p))
10867 (save-excursion
10868 (save-restriction
10869 (widen)
10870 (if pos
10871 (progn
10872 (goto-char pos)
10873 (looking-at org-outline-regexp)
10874 (setq level (org-get-valid-level (funcall outline-level) 1))
10875 (goto-char
10876 (if reversed
10877 (or (outline-next-heading) (point-max))
10878 (or (save-excursion (org-get-next-sibling))
10879 (org-end-of-subtree t t)
10880 (point-max)))))
10881 (setq level 1)
10882 (if (not reversed)
10883 (goto-char (point-max))
10884 (goto-char (point-min))
10885 (or (outline-next-heading) (goto-char (point-max)))))
10886 (if (not (bolp)) (newline))
10887 (org-paste-subtree level)
10888 (when org-log-refile
10889 (org-add-log-setup 'refile nil nil 'findpos
10890 org-log-refile)
10891 (unless (eq org-log-refile 'note)
10892 (save-excursion (org-add-log-note))))
10893 (and org-auto-align-tags
10894 (let ((org-loop-over-headlines-in-active-region nil))
10895 (org-set-tags nil t)))
10896 (with-demoted-errors
10897 (bookmark-set "org-refile-last-stored"))
10898 ;; If we are refiling for capture, make sure that the
10899 ;; last-capture pointers point here
10900 (when (org-bound-and-true-p org-refile-for-capture)
10901 (with-demoted-errors
10902 (bookmark-set "org-capture-last-stored-marker"))
10903 (move-marker org-capture-last-stored-marker (point)))
10904 (if (fboundp 'deactivate-mark) (deactivate-mark))
10905 (run-hooks 'org-after-refile-insert-hook))))
10906 (if regionp
10907 (delete-region (point) (+ (point) region-length))
10908 (org-cut-subtree))
10909 (when (featurep 'org-inlinetask)
10910 (org-inlinetask-remove-END-maybe))
10911 (setq org-markers-to-move nil)
10914 (defun org-refile-goto-last-stored ()
10915 "Go to the location where the last refile was stored."
10916 (interactive)
10917 (bookmark-jump "org-refile-last-stored")
10918 (message "This is the location of the last refile"))
10920 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10921 no-exclude)
10922 "Prompt the user for a refile location, using PROMPT.
10923 PROMPT should not be suffixed with a colon and a space, because
10924 this function appends the default value from
10925 `org-refile-history' automatically, if that is not empty.
10926 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10927 this is used for the GOTO interface."
10928 (let ((org-refile-targets org-refile-targets)
10929 (org-refile-use-outline-path org-refile-use-outline-path)
10930 excluded-entries)
10931 (when (and (derived-mode-p 'org-mode)
10932 (not org-refile-use-cache)
10933 (not no-exclude))
10934 (org-map-tree
10935 (lambda()
10936 (setq excluded-entries
10937 (append excluded-entries (list (org-get-heading t t)))))))
10938 (setq org-refile-target-table
10939 (org-refile-get-targets default-buffer excluded-entries)))
10940 (unless org-refile-target-table
10941 (error "No refile targets"))
10942 (let* ((prompt (concat prompt
10943 (and (car org-refile-history)
10944 (concat " (default " (car org-refile-history) ")"))
10945 ": "))
10946 (cbuf (current-buffer))
10947 (partial-completion-mode nil)
10948 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10949 (cfunc (if (and org-refile-use-outline-path
10950 org-outline-path-complete-in-steps)
10951 'org-olpath-completing-read
10952 'org-icompleting-read))
10953 (extra (if org-refile-use-outline-path "/" ""))
10954 (filename (and cfn (expand-file-name cfn)))
10955 (tbl (mapcar
10956 (lambda (x)
10957 (if (and (not (member org-refile-use-outline-path
10958 '(file full-file-path)))
10959 (not (equal filename (nth 1 x))))
10960 (cons (concat (car x) extra " ("
10961 (file-name-nondirectory (nth 1 x)) ")")
10962 (cdr x))
10963 (cons (concat (car x) extra) (cdr x))))
10964 org-refile-target-table))
10965 (completion-ignore-case t)
10966 pa answ parent-target child parent old-hist)
10967 (setq old-hist org-refile-history)
10968 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10969 nil 'org-refile-history (car org-refile-history)))
10970 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10971 (org-refile-check-position pa)
10972 (if pa
10973 (progn
10974 (when (or (not org-refile-history)
10975 (not (eq old-hist org-refile-history))
10976 (not (equal (car pa) (car org-refile-history))))
10977 (setq org-refile-history
10978 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10979 org-refile-history
10980 (cdr org-refile-history))))
10981 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10982 (pop org-refile-history)))
10983 pa)
10985 (progn
10986 (setq parent (match-string 1 answ)
10987 child (match-string 2 answ))
10988 (setq parent-target (or (assoc parent tbl)
10989 (assoc (concat parent "/") tbl)))
10990 (when (and parent-target
10991 (or (eq new-nodes t)
10992 (and (eq new-nodes 'confirm)
10994 child)))))
10995 (org-refile-new-child parent-target child)))
10996 (error "Invalid target location")))))
10998 (declare-function org-string-nw-p "org-macs" (s))
10999 (defun org-refile-check-position (refile-pointer)
11000 "Check if the refile pointer matches the headline to which it points."
11001 (let* ((file (nth 1 refile-pointer))
11002 (re (nth 2 refile-pointer))
11003 (pos (nth 3 refile-pointer))
11004 buffer)
11005 (if (and (not (markerp pos)) (not file))
11006 (error "Please save the buffer to a file before refiling")
11007 (when (org-string-nw-p re)
11008 (setq buffer (if (markerp pos)
11009 (marker-buffer pos)
11010 (or (find-buffer-visiting file)
11011 (find-file-noselect file))))
11012 (with-current-buffer buffer
11013 (save-excursion
11014 (save-restriction
11015 (widen)
11016 (goto-char pos)
11017 (beginning-of-line 1)
11018 (unless (org-looking-at-p re)
11019 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11021 (defun org-refile-new-child (parent-target child)
11022 "Use refile target PARENT-TARGET to add new CHILD below it."
11023 (unless parent-target
11024 (error "Cannot find parent for new node"))
11025 (let ((file (nth 1 parent-target))
11026 (pos (nth 3 parent-target))
11027 level)
11028 (with-current-buffer (or (find-buffer-visiting file)
11029 (find-file-noselect file))
11030 (save-excursion
11031 (save-restriction
11032 (widen)
11033 (if pos
11034 (goto-char pos)
11035 (goto-char (point-max))
11036 (if (not (bolp)) (newline)))
11037 (when (looking-at org-outline-regexp)
11038 (setq level (funcall outline-level))
11039 (org-end-of-subtree t t))
11040 (org-back-over-empty-lines)
11042 (if pos (org-get-valid-level level 1) 1) ?*)
11044 (beginning-of-line 0)
11045 (list (concat (car parent-target) "/" child) file "" (point)))))))
11047 (defun org-olpath-completing-read (prompt collection &rest args)
11048 "Read an outline path like a file name."
11049 (let ((thetable collection)
11050 (org-completion-use-ido nil) ; does not work with ido.
11051 (org-completion-use-iswitchb nil)) ; or iswitchb
11052 (apply
11053 'org-icompleting-read prompt
11054 (lambda (string predicate &optional flag)
11055 (let (rtn r f (l (length string)))
11056 (cond
11057 ((eq flag nil)
11058 ;; try completion
11059 (try-completion string thetable))
11060 ((eq flag t)
11061 ;; all-completions
11062 (setq rtn (all-completions string thetable predicate))
11063 (mapcar
11064 (lambda (x)
11065 (setq r (substring x l))
11066 (if (string-match " ([^)]*)$" x)
11067 (setq f (match-string 0 x))
11068 (setq f ""))
11069 (if (string-match "/" r)
11070 (concat string (substring r 0 (match-end 0)) f)
11071 x))
11072 rtn))
11073 ((eq flag 'lambda)
11074 ;; exact match?
11075 (assoc string thetable)))))
11076 args)))
11078 ;;;; Dynamic blocks
11080 (defun org-find-dblock (name)
11081 "Find the first dynamic block with name NAME in the buffer.
11082 If not found, stay at current position and return nil."
11083 (let ((case-fold-search t) pos)
11084 (save-excursion
11085 (goto-char (point-min))
11086 (setq pos (and (re-search-forward
11088 (match-beginning 0))))
11089 (if pos (goto-char pos))
11090 pos))
11092 (defconst org-dblock-start-re
11094 "Matches the start line of a dynamic block, with parameters.")
11097 "Matches the end of a dynamic block.")
11099 (defun org-create-dblock (plist)
11100 "Create a dynamic block section, with parameters taken from PLIST.
11101 PLIST must contain a :name entry which is used as name of the block."
11103 (end-of-line 1)
11104 (newline))
11105 (let ((col (current-column))
11106 (name (plist-get plist :name)))
11107 (insert "#+BEGIN: " name)
11108 (while plist
11109 (if (eq (car plist) :name)
11110 (setq plist (cddr plist))
11111 (insert " " (prin1-to-string (pop plist)))))
11113 (beginning-of-line -2)))
11115 (defun org-prepare-dblock ()
11116 "Prepare dynamic block for refresh.
11117 This empties the block, puts the cursor at the insert position and returns
11118 the property list including an extra property :name with the block name."
11119 (unless (looking-at org-dblock-start-re)
11120 (error "Not at a dynamic block"))
11121 (let* ((begdel (1+ (match-end 0)))
11122 (name (org-no-properties (match-string 1)))
11123 (params (append (list :name name)
11124 (read (concat "(" (match-string 3) ")")))))
11125 (save-excursion
11126 (beginning-of-line 1)
11128 (setq params (plist-put params :indentation-column (current-column))))
11129 (unless (re-search-forward org-dblock-end-re nil t)
11130 (error "Dynamic block not terminated"))
11131 (setq params
11132 (append params
11133 (list :content (buffer-substring
11134 begdel (match-beginning 0)))))
11135 (delete-region begdel (match-beginning 0))
11136 (goto-char begdel)
11137 (open-line 1)
11138 params))
11140 (defun org-map-dblocks (&optional command)
11141 "Apply COMMAND to all dynamic blocks in the current buffer.
11142 If COMMAND is not given, use `org-update-dblock'."
11143 (let ((cmd (or command 'org-update-dblock)))
11144 (save-excursion
11145 (goto-char (point-min))
11146 (while (re-search-forward org-dblock-start-re nil t)
11147 (goto-char (match-beginning 0))
11148 (save-excursion
11149 (condition-case nil
11150 (funcall cmd)
11151 (error (message "Error during update of dynamic block"))))
11152 (unless (re-search-forward org-dblock-end-re nil t)
11153 (error "Dynamic block not terminated"))))))
11155 (defun org-dblock-update (&optional arg)
11156 "User command for updating dynamic blocks.
11157 Update the dynamic block at point. With prefix ARG, update all dynamic
11158 blocks in the buffer."
11159 (interactive "P")
11160 (if arg
11161 (org-update-all-dblocks)
11162 (or (looking-at org-dblock-start-re)
11163 (org-beginning-of-dblock))
11164 (org-update-dblock)))
11166 (defun org-update-dblock ()
11167 "Update the dynamic block at point.
11168 This means to empty the block, parse for parameters and then call
11169 the correct writing function."
11170 (interactive)
11171 (save-window-excursion
11172 (let* ((pos (point))
11173 (line (org-current-line))
11174 (params (org-prepare-dblock))
11175 (name (plist-get params :name))
11176 (indent (plist-get params :indentation-column))
11177 (cmd (intern (concat "org-dblock-write:" name))))
11178 (message "Updating dynamic block `%s' at line %d..." name line)
11179 (funcall cmd params)
11180 (message "Updating dynamic block `%s' at line %d...done" name line)
11181 (goto-char pos)
11182 (when (and indent (> indent 0))
11183 (setq indent (make-string indent ?\ ))
11184 (save-excursion
11185 (org-beginning-of-dblock)
11186 (forward-line 1)
11187 (while (not (looking-at org-dblock-end-re))
11188 (insert indent)
11189 (beginning-of-line 2))
11190 (when (looking-at org-dblock-end-re)
11192 (replace-match ""))
11193 (insert indent)))))))
11195 (defun org-beginning-of-dblock ()
11196 "Find the beginning of the dynamic block at point.
11197 Error if there is no such block at point."
11198 (let ((pos (point))
11199 beg)
11200 (end-of-line 1)
11201 (if (and (re-search-backward org-dblock-start-re nil t)
11202 (setq beg (match-beginning 0))
11203 (re-search-forward org-dblock-end-re nil t)
11204 (> (match-end 0) pos))
11205 (goto-char beg)
11206 (goto-char pos)
11207 (error "Not in a dynamic block"))))
11209 (defun org-update-all-dblocks ()
11210 "Update all dynamic blocks in the buffer.
11211 This function can be used in a hook."
11212 (interactive)
11213 (when (derived-mode-p 'org-mode)
11214 (org-map-dblocks 'org-update-dblock)))
11217 ;;;; Completion
11219 (defconst org-additional-option-like-keywords
11220 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11221 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11222 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11223 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11224 "BEGIN:" "END:"
11225 "ORGTBL" "TBLFM:" "TBLNAME:"
11226 "BEGIN_EXAMPLE" "END_EXAMPLE"
11227 "BEGIN_VERBATIM" "END_VERBATIM"
11228 "BEGIN_QUOTE" "END_QUOTE"
11229 "BEGIN_VERSE" "END_VERSE"
11230 "BEGIN_CENTER" "END_CENTER"
11231 "BEGIN_SRC" "END_SRC"
11232 "BEGIN_RESULT" "END_RESULT"
11233 "BEGIN_lstlisting" "END_lstlisting"
11234 "NAME:" "RESULTS:"
11235 "HEADER:" "HEADERS:"
11236 "COLUMNS:" "PROPERTY:"
11237 "CAPTION:" "LABEL:"
11238 "SETUPFILE:"
11239 "INCLUDE:" "INDEX:"
11240 "BIND:"
11241 "MACRO:"))
11243 (defconst org-options-keywords
11244 '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
11245 "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
11246 "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
11247 "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
11248 "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
11249 "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:" "STYLE:"
11250 "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
11252 (defconst org-additional-option-like-keywords-for-flyspell
11253 (delete-dups
11254 (split-string
11255 (mapconcat (lambda(k)
11256 (replace-regexp-in-string
11258 (concat k " " (downcase k) " " (upcase k))))
11259 (append org-options-keywords org-additional-option-like-keywords)
11260 " ")
11261 " +" t)))
11263 (defcustom org-structure-template-alist
11278 ("L" "#+LaTeX: "
11282 ("H" "#+HTML: "
11285 ("A" "#+ASCII: ")
11286 ("i" "#+INDEX: ?"
11287 "#+INDEX: ?")
11288 ("I" "#+INCLUDE: %file ?"
11290 "Structure completion elements.
11291 This is a list of abbreviation keys and values. The value gets inserted
11292 if you type `<' followed by the key and then press the completion key,
11293 usually `M-TAB'. %file will be replaced by a file name after prompting
11294 for the file using completion. The cursor will be placed at the position
11295 of the `?` in the template.
11296 There are two templates for each key, the first uses the original Org syntax,
11297 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11298 the default when the /org-mtags.el/ module has been loaded. See also the
11299 variable `org-mtags-prefer-muse-templates'."
11300 :group 'org-completion
11301 :type '(repeat
11302 (string :tag "Key")
11303 (string :tag "Template")
11304 (string :tag "Muse Template")))
11306 (defun org-try-structure-completion ()
11307 "Try to complete a structure template before point.
11309 expands them."
11310 (let ((l (buffer-substring (point-at-bol) (point)))
11311 a)
11314 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11315 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11316 (match-beginning 1)) a)
11317 t)))
11319 (defun org-complete-expand-structure-template (start cell)
11320 "Expand a structure template."
11321 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11322 (rpl (nth (if musep 2 1) cell))
11323 (ind ""))
11324 (delete-region start (point))
11326 (cond
11327 ((bolp))
11329 (setq ind (buffer-substring (point-at-bol) (point))))
11330 (t (newline))))
11331 (setq start (point))
11332 (if (string-match "%file" rpl)
11333 (setq rpl (replace-match
11334 (concat
11336 (save-match-data
11337 (abbreviate-file-name (read-file-name "Include file: ")))
11339 t t rpl)))
11342 (insert rpl)
11345 ;;;; TODO, DEADLINE, Comments
11347 (defun org-toggle-comment ()
11348 "Change the COMMENT state of an entry."
11349 (interactive)
11350 (save-excursion
11351 (org-back-to-heading)
11352 (let (case-fold-search)
11353 (cond
11354 ((looking-at (format org-heading-keyword-regexp-format
11355 org-comment-string))
11356 (goto-char (match-end 1))
11357 (looking-at (concat " +" org-comment-string))
11358 (replace-match "" t t)
11359 (when (eolp) (insert " ")))
11360 ((looking-at org-outline-regexp)
11361 (goto-char (match-end 0))
11362 (insert org-comment-string " "))))))
11364 (defvar org-last-todo-state-is-todo nil
11365 "This is non-nil when the last TODO state change led to a TODO state.
11366 If the last change removed the TODO tag or switched to DONE, then
11367 this is nil.")
11369 (defvar org-setting-tags nil) ; dynamically skipped
11371 (defvar org-todo-setup-filter-hook nil
11372 "Hook for functions that pre-filter todo specs.
11373 Each function takes a todo spec and returns either nil or the spec
11374 transformed into canonical form." )
11376 (defvar org-todo-get-default-hook nil
11377 "Hook for functions that get a default item for todo.
11378 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11379 nil or a string to be used for the todo mark." )
11381 (defvar org-agenda-headline-snapshot-before-repeat)
11383 (defun org-current-effective-time ()
11384 "Return current time adjusted for `org-extend-today-until' variable."
11385 (let* ((ct (org-current-time))
11386 (dct (decode-time ct))
11387 (ct1
11388 (if (and org-use-effective-time
11389 (< (nth 2 dct) org-extend-today-until))
11390 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11391 ct)))
11392 ct1))
11394 (defun org-todo-yesterday (&optional arg)
11395 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11396 (interactive "P")
11397 (if (eq major-mode 'org-agenda-mode)
11398 (apply 'org-agenda-todo-yesterday arg)
11399 (let* ((hour (third (decode-time
11400 (org-current-time))))
11401 (org-extend-today-until (1+ hour)))
11402 (org-todo arg))))
11404 (defun org-todo (&optional arg)
11405 "Change the TODO state of an item.
11406 The state of an item is given by a keyword at the start of the heading,
11407 like
11408 *** TODO Write paper
11409 *** DONE Call mom
11411 The different keywords are specified in the variable `org-todo-keywords'.
11413 So for this example: when the item starts with TODO, it is changed to DONE.
11414 When it starts with DONE, the DONE is removed. And when neither TODO nor
11415 DONE are present, add TODO at the beginning of the heading.
11418 state.
11419 With numeric prefix arg, switch to that state.
11421 keywords (nextset).
11423 With a numeric prefix arg of 0, inhibit note taking for the change.
11425 For calling through lisp, arg is also interpreted in the following way:
11426 'none -> empty state
11428 'done -> switch to DONE
11429 'nextset -> switch to the next set of keywords
11430 'previousset -> switch to the previous set of keywords
11432 really is a member of `org-todo-keywords'."
11433 (interactive "P")
11434 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11435 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11436 'region-start-level 'region))
11437 org-loop-over-headlines-in-active-region)
11438 (org-map-entries
11439 `(org-todo ,arg)
11440 org-loop-over-headlines-in-active-region
11441 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11442 (if (equal arg '(16)) (setq arg 'nextset))
11443 (let ((org-blocker-hook org-blocker-hook)
11444 commentp
11445 case-fold-search)
11446 (when (equal arg '(64))
11447 (setq arg nil org-blocker-hook nil))
11448 (when (and org-blocker-hook
11449 (or org-inhibit-blocking
11450 (org-entry-get nil "NOBLOCKING")))
11451 (setq org-blocker-hook nil))
11452 (save-excursion
11453 (catch 'exit
11454 (org-back-to-heading t)
11456 (org-toggle-comment)
11457 (setq commentp t))
11458 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11461 (let* ((match-data (match-data))
11462 (startpos (point-at-bol))
11463 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11464 (org-log-done org-log-done)
11465 (org-log-repeat org-log-repeat)
11466 (org-todo-log-states org-todo-log-states)
11467 (org-inhibit-logging
11468 (if (equal arg 0)
11469 (progn (setq arg nil) 'note) org-inhibit-logging))
11470 (this (match-string 1))
11471 (hl-pos (match-beginning 0))
11472 (head (org-get-todo-sequence-head this))
11473 (ass (assoc head org-todo-kwd-alist))
11474 (interpret (nth 1 ass))
11475 (done-word (nth 3 ass))
11476 (final-done-word (nth 4 ass))
11477 (org-last-state (or this ""))
11478 (completion-ignore-case t)
11479 (member (member this org-todo-keywords-1))
11480 (tail (cdr member))
11481 (org-state (cond
11482 ((and org-todo-key-trigger
11483 (or (and (equal arg '(4))
11484 (eq org-use-fast-todo-selection 'prefix))
11485 (and (not arg) org-use-fast-todo-selection
11486 (not (eq org-use-fast-todo-selection
11487 'prefix)))))
11488 ;; Use fast selection
11489 (org-fast-todo-selection))
11490 ((and (equal arg '(4))
11491 (or (not org-use-fast-todo-selection)
11492 (not org-todo-key-trigger)))
11493 ;; Read a state with completion
11494 (org-icompleting-read
11495 "State: " (mapcar (lambda(x) (list x))
11496 org-todo-keywords-1)
11497 nil t))
11498 ((eq arg 'right)
11499 (if this
11500 (if tail (car tail) nil)
11501 (car org-todo-keywords-1)))
11502 ((eq arg 'left)
11503 (if (equal member org-todo-keywords-1)
11504 nil
11505 (if this
11506 (nth (- (length org-todo-keywords-1)
11507 (length tail) 2)
11508 org-todo-keywords-1)
11509 (org-last org-todo-keywords-1))))
11510 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11511 (setq arg nil))) ; hack to fall back to cycling
11512 (arg
11513 ;; user or caller requests a specific state
11514 (cond
11515 ((equal arg "") nil)
11516 ((eq arg 'none) nil)
11517 ((eq arg 'done) (or done-word (car org-done-keywords)))
11518 ((eq arg 'nextset)
11519 (or (car (cdr (member head org-todo-heads)))
11520 (car org-todo-heads)))
11521 ((eq arg 'previousset)
11522 (let ((org-todo-heads (reverse org-todo-heads)))
11523 (or (car (cdr (member head org-todo-heads)))
11524 (car org-todo-heads))))
11525 ((car (member arg org-todo-keywords-1)))
11526 ((stringp arg)
11527 (error "State `%s' not valid in this file" arg))
11528 ((nth (1- (prefix-numeric-value arg))
11529 org-todo-keywords-1))))
11530 ((null member) (or head (car org-todo-keywords-1)))
11531 ((equal this final-done-word) nil) ;; -> make empty
11532 ((null tail) nil) ;; -> first entry
11533 ((memq interpret '(type priority))
11534 (if (eq this-command last-command)
11535 (car tail)
11536 (if (> (length tail) 0)
11537 (or done-word (car org-done-keywords))
11538 nil)))
11539 (t
11540 (car tail))))
11541 (org-state (or
11542 (run-hook-with-args-until-success
11543 'org-todo-get-default-hook org-state org-last-state)
11544 org-state))
11545 (next (if org-state (concat " " org-state " ") " "))
11546 (change-plist (list :type 'todo-state-change :from this :to org-state
11547 :position startpos))
11548 dolog now-done-p)
11549 (when org-blocker-hook
11550 (setq org-last-todo-state-is-todo
11551 (not (member this org-done-keywords)))
11552 (unless (save-excursion
11553 (save-match-data
11554 (org-with-wide-buffer
11555 (run-hook-with-args-until-failure
11556 'org-blocker-hook change-plist))))
11557 (if (org-called-interactively-p 'interactive)
11558 (error "TODO state change from %s to %s blocked" this org-state)
11559 ;; fail silently
11560 (message "TODO state change from %s to %s blocked" this org-state)
11561 (throw 'exit nil))))
11562 (store-match-data match-data)
11563 (replace-match next t t)
11564 (unless (pos-visible-in-window-p hl-pos)
11565 (message "TODO state changed to %s" (org-trim next)))
11566 (unless head
11567 (setq head (org-get-todo-sequence-head org-state)
11568 ass (assoc head org-todo-kwd-alist)
11569 interpret (nth 1 ass)
11570 done-word (nth 3 ass)
11571 final-done-word (nth 4 ass)))
11572 (when (memq arg '(nextset previousset))
11573 (message "Keyword-Set %d/%d: %s"
11574 (- (length org-todo-sets) -1
11575 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11576 (length org-todo-sets)
11577 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11578 (setq org-last-todo-state-is-todo
11579 (not (member org-state org-done-keywords)))
11580 (setq now-done-p (and (member org-state org-done-keywords)
11581 (not (member this org-done-keywords))))
11582 (and logging (org-local-logging logging))
11583 (when (and (or org-todo-log-states org-log-done)
11584 (not (eq org-inhibit-logging t))
11585 (not (memq arg '(nextset previousset))))
11586 ;; we need to look at recording a time and note
11587 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11588 (nth 2 (assoc this org-todo-log-states))))
11589 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11590 (setq dolog 'time))
11591 (when (and org-state
11592 (member org-state org-not-done-keywords)
11593 (not (member this org-not-done-keywords)))
11594 ;; This is now a todo state and was not one before
11595 ;; If there was a CLOSED time stamp, get rid of it.
11596 (org-add-planning-info nil nil 'closed))
11597 (when (and now-done-p org-log-done)
11598 ;; It is now done, and it was not done before
11599 (org-add-planning-info 'closed (org-current-effective-time))
11600 (if (and (not dolog) (eq 'note org-log-done))
11601 (org-add-log-setup 'done org-state this 'findpos 'note)))
11602 (when (and org-state dolog)
11603 ;; This is a non-nil state, and we need to log it
11604 (org-add-log-setup 'state org-state this 'findpos dolog)))
11605 ;; Fixup tag positioning
11606 (org-todo-trigger-tag-changes org-state)
11607 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11608 (when org-provide-todo-statistics
11609 (org-update-parent-todo-statistics))
11610 (run-hooks 'org-after-todo-state-change-hook)
11611 (if (and arg (not (member org-state org-done-keywords)))
11612 (setq head (org-get-todo-sequence-head org-state)))
11613 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11614 ;; Do we need to trigger a repeat?
11615 (when now-done-p
11616 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11617 ;; This is for the agenda, take a snapshot of the headline.
11618 (save-match-data
11619 (setq org-agenda-headline-snapshot-before-repeat
11620 (org-get-heading))))
11621 (org-auto-repeat-maybe org-state))
11622 ;; Fixup cursor location if close to the keyword
11623 (if (and (outline-on-heading-p)
11624 (not (bolp))
11625 (save-excursion (beginning-of-line 1)
11626 (looking-at org-todo-line-regexp))
11627 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11628 (progn
11629 (goto-char (or (match-end 2) (match-end 1)))
11630 (and (looking-at " ") (just-one-space))))
11631 (when org-trigger-hook
11632 (save-excursion
11633 (run-hook-with-args 'org-trigger-hook change-plist)))
11634 (when commentp (org-toggle-comment))))))))
11636 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11637 "Block turning an entry into a TODO, using the hierarchy.
11638 This checks whether the current task should be blocked from state
11639 changes. Such blocking occurs when:
11641 1. The task has children which are not all in a completed state.
11643 2. A task has a parent with the property :ORDERED:, and there
11644 are siblings prior to the current task with incomplete
11645 status.
11647 3. The parent of the task is blocked because it has siblings that should
11648 be done first, or is child of a block grandparent TODO entry."
11650 (if (not org-enforce-todo-dependencies)
11651 t ; if locally turned off don't block
11652 (catch 'dont-block
11653 ;; If this is not a todo state change, or if this entry is already DONE,
11654 ;; do not block
11655 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11656 (member (plist-get change-plist :from)
11657 (cons 'done org-done-keywords))
11658 (member (plist-get change-plist :to)
11659 (cons 'todo org-not-done-keywords))
11660 (not (plist-get change-plist :to)))
11661 (throw 'dont-block t))
11662 ;; If this task has children, and any are undone, it's blocked
11663 (save-excursion
11664 (org-back-to-heading t)
11665 (let ((this-level (funcall outline-level)))
11666 (outline-next-heading)
11667 (let ((child-level (funcall outline-level)))
11668 (while (and (not (eobp))
11669 (> child-level this-level))
11670 ;; this todo has children, check whether they are all
11671 ;; completed
11672 (if (and (not (org-entry-is-done-p))
11673 (org-entry-is-todo-p))
11674 (throw 'dont-block nil))
11675 (outline-next-heading)
11676 (setq child-level (funcall outline-level))))))
11677 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11678 ;; any previous siblings are undone, it's blocked
11679 (save-excursion
11680 (org-back-to-heading t)
11681 (let* ((pos (point))
11682 (parent-pos (and (org-up-heading-safe) (point))))
11683 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11684 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11685 (forward-line 1)
11686 (re-search-forward org-not-done-heading-regexp pos t))
11687 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11688 ;; Search further up the hierarchy, to see if an ancestor is blocked
11689 (while t
11690 (goto-char parent-pos)
11691 (if (not (looking-at org-not-done-heading-regexp))
11692 (throw 'dont-block t)) ; do not block, parent is not a TODO
11693 (setq pos (point))
11694 (setq parent-pos (and (org-up-heading-safe) (point)))
11695 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11696 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11697 (forward-line 1)
11698 (re-search-forward org-not-done-heading-regexp pos t))
11699 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11701 (defcustom org-track-ordered-property-with-tag nil
11702 "Should the ORDERED property also be shown as a tag?
11703 The ORDERED property decides if an entry should require subtasks to be
11704 completed in sequence. Since a property is not very visible, setting
11705 this option means that toggling the ORDERED property with the command
11706 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11707 not relevant for the behavior, but it makes things more visible.
11709 Note that toggling the tag with tags commands will not change the property
11710 and therefore not influence behavior!
11712 This can be t, meaning the tag ORDERED should be used, It can also be a
11713 string to select a different tag for this task."
11714 :group 'org-todo
11715 :type '(choice
11716 (const :tag "No tracking" nil)
11717 (const :tag "Track with ORDERED tag" t)
11718 (string :tag "Use other tag")))
11720 (defun org-toggle-ordered-property ()
11721 "Toggle the ORDERED property of the current entry.
11722 For better visibility, you can track the value of this property with a tag.
11723 See variable `org-track-ordered-property-with-tag'."
11724 (interactive)
11725 (let* ((t1 org-track-ordered-property-with-tag)
11726 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11727 (save-excursion
11728 (org-back-to-heading)
11729 (if (org-entry-get nil "ORDERED")
11730 (progn
11731 (org-delete-property "ORDERED")
11732 (and tag (org-toggle-tag tag 'off))
11733 (message "Subtasks can be completed in arbitrary order"))
11734 (org-entry-put nil "ORDERED" "t")
11735 (and tag (org-toggle-tag tag 'on))
11736 (message "Subtasks must be completed in sequence")))))
11738 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11739 (defun org-block-todo-from-checkboxes (change-plist)
11740 "Block turning an entry into a TODO, using checkboxes.
11741 This checks whether the current task should be blocked from state
11742 changes because there are unchecked boxes in this entry."
11743 (if (not org-enforce-todo-checkbox-dependencies)
11744 t ; if locally turned off don't block
11745 (catch 'dont-block
11746 ;; If this is not a todo state change, or if this entry is already DONE,
11747 ;; do not block
11748 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11749 (member (plist-get change-plist :from)
11750 (cons 'done org-done-keywords))
11751 (member (plist-get change-plist :to)
11752 (cons 'todo org-not-done-keywords))
11753 (not (plist-get change-plist :to)))
11754 (throw 'dont-block t))
11755 ;; If this task has checkboxes that are not checked, it's blocked
11756 (save-excursion
11757 (org-back-to-heading t)
11758 (let ((beg (point)) end)
11759 (outline-next-heading)
11760 (setq end (point))
11761 (goto-char beg)
11762 (if (org-list-search-forward
11763 (concat (org-item-beginning-re)
11766 end t)
11767 (progn
11768 (if (boundp 'org-blocked-by-checkboxes)
11769 (setq org-blocked-by-checkboxes t))
11770 (throw 'dont-block nil)))))
11771 t))) ; do not block
11773 (defun org-entry-blocked-p ()
11774 "Is the current entry blocked?"
11775 (if (org-entry-get nil "NOBLOCKING")
11776 nil ;; Never block this entry
11777 (not
11778 (run-hook-with-args-until-failure
11779 'org-blocker-hook
11780 (list :type 'todo-state-change
11781 :position (point)
11782 :from 'todo
11783 :to 'done)))))
11785 (defun org-update-statistics-cookies (all)
11786 "Update the statistics cookie, either from TODO or from checkboxes.
11787 This should be called with the cursor in a line with a statistics cookie."
11788 (interactive "P")
11789 (if all
11790 (progn
11791 (org-update-checkbox-count 'all)
11792 (org-map-entries 'org-update-parent-todo-statistics))
11793 (if (not (org-at-heading-p))
11794 (org-update-checkbox-count)
11795 (let ((pos (point-marker))
11796 end l1 l2)
11797 (ignore-errors (org-back-to-heading t))
11798 (if (not (org-at-heading-p))
11799 (org-update-checkbox-count)
11800 (setq l1 (org-outline-level))
11801 (setq end (save-excursion
11802 (outline-next-heading)
11803 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11804 (point)))
11805 (if (and (save-excursion
11806 (re-search-forward
11808 (not (save-excursion (re-search-forward
11810 (org-update-checkbox-count)
11811 (if (and l2 (> l2 l1))
11812 (progn
11813 (goto-char end)
11814 (org-update-parent-todo-statistics))
11815 (goto-char pos)
11816 (beginning-of-line 1)
11817 (while (re-search-forward
11819 (point-at-eol) t)
11820 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11821 (goto-char pos)
11822 (move-marker pos nil)))))
11824 (defvar org-entry-property-inherited-from) ;; defined below
11825 (defun org-update-parent-todo-statistics ()
11826 "Update any statistics cookie in the parent of the current headline.
11827 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11828 the entire subtree and this will travel up the hierarchy and update
11829 statistics everywhere."
11830 (let* ((prop (save-excursion (org-up-heading-safe)
11831 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11832 (recursive (or (not org-hierarchical-todo-statistics)
11834 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11835 0))
11836 (first t)
11838 level ltoggle l1 new ndel
11839 (cnt-all 0) (cnt-done 0) is-percent kwd
11840 checkbox-beg ov ovs ove cookie-present)
11841 (catch 'exit
11842 (save-excursion
11843 (beginning-of-line 1)
11844 (setq ltoggle (funcall outline-level))
11845 ;; Three situations are to consider:
11847 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11848 ;; to the top-level ancestor on the headline;
11850 ;; 2. If parent has "recursive" property, repeat up to the
11851 ;; headline setting that property, taking inheritance into
11852 ;; account;
11854 ;; 3. Else, move up to direct parent and proceed only once.
11855 (while (and (setq level (org-up-heading-safe))
11856 (or recursive first)
11857 (>= (point) lim))
11858 (setq first nil cookie-present nil)
11859 (unless (and level
11860 (not (string-match
11862 (downcase (or (org-entry-get nil "COOKIE_DATA")
11863 "")))))
11864 (throw 'exit nil))
11865 (while (re-search-forward box-re (point-at-eol) t)
11866 (setq cnt-all 0 cnt-done 0 cookie-present t)
11867 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11868 (save-match-data
11869 (unless (outline-next-heading) (throw 'exit nil))
11870 (while (and (looking-at org-complex-heading-regexp)
11871 (> (setq l1 (length (match-string 1))) level))
11872 (setq kwd (and (or recursive (= l1 ltoggle))
11873 (match-string 2)))
11874 (if (or (eq org-provide-todo-statistics 'all-headlines)
11875 (and (listp org-provide-todo-statistics)
11876 (or (member kwd org-provide-todo-statistics)
11877 (member kwd org-done-keywords))))
11878 (setq cnt-all (1+ cnt-all))
11879 (if (eq org-provide-todo-statistics t)
11880 (and kwd (setq cnt-all (1+ cnt-all)))))
11881 (and (member kwd org-done-keywords)
11882 (setq cnt-done (1+ cnt-done)))
11883 (outline-next-heading)))
11884 (setq new
11885 (if is-percent
11886 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11887 (format "[%d/%d]" cnt-done cnt-all))
11888 ndel (- (match-end 0) checkbox-beg))
11889 ;; handle overlays when updating cookie from column view
11890 (when (setq ov (car (overlays-at checkbox-beg)))
11891 (setq ovs (overlay-start ov) ove (overlay-end ov))
11892 (delete-overlay ov))
11893 (goto-char checkbox-beg)
11894 (insert new)
11895 (delete-region (point) (+ (point) ndel))
11896 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11897 (when ov (move-overlay ov ovs ove)))
11898 (when cookie-present
11899 (run-hook-with-args 'org-after-todo-statistics-hook
11900 cnt-done (- cnt-all cnt-done))))))
11901 (run-hooks 'org-todo-statistics-hook)))
11903 (defvar org-after-todo-statistics-hook nil
11904 "Hook that is called after a TODO statistics cookie has been updated.
11905 Each function is called with two arguments: the number of not-done entries
11906 and the number of done entries.
11908 For example, the following function, when added to this hook, will switch
11909 an entry to DONE when all children are done, and back to TODO when new
11910 entries are set to a TODO status. Note that this hook is only called
11911 when there is a statistics cookie in the headline!
11913 (defun org-summary-todo (n-done n-not-done)
11915 (let (org-log-done org-log-states) ; turn off logging
11917 ")
11919 (defvar org-todo-statistics-hook nil
11920 "Hook that is run whenever Org thinks TODO statistics should be updated.
11921 This hook runs even if there is no statistics cookie present, in which case
11922 `org-after-todo-statistics-hook' would not run.")
11924 (defun org-todo-trigger-tag-changes (state)
11925 "Apply the changes defined in `org-todo-state-tags-triggers'."
11926 (let ((l org-todo-state-tags-triggers)
11927 changes)
11928 (when (or (not state) (equal state ""))
11929 (setq changes (append changes (cdr (assoc "" l)))))
11930 (when (and (stringp state) (> (length state) 0))
11931 (setq changes (append changes (cdr (assoc state l)))))
11932 (when (member state org-not-done-keywords)
11933 (setq changes (append changes (cdr (assoc 'todo l)))))
11934 (when (member state org-done-keywords)
11935 (setq changes (append changes (cdr (assoc 'done l)))))
11936 (dolist (c changes)
11937 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11939 (defun org-local-logging (value)
11940 "Get logging settings from a property VALUE."
11941 (let* (words w a)
11942 ;; directly set the variables, they are already local.
11943 (setq org-log-done nil
11944 org-log-repeat nil
11945 org-todo-log-states nil)
11946 (setq words (org-split-string value))
11947 (while (setq w (pop words))
11948 (cond
11949 ((setq a (assoc w org-startup-options))
11950 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11951 (set (nth 1 a) (nth 2 a))))
11952 ((setq a (org-extract-log-state-settings w))
11953 (and (member (car a) org-todo-keywords-1)
11954 (push a org-todo-log-states)))))))
11956 (defun org-get-todo-sequence-head (kwd)
11957 "Return the head of the TODO sequence to which KWD belongs.
11958 If KWD is not set, check if there is a text property remembering the
11959 right sequence."
11960 (let (p)
11961 (cond
11962 ((not kwd)
11963 (or (get-text-property (point-at-bol) 'org-todo-head)
11964 (progn
11965 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11966 nil (point-at-eol)))
11967 (get-text-property p 'org-todo-head))))
11968 ((not (member kwd org-todo-keywords-1))
11969 (car org-todo-keywords-1))
11970 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11972 (defun org-fast-todo-selection ()
11973 "Fast TODO keyword selection with single keys.
11974 Returns the new TODO keyword, or nil if no state change should occur."
11975 (let* ((fulltable org-todo-key-alist)
11976 (done-keywords org-done-keywords) ;; needed for the faces.
11977 (maxlen (apply 'max (mapcar
11978 (lambda (x)
11979 (if (stringp (car x)) (string-width (car x)) 0))
11980 fulltable)))
11981 (expert nil)
11982 (fwidth (+ maxlen 3 1 3))
11983 (ncol (/ (- (window-width) 4) fwidth))
11984 tg cnt e c tbl
11985 groups ingroup)
11986 (save-excursion
11987 (save-window-excursion
11988 (if expert
11989 (set-buffer (get-buffer-create " *Org todo*"))
11990 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11991 (erase-buffer)
11992 (org-set-local 'org-done-keywords done-keywords)
11993 (setq tbl fulltable cnt 0)
11994 (while (setq e (pop tbl))
11995 (cond
11996 ((equal e '(:startgroup))
11997 (push '() groups) (setq ingroup t)
11998 (when (not (= cnt 0))
11999 (setq cnt 0)
12001 (insert "{ "))
12002 ((equal e '(:endgroup))
12003 (setq ingroup nil cnt 0)
12005 ((equal e '(:newline))
12006 (when (not (= cnt 0))
12007 (setq cnt 0)
12009 (setq e (car tbl))
12010 (while (equal (car tbl) '(:newline))
12012 (setq tbl (cdr tbl)))))
12013 (t
12014 (setq tg (car e) c (cdr e))
12015 (if ingroup (push tg (car groups)))
12016 (setq tg (org-add-props tg nil 'face
12017 (org-get-todo-face tg)))
12018 (if (and (= cnt 0) (not ingroup)) (insert " "))
12019 (insert "[" c "] " tg (make-string
12020 (- fwidth 4 (length tg)) ?\ ))
12021 (when (= (setq cnt (1+ cnt)) ncol)
12023 (if ingroup (insert " "))
12024 (setq cnt 0)))))
12026 (goto-char (point-min))
12027 (if (not expert) (org-fit-window-to-buffer))
12028 (message "[a-z..]:Set [SPC]:clear")
12029 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12030 (cond
12031 ((or (= c ?\C-g)
12032 (and (= c ?q) (not (rassoc c fulltable))))
12033 (setq quit-flag t))
12034 ((= c ?\ ) nil)
12035 ((setq e (rassoc c fulltable) tg (car e))
12036 tg)
12037 (t (setq quit-flag t)))))))
12039 (defun org-entry-is-todo-p ()
12040 (member (org-get-todo-state) org-not-done-keywords))
12042 (defun org-entry-is-done-p ()
12043 (member (org-get-todo-state) org-done-keywords))
12045 (defun org-get-todo-state ()
12046 (save-excursion
12047 (org-back-to-heading t)
12048 (and (looking-at org-todo-line-regexp)
12049 (match-end 2)
12050 (match-string 2))))
12052 (defun org-at-date-range-p (&optional inactive-ok)
12053 "Is the cursor inside a date range?"
12054 (interactive)
12055 (save-excursion
12056 (catch 'exit
12057 (let ((pos (point)))
12059 (skip-chars-backward "<[")
12060 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12061 (>= (match-end 0) pos)
12062 (throw 'exit t))
12064 (skip-chars-backward "<[")
12065 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12066 (>= (match-end 0) pos)
12067 (throw 'exit t)))
12068 nil)))
12070 (defun org-get-repeat (&optional tagline)
12071 "Check if there is a deadline/schedule with repeater in this entry."
12072 (save-match-data
12073 (save-excursion
12074 (org-back-to-heading t)
12075 (and (re-search-forward (if tagline
12077 org-repeat-re)
12078 (org-entry-end-position) t)
12079 (match-string-no-properties 1)))))
12081 (defvar org-last-changed-timestamp)
12082 (defvar org-last-inserted-timestamp)
12083 (defvar org-log-post-message)
12084 (defvar org-log-note-purpose)
12085 (defvar org-log-note-how)
12086 (defvar org-log-note-extra)
12087 (defun org-auto-repeat-maybe (done-word)
12088 "Check if the current headline contains a repeated deadline/schedule.
12089 If yes, set TODO state back to what it was and change the base date
12090 of repeating deadline/scheduled time stamps to new date.
12091 This function is run automatically after each state change to a DONE state."
12092 ;; last-state is dynamically scoped into this function
12093 (let* ((repeat (org-get-repeat))
12094 (aa (assoc org-last-state org-todo-kwd-alist))
12095 (interpret (nth 1 aa))
12096 (head (nth 2 aa))
12097 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12098 (msg "Entry repeats: ")
12099 (org-log-done nil)
12100 (org-todo-log-states nil)
12101 re type n what ts time to-state)
12102 (when repeat
12103 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12104 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12105 org-todo-repeat-to-state))
12106 (unless (and to-state (member to-state org-todo-keywords-1))
12107 (setq to-state (if (eq interpret 'type) org-last-state head)))
12108 (org-todo to-state)
12109 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12110 (org-entry-put nil "LAST_REPEAT" (format-time-string
12111 (org-time-stamp-format t t))))
12112 (when org-log-repeat
12113 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12114 (memq 'org-add-log-note post-command-hook))
12115 ;; OK, we are already setup for some record
12116 (if (eq org-log-repeat 'note)
12117 ;; make sure we take a note, not only a time stamp
12118 (setq org-log-note-how 'note))
12119 ;; Set up for taking a record
12120 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12121 org-last-state
12122 'findpos org-log-repeat)))
12123 (org-back-to-heading t)
12124 (org-add-planning-info nil nil 'closed)
12128 (while (re-search-forward
12129 re (save-excursion (outline-next-heading) (point)) t)
12130 (setq type (if (match-end 1) org-scheduled-string
12131 (if (match-end 3) org-deadline-string "Plain:"))
12132 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12134 (setq n (string-to-number (match-string 2 ts))
12135 what (match-string 3 ts))
12136 (if (equal what "w") (setq n (* n 7) what "d"))
12138 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12139 ;; Preparation, see if we need to modify the start date for the change
12140 (when (match-end 1)
12141 (setq time (save-match-data (org-time-string-to-time ts)))
12142 (cond
12143 ((equal (match-string 1 ts) ".")
12144 ;; Shift starting date to today
12145 (org-timestamp-change
12146 (- (org-today) (time-to-days time))
12147 'day))
12148 ((equal (match-string 1 ts) "+")
12149 (let ((nshiftmax 10) (nshift 0))
12150 (while (or (= nshift 0)
12151 (<= (time-to-days time)
12152 (time-to-days (current-time))))
12153 (when (= (incf nshift) nshiftmax)
12154 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12155 (error "Abort")))
12156 (org-timestamp-change n (cdr (assoc what whata)))
12157 (org-at-timestamp-p t)
12158 (setq ts (match-string 1))
12159 (setq time (save-match-data (org-time-string-to-time ts)))))
12160 (org-timestamp-change (- n) (cdr (assoc what whata)))
12161 ;; rematch, so that we have everything in place for the real shift
12162 (org-at-timestamp-p t)
12163 (setq ts (match-string 1))
12165 (org-timestamp-change n (cdr (assoc what whata)))
12166 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12167 (setq org-log-post-message msg)
12168 (message "%s" msg))))
12170 (defun org-show-todo-tree (arg)
12171 "Make a compact tree which shows all headlines marked with TODO.
12172 The tree will show the lines where the regexp matches, and all higher
12173 headlines above the match.
12175 With a numeric prefix N, construct a sparse tree for the Nth element
12176 of `org-todo-keywords-1'."
12177 (interactive "P")
12178 (let ((case-fold-search nil)
12179 (kwd-re
12180 (cond ((null arg) org-not-done-regexp)
12181 ((equal arg '(4))
12182 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12183 (mapcar 'list org-todo-keywords-1))))
12187 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12188 (regexp-quote (nth (1- (prefix-numeric-value arg))
12189 org-todo-keywords-1)))
12190 (t (error "Invalid prefix argument: %s" arg)))))
12191 (message "%d TODO entries found"
12192 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12194 (defun org-deadline (&optional remove time)
12196 With argument REMOVE, remove any deadline from the item.
12197 With argument TIME, set the deadline at the corresponding date. TIME
12199 (interactive "P")
12200 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12201 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12202 'region-start-level 'region))
12203 org-loop-over-headlines-in-active-region)
12204 (org-map-entries
12205 `(org-deadline ',remove ,time)
12206 org-loop-over-headlines-in-active-region
12207 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12208 (let* ((old-date (org-entry-get nil "DEADLINE"))
12209 (repeater (and old-date
12210 (string-match
12212 old-date)
12213 (match-string 1 old-date))))
12214 (if remove
12215 (progn
12216 (when (and old-date org-log-redeadline)
12217 (org-add-log-setup 'deldeadline nil old-date 'findpos
12218 org-log-redeadline))
12219 (org-remove-timestamp-with-keyword org-deadline-string)
12220 (message "Item no longer has a deadline."))
12221 (org-add-planning-info 'deadline time 'closed)
12222 (when (and old-date org-log-redeadline
12223 (not (equal old-date
12224 (substring org-last-inserted-timestamp 1 -1))))
12225 (org-add-log-setup 'redeadline nil old-date 'findpos
12226 org-log-redeadline))
12227 (when repeater
12228 (save-excursion
12229 (org-back-to-heading t)
12230 (when (re-search-forward (concat org-deadline-string " "
12231 org-last-inserted-timestamp)
12232 (save-excursion
12233 (outline-next-heading) (point)) t)
12234 (goto-char (1- (match-end 0)))
12235 (insert " " repeater)
12236 (setq org-last-inserted-timestamp
12237 (concat (substring org-last-inserted-timestamp 0 -1)
12238 " " repeater
12239 (substring org-last-inserted-timestamp -1))))))
12240 (message "Deadline on %s" org-last-inserted-timestamp)))))
12242 (defun org-schedule (&optional remove time)
12243 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12244 With argument REMOVE, remove any scheduling date from the item.
12245 With argument TIME, scheduled at the corresponding date. TIME can
12247 (interactive "P")
12248 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12249 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12250 'region-start-level 'region))
12251 org-loop-over-headlines-in-active-region)
12252 (org-map-entries
12253 `(org-schedule ',remove ,time)
12254 org-loop-over-headlines-in-active-region
12255 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12256 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12257 (repeater (and old-date
12258 (string-match
12260 old-date)
12261 (match-string 1 old-date))))
12262 (if remove
12263 (progn
12264 (when (and old-date org-log-reschedule)
12265 (org-add-log-setup 'delschedule nil old-date 'findpos
12266 org-log-reschedule))
12267 (org-remove-timestamp-with-keyword org-scheduled-string)
12268 (message "Item is no longer scheduled."))
12269 (org-add-planning-info 'scheduled time 'closed)
12270 (when (and old-date org-log-reschedule
12271 (not (equal old-date
12272 (substring org-last-inserted-timestamp 1 -1))))
12273 (org-add-log-setup 'reschedule nil old-date 'findpos
12274 org-log-reschedule))
12275 (when repeater
12276 (save-excursion
12277 (org-back-to-heading t)
12278 (when (re-search-forward (concat org-scheduled-string " "
12279 org-last-inserted-timestamp)
12280 (save-excursion
12281 (outline-next-heading) (point)) t)
12282 (goto-char (1- (match-end 0)))
12283 (insert " " repeater)
12284 (setq org-last-inserted-timestamp
12285 (concat (substring org-last-inserted-timestamp 0 -1)
12286 " " repeater
12287 (substring org-last-inserted-timestamp -1))))))
12288 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12290 (defun org-get-scheduled-time (pom &optional inherit)
12291 "Get the scheduled time as a time tuple, of a format suitable
12292 for calling org-schedule with, or if there is no scheduling,
12293 returns nil."
12294 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12295 (when time
12296 (apply 'encode-time (org-parse-time-string time)))))
12298 (defun org-get-deadline-time (pom &optional inherit)
12299 "Get the deadline as a time tuple, of a format suitable for
12300 calling org-deadline with, or if there is no scheduling, returns
12301 nil."
12302 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12303 (when time
12304 (apply 'encode-time (org-parse-time-string time)))))
12306 (defun org-remove-timestamp-with-keyword (keyword)
12307 "Remove all time stamps with KEYWORD in the current entry."
12309 beg)
12310 (save-excursion
12311 (org-back-to-heading t)
12312 (setq beg (point))
12313 (outline-next-heading)
12314 (while (re-search-backward re beg t)
12315 (replace-match "")
12317 (equal (char-before) ?\ ))
12318 (backward-delete-char 1)
12320 (point-at-bol) (point-at-eol)))
12321 (delete-region (point-at-bol)
12322 (min (point-max) (1+ (point-at-eol))))))))))
12324 (defun org-add-planning-info (what &optional time &rest remove)
12325 "Insert new timestamp with keyword in the line directly after the headline.
12326 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12327 If non is given, the user is prompted for a date.
12328 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12329 be removed."
12330 (interactive)
12331 (let (org-time-was-given org-end-time-was-given ts
12332 end default-time default-input)
12334 (catch 'exit
12335 (when (and (memq what '(scheduled deadline))
12336 (or (not time)
12337 (and (stringp time)
12338 (string-match "^[-+]+[0-9]" time))))
12339 ;; Try to get a default date/time from existing timestamp
12340 (save-excursion
12341 (org-back-to-heading t)
12342 (setq end (save-excursion (outline-next-heading) (point)))
12343 (when (re-search-forward (if (eq what 'scheduled)
12344 org-scheduled-time-regexp
12345 org-deadline-time-regexp)
12346 end t)
12347 (setq ts (match-string 1)
12348 default-time
12349 (apply 'encode-time (org-parse-time-string ts))
12350 default-input (and ts (org-get-compact-tod ts))))))
12351 (when what
12352 (setq time
12353 (if (stringp time)
12354 ;; This is a string (relative or absolute), set proper date
12355 (apply 'encode-time
12356 (org-read-date-analyze
12357 time default-time (decode-time default-time)))
12358 ;; If necessary, get the time from the user
12359 (or time (org-read-date nil 'to-time nil nil
12360 default-time default-input)))))
12362 (when (and org-insert-labeled-timestamps-at-point
12363 (member what '(scheduled deadline)))
12364 (insert
12365 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12366 (org-insert-time-stamp time org-time-was-given
12367 nil nil nil (list org-end-time-was-given))
12368 (setq what nil))
12369 (save-excursion
12370 (save-restriction
12371 (let (col list elt ts buffer-invisibility-spec)
12372 (org-back-to-heading t)
12374 (goto-char (match-end 1))
12375 (setq col (current-column))
12376 (goto-char (match-end 0))
12378 (when (and (not what)
12379 (not (looking-at
12381 org-keyword-time-not-clock-regexp))))
12382 ;; Nothing to add, nothing to remove...... :-)
12383 (throw 'exit nil))
12384 (if (and (not (looking-at org-outline-regexp))
12387 (not (equal (match-string 1) org-clock-string)))
12388 (narrow-to-region (match-beginning 0) (match-end 0))
12390 (backward-char 1)
12391 (narrow-to-region (point) (point))
12392 (and org-adapt-indentation (org-indent-to-column col)))
12393 ;; Check if we have to remove something.
12394 (setq list (cons what remove))
12395 (while list
12396 (setq elt (pop list))
12397 (when (or (and (eq elt 'scheduled)
12398 (re-search-forward org-scheduled-time-regexp nil t))
12399 (and (eq elt 'deadline)
12400 (re-search-forward org-deadline-time-regexp nil t))
12401 (and (eq elt 'closed)
12402 (re-search-forward org-closed-time-regexp nil t)))
12403 (replace-match "")
12404 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12406 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12407 (when what
12408 (insert
12409 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12410 (cond ((eq what 'scheduled) org-scheduled-string)
12411 ((eq what 'deadline) org-deadline-string)
12412 ((eq what 'closed) org-closed-string))
12413 " ")
12414 (setq ts (org-insert-time-stamp
12415 time
12416 (or org-time-was-given
12417 (and (eq what 'closed) org-log-done-with-time))
12418 (eq what 'closed)
12419 nil nil (list org-end-time-was-given)))
12420 (insert
12421 (if (not (or (bolp) (eq (char-before) ?\ )
12422 (memq (char-after) '(32 10))
12423 (eobp))) " " ""))
12424 (end-of-line 1))
12425 (goto-char (point-min))
12426 (widen)
12429 (delete-region (1- (point)) (point-at-eol)))
12430 ts))))))
12432 (defvar org-log-note-marker (make-marker))
12433 (defvar org-log-note-purpose nil)
12434 (defvar org-log-note-state nil)
12435 (defvar org-log-note-previous-state nil)
12436 (defvar org-log-note-how nil)
12437 (defvar org-log-note-extra nil)
12438 (defvar org-log-note-window-configuration nil)
12439 (defvar org-log-note-return-to (make-marker))
12440 (defvar org-log-note-effective-time nil
12441 "Remembered current time so that dynamically scoped
12442 `org-extend-today-until' affects tha timestamps in state change
12443 log")
12445 (defvar org-log-post-message nil
12446 "Message to be displayed after a log note has been stored.
12447 The auto-repeater uses this.")
12449 (defun org-add-note ()
12450 "Add a note to the current entry.
12451 This is done in the same way as adding a state change note."
12452 (interactive)
12453 (org-add-log-setup 'note nil nil 'findpos nil))
12455 (defvar org-property-end-re)
12456 (defun org-add-log-setup (&optional purpose state prev-state
12457 findpos how extra)
12458 "Set up the post command hook to take a note.
12459 If this is about to TODO state change, the new state is expected in STATE.
12460 When FINDPOS is non-nil, find the correct position for the note in
12461 the current entry. If not, assume that it can be inserted at point.
12462 HOW is an indicator what kind of note should be created.
12463 EXTRA is additional text that will be inserted into the notes buffer."
12464 (let* ((org-log-into-drawer (org-log-into-drawer))
12465 (drawer (cond ((stringp org-log-into-drawer)
12466 org-log-into-drawer)
12467 (org-log-into-drawer "LOGBOOK"))))
12468 (save-restriction
12469 (save-excursion
12470 (when findpos
12471 (org-back-to-heading t)
12472 (narrow-to-region (point) (save-excursion
12473 (outline-next-heading) (point)))
12477 (goto-char (match-end 0))
12478 (cond
12479 (drawer
12481 nil t)
12482 (progn
12483 (goto-char (match-end 0))
12484 (or org-log-states-order-reversed
12485 (and (re-search-forward org-property-end-re nil t)
12486 (goto-char (1- (match-beginning 0))))))
12488 (beginning-of-line 0)
12489 (org-indent-line)
12490 (beginning-of-line 2)
12491 (org-indent-line)
12492 (end-of-line 0)))
12493 ((and org-log-state-notes-insert-after-drawers
12494 (save-excursion
12495 (forward-line) (looking-at org-drawer-regexp)))
12496 (forward-line)
12497 (while (looking-at org-drawer-regexp)
12498 (goto-char (match-end 0))
12499 (re-search-forward org-property-end-re (point-max) t)
12500 (forward-line))
12501 (forward-line -1)))
12502 (unless org-log-states-order-reversed
12504 (org-skip-over-state-notes)
12506 (move-marker org-log-note-marker (point))
12507 (setq org-log-note-purpose purpose
12508 org-log-note-state state
12509 org-log-note-previous-state prev-state
12510 org-log-note-how how
12511 org-log-note-extra extra
12512 org-log-note-effective-time (org-current-effective-time))
12513 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12515 (defun org-skip-over-state-notes ()
12516 "Skip past the list of State notes in an entry."
12518 (when (ignore-errors (goto-char (org-in-item-p)))
12519 (let* ((struct (org-list-struct))
12520 (prevs (org-list-prevs-alist struct)))
12522 (goto-char (or (org-list-get-next-item (point) struct prevs)
12523 (org-list-get-item-end (point) struct)))))))
12525 (defun org-add-log-note (&optional purpose)
12526 "Pop up a window for taking a note, and add this note later at point."
12527 (remove-hook 'post-command-hook 'org-add-log-note)
12528 (setq org-log-note-window-configuration (current-window-configuration))
12529 (delete-other-windows)
12530 (move-marker org-log-note-return-to (point))
12531 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12532 (goto-char org-log-note-marker)
12533 (org-switch-to-buffer-other-window "*Org Note*")
12534 (erase-buffer)
12535 (if (memq org-log-note-how '(time state))
12536 (let (current-prefix-arg) (org-store-log-note))
12537 (let ((org-inhibit-startup t)) (org-mode))
12538 (insert (format "# Insert note for %s.
12540 (cond
12541 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12542 ((eq org-log-note-purpose 'done) "closed todo item")
12543 ((eq org-log-note-purpose 'state)
12545 (or org-log-note-previous-state "")
12546 (or org-log-note-state "")))
12547 ((eq org-log-note-purpose 'reschedule)
12548 "rescheduling")
12549 ((eq org-log-note-purpose 'delschedule)
12550 "no longer scheduled")
12551 ((eq org-log-note-purpose 'redeadline)
12552 "changing deadline")
12553 ((eq org-log-note-purpose 'deldeadline)
12554 "removing deadline")
12555 ((eq org-log-note-purpose 'refile)
12556 "refiling")
12557 ((eq org-log-note-purpose 'note)
12558 "this entry")
12559 (t (error "This should not happen")))))
12560 (if org-log-note-extra (insert org-log-note-extra))
12561 (org-set-local 'org-finish-function 'org-store-log-note)
12562 (run-hooks 'org-log-buffer-setup-hook)))
12564 (defvar org-note-abort nil) ; dynamically scoped
12565 (defun org-store-log-note ()
12566 "Finish taking a log note, and insert it to where it belongs."
12567 (let ((txt (buffer-string))
12568 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12569 lines ind bul)
12570 (kill-buffer (current-buffer))
12572 (setq txt (replace-match "" t t txt)))
12574 (setq txt (replace-match "" t t txt)))
12577 (setq note
12578 (org-replace-escapes
12579 note
12580 (list (cons "%u" (user-login-name))
12581 (cons "%U" user-full-name)
12582 (cons "%t" (format-time-string
12583 (org-time-stamp-format 'long 'inactive)
12584 org-log-note-effective-time))
12585 (cons "%T" (format-time-string
12586 (org-time-stamp-format 'long nil)
12587 org-log-note-effective-time))
12588 (cons "%d" (format-time-string
12589 (org-time-stamp-format nil 'inactive)
12590 org-log-note-effective-time))
12591 (cons "%D" (format-time-string
12592 (org-time-stamp-format nil nil)
12593 org-log-note-effective-time))
12594 (cons "%s" (if org-log-note-state
12596 ""))
12597 (cons "%S" (if org-log-note-previous-state
12601 (push note lines))
12602 (when (or current-prefix-arg org-note-abort)
12603 (when org-log-into-drawer
12604 (org-remove-empty-drawer-at
12605 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12606 org-log-note-marker))
12607 (setq lines nil))
12608 (when lines
12609 (with-current-buffer (marker-buffer org-log-note-marker)
12610 (save-excursion
12611 (goto-char org-log-note-marker)
12612 (move-marker org-log-note-marker nil)
12613 (end-of-line 1)
12615 (setq ind (save-excursion
12616 (if (ignore-errors (goto-char (org-in-item-p)))
12617 (let ((struct (org-list-struct)))
12618 (org-list-get-ind
12619 (org-list-get-top-point struct) struct))
12621 (cond
12622 ((and (org-at-heading-p)
12623 org-adapt-indentation)
12624 (1+ (org-current-level)))
12625 ((org-at-heading-p) 0)
12626 (t (org-get-indentation))))))
12627 (setq bul (org-list-bullet-string "-"))
12628 (org-indent-line-to ind)
12629 (insert bul (pop lines))
12630 (let ((ind-body (+ (length bul) ind)))
12631 (while lines
12633 (org-indent-line-to ind-body)
12634 (insert (pop lines))))
12635 (message "Note stored")
12636 (org-back-to-heading t)
12637 (org-cycle-hide-drawers 'children)))))
12638 (set-window-configuration org-log-note-window-configuration)
12639 (with-current-buffer (marker-buffer org-log-note-return-to)
12640 (goto-char org-log-note-return-to))
12641 (move-marker org-log-note-return-to nil)
12642 (and org-log-post-message (message "%s" org-log-post-message)))
12644 (defun org-remove-empty-drawer-at (drawer pos)
12645 "Remove an empty drawer DRAWER at position POS.
12646 POS may also be a marker."
12647 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12648 (save-excursion
12649 (save-restriction
12650 (widen)
12651 (goto-char pos)
12652 (if (org-in-regexp
12654 (replace-match ""))))))
12656 (defvar org-ts-type nil)
12657 (defun org-sparse-tree (&optional arg type)
12658 "Create a sparse tree, prompt for the details.
12659 This command can create sparse trees. You first need to select the type
12660 of match used to create the tree:
12662 t Show all TODO entries.
12663 T Show entries with a specific TODO keyword.
12664 m Show entries selected by a tags/property match.
12665 p Enter a property name and its value (both with completion on existing
12666 names/values) and show entries with that property.
12667 r Show entries matching a regular expression (`/' can be used as well).
12668 b Show deadlines and scheduled items before a date.
12669 a Show deadlines and scheduled items after a date.
12670 d Show deadlines due within `org-deadline-warning-days'.
12671 D Show deadlines and scheduled items between a date range."
12672 (interactive "P")
12673 (let (ans kwd value ts-type)
12674 (setq type (or type org-sparse-tree-default-date-type))
12675 (setq org-ts-type type)
12676 (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"
12677 (cond ((eq type 'all) "all timestamps")
12678 ((eq type 'scheduled) "only scheduled")
12679 ((eq type 'deadline) "only deadline")
12680 ((eq type 'active) "only active timestamps")
12681 ((eq type 'inactive) "only inactive timestamps")
12682 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
12683 (t "scheduled/deadline")))
12684 (setq ans (read-char-exclusive))
12685 (cond
12686 ((equal ans ?c)
12687 (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
12688 ((equal ans ?d)
12689 (call-interactively 'org-check-deadlines))
12690 ((equal ans ?b)
12691 (call-interactively 'org-check-before-date))
12692 ((equal ans ?a)
12693 (call-interactively 'org-check-after-date))
12694 ((equal ans ?D)
12695 (call-interactively 'org-check-dates-range))
12696 ((equal ans ?t)
12697 (call-interactively 'org-show-todo-tree))
12698 ((equal ans ?T)
12699 (org-show-todo-tree '(4)))
12700 ((member ans '(?T ?m))
12701 (call-interactively 'org-match-sparse-tree))
12702 ((member ans '(?p ?P))
12703 (setq kwd (org-icompleting-read "Property: "
12704 (mapcar 'list (org-buffer-property-keys))))
12705 (setq value (org-icompleting-read "Value: "
12706 (mapcar 'list (org-property-values kwd))))
12709 (org-match-sparse-tree arg (concat kwd "=" value)))
12710 ((member ans '(?r ?R ?/))
12711 (call-interactively 'org-occur))
12714 (defvar org-occur-highlights nil
12715 "List of overlays used for occur matches.")
12716 (make-variable-buffer-local 'org-occur-highlights)
12717 (defvar org-occur-parameters nil
12718 "Parameters of the active org-occur calls.
12719 This is a list, each call to org-occur pushes as cons cell,
12720 containing the regular expression and the callback, onto the list.
12721 The list can contain several entries if `org-occur' has been called
12722 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12723 will only contain one set of parameters. When the highlights are
12724 removed (for example with `C-c C-c', or with the next edit (depending
12725 on `org-remove-highlights-with-change'), this variable is emptied
12726 as well.")
12727 (make-variable-buffer-local 'org-occur-parameters)
12729 (defun org-occur (regexp &optional keep-previous callback)
12730 "Make a compact tree which shows all matches of REGEXP.
12731 The tree will show the lines where the regexp matches, and all higher
12732 headlines above the match. It will also show the heading after the match,
12733 to make sure editing the matching entry is easy.
12734 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12735 call to `org-occur' will be kept, to allow stacking of calls to this
12736 command.
12737 If CALLBACK is non-nil, it is a function which is called to confirm
12738 that the match should indeed be shown."
12740 (when (equal regexp "")
12741 (error "Regexp cannot be empty"))
12742 (unless keep-previous
12743 (org-remove-occur-highlights nil nil t))
12744 (push (cons regexp callback) org-occur-parameters)
12745 (let ((cnt 0))
12746 (save-excursion
12747 (goto-char (point-min))
12748 (if (or (not keep-previous) ; do not want to keep
12749 (not org-occur-highlights)) ; no previous matches
12750 ;; hide everything
12751 (org-overview))
12752 (while (re-search-forward regexp nil t)
12753 (when (or (not callback)
12754 (save-match-data (funcall callback)))
12755 (setq cnt (1+ cnt))
12756 (when org-highlight-sparse-tree-matches
12757 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12758 (org-show-context 'occur-tree))))
12759 (when org-remove-highlights-with-change
12760 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12761 nil 'local))
12762 (unless org-sparse-tree-open-archived-trees
12763 (org-hide-archived-subtrees (point-min) (point-max)))
12764 (run-hooks 'org-occur-hook)
12765 (if (org-called-interactively-p 'interactive)
12766 (message "%d match(es) for regexp %s" cnt regexp))
12767 cnt))
12769 (defun org-occur-next-match (&optional n reset)
12770 "Function for `next-error-function' to find sparse tree matches.
12771 N is the number of matches to move, when negative move backwards.
12772 RESET is entirely ignored - this function always goes back to the
12773 starting point when no match is found."
12774 (let* ((limit (if (< n 0) (point-min) (point-max)))
12775 (search-func (if (< n 0)
12776 'previous-single-char-property-change
12777 'next-single-char-property-change))
12778 (n (abs n))
12779 (pos (point))
12780 p1)
12781 (catch 'exit
12782 (while (setq p1 (funcall search-func (point) 'org-type))
12783 (when (equal p1 limit)
12784 (goto-char pos)
12785 (error "No more matches"))
12786 (when (equal (get-char-property p1 'org-type) 'org-occur)
12787 (setq n (1- n))
12788 (when (= n 0)
12789 (goto-char p1)
12790 (throw 'exit (point))))
12791 (goto-char p1))
12792 (goto-char p1)
12793 (error "No more matches"))))
12795 (defun org-show-context (&optional key)
12796 "Make sure point and context are visible.
12797 How much context is shown depends upon the variables
12798 `org-show-hierarchy-above', `org-show-following-heading',
12799 `org-show-entry-below' and `org-show-siblings'."
12800 (let ((heading-p (org-at-heading-p t))
12801 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12802 (following-p (org-get-alist-option org-show-following-heading key))
12803 (entry-p (org-get-alist-option org-show-entry-below key))
12804 (siblings-p (org-get-alist-option org-show-siblings key)))
12805 (catch 'exit
12806 ;; Show heading or entry text
12807 (if (and heading-p (not entry-p))
12808 (org-flag-heading nil) ; only show the heading
12809 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12810 (org-show-hidden-entry))) ; show entire entry
12811 (when following-p
12812 ;; Show next sibling, or heading below text
12813 (save-excursion
12814 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12815 (org-flag-heading nil))))
12816 (when siblings-p (org-show-siblings))
12817 (when hierarchy-p
12818 ;; show all higher headings, possibly with siblings
12819 (save-excursion
12820 (while (and (condition-case nil
12821 (progn (org-up-heading-all 1) t)
12822 (error nil))
12823 (not (bobp)))
12824 (org-flag-heading nil)
12825 (when siblings-p (org-show-siblings))))))))
12827 (defvar org-reveal-start-hook nil
12828 "Hook run before revealing a location.")
12830 (defun org-reveal (&optional siblings)
12831 "Show current entry, hierarchy above it, and the following headline.
12832 This can be used to show a consistent set of context around locations
12833 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12834 not t for the search context.
12836 With optional argument SIBLINGS, on each level of the hierarchy all
12837 siblings are shown. This repairs the tree structure to what it would
12838 look like when opened with hierarchical calls to `org-cycle'.
12840 go to the parent and show the
12841 entire tree."
12842 (interactive "P")
12843 (run-hooks 'org-reveal-start-hook)
12844 (let ((org-show-hierarchy-above t)
12845 (org-show-following-heading t)
12846 (org-show-siblings (if siblings t org-show-siblings)))
12847 (org-show-context nil))
12848 (when (equal siblings '(16))
12849 (save-excursion
12850 (when (org-up-heading-safe)
12851 (org-show-subtree)
12852 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12854 (defun org-highlight-new-match (beg end)
12855 "Highlight from BEG to END and mark the highlight is an occur headline."
12856 (let ((ov (make-overlay beg end)))
12857 (overlay-put ov 'face 'secondary-selection)
12858 (overlay-put ov 'org-type 'org-occur)
12859 (push ov org-occur-highlights)))
12861 (defun org-remove-occur-highlights (&optional beg end noremove)
12862 "Remove the occur highlights from the buffer.
12863 BEG and END are ignored. If NOREMOVE is nil, remove this function
12864 from the `before-change-functions' in the current buffer."
12865 (interactive)
12866 (unless org-inhibit-highlight-removal
12867 (mapc 'delete-overlay org-occur-highlights)
12868 (setq org-occur-highlights nil)
12869 (setq org-occur-parameters nil)
12870 (unless noremove
12871 (remove-hook 'before-change-functions
12872 'org-remove-occur-highlights 'local))))
12874 ;;;; Priorities
12877 "Regular expression matching the priority indicator.")
12879 (defvar org-remove-priority-next-time nil)
12881 (defun org-priority-up ()
12882 "Increase the priority of the current item."
12883 (interactive)
12884 (org-priority 'up))
12886 (defun org-priority-down ()
12887 "Decrease the priority of the current item."
12888 (interactive)
12889 (org-priority 'down))
12891 (defun org-priority (&optional action show)
12892 "Change the priority of an item.
12893 ACTION can be `set', `up', `down', or a character."
12894 (interactive "P")
12895 (if (equal action '(4))
12896 (org-show-priority)
12897 (unless org-enable-priority-commands
12898 (error "Priority commands are disabled"))
12899 (setq action (or action 'set))
12900 (let (current new news have remove)
12901 (save-excursion
12902 (org-back-to-heading t)
12903 (if (looking-at org-priority-regexp)
12904 (setq current (string-to-char (match-string 2))
12905 have t))
12906 (cond
12907 ((eq action 'remove)
12908 (setq remove t new ?\ ))
12909 ((or (eq action 'set)
12910 (if (featurep 'xemacs) (characterp action) (integerp action)))
12911 (if (not (eq action 'set))
12912 (setq new action)
12913 (message "Priority %c-%c, SPC to remove: "
12914 org-highest-priority org-lowest-priority)
12915 (save-match-data
12916 (setq new (read-char-exclusive))))
12917 (if (and (= (upcase org-highest-priority) org-highest-priority)
12918 (= (upcase org-lowest-priority) org-lowest-priority))
12919 (setq new (upcase new)))
12920 (cond ((equal new ?\ ) (setq remove t))
12921 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12922 (error "Priority must be between `%c' and `%c'"
12923 org-highest-priority org-lowest-priority))))
12924 ((eq action 'up)
12925 (setq new (if have
12926 (1- current) ; normal cycling
12927 ;; last priority was empty
12928 (if (eq last-command this-command)
12929 org-lowest-priority ; wrap around empty to lowest
12930 ;; default
12931 (if org-priority-start-cycle-with-default
12932 org-default-priority
12933 (1- org-default-priority))))))
12934 ((eq action 'down)
12935 (setq new (if have
12936 (1+ current) ; normal cycling
12937 ;; last priority was empty
12938 (if (eq last-command this-command)
12939 org-highest-priority ; wrap around empty to highest
12940 ;; default
12941 (if org-priority-start-cycle-with-default
12942 org-default-priority
12943 (1+ org-default-priority))))))
12944 (t (error "Invalid action")))
12945 (if (or (< (upcase new) org-highest-priority)
12946 (> (upcase new) org-lowest-priority))
12947 (if (and (memq action '(up down))
12948 (not have) (not (eq last-command this-command)))
12949 ;; `new' is from default priority
12950 (error
12951 "The default can not be set, see `org-default-priority' why")
12952 ;; normal cycling: `new' is beyond highest/lowest priority
12953 ;; and is wrapped around to the empty priority
12954 (setq remove t)))
12955 (setq news (format "%c" new))
12956 (if have
12957 (if remove
12958 (replace-match "" t t nil 1)
12959 (replace-match news t t nil 2))
12960 (if remove
12961 (error "No priority cookie found in line")
12962 (let ((case-fold-search nil))
12963 (looking-at org-todo-line-regexp))
12964 (if (match-end 2)
12965 (progn
12966 (goto-char (match-end 2))
12967 (insert " [#" news "]"))
12968 (goto-char (match-beginning 3))
12969 (insert "[#" news "] "))))
12970 (org-preserve-lc (org-set-tags nil 'align)))
12971 (if remove
12972 (message "Priority removed")
12973 (message "Priority of current item set to %s" news)))))
12975 (defun org-show-priority ()
12976 "Show the priority of the current item.
12977 This priority is composed of the main priority given with the [#A] cookies,
12978 and by additional input from the age of a schedules or deadline entry."
12979 (interactive)
12980 (let ((pri (if (eq major-mode 'org-agenda-mode)
12981 (org-get-at-bol 'priority)
12982 (save-excursion
12983 (save-match-data
12984 (beginning-of-line)
12985 (and (looking-at org-heading-regexp)
12986 (org-get-priority (match-string 0))))))))
12987 (message "Priority is %d" (if pri pri -1000))))
12989 (defun org-get-priority (s)
12990 "Find priority cookie and return priority."
12991 (if (functionp org-get-priority-function)
12992 (funcall org-get-priority-function)
12993 (save-match-data
12994 (if (not (string-match org-priority-regexp s))
12995 (* 1000 (- org-lowest-priority org-default-priority))
12996 (* 1000 (- org-lowest-priority
12997 (string-to-char (match-string 2 s))))))))
12999 ;;;; Tags
13001 (defvar org-agenda-archives-mode)
13002 (defvar org-map-continue-from nil
13003 "Position from where mapping should continue.
13004 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13006 (defvar org-scanner-tags nil
13007 "The current tag list while the tags scanner is running.")
13008 (defvar org-trust-scanner-tags nil
13009 "Should `org-get-tags-at' use the tags for the scanner.
13010 This is for internal dynamical scoping only.
13011 When this is non-nil, the function `org-get-tags-at' will return the value
13012 of `org-scanner-tags' instead of building the list by itself. This
13013 can lead to large speed-ups when the tags scanner is used in a file with
13014 many entries, and when the list of tags is retrieved, for example to
13015 obtain a list of properties. Building the tags list for each entry in such
13016 a file becomes an N^2 operation - but with this variable set, it scales
13017 as N.")
13019 (defun org-scan-tags (action matcher todo-only &optional start-level)
13020 "Scan headline tags with inheritance and produce output ACTION.
13022 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13023 or `agenda' to produce an entry list for an agenda view. It can also be
13024 a Lisp form or a function that should be called at each matched headline, in
13025 this case the return value is a list of all return values from these calls.
13027 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13028 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13029 only lines with a not-done TODO keyword are included in the output.
13030 This should be the same variable that was scoped into
13031 and set by `org-make-tags-matcher' when it constructed MATCHER.
13033 START-LEVEL can be a string with asterisks, reducing the scope to
13034 headlines matching this string."
13035 (require 'org-agenda)
13036 (let* ((re (concat "^"
13037 (if start-level
13038 ;; Get the correct level to match
13040 org-outline-regexp)
13044 (props (list 'face 'default
13045 'done-face 'org-agenda-done
13046 'undone-face 'default
13047 'mouse-face 'highlight
13048 'org-not-done-regexp org-not-done-regexp
13049 'org-todo-regexp org-todo-regexp
13050 'org-complex-heading-regexp org-complex-heading-regexp
13051 'help-echo
13052 (format "mouse-2 or RET jump to org file %s"
13053 (abbreviate-file-name
13054 (or (buffer-file-name (buffer-base-buffer))
13055 (buffer-name (buffer-base-buffer)))))))
13056 (case-fold-search nil)
13057 (org-map-continue-from nil)
13058 lspos tags tags-list
13059 (tags-alist (list (cons 0 org-file-tags)))
13060 (llast 0) rtn rtn1 level category i txt
13061 todo marker entry priority)
13062 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13063 (setq action (list 'lambda nil action)))
13064 (save-excursion
13065 (goto-char (point-min))
13066 (when (eq action 'sparse-tree)
13067 (org-overview)
13068 (org-remove-occur-highlights))
13069 (while (re-search-forward re nil t)
13070 (setq org-map-continue-from nil)
13071 (catch :skip
13072 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13073 tags (if (match-end 4) (org-match-string-no-properties 4)))
13074 (goto-char (setq lspos (match-beginning 0)))
13075 (setq level (org-reduced-level (funcall outline-level))
13076 category (org-get-category))
13077 (setq i llast llast level)
13078 ;; remove tag lists from same and sublevels
13079 (while (>= i level)
13080 (when (setq entry (assoc i tags-alist))
13081 (setq tags-alist (delete entry tags-alist)))
13082 (setq i (1- i)))
13083 ;; add the next tags
13084 (when tags
13085 (setq tags (org-split-string tags ":")
13086 tags-alist
13087 (cons (cons level tags) tags-alist)))
13088 ;; compile tags for current headline
13089 (setq tags-list
13090 (if org-use-tag-inheritance
13091 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13092 tags)
13093 org-scanner-tags tags-list)
13094 (when org-use-tag-inheritance
13095 (setcdr (car tags-alist)
13096 (mapcar (lambda (x)
13097 (setq x (copy-sequence x))
13098 (org-add-prop-inherited x))
13099 (cdar tags-alist))))
13100 (when (and tags org-use-tag-inheritance
13101 (or (not (eq t org-use-tag-inheritance))
13102 org-tags-exclude-from-inheritance))
13103 ;; selective inheritance, remove uninherited ones
13104 (setcdr (car tags-alist)
13105 (org-remove-uninherited-tags (cdar tags-alist))))
13106 (when (and
13108 ;; eval matcher only when the todo condition is OK
13109 (and (or (not todo-only) (member todo org-not-done-keywords))
13110 (let ((case-fold-search t) (org-trust-scanner-tags t))
13111 (eval matcher)))
13113 ;; Call the skipper, but return t if it does not skip,
13114 ;; so that the `and' form continues evaluating
13115 (progn
13116 (unless (eq action 'sparse-tree) (org-agenda-skip))
13117 t)
13119 ;; Check if timestamps are deselecting this entry
13120 (or (not todo-only)
13121 (and (member todo org-not-done-keywords)
13122 (or (not org-agenda-tags-todo-honor-ignore-options)
13123 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
13125 ;; Extra check for the archive tag
13126 ;; FIXME: Does the skipper already do this????
13127 (or
13128 (not (member org-archive-tag tags-list))
13129 ;; we have an archive tag, should we use this anyway?
13130 (or (not org-agenda-skip-archived-trees)
13131 (and (eq action 'agenda) org-agenda-archives-mode))))
13133 ;; select this headline
13135 (cond
13136 ((eq action 'sparse-tree)
13137 (and org-highlight-sparse-tree-matches
13138 (org-get-heading) (match-end 0)
13139 (org-highlight-new-match
13140 (match-beginning 1) (match-end 1)))
13141 (org-show-context 'tags-tree))
13142 ((eq action 'agenda)
13143 (setq txt (org-agenda-format-item
13144 ""
13145 (concat
13146 (if (eq org-tags-match-list-sublevels 'indented)
13147 (make-string (1- level) ?.) "")
13148 (org-get-heading))
13149 category
13150 tags-list)
13151 priority (org-get-priority txt))
13152 (goto-char lspos)
13153 (setq marker (org-agenda-new-marker))
13154 (org-add-props txt props
13155 'org-marker marker 'org-hd-marker marker 'org-category category
13156 'todo-state todo
13157 'priority priority 'type "tagsmatch")
13158 (push txt rtn))
13159 ((functionp action)
13160 (setq org-map-continue-from nil)
13161 (save-excursion
13162 (setq rtn1 (funcall action))
13163 (push rtn1 rtn)))
13164 (t (error "Invalid action")))
13166 ;; if we are to skip sublevels, jump to end of subtree
13167 (unless org-tags-match-list-sublevels
13168 (org-end-of-subtree t)
13169 (backward-char 1))))
13170 ;; Get the correct position from where to continue
13171 (if org-map-continue-from
13172 (goto-char org-map-continue-from)
13173 (and (= (point) lspos) (end-of-line 1)))))
13174 (when (and (eq action 'sparse-tree)
13175 (not org-sparse-tree-open-archived-trees))
13176 (org-hide-archived-subtrees (point-min) (point-max)))
13177 (nreverse rtn)))
13179 (defun org-remove-uninherited-tags (tags)
13180 "Remove all tags that are not inherited from the list TAGS."
13181 (cond
13182 ((eq org-use-tag-inheritance t)
13183 (if org-tags-exclude-from-inheritance
13184 (org-delete-all org-tags-exclude-from-inheritance tags)
13185 tags))
13186 ((not org-use-tag-inheritance) nil)
13187 ((stringp org-use-tag-inheritance)
13188 (delq nil (mapcar
13189 (lambda (x)
13190 (if (and (string-match org-use-tag-inheritance x)
13191 (not (member x org-tags-exclude-from-inheritance)))
13192 x nil))
13193 tags)))
13194 ((listp org-use-tag-inheritance)
13195 (delq nil (mapcar
13196 (lambda (x)
13197 (if (member x org-use-tag-inheritance) x nil))
13198 tags)))))
13200 (defun org-match-sparse-tree (&optional todo-only match)
13201 "Create a sparse tree according to tags string MATCH.
13202 MATCH can contain positive and negative selection of tags, like
13204 If optional argument TODO-ONLY is non-nil, only select lines that are
13205 also TODO lines."
13206 (interactive "P")
13207 (org-agenda-prepare-buffers (list (current-buffer)))
13208 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13210 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13212 (defvar org-cached-props nil)
13213 (defun org-cached-entry-get (pom property)
13214 (if (or (eq t org-use-property-inheritance)
13215 (and (stringp org-use-property-inheritance)
13216 (string-match org-use-property-inheritance property))
13217 (and (listp org-use-property-inheritance)
13218 (member property org-use-property-inheritance)))
13219 ;; Caching is not possible, check it directly
13220 (org-entry-get pom property 'inherit)
13221 ;; Get all properties, so that we can do complicated checks easily
13222 (cdr (assoc property (or org-cached-props
13223 (setq org-cached-props
13224 (org-entry-properties pom)))))))
13226 (defun org-global-tags-completion-table (&optional files)
13227 "Return the list of all tags in all agenda buffer/files.
13228 Optional FILES argument is a list of files which can be used
13229 instead of the agenda files."
13230 (save-excursion
13231 (org-uniquify
13232 (delq nil
13233 (apply 'append
13234 (mapcar
13235 (lambda (file)
13236 (set-buffer (find-file-noselect file))
13237 (append (org-get-buffer-tags)
13238 (mapcar (lambda (x) (if (stringp (car-safe x))
13239 (list (car-safe x)) nil))
13240 org-tag-alist)))
13241 (if (and files (car files))
13242 files
13243 (org-agenda-files))))))))
13245 (defun org-make-tags-matcher (match)
13246 "Create the TAGS/TODO matcher form for the selection string MATCH.
13248 The variable `todo-only' is scoped dynamically into this function.
13249 It will be set to t if the matcher restricts matching to TODO entries,
13250 otherwise will not be touched.
13252 Returns a cons of the selection string MATCH and the constructed
13253 lisp form implementing the matcher. The matcher is to be evaluated
13254 at an Org entry, with point on the headline, and returns t if the
13255 entry matches the selection string MATCH. The returned lisp form
13256 references two variables with information about the entry, which
13257 must be bound around the form's evaluation: todo, the TODO keyword
13258 at the entry (or nil of none); and tags-list, the list of all tags
13259 at the entry including inherited ones. Additionally, the category
13260 of the entry (if any) must be specified as the text property
13261 'org-category on the headline.
13263 See also `org-scan-tags'.
13264 "
13265 (declare (special todo-only))
13266 (unless (boundp 'todo-only)
13267 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13268 (unless match
13269 ;; Get a new match request, with completion
13270 (let ((org-last-tags-completion-table
13271 (org-global-tags-completion-table)))
13272 (setq match (org-completing-read-no-i
13273 "Match: " 'org-tags-completion-function nil nil nil
13274 'org-tags-history))))
13276 ;; Parse the string and create a lisp form
13277 (let ((match0 match)
13278 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13279 minus tag mm
13280 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13281 orterms term orlist re-p str-p level-p level-op time-p
13282 prop-p pn pv po gv rest)
13283 (if (string-match "/+" match)
13284 ;; match contains also a todo-matching request
13285 (progn
13286 (setq tagsmatch (substring match 0 (match-beginning 0))
13287 todomatch (substring match (match-end 0)))
13288 (if (string-match "^!" todomatch)
13289 (setq todo-only t todomatch (substring todomatch 1)))
13291 (setq todomatch nil)))
13292 ;; only matching tags
13293 (setq tagsmatch match todomatch nil))
13295 ;; Make the tags matcher
13297 (setq tagsmatcher t)
13298 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13299 (while (setq term (pop orterms))
13301 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13302 (while (string-match re term)
13303 (setq rest (substring term (match-end 0))
13304 minus (and (match-end 1)
13305 (equal (match-string 1 term) "-"))
13306 tag (save-match-data (replace-regexp-in-string
13308 (match-string 2 term)))
13309 re-p (equal (string-to-char tag) ?{)
13310 level-p (match-end 4)
13311 prop-p (match-end 5)
13312 mm (cond
13313 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13314 (level-p
13315 (setq level-op (org-op-to-function (match-string 3 term)))
13316 `(,level-op level ,(string-to-number
13317 (match-string 4 term))))
13318 (prop-p
13319 (setq pn (match-string 5 term)
13320 po (match-string 6 term)
13321 pv (match-string 7 term)
13322 re-p (equal (string-to-char pv) ?{)
13324 time-p (save-match-data
13326 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13327 (if time-p (setq pv (org-matcher-time pv)))
13328 (setq po (org-op-to-function po (if time-p 'time str-p)))
13329 (cond
13330 ((equal pn "CATEGORY")
13331 (setq gv '(get-text-property (point) 'org-category)))
13332 ((equal pn "TODO")
13333 (setq gv 'todo))
13334 (t
13335 (setq gv `(org-cached-entry-get nil ,pn))))
13336 (if re-p
13337 (if (eq po 'org<>)
13338 `(not (string-match ,pv (or ,gv "")))
13339 `(string-match ,pv (or ,gv "")))
13340 (if str-p
13341 `(,po (or ,gv "") ,pv)
13342 `(,po (string-to-number (or ,gv ""))
13343 ,(string-to-number pv) ))))
13344 (t `(member ,tag tags-list)))
13345 mm (if minus (list 'not mm) mm)
13346 term rest)
13347 (push mm tagsmatcher))
13348 (push (if (> (length tagsmatcher) 1)
13349 (cons 'and tagsmatcher)
13350 (car tagsmatcher))
13351 orlist)
13352 (setq tagsmatcher nil))
13353 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13354 (setq tagsmatcher
13355 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13356 ;; Make the todo matcher
13358 (setq todomatcher t)
13359 (setq orterms (org-split-string todomatch "|") orlist nil)
13360 (while (setq term (pop orterms))
13361 (while (string-match re term)
13362 (setq minus (and (match-end 1)
13363 (equal (match-string 1 term) "-"))
13364 kwd (match-string 2 term)
13365 re-p (equal (string-to-char kwd) ?{)
13366 term (substring term (match-end 0))
13367 mm (if re-p
13368 `(string-match ,(substring kwd 1 -1) todo)
13369 (list 'equal 'todo kwd))
13370 mm (if minus (list 'not mm) mm))
13371 (push mm todomatcher))
13372 (push (if (> (length todomatcher) 1)
13373 (cons 'and todomatcher)
13374 (car todomatcher))
13375 orlist)
13376 (setq todomatcher nil))
13377 (setq todomatcher (if (> (length orlist) 1)
13378 (cons 'or orlist) (car orlist))))
13380 ;; Return the string and lisp forms of the matcher
13381 (setq matcher (if todomatcher
13382 (list 'and tagsmatcher todomatcher)
13383 tagsmatcher))
13384 (when todo-only
13385 (setq matcher (list 'and '(member todo org-not-done-keywords)
13386 matcher)))
13387 (cons match0 matcher)))
13389 (defun org-op-to-function (op &optional stringp)
13390 "Turn an operator into the appropriate function."
13391 (setq op
13392 (cond
13393 ((equal op "<" ) '(< string< org-time<))
13394 ((equal op ">" ) '(> org-string> org-time>))
13395 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13396 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13397 ((member op '("=" "==")) '(= string= org-time=))
13398 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13399 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13401 (defun org<> (a b) (not (= a b)))
13402 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13403 (defun org-string>= (a b) (not (string< a b)))
13404 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13405 (defun org-string<> (a b) (not (string= a b)))
13406 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13407 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13408 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13409 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13410 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13411 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13412 (defun org-2ft (s)
13413 "Convert S to a floating point time.
13414 If S is already a number, just return it. If it is a string, parse
13415 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13416 (cond
13417 ((numberp s) s)
13418 ((stringp s)
13419 (condition-case nil
13420 (float-time (apply 'encode-time (org-parse-time-string s)))
13421 (error 0.)))
13422 (t 0.)))
13424 (defun org-time-today ()
13425 "Time in seconds today at 0:00.
13426 Returns the float number of seconds since the beginning of the
13427 epoch to the beginning of today (00:00)."
13428 (float-time (apply 'encode-time
13429 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13431 (defun org-matcher-time (s)
13432 "Interpret a time comparison value."
13433 (save-match-data
13434 (cond
13435 ((string= s "<now>") (float-time))
13436 ((string= s "<today>") (org-time-today))
13437 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13438 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13440 (+ (org-time-today)
13441 (* (string-to-number (match-string 1 s))
13442 (cdr (assoc (match-string 2 s)
13443 '(("d" . 86400.0) ("w" . 604800.0)
13444 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13445 (t (org-2ft s)))))
13447 (defun org-match-any-p (re list)
13448 "Does re match any element of list?"
13449 (setq list (mapcar (lambda (x) (string-match re x)) list))
13450 (delq nil list))
13452 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13453 (defvar org-tags-overlay (make-overlay 1 1))
13454 (org-detach-overlay org-tags-overlay)
13456 (defun org-get-local-tags-at (&optional pos)
13457 "Get a list of tags defined in the current headline."
13458 (org-get-tags-at pos 'local))
13460 (defun org-get-local-tags ()
13461 "Get a list of tags defined in the current headline."
13462 (org-get-tags-at nil 'local))
13464 (defun org-get-tags-at (&optional pos local)
13465 "Get a list of all headline tags applicable at POS.
13466 POS defaults to point. If tags are inherited, the list contains
13467 the targets in the same sequence as the headlines appear, i.e.
13468 the tags of the current headline come last.
13469 When LOCAL is non-nil, only return tags from the current headline,
13470 ignore inherited ones."
13471 (interactive)
13472 (if (and org-trust-scanner-tags
13473 (or (not pos) (equal pos (point)))
13474 (not local))
13475 org-scanner-tags
13476 (let (tags ltags lastpos parent)
13477 (save-excursion
13478 (save-restriction
13479 (widen)
13480 (goto-char (or pos (point)))
13481 (save-match-data
13482 (catch 'done
13483 (condition-case nil
13484 (progn
13485 (org-back-to-heading t)
13486 (while (not (equal lastpos (point)))
13487 (setq lastpos (point))
13488 (when (looking-at
13490 (setq ltags (org-split-string
13491 (org-match-string-no-properties 1) ":"))
13492 (when parent
13493 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13494 (setq tags (append
13495 (if parent
13496 (org-remove-uninherited-tags ltags)
13497 ltags)
13498 tags)))
13499 (or org-use-tag-inheritance (throw 'done t))
13500 (if local (throw 'done t))
13501 (or (org-up-heading-safe) (error nil))
13502 (setq parent t)))
13503 (error nil)))))
13504 (if local
13505 tags
13506 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13508 (defun org-add-prop-inherited (s)
13509 (add-text-properties 0 (length s) '(inherited t) s)
13510 s)
13512 (defun org-toggle-tag (tag &optional onoff)
13513 "Toggle the tag TAG for the current line.
13514 If ONOFF is `on' or `off', don't toggle but set to this state."
13515 (let (res current)
13516 (save-excursion
13517 (org-back-to-heading t)
13519 (point-at-eol) t)
13520 (progn
13521 (setq current (match-string 1))
13522 (replace-match ""))
13523 (setq current ""))
13524 (setq current (nreverse (org-split-string current ":")))
13525 (cond
13526 ((eq onoff 'on)
13527 (setq res t)
13528 (or (member tag current) (push tag current)))
13529 ((eq onoff 'off)
13530 (or (not (member tag current)) (setq current (delete tag current))))
13531 (t (if (member tag current)
13532 (setq current (delete tag current))
13533 (setq res t)
13534 (push tag current))))
13535 (end-of-line 1)
13536 (if current
13537 (progn
13538 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13539 (org-set-tags nil t))
13540 (delete-horizontal-space))
13541 (run-hooks 'org-after-tags-change-hook))
13542 res))
13544 (defun org-align-tags-here (to-col)
13545 ;; Assumes that this is a headline
13546 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13547 (beginning-of-line 1)
13549 (< pos (match-beginning 2)))
13550 (progn
13551 (setq tags-l (- (match-end 2) (match-beginning 2)))
13552 (goto-char (match-beginning 1))
13553 (insert " ")
13554 (delete-region (point) (1+ (match-beginning 2)))
13555 (setq ncol (max (current-column)
13556 (1+ col)
13557 (if (> to-col 0)
13558 to-col
13559 (- (abs to-col) tags-l))))
13560 (setq p (point))
13561 (insert (make-string (- ncol (current-column)) ?\ ))
13562 (setq ncol (current-column))
13563 (when indent-tabs-mode (tabify p (point-at-eol)))
13564 (org-move-to-column (min ncol col) t))
13565 (goto-char pos))))
13567 (defun org-set-tags-command (&optional arg just-align)
13568 "Call the set-tags command for the current entry."
13569 (interactive "P")
13570 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13571 (org-set-tags arg just-align)
13572 (save-excursion
13573 (org-back-to-heading t)
13574 (org-set-tags arg just-align))))
13576 (defun org-set-tags-to (data)
13577 "Set the tags of the current entry to DATA, replacing the current tags.
13578 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13579 If DATA is nil or the empty string, any tags will be removed."
13580 (interactive "sTags: ")
13581 (setq data
13582 (cond
13583 ((eq data nil) "")
13584 ((equal data "") "")
13585 ((stringp data)
13586 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13587 ":"))
13588 ((listp data)
13589 (concat ":" (mapconcat 'identity data ":") ":"))))
13590 (when data
13591 (save-excursion
13592 (org-back-to-heading t)
13593 (when (looking-at org-complex-heading-regexp)
13594 (if (match-end 5)
13595 (progn
13596 (goto-char (match-beginning 5))
13597 (insert data)
13598 (delete-region (point) (point-at-eol))
13599 (org-set-tags nil 'align))
13600 (goto-char (point-at-eol))
13601 (insert " " data)
13602 (org-set-tags nil 'align)))
13603 (beginning-of-line 1)
13605 (delete-region (match-beginning 1) (match-end 1))))))
13607 (defun org-align-all-tags ()
13608 "Align the tags i all headings."
13609 (interactive)
13610 (save-excursion
13611 (or (ignore-errors (org-back-to-heading t))
13612 (outline-next-heading))
13613 (if (org-at-heading-p)
13614 (org-set-tags t)
13615 (message "No headings"))))
13617 (defvar org-indent-indentation-per-level)
13618 (defun org-set-tags (&optional arg just-align)
13619 "Set the tags for the current headline.
13620 With prefix ARG, realign all tags in headings in the current buffer."
13621 (interactive "P")
13622 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13623 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13624 'region-start-level 'region))
13625 org-loop-over-headlines-in-active-region)
13626 (org-map-entries
13627 ;; We don't use ARG and JUST-ALIGN here these args are not
13628 ;; useful when looping over headlines
13629 `(org-set-tags)
13630 org-loop-over-headlines-in-active-region
13631 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13632 (let* ((re org-outline-regexp-bol)
13633 (current (unless arg (org-get-tags-string)))
13634 (col (current-column))
13635 (org-setting-tags t)
13636 table current-tags inherited-tags ; computed below when needed
13637 tags p0 c0 c1 rpl di tc level)
13638 (if arg
13639 (save-excursion
13640 (goto-char (point-min))
13641 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13642 (while (re-search-forward re nil t)
13643 (org-set-tags nil t)
13644 (end-of-line 1)))
13645 (message "All tags realigned to column %d" org-tags-column))
13646 (if just-align
13647 (setq tags current)
13648 ;; Get a new set of tags from the user
13649 (save-excursion
13650 (setq table (append org-tag-persistent-alist
13651 (or org-tag-alist (org-get-buffer-tags))
13652 (and
13653 org-complete-tags-always-offer-all-agenda-tags
13654 (org-global-tags-completion-table
13655 (org-agenda-files))))
13656 org-last-tags-completion-table table
13657 current-tags (org-split-string current ":")
13658 inherited-tags (nreverse
13659 (nthcdr (length current-tags)
13660 (nreverse (org-get-tags-at))))
13661 tags
13662 (if (or (eq t org-use-fast-tag-selection)
13663 (and org-use-fast-tag-selection
13664 (delq nil (mapcar 'cdr table))))
13665 (org-fast-tag-selection
13666 current-tags inherited-tags table
13667 (if org-fast-tag-selection-include-todo
13668 org-todo-key-alist))
13669 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13670 (org-trim
13671 (org-icompleting-read "Tags: "
13672 'org-tags-completion-function
13673 nil nil current 'org-tags-history))))))
13674 (while (string-match "[-+&]+" tags)
13675 ;; No boolean logic, just a list
13676 (setq tags (replace-match ":" t t tags))))
13678 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13680 (if org-tags-sort-function
13681 (setq tags (mapconcat 'identity
13682 (sort (org-split-string
13683 tags (org-re "[^[:alnum:]_@#%]+"))
13684 org-tags-sort-function) ":")))
13687 (setq tags "")
13688 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13689 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13691 ;; Insert new tags at the correct column
13692 (beginning-of-line 1)
13693 (setq level (or (and (looking-at org-outline-regexp)
13694 (- (match-end 0) (point) 1))
13695 1))
13696 (cond
13697 ((and (equal current "") (equal tags "")))
13698 ((re-search-forward
13700 (point-at-eol) t)
13701 (if (equal tags "")
13702 (setq rpl "")
13703 (goto-char (match-beginning 0))
13704 (setq c0 (current-column)
13705 ;; compute offset for the case of org-indent-mode active
13706 di (if org-indent-mode
13707 (* (1- org-indent-indentation-per-level) (1- level))
13708 0)
13709 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13710 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13711 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13712 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13713 (replace-match rpl t t)
13714 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13715 tags)
13716 (t (error "Tags alignment failed")))
13717 (org-move-to-column col)
13718 (unless just-align
13719 (run-hooks 'org-after-tags-change-hook))))))
13721 (defun org-change-tag-in-region (beg end tag off)
13722 "Add or remove TAG for each entry in the region.
13723 This works in the agenda, and also in an org-mode buffer."
13724 (interactive
13725 (list (region-beginning) (region-end)
13726 (let ((org-last-tags-completion-table
13727 (if (derived-mode-p 'org-mode)
13728 (org-get-buffer-tags)
13729 (org-global-tags-completion-table))))
13730 (org-icompleting-read
13731 "Tag: " 'org-tags-completion-function nil nil nil
13732 'org-tags-history))
13733 (progn
13735 (equal (read-char-exclusive) ?r))))
13736 (if (fboundp 'deactivate-mark) (deactivate-mark))
13737 (let ((agendap (equal major-mode 'org-agenda-mode))
13738 l1 l2 m buf pos newhead (cnt 0))
13739 (goto-char end)
13740 (setq l2 (1- (org-current-line)))
13741 (goto-char beg)
13742 (setq l1 (org-current-line))
13743 (loop for l from l1 to l2 do
13744 (org-goto-line l)
13745 (setq m (get-text-property (point) 'org-hd-marker))
13746 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
13747 (and agendap m))
13748 (setq buf (if agendap (marker-buffer m) (current-buffer))
13749 pos (if agendap m (point)))
13750 (with-current-buffer buf
13751 (save-excursion
13752 (save-restriction
13753 (goto-char pos)
13754 (setq cnt (1+ cnt))
13755 (org-toggle-tag tag (if off 'off 'on))
13756 (setq newhead (org-get-heading)))))
13757 (and agendap (org-agenda-change-all-lines newhead m))))
13758 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13760 (defun org-tags-completion-function (string predicate &optional flag)
13761 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13762 (confirm (lambda (x) (stringp (car x)))))
13764 (setq s1 (match-string 1 string)
13765 s2 (match-string 2 string))
13766 (setq s1 "" s2 string))
13767 (cond
13768 ((eq flag nil)
13769 ;; try completion
13770 (setq rtn (try-completion s2 ctable confirm))
13771 (if (stringp rtn)
13772 (setq rtn
13773 (concat s1 s2 (substring rtn (length s2))
13774 (if (and org-add-colon-after-tag-completion
13775 (assoc rtn ctable))
13776 ":" ""))))
13777 rtn)
13778 ((eq flag t)
13779 ;; all-completions
13780 (all-completions s2 ctable confirm)
13781 )
13782 ((eq flag 'lambda)
13783 ;; exact match?
13784 (assoc s2 ctable)))
13785 ))
13787 (defun org-fast-tag-insert (kwd tags face &optional end)
13788 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13789 (insert (format "%-12s" (concat kwd ":"))
13790 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13791 (or end "")))
13793 (defun org-fast-tag-show-exit (flag)
13794 (save-excursion
13795 (org-goto-line 3)
13797 (replace-match ""))
13798 (when flag
13799 (end-of-line 1)
13800 (org-move-to-column (- (window-width) 19) t)
13801 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13803 (defun org-set-current-tags-overlay (current prefix)
13804 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13805 (if (featurep 'xemacs)
13806 (org-overlay-display org-tags-overlay (concat prefix s)
13807 'secondary-selection)
13808 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13809 (org-overlay-display org-tags-overlay (concat prefix s)))))
13811 (defvar org-last-tag-selection-key nil)
13812 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13813 "Fast tag selection with single keys.
13814 CURRENT is the current list of tags in the headline, INHERITED is the
13815 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13816 possibly with grouping information. TODO-TABLE is a similar table with
13817 TODO keywords, should these have keys assigned to them.
13818 If the keys are nil, a-z are automatically assigned.
13819 Returns the new tags string, or nil to not change the current settings."
13820 (let* ((fulltable (append table todo-table))
13821 (maxlen (apply 'max (mapcar
13822 (lambda (x)
13823 (if (stringp (car x)) (string-width (car x)) 0))
13824 fulltable)))
13825 (buf (current-buffer))
13826 (expert (eq org-fast-tag-selection-single-key 'expert))
13827 (buffer-tags nil)
13828 (fwidth (+ maxlen 3 1 3))
13829 (ncol (/ (- (window-width) 4) fwidth))
13830 (i-face 'org-done)
13831 (c-face 'org-todo)
13832 tg cnt e c char c1 c2 ntable tbl rtn
13833 ov-start ov-end ov-prefix
13834 (exit-after-next org-fast-tag-selection-single-key)
13835 (done-keywords org-done-keywords)
13836 groups ingroup)
13837 (save-excursion
13838 (beginning-of-line 1)
13839 (if (looking-at
13841 (setq ov-start (match-beginning 1)
13842 ov-end (match-end 1)
13843 ov-prefix "")
13844 (setq ov-start (1- (point-at-eol))
13845 ov-end (1+ ov-start))
13847 (setq ov-prefix
13848 (concat
13849 (buffer-substring (1- (point)) (point))
13850 (if (> (current-column) org-tags-column)
13851 " "
13852 (make-string (- org-tags-column (current-column)) ?\ ))))))
13853 (move-overlay org-tags-overlay ov-start ov-end)
13854 (save-window-excursion
13855 (if expert
13856 (set-buffer (get-buffer-create " *Org tags*"))
13857 (delete-other-windows)
13858 (split-window-vertically)
13859 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13860 (erase-buffer)
13861 (org-set-local 'org-done-keywords done-keywords)
13864 (org-fast-tag-show-exit exit-after-next)
13865 (org-set-current-tags-overlay current ov-prefix)
13866 (setq tbl fulltable char ?a cnt 0)
13867 (while (setq e (pop tbl))
13868 (cond
13869 ((equal (car e) :startgroup)
13870 (push '() groups) (setq ingroup t)
13871 (when (not (= cnt 0))
13872 (setq cnt 0)
13874 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13875 ((equal (car e) :endgroup)
13876 (setq ingroup nil cnt 0)
13878 ((equal e '(:newline))
13879 (when (not (= cnt 0))
13880 (setq cnt 0)
13882 (setq e (car tbl))
13883 (while (equal (car tbl) '(:newline))
13885 (setq tbl (cdr tbl)))))
13886 (t
13887 (setq tg (copy-sequence (car e)) c2 nil)
13888 (if (cdr e)
13889 (setq c (cdr e))
13890 ;; automatically assign a character.
13891 (setq c1 (string-to-char
13892 (downcase (substring
13893 tg (if (= (string-to-char tg) ?@) 1 0)))))
13894 (if (or (rassoc c1 ntable) (rassoc c1 table))
13895 (while (or (rassoc char ntable) (rassoc char table))
13896 (setq char (1+ char)))
13897 (setq c2 c1))
13898 (setq c (or c2 char)))
13899 (if ingroup (push tg (car groups)))
13900 (setq tg (org-add-props tg nil 'face
13901 (cond
13902 ((not (assoc tg table))
13903 (org-get-todo-face tg))
13904 ((member tg current) c-face)
13905 ((member tg inherited) i-face))))
13906 (if (and (= cnt 0) (not ingroup)) (insert " "))
13907 (insert "[" c "] " tg (make-string
13908 (- fwidth 4 (length tg)) ?\ ))
13909 (push (cons tg c) ntable)
13910 (when (= (setq cnt (1+ cnt)) ncol)
13912 (if ingroup (insert " "))
13913 (setq cnt 0)))))
13914 (setq ntable (nreverse ntable))
13916 (goto-char (point-min))
13917 (if (not expert) (org-fit-window-to-buffer))
13918 (setq rtn
13919 (catch 'exit
13920 (while t
13921 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13922 (if (not groups) "no " "")
13923 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13924 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13925 (setq org-last-tag-selection-key c)
13926 (cond
13928 ((= c ?!)
13929 (setq groups (not groups))
13930 (goto-char (point-min))
13931 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13932 ((= c ?\C-c)
13933 (if (not expert)
13934 (org-fast-tag-show-exit
13935 (setq exit-after-next (not exit-after-next)))
13936 (setq expert nil)
13937 (delete-other-windows)
13938 (set-window-buffer (split-window-vertically) " *Org tags*")
13939 (org-switch-to-buffer-other-window " *Org tags*")
13940 (org-fit-window-to-buffer)))
13941 ((or (= c ?\C-g)
13942 (and (= c ?q) (not (rassoc c ntable))))
13943 (org-detach-overlay org-tags-overlay)
13944 (setq quit-flag t))
13945 ((= c ?\ )
13946 (setq current nil)
13947 (if exit-after-next (setq exit-after-next 'now)))
13949 (condition-case nil
13950 (setq tg (org-icompleting-read
13951 "Tag: "
13952 (or buffer-tags
13953 (with-current-buffer buf
13954 (org-get-buffer-tags)))))
13955 (quit (setq tg "")))
13957 (add-to-list 'buffer-tags (list tg))
13958 (if (member tg current)
13959 (setq current (delete tg current))
13960 (push tg current)))
13961 (if exit-after-next (setq exit-after-next 'now)))
13962 ((setq e (rassoc c todo-table) tg (car e))
13963 (with-current-buffer buf
13964 (save-excursion (org-todo tg)))
13965 (if exit-after-next (setq exit-after-next 'now)))
13966 ((setq e (rassoc c ntable) tg (car e))
13967 (if (member tg current)
13968 (setq current (delete tg current))
13969 (loop for g in groups do
13970 (if (member tg g)
13971 (mapc (lambda (x)
13972 (setq current (delete x current)))
13973 g)))
13974 (push tg current))
13975 (if exit-after-next (setq exit-after-next 'now))))
13977 ;; Create a sorted list
13978 (setq current
13979 (sort current
13980 (lambda (a b)
13981 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13982 (if (eq exit-after-next 'now) (throw 'exit t))
13983 (goto-char (point-min))
13984 (beginning-of-line 2)
13985 (delete-region (point) (point-at-eol))
13986 (org-fast-tag-insert "Current" current c-face)
13987 (org-set-current-tags-overlay current ov-prefix)
13988 (while (re-search-forward
13990 (setq tg (match-string 1))
13991 (add-text-properties
13992 (match-beginning 1) (match-end 1)
13993 (list 'face
13994 (cond
13995 ((member tg current) c-face)
13996 ((member tg inherited) i-face)
13997 (t (get-text-property (match-beginning 1) 'face))))))
13998 (goto-char (point-min)))))
13999 (org-detach-overlay org-tags-overlay)
14000 (if rtn
14001 (mapconcat 'identity current ":")
14002 nil))))
14004 (defun org-get-tags-string ()
14005 "Get the TAGS string in the current headline."
14006 (unless (org-at-heading-p t)
14007 (error "Not on a heading"))
14008 (save-excursion
14009 (beginning-of-line 1)
14011 (org-match-string-no-properties 1)
14012 "")))
14014 (defun org-get-tags ()
14015 "Get the list of tags specified in the current headline."
14016 (org-split-string (org-get-tags-string) ":"))
14018 (defun org-get-buffer-tags ()
14019 "Get a table of all tags used in the buffer, for completion."
14020 (let (tags)
14021 (save-excursion
14022 (goto-char (point-min))
14023 (while (re-search-forward
14025 (when (equal (char-after (point-at-bol 0)) ?*)
14026 (mapc (lambda (x) (add-to-list 'tags x))
14027 (org-split-string (org-match-string-no-properties 1) ":")))))
14028 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14029 (mapcar 'list tags)))
14031 ;;;; The mapping API
14033 (defun org-map-entries (func &optional match scope &rest skip)
14034 "Call FUNC at each headline selected by MATCH in SCOPE.
14036 FUNC is a function or a lisp form. The function will be called without
14037 arguments, with the cursor positioned at the beginning of the headline.
14038 The return values of all calls to the function will be collected and
14039 returned as a list.
14041 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14042 does not need to preserve point. After evaluation, the cursor will be
14043 moved to the end of the line (presumably of the headline of the
14044 processed entry) and search continues from there. Under some
14045 circumstances, this may not produce the wanted results. For example,
14046 if you have removed (e.g. archived) the current (sub)tree it could
14047 mean that the next entry will be skipped entirely. In such cases, you
14048 can specify the position from where search should continue by making
14049 FUNC set the variable `org-map-continue-from' to the desired buffer
14050 position.
14052 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14053 Only headlines that are matched by this query will be considered during
14054 the iteration. When MATCH is nil or t, all headlines will be
14055 visited by the iteration.
14057 SCOPE determines the scope of this command. It can be any of:
14059 nil The current buffer, respecting the restriction if any
14060 tree The subtree started with the entry at point
14061 region The entries within the active region, if any
14062 region-start-level
14063 The entries within the active region, but only those at
14064 the same level than the first one.
14065 file The current buffer, without restriction
14066 file-with-archives
14067 The current buffer, and any archives associated with it
14068 agenda All agenda files
14069 agenda-with-archives
14070 All agenda files with any archive files associated with them
14071 \(file1 file2 ...)
14072 If this is a list, all files in the list will be scanned
14074 The remaining args are treated as settings for the skipping facilities of
14075 the scanner. The following items can be given here:
14077 archive skip trees with the archive tag.
14078 comment skip trees with the COMMENT keyword
14079 function or Emacs Lisp form:
14080 will be used as value for `org-agenda-skip-function', so whenever
14081 the function returns t, FUNC will not be called for that
14082 entry and search will continue from the point where the
14083 function leaves it.
14085 If your function needs to retrieve the tags including inherited tags
14086 at the *current* entry, you can use the value of the variable
14087 `org-scanner-tags' which will be much faster than getting the value
14088 with `org-get-tags-at'. If your function gets properties with
14089 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14090 to t around the call to `org-entry-properties' to get the same speedup.
14091 Note that if your function moves around to retrieve tags and properties at
14092 a *different* entry, you cannot use these techniques."
14093 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14094 (not (org-region-active-p)))
14095 (let* ((org-agenda-archives-mode nil) ; just to make sure
14096 (org-agenda-skip-archived-trees (memq 'archive skip))
14097 (org-agenda-skip-comment-trees (memq 'comment skip))
14098 (org-agenda-skip-function
14099 (car (org-delete-all '(comment archive) skip)))
14100 (org-tags-match-list-sublevels t)
14101 (start-level (eq scope 'region-start-level))
14102 matcher file res
14103 org-todo-keywords-for-agenda
14104 org-done-keywords-for-agenda
14105 org-todo-keyword-alist-for-agenda
14106 org-drawers-for-agenda
14107 org-tag-alist-for-agenda
14108 todo-only)
14110 (cond
14111 ((eq match t) (setq matcher t))
14112 ((eq match nil) (setq matcher t))
14113 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14115 (save-excursion
14116 (save-restriction
14117 (cond ((eq scope 'tree)
14118 (org-back-to-heading t)
14119 (org-narrow-to-subtree)
14120 (setq scope nil))
14121 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14122 (org-region-active-p))
14123 ;; If needed, set start-level to a string like "2"
14124 (when start-level
14125 (save-excursion
14126 (goto-char (region-beginning))
14127 (unless (org-at-heading-p) (outline-next-heading))
14128 (setq start-level (org-current-level))))
14129 (narrow-to-region (region-beginning)
14130 (save-excursion
14131 (goto-char (region-end))
14132 (unless (and (bolp) (org-at-heading-p))
14133 (outline-next-heading))
14134 (point)))
14135 (setq scope nil)))
14137 (if (not scope)
14138 (progn
14139 (org-agenda-prepare-buffers
14140 (list (buffer-file-name (current-buffer))))
14141 (setq res (org-scan-tags func matcher todo-only start-level)))
14142 ;; Get the right scope
14143 (cond
14144 ((and scope (listp scope) (symbolp (car scope)))
14145 (setq scope (eval scope)))
14146 ((eq scope 'agenda)
14147 (setq scope (org-agenda-files t)))
14148 ((eq scope 'agenda-with-archives)
14149 (setq scope (org-agenda-files t))
14150 (setq scope (org-add-archive-files scope)))
14151 ((eq scope 'file)
14152 (setq scope (list (buffer-file-name))))
14153 ((eq scope 'file-with-archives)
14154 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14155 (org-agenda-prepare-buffers scope)
14156 (while (setq file (pop scope))
14157 (with-current-buffer (org-find-base-buffer-visiting file)
14158 (save-excursion
14159 (save-restriction
14160 (widen)
14161 (goto-char (point-min))
14162 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14163 res)))
14165 ;;;; Properties
14167 ;;; Setting and retrieving properties
14169 (defconst org-special-properties
14170 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14171 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14172 "The special properties valid in Org-mode.
14174 These are properties that are not defined in the property drawer,
14175 but in some other way.")
14177 (defconst org-default-properties
14178 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14179 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14180 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14181 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14182 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14183 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14184 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14185 "Some properties that are used by Org-mode for various purposes.
14186 Being in this list makes sure that they are offered for completion.")
14189 "Regular expression matching the first line of a property drawer.")
14192 "Regular expression matching the last line of a property drawer.")
14195 "Regular expression matching the first line of a property drawer.")
14198 "Regular expression matching the first line of a property drawer.")
14200 (defconst org-property-drawer-re
14203 "Matches an entire property drawer.")
14205 (defconst org-clock-drawer-re
14208 "Matches an entire clock drawer.")
14210 (defsubst org-re-property (property)
14211 "Return a regexp matching a PROPERTY line.
14212 Match group 1 will be set to the value."
14215 (defsubst org-re-property-keyword (property)
14216 "Return a regexp matching a PROPERTY line, possibly with no
14217 value for the property."
14220 (defun org-property-action ()
14221 "Do an action on properties."
14222 (interactive)
14223 (let (c)
14224 (org-at-property-p)
14225 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14226 (setq c (read-char-exclusive))
14227 (cond
14228 ((equal c ?s)
14229 (call-interactively 'org-set-property))
14230 ((equal c ?d)
14231 (call-interactively 'org-delete-property))
14232 ((equal c ?D)
14233 (call-interactively 'org-delete-property-globally))
14234 ((equal c ?c)
14235 (call-interactively 'org-compute-property-at-point))
14236 (t (error "No such property action %c" c)))))
14238 (defun org-inc-effort ()
14239 "Increment the value of the effort property in the current entry."
14240 (interactive)
14241 (org-set-effort nil t))
14243 (defun org-set-effort (&optional value increment)
14244 "Set the effort property of the current entry.
14245 With numerical prefix arg, use the nth allowed value, 0 stands for the
14246 10th allowed value.
14248 When INCREMENT is non-nil, set the property to the next allowed value."
14249 (interactive "P")
14250 (if (equal value 0) (setq value 10))
14251 (let* ((completion-ignore-case t)
14252 (prop org-effort-property)
14253 (cur (org-entry-get nil prop))
14254 (allowed (org-property-get-allowed-values nil prop 'table))
14255 (existing (mapcar 'list (org-property-values prop)))
14256 rpl
14257 (val (cond
14258 ((stringp value) value)
14259 ((and allowed (integerp value))
14260 (or (car (nth (1- value) allowed))
14261 (car (org-last allowed))))
14262 ((and allowed increment)
14263 (or (caadr (member (list cur) allowed))
14264 (error "Allowed effort values are not set")))
14265 (allowed
14266 (message "Select 1-9,0, [RET%s]: %s"
14267 (if cur (concat "=" cur) "")
14268 (mapconcat 'car allowed " "))
14269 (setq rpl (read-char-exclusive))
14271 cur
14272 (setq rpl (- rpl ?0))
14273 (if (equal rpl 0) (setq rpl 10))
14274 (if (and (> rpl 0) (<= rpl (length allowed)))
14275 (car (nth (1- rpl) allowed))
14276 (org-completing-read "Effort: " allowed nil))))
14277 (t
14278 (let (org-completion-use-ido org-completion-use-iswitchb)
14279 (org-completing-read
14281 (concat "[" cur "]") "")
14282 ": ")
14283 existing nil nil "" nil cur))))))
14284 (unless (equal (org-entry-get nil prop) val)
14285 (org-entry-put nil prop val))
14286 (message "%s is now %s" prop val)))
14288 (defun org-at-property-p ()
14289 "Is cursor inside a property drawer?"
14290 (save-excursion
14291 (beginning-of-line 1)
14293 (save-match-data ;; Used by calling procedures
14294 (let ((p (point))
14295 (range (unless (org-before-first-heading-p)
14296 (org-get-property-block))))
14297 (and range (<= (car range) p) (< p (cdr range))))))))
14299 (defun org-get-property-block (&optional beg end force)
14300 "Return the (beg . end) range of the body of the property drawer.
14301 BEG and END are the beginning and end of the current subtree, or of
14302 the part before the first headline. If they are not given, they will
14303 be found. If the drawer does not exist and FORCE is non-nil, create
14304 the drawer."
14305 (catch 'exit
14306 (save-excursion
14307 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
14308 (progn (org-back-to-heading t) (point))))
14309 (end (or end (and (not (outline-next-heading)) (point-max))
14310 (point))))
14311 (goto-char beg)
14312 (if (re-search-forward org-property-start-re end t)
14313 (setq beg (1+ (match-end 0)))
14314 (if force
14315 (save-excursion
14316 (org-insert-property-drawer)
14317 (setq end (progn (outline-next-heading) (point))))
14318 (throw 'exit nil))
14319 (goto-char beg)
14320 (if (re-search-forward org-property-start-re end t)
14321 (setq beg (1+ (match-end 0)))))
14322 (if (re-search-forward org-property-end-re end t)
14323 (setq end (match-beginning 0))
14324 (or force (throw 'exit nil))
14325 (goto-char beg)
14326 (setq end beg)
14327 (org-indent-line)
14329 (cons beg end)))))
14331 (defun org-entry-properties (&optional pom which specific)
14332 "Get all properties of the entry at point-or-marker POM.
14333 This includes the TODO keyword, the tags, time strings for deadline,
14334 scheduled, and clocking, and any additional properties defined in the
14335 entry. The return value is an alist, keys may occur multiple times
14336 if the property key was used several times.
14337 POM may also be nil, in which case the current entry is used.
14338 If WHICH is nil or `all', get all properties. If WHICH is
14339 `special' or `standard', only get that subclass. If WHICH
14340 is a string only get exactly this property. SPECIFIC can be a string, the
14341 specific property we are interested in. Specifying it can speed
14342 things up because then unnecessary parsing is avoided."
14343 (setq which (or which 'all))
14344 (org-with-point-at pom
14345 (let ((clockstr (substring org-clock-string 0 -1))
14346 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14347 (case-fold-search nil)
14348 beg end range props sum-props key key1 value string clocksum clocksumt)
14349 (save-excursion
14350 (when (condition-case nil
14351 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14352 (error nil))
14353 (setq beg (point))
14354 (setq sum-props (get-text-property (point) 'org-summaries))
14355 (setq clocksum (get-text-property (point) :org-clock-minutes)
14356 clocksumt (get-text-property (point) :org-clock-minutes-today))
14357 (outline-next-heading)
14358 (setq end (point))
14359 (when (memq which '(all special))
14360 ;; Get the special properties, like TODO and tags
14361 (goto-char beg)
14362 (when (and (or (not specific) (string= specific "TODO"))
14363 (looking-at org-todo-line-regexp) (match-end 2))
14364 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14365 (when (and (or (not specific) (string= specific "PRIORITY"))
14366 (looking-at org-priority-regexp))
14367 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14368 (when (or (not specific) (string= specific "FILE"))
14369 (push (cons "FILE" buffer-file-name) props))
14370 (when (and (or (not specific) (string= specific "TAGS"))
14371 (setq value (org-get-tags-string))
14373 (push (cons "TAGS" value) props))
14374 (when (and (or (not specific) (string= specific "ALLTAGS"))
14375 (setq value (org-get-tags-at)))
14376 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14377 ":"))
14378 props))
14379 (when (or (not specific) (string= specific "BLOCKED"))
14380 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14381 (when (or (not specific)
14382 (member specific
14383 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14384 "TIMESTAMP" "TIMESTAMP_IA")))
14385 (catch 'match
14386 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14387 (setq key (if (match-end 1)
14388 (substring (org-match-string-no-properties 1)
14389 0 -1))
14390 string (if (equal key clockstr)
14391 (org-trim
14392 (buffer-substring-no-properties
14393 (match-beginning 3) (goto-char
14394 (point-at-eol))))
14395 (substring (org-match-string-no-properties 3)
14396 1 -1)))
14397 ;; Get the correct property name from the key. This is
14398 ;; necessary if the user has configured time keywords.
14399 (setq key1 (concat key ":"))
14400 (cond
14401 ((not key)
14402 (setq key
14403 (if (= (char-after (match-beginning 3)) ?\[)
14404 "TIMESTAMP_IA" "TIMESTAMP")))
14405 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14406 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14407 ((equal key1 org-closed-string) (setq key "CLOSED"))
14408 ((equal key1 org-clock-string) (setq key "CLOCK")))
14409 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14410 (progn
14411 (push (cons key string) props)
14412 ;; no need to search further if match is found
14413 (throw 'match t))
14414 (when (or (equal key "CLOCK") (not (assoc key props)))
14415 (push (cons key string) props)))))))
14417 (when (memq which '(all standard))
14418 ;; Get the standard properties, like :PROP: ...
14419 (setq range (org-get-property-block beg end))
14420 (when range
14421 (goto-char (car range))
14422 (while (re-search-forward
14424 (cdr range) t)
14425 (setq key (org-match-string-no-properties 1)
14426 value (org-trim (or (org-match-string-no-properties 2) "")))
14427 (unless (member key excluded)
14428 (push (cons key (or value "")) props)))))
14429 (if clocksum
14430 (push (cons "CLOCKSUM"
14431 (org-columns-number-to-string (/ (float clocksum) 60.)
14432 'add_times))
14433 props))
14434 (if clocksumt
14435 (push (cons "CLOCKSUM_T"
14436 (org-columns-number-to-string (/ (float clocksumt) 60.)
14437 'add_times))
14438 props))
14439 (unless (assoc "CATEGORY" props)
14440 (push (cons "CATEGORY" (org-get-category)) props))
14441 (append sum-props (nreverse props)))))))
14443 (defun org-entry-get (pom property &optional inherit literal-nil)
14444 "Get value of PROPERTY for entry or content at point-or-marker POM.
14445 If INHERIT is non-nil and the entry does not have the property,
14446 then also check higher levels of the hierarchy.
14447 If INHERIT is the symbol `selective', use inheritance only if the setting
14448 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14449 If the property is present but empty, the return value is the empty string.
14450 If the property is not present at all, nil is returned.
14453 do not interpret it as the list atom nil. This is used for inheritance
14455 (org-with-point-at pom
14456 (if (and inherit (if (eq inherit 'selective)
14457 (org-property-inherit-p property)
14458 t))
14459 (org-entry-get-with-inheritance property literal-nil)
14460 (if (member property org-special-properties)
14461 ;; We need a special property. Use `org-entry-properties' to
14462 ;; retrieve it, but specify the wanted property
14463 (cdr (assoc property (org-entry-properties nil 'special property)))
14464 (let* ((range (org-get-property-block))
14465 (props (list (or (assoc property org-file-properties)
14466 (assoc property org-global-properties)
14467 (assoc property org-global-properties-fixed))))
14468 (ap (lambda (key)
14469 (when (re-search-forward
14470 (org-re-property key) (cdr range) t)
14471 (setq props
14472 (org-update-property-plist
14473 key
14474 (if (match-end 1)
14475 (org-match-string-no-properties 1) "")
14476 props)))))
14477 val)
14478 (when (and range (goto-char (car range)))
14479 (funcall ap property)
14480 (goto-char (car range))
14481 (while (funcall ap (concat property "+")))
14482 (setq val (cdr (assoc property props)))
14483 (when val (if literal-nil val (org-not-nil val)))))))))
14485 (defun org-property-or-variable-value (var &optional inherit)
14486 "Check if there is a property fixing the value of VAR.
14487 If yes, return this value. If not, return the current value of the variable."
14488 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14490 (read prop)
14491 (symbol-value var))))
14493 (defun org-entry-delete (pom property)
14494 "Delete the property PROPERTY from entry at point-or-marker POM."
14495 (org-with-point-at pom
14496 (if (member property org-special-properties)
14497 nil ; cannot delete these properties.
14498 (let ((range (org-get-property-block)))
14499 (if (and range
14500 (goto-char (car range))
14501 (re-search-forward
14502 (org-re-property property)
14503 (cdr range) t))
14504 (progn
14505 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14506 t)
14507 nil)))))
14509 ;; Multi-values properties are properties that contain multiple values
14510 ;; These values are assumed to be single words, separated by whitespace.
14511 (defun org-entry-add-to-multivalued-property (pom property value)
14512 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14513 (let* ((old (org-entry-get pom property))
14515 (setq value (org-entry-protect-space value))
14516 (unless (member value values)
14517 (setq values (cons value values))
14518 (org-entry-put pom property
14519 (mapconcat 'identity values " ")))))
14521 (defun org-entry-remove-from-multivalued-property (pom property value)
14522 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14523 (let* ((old (org-entry-get pom property))
14525 (setq value (org-entry-protect-space value))
14526 (when (member value values)
14527 (setq values (delete value values))
14528 (org-entry-put pom property
14529 (mapconcat 'identity values " ")))))
14531 (defun org-entry-member-in-multivalued-property (pom property value)
14532 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14533 (let* ((old (org-entry-get pom property))
14535 (setq value (org-entry-protect-space value))
14536 (member value values)))
14538 (defun org-entry-get-multivalued-property (pom property)
14539 "Return a list of values in a multivalued property."
14540 (let* ((value (org-entry-get pom property))
14542 (mapcar 'org-entry-restore-space values)))
14544 (defun org-entry-put-multivalued-property (pom property &rest values)
14545 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14546 VALUES should be a list of strings. Spaces will be protected."
14547 (org-entry-put pom property
14548 (mapconcat 'org-entry-protect-space values " "))
14549 (let* ((value (org-entry-get pom property))
14551 (mapcar 'org-entry-restore-space values)))
14553 (defun org-entry-protect-space (s)
14554 "Protect spaces and newline in string S."
14555 (while (string-match " " s)
14556 (setq s (replace-match "%20" t t s)))
14558 (setq s (replace-match "%0A" t t s)))
14559 s)
14561 (defun org-entry-restore-space (s)
14562 "Restore spaces and newline in string S."
14563 (while (string-match "%20" s)
14564 (setq s (replace-match " " t t s)))
14565 (while (string-match "%0A" s)
14567 s)
14569 (defvar org-entry-property-inherited-from (make-marker)
14570 "Marker pointing to the entry from where a property was inherited.
14571 Each call to `org-entry-get-with-inheritance' will set this marker to the
14572 location of the entry where the inheritance search matched. If there was
14573 no match, the marker will point nowhere.
14574 Note that also `org-entry-get' calls this function, if the INHERIT flag
14575 is set.")
14577 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14578 "Get PROPERTY of entry or content at point, search higher levels if needed.
14579 The search will stop at the first ancestor which has the property defined.
14581 should be considered as undefined (this is the meaning of nil here).
14583 (move-marker org-entry-property-inherited-from nil)
14584 (let (tmp)
14585 (save-excursion
14586 (save-restriction
14587 (widen)
14588 (catch 'ex
14589 (while t
14590 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14591 (or (ignore-errors (org-back-to-heading t))
14592 (goto-char (point-min)))
14593 (move-marker org-entry-property-inherited-from (point))
14594 (throw 'ex tmp))
14595 (or (ignore-errors (org-up-heading-safe))
14596 (throw 'ex nil))))))
14597 (setq tmp (or tmp
14598 (cdr (assoc property org-file-properties))
14599 (cdr (assoc property org-global-properties))
14600 (cdr (assoc property org-global-properties-fixed))))
14601 (if literal-nil tmp (org-not-nil tmp))))
14603 (defvar org-property-changed-functions nil
14604 "Hook called when the value of a property has changed.
14605 Each hook function should accept two arguments, the name of the property
14606 and the new value.")
14608 (defun org-entry-put (pom property value)
14609 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14610 (org-with-point-at pom
14611 (org-back-to-heading t)
14612 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14613 range)
14614 (cond
14615 ((equal property "TODO")
14617 (not (member value org-todo-keywords-1)))
14619 (if (or (not value)
14621 (setq value 'none))
14622 (org-todo value)
14623 (org-set-tags nil 'align))
14624 ((equal property "PRIORITY")
14626 (string-to-char value) ?\ ))
14627 (org-set-tags nil 'align))
14628 ((equal property "SCHEDULED")
14629 (if (re-search-forward org-scheduled-time-regexp end t)
14630 (cond
14631 ((eq value 'earlier) (org-timestamp-change -1 'day))
14632 ((eq value 'later) (org-timestamp-change 1 'day))
14633 (t (call-interactively 'org-schedule)))
14634 (call-interactively 'org-schedule)))
14635 ((equal property "DEADLINE")
14636 (if (re-search-forward org-deadline-time-regexp end t)
14637 (cond
14638 ((eq value 'earlier) (org-timestamp-change -1 'day))
14639 ((eq value 'later) (org-timestamp-change 1 'day))
14640 (t (call-interactively 'org-deadline)))
14641 (call-interactively 'org-deadline)))
14642 ((member property org-special-properties)
14643 (error "The %s property can not yet be set with `org-entry-put'"
14644 property))
14645 (t ; a non-special property
14646 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14647 (setq range (org-get-property-block beg end 'force))
14648 (goto-char (car range))
14649 (if (re-search-forward
14650 (org-re-property-keyword property) (cdr range) t)
14651 (progn
14652 (delete-region (match-beginning 0) (match-end 0))
14653 (goto-char (match-beginning 0)))
14654 (goto-char (cdr range))
14656 (backward-char 1)
14657 (org-indent-line))
14658 (insert ":" property ":")
14659 (and value (insert " " value))
14660 (org-indent-line)))))
14661 (run-hook-with-args 'org-property-changed-functions property value)))
14663 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14664 "Get all property keys in the current buffer.
14665 With INCLUDE-SPECIALS, also list the special properties that reflect things
14666 like tags and TODO state.
14667 With INCLUDE-DEFAULTS, also include properties that has special meaning
14668 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14669 and others.
14670 With INCLUDE-COLUMNS, also include property names given in COLUMN
14671 formats in the current buffer."
14672 (let (rtn range cfmt s p)
14673 (save-excursion
14674 (save-restriction
14675 (widen)
14676 (goto-char (point-min))
14677 (while (re-search-forward org-property-start-re nil t)
14678 (setq range (org-get-property-block))
14679 (goto-char (car range))
14680 (while (re-search-forward
14682 (cdr range) t)
14683 (add-to-list 'rtn (org-match-string-no-properties 1)))
14684 (outline-next-heading))))
14686 (when include-specials
14687 (setq rtn (append org-special-properties rtn)))
14689 (when include-defaults
14690 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14691 (add-to-list 'rtn org-effort-property))
14693 (when include-columns
14694 (save-excursion
14695 (save-restriction
14696 (widen)
14697 (goto-char (point-min))
14698 (while (re-search-forward
14700 nil t)
14701 (setq cfmt (match-string 2) s 0)
14703 cfmt s)
14704 (setq s (match-end 0)
14705 p (match-string 1 cfmt))
14706 (unless (or (equal p "ITEM")
14707 (member p org-special-properties))
14708 (add-to-list 'rtn (match-string 1 cfmt))))))))
14710 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14712 (defun org-property-values (key)
14713 "Return a list of all values of property KEY in the current buffer."
14714 (save-excursion
14715 (save-restriction
14716 (widen)
14717 (goto-char (point-min))
14718 (let ((re (org-re-property key))
14719 values)
14720 (while (re-search-forward re nil t)
14721 (add-to-list 'values (org-trim (match-string 1))))
14722 (delete "" values)))))
14724 (defun org-insert-property-drawer ()
14725 "Insert a property drawer into the current entry."
14726 (org-back-to-heading t)
14727 (looking-at org-outline-regexp)
14728 (let ((indent (if org-adapt-indentation
14729 (- (match-end 0) (match-beginning 0))
14730 0))
14731 (beg (point))
14733 end hiddenp)
14734 (outline-next-heading)
14735 (setq end (point))
14736 (goto-char beg)
14737 (while (re-search-forward re end t))
14738 (setq hiddenp (outline-invisible-p))
14739 (end-of-line 1)
14742 (if (member (match-string 1) '("CLOCK:" ":END:"))
14743 ;; just skip this line
14744 (beginning-of-line 2)
14745 ;; Drawer start, find the end
14747 (beginning-of-line 1)))
14748 (org-skip-over-state-notes)
14750 (if (eq (char-before) ?*) (forward-char 1))
14752 (beginning-of-line 0)
14753 (org-indent-to-column indent)
14754 (beginning-of-line 2)
14755 (org-indent-to-column indent)
14756 (beginning-of-line 0)
14757 (if hiddenp
14758 (save-excursion
14759 (org-back-to-heading t)
14760 (hide-entry))
14761 (org-flag-drawer t))))
14763 (defun org-insert-drawer (&optional arg drawer)
14764 "Insert a drawer at point.
14766 Optional argument DRAWER, when non-nil, is a string representing
14767 drawer's name. Otherwise, the user is prompted for a name.
14769 If a region is active, insert the drawer around that region
14770 instead.
14772 Point is left between drawer's boundaries."
14773 (interactive "P")
14774 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14775 "LOGBOOK"))
14776 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14777 ;; internally by Org. They are meant to be inserted
14778 ;; automatically.
14779 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14780 ;; Remove system drawers from list. Note: For some reason,
14781 ;; `org-completing-read' ignores the predicate while
14782 ;; `completing-read' handles it fine.
14783 (drawer (if arg "PROPERTIES"
14784 (or drawer
14785 (completing-read
14786 "Drawer: " org-drawers
14787 (lambda (d) (not (member d system-drawers))))))))
14788 (cond
14789 ;; With C-u, fall back on `org-insert-property-drawer'
14790 (arg (org-insert-property-drawer))
14791 ;; With an active region, insert a drawer at point.
14792 ((not (org-region-active-p))
14793 (progn
14796 (forward-line -2)))
14797 ;; Otherwise, insert the drawer at point
14798 (t
14799 (let ((rbeg (region-beginning))
14800 (rend (copy-marker (region-end))))
14801 (unwind-protect
14802 (progn
14803 (goto-char rbeg)
14804 (beginning-of-line)
14805 (when (save-excursion
14806 (re-search-forward org-outline-regexp-bol rend t))
14807 (error "Drawers cannot contain headlines"))
14808 ;; Position point at the beginning of the first
14809 ;; non-blank line in region. Insert drawer's opening
14810 ;; there, then indent it.
14811 (org-skip-whitespace)
14812 (beginning-of-line)
14814 (forward-line -1)
14815 (indent-for-tab-command)
14816 ;; Move point to the beginning of the first blank line
14817 ;; after the last non-blank line in region. Insert
14818 ;; drawer's closing, then indent it.
14819 (goto-char rend)
14822 (deactivate-mark t)
14823 (indent-for-tab-command)
14825 ;; Clear marker, whatever the outcome of insertion is.
14826 (set-marker rend nil)))))))
14828 (defvar org-property-set-functions-alist nil
14829 "Property set function alist.
14830 Each entry should have the following format:
14832 (PROPERTY . READ-FUNCTION)
14834 The read function will be called with the same argument as
14835 `org-completing-read'.")
14837 (defun org-set-property-function (property)
14838 "Get the function that should be used to set PROPERTY.
14839 This is computed according to `org-property-set-functions-alist'."
14840 (or (cdr (assoc property org-property-set-functions-alist))
14841 'org-completing-read))
14843 (defun org-read-property-value (property)
14844 "Read PROPERTY value from user."
14845 (let* ((completion-ignore-case t)
14846 (allowed (org-property-get-allowed-values nil property 'table))
14847 (cur (org-entry-get nil property))
14848 (prompt (concat property " value"
14850 (concat " [" cur "]") "") ": "))
14851 (set-function (org-set-property-function property))
14852 (val (if allowed
14853 (funcall set-function prompt allowed nil
14854 (not (get-text-property 0 'org-unrestricted
14855 (caar allowed))))
14856 (let (org-completion-use-ido org-completion-use-iswitchb)
14857 (funcall set-function prompt
14858 (mapcar 'list (org-property-values property))
14859 nil nil "" nil cur)))))
14860 (if (equal val "")
14861 cur
14862 val)))
14864 (defvar org-last-set-property nil)
14865 (defun org-read-property-name ()
14866 "Read a property name."
14867 (let* ((completion-ignore-case t)
14868 (keys (org-buffer-property-keys nil t t))
14869 (default-prop (or (save-excursion
14870 (save-match-data
14871 (beginning-of-line)
14873 (null (string= (match-string 1) "END"))
14874 (match-string 1))))
14875 org-last-set-property))
14876 (property (org-icompleting-read
14877 (concat "Property"
14878 (if default-prop (concat " [" default-prop "]") "")
14879 ": ")
14880 (mapcar 'list keys)
14881 nil nil nil nil
14882 default-prop
14883 )))
14884 (if (member property keys)
14885 property
14886 (or (cdr (assoc (downcase property)
14887 (mapcar (lambda (x) (cons (downcase x) x))
14888 keys)))
14889 property))))
14891 (defun org-set-property (property value)
14892 "In the current entry, set PROPERTY to VALUE.
14893 When called interactively, this will prompt for a property name, offering
14894 completion on existing and default properties. And then it will prompt
14895 for a value, offering completion either on allowed values (via an inherited
14896 xxx_ALL property) or on existing values in other instances of this property
14897 in the current file."
14898 (interactive (list nil nil))
14899 (let* ((property (or property (org-read-property-name)))
14900 (value (or value (org-read-property-value property)))
14901 (fn (cdr (assoc property org-properties-postprocess-alist))))
14902 (setq org-last-set-property property)
14903 ;; Possibly postprocess the inserted value:
14904 (when fn (setq value (funcall fn value)))
14905 (unless (equal (org-entry-get nil property) value)
14906 (org-entry-put nil property value))))
14908 (defun org-delete-property (property)
14909 "In the current entry, delete PROPERTY."
14910 (interactive
14911 (let* ((completion-ignore-case t)
14912 (prop (org-icompleting-read "Property: "
14913 (org-entry-properties nil 'standard))))
14914 (list prop)))
14915 (message "Property %s %s" property
14916 (if (org-entry-delete nil property)
14917 "deleted"
14918 "was not present in the entry")))
14920 (defun org-delete-property-globally (property)
14921 "Remove PROPERTY globally, from all entries."
14922 (interactive
14923 (let* ((completion-ignore-case t)
14924 (prop (org-icompleting-read
14925 "Globally remove property: "
14926 (mapcar 'list (org-buffer-property-keys)))))
14927 (list prop)))
14928 (save-excursion
14929 (save-restriction
14930 (widen)
14931 (goto-char (point-min))
14932 (let ((cnt 0))
14933 (while (re-search-forward
14934 (org-re-property property)
14935 nil t)
14936 (setq cnt (1+ cnt))
14937 (delete-region (match-beginning 0) (1+ (point-at-eol))))
14940 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14942 (defun org-compute-property-at-point ()
14943 "Compute the property at point.
14944 This looks for an enclosing column format, extracts the operator and
14945 then applies it to the property in the column format's scope."
14946 (interactive)
14947 (unless (org-at-property-p)
14948 (error "Not at a property"))
14949 (let ((prop (org-match-string-no-properties 2)))
14950 (org-columns-get-format-and-top-level)
14951 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14952 (error "No operator defined for property %s" prop))
14953 (org-columns-compute prop)))
14955 (defvar org-property-allowed-value-functions nil
14956 "Hook for functions supplying allowed values for a specific property.
14957 The functions must take a single argument, the name of the property, and
14959 the values, this means that these values are intended as defaults for
14960 completion, but that other values should be allowed too.
14961 The functions must return nil if they are not responsible for this
14962 property.")
14964 (defun org-property-get-allowed-values (pom property &optional table)
14965 "Get allowed values for the property PROPERTY.
14966 When TABLE is non-nil, return an alist that can directly be used for
14967 completion."
14968 (let (vals)
14969 (cond
14970 ((equal property "TODO")
14971 (setq vals (org-with-point-at pom
14972 (append org-todo-keywords-1 '("")))))
14973 ((equal property "PRIORITY")
14974 (let ((n org-lowest-priority))
14975 (while (>= n org-highest-priority)
14976 (push (char-to-string n) vals)
14977 (setq n (1- n)))))
14978 ((member property org-special-properties))
14979 ((setq vals (run-hook-with-args-until-success
14980 'org-property-allowed-value-functions property)))
14981 (t
14982 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14984 (setq vals (car (read-from-string (concat "(" vals ")"))))
14985 (setq vals (mapcar (lambda (x)
14986 (cond ((stringp x) x)
14987 ((numberp x) (number-to-string x))
14988 ((symbolp x) (symbol-name x))
14989 (t "???")))
14990 vals)))))
14991 (when (member ":ETC" vals)
14992 (setq vals (remove ":ETC" vals))
14993 (org-add-props (car vals) '(org-unrestricted t)))
14994 (if table (mapcar 'list vals) vals)))
14996 (defun org-property-previous-allowed-value (&optional previous)
14997 "Switch to the next allowed value for this property."
14998 (interactive)
14999 (org-property-next-allowed-value t))
15001 (defun org-property-next-allowed-value (&optional previous)
15002 "Switch to the next allowed value for this property."
15003 (interactive)
15004 (unless (org-at-property-p)
15005 (error "Not at a property"))
15006 (let* ((key (match-string 2))
15007 (value (match-string 3))
15008 (allowed (or (org-property-get-allowed-values (point) key)
15009 (and (member value '("[ ]" "[-]" "[X]"))
15010 '("[ ]" "[X]"))))
15011 nval)
15012 (unless allowed
15013 (error "Allowed values for this property have not been defined"))
15014 (if previous (setq allowed (reverse allowed)))
15015 (if (member value allowed)
15016 (setq nval (car (cdr (member value allowed)))))
15017 (setq nval (or nval (car allowed)))
15018 (if (equal nval value)
15019 (error "Only one allowed value for this property"))
15020 (org-at-property-p)
15021 (replace-match (concat " :" key ": " nval) t t)
15022 (org-indent-line)
15023 (beginning-of-line 1)
15025 (run-hook-with-args 'org-property-changed-functions key nval)))
15027 (defun org-find-olp (path &optional this-buffer)
15028 "Return a marker pointing to the entry at outline path OLP.
15029 If anything goes wrong, throw an error.
15030 You can wrap this call to catch the error like this:
15032 (condition-case msg
15033 (org-mobile-locate-entry (match-string 4))
15034 (error (nth 1 msg)))
15036 The return value will then be either a string with the error message,
15037 or a marker if everything is OK.
15039 If THIS-BUFFER is set, the outline path does not contain a file,
15040 only headings."
15041 (let* ((file (if this-buffer buffer-file-name (pop path)))
15042 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15043 (level 1)
15044 (lmin 1)
15045 (lmax 1)
15046 limit re end found pos heading cnt flevel)
15047 (unless buffer (error "File not found :%s" file))
15048 (with-current-buffer buffer
15049 (save-excursion
15050 (save-restriction
15051 (widen)
15052 (setq limit (point-max))
15053 (goto-char (point-min))
15054 (while (setq heading (pop path))
15055 (setq re (format org-complex-heading-regexp-format
15056 (regexp-quote heading)))
15057 (setq cnt 0 pos (point))
15058 (while (re-search-forward re end t)
15059 (setq level (- (match-end 1) (match-beginning 1)))
15060 (if (and (>= level lmin) (<= level lmax))
15061 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15062 (when (= cnt 0) (error "Heading not found on level %d: %s"
15063 lmax heading))
15064 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15065 lmax heading))
15066 (goto-char found)
15067 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15068 (setq end (save-excursion (org-end-of-subtree t t))))
15069 (when (org-at-heading-p)
15070 (point-marker)))))))
15072 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15073 "Find node HEADING in BUFFER.
15074 Return a marker to the heading if it was found, or nil if not.
15075 If POS-ONLY is set, return just the position instead of a marker.
15077 The heading text must match exact, but it may have a TODO keyword,
15078 a priority cookie and tags in the standard locations."
15079 (with-current-buffer (or buffer (current-buffer))
15080 (save-excursion
15081 (save-restriction
15082 (widen)
15083 (goto-char (point-min))
15084 (let (case-fold-search)
15085 (if (re-search-forward
15086 (format org-complex-heading-regexp-format
15087 (regexp-quote heading)) nil t)
15088 (if pos-only
15089 (match-beginning 0)
15090 (move-marker (make-marker) (match-beginning 0)))))))))
15092 (defun org-find-exact-heading-in-directory (heading &optional dir)
15093 "Find Org node headline HEADING in all .org files in directory DIR.
15094 When the target headline is found, return a marker to this location."
15095 (let ((files (directory-files (or dir default-directory)
15097 file visiting m buffer)
15098 (catch 'found
15099 (while (setq file (pop files))
15100 (message "trying %s" file)
15101 (setq visiting (org-find-base-buffer-visiting file))
15102 (setq buffer (or visiting (find-file-noselect file)))
15103 (setq m (org-find-exact-headline-in-buffer
15104 heading buffer))
15105 (when (and (not m) (not visiting)) (kill-buffer buffer))
15106 (and m (throw 'found m))))))
15108 (defun org-find-entry-with-id (ident)
15109 "Locate the entry that contains the ID property with exact value IDENT.
15110 IDENT can be a string, a symbol or a number, this function will search for
15111 the string representation of it.
15112 Return the position where this entry starts, or nil if there is no such entry."
15113 (interactive "sID: ")
15114 (let ((id (cond
15115 ((stringp ident) ident)
15116 ((symbol-name ident) (symbol-name ident))
15117 ((numberp ident) (number-to-string ident))
15118 (t (error "IDENT %s must be a string, symbol or number" ident))))
15119 (case-fold-search nil))
15120 (save-excursion
15121 (save-restriction
15122 (widen)
15123 (goto-char (point-min))
15124 (when (re-search-forward
15126 nil t)
15127 (org-back-to-heading t)
15128 (point))))))
15130 ;;;; Timestamps
15132 (defvar org-last-changed-timestamp nil)
15133 (defvar org-last-inserted-timestamp nil
15134 "The last time stamp inserted with `org-insert-time-stamp'.")
15135 (defvar org-time-was-given) ; dynamically scoped parameter
15136 (defvar org-end-time-was-given) ; dynamically scoped parameter
15137 (defvar org-ts-what) ; dynamically scoped parameter
15139 (defun org-time-stamp (arg &optional inactive)
15140 "Prompt for a date/time and insert a time stamp.
15141 If the user specifies a time like HH:MM or if this command is
15142 called with at least one prefix argument, the time stamp contains
15143 the date and the time. Otherwise, only the date is be included.
15145 All parts of a date not specified by the user is filled in from
15146 the current date/time. So if you just press return without
15147 typing anything, the time stamp will represent the current
15148 date/time.
15150 If there is already a timestamp at the cursor, it will be
15151 modified.
15153 With two universal prefix arguments, insert an active timestamp
15154 with the current time without prompting the user."
15155 (interactive "P")
15156 (let* ((ts nil)
15157 (default-time
15158 ;; Default time is either today, or, when entering a range,
15159 ;; the range start.
15160 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15161 (save-excursion
15162 (re-search-backward
15164 (- (point) 20) t)))
15165 (apply 'encode-time (org-parse-time-string (match-string 1)))
15166 (current-time)))
15167 (default-input (and ts (org-get-compact-tod ts)))
15168 (repeater (save-excursion
15169 (save-match-data
15170 (beginning-of-line)
15171 (when (re-search-forward
15173 (save-excursion (progn (end-of-line) (point))) t)
15174 (match-string 0)))))
15175 org-time-was-given org-end-time-was-given time)
15176 (cond
15177 ((and (org-at-timestamp-p t)
15178 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15179 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15180 (insert "--")
15181 (setq time (let ((this-command this-command))
15182 (org-read-date arg 'totime nil nil
15183 default-time default-input inactive)))
15184 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15185 ((org-at-timestamp-p t)
15186 (setq time (let ((this-command this-command))
15187 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15188 (when (org-at-timestamp-p t) ; just to get the match data
15189 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15190 (replace-match "")
15191 (setq org-last-changed-timestamp
15192 (org-insert-time-stamp
15193 time (or org-time-was-given arg)
15194 inactive nil nil (list org-end-time-was-given)))
15195 (when repeater (goto-char (1- (point))) (insert " " repeater)
15196 (setq org-last-changed-timestamp
15197 (concat (substring org-last-inserted-timestamp 0 -1)
15198 " " repeater ">"))))
15199 (message "Timestamp updated"))
15200 ((equal arg '(16))
15201 (org-insert-time-stamp (current-time) t))
15202 (t
15203 (setq time (let ((this-command this-command))
15204 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15205 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15206 nil nil (list org-end-time-was-given))))))
15208 ;; FIXME: can we use this for something else, like computing time differences?
15209 (defun org-get-compact-tod (s)
15210 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15211 (let* ((t1 (match-string 1 s))
15212 (h1 (string-to-number (match-string 2 s)))
15213 (m1 (string-to-number (match-string 3 s)))
15214 (t2 (and (match-end 4) (match-string 5 s)))
15215 (h2 (and t2 (string-to-number (match-string 6 s))))
15216 (m2 (and t2 (string-to-number (match-string 7 s))))
15217 dh dm)
15218 (if (not t2)
15219 t1
15220 (setq dh (- h2 h1) dm (- m2 m1))
15221 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15222 (concat t1 "+" (number-to-string dh)
15223 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15225 (defun org-time-stamp-inactive (&optional arg)
15226 "Insert an inactive time stamp.
15227 An inactive time stamp is enclosed in square brackets instead of angle
15228 brackets. It is inactive in the sense that it does not trigger agenda entries,
15229 does not link to the calendar and cannot be changed with the S-cursor keys.
15230 So these are more for recording a certain time/date."
15231 (interactive "P")
15232 (org-time-stamp arg 'inactive))
15234 (defvar org-date-ovl (make-overlay 1 1))
15235 (overlay-put org-date-ovl 'face 'org-date-selected)
15236 (org-detach-overlay org-date-ovl)
15238 (defvar org-ans1) ; dynamically scoped parameter
15239 (defvar org-ans2) ; dynamically scoped parameter
15241 (defvar org-plain-time-of-day-regexp) ; defined below
15243 (defvar org-overriding-default-time nil) ; dynamically scoped
15244 (defvar org-read-date-overlay nil)
15245 (defvar org-dcst nil) ; dynamically scoped
15246 (defvar org-read-date-history nil)
15247 (defvar org-read-date-final-answer nil)
15248 (defvar org-read-date-analyze-futurep nil)
15249 (defvar org-read-date-analyze-forced-year nil)
15250 (defvar org-read-date-inactive)
15252 (defun org-read-date (&optional org-with-time to-time from-string prompt
15253 default-time default-input inactive)
15254 "Read a date, possibly a time, and make things smooth for the user.
15255 The prompt will suggest to enter an ISO date, but you can also enter anything
15256 which will at least partially be understood by `parse-time-string'.
15257 Unrecognized parts of the date will default to the current day, month, year,
15258 hour and minute. If this command is called to replace a timestamp at point,
15259 or to enter the second timestamp of a range, the default time is taken
15260 from the existing stamp. Furthermore, the command prefers the future,
15261 so if you are giving a date where the year is not given, and the day-month
15262 combination is already past in the current year, it will assume you
15263 mean next year. For details, see the manual. A few examples:
15265 3-2-5 --> 2003-02-05
15266 feb 15 --> currentyear-02-15
15267 2/15 --> currentyear-02-15
15268 sep 12 9 --> 2009-09-12
15269 12:45 --> today 12:45
15270 22 sept 0:34 --> currentyear-09-22 0:34
15271 12 --> currentyear-currentmonth-12
15272 Fri --> nearest Friday (today or later)
15273 etc.
15275 Furthermore you can specify a relative date by giving, as the *first* thing
15276 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15277 change in days weeks, months, years.
15278 With a single plus or minus, the date is relative to today. With a double
15279 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15280 +4d --> four days from today
15281 +4 --> same as above
15282 +2w --> two weeks from today
15283 ++5 --> five days from default date
15285 The function understands only English month and weekday abbreviations.
15287 While prompting, a calendar is popped up - you can also select the
15288 date with the mouse (button 1). The calendar shows a period of three
15289 months. To scroll it to other months, use the keys `>' and `<'.
15290 If you don't like the calendar, turn it off with
15291 \(setq org-read-date-popup-calendar nil)
15293 With optional argument TO-TIME, the date will immediately be converted
15294 to an internal time.
15295 With an optional argument ORG-WITH-TIME, the prompt will suggest to
15296 also insert a time. Note that when ORG-WITH-TIME is not set, you can
15297 still enter a time, and this function will inform the calling routine
15298 about this change. The calling routine may then choose to change the
15299 format used to insert the time stamp into the buffer to include the time.
15300 With optional argument FROM-STRING, read from this string instead from
15301 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15302 the time/date that is used for everything that is not specified by the
15303 user."
15304 (require 'parse-time)
15305 (let* ((org-time-stamp-rounding-minutes
15306 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15307 (org-dcst org-display-custom-times)
15308 (ct (org-current-time))
15309 (org-def (or org-overriding-default-time default-time ct))
15310 (org-defdecode (decode-time org-def))
15311 (dummy (progn
15312 (when (< (nth 2 org-defdecode) org-extend-today-until)
15313 (setcar (nthcdr 2 org-defdecode) -1)
15314 (setcar (nthcdr 1 org-defdecode) 59)
15315 (setq org-def (apply 'encode-time org-defdecode)
15316 org-defdecode (decode-time org-def)))))
15317 (calendar-frame-setup nil)
15318 (calendar-setup nil)
15319 (calendar-move-hook nil)
15320 (calendar-view-diary-initially-flag nil)
15321 (calendar-view-holidays-initially-flag nil)
15322 (timestr (format-time-string
15323 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15324 (prompt (concat (if prompt (concat prompt " ") "")
15325 (format "Date+time [%s]: " timestr)))
15326 ans (org-ans0 "") org-ans1 org-ans2 final)
15328 (cond
15329 (from-string (setq ans from-string))
15330 (org-read-date-popup-calendar
15331 (save-excursion
15332 (save-window-excursion
15333 (calendar)
15334 (org-eval-in-calendar '(setq cursor-type nil) t)
15335 (unwind-protect
15336 (progn
15337 (calendar-forward-day (- (time-to-days org-def)
15338 (calendar-absolute-from-gregorian
15339 (calendar-current-date))))
15340 (org-eval-in-calendar nil t)
15341 (let* ((old-map (current-local-map))
15342 (map (copy-keymap calendar-mode-map))
15343 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15344 (org-defkey map (kbd "RET") 'org-calendar-select)
15345 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15346 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15347 (org-defkey minibuffer-local-map [(meta shift left)]
15348 (lambda () (interactive)
15349 (org-eval-in-calendar '(calendar-backward-month 1))))
15350 (org-defkey minibuffer-local-map [(meta shift right)]
15351 (lambda () (interactive)
15352 (org-eval-in-calendar '(calendar-forward-month 1))))
15353 (org-defkey minibuffer-local-map [(meta shift up)]
15354 (lambda () (interactive)
15355 (org-eval-in-calendar '(calendar-backward-year 1))))
15356 (org-defkey minibuffer-local-map [(meta shift down)]
15357 (lambda () (interactive)
15358 (org-eval-in-calendar '(calendar-forward-year 1))))
15359 (org-defkey minibuffer-local-map [?\e (shift left)]
15360 (lambda () (interactive)
15361 (org-eval-in-calendar '(calendar-backward-month 1))))
15362 (org-defkey minibuffer-local-map [?\e (shift right)]
15363 (lambda () (interactive)
15364 (org-eval-in-calendar '(calendar-forward-month 1))))
15365 (org-defkey minibuffer-local-map [?\e (shift up)]
15366 (lambda () (interactive)
15367 (org-eval-in-calendar '(calendar-backward-year 1))))
15368 (org-defkey minibuffer-local-map [?\e (shift down)]
15369 (lambda () (interactive)
15370 (org-eval-in-calendar '(calendar-forward-year 1))))
15371 (org-defkey minibuffer-local-map [(shift up)]
15372 (lambda () (interactive)
15373 (org-eval-in-calendar '(calendar-backward-week 1))))
15374 (org-defkey minibuffer-local-map [(shift down)]
15375 (lambda () (interactive)
15376 (org-eval-in-calendar '(calendar-forward-week 1))))
15377 (org-defkey minibuffer-local-map [(shift left)]
15378 (lambda () (interactive)
15379 (org-eval-in-calendar '(calendar-backward-day 1))))
15380 (org-defkey minibuffer-local-map [(shift right)]
15381 (lambda () (interactive)
15382 (org-eval-in-calendar '(calendar-forward-day 1))))
15383 (org-defkey minibuffer-local-map ">"
15384 (lambda () (interactive)
15385 (org-eval-in-calendar '(scroll-calendar-left 1))))
15386 (org-defkey minibuffer-local-map "<"
15387 (lambda () (interactive)
15388 (org-eval-in-calendar '(scroll-calendar-right 1))))
15389 (org-defkey minibuffer-local-map "\C-v"
15390 (lambda () (interactive)
15391 (org-eval-in-calendar
15392 '(calendar-scroll-left-three-months 1))))
15393 (org-defkey minibuffer-local-map "\M-v"
15394 (lambda () (interactive)
15395 (org-eval-in-calendar
15396 '(calendar-scroll-right-three-months 1))))
15397 (run-hooks 'org-read-date-minibuffer-setup-hook)
15398 (unwind-protect
15399 (progn
15400 (use-local-map map)
15401 (setq org-read-date-inactive inactive)
15402 (add-hook 'post-command-hook 'org-read-date-display)
15403 (setq org-ans0 (read-string prompt default-input
15404 'org-read-date-history nil))
15405 ;; org-ans0: from prompt
15406 ;; org-ans1: from mouse click
15407 ;; org-ans2: from calendar motion
15408 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15409 (remove-hook 'post-command-hook 'org-read-date-display)
15410 (use-local-map old-map)
15411 (when org-read-date-overlay
15412 (delete-overlay org-read-date-overlay)
15413 (setq org-read-date-overlay nil)))))
15414 (bury-buffer "*Calendar*")))))
15416 (t ; Naked prompt only
15417 (unwind-protect
15418 (setq ans (read-string prompt default-input
15419 'org-read-date-history timestr))
15420 (when org-read-date-overlay
15421 (delete-overlay org-read-date-overlay)
15422 (setq org-read-date-overlay nil)))))
15424 (setq final (org-read-date-analyze ans org-def org-defdecode))
15426 (when org-read-date-analyze-forced-year
15427 (message "Year was forced into %s"
15428 (if org-read-date-force-compatible-dates
15429 "compatible range (1970-2037)"
15430 "range representable on this machine"))
15431 (ding))
15433 ;; One round trip to get rid of 34th of August and stuff like that....
15434 (setq final (decode-time (apply 'encode-time final)))
15436 (setq org-read-date-final-answer ans)
15438 (if to-time
15439 (apply 'encode-time final)
15440 (if (and (boundp 'org-time-was-given) org-time-was-given)
15441 (format "%04d-%02d-%02d %02d:%02d"
15442 (nth 5 final) (nth 4 final) (nth 3 final)
15443 (nth 2 final) (nth 1 final))
15444 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15446 (defvar org-def)
15447 (defvar org-defdecode)
15448 (defvar org-with-time)
15449 (defun org-read-date-display ()
15450 "Display the current date prompt interpretation in the minibuffer."
15451 (when org-read-date-display-live
15452 (when org-read-date-overlay
15453 (delete-overlay org-read-date-overlay))
15454 (when (minibufferp (current-buffer))
15455 (save-excursion
15456 (end-of-line 1)
15457 (while (not (equal (buffer-substring
15458 (max (point-min) (- (point) 4)) (point))
15459 " "))
15460 (insert " ")))
15461 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15462 " " (or org-ans1 org-ans2)))
15463 (org-end-time-was-given nil)
15464 (f (org-read-date-analyze ans org-def org-defdecode))
15465 (fmts (if org-dcst
15466 org-time-stamp-custom-formats
15467 org-time-stamp-formats))
15468 (fmt (if (or org-with-time
15469 (and (boundp 'org-time-was-given) org-time-was-given))
15470 (cdr fmts)
15471 (car fmts)))
15472 (txt (format-time-string fmt (apply 'encode-time f)))
15473 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15474 (txt (concat "=> " txt)))
15475 (when (and org-end-time-was-given
15476 (string-match org-plain-time-of-day-regexp txt))
15477 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15478 org-end-time-was-given
15479 (substring txt (match-end 0)))))
15480 (when org-read-date-analyze-futurep
15481 (setq txt (concat txt " (=>F)")))
15482 (setq org-read-date-overlay
15483 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15484 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
15486 (defun org-read-date-analyze (ans org-def org-defdecode)
15487 "Analyze the combined answer of the date prompt."
15488 ;; FIXME: cleanup and comment
15489 (let ((nowdecode (decode-time (current-time)))
15490 delta deltan deltaw deltadef year month day
15491 hour minute second wday pm h2 m2 tl wday1
15492 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15493 (setq org-read-date-analyze-futurep nil
15494 org-read-date-analyze-forced-year nil)
15496 (setq ans "+0"))
15498 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15499 (setq ans (replace-match "" t t ans)
15500 deltan (car delta)
15501 deltaw (nth 1 delta)
15502 deltadef (nth 2 delta)))
15504 ;; Check if there is an iso week date in there. If yes, store the
15505 ;; info and postpone interpreting it until the rest of the parsing
15506 ;; is done.
15507 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15508 (setq iso-year (if (match-end 1)
15509 (org-small-year-to-year
15510 (string-to-number (match-string 1 ans))))
15511 iso-weekday (if (match-end 3)
15512 (string-to-number (match-string 3 ans)))
15513 iso-week (string-to-number (match-string 2 ans)))
15514 (setq ans (replace-match "" t t ans)))
15516 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15517 (when (string-match
15519 (setq year (if (match-end 2)
15520 (string-to-number (match-string 2 ans))
15521 (progn (setq kill-year t)
15522 (string-to-number (format-time-string "%Y"))))
15523 month (string-to-number (match-string 3 ans))
15524 day (string-to-number (match-string 4 ans)))
15525 (if (< year 100) (setq year (+ 2000 year)))
15527 t nil ans)))
15529 ;; Help matching dotted european dates
15530 (when (string-match
15531 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
15532 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
15533 (setq kill-year t)
15534 (string-to-number (format-time-string "%Y")))
15535 day (string-to-number (match-string 1 ans))
15536 month (string-to-number (match-string 2 ans))
15537 ans (replace-match (format "%04d-%02d-%02d" year month day)
15538 t nil ans)))
15540 ;; Help matching american dates, like 5/30 or 5/30/7
15541 (when (string-match
15542 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15543 (setq year (if (match-end 4)
15544 (string-to-number (match-string 4 ans))
15545 (progn (setq kill-year t)
15546 (string-to-number (format-time-string "%Y"))))
15547 month (string-to-number (match-string 1 ans))
15548 day (string-to-number (match-string 2 ans)))
15549 (if (< year 100) (setq year (+ 2000 year)))
15551 t nil ans)))
15552 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15553 ;; If there is a time with am/pm, and *no* time without it, we convert
15554 ;; so that matching will be successful.
15555 (loop for i from 1 to 2 do ; twice, for end time as well
15558 (setq hour (string-to-number (match-string 1 ans))
15559 minute (if (match-end 3)
15560 (string-to-number (match-string 3 ans))
15561 0)
15562 pm (equal ?p
15563 (string-to-char (downcase (match-string 4 ans)))))
15564 (if (and (= hour 12) (not pm))
15565 (setq hour 0)
15566 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15567 (setq ans (replace-match (format "%02d:%02d" hour minute)
15568 t t ans))))
15570 ;; Check if a time range is given as a duration
15571 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15572 (setq hour (string-to-number (match-string 1 ans))
15573 h2 (+ hour (string-to-number (match-string 3 ans)))
15574 minute (string-to-number (match-string 2 ans))
15575 m2 (+ minute (if (match-end 5) (string-to-number
15576 (match-string 5 ans))0)))
15577 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15578 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15579 t t ans)))
15581 ;; Check if there is a time range
15582 (when (boundp 'org-end-time-was-given)
15583 (setq org-time-was-given nil)
15584 (when (and (string-match org-plain-time-of-day-regexp ans)
15585 (match-end 8))
15586 (setq org-end-time-was-given (match-string 8 ans))
15587 (setq ans (concat (substring ans 0 (match-beginning 7))
15588 (substring ans (match-end 7))))))
15590 (setq tl (parse-time-string ans)
15591 day (or (nth 3 tl) (nth 3 org-defdecode))
15592 month (or (nth 4 tl)
15593 (if (and org-read-date-prefer-future
15594 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15595 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15596 (nth 4 org-defdecode)))
15597 year (or (and (not kill-year) (nth 5 tl))
15598 (if (and org-read-date-prefer-future
15599 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15600 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15601 (nth 5 org-defdecode)))
15602 hour (or (nth 2 tl) (nth 2 org-defdecode))
15603 minute (or (nth 1 tl) (nth 1 org-defdecode))
15604 second (or (nth 0 tl) 0)
15605 wday (nth 6 tl))
15607 (when (and (eq org-read-date-prefer-future 'time)
15608 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15609 (equal day (nth 3 nowdecode))
15610 (equal month (nth 4 nowdecode))
15611 (equal year (nth 5 nowdecode))
15612 (nth 2 tl)
15613 (or (< (nth 2 tl) (nth 2 nowdecode))
15614 (and (= (nth 2 tl) (nth 2 nowdecode))
15615 (nth 1 tl)
15616 (< (nth 1 tl) (nth 1 nowdecode)))))
15617 (setq day (1+ day)
15618 futurep t))
15620 ;; Special date definitions below
15621 (cond
15622 (iso-week
15623 ;; There was an iso week
15624 (require 'cal-iso)
15625 (setq futurep nil)
15626 (setq year (or iso-year year)
15627 day (or iso-weekday wday 1)
15628 wday nil ; to make sure that the trigger below does not match
15629 iso-date (calendar-gregorian-from-absolute
15630 (calendar-absolute-from-iso
15631 (list iso-week day year))))
15632 ; FIXME: Should we also push ISO weeks into the future?
15633 ; (when (and org-read-date-prefer-future
15634 ; (not iso-year)
15635 ; (< (calendar-absolute-from-gregorian iso-date)
15636 ; (time-to-days (current-time))))
15637 ; (setq year (1+ year)
15638 ; iso-date (calendar-gregorian-from-absolute
15639 ; (calendar-absolute-from-iso
15640 ; (list iso-week day year)))))
15641 (setq month (car iso-date)
15642 year (nth 2 iso-date)
15643 day (nth 1 iso-date)))
15644 (deltan
15645 (setq futurep nil)
15646 (unless deltadef
15647 (let ((now (decode-time (current-time))))
15648 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15649 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15650 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15651 ((equal deltaw "m") (setq month (+ month deltan)))
15652 ((equal deltaw "y") (setq year (+ year deltan)))))
15653 ((and wday (not (nth 3 tl)))
15654 ;; Weekday was given, but no day, so pick that day in the week
15655 ;; on or after the derived date.
15656 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15657 (unless (equal wday wday1)
15658 (setq day (+ day (% (- wday wday1 -7) 7))))))
15659 (if (and (boundp 'org-time-was-given)
15660 (nth 2 tl))
15661 (setq org-time-was-given t))
15662 (if (< year 100) (setq year (+ 2000 year)))
15663 ;; Check of the date is representable
15664 (if org-read-date-force-compatible-dates
15665 (progn
15666 (if (< year 1970)
15667 (setq year 1970 org-read-date-analyze-forced-year t))
15668 (if (> year 2037)
15669 (setq year 2037 org-read-date-analyze-forced-year t)))
15670 (condition-case nil
15671 (ignore (encode-time second minute hour day month year))
15672 (error
15673 (setq year (nth 5 org-defdecode))
15674 (setq org-read-date-analyze-forced-year t))))
15675 (setq org-read-date-analyze-futurep futurep)
15676 (list second minute hour day month year)))
15678 (defvar parse-time-weekdays)
15679 (defun org-read-date-get-relative (s today default)
15680 "Check string S for special relative date string.
15681 TODAY and DEFAULT are internal times, for today and for a default.
15682 Return shift list (N what def-flag)
15684 N is the number of WHATs to shift.
15685 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15686 the DEFAULT date rather than TODAY."
15687 (require 'parse-time)
15688 (when (and
15689 (string-match
15690 (concat
15695 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15696 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15697 (string-to-char (substring (match-string 1 s) -1))
15698 ?+))
15699 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15700 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15701 (what (if (match-end 3) (match-string 3 s) "d"))
15702 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15703 (date (if rel default today))
15704 (wday (nth 6 (decode-time date)))
15705 delta)
15706 (if wday1
15707 (progn
15708 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15709 (if (= dir ?-) (setq delta (- delta 7)))
15710 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15711 (list delta "d" rel))
15712 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15714 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15715 "Turn a user-specified date into the internal representation.
15716 The internal representation needed by the calendar is (month day year).
15717 This is a wrapper to handle the brain-dead convention in calendar that
15718 user function argument order change dependent on argument order."
15719 (if (boundp 'calendar-date-style)
15720 (cond
15721 ((eq calendar-date-style 'american)
15722 (list arg1 arg2 arg3))
15723 ((eq calendar-date-style 'european)
15724 (list arg2 arg1 arg3))
15725 ((eq calendar-date-style 'iso)
15726 (list arg2 arg3 arg1)))
15727 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15728 (if (org-bound-and-true-p european-calendar-style)
15729 (list arg2 arg1 arg3)
15730 (list arg1 arg2 arg3)))))
15732 (defun org-eval-in-calendar (form &optional keepdate)
15733 "Eval FORM in the calendar window and return to current window.
15734 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
15735 otherwise stick to the current value of `org-ans2'."
15736 (let ((sf (selected-frame))
15737 (sw (selected-window)))
15738 (select-window (get-buffer-window "*Calendar*" t))
15739 (eval form)
15740 (when (and (not keepdate) (calendar-cursor-to-date))
15741 (let* ((date (calendar-cursor-to-date))
15742 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15743 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15744 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15745 (select-window sw)
15746 (org-select-frame-set-input-focus sf)))
15748 (defun org-calendar-select ()
15749 "Return to `org-read-date' with the date currently selected.
15750 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15751 (interactive)
15752 (when (calendar-cursor-to-date)
15753 (let* ((date (calendar-cursor-to-date))
15754 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15755 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15756 (if (active-minibuffer-window) (exit-minibuffer))))
15758 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15759 "Insert a date stamp for the date given by the internal TIME.
15760 WITH-HM means use the stamp format that includes the time of the day.
15761 INACTIVE means use square brackets instead of angular ones, so that the
15762 stamp will not contribute to the agenda.
15763 PRE and POST are optional strings to be inserted before and after the
15764 stamp.
15765 The command returns the inserted time stamp."
15766 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15767 stamp)
15768 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15769 (insert-before-markers (or pre ""))
15770 (when (listp extra)
15771 (setq extra (car extra))
15772 (if (and (stringp extra)
15774 (setq extra (format "-%02d:%02d"
15775 (string-to-number (match-string 1 extra))
15776 (string-to-number (match-string 2 extra))))
15777 (setq extra nil)))
15778 (when extra
15779 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15780 (insert-before-markers (setq stamp (format-time-string fmt time)))
15781 (insert-before-markers (or post ""))
15782 (setq org-last-inserted-timestamp stamp)))
15784 (defun org-toggle-time-stamp-overlays ()
15785 "Toggle the use of custom time stamp formats."
15786 (interactive)
15787 (setq org-display-custom-times (not org-display-custom-times))
15788 (unless org-display-custom-times
15789 (let ((p (point-min)) (bmp (buffer-modified-p)))
15790 (while (setq p (next-single-property-change p 'display))
15791 (if (and (get-text-property p 'display)
15792 (eq (get-text-property p 'face) 'org-date))
15793 (remove-text-properties
15794 p (setq p (next-single-property-change p 'display))
15795 '(display t))))
15796 (set-buffer-modified-p bmp)))
15797 (if (featurep 'xemacs)
15798 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15799 (org-restart-font-lock)
15800 (setq org-table-may-need-update t)
15801 (if org-display-custom-times
15802 (message "Time stamps are overlaid with custom format")
15803 (message "Time stamp overlays removed")))
15805 (defun org-display-custom-time (beg end)
15806 "Overlay modified time stamp format over timestamp between BEG and END."
15807 (let* ((ts (buffer-substring beg end))
15808 t1 w1 with-hm tf time str w2 (off 0))
15809 (save-match-data
15810 (setq t1 (org-parse-time-string ts t))
15811 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
15812 (setq off (- (match-end 0) (match-beginning 0)))))
15813 (setq end (- end off))
15814 (setq w1 (- end beg)
15815 with-hm (and (nth 1 t1) (nth 2 t1))
15816 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15817 time (org-fix-decoded-time t1)
15818 str (org-add-props
15819 (format-time-string
15820 (substring tf 1 -1) (apply 'encode-time time))
15821 nil 'mouse-face 'highlight)
15822 w2 (length str))
15823 (if (not (= w2 w1))
15824 (add-text-properties (1+ beg) (+ 2 beg)
15825 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15826 (if (featurep 'xemacs)
15827 (progn
15828 (put-text-property beg end 'invisible t)
15829 (put-text-property beg end 'end-glyph (make-glyph str)))
15830 (put-text-property beg end 'display str))))
15832 (defun org-translate-time (string)
15833 "Translate all timestamps in STRING to custom format.
15834 But do this only if the variable `org-display-custom-times' is set."
15835 (when org-display-custom-times
15836 (save-match-data
15837 (let* ((start 0)
15838 (re org-ts-regexp-both)
15839 t1 with-hm inactive tf time str beg end)
15840 (while (setq start (string-match re string start))
15841 (setq beg (match-beginning 0)
15842 end (match-end 0)
15843 t1 (save-match-data
15844 (org-parse-time-string (substring string beg end) t))
15845 with-hm (and (nth 1 t1) (nth 2 t1))
15846 inactive (equal (substring string beg (1+ beg)) "[")
15847 tf (funcall (if with-hm 'cdr 'car)
15848 org-time-stamp-custom-formats)
15849 time (org-fix-decoded-time t1)
15850 str (format-time-string
15851 (concat
15852 (if inactive "[" "<") (substring tf 1 -1)
15853 (if inactive "]" ">"))
15854 (apply 'encode-time time))
15855 string (replace-match str t t string)
15856 start (+ start (length str)))))))
15857 string)
15859 (defun org-fix-decoded-time (time)
15860 "Set 0 instead of nil for the first 6 elements of time.
15861 Don't touch the rest."
15862 (let ((n 0))
15863 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15865 (defun org-days-to-time (timestamp-string)
15866 "Difference between TIMESTAMP-STRING and now in days."
15867 (- (time-to-days (org-time-string-to-time timestamp-string))
15868 (time-to-days (current-time))))
15870 (defun org-deadline-close (timestamp-string &optional ndays)
15871 "Is the time in TIMESTAMP-STRING close to the current date?"
15872 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15873 (and (< (org-days-to-time timestamp-string) ndays)
15874 (not (org-entry-is-done-p))))
15876 (defun org-get-wdays (ts)
15877 "Get the deadline lead time appropriate for timestring TS."
15878 (cond
15879 ((<= org-deadline-warning-days 0)
15880 ;; 0 or negative, enforce this value no matter what
15881 (- org-deadline-warning-days))
15883 ;; lead time is specified.
15884 (floor (* (string-to-number (match-string 1 ts))
15885 (cdr (assoc (match-string 2 ts)
15886 '(("d" . 1) ("w" . 7)
15887 ("m" . 30.4) ("y" . 365.25)))))))
15888 ;; go for the default.
15889 (t org-deadline-warning-days)))
15891 (defun org-calendar-select-mouse (ev)
15892 "Return to `org-read-date' with the date currently selected.
15893 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15894 (interactive "e")
15895 (mouse-set-point ev)
15896 (when (calendar-cursor-to-date)
15897 (let* ((date (calendar-cursor-to-date))
15898 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15899 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15900 (if (active-minibuffer-window) (exit-minibuffer))))
15902 (defun org-check-deadlines (ndays)
15903 "Check if there are any deadlines due or past due.
15904 A deadline is considered due if it happens within `org-deadline-warning-days'
15905 days from today's date. If the deadline appears in an entry marked DONE,
15906 it is not shown. The prefix arg NDAYS can be used to test that many
15908 (interactive "P")
15909 (let* ((org-warn-days
15910 (cond
15911 ((equal ndays '(4)) 100000)
15912 (ndays (prefix-numeric-value ndays))
15913 (t (abs org-deadline-warning-days))))
15914 (case-fold-search nil)
15916 (callback
15917 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15919 (message "%d deadlines past-due or due within %d days"
15920 (org-occur regexp nil callback)
15921 org-warn-days)))
15923 (defsubst org-re-timestamp (type)
15924 "Return a regexp for timestamp TYPE.
15925 Allowed values for TYPE are:
15927 all: all timestamps
15928 active: only active timestamps (<...>)
15929 inactive: only inactive timestamps ([...])
15930 scheduled: only scheduled timestamps
15931 deadline: only deadline timestamps
15933 When TYPE is nil, fall back on returning a regexp that matches
15934 both scheduled and deadline timestamps."
15935 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
15936 ((eq type 'active) org-ts-regexp)
15940 ((eq type 'scheduled-or-deadline)
15943 (defun org-check-before-date (date)
15944 "Check if there are deadlines or scheduled entries before DATE."
15945 (interactive (list (org-read-date)))
15946 (let ((case-fold-search nil)
15947 (regexp (org-re-timestamp org-ts-type))
15948 (callback
15949 (lambda () (time-less-p
15950 (org-time-string-to-time (match-string 1))
15951 (org-time-string-to-time date)))))
15952 (message "%d entries before %s"
15953 (org-occur regexp nil callback) date)))
15955 (defun org-check-after-date (date)
15956 "Check if there are deadlines or scheduled entries after DATE."
15957 (interactive (list (org-read-date)))
15958 (let ((case-fold-search nil)
15959 (regexp (org-re-timestamp org-ts-type))
15960 (callback
15961 (lambda () (not
15962 (time-less-p
15963 (org-time-string-to-time (match-string 1))
15964 (org-time-string-to-time date))))))
15965 (message "%d entries after %s"
15966 (org-occur regexp nil callback) date)))
15968 (defun org-check-dates-range (start-date end-date)
15969 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15970 (interactive (list (org-read-date nil nil nil "Range starts")
15971 (org-read-date nil nil nil "Range end")))
15972 (let ((case-fold-search nil)
15973 (regexp (org-re-timestamp org-ts-type))
15974 (callback
15975 (lambda ()
15976 (let ((match (match-string 1)))
15977 (and
15978 (not (time-less-p
15979 (org-time-string-to-time match)
15980 (org-time-string-to-time start-date)))
15981 (time-less-p
15982 (org-time-string-to-time match)
15983 (org-time-string-to-time end-date)))))))
15984 (message "%d entries between %s and %s"
15985 (org-occur regexp nil callback) start-date end-date)))
15987 (defun org-evaluate-time-range (&optional to-buffer)
15988 "Evaluate a time range by computing the difference between start and end.
15989 Normally the result is just printed in the echo area, but with prefix arg
15990 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15991 If the time range is actually in a table, the result is inserted into the
15992 next column.
15993 For time difference computation, a year is assumed to be exactly 365
15994 days in order to avoid rounding problems."
15995 (interactive "P")
15996 (or
15997 (org-clock-update-time-maybe)
15998 (save-excursion
15999 (unless (org-at-date-range-p t)
16000 (goto-char (point-at-bol))
16001 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16002 (if (not (org-at-date-range-p t))
16003 (error "Not at a time-stamp range, and none found in current line")))
16004 (let* ((ts1 (match-string 1))
16005 (ts2 (match-string 2))
16006 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16007 (match-end (match-end 0))
16008 (time1 (org-time-string-to-time ts1))
16009 (time2 (org-time-string-to-time ts2))
16010 (t1 (org-float-time time1))
16011 (t2 (org-float-time time2))
16012 (diff (abs (- t2 t1)))
16013 (negative (< (- t2 t1) 0))
16014 ;; (ys (floor (* 365 24 60 60)))
16015 (ds (* 24 60 60))
16016 (hs (* 60 60))
16017 (fy "%dy %dd %02d:%02d")
16018 (fy1 "%dy %dd")
16019 (fd "%dd %02d:%02d")
16020 (fd1 "%dd")
16021 (fh "%02d:%02d")
16022 y d h m align)
16023 (if havetime
16024 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16025 y 0
16026 d (floor (/ diff ds)) diff (mod diff ds)
16027 h (floor (/ diff hs)) diff (mod diff hs)
16028 m (floor (/ diff 60)))
16029 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16030 y 0
16031 d (floor (+ (/ diff ds) 0.5))
16032 h 0 m 0))
16033 (if (not to-buffer)
16034 (message "%s" (org-make-tdiff-string y d h m))
16035 (if (org-at-table-p)
16036 (progn
16037 (goto-char match-end)
16038 (setq align t)
16039 (and (looking-at " *|") (goto-char (match-end 0))))
16040 (goto-char match-end))
16041 (if (looking-at
16043 (replace-match ""))
16044 (if negative (insert " -"))
16045 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16046 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16047 (insert " " (format fh h m))))
16048 (if align (org-table-align))
16049 (message "Time difference inserted")))))
16051 (defun org-make-tdiff-string (y d h m)
16052 (let ((fmt "")
16053 (l nil))
16054 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16055 l (push y l)))
16056 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16057 l (push d l)))
16058 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16059 l (push h l)))
16060 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16061 l (push m l)))
16062 (apply 'format fmt (nreverse l))))
16064 (defun org-time-string-to-time (s &optional buffer pos)
16065 "Convert a timestamp string into internal time."
16066 (condition-case errdata
16067 (apply 'encode-time (org-parse-time-string s))
16069 s (if (not (and buffer pos))
16070 ""
16071 (format " at %d in buffer `%s'" pos buffer))
16072 (cdr errdata)))))
16074 (defun org-time-string-to-seconds (s)
16075 "Convert a timestamp string to a number of seconds."
16076 (org-float-time (org-time-string-to-time s)))
16078 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16079 "Convert a time stamp to an absolute day number.
16080 If there is a specifier for a cyclic time stamp, get the closest date to
16081 DAYNR.
16082 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16083 The variable date is bound by the calendar when this is called."
16084 (cond
16086 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16087 daynr
16088 (+ daynr 1000)))
16090 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16091 (time-to-days (current-time))) (match-string 0 s)
16092 prefer show-all))
16093 (t (time-to-days
16094 (condition-case errdata
16095 (apply 'encode-time (org-parse-time-string s))
16097 s (if (not (and buffer pos))
16098 ""
16099 (format " at %d in buffer `%s'" pos buffer))
16100 (cdr errdata))))))))
16102 (defun org-days-to-iso-week (days)
16103 "Return the iso week number."
16104 (require 'cal-iso)
16105 (car (calendar-iso-from-absolute days)))
16107 (defun org-small-year-to-year (year)
16108 "Convert 2-digit years into 4-digit years.
16109 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16110 The year 2000 cannot be abbreviated. Any year larger than 99
16111 is returned unchanged."
16112 (if (< year 38)
16113 (setq year (+ 2000 year))
16114 (if (< year 100)
16115 (setq year (+ 1900 year))))
16116 year)
16118 (defun org-time-from-absolute (d)
16119 "Return the time corresponding to date D.
16120 D may be an absolute day number, or a calendar-type list (month day year)."
16121 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16122 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16124 (defun org-calendar-holiday ()
16125 "List of holidays, for Diary display in Org-mode."
16126 (require 'holidays)
16127 (let ((hl (funcall
16128 (if (fboundp 'calendar-check-holidays)
16129 'calendar-check-holidays 'check-calendar-holidays) date)))
16130 (if hl (mapconcat 'identity hl "; "))))
16132 (defun org-diary-sexp-entry (sexp entry date)
16133 "Process a SEXP diary ENTRY for DATE."
16134 (require 'diary-lib)
16135 (let ((result (if calendar-debug-sexp
16136 (let ((stack-trace-on-error t))
16137 (eval (car (read-from-string sexp))))
16138 (condition-case nil
16139 (eval (car (read-from-string sexp)))
16140 (error
16141 (beep)
16142 (message "Bad sexp at line %d in %s: %s"
16143 (org-current-line)
16144 (buffer-file-name) sexp)
16145 (sleep-for 2))))))
16146 (cond ((stringp result) (split-string result "; "))
16147 ((and (consp result)
16148 (not (consp (cdr result)))
16149 (stringp (cdr result))) (cdr result))
16150 ((and (consp result)
16151 (stringp (car result))) result)
16152 (result entry))))
16154 (defun org-diary-to-ical-string (frombuf)
16155 "Get iCalendar entries from diary entries in buffer FROMBUF.
16156 This uses the icalendar.el library."
16157 (let* ((tmpdir (if (featurep 'xemacs)
16158 (temp-directory)
16159 temporary-file-directory))
16160 (tmpfile (make-temp-name
16161 (expand-file-name "orgics" tmpdir)))
16162 buf rtn b e)
16163 (with-current-buffer frombuf
16164 (icalendar-export-region (point-min) (point-max) tmpfile)
16165 (setq buf (find-buffer-visiting tmpfile))
16166 (set-buffer buf)
16167 (goto-char (point-min))
16168 (if (re-search-forward "^BEGIN:VEVENT" nil t)
16169 (setq b (match-beginning 0)))
16170 (goto-char (point-max))
16171 (if (re-search-backward "^END:VEVENT" nil t)
16172 (setq e (match-end 0)))
16174 (kill-buffer buf)
16175 (delete-file tmpfile)
16176 rtn))
16178 (defun org-closest-date (start current change prefer show-all)
16179 "Find the date closest to CURRENT that is consistent with START and CHANGE.
16180 When PREFER is `past', return a date that is either CURRENT or past.
16181 When PREFER is `future', return a date that is either CURRENT or future.
16182 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
16183 ;; Make the proper lists from the dates
16184 (catch 'exit
16185 (let ((a1 '(("h" . hour)
16186 ("d" . day)
16187 ("w" . week)
16188 ("m" . month)
16189 ("y" . year)))
16190 (shour (nth 2 (org-parse-time-string start)))
16191 dn dw sday cday n1 n2 n0
16192 d m y y1 y2 date1 date2 nmonths nm ny m2)
16194 (setq start (org-date-to-gregorian start)
16195 current (org-date-to-gregorian
16196 (if show-all
16197 current
16198 (time-to-days (current-time))))
16199 sday (calendar-absolute-from-gregorian start)
16200 cday (calendar-absolute-from-gregorian current))
16202 (if (<= cday sday) (throw 'exit sday))
16205 (setq dn (string-to-number (match-string 1 change))
16206 dw (cdr (assoc (match-string 2 change) a1)))
16207 (error "Invalid change specifier: %s" change))
16208 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16209 (cond
16210 ((eq dw 'hour)
16211 (let ((missing-hours
16212 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
16213 dn)))
16214 (setq n1 (if (zerop missing-hours) cday
16215 (- cday (1+ (floor (/ missing-hours 24)))))
16216 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
16217 ((eq dw 'day)
16218 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16219 n2 (+ n1 dn)))
16220 ((eq dw 'year)
16221 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16222 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16223 (setq date1 (list m d y1)
16224 n1 (calendar-absolute-from-gregorian date1)
16225 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16226 n2 (calendar-absolute-from-gregorian date2)))
16227 ((eq dw 'month)
16228 ;; approx number of month between the two dates
16229 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16230 ;; How often does dn fit in there?
16231 (setq d (nth 1 start) m (car start) y (nth 2 start)
16232 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16233 m (+ m nm)
16234 ny (floor (/ m 12))
16235 y (+ y ny)
16236 m (- m (* ny 12)))
16237 (while (> m 12) (setq m (- m 12) y (1+ y)))
16238 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16239 (setq m2 (+ m dn) y2 y)
16240 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16241 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16242 (while (<= n2 cday)
16243 (setq n1 n2 m m2 y y2)
16244 (setq m2 (+ m dn) y2 y)
16245 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16246 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
16247 ;; Make sure n1 is the earlier date
16248 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16249 (if show-all
16250 (cond
16251 ((eq prefer 'past) (if (= cday n2) n2 n1))
16252 ((eq prefer 'future) (if (= cday n1) n1 n2))
16253 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16254 (cond
16255 ((eq prefer 'past) (if (= cday n2) n2 n1))
16256 ((eq prefer 'future) (if (= cday n1) n1 n2))
16257 (t (if (= cday n1) n1 n2)))))))
16259 (defun org-date-to-gregorian (date)
16260 "Turn any specification of DATE into a Gregorian date for the calendar."
16261 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16262 ((and (listp date) (= (length date) 3)) date)
16263 ((stringp date)
16264 (setq date (org-parse-time-string date))
16265 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16266 ((listp date)
16267 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16269 (defun org-parse-time-string (s &optional nodefault)
16270 "Parse the standard Org-mode time string.
16271 This should be a lot faster than the normal `parse-time-string'.
16272 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16273 hour and minute fields will be nil if not given."
16274 (if (string-match org-ts-regexp0 s)
16275 (list 0
16276 (if (or (match-beginning 8) (not nodefault))
16277 (string-to-number (or (match-string 8 s) "0")))
16278 (if (or (match-beginning 7) (not nodefault))
16279 (string-to-number (or (match-string 7 s) "0")))
16280 (string-to-number (match-string 4 s))
16281 (string-to-number (match-string 3 s))
16282 (string-to-number (match-string 2 s))
16283 nil nil nil)
16284 (error "Not a standard Org-mode time string: %s" s)))
16286 (defun org-timestamp-up (&optional arg)
16287 "Increase the date item at the cursor by one.
16288 If the cursor is on the year, change the year. If it is on the month,
16289 the day or the time, change that.
16290 With prefix ARG, change by that many units."
16291 (interactive "p")
16292 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16294 (defun org-timestamp-down (&optional arg)
16295 "Decrease the date item at the cursor by one.
16296 If the cursor is on the year, change the year. If it is on the month,
16297 the day or the time, change that.
16298 With prefix ARG, change by that many units."
16299 (interactive "p")
16300 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16302 (defun org-timestamp-up-day (&optional arg)
16303 "Increase the date in the time stamp by one day.
16304 With prefix ARG, change that many days."
16305 (interactive "p")
16306 (if (and (not (org-at-timestamp-p t))
16307 (org-at-heading-p))
16308 (org-todo 'up)
16309 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16311 (defun org-timestamp-down-day (&optional arg)
16312 "Decrease the date in the time stamp by one day.
16313 With prefix ARG, change that many days."
16314 (interactive "p")
16315 (if (and (not (org-at-timestamp-p t))
16316 (org-at-heading-p))
16317 (org-todo 'down)
16318 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16320 (defun org-at-timestamp-p (&optional inactive-ok)
16321 "Determine if the cursor is in or at a timestamp."
16322 (interactive)
16323 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16324 (pos (point))
16325 (ans (or (looking-at tsr)
16326 (save-excursion
16328 (if (> (point) (point-min)) (backward-char 1))
16329 (and (looking-at tsr)
16330 (> (- (match-end 0) pos) -1))))))
16331 (and ans
16332 (boundp 'org-ts-what)
16333 (setq org-ts-what
16334 (cond
16335 ((= pos (match-beginning 0)) 'bracket)
16336 ;; Point is considered to be "on the bracket" whether
16337 ;; it's really on it or right after it.
16338 ((= pos (1- (match-end 0))) 'bracket)
16339 ((= pos (match-end 0)) 'after)
16340 ((org-pos-in-match-range pos 2) 'year)
16341 ((org-pos-in-match-range pos 3) 'month)
16342 ((org-pos-in-match-range pos 7) 'hour)
16343 ((org-pos-in-match-range pos 8) 'minute)
16344 ((or (org-pos-in-match-range pos 4)
16345 (org-pos-in-match-range pos 5)) 'day)
16346 ((and (> pos (or (match-end 8) (match-end 5)))
16347 (< pos (match-end 0)))
16348 (- pos (or (match-end 8) (match-end 5))))
16349 (t 'day))))
16350 ans))
16352 (defun org-toggle-timestamp-type ()
16353 "Toggle the type (<active> or [inactive]) of a time stamp."
16354 (interactive)
16355 (when (org-at-timestamp-p t)
16356 (let ((beg (match-beginning 0)) (end (match-end 0))
16357 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16358 (save-excursion
16359 (goto-char beg)
16360 (while (re-search-forward "[][<>]" end t)
16361 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16362 t t)))
16363 (message "Timestamp is now %sactive"
16364 (if (equal (char-after beg) ?<) "" "in")))))
16366 (defvar org-clock-history) ; defined in org-clock.el
16367 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
16368 (defun org-timestamp-change (n &optional what updown)
16369 "Change the date in the time stamp at point.
16370 The date will be changed by N times WHAT. WHAT can be `day', `month',
16371 `year', `minute', `second'. If WHAT is not given, the cursor position
16372 in the timestamp determines what will be changed."
16373 (let ((origin (point)) origin-cat
16374 with-hm inactive
16375 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16376 org-ts-what
16377 extra rem
16378 ts time time0 fixnext clrgx)
16379 (if (not (org-at-timestamp-p t))
16380 (error "Not at a timestamp"))
16381 (if (and (not what) (eq org-ts-what 'bracket))
16382 (org-toggle-timestamp-type)
16383 ;; Point isn't on brackets. Remember the part of the time-stamp
16384 ;; the point was in. Indeed, size of time-stamps may change,
16385 ;; but point must be kept in the same category nonetheless.
16386 (setq origin-cat org-ts-what)
16387 (if (and (not what) (not (eq org-ts-what 'day))
16388 org-display-custom-times
16389 (get-text-property (point) 'display)
16390 (not (get-text-property (1- (point)) 'display)))
16391 (setq org-ts-what 'day))
16392 (setq org-ts-what (or what org-ts-what)
16393 inactive (= (char-after (match-beginning 0)) ?\[)
16394 ts (match-string 0))
16395 (replace-match "")
16396 (if (string-match
16398 ts)
16399 (setq extra (match-string 1 ts)))
16401 (setq with-hm t))
16402 (setq time0 (org-parse-time-string ts))
16403 (when (and updown
16404 (eq org-ts-what 'minute)
16405 (not current-prefix-arg))
16406 ;; This looks like s-up and s-down. Change by one rounding step.
16407 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16408 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16409 (setcar (cdr time0) (+ (nth 1 time0)
16410 (if (> n 0) (- rem) (- dm rem))))))
16411 (setq time
16412 (encode-time (or (car time0) 0)
16413 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16414 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16415 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16416 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16417 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16418 (nthcdr 6 time0)))
16419 (when (and (member org-ts-what '(hour minute))
16420 extra
16422 (setq extra (org-modify-ts-extra
16423 extra
16424 (if (eq org-ts-what 'hour) 2 5)
16425 n dm)))
16426 (when (integerp org-ts-what)
16427 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16428 (if (eq what 'calendar)
16429 (let ((cal-date (org-get-date-from-calendar)))
16430 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16431 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16432 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16433 (setcar time0 (or (car time0) 0))
16434 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16435 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16436 (setq time (apply 'encode-time time0))))
16437 ;; Insert the new time-stamp, and ensure point stays in the same
16438 ;; category as before (i.e. not after the last position in that
16439 ;; category).
16440 (let ((pos (point)))
16441 ;; Stay before inserted string. `save-excursion' is of no use.
16442 (setq org-last-changed-timestamp
16443 (org-insert-time-stamp time with-hm inactive nil nil extra))
16444 (goto-char pos))
16445 (save-match-data
16446 (looking-at org-ts-regexp3)
16447 (goto-char (cond
16448 ;; `day' category ends before `hour' if any, or at
16449 ;; the end of the day name.
16450 ((eq origin-cat 'day)
16451 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16452 ((eq origin-cat 'hour) (min (match-end 7) origin))
16453 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16454 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16455 ;; `year' and `month' have both fixed size: point
16456 ;; couldn't have moved into another part.
16457 (t origin))))
16458 ;; Update clock if on a CLOCK line.
16459 (org-clock-update-time-maybe)
16460 ;; Maybe adjust the closest clock in `org-clock-history'
16461 (when org-clock-adjust-closest
16462 (if (not (and (org-at-clock-log-p)
16463 (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
16464 org-clock-history))))))
16465 (message "No clock to adjust")
16466 (cond ((save-excursion ; fix previous clock?
16467 (re-search-backward org-ts-regexp0 nil t)
16470 ((save-excursion ; fix next clock?
16471 (re-search-backward org-ts-regexp0 nil t)
16474 (save-window-excursion
16475 ;; Find closest clock to point, adjust the previous/next one in history
16476 (let* ((p (save-excursion (org-back-to-heading t)))
16477 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
16478 (clfixnth
16479 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
16480 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
16481 (if (not clfixpos)
16482 (message "No clock to adjust")
16483 (save-excursion
16484 (org-goto-marker-or-bmk clfixpos)
16485 (org-show-subtree)
16486 (when (re-search-forward clrgx nil t)
16487 (goto-char (match-beginning 1))
16488 (let (org-clock-adjust-closest)
16489 (org-timestamp-change n org-ts-what updown))
16490 (message "Clock adjusted in %s for heading: %s"
16491 (file-name-nondirectory (buffer-file-name))
16492 (org-get-heading t t)))))))))
16493 ;; Try to recenter the calendar window, if any.
16494 (if (and org-calendar-follow-timestamp-change
16495 (get-buffer-window "*Calendar*" t)
16496 (memq org-ts-what '(day month year)))
16497 (org-recenter-calendar (time-to-days time))))))
16499 (defun org-modify-ts-extra (s pos n dm)
16500 "Change the different parts of the lead-time and repeat fields in timestamp."
16501 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16502 ng h m new rem)
16503 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16504 (cond
16505 ((or (org-pos-in-match-range pos 2)
16506 (org-pos-in-match-range pos 3))
16507 (setq m (string-to-number (match-string 3 s))
16508 h (string-to-number (match-string 2 s)))
16509 (if (org-pos-in-match-range pos 2)
16510 (setq h (+ h n))
16511 (setq n (* dm (org-no-warnings (signum n))))
16512 (when (not (= 0 (setq rem (% m dm))))
16513 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16514 (setq m (+ m n)))
16515 (if (< m 0) (setq m (+ m 60) h (1- h)))
16516 (if (> m 59) (setq m (- m 60) h (1+ h)))
16517 (setq h (min 24 (max 0 h)))
16518 (setq ng 1 new (format "-%02d:%02d" h m)))
16519 ((org-pos-in-match-range pos 6)
16520 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16521 ((org-pos-in-match-range pos 5)
16522 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16524 ((org-pos-in-match-range pos 9)
16525 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16526 ((org-pos-in-match-range pos 8)
16527 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16529 (when ng
16530 (setq s (concat
16531 (substring s 0 (match-beginning ng))
16532 new
16533 (substring s (match-end ng))))))
16534 s))
16536 (defun org-recenter-calendar (date)
16537 "If the calendar is visible, recenter it to DATE."
16538 (let ((cwin (get-buffer-window "*Calendar*" t)))
16539 (when cwin
16540 (let ((calendar-move-hook nil))
16541 (with-selected-window cwin
16542 (calendar-goto-date (if (listp date) date
16543 (calendar-gregorian-from-absolute date))))))))
16545 (defun org-goto-calendar (&optional arg)
16546 "Go to the Emacs calendar at the current date.
16547 If there is a time stamp in the current line, go to that date.
16548 A prefix ARG can be used to force the current date."
16549 (interactive "P")
16550 (let ((tsr org-ts-regexp) diff
16551 (calendar-move-hook nil)
16552 (calendar-view-holidays-initially-flag nil)
16553 (calendar-view-diary-initially-flag nil))
16554 (if (or (org-at-timestamp-p)
16555 (save-excursion
16556 (beginning-of-line 1)
16557 (looking-at (concat ".*" tsr))))
16558 (let ((d1 (time-to-days (current-time)))
16559 (d2 (time-to-days
16560 (org-time-string-to-time (match-string 1)))))
16561 (setq diff (- d2 d1))))
16562 (calendar)
16563 (calendar-goto-today)
16564 (if (and diff (not arg)) (calendar-forward-day diff))))
16566 (defun org-get-date-from-calendar ()
16567 "Return a list (month day year) of date at point in calendar."
16568 (with-current-buffer "*Calendar*"
16569 (save-match-data
16570 (calendar-cursor-to-date))))
16572 (defun org-date-from-calendar ()
16573 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16574 If there is already a time stamp at the cursor position, update it."
16575 (interactive)
16576 (if (org-at-timestamp-p t)
16577 (org-timestamp-change 0 'calendar)
16578 (let ((cal-date (org-get-date-from-calendar)))
16579 (org-insert-time-stamp
16580 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16582 (defun org-minutes-to-hh:mm-string (m)
16583 "Compute H:MM from a number of minutes."
16584 (let ((h (/ m 60)))
16585 (setq m (- m (* 60 h)))
16586 (format org-time-clocksum-format h m)))
16588 (defun org-hh:mm-string-to-minutes (s)
16589 "Convert a string H:MM to a number of minutes.
16590 If the string is just a number, interpret it as minutes.
16591 In fact, the first hh:mm or number in the string will be taken,
16592 there can be extra stuff in the string.
16593 If no number is found, the return value is 0."
16594 (cond
16595 ((integerp s) s)
16597 (+ (* (string-to-number (match-string 1 s)) 60)
16598 (string-to-number (match-string 2 s))))
16600 (string-to-number (match-string 1 s)))
16601 (t 0)))
16603 (defcustom org-effort-durations
16604 `(("h" . 60)
16605 ("d" . ,(* 60 8))
16606 ("w" . ,(* 60 8 5))
16607 ("m" . ,(* 60 8 5 4))
16608 ("y" . ,(* 60 8 5 40)))
16609 "Conversion factor to minutes for an effort modifier.
16611 Each entry has the form (MODIFIER . MINUTES).
16613 In an effort string, a number followed by MODIFIER is multiplied
16614 by the specified number of MINUTES to obtain an effort in
16615 minutes.
16619 :group 'org-agenda
16620 :version "24.1"
16621 :type '(alist :key-type (string :tag "Modifier")
16622 :value-type (number :tag "Minutes")))
16624 (defun org-duration-string-to-minutes (s &optional output-to-string)
16625 "Convert a duration string S to minutes.
16627 A bare number is interpreted as minutes, modifiers can be set by
16628 customizing `org-effort-durations' (which see).
16630 Entries containing a colon are interpreted as H:MM by
16631 `org-hh:mm-string-to-minutes'."
16632 (let ((result 0)
16634 (regexp-opt (mapcar 'car org-effort-durations))
16636 (while (string-match re s)
16637 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16638 (string-to-number (match-string 1 s))))
16639 (setq s (replace-match "" nil t s)))
16640 (setq result (floor result))
16641 (incf result (org-hh:mm-string-to-minutes s))
16642 (if output-to-string (number-to-string result) result)))
16644 ;;;; Files
16646 (defun org-save-all-org-buffers ()
16647 "Save all Org-mode buffers without user confirmation."
16648 (interactive)
16649 (message "Saving all Org-mode buffers...")
16650 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
16651 (when (featurep 'org-id) (org-id-locations-save))
16652 (message "Saving all Org-mode buffers... done"))
16654 (defun org-revert-all-org-buffers ()
16655 "Revert all Org-mode buffers.
16656 Prompt for confirmation when there are unsaved changes.
16657 Be sure you know what you are doing before letting this function
16658 overwrite your changes.
16660 This function is useful in a setup where one tracks org files
16661 with a version control system, to revert on one machine after pulling
16662 changes from another. I believe the procedure must be like this:
16664 1. M-x org-save-all-org-buffers
16665 2. Pull changes from the other machine, resolve conflicts
16666 3. M-x org-revert-all-org-buffers"
16667 (interactive)
16668 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16669 (error "Abort"))
16670 (save-excursion
16671 (save-window-excursion
16672 (mapc
16673 (lambda (b)
16674 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
16675 (with-current-buffer b buffer-file-name))
16676 (org-pop-to-buffer-same-window b)
16677 (revert-buffer t 'no-confirm)))
16678 (buffer-list))
16679 (when (and (featurep 'org-id) org-id-track-globally)
16680 (org-id-locations-load)))))
16682 ;;;; Agenda files
16684 ;;;###autoload
16685 (defun org-switchb (&optional arg)
16686 "Switch between Org buffers.
16687 With one prefix argument, restrict available buffers to files.
16688 With two prefix arguments, restrict available buffers to agenda files.
16690 Defaults to `iswitchb' for buffer name completion.
16691 Set `org-completion-use-ido' to make it use ido instead."
16692 (interactive "P")
16693 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16694 ((equal arg '(16)) (org-buffer-list 'agenda))
16695 (t (org-buffer-list))))
16696 (org-completion-use-iswitchb org-completion-use-iswitchb)
16697 (org-completion-use-ido org-completion-use-ido))
16698 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16699 (setq org-completion-use-iswitchb t))
16700 (org-pop-to-buffer-same-window
16701 (org-icompleting-read "Org buffer: "
16702 (mapcar 'list (mapcar 'buffer-name blist))
16703 nil t))))
16705 ;;; Define some older names previously used for this functionality
16706 ;;;###autoload
16707 (defalias 'org-ido-switchb 'org-switchb)
16708 ;;;###autoload
16709 (defalias 'org-iswitchb 'org-switchb)
16711 (defun org-buffer-list (&optional predicate exclude-tmp)
16712 "Return a list of Org buffers.
16713 PREDICATE can be `export', `files' or `agenda'.
16715 export restrict the list to Export buffers.
16716 files restrict the list to buffers visiting Org files.
16717 agenda restrict the list to buffers visiting agenda files.
16719 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16720 (let* ((bfn nil)
16721 (agenda-files (and (eq predicate 'agenda)
16722 (mapcar 'file-truename (org-agenda-files t))))
16723 (filter
16724 (cond
16725 ((eq predicate 'files)
16726 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
16727 ((eq predicate 'export)
16728 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16729 ((eq predicate 'agenda)
16730 (lambda (b)
16731 (with-current-buffer b
16732 (and (derived-mode-p 'org-mode)
16733 (setq bfn (buffer-file-name b))
16734 (member (file-truename bfn) agenda-files)))))
16735 (t (lambda (b) (with-current-buffer b
16736 (or (derived-mode-p 'org-mode)
16737 (string-match "\*Org .*Export"
16738 (buffer-name b)))))))))
16739 (delq nil
16740 (mapcar
16741 (lambda(b)
16742 (if (and (funcall filter b)
16743 (or (not exclude-tmp)
16744 (not (string-match "tmp" (buffer-name b)))))
16745 b
16746 nil))
16747 (buffer-list)))))
16749 (defun org-agenda-files (&optional unrestricted archives)
16750 "Get the list of agenda files.
16751 Optional UNRESTRICTED means return the full list even if a restriction
16752 is currently in place.
16753 When ARCHIVES is t, include all archive files that are really being
16754 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16755 `org-agenda-archives-mode' is t."
16756 (let ((files
16757 (cond
16758 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16759 ((stringp org-agenda-files) (org-read-agenda-file-list))
16760 ((listp org-agenda-files) org-agenda-files)
16761 (t (error "Invalid value of `org-agenda-files'")))))
16762 (setq files (apply 'append
16763 (mapcar (lambda (f)
16764 (if (file-directory-p f)
16765 (directory-files
16766 f t org-agenda-file-regexp)
16767 (list f)))
16768 files)))
16769 (when org-agenda-skip-unavailable-files
16770 (setq files (delq nil
16771 (mapcar (function
16772 (lambda (file)
16773 (and (file-readable-p file) file)))
16774 files))))
16775 (when (or (eq archives t)
16776 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16777 (setq files (org-add-archive-files files)))
16778 files))
16780 (defun org-agenda-file-p (&optional file)
16781 "Return non-nil, if FILE is an agenda file.
16782 If FILE is omitted, use the file associated with the current
16783 buffer."
16784 (member (or file (buffer-file-name))
16785 (org-agenda-files t)))
16787 (defun org-edit-agenda-file-list ()
16788 "Edit the list of agenda files.
16789 Depending on setup, this either uses customize to edit the variable
16790 `org-agenda-files', or it visits the file that is holding the list. In the
16791 latter case, the buffer is set up in a way that saving it automatically kills
16792 the buffer and restores the previous window configuration."
16793 (interactive)
16794 (if (stringp org-agenda-files)
16795 (let ((cw (current-window-configuration)))
16796 (find-file org-agenda-files)
16797 (org-set-local 'org-window-configuration cw)
16798 (org-add-hook 'after-save-hook
16799 (lambda ()
16800 (set-window-configuration
16801 (prog1 org-window-configuration
16802 (kill-buffer (current-buffer))))
16803 (org-install-agenda-files-menu)
16804 (message "New agenda file list installed"))
16805 nil 'local)
16806 (message "%s" (substitute-command-keys
16808 (customize-variable 'org-agenda-files)))
16810 (defun org-store-new-agenda-file-list (list)
16811 "Set new value for the agenda file list and save it correctly."
16812 (if (stringp org-agenda-files)
16813 (let ((fe (org-read-agenda-file-list t)) b u)
16814 (while (setq b (find-buffer-visiting org-agenda-files))
16815 (kill-buffer b))
16816 (with-temp-file org-agenda-files
16817 (insert
16818 (mapconcat
16819 (lambda (f) ;; Keep un-expanded entries.
16820 (if (setq u (assoc f fe))
16821 (cdr u)
16822 f))
16825 (let ((org-mode-hook nil) (org-inhibit-startup t)
16826 (org-insert-mode-line-in-empty-file nil))
16827 (setq org-agenda-files list)
16828 (customize-save-variable 'org-agenda-files org-agenda-files))))
16830 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16831 "Read the list of agenda files from a file.
16832 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16833 filenames, used by `org-store-new-agenda-file-list' to write back
16834 un-expanded file names."
16835 (when (file-directory-p org-agenda-files)
16836 (error "`org-agenda-files' cannot be a single directory"))
16837 (when (stringp org-agenda-files)
16838 (with-temp-buffer
16839 (insert-file-contents org-agenda-files)
16840 (mapcar
16841 (lambda (f)
16842 (let ((e (expand-file-name (substitute-in-file-name f)
16843 org-directory)))
16844 (if pair-with-expansion
16845 (cons e f)
16846 e)))
16849 ;;;###autoload
16850 (defun org-cycle-agenda-files ()
16851 "Cycle through the files in `org-agenda-files'.
16852 If the current buffer visits an agenda file, find the next one in the list.
16853 If the current buffer does not, find the first agenda file."
16854 (interactive)
16855 (let* ((fs (org-agenda-files t))
16856 (files (append fs (list (car fs))))
16857 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16858 file)
16859 (unless files (error "No agenda files"))
16860 (catch 'exit
16861 (while (setq file (pop files))
16862 (if (equal (file-truename file) tcf)
16863 (when (car files)
16864 (find-file (car files))
16865 (throw 'exit t))))
16866 (find-file (car fs)))
16867 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16869 (defun org-agenda-file-to-front (&optional to-end)
16870 "Move/add the current file to the top of the agenda file list.
16871 If the file is not present in the list, it is added to the front. If it is
16872 present, it is moved there. With optional argument TO-END, add/move to the
16873 end of the list."
16874 (interactive "P")
16875 (let ((org-agenda-skip-unavailable-files nil)
16876 (file-alist (mapcar (lambda (x)
16877 (cons (file-truename x) x))
16878 (org-agenda-files t)))
16879 (ctf (file-truename
16880 (or buffer-file-name
16881 (error "Please save the current buffer to a file"))))
16882 x had)
16883 (setq x (assoc ctf file-alist) had x)
16885 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16886 (if to-end
16887 (setq file-alist (append (delq x file-alist) (list x)))
16888 (setq file-alist (cons x (delq x file-alist))))
16889 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16890 (org-install-agenda-files-menu)
16891 (message "File %s to %s of agenda file list"
16892 (if had "moved" "added") (if to-end "end" "front"))))
16894 (defun org-remove-file (&optional file)
16895 "Remove current file from the list of files in variable `org-agenda-files'.
16896 These are the files which are being checked for agenda entries.
16897 Optional argument FILE means use this file instead of the current."
16898 (interactive)
16899 (let* ((org-agenda-skip-unavailable-files nil)
16900 (file (or file buffer-file-name
16901 (error "Current buffer does not visit a file")))
16902 (true-file (file-truename file))
16903 (afile (abbreviate-file-name file))
16904 (files (delq nil (mapcar
16905 (lambda (x)
16906 (if (equal true-file
16907 (file-truename x))
16908 nil x))
16909 (org-agenda-files t)))))
16910 (if (not (= (length files) (length (org-agenda-files t))))
16911 (progn
16912 (org-store-new-agenda-file-list files)
16913 (org-install-agenda-files-menu)
16914 (message "Removed file: %s" afile))
16915 (message "File was not in list: %s (not removed)" afile))))
16917 (defun org-file-menu-entry (file)
16918 (vector file (list 'find-file file) t))
16920 (defun org-check-agenda-file (file)
16921 "Make sure FILE exists. If not, ask user what to do."
16922 (when (not (file-exists-p file))
16923 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
16924 (abbreviate-file-name file))
16925 (let ((r (downcase (read-char-exclusive))))
16926 (cond
16927 ((equal r ?r)
16928 (org-remove-file file)
16929 (throw 'nextfile t))
16930 (t (error "Abort"))))))
16932 (defun org-get-agenda-file-buffer (file)
16933 "Get a buffer visiting FILE. If the buffer needs to be created, add
16934 it to the list of buffers which might be released later."
16935 (let ((buf (org-find-base-buffer-visiting file)))
16936 (if buf
16937 buf ; just return it
16938 ;; Make a new buffer and remember it
16939 (setq buf (find-file-noselect file))
16940 (if buf (push buf org-agenda-new-buffers))
16941 buf)))
16943 (defun org-release-buffers (blist)
16944 "Release all buffers in list, asking the user for confirmation when needed.
16945 When a buffer is unmodified, it is just killed. When modified, it is saved
16946 \(if the user agrees) and then killed."
16947 (let (buf file)
16948 (while (setq buf (pop blist))
16949 (setq file (buffer-file-name buf))
16950 (when (and (buffer-modified-p buf)
16951 file
16952 (y-or-n-p (format "Save file %s? " file)))
16953 (with-current-buffer buf (save-buffer)))
16954 (kill-buffer buf))))
16956 (defun org-agenda-prepare-buffers (files)
16957 "Create buffers for all agenda files, protect archived trees and comments."
16958 (interactive)
16959 (let ((pa '(:org-archived t))
16960 (pc '(:org-comment t))
16961 (pall '(:org-archived t :org-comment t))
16962 (inhibit-read-only t)
16963 (rea (concat ":" org-archive-tag ":"))
16964 bmp file re)
16965 (save-excursion
16966 (save-restriction
16967 (while (setq file (pop files))
16968 (catch 'nextfile
16969 (if (bufferp file)
16970 (set-buffer file)
16971 (org-check-agenda-file file)
16972 (set-buffer (org-get-agenda-file-buffer file)))
16973 (widen)
16974 (setq bmp (buffer-modified-p))
16975 (org-refresh-category-properties)
16976 (setq org-todo-keywords-for-agenda
16977 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16978 (setq org-done-keywords-for-agenda
16979 (append org-done-keywords-for-agenda org-done-keywords))
16980 (setq org-todo-keyword-alist-for-agenda
16981 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16982 (setq org-drawers-for-agenda
16983 (append org-drawers-for-agenda org-drawers))
16984 (setq org-tag-alist-for-agenda
16985 (append org-tag-alist-for-agenda org-tag-alist))
16987 (save-excursion
16988 (remove-text-properties (point-min) (point-max) pall)
16989 (when org-agenda-skip-archived-trees
16990 (goto-char (point-min))
16991 (while (re-search-forward rea nil t)
16992 (if (org-at-heading-p t)
16993 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16994 (goto-char (point-min))
16995 (setq re (format org-heading-keyword-regexp-format
16996 org-comment-string))
16997 (while (re-search-forward re nil t)
16998 (add-text-properties
16999 (match-beginning 0) (org-end-of-subtree t) pc)))
17000 (set-buffer-modified-p bmp)))))
17001 (setq org-todo-keywords-for-agenda
17002 (org-uniquify org-todo-keywords-for-agenda))
17003 (setq org-todo-keyword-alist-for-agenda
17004 (org-uniquify org-todo-keyword-alist-for-agenda)
17005 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
17007 ;;;; Embedded LaTeX
17009 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17010 "Keymap for the minor `org-cdlatex-mode'.")
17012 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
17013 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
17014 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
17015 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
17016 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
17018 (defvar org-cdlatex-texmathp-advice-is-done nil
17019 "Flag remembering if we have applied the advice to texmathp already.")
17021 (define-minor-mode org-cdlatex-mode
17022 "Toggle the minor `org-cdlatex-mode'.
17023 This mode supports entering LaTeX environment and math in LaTeX fragments
17024 in Org-mode.
17026 nil " OCDL" nil
17027 (when org-cdlatex-mode
17028 (require 'cdlatex)
17029 (run-hooks 'cdlatex-mode-hook)
17030 (cdlatex-compute-tables))
17031 (unless org-cdlatex-texmathp-advice-is-done
17032 (setq org-cdlatex-texmathp-advice-is-done t)
17033 (defadvice texmathp (around org-math-always-on activate)
17034 "Always return t in org-mode buffers.
17035 This is because we want to insert math symbols without dollars even outside
17036 the LaTeX math segments. If Orgmode thinks that point is actually inside
17037 an embedded LaTeX fragment, let texmathp do its job.
17039 (interactive)
17040 (let (p)
17041 (cond
17042 ((not (derived-mode-p 'org-mode)) ad-do-it)
17043 ((eq this-command 'cdlatex-math-symbol)
17044 (setq ad-return-value t
17045 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
17046 (t
17047 (let ((p (org-inside-LaTeX-fragment-p)))
17048 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
17049 (setq ad-return-value t
17050 texmathp-why '("Org-mode embedded math" . 0))
17051 (if p ad-do-it)))))))))
17053 (defun turn-on-org-cdlatex ()
17054 "Unconditionally turn on `org-cdlatex-mode'."
17055 (org-cdlatex-mode 1))
17057 (defun org-inside-LaTeX-fragment-p ()
17058 "Test if point is inside a LaTeX fragment.
17060 sequence appearing also before point.
17061 Even though the matchers for math are configurable, this function assumes
17063 delimiters are skipped when they have been removed by customization.
17064 The return value is nil, or a cons cell with the delimiter and the
17065 position of this delimiter.
17067 This function does a reasonably good job, but can locally be fooled by
17068 for example currency specifications. For example it will assume being in
17070 fragments that are properly closed, but during editing, we have to live
17071 with the uncertainty caused by missing closing delimiters. This function
17072 looks only before point, not after."
17073 (catch 'exit
17074 (let ((pos (point))
17075 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
17076 (lim (progn
17078 (point)))
17079 dd-on str (start 0) m re)
17080 (goto-char pos)
17081 (when dodollar
17083 re (nth 1 (assoc "$" org-latex-regexps)))
17084 (while (string-match re str start)
17085 (cond
17086 ((= (match-end 0) (length str))
17087 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
17088 ((= (match-end 0) (- (length str) 5))
17089 (throw 'exit nil))
17090 (t (setq start (match-end 0))))))
17091 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17092 (goto-char pos)
17093 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
17094 (and (match-beginning 2) (throw 'exit nil))
17095 ;; count $$
17097 (setq dd-on (not dd-on)))
17098 (goto-char pos)
17099 (if dd-on (cons "$$" m))))))
17101 (defun org-inside-latex-macro-p ()
17102 "Is point inside a LaTeX macro or its arguments?"
17103 (save-match-data
17104 (org-in-regexp
17107 (defun org-try-cdlatex-tab ()
17108 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17109 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17110 - inside a LaTeX fragment, or
17111 - after the first word in a line, where an abbreviation expansion could
17112 insert a LaTeX environment."
17113 (when org-cdlatex-mode
17114 (cond
17115 ;; Before any word on the line: No expansion possible.
17117 ;; Just after first word on the line: Expand it. Make sure it
17118 ;; cannot happen on headlines, though.
17119 ((save-excursion
17120 (skip-chars-backward "a-zA-Z0-9*")
17122 (and (bolp) (not (org-at-heading-p))))
17123 (cdlatex-tab) t)
17124 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
17126 (defun org-cdlatex-underscore-caret (&optional arg)
17127 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17128 Revert to the normal definition outside of these fragments."
17129 (interactive "P")
17130 (if (org-inside-LaTeX-fragment-p)
17131 (call-interactively 'cdlatex-sub-superscript)
17132 (let (org-cdlatex-mode)
17133 (call-interactively (key-binding (vector last-input-event))))))
17135 (defun org-cdlatex-math-modify (&optional arg)
17136 "Execute `cdlatex-math-modify' in LaTeX fragments.
17137 Revert to the normal definition outside of these fragments."
17138 (interactive "P")
17139 (if (org-inside-LaTeX-fragment-p)
17140 (call-interactively 'cdlatex-math-modify)
17141 (let (org-cdlatex-mode)
17142 (call-interactively (key-binding (vector last-input-event))))))
17144 (defvar org-latex-fragment-image-overlays nil
17145 "List of overlays carrying the images of latex fragments.")
17146 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
17148 (defun org-remove-latex-fragment-image-overlays ()
17149 "Remove all overlays with LaTeX fragment images in current buffer."
17150 (mapc 'delete-overlay org-latex-fragment-image-overlays)
17151 (setq org-latex-fragment-image-overlays nil))
17153 (defun org-preview-latex-fragment (&optional subtree)
17154 "Preview the LaTeX fragment at point, or all locally or globally.
17155 If the cursor is in a LaTeX fragment, create the image and overlay
17156 it over the source code. If there is no fragment at point, display
17157 all fragments in the current text, from one headline to the next. With
17158 prefix SUBTREE, display all fragments in the current subtree. With a
17160 the cursor is before the first headline,
17161 display all fragments in the buffer.
17163 (interactive "P")
17164 (unless buffer-file-name
17165 (error "Can't preview LaTeX fragment in a non-file buffer"))
17166 (org-remove-latex-fragment-image-overlays)
17167 (save-excursion
17168 (save-restriction
17169 (let (beg end at msg)
17170 (cond
17171 ((or (equal subtree '(16))
17172 (not (save-excursion
17173 (re-search-backward org-outline-regexp-bol nil t))))
17174 (setq beg (point-min) end (point-max)
17175 msg "Creating images for buffer...%s"))
17176 ((equal subtree '(4))
17177 (org-back-to-heading)
17178 (setq beg (point) end (org-end-of-subtree t)
17179 msg "Creating images for subtree...%s"))
17180 (t
17181 (if (setq at (org-inside-LaTeX-fragment-p))
17182 (goto-char (max (point-min) (- (cdr at) 2)))
17183 (org-back-to-heading))
17184 (setq beg (point) end (progn (outline-next-heading) (point))
17185 msg (if at "Creating image...%s"
17186 "Creating images for entry...%s"))))
17187 (message msg "")
17188 (narrow-to-region beg end)
17189 (goto-char beg)
17190 (org-format-latex
17191 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
17192 (file-name-nondirectory
17193 buffer-file-name)))
17194 default-directory 'overlays msg at 'forbuffer
17195 org-latex-create-formula-image-program)
17196 (message msg "done. Use `C-c C-c' to remove images.")))))
17198 (defvar org-latex-regexps
17200 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17203 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
17207 "Regular expressions for matching embedded LaTeX.")
17209 (defvar org-export-have-math nil) ;; dynamic scoping
17210 (defun org-format-latex (prefix &optional dir overlays msg at
17211 forbuffer processing-type)
17212 "Replace LaTeX fragments with links to an image, and produce images.
17213 Some of the options can be changed using the variable
17214 `org-format-latex-options'."
17215 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
17216 (let* ((prefixnodir (file-name-nondirectory prefix))
17217 (absprefix (expand-file-name prefix dir))
17218 (todir (file-name-directory absprefix))
17219 (opt org-format-latex-options)
17220 (matchers (plist-get opt :matchers))
17221 (re-list org-latex-regexps)
17222 (org-format-latex-header-extra
17223 (plist-get (org-infile-export-plist) :latex-header-extra))
17224 (cnt 0) txt hash link beg end re e checkdir
17225 executables-checked string
17226 m n block-type block linkfile movefile ov)
17227 ;; Check the different regular expressions
17228 (while (setq e (pop re-list))
17229 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
17231 (when (member m matchers)
17232 (goto-char (point-min))
17233 (while (re-search-forward re nil t)
17234 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
17235 (not (get-text-property (match-beginning n)
17236 'org-protected))
17237 (or (not overlays)
17238 (not (eq (get-char-property (match-beginning n)
17239 'org-overlay-type)
17240 'org-latex-overlay))))
17241 (setq org-export-have-math t)
17242 (cond
17243 ((eq processing-type 'verbatim)
17244 ;; Leave the text verbatim, just protect it
17245 (add-text-properties (match-beginning n) (match-end n)
17246 '(org-protected t)))
17247 ((eq processing-type 'mathjax)
17248 ;; Prepare for MathJax processing
17249 (setq string (match-string n))
17250 (if (member m '("$" "$1"))
17251 (save-excursion
17252 (delete-region (match-beginning n) (match-end n))
17253 (goto-char (match-beginning n))
17256 '(org-protected t))))
17257 (add-text-properties (match-beginning n) (match-end n)
17258 '(org-protected t))))
17259 ((or (eq processing-type 'dvipng)
17260 (eq processing-type 'imagemagick))
17261 ;; Process to an image
17262 (setq txt (match-string n)
17263 beg (match-beginning n) end (match-end n)
17264 cnt (1+ cnt))
17265 (let (print-length print-level) ; make sure full list is printed
17266 (setq hash (sha1 (prin1-to-string
17267 (list org-format-latex-header
17268 org-format-latex-header-extra
17269 org-export-latex-default-packages-alist
17270 org-export-latex-packages-alist
17271 org-format-latex-options
17272 forbuffer txt)))
17273 linkfile (format "%s_%s.png" prefix hash)
17274 movefile (format "%s_%s.png" absprefix hash)))
17275 (setq link (concat block "[[file:" linkfile "]]" block))
17276 (if msg (message msg cnt))
17277 (goto-char beg)
17278 (unless checkdir ; make sure the directory exists
17279 (setq checkdir t)
17280 (or (file-directory-p todir) (make-directory todir t)))
17281 (cond
17282 ((eq processing-type 'dvipng)
17283 (unless executables-checked
17284 (org-check-external-command
17285 "latex" "needed to convert LaTeX fragments to images")
17286 (org-check-external-command
17287 "dvipng" "needed to convert LaTeX fragments to images")
17288 (setq executables-checked t))
17289 (unless (file-exists-p movefile)
17290 (org-create-formula-image-with-dvipng
17291 txt movefile opt forbuffer)))
17292 ((eq processing-type 'imagemagick)
17293 (unless executables-checked
17294 (org-check-external-command
17295 "convert" "you need to install imagemagick")
17296 (setq executables-checked t))
17297 (unless (file-exists-p movefile)
17298 (org-create-formula-image-with-imagemagick
17299 txt movefile opt forbuffer))))
17300 (if overlays
17301 (progn
17302 (mapc (lambda (o)
17303 (if (eq (overlay-get o 'org-overlay-type)
17304 'org-latex-overlay)
17305 (delete-overlay o)))
17306 (overlays-in beg end))
17307 (setq ov (make-overlay beg end))
17308 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17309 (if (featurep 'xemacs)
17310 (progn
17311 (overlay-put ov 'invisible t)
17312 (overlay-put
17313 ov 'end-glyph
17314 (make-glyph (vector 'png :file movefile))))
17315 (overlay-put
17316 ov 'display
17317 (list 'image :type 'png :file movefile :ascent 'center)))
17318 (push ov org-latex-fragment-image-overlays)
17319 (goto-char end))
17320 (delete-region beg end)
17321 (insert (org-add-props link
17322 (list 'org-latex-src
17323 (replace-regexp-in-string
17325 'org-latex-src-embed-type
17326 (if block-type 'paragraph 'character))))))
17327 ((eq processing-type 'mathml)
17328 ;; Process to MathML
17329 (unless executables-checked
17330 (unless (save-match-data (org-format-latex-mathml-available-p))
17331 (error "LaTeX to MathML converter not configured"))
17332 (setq executables-checked t))
17333 (setq txt (match-string n)
17334 beg (match-beginning n) end (match-end n)
17335 cnt (1+ cnt))
17336 (if msg (message msg cnt))
17337 (goto-char beg)
17338 (delete-region beg end)
17339 (insert (org-format-latex-as-mathml
17340 txt block-type prefix dir)))
17341 (t
17342 (error "Unknown conversion type %s for latex fragments"
17343 processing-type)))))))))
17345 (defun org-create-math-formula (latex-frag &optional mathml-file)
17346 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17347 Use `org-latex-to-mathml-convert-command'. If the conversion is
17349 elements otherwise return nil. When MATHML-FILE is specified,
17350 write the results in to that file. When invoked as an
17351 interactive command, prompt for LATEX-FRAG, with initial value
17352 set to the current active region and echo the results for user
17353 inspection."
17354 (interactive (list (let ((frag (when (org-region-active-p)
17355 (buffer-substring-no-properties
17356 (region-beginning) (region-end)))))
17357 (read-string "LaTeX Fragment: " frag nil frag))))
17358 (unless latex-frag (error "Invalid latex-frag"))
17359 (let* ((tmp-in-file (file-relative-name
17360 (make-temp-name (expand-file-name "ltxmathml-in"))))
17361 (ignore (write-region latex-frag nil tmp-in-file))
17362 (tmp-out-file (file-relative-name
17363 (make-temp-name (expand-file-name "ltxmathml-out"))))
17364 (cmd (format-spec
17365 org-latex-to-mathml-convert-command
17366 `((?j . ,(shell-quote-argument
17367 (expand-file-name org-latex-to-mathml-jar-file)))
17368 (?I . ,(shell-quote-argument tmp-in-file))
17369 (?o . ,(shell-quote-argument tmp-out-file)))))
17370 mathml shell-command-output)
17371 (when (org-called-interactively-p 'any)
17372 (unless (org-format-latex-mathml-available-p)
17373 (error "LaTeX to MathML converter not configured")))
17374 (message "Running %s" cmd)
17375 (setq shell-command-output (shell-command-to-string cmd))
17376 (setq mathml
17377 (when (file-readable-p tmp-out-file)
17378 (with-current-buffer (find-file-noselect tmp-out-file t)
17379 (goto-char (point-min))
17380 (when (re-search-forward
17381 (concat
17382 (regexp-quote
17385 (regexp-quote "</math>")) nil t)
17386 (prog1 (match-string 0) (kill-buffer))))))
17387 (cond
17388 (mathml
17389 (setq mathml
17391 (when mathml-file
17392 (write-region mathml nil mathml-file))
17393 (when (org-called-interactively-p 'any)
17394 (message mathml)))
17395 ((message "LaTeX to MathML conversion failed")
17396 (message shell-command-output)))
17397 (delete-file tmp-in-file)
17398 (when (file-exists-p tmp-out-file)
17399 (delete-file tmp-out-file))
17400 mathml))
17402 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17403 prefix &optional dir)
17404 "Use `org-create-math-formula' but check local cache first."
17405 (let* ((absprefix (expand-file-name prefix dir))
17406 (print-length nil) (print-level nil)
17407 (formula-id (concat
17408 "formula-"
17409 (sha1
17410 (prin1-to-string
17411 (list latex-frag
17412 org-latex-to-mathml-convert-command)))))
17413 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17414 (formula-cache-dir (file-name-directory formula-cache)))
17416 (unless (file-directory-p formula-cache-dir)
17417 (make-directory formula-cache-dir t))
17419 (unless (file-exists-p formula-cache)
17420 (org-create-math-formula latex-frag formula-cache))
17422 (if (file-exists-p formula-cache)
17423 ;; Successful conversion. Return the link to MathML file.
17424 (org-add-props
17425 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17427 'org-latex-src-embed-type (if latex-frag-type
17428 'paragraph 'character)))
17429 ;; Failed conversion. Return the LaTeX fragment verbatim
17430 (add-text-properties
17431 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17432 latex-frag)))
17434 ;; This function borrows from Ganesh Swami's latex2png.el
17435 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
17436 "This calls dvipng."
17437 (require 'org-latex)
17438 (let* ((tmpdir (if (featurep 'xemacs)
17439 (temp-directory)
17440 temporary-file-directory))
17441 (texfilebase (make-temp-name
17442 (expand-file-name "orgtex" tmpdir)))
17443 (texfile (concat texfilebase ".tex"))
17444 (dvifile (concat texfilebase ".dvi"))
17445 (pngfile (concat texfilebase ".png"))
17446 (fnh (if (featurep 'xemacs)
17447 (font-height (face-font 'default))
17448 (face-attribute 'default :height nil)))
17449 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17450 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17451 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17452 "Black"))
17453 (bg (or (plist-get options (if buffer :background :html-background))
17454 "Transparent")))
17455 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17456 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17457 (with-temp-file texfile
17458 (insert (org-splice-latex-header
17459 org-format-latex-header
17460 org-export-latex-default-packages-alist
17461 org-export-latex-packages-alist t
17462 org-format-latex-header-extra))
17464 (require 'org-latex)
17465 (org-export-latex-fix-inputenc))
17466 (let ((dir default-directory))
17467 (condition-case nil
17468 (progn
17469 (cd tmpdir)
17470 (call-process "latex" nil nil nil texfile))
17471 (error nil))
17472 (cd dir))
17473 (if (not (file-exists-p dvifile))
17474 (progn (message "Failed to create dvi file from %s" texfile) nil)
17475 (condition-case nil
17476 (if (featurep 'xemacs)
17477 (call-process "dvipng" nil nil nil
17478 "-fg" fg "-bg" bg
17479 "-T" "tight"
17480 "-o" pngfile
17481 dvifile)
17482 (call-process "dvipng" nil nil nil
17483 "-fg" fg "-bg" bg
17484 "-D" dpi
17485 ;;"-x" scale "-y" scale
17486 "-T" "tight"
17487 "-o" pngfile
17488 dvifile))
17489 (error nil))
17490 (if (not (file-exists-p pngfile))
17491 (if org-format-latex-signal-error
17492 (error "Failed to create png file from %s" texfile)
17493 (message "Failed to create png file from %s" texfile)
17494 nil)
17495 ;; Use the requested file name and clean up
17496 (copy-file pngfile tofile 'replace)
17497 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
17498 (if (file-exists-p (concat texfilebase e))
17499 (delete-file (concat texfilebase e))))
17500 pngfile))))
17502 (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
17503 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
17504 "This calls convert, which is included into imagemagick."
17505 (require 'org-latex)
17506 (let* ((tmpdir (if (featurep 'xemacs)
17507 (temp-directory)
17508 temporary-file-directory))
17509 (texfilebase (make-temp-name
17510 (expand-file-name "orgtex" tmpdir)))
17511 (texfile (concat texfilebase ".tex"))
17512 (pdffile (concat texfilebase ".pdf"))
17513 (pngfile (concat texfilebase ".png"))
17514 (fnh (if (featurep 'xemacs)
17515 (font-height (face-font 'default))
17516 (face-attribute 'default :height nil)))
17517 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17518 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17519 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17520 "black"))
17521 (bg (or (plist-get options (if buffer :background :html-background))
17522 "white")))
17523 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
17524 (setq fg (org-latex-color-format fg)))
17525 (if (eq bg 'default) (setq bg (org-latex-color :background))
17526 (setq bg (org-latex-color-format
17527 (if (string= bg "Transparent")(setq bg "white")))))
17528 (with-temp-file texfile
17529 (insert (org-splice-latex-header
17530 org-format-latex-header
17531 org-export-latex-default-packages-alist
17532 org-export-latex-packages-alist t
17533 org-format-latex-header-extra))
17539 string
17542 (require 'org-latex)
17543 (org-export-latex-fix-inputenc))
17544 (let ((dir default-directory) cmd cmds latex-frags-cmds)
17545 (condition-case nil
17546 (progn
17547 (cd tmpdir)
17548 (setq cmds org-latex-to-pdf-process)
17549 (while cmds
17550 (setq latex-frags-cmds (pop cmds))
17551 (if (listp latex-frags-cmds)
17552 (setq cmds nil)
17553 (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
17554 (while latex-frags-cmds
17555 (setq cmd (pop latex-frags-cmds))
17556 (while (string-match "%b" cmd)
17557 (setq cmd (replace-match
17558 (save-match-data
17559 (shell-quote-argument texfile))
17560 t t cmd)))
17561 (while (string-match "%f" cmd)
17562 (setq cmd (replace-match
17563 (save-match-data
17564 (shell-quote-argument (file-name-nondirectory texfile)))
17565 t t cmd)))
17566 (while (string-match "%o" cmd)
17567 (setq cmd (replace-match
17568 (save-match-data
17569 (shell-quote-argument (file-name-directory texfile)))
17570 t t cmd)))
17571 (setq cmd (split-string cmd))
17572 (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
17573 (error nil))
17574 (cd dir))
17575 (if (not (file-exists-p pdffile))
17576 (progn (message "Failed to create pdf file from %s" texfile) nil)
17577 (condition-case nil
17578 (if (featurep 'xemacs)
17579 (call-process "convert" nil nil nil
17580 "-density" "96"
17581 "-trim"
17582 "-antialias"
17583 pdffile
17584 "-quality" "100"
17585 ;; "-sharpen" "0x1.0"
17586 pngfile)
17587 (call-process "convert" nil nil nil
17588 "-density" dpi
17589 "-trim"
17590 "-antialias"
17591 pdffile
17592 "-quality" "100"
17593 ; "-sharpen" "0x1.0"
17594 pngfile))
17595 (error nil))
17596 (if (not (file-exists-p pngfile))
17597 (if org-format-latex-signal-error
17598 (error "Failed to create png file from %s" texfile)
17599 (message "Failed to create png file from %s" texfile)
17600 nil)
17601 ;; Use the requested file name and clean up
17602 (copy-file pngfile tofile 'replace)
17603 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
17604 (if (file-exists-p (concat texfilebase e))
17605 (delete-file (concat texfilebase e))))
17606 pngfile))))
17608 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17609 "Fill a LaTeX header template TPL.
17610 In the template, the following place holders will be recognized:
17613 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17615 [NO-PACKAGES] do not include PKG
17616 [EXTRA] the string EXTRA
17617 [NO-EXTRA] do not include EXTRA
17619 For backward compatibility, if both the positive and the negative place
17621 assumed to be present at the end of the template.
17622 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17623 EXTRA is a string.
17624 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17625 (let (rpl (end ""))
17627 (setq rpl (if (or (match-end 1) (not def-pkg))
17628 "" (org-latex-packages-to-string def-pkg snippets-p t))
17629 tpl (replace-match rpl t t tpl))
17630 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17633 (setq rpl (if (or (match-end 1) (not pkg))
17634 "" (org-latex-packages-to-string pkg snippets-p t))
17635 tpl (replace-match rpl t t tpl))
17636 (if pkg (setq end
17638 (org-latex-packages-to-string pkg snippets-p)))))
17641 (setq rpl (if (or (match-end 1) (not extra))
17643 tpl (replace-match rpl t t tpl))
17649 tpl)))
17651 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17653 (setq pkg (mapconcat (lambda(p)
17654 (cond
17655 ((stringp p) p)
17656 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17657 (format "%% Package %s omitted" (cadr p)))
17658 ((equal "" (car p))
17660 (t
17662 (car p) (cadr p)))))
17663 pkg
17667 (defun org-dvipng-color (attr)
17668 "Return a RGB color specification for dvipng."
17669 (apply 'format "rgb %s %s %s"
17670 (mapcar 'org-normalize-color
17671 (if (featurep 'xemacs)
17672 (color-rgb-components
17673 (face-property 'default
17674 (cond ((eq attr :foreground) 'foreground)
17675 ((eq attr :background) 'background))))
17676 (color-values (face-attribute 'default attr nil))))))
17678 (defun org-latex-color (attr)
17679 "Return a RGB color for the LaTeX color package."
17680 (apply 'format "%s,%s,%s"
17681 (mapcar 'org-normalize-color
17682 (if (featurep 'xemacs)
17683 (color-rgb-components
17684 (face-property 'default
17685 (cond ((eq attr :foreground) 'foreground)
17686 ((eq attr :background) 'background))))
17687 (color-values (face-attribute 'default attr nil))))))
17689 (defun org-latex-color-format (color-name)
17690 "Convert COLOR-NAME to a RGB color value."
17691 (apply 'format "%s,%s,%s"
17692 (mapcar 'org-normalize-color
17693 (color-values color-name))))
17695 (defun org-normalize-color (value)
17696 "Return string to be used as color value for an RGB component."
17697 (format "%g" (/ value 65535.0)))
17699 ;; Image display
17702 (defvar org-inline-image-overlays nil)
17703 (make-variable-buffer-local 'org-inline-image-overlays)
17705 (defun org-toggle-inline-images (&optional include-linked)
17706 "Toggle the display of inline images.
17707 INCLUDE-LINKED is passed to `org-display-inline-images'."
17708 (interactive "P")
17709 (if org-inline-image-overlays
17710 (progn
17711 (org-remove-inline-images)
17712 (message "Inline image display turned off"))
17713 (org-display-inline-images include-linked)
17714 (if org-inline-image-overlays
17715 (message "%d images displayed inline"
17716 (length org-inline-image-overlays))
17717 (message "No images to display inline"))))
17719 (defun org-redisplay-inline-images ()
17720 "Refresh the display of inline images."
17721 (interactive)
17722 (if (not org-inline-image-overlays)
17723 (org-toggle-inline-images)
17724 (org-toggle-inline-images)
17725 (org-toggle-inline-images)))
17727 (defun org-display-inline-images (&optional include-linked refresh beg end)
17728 "Display inline images.
17729 Normally only links without a description part are inlined, because this
17730 is how it will work for export. When INCLUDE-LINKED is set, also links
17731 with a description part will be inlined. This can be nice for a quick
17732 look at those images, but it does not reflect what exported files will look
17733 like.
17734 When REFRESH is set, refresh existing images between BEG and END.
17735 This will create new image displays only if necessary.
17736 BEG and END default to the buffer boundaries."
17737 (interactive "P")
17738 (unless refresh
17739 (org-remove-inline-images)
17740 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17741 (save-excursion
17742 (save-restriction
17743 (widen)
17744 (setq beg (or beg (point-min)) end (or end (point-max)))
17745 (goto-char beg)
17747 (substring (org-image-file-name-regexp) 0 -2)
17749 old file ov img)
17750 (while (re-search-forward re end t)
17751 (setq old (get-char-property-and-overlay (match-beginning 1)
17752 'org-image-overlay))
17753 (setq file (expand-file-name
17754 (concat (or (match-string 3) "") (match-string 4))))
17755 (when (file-exists-p file)
17756 (if (and (car-safe old) refresh)
17757 (image-refresh (overlay-get (cdr old) 'display))
17758 (setq img (save-match-data (create-image file)))
17759 (when img
17760 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17761 (overlay-put ov 'display img)
17762 (overlay-put ov 'face 'default)
17763 (overlay-put ov 'org-image-overlay t)
17764 (overlay-put ov 'modification-hooks
17765 (list 'org-display-inline-remove-overlay))
17766 (push ov org-inline-image-overlays)))))))))
17768 (define-obsolete-function-alias
17769 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
17771 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
17772 "Remove inline-display overlay if a corresponding region is modified."
17773 (let ((inhibit-modification-hooks t))
17774 (when (and ov after)
17775 (delete ov org-inline-image-overlays)
17776 (delete-overlay ov))))
17778 (defun org-remove-inline-images ()
17779 "Remove inline display of images."
17780 (interactive)
17781 (mapc 'delete-overlay org-inline-image-overlays)
17782 (setq org-inline-image-overlays nil))
17784 ;;;; Key bindings
17786 ;; Outline functions from `outline-mode-prefix-map'
17787 ;; that can be remapped in Org:
17788 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17789 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17790 (define-key org-mode-map [remap outline-forward-same-level]
17791 'org-forward-heading-same-level)
17792 (define-key org-mode-map [remap outline-backward-same-level]
17793 'org-backward-heading-same-level)
17794 (define-key org-mode-map [remap show-branches]
17795 'org-kill-note-or-show-branches)
17796 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17797 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17798 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17800 ;; Outline functions from `outline-mode-prefix-map' that can not
17801 ;; be remapped in Org:
17802 ;;
17803 ;; - the column "key binding" shows whether the Outline function is still
17804 ;; available in Org mode on the same key that it has been bound to in
17805 ;; Outline mode:
17806 ;; - "overridden": key used for a different functionality in Org mode
17807 ;; - else: key still bound to the same Outline function in Org mode
17808 ;;
17809 ;; | Outline function | key binding | Org replacement |
17810 ;; |------------------------------------+-------------+-----------------------|
17811 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17812 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17813 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17814 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
17815 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17816 ;; | `show-entry' | overridden | no replacement |
17817 ;; | `show-children' | `C-c C-i' | visibility cycling |
17818 ;; | `show-branches' | `C-c C-k' | still same function |
17819 ;; | `show-subtree' | overridden | visibility cycling |
17820 ;; | `show-all' | overridden | no replacement |
17821 ;; | `hide-subtree' | overridden | visibility cycling |
17822 ;; | `hide-body' | overridden | no replacement |
17823 ;; | `hide-entry' | overridden | visibility cycling |
17824 ;; | `hide-leaves' | overridden | no replacement |
17825 ;; | `hide-sublevels' | overridden | no replacement |
17826 ;; | `hide-other' | overridden | no replacement |
17828 ;; Make `C-c C-x' a prefix key
17829 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17831 ;; TAB key with modifiers
17832 (org-defkey org-mode-map "\C-i" 'org-cycle)
17833 (org-defkey org-mode-map [(tab)] 'org-cycle)
17834 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17836 ;; The following line is necessary under Suse GNU/Linux
17837 (unless (featurep 'xemacs)
17838 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17839 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17840 (define-key org-mode-map [backtab] 'org-shifttab)
17842 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17843 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17844 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17846 ;; Cursor keys with modifiers
17847 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17848 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17849 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17850 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17852 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17853 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17854 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17855 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17857 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17858 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17859 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17860 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17862 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17863 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17864 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17865 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17867 ;; Babel keys
17868 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17869 (mapc (lambda (pair)
17870 (define-key org-babel-map (car pair) (cdr pair)))
17871 org-babel-key-bindings)
17873 ;;; Extra keys for tty access.
17874 ;; We only set them when really needed because otherwise the
17875 ;; menus don't show the simple keys
17877 (when (or org-use-extra-keys
17878 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17879 (not window-system))
17880 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17881 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17882 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17883 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17884 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17885 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17886 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17887 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17888 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17889 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17890 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17891 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17892 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17893 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17894 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17895 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17896 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17897 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17898 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17899 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17900 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17901 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17902 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17903 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17904 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17905 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17906 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17907 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17909 ;; All the other keys
17911 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17912 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17913 (if (boundp 'narrow-map)
17914 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17915 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17916 (if (boundp 'narrow-map)
17917 (org-defkey narrow-map "b" 'org-narrow-to-block)
17918 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17919 (if (boundp 'narrow-map)
17920 (org-defkey narrow-map "e" 'org-narrow-to-element)
17921 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
17922 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
17923 (org-defkey org-mode-map "\M-}" 'org-forward-element)
17924 (org-defkey org-mode-map "\M-{" 'org-backward-element)
17925 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
17926 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
17927 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
17928 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
17929 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17930 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17931 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17932 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17933 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17934 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17935 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17936 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17937 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17938 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17939 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17940 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17941 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17942 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17943 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17945 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17946 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17947 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17948 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17949 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17950 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17951 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17952 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17953 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17954 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
17955 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17956 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17957 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17958 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17959 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17960 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17961 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17962 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17963 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17964 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17965 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17967 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17968 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17969 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17970 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17971 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17972 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17973 (org-defkey org-mode-map "\C-c^" 'org-sort)
17974 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17975 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17976 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17977 (org-defkey org-mode-map "\C-m" 'org-return)
17978 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17979 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17980 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17981 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17982 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17983 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17984 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17985 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17986 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17987 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17988 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17989 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17990 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17991 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17992 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17993 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17994 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17995 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17996 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17997 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17998 (org-defkey org-mode-map "\M-h" 'org-mark-element)
17999 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
18000 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
18002 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
18003 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
18004 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
18006 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
18007 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
18008 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
18009 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
18010 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
18011 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
18012 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
18013 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
18014 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
18015 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
18016 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
18017 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
18018 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
18020 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
18021 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
18022 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
18023 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
18024 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
18025 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
18026 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
18027 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
18029 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
18030 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
18031 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
18032 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
18033 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
18035 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
18037 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
18039 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
18040 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
18042 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
18045 (when (featurep 'xemacs)
18046 (org-defkey org-mode-map 'button3 'popup-mode-menu))
18049 (defconst org-speed-commands-default
18050 '(
18051 ("Outline Navigation")
18052 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
18053 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
18054 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
18055 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
18056 ("u" . (org-speed-move-safe 'outline-up-heading))
18057 ("j" . org-goto)
18058 ("g" . (org-refile t))
18059 ("Outline Visibility")
18060 ("c" . org-cycle)
18061 ("C" . org-shifttab)
18062 (" " . org-display-outline-path)
18063 (":" . org-columns)
18064 ("Outline Structure Editing")
18065 ("U" . org-shiftmetaup)
18066 ("D" . org-shiftmetadown)
18067 ("r" . org-metaright)
18068 ("l" . org-metaleft)
18069 ("R" . org-shiftmetaright)
18070 ("L" . org-shiftmetaleft)
18071 ("i" . (progn (forward-char 1) (call-interactively
18072 'org-insert-heading-respect-content)))
18073 ("^" . org-sort)
18074 ("w" . org-refile)
18075 ("a" . org-archive-subtree-default-with-confirmation)
18076 ("." . org-mark-subtree)
18077 ("#" . org-toggle-comment)
18078 ("Clock Commands")
18079 ("I" . org-clock-in)
18080 ("O" . org-clock-out)
18081 ("Meta Data Editing")
18082 ("t" . org-todo)
18083 ("," . (org-priority))
18084 ("0" . (org-priority ?\ ))
18085 ("1" . (org-priority ?A))
18086 ("2" . (org-priority ?B))
18087 ("3" . (org-priority ?C))
18088 (";" . org-set-tags-command)
18089 ("e" . org-set-effort)
18090 ("E" . org-inc-effort)
18091 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
18092 (org-entry-put (point) "APPT_WARNTIME" m)))
18093 ("Agenda Views etc")
18094 ("v" . org-agenda)
18095 ("/" . org-sparse-tree)
18096 ("Misc")
18097 ("o" . org-open-at-point)
18098 ("?" . org-speed-command-help)
18099 ("<" . (org-agenda-set-restriction-lock 'subtree))
18100 (">" . (org-agenda-remove-restriction-lock))
18101 )
18102 "The default speed commands.")
18104 (defun org-print-speed-command (e)
18105 (if (> (length (car e)) 1)
18106 (progn
18108 (princ (car e))
18110 (princ (make-string (length (car e)) ?-))
18112 (princ (car e))
18113 (princ " ")
18114 (if (symbolp (cdr e))
18115 (princ (symbol-name (cdr e)))
18116 (prin1 (cdr e)))
18119 (defun org-speed-command-help ()
18120 "Show the available speed commands."
18121 (interactive)
18122 (if (not org-use-speed-commands)
18123 (error "Speed commands are not activated, customize `org-use-speed-commands'")
18124 (with-output-to-temp-buffer "*Help*"
18126 (mapc 'org-print-speed-command org-speed-commands-user)
18129 (mapc 'org-print-speed-command org-speed-commands-default))
18130 (with-current-buffer "*Help*"
18131 (setq truncate-lines t))))
18133 (defun org-speed-move-safe (cmd)
18134 "Execute CMD, but make sure that the cursor always ends up in a headline.
18135 If not, return to the original position and throw an error."
18136 (interactive)
18137 (let ((pos (point)))
18138 (call-interactively cmd)
18139 (unless (and (bolp) (org-at-heading-p))
18140 (goto-char pos)
18141 (error "Boundary reached while executing %s" cmd))))
18143 (defvar org-self-insert-command-undo-counter 0)
18145 (defvar org-table-auto-blank-field) ; defined in org-table.el
18146 (defvar org-speed-command nil)
18148 (define-obsolete-function-alias
18149 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
18151 (defun org-speed-command-activate (keys)
18152 "Hook for activating single-letter speed commands.
18153 `org-speed-commands-default' specifies a minimal command set.
18154 Use `org-speed-commands-user' for further customization."
18155 (when (or (and (bolp) (looking-at org-outline-regexp))
18156 (and (functionp org-use-speed-commands)
18157 (funcall org-use-speed-commands)))
18158 (cdr (assoc keys (append org-speed-commands-user
18159 org-speed-commands-default)))))
18161 (define-obsolete-function-alias
18162 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
18164 (defun org-babel-speed-command-activate (keys)
18165 "Hook for activating single-letter code block commands."
18166 (when (and (bolp) (looking-at org-babel-src-block-regexp))
18167 (cdr (assoc keys org-babel-key-bindings))))
18169 (defcustom org-speed-command-hook
18170 '(org-speed-command-default-hook org-babel-speed-command-hook)
18171 "Hook for activating speed commands at strategic locations.
18172 Hook functions are called in sequence until a valid handler is
18173 found.
18175 Each hook takes a single argument, a user-pressed command key
18176 which is also a `self-insert-command' from the global map.
18178 Within the hook, examine the cursor position and the command key
18179 and return nil or a valid handler as appropriate. Handler could
18180 be one of an interactive command, a function, or a form.
18182 Set `org-use-speed-commands' to non-nil value to enable this
18183 hook. The default setting is `org-speed-command-activate'."
18184 :group 'org-structure
18185 :version "24.1"
18186 :type 'hook)
18188 (defun org-self-insert-command (N)
18189 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18190 If the cursor is in a table looking at whitespace, the whitespace is
18191 overwritten, and the table is not marked as requiring realignment."
18192 (interactive "p")
18193 (org-check-before-invisible-edit 'insert)
18194 (cond
18195 ((and org-use-speed-commands
18196 (setq org-speed-command
18197 (run-hook-with-args-until-success
18198 'org-speed-command-hook (this-command-keys))))
18199 (cond
18200 ((commandp org-speed-command)
18201 (setq this-command org-speed-command)
18202 (call-interactively org-speed-command))
18203 ((functionp org-speed-command)
18204 (funcall org-speed-command))
18205 ((and org-speed-command (listp org-speed-command))
18206 (eval org-speed-command))
18207 (t (let (org-use-speed-commands)
18208 (call-interactively 'org-self-insert-command)))))
18209 ((and
18210 (org-table-p)
18211 (progn
18212 ;; check if we blank the field, and if that triggers align
18213 (and (featurep 'org-table) org-table-auto-blank-field
18214 (member last-command
18215 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
18217 ;; got extra space, this field does not determine column width
18218 (let (org-table-may-need-update) (org-table-blank-field))
18219 ;; no extra space, this field may determine column width
18220 (org-table-blank-field)))
18221 t)
18222 (eq N 1)
18224 (let (org-table-may-need-update)
18225 (goto-char (1- (match-end 0)))
18226 (backward-delete-char 1)
18227 (goto-char (match-beginning 0))
18228 (self-insert-command N)))
18229 (t
18230 (setq org-table-may-need-update t)
18231 (self-insert-command N)
18232 (org-fix-tags-on-the-fly)
18233 (if org-self-insert-cluster-for-undo
18234 (if (not (eq last-command 'org-self-insert-command))
18235 (setq org-self-insert-command-undo-counter 1)
18236 (if (>= org-self-insert-command-undo-counter 20)
18237 (setq org-self-insert-command-undo-counter 1)
18238 (and (> org-self-insert-command-undo-counter 0)
18239 buffer-undo-list (listp buffer-undo-list)
18240 (not (cadr buffer-undo-list)) ; remove nil entry
18241 (setcdr buffer-undo-list (cddr buffer-undo-list)))
18242 (setq org-self-insert-command-undo-counter
18243 (1+ org-self-insert-command-undo-counter))))))))
18245 (defun org-check-before-invisible-edit (kind)
18246 "Check is editing if kind KIND would be dangerous with invisible text around.
18247 The detailed reaction depends on the user option `org-catch-invisible-edits'."
18248 ;; First, try to get out of here as quickly as possible, to reduce overhead
18249 (if (and org-catch-invisible-edits
18250 (or (not (boundp 'visible-mode)) (not visible-mode))
18251 (or (get-char-property (point) 'invisible)
18252 (get-char-property (max (point-min) (1- (point))) 'invisible)))
18253 ;; OK, we need to take a closer look
18254 (let* ((invisible-at-point (get-char-property (point) 'invisible))
18255 (invisible-before-point (if (bobp) nil (get-char-property
18256 (1- (point)) 'invisible)))
18257 (border-and-ok-direction
18258 (or
18259 ;; Check if we are acting predictably before invisible text
18260 (and invisible-at-point (not invisible-before-point)
18261 (memq kind '(insert delete-backward)))
18262 ;; Check if we are acting predictably after invisible text
18263 ;; This works not well, and I have turned it off. It seems
18264 ;; better to always show and stop after invisible text.
18265 ;; (and (not invisible-at-point) invisible-before-point
18266 ;; (memq kind '(insert delete)))
18267 )))
18268 (when (or (memq invisible-at-point '(outline org-hide-block t))
18269 (memq invisible-before-point '(outline org-hide-block t)))
18270 (if (eq org-catch-invisible-edits 'error)
18271 (error "Editing in invisible areas is prohibited - make visible first"))
18272 (if (and org-custom-properties-overlays
18273 (y-or-n-p "Display invisible properties in this buffer? "))
18274 (org-toggle-custom-properties-visibility)
18275 ;; Make the area visible
18276 (save-excursion
18277 (if invisible-before-point
18278 (goto-char (previous-single-char-property-change
18279 (point) 'invisible)))
18280 (org-cycle))
18281 (cond
18282 ((eq org-catch-invisible-edits 'show)
18283 ;; That's it, we do the edit after showing
18284 (message
18285 "Unfolding invisible region around point before editing")
18286 (sit-for 1))
18287 ((and (eq org-catch-invisible-edits 'smart)
18288 border-and-ok-direction)
18289 (message "Unfolding invisible region around point before editing"))
18290 (t
18291 ;; Don't do the edit, make the user repeat it in full visibility
18292 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
18294 (defun org-fix-tags-on-the-fly ()
18295 (when (and (equal (char-after (point-at-bol)) ?*)
18296 (org-at-heading-p))
18297 (org-align-tags-here org-tags-column)))
18299 (defun org-delete-backward-char (N)
18300 "Like `delete-backward-char', insert whitespace at field end in tables.
18301 When deleting backwards, in tables this function will insert whitespace in
18303 still be marked for re-alignment if the field did fill the entire column,
18304 because, in this case the deletion might narrow the column."
18305 (interactive "p")
18306 (save-match-data
18307 (org-check-before-invisible-edit 'delete-backward)
18308 (if (and (org-table-p)
18309 (eq N 1)
18310 (string-match "|" (buffer-substring (point-at-bol) (point)))
18311 (looking-at ".*?|"))
18312 (let ((pos (point))
18314 (c org-table-may-need-update))
18315 (backward-delete-char N)
18316 (if (not overwrite-mode)
18317 (progn
18318 (skip-chars-forward "^|")
18319 (insert " ")
18320 (goto-char (1- pos))))
18321 ;; noalign: if there were two spaces at the end, this field
18322 ;; does not determine the width of the column.
18323 (if noalign (setq org-table-may-need-update c)))
18324 (backward-delete-char N)
18325 (org-fix-tags-on-the-fly))))
18327 (defun org-delete-char (N)
18328 "Like `delete-char', but insert whitespace at field end in tables.
18329 When deleting characters, in tables this function will insert whitespace in
18331 still be marked for re-alignment if the field did fill the entire column,
18332 because, in this case the deletion might narrow the column."
18333 (interactive "p")
18334 (save-match-data
18335 (org-check-before-invisible-edit 'delete)
18336 (if (and (org-table-p)
18337 (not (bolp))
18338 (not (= (char-after) ?|))
18339 (eq N 1))
18340 (if (looking-at ".*?|")
18341 (let ((pos (point))
18343 (c org-table-may-need-update))
18344 (replace-match (concat
18345 (substring (match-string 0) 1 -1)
18346 " |"))
18347 (goto-char pos)
18348 ;; noalign: if there were two spaces at the end, this field
18349 ;; does not determine the width of the column.
18350 (if noalign (setq org-table-may-need-update c)))
18351 (delete-char N))
18352 (delete-char N)
18353 (org-fix-tags-on-the-fly))))
18355 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
18356 (put 'org-self-insert-command 'delete-selection t)
18357 (put 'orgtbl-self-insert-command 'delete-selection t)
18358 (put 'org-delete-char 'delete-selection 'supersede)
18359 (put 'org-delete-backward-char 'delete-selection 'supersede)
18360 (put 'org-yank 'delete-selection 'yank)
18362 ;; Make `flyspell-mode' delay after some commands
18363 (put 'org-self-insert-command 'flyspell-delayed t)
18364 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
18365 (put 'org-delete-char 'flyspell-delayed t)
18366 (put 'org-delete-backward-char 'flyspell-delayed t)
18368 ;; Make pabbrev-mode expand after org-mode commands
18369 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
18370 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
18372 ;; How to do this: Measure non-white length of current string
18373 ;; If equal to column width, we should realign.
18375 (defun org-remap (map &rest commands)
18376 "In MAP, remap the functions given in COMMANDS.
18377 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
18378 (let (new old)
18379 (while commands
18380 (setq old (pop commands) new (pop commands))
18381 (if (fboundp 'command-remapping)
18382 (org-defkey map (vector 'remap old) new)
18383 (substitute-key-definition old new map global-map)))))
18385 (when (eq org-enable-table-editor 'optimized)
18386 ;; If the user wants maximum table support, we need to hijack
18387 ;; some standard editing functions
18388 (org-remap org-mode-map
18389 'self-insert-command 'org-self-insert-command
18390 'delete-char 'org-delete-char
18391 'delete-backward-char 'org-delete-backward-char)
18392 (org-defkey org-mode-map "|" 'org-force-self-insert))
18394 (defvar org-ctrl-c-ctrl-c-hook nil
18395 "Hook for functions attaching themselves to `C-c C-c'.
18397 This can be used to add additional functionality to the C-c C-c
18398 key which executes context-dependent commands. This hook is run
18399 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
18400 run after the last test.
18402 Each function will be called with no arguments. The function
18403 must check if the context is appropriate for it to act. If yes,
18404 it should do its thing and then return a non-nil value. If the
18405 context is wrong, just do nothing and return nil.")
18407 (defvar org-ctrl-c-ctrl-c-final-hook nil
18408 "Hook for functions attaching themselves to `C-c C-c'.
18410 This can be used to add additional functionality to the C-c C-c
18411 key which executes context-dependent commands. This hook is run
18412 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
18413 before the first test.
18415 Each function will be called with no arguments. The function
18416 must check if the context is appropriate for it to act. If yes,
18417 it should do its thing and then return a non-nil value. If the
18418 context is wrong, just do nothing and return nil.")
18420 (defvar org-tab-first-hook nil
18421 "Hook for functions to attach themselves to TAB.
18422 See `org-ctrl-c-ctrl-c-hook' for more information.
18423 This hook runs as the first action when TAB is pressed, even before
18424 `org-cycle' messes around with the `outline-regexp' to cater for
18425 inline tasks and plain list item folding.
18426 If any function in this hook returns t, any other actions that
18427 would have been caused by TAB (such as table field motion or visibility
18428 cycling) will not occur.")
18430 (defvar org-tab-after-check-for-table-hook nil
18431 "Hook for functions to attach themselves to TAB.
18432 See `org-ctrl-c-ctrl-c-hook' for more information.
18433 This hook runs after it has been established that the cursor is not in a
18434 table, but before checking if the cursor is in a headline or if global cycling
18435 should be done.
18436 If any function in this hook returns t, not other actions like visibility
18437 cycling will be done.")
18439 (defvar org-tab-after-check-for-cycling-hook nil
18440 "Hook for functions to attach themselves to TAB.
18441 See `org-ctrl-c-ctrl-c-hook' for more information.
18442 This hook runs after it has been established that not table field motion and
18443 not visibility should be done because of current context. This is probably
18444 the place where a package like yasnippets can hook in.")
18446 (defvar org-tab-before-tab-emulation-hook nil
18447 "Hook for functions to attach themselves to TAB.
18448 See `org-ctrl-c-ctrl-c-hook' for more information.
18449 This hook runs after every other options for TAB have been exhausted, but
18452 (defvar org-metaleft-hook nil
18453 "Hook for functions attaching themselves to `M-left'.
18454 See `org-ctrl-c-ctrl-c-hook' for more information.")
18455 (defvar org-metaright-hook nil
18456 "Hook for functions attaching themselves to `M-right'.
18457 See `org-ctrl-c-ctrl-c-hook' for more information.")
18458 (defvar org-metaup-hook nil
18459 "Hook for functions attaching themselves to `M-up'.
18460 See `org-ctrl-c-ctrl-c-hook' for more information.")
18461 (defvar org-metadown-hook nil
18462 "Hook for functions attaching themselves to `M-down'.
18463 See `org-ctrl-c-ctrl-c-hook' for more information.")
18464 (defvar org-shiftmetaleft-hook nil
18465 "Hook for functions attaching themselves to `M-S-left'.
18466 See `org-ctrl-c-ctrl-c-hook' for more information.")
18467 (defvar org-shiftmetaright-hook nil
18468 "Hook for functions attaching themselves to `M-S-right'.
18469 See `org-ctrl-c-ctrl-c-hook' for more information.")
18470 (defvar org-shiftmetaup-hook nil
18471 "Hook for functions attaching themselves to `M-S-up'.
18472 See `org-ctrl-c-ctrl-c-hook' for more information.")
18473 (defvar org-shiftmetadown-hook nil
18474 "Hook for functions attaching themselves to `M-S-down'.
18475 See `org-ctrl-c-ctrl-c-hook' for more information.")
18476 (defvar org-metareturn-hook nil
18477 "Hook for functions attaching themselves to `M-RET'.
18478 See `org-ctrl-c-ctrl-c-hook' for more information.")
18479 (defvar org-shiftup-hook nil
18480 "Hook for functions attaching themselves to `S-up'.
18481 See `org-ctrl-c-ctrl-c-hook' for more information.")
18482 (defvar org-shiftup-final-hook nil
18483 "Hook for functions attaching themselves to `S-up'.
18484 This one runs after all other options except shift-select have been excluded.
18485 See `org-ctrl-c-ctrl-c-hook' for more information.")
18486 (defvar org-shiftdown-hook nil
18487 "Hook for functions attaching themselves to `S-down'.
18488 See `org-ctrl-c-ctrl-c-hook' for more information.")
18489 (defvar org-shiftdown-final-hook nil
18490 "Hook for functions attaching themselves to `S-down'.
18491 This one runs after all other options except shift-select have been excluded.
18492 See `org-ctrl-c-ctrl-c-hook' for more information.")
18493 (defvar org-shiftleft-hook nil
18494 "Hook for functions attaching themselves to `S-left'.
18495 See `org-ctrl-c-ctrl-c-hook' for more information.")
18496 (defvar org-shiftleft-final-hook nil
18497 "Hook for functions attaching themselves to `S-left'.
18498 This one runs after all other options except shift-select have been excluded.
18499 See `org-ctrl-c-ctrl-c-hook' for more information.")
18500 (defvar org-shiftright-hook nil
18501 "Hook for functions attaching themselves to `S-right'.
18502 See `org-ctrl-c-ctrl-c-hook' for more information.")
18503 (defvar org-shiftright-final-hook nil
18504 "Hook for functions attaching themselves to `S-right'.
18505 This one runs after all other options except shift-select have been excluded.
18506 See `org-ctrl-c-ctrl-c-hook' for more information.")
18508 (defun org-modifier-cursor-error ()
18509 "Throw an error, a modified cursor command was applied in wrong context."
18510 (error "This command is active in special context like tables, headlines or items"))
18512 (defun org-shiftselect-error ()
18513 "Throw an error because Shift-Cursor command was applied in wrong context."
18514 (if (and (boundp 'shift-select-mode) shift-select-mode)
18515 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
18516 (error "This command works only in special context like headlines or timestamps")))
18518 (defun org-call-for-shift-select (cmd)
18519 (let ((this-command-keys-shift-translated t))
18520 (call-interactively cmd)))
18522 (defun org-shifttab (&optional arg)
18523 "Global visibility cycling or move to previous table field.
18524 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
18525 on context.
18526 See the individual commands for more information."
18527 (interactive "P")
18528 (cond
18529 ((org-at-table-p) (call-interactively 'org-table-previous-field))
18530 ((integerp arg)
18531 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18532 (message "Content view to level: %d" arg)
18533 (org-content (prefix-numeric-value arg2))
18534 (setq org-cycle-global-status 'overview)))
18535 (t (call-interactively 'org-global-cycle))))
18537 (defun org-shiftmetaleft ()
18538 "Promote subtree or delete table column.
18539 Calls `org-promote-subtree', `org-outdent-item-tree', or
18540 `org-table-delete-column', depending on context. See the
18541 individual commands for more information."
18542 (interactive)
18543 (cond
18544 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18545 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18546 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18547 ((if (not (org-region-active-p)) (org-at-item-p)
18548 (save-excursion (goto-char (region-beginning))
18549 (org-at-item-p)))
18550 (call-interactively 'org-outdent-item-tree))
18551 (t (org-modifier-cursor-error))))
18553 (defun org-shiftmetaright ()
18554 "Demote subtree or insert table column.
18555 Calls `org-demote-subtree', `org-indent-item-tree', or
18556 `org-table-insert-column', depending on context. See the
18557 individual commands for more information."
18558 (interactive)
18559 (cond
18560 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18561 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18562 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18563 ((if (not (org-region-active-p)) (org-at-item-p)
18564 (save-excursion (goto-char (region-beginning))
18565 (org-at-item-p)))
18566 (call-interactively 'org-indent-item-tree))
18567 (t (org-modifier-cursor-error))))
18569 (defun org-shiftmetaup (&optional arg)
18570 "Move subtree up or kill table row.
18571 Calls `org-move-subtree-up' or `org-table-kill-row' or
18572 `org-move-item-up' or `org-timestamp-up', depending on context.
18573 See the individual commands for more information."
18574 (interactive "P")
18575 (cond
18576 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18577 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18578 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18579 ((org-at-item-p) (call-interactively 'org-move-item-up))
18580 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18581 (call-interactively 'org-timestamp-up)))
18582 (t (org-modifier-cursor-error))))
18584 (defun org-shiftmetadown (&optional arg)
18585 "Move subtree down or insert table row.
18586 Calls `org-move-subtree-down' or `org-table-insert-row' or
18587 `org-move-item-down' or `org-timestamp-up', depending on context.
18588 See the individual commands for more information."
18589 (interactive "P")
18590 (cond
18591 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18592 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18593 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18594 ((org-at-item-p) (call-interactively 'org-move-item-down))
18595 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18596 (call-interactively 'org-timestamp-down)))
18597 (t (org-modifier-cursor-error))))
18599 (defsubst org-hidden-tree-error ()
18600 (error
18601 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18603 (defun org-metaleft (&optional arg)
18604 "Promote heading or move table column to left.
18605 Calls `org-do-promote' or `org-table-move-column', depending on context.
18606 With no specific context, calls the Emacs default `backward-word'.
18607 See the individual commands for more information."
18608 (interactive "P")
18609 (cond
18610 ((run-hook-with-args-until-success 'org-metaleft-hook))
18611 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18612 ((org-with-limited-levels
18613 (or (org-at-heading-p)
18614 (and (org-region-active-p)
18615 (save-excursion
18616 (goto-char (region-beginning))
18617 (org-at-heading-p)))))
18618 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18619 (call-interactively 'org-do-promote))
18620 ;; At an inline task.
18621 ((org-at-heading-p)
18622 (call-interactively 'org-inlinetask-promote))
18623 ((or (org-at-item-p)
18624 (and (org-region-active-p)
18625 (save-excursion
18626 (goto-char (region-beginning))
18627 (org-at-item-p))))
18628 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18629 (call-interactively 'org-outdent-item))
18630 (t (call-interactively 'backward-word))))
18632 (defun org-metaright (&optional arg)
18633 "Demote a subtree, a list item or move table column to right.
18634 In front of a drawer or a block keyword, indent it correctly.
18635 With no specific context, calls the Emacs default `forward-word'.
18636 See the individual commands for more information."
18637 (interactive "P")
18638 (cond
18639 ((run-hook-with-args-until-success 'org-metaright-hook))
18640 ((org-at-table-p) (call-interactively 'org-table-move-column))
18641 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18642 ((org-at-block-p) (call-interactively 'org-indent-block))
18643 ((org-with-limited-levels
18644 (or (org-at-heading-p)
18645 (and (org-region-active-p)
18646 (save-excursion
18647 (goto-char (region-beginning))
18648 (org-at-heading-p)))))
18649 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18650 (call-interactively 'org-do-demote))
18651 ;; At an inline task.
18652 ((org-at-heading-p)
18653 (call-interactively 'org-inlinetask-demote))
18654 ((or (org-at-item-p)
18655 (and (org-region-active-p)
18656 (save-excursion
18657 (goto-char (region-beginning))
18658 (org-at-item-p))))
18659 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18660 (call-interactively 'org-indent-item))
18661 (t (call-interactively 'forward-word))))
18663 (defun org-check-for-hidden (what)
18664 "Check if there are hidden headlines/items in the current visual line.
18665 WHAT can be either `headlines' or `items'. If the current line is
18666 an outline or item heading and it has a folded subtree below it,
18667 this function returns t, nil otherwise."
18668 (let ((re (cond
18669 ((eq what 'headlines) org-outline-regexp-bol)
18670 ((eq what 'items) (org-item-beginning-re))
18671 (t (error "This should not happen"))))
18672 beg end)
18673 (save-excursion
18674 (catch 'exit
18675 (unless (org-region-active-p)
18676 (setq beg (point-at-bol))
18677 (beginning-of-line 2)
18678 (while (and (not (eobp)) ;; this is like `next-line'
18679 (get-char-property (1- (point)) 'invisible))
18680 (beginning-of-line 2))
18681 (setq end (point))
18682 (goto-char beg)
18683 (goto-char (point-at-eol))
18684 (setq end (max end (point)))
18685 (while (re-search-forward re end t)
18686 (if (get-char-property (match-beginning 0) 'invisible)
18687 (throw 'exit t))))
18688 nil))))
18690 (autoload 'org-element-at-point "org-element")
18691 (autoload 'org-element-type "org-element")
18693 (declare-function org-element-at-point "org-element" (&optional keep-trail))
18694 (declare-function org-element-type "org-element" (element))
18695 (declare-function org-element-contents "org-element" (element))
18696 (declare-function org-element-property "org-element" (property element))
18697 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
18698 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
18699 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
18700 (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
18701 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
18703 (defun org-metaup (&optional arg)
18704 "Move subtree up or move table row up.
18705 Calls `org-move-subtree-up' or `org-table-move-row' or
18706 `org-move-item-up', depending on context. See the individual commands
18707 for more information."
18708 (interactive "P")
18709 (cond
18710 ((run-hook-with-args-until-success 'org-metaup-hook))
18711 ((org-region-active-p)
18712 (let* ((a (min (region-beginning) (region-end)))
18713 (b (1- (max (region-beginning) (region-end))))
18714 (c (save-excursion (goto-char a)
18715 (move-beginning-of-line 0)))
18716 (d (save-excursion (goto-char a)
18717 (move-end-of-line 0) (point))))
18718 (transpose-regions a b c d)
18719 (goto-char c)))
18720 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18721 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18722 ((org-at-item-p) (call-interactively 'org-move-item-up))
18723 (t (org-drag-element-backward))))
18725 (defun org-metadown (&optional arg)
18726 "Move subtree down or move table row down.
18727 Calls `org-move-subtree-down' or `org-table-move-row' or
18728 `org-move-item-down', depending on context. See the individual
18729 commands for more information."
18730 (interactive "P")
18731 (cond
18732 ((run-hook-with-args-until-success 'org-metadown-hook))
18733 ((org-region-active-p)
18734 (let* ((a (min (region-beginning) (region-end)))
18735 (b (max (region-beginning) (region-end)))
18736 (c (save-excursion (goto-char b)
18737 (move-beginning-of-line 1)))
18738 (d (save-excursion (goto-char b)
18739 (move-end-of-line 1) (1+ (point)))))
18740 (transpose-regions a b c d)
18741 (goto-char d)))
18742 ((org-at-table-p) (call-interactively 'org-table-move-row))
18743 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18744 ((org-at-item-p) (call-interactively 'org-move-item-down))
18745 (t (org-drag-element-forward))))
18747 (defun org-shiftup (&optional arg)
18748 "Increase item in timestamp or increase priority of current headline.
18749 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18750 depending on context. See the individual commands for more information."
18751 (interactive "P")
18752 (cond
18753 ((run-hook-with-args-until-success 'org-shiftup-hook))
18754 ((and org-support-shift-select (org-region-active-p))
18755 (org-call-for-shift-select 'previous-line))
18756 ((org-at-timestamp-p t)
18757 (call-interactively (if org-edit-timestamp-down-means-later
18758 'org-timestamp-down 'org-timestamp-up)))
18759 ((and (not (eq org-support-shift-select 'always))
18760 org-enable-priority-commands
18761 (org-at-heading-p))
18762 (call-interactively 'org-priority-up))
18763 ((and (not org-support-shift-select) (org-at-item-p))
18764 (call-interactively 'org-previous-item))
18765 ((org-clocktable-try-shift 'up arg))
18766 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18767 (org-support-shift-select
18768 (org-call-for-shift-select 'previous-line))
18769 (t (org-shiftselect-error))))
18771 (defun org-shiftdown (&optional arg)
18772 "Decrease item in timestamp or decrease priority of current headline.
18773 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18774 depending on context. See the individual commands for more information."
18775 (interactive "P")
18776 (cond
18777 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18778 ((and org-support-shift-select (org-region-active-p))
18779 (org-call-for-shift-select 'next-line))
18780 ((org-at-timestamp-p t)
18781 (call-interactively (if org-edit-timestamp-down-means-later
18782 'org-timestamp-up 'org-timestamp-down)))
18783 ((and (not (eq org-support-shift-select 'always))
18784 org-enable-priority-commands
18785 (org-at-heading-p))
18786 (call-interactively 'org-priority-down))
18787 ((and (not org-support-shift-select) (org-at-item-p))
18788 (call-interactively 'org-next-item))
18789 ((org-clocktable-try-shift 'down arg))
18790 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18791 (org-support-shift-select
18792 (org-call-for-shift-select 'next-line))
18793 (t (org-shiftselect-error))))
18795 (defun org-shiftright (&optional arg)
18796 "Cycle the thing at point or in the current line, depending on context.
18797 Depending on context, this does one of the following:
18799 - switch a timestamp at point one day into the future
18800 - on a headline, switch to the next TODO keyword.
18801 - on an item, switch entire list to the next bullet type
18802 - on a property line, switch to the next allowed value
18803 - on a clocktable definition line, move time block into the future"
18804 (interactive "P")
18805 (cond
18806 ((run-hook-with-args-until-success 'org-shiftright-hook))
18807 ((and org-support-shift-select (org-region-active-p))
18808 (org-call-for-shift-select 'forward-char))
18809 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18810 ((and (not (eq org-support-shift-select 'always))
18811 (org-at-heading-p))
18812 (let ((org-inhibit-logging
18813 (not org-treat-S-cursor-todo-selection-as-state-change))
18814 (org-inhibit-blocking
18815 (not org-treat-S-cursor-todo-selection-as-state-change)))
18816 (org-call-with-arg 'org-todo 'right)))
18817 ((or (and org-support-shift-select
18818 (not (eq org-support-shift-select 'always))
18819 (org-at-item-bullet-p))
18820 (and (not org-support-shift-select) (org-at-item-p)))
18821 (org-call-with-arg 'org-cycle-list-bullet nil))
18822 ((and (not (eq org-support-shift-select 'always))
18823 (org-at-property-p))
18824 (call-interactively 'org-property-next-allowed-value))
18825 ((org-clocktable-try-shift 'right arg))
18826 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18827 (org-support-shift-select
18828 (org-call-for-shift-select 'forward-char))
18829 (t (org-shiftselect-error))))
18831 (defun org-shiftleft (&optional arg)
18832 "Cycle the thing at point or in the current line, depending on context.
18833 Depending on context, this does one of the following:
18835 - switch a timestamp at point one day into the past
18836 - on a headline, switch to the previous TODO keyword.
18837 - on an item, switch entire list to the previous bullet type
18838 - on a property line, switch to the previous allowed value
18839 - on a clocktable definition line, move time block into the past"
18840 (interactive "P")
18841 (cond
18842 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18843 ((and org-support-shift-select (org-region-active-p))
18844 (org-call-for-shift-select 'backward-char))
18845 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18846 ((and (not (eq org-support-shift-select 'always))
18847 (org-at-heading-p))
18848 (let ((org-inhibit-logging
18849 (not org-treat-S-cursor-todo-selection-as-state-change))
18850 (org-inhibit-blocking
18851 (not org-treat-S-cursor-todo-selection-as-state-change)))
18852 (org-call-with-arg 'org-todo 'left)))
18853 ((or (and org-support-shift-select
18854 (not (eq org-support-shift-select 'always))
18855 (org-at-item-bullet-p))
18856 (and (not org-support-shift-select) (org-at-item-p)))
18857 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18858 ((and (not (eq org-support-shift-select 'always))
18859 (org-at-property-p))
18860 (call-interactively 'org-property-previous-allowed-value))
18861 ((org-clocktable-try-shift 'left arg))
18862 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18863 (org-support-shift-select
18864 (org-call-for-shift-select 'backward-char))
18865 (t (org-shiftselect-error))))
18867 (defun org-shiftcontrolright ()
18868 "Switch to next TODO set."
18869 (interactive)
18870 (cond
18871 ((and org-support-shift-select (org-region-active-p))
18872 (org-call-for-shift-select 'forward-word))
18873 ((and (not (eq org-support-shift-select 'always))
18874 (org-at-heading-p))
18875 (org-call-with-arg 'org-todo 'nextset))
18876 (org-support-shift-select
18877 (org-call-for-shift-select 'forward-word))
18878 (t (org-shiftselect-error))))
18880 (defun org-shiftcontrolleft ()
18881 "Switch to previous TODO set."
18882 (interactive)
18883 (cond
18884 ((and org-support-shift-select (org-region-active-p))
18885 (org-call-for-shift-select 'backward-word))
18886 ((and (not (eq org-support-shift-select 'always))
18887 (org-at-heading-p))
18888 (org-call-with-arg 'org-todo 'previousset))
18889 (org-support-shift-select
18890 (org-call-for-shift-select 'backward-word))
18891 (t (org-shiftselect-error))))
18893 (defun org-shiftcontrolup ()
18894 "Change timestamps synchronously up in CLOCK log lines."
18895 (interactive)
18896 (cond ((and (not org-support-shift-select)
18897 (org-at-clock-log-p)
18898 (org-at-timestamp-p t))
18899 (org-clock-timestamps-up))
18900 (t (org-shiftselect-error))))
18902 (defun org-shiftcontroldown ()
18903 "Change timestamps synchronously down in CLOCK log lines."
18904 (interactive)
18905 (cond ((and (not org-support-shift-select)
18906 (org-at-clock-log-p)
18907 (org-at-timestamp-p t))
18908 (org-clock-timestamps-down))
18909 (t (org-shiftselect-error))))
18911 (defun org-ctrl-c-ret ()
18912 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18913 (interactive)
18914 (cond
18915 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18916 (t (call-interactively 'org-insert-heading))))
18918 (defun org-find-visible ()
18919 (let ((s (point)))
18920 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18921 (get-char-property s 'invisible)))
18922 s))
18923 (defun org-find-invisible ()
18924 (let ((s (point)))
18925 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18926 (not (get-char-property s 'invisible))))
18927 s))
18929 (defun org-copy-visible (beg end)
18930 "Copy the visible parts of the region."
18931 (interactive "r")
18932 (let (snippets s)
18933 (save-excursion
18934 (save-restriction
18935 (narrow-to-region beg end)
18936 (setq s (goto-char (point-min)))
18937 (while (not (= (point) (point-max)))
18938 (goto-char (org-find-invisible))
18939 (push (buffer-substring s (point)) snippets)
18940 (setq s (goto-char (org-find-visible))))))
18941 (kill-new (apply 'concat (nreverse snippets)))))
18943 (defun org-copy-special ()
18944 "Copy region in table or copy current subtree.
18945 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18946 See the individual commands for more information."
18947 (interactive)
18948 (call-interactively
18949 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18951 (defun org-cut-special ()
18952 "Cut region in table or cut current subtree.
18953 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18954 See the individual commands for more information."
18955 (interactive)
18956 (call-interactively
18957 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18959 (defun org-paste-special (arg)
18960 "Paste rectangular region into table, or past subtree relative to level.
18961 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18962 See the individual commands for more information."
18963 (interactive "P")
18964 (if (org-at-table-p)
18965 (org-table-paste-rectangle)
18966 (org-paste-subtree arg)))
18968 (defsubst org-in-fixed-width-region-p ()
18969 "Is point in a fixed-width region?"
18970 (save-match-data
18971 (eq 'fixed-width (org-element-type (org-element-at-point)))))
18973 (defun org-edit-special (&optional arg)
18974 "Call a special editor for the stuff at point.
18975 When at a table, call the formula editor with `org-table-edit-formulas'.
18976 When in a source code block, call `org-edit-src-code'.
18977 When in a fixed-width region, call `org-edit-fixed-width-region'.
18978 When in an #+include line, visit the included file.
18979 On a link, call `ffap' to visit the link at point.
18980 Otherwise, return a user error."
18981 (interactive)
18982 ;; possibly prep session before editing source
18983 (when (and (org-in-src-block-p) arg)
18984 (let* ((info (org-babel-get-src-block-info))
18985 (lang (nth 0 info))
18986 (params (nth 2 info))
18987 (session (cdr (assoc :session params))))
18988 (when (and info session) ;; we are in a source-code block with a session
18989 (funcall
18990 (intern (concat "org-babel-prep-session:" lang)) session params))))
18991 (cond ;; proceed with `org-edit-special'
18992 ((save-excursion
18993 (beginning-of-line 1)
18994 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18995 (find-file (org-trim (match-string 1))))
18996 ((or (org-at-table-p)
18997 (save-excursion
18998 (beginning-of-line 1)
19000 (call-interactively 'org-table-edit-formulas))
19001 ((or (org-in-block-p '("src" "example" "latex" "html"))
19002 (org-at-table.el-p))
19003 (org-edit-src-code))
19004 ((org-in-fixed-width-region-p) (org-edit-fixed-width-region))
19005 ((org-at-regexp-p org-any-link-re) (call-interactively 'ffap))
19006 (t (user-error "No special environment to edit here"))))
19008 (defvar org-table-coordinate-overlays) ; defined in org-table.el
19009 (defun org-ctrl-c-ctrl-c (&optional arg)
19010 "Set tags in headline, or update according to changed information at point.
19012 This command does many different things, depending on context:
19014 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
19015 this is what we do.
19017 - If the cursor is on a statistics cookie, update it.
19019 - If the cursor is in a headline, prompt for tags and insert them
19020 into the current line, aligned to `org-tags-column'. When called
19021 with prefix arg, realign all tags in the current buffer.
19023 - If the cursor is in one of the special #+KEYWORD lines, this
19024 triggers scanning the buffer for these lines and updating the
19025 information.
19027 - If the cursor is inside a table, realign the table. This command
19028 works even if the automatic table editor has been turned off.
19030 - If the cursor is on a #+TBLFM line, re-apply the formulas to
19031 the entire table.
19033 - If the cursor is at a footnote reference or definition, jump to
19034 the corresponding definition or references, respectively.
19036 - If the cursor is a the beginning of a dynamic block, update it.
19038 - If the current buffer is a capture buffer, close note and file it.
19040 - If the cursor is on a <<<target>>>, update radio targets and
19041 corresponding links in this buffer.
19043 - If the cursor is on a numbered item in a plain list, renumber the
19044 ordered list.
19046 - If the cursor is on a checkbox, toggle it.
19048 - If the cursor is on a code block, evaluate it. The variable
19049 `org-confirm-babel-evaluate' can be used to control prompting
19050 before code block evaluation, by default every code block
19051 evaluation requires confirmation. Code block evaluation can be
19052 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
19053 (interactive "P")
19054 (let ((org-enable-table-editor t))
19055 (cond
19056 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
19057 org-occur-highlights
19058 org-latex-fragment-image-overlays)
19059 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
19060 (org-remove-occur-highlights)
19061 (org-remove-latex-fragment-image-overlays)
19062 (message "Temporary highlights/overlays removed from current buffer"))
19063 ((and (local-variable-p 'org-finish-function (current-buffer))
19064 (fboundp org-finish-function))
19065 (funcall org-finish-function))
19066 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
19067 ((org-in-regexp org-ts-regexp-both)
19068 (org-timestamp-change 0 'day))
19069 ((or (looking-at org-property-start-re)
19070 (org-at-property-p))
19071 (call-interactively 'org-property-action))
19072 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
19074 (or (org-at-heading-p) (org-at-item-p)))
19075 (call-interactively 'org-update-statistics-cookies))
19076 ((org-at-heading-p) (call-interactively 'org-set-tags))
19077 ((org-at-table.el-p)
19078 (message "Use C-c ' to edit table.el tables"))
19079 ((org-at-table-p)
19080 (org-table-maybe-eval-formula)
19081 (if arg
19082 (call-interactively 'org-table-recalculate)
19083 (org-table-maybe-recalculate-line))
19084 (call-interactively 'org-table-align)
19085 (orgtbl-send-table 'maybe))
19086 ((or (org-footnote-at-reference-p)
19087 (org-footnote-at-definition-p))
19088 (call-interactively 'org-footnote-action))
19089 ((org-at-item-checkbox-p)
19090 ;; Cursor at a checkbox: repair list and update checkboxes. Send
19091 ;; list only if at top item.
19092 (let* ((cbox (match-string 1))
19093 (struct (org-list-struct))
19094 (old-struct (copy-tree struct))
19095 (parents (org-list-parents-alist struct))
19096 (orderedp (org-entry-get nil "ORDERED"))
19097 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19098 block-item)
19099 ;; Use a light version of `org-toggle-checkbox' to avoid
19100 ;; computing list structure twice.
19101 (let ((new-box (cond
19102 ((equal arg '(16)) "[-]")
19103 ((equal arg '(4)) nil)
19104 ((equal "[X]" cbox) "[ ]")
19105 (t "[X]"))))
19106 (if (and firstp arg)
19107 ;; If at first item of sub-list, remove check-box from
19108 ;; every item at the same level.
19109 (mapc
19110 (lambda (pos) (org-list-set-checkbox pos struct new-box))
19111 (org-list-get-all-items
19112 (point-at-bol) struct (org-list-prevs-alist struct)))
19113 (org-list-set-checkbox (point-at-bol) struct new-box)))
19114 ;; Replicate `org-list-write-struct', while grabbing a return
19115 ;; value from `org-list-struct-fix-box'.
19116 (org-list-struct-fix-ind struct parents 2)
19117 (org-list-struct-fix-item-end struct)
19118 (let ((prevs (org-list-prevs-alist struct)))
19119 (org-list-struct-fix-bul struct prevs)
19120 (org-list-struct-fix-ind struct parents)
19121 (setq block-item
19122 (org-list-struct-fix-box struct parents prevs orderedp)))
19123 (org-list-struct-apply-struct struct old-struct)
19124 (org-update-checkbox-count-maybe)
19125 (when block-item
19126 (message
19127 "Checkboxes were removed due to unchecked box at line %d"
19128 (org-current-line block-item)))
19129 (when firstp (org-list-send-list 'maybe))))
19130 ((org-at-item-p)
19131 ;; Cursor at an item: repair list. Do checkbox related actions
19132 ;; only if function was called with an argument. Send list only
19133 ;; if at top item.
19134 (let* ((struct (org-list-struct))
19135 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19136 old-struct)
19137 (when arg
19138 (setq old-struct (copy-tree struct))
19139 (if firstp
19140 ;; If at first item of sub-list, add check-box to every
19141 ;; item at the same level.
19142 (mapc
19143 (lambda (pos)
19144 (unless (org-list-get-checkbox pos struct)
19145 (org-list-set-checkbox pos struct "[ ]")))
19146 (org-list-get-all-items
19147 (point-at-bol) struct (org-list-prevs-alist struct)))
19148 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
19149 (org-list-write-struct
19150 struct (org-list-parents-alist struct) old-struct)
19151 (when arg (org-update-checkbox-count-maybe))
19152 (when firstp (org-list-send-list 'maybe))))
19153 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
19154 ;; Dynamic block
19155 (beginning-of-line 1)
19156 (save-excursion (org-update-dblock)))
19157 ((save-excursion
19158 (let ((case-fold-search t))
19159 (beginning-of-line 1)
19161 (cond
19162 ((or (equal (match-string 1) "TBLFM")
19163 (equal (match-string 1) "tblfm"))
19164 ;; Recalculate the table before this line
19165 (save-excursion
19166 (beginning-of-line 1)
19168 (if (org-at-table-p)
19169 (org-call-with-arg 'org-table-recalculate (or arg t)))))
19170 (t
19171 (let ((org-inhibit-startup-visibility-stuff t)
19172 (org-startup-align-all-tables nil))
19173 (when (boundp 'org-table-coordinate-overlays)
19174 (mapc 'delete-overlay org-table-coordinate-overlays)
19175 (setq org-table-coordinate-overlays nil))
19176 (org-save-outline-visibility 'use-markers (org-mode-restart)))
19177 (message "Local setup has been refreshed"))))
19178 ((org-clock-update-time-maybe))
19179 (t
19180 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19181 (error "C-c C-c can do nothing useful at this location"))))))
19183 (defun org-mode-restart ()
19184 "Restart Org-mode, to scan again for special lines.
19185 Also updates the keyword regular expressions."
19186 (interactive)
19187 (org-mode)
19188 (message "Org-mode restarted"))
19190 (defun org-kill-note-or-show-branches ()
19191 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
19192 (interactive)
19193 (if (not org-finish-function)
19194 (progn
19195 (hide-subtree)
19196 (call-interactively 'show-branches))
19197 (let ((org-note-abort t))
19198 (funcall org-finish-function))))
19200 (defun org-return (&optional indent)
19201 "Goto next table row or insert a newline.
19202 Calls `org-table-next-row' or `newline', depending on context.
19203 See the individual commands for more information."
19204 (interactive)
19205 (let (org-ts-what)
19206 (cond
19207 ((or (bobp) (org-in-src-block-p))
19208 (if indent (newline-and-indent) (newline)))
19209 ((org-at-table-p)
19210 (org-table-justify-field-maybe)
19211 (call-interactively 'org-table-next-row))
19212 ;; when `newline-and-indent' is called within a list, make sure
19213 ;; text moved stays inside the item.
19214 ((and (org-in-item-p) indent)
19215 (if (and (org-at-item-p) (>= (point) (match-end 0)))
19216 (progn
19217 (save-match-data (newline))
19218 (org-indent-line-to (length (match-string 0))))
19219 (let ((ind (org-get-indentation)))
19220 (newline)
19221 (if (org-looking-back org-list-end-re)
19222 (org-indent-line)
19223 (org-indent-line-to ind)))))
19224 ((and org-return-follows-link
19225 (org-at-timestamp-p t)
19226 (not (eq org-ts-what 'after)))
19227 (org-follow-timestamp-link))
19228 ((and org-return-follows-link
19229 (let ((tprop (get-text-property (point) 'face)))
19230 (or (eq tprop 'org-link)
19231 (and (listp tprop) (memq 'org-link tprop)))))
19232 (call-interactively 'org-open-at-point))
19233 ((and (org-at-heading-p)
19234 (looking-at
19236 (org-show-entry)
19237 (end-of-line 1)
19238 (newline))
19239 (t (if indent (newline-and-indent) (newline))))))
19241 (defun org-return-indent ()
19242 "Goto next table row or insert a newline and indent.
19243 Calls `org-table-next-row' or `newline-and-indent', depending on
19244 context. See the individual commands for more information."
19245 (interactive)
19246 (org-return t))
19248 (defun org-ctrl-c-star ()
19249 "Compute table, or change heading status of lines.
19250 Calls `org-table-recalculate' or `org-toggle-heading',
19251 depending on context."
19252 (interactive)
19253 (cond
19254 ((org-at-table-p)
19255 (call-interactively 'org-table-recalculate))
19256 (t
19257 ;; Convert all lines in region to list items
19258 (call-interactively 'org-toggle-heading))))
19260 (defun org-ctrl-c-minus ()
19261 "Insert separator line in table or modify bullet status of line.
19262 Also turns a plain line or a region of lines into list items.
19263 Calls `org-table-insert-hline', `org-toggle-item', or
19264 `org-cycle-list-bullet', depending on context."
19265 (interactive)
19266 (cond
19267 ((org-at-table-p)
19268 (call-interactively 'org-table-insert-hline))
19269 ((org-region-active-p)
19270 (call-interactively 'org-toggle-item))
19271 ((org-in-item-p)
19272 (call-interactively 'org-cycle-list-bullet))
19273 (t
19274 (call-interactively 'org-toggle-item))))
19276 (defun org-toggle-item (arg)
19277 "Convert headings or normal lines to items, items to normal lines.
19278 If there is no active region, only the current line is considered.
19280 If the first non blank line in the region is an headline, convert
19281 all headlines to items, shifting text accordingly.
19283 If it is an item, convert all items to normal lines.
19285 If it is normal text, change region into an item. With a prefix
19286 argument ARG, change each line in region into an item."
19287 (interactive "P")
19288 (let ((shift-text
19289 (function
19290 ;; Shift text in current section to IND, from point to END.
19291 ;; The function leaves point to END line.
19292 (lambda (ind end)
19293 (let ((min-i 1000) (end (copy-marker end)))
19294 ;; First determine the minimum indentation (MIN-I) of
19295 ;; the text.
19296 (save-excursion
19297 (catch 'exit
19298 (while (< (point) end)
19299 (let ((i (org-get-indentation)))
19300 (cond
19301 ;; Skip blank lines and inline tasks.
19303 ((looking-at org-outline-regexp-bol))
19304 ;; We can't find less than 0 indentation.
19305 ((zerop i) (throw 'exit (setq min-i 0)))
19306 ((< i min-i) (setq min-i i))))
19307 (forward-line))))
19308 ;; Then indent each line so that a line indented to
19309 ;; MIN-I becomes indented to IND. Ignore blank lines
19310 ;; and inline tasks in the process.
19311 (let ((delta (- ind min-i)))
19312 (while (< (point) end)
19314 (looking-at org-outline-regexp-bol))
19315 (org-indent-line-to (+ (org-get-indentation) delta)))
19316 (forward-line)))))))
19317 (skip-blanks
19318 (function
19319 ;; Return beginning of first non-blank line, starting from
19320 ;; line at POS.
19321 (lambda (pos)
19322 (save-excursion
19323 (goto-char pos)
19325 (point-at-bol)))))
19326 beg end)
19327 ;; Determine boundaries of changes.
19328 (if (org-region-active-p)
19329 (setq beg (funcall skip-blanks (region-beginning))
19330 end (copy-marker (region-end)))
19331 (setq beg (funcall skip-blanks (point-at-bol))
19332 end (copy-marker (point-at-eol))))
19333 ;; Depending on the starting line, choose an action on the text
19334 ;; between BEG and END.
19335 (org-with-limited-levels
19336 (save-excursion
19337 (goto-char beg)
19338 (cond
19339 ;; Case 1. Start at an item: de-itemize. Note that it only
19340 ;; happens when a region is active: `org-ctrl-c-minus'
19341 ;; would call `org-cycle-list-bullet' otherwise.
19342 ((org-at-item-p)
19343 (while (< (point) end)
19344 (when (org-at-item-p)
19346 (delete-region (point) (match-end 0)))
19347 (forward-line)))
19348 ;; Case 2. Start at an heading: convert to items.
19349 ((org-at-heading-p)
19350 (let* ((bul (org-list-bullet-string "-"))
19351 (bul-len (length bul))
19352 ;; Indentation of the first heading. It should be
19353 ;; relative to the indentation of its parent, if any.
19354 (start-ind (save-excursion
19355 (cond
19356 ((not org-adapt-indentation) 0)
19357 ((not (outline-previous-heading)) 0)
19358 (t (length (match-string 0))))))
19359 ;; Level of first heading. Further headings will be
19360 ;; compared to it to determine hierarchy in the list.
19361 (ref-level (org-reduced-level (org-outline-level))))
19362 (while (< (point) end)
19363 (let* ((level (org-reduced-level (org-outline-level)))
19364 (delta (max 0 (- level ref-level))))
19365 ;; If current headline is less indented than the first
19366 ;; one, set it as reference, in order to preserve
19367 ;; subtrees.
19368 (when (< level ref-level) (setq ref-level level))
19369 (replace-match bul t t)
19370 (org-indent-line-to (+ start-ind (* delta bul-len)))
19371 ;; Ensure all text down to END (or SECTION-END) belongs
19372 ;; to the newly created item.
19373 (let ((section-end (save-excursion
19374 (or (outline-next-heading) (point)))))
19375 (forward-line)
19376 (funcall shift-text
19377 (+ start-ind (* (1+ delta) bul-len))
19378 (min end section-end)))))))
19379 ;; Case 3. Normal line with ARG: turn each non-item line into
19380 ;; an item.
19381 (arg
19382 (while (< (point) end)
19383 (unless (or (org-at-heading-p) (org-at-item-p))
19385 (replace-match
19387 (forward-line)))
19388 ;; Case 4. Normal line without ARG: make the first line of
19389 ;; region an item, and shift indentation of others
19390 ;; lines to set them as item's body.
19391 (t (let* ((bul (org-list-bullet-string "-"))
19392 (bul-len (length bul))
19393 (ref-ind (org-get-indentation)))
19395 (insert bul)
19396 (forward-line)
19397 (while (< (point) end)
19398 ;; Ensure that lines less indented than first one
19399 ;; still get included in item body.
19400 (funcall shift-text
19401 (+ ref-ind bul-len)
19402 (min end (save-excursion (or (outline-next-heading)
19403 (point)))))
19404 (forward-line)))))))))
19406 (defun org-toggle-heading (&optional nstars)
19407 "Convert headings to normal text, or items or text to headings.
19408 If there is no active region, only the current line is considered.
19411 point into heading.
19413 In a region:
19415 - If the first non blank line is an headline, remove the stars
19416 from all headlines in the region.
19418 - If it is a normal line turn each and every normal line (i.e. not an
19419 heading or an item) in the region into a heading.
19421 - If it is a plain list item, turn all plain list items into headings.
19423 When converting a line into a heading, the number of stars is chosen
19424 such that the lines become children of the current entry. However,
19425 when a prefix argument is given, its value determines the number of
19426 stars to add."
19427 (interactive "P")
19428 (let ((skip-blanks
19429 (function
19430 ;; Return beginning of first non-blank line, starting from
19431 ;; line at POS.
19432 (lambda (pos)
19433 (save-excursion
19434 (goto-char pos)
19435 (while (org-at-comment-p) (forward-line))
19437 (point-at-bol)))))
19438 beg end toggled)
19439 ;; Determine boundaries of changes. If a universal prefix has
19440 ;; been given, put the list in a region. If region ends at a bol,
19441 ;; do not consider the last line to be in the region.
19443 (when (and current-prefix-arg (org-at-item-p))
19444 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
19445 (org-mark-element))
19447 (if (org-region-active-p)
19448 (setq beg (funcall skip-blanks (region-beginning))
19449 end (copy-marker (save-excursion
19450 (goto-char (region-end))
19451 (if (bolp) (point) (point-at-eol)))))
19452 (setq beg (funcall skip-blanks (point-at-bol))
19453 end (copy-marker (point-at-eol))))
19454 ;; Ensure inline tasks don't count as headings.
19455 (org-with-limited-levels
19456 (save-excursion
19457 (goto-char beg)
19458 (cond
19459 ;; Case 1. Started at an heading: de-star headings.
19460 ((org-at-heading-p)
19461 (while (< (point) end)
19462 (when (org-at-heading-p t)
19463 (looking-at org-outline-regexp) (replace-match "")
19464 (setq toggled t))
19465 (forward-line)))
19466 ;; Case 2. Started at an item: change items into headlines.
19467 ;; One star will be added by `org-list-to-subtree'.
19468 ((org-at-item-p)
19469 (let* ((stars (make-string
19470 (if nstars
19471 ;; subtract the star that will be added again by
19472 ;; `org-list-to-subtree'
19473 (1- (prefix-numeric-value current-prefix-arg))
19474 (or (org-current-level) 0))
19475 ?*))
19476 (add-stars
19477 (cond (nstars "") ; stars from prefix only
19478 ((equal stars "") "") ; before first heading
19479 (org-odd-levels-only "*") ; inside heading, odd
19480 (t "")))) ; inside heading, oddeven
19481 (while (< (point) end)
19482 (when (org-at-item-p)
19483 ;; Pay attention to cases when region ends before list.
19484 (let* ((struct (org-list-struct))
19485 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
19486 (save-restriction
19487 (narrow-to-region (point) list-end)
19488 (insert
19489 (org-list-to-subtree
19490 (org-list-parse-list t)
19491 '(:istart (concat stars add-stars (funcall get-stars depth))
19492 :icount (concat stars add-stars (funcall get-stars depth)))))))
19493 (setq toggled t))
19494 (forward-line))))
19495 ;; Case 3. Started at normal text: make every line an heading,
19496 ;; skipping headlines and items.
19497 (t (let* ((stars (make-string
19498 (if nstars
19499 (prefix-numeric-value current-prefix-arg)
19500 (or (org-current-level) 0))
19501 ?*))
19502 (add-stars
19503 (cond (nstars "") ; stars from prefix only
19504 ((equal stars "") "*") ; before first heading
19505 (org-odd-levels-only "**") ; inside heading, odd
19506 (t "*"))) ; inside heading, oddeven
19507 (rpl (concat stars add-stars " ")))
19508 (while (< (point) end)
19509 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
19511 (replace-match (concat rpl (match-string 2))) (setq toggled t))
19512 (forward-line)))))))
19513 (unless toggled (message "Cannot toggle heading from here"))))
19515 (defun org-meta-return (&optional arg)
19516 "Insert a new heading or wrap a region in a table.
19517 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
19518 See the individual commands for more information."
19519 (interactive "P")
19520 (cond
19521 ((run-hook-with-args-until-success 'org-metareturn-hook))
19522 ((or (org-at-drawer-p) (org-at-property-p))
19523 (newline-and-indent))
19524 ((org-at-table-p)
19525 (call-interactively 'org-table-wrap-region))
19526 (t (call-interactively 'org-insert-heading))))
19528 ;;; Menu entries
19530 (defsubst org-in-subtree-not-table-p ()
19531 "Are we in a subtree and not in a table?"
19532 (and (not (org-before-first-heading-p))
19533 (not (org-at-table-p))))
19535 ;; Define the Org-mode menus
19536 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
19537 '("Tbl"
19538 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
19539 ["Next Field" org-cycle (org-at-table-p)]
19540 ["Previous Field" org-shifttab (org-at-table-p)]
19541 ["Next Row" org-return (org-at-table-p)]
19542 "--"
19543 ["Blank Field" org-table-blank-field (org-at-table-p)]
19544 ["Edit Field" org-table-edit-field (org-at-table-p)]
19545 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
19546 "--"
19547 ("Column"
19548 ["Move Column Left" org-metaleft (org-at-table-p)]
19549 ["Move Column Right" org-metaright (org-at-table-p)]
19550 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
19551 ["Insert Column" org-shiftmetaright (org-at-table-p)])
19552 ("Row"
19553 ["Move Row Up" org-metaup (org-at-table-p)]
19554 ["Move Row Down" org-metadown (org-at-table-p)]
19555 ["Delete Row" org-shiftmetaup (org-at-table-p)]
19556 ["Insert Row" org-shiftmetadown (org-at-table-p)]
19557 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
19558 "--"
19559 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
19560 ("Rectangle"
19561 ["Copy Rectangle" org-copy-special (org-at-table-p)]
19562 ["Cut Rectangle" org-cut-special (org-at-table-p)]
19563 ["Paste Rectangle" org-paste-special (org-at-table-p)]
19564 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
19565 "--"
19566 ("Calculate"
19567 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
19568 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
19569 ["Edit Formulas" org-edit-special (org-at-table-p)]
19570 "--"
19571 ["Recalculate line" org-table-recalculate (org-at-table-p)]
19572 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
19573 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
19574 "--"
19575 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
19576 "--"
19577 ["Sum Column/Rectangle" org-table-sum
19578 (or (org-at-table-p) (org-region-active-p))]
19579 ["Which Column?" org-table-current-column (org-at-table-p)])
19580 ["Debug Formulas"
19581 org-table-toggle-formula-debugger
19582 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
19583 ["Show Col/Row Numbers"
19584 org-table-toggle-coordinate-overlays
19585 :style toggle
19586 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
19587 "--"
19588 ["Create" org-table-create (and (not (org-at-table-p))
19589 org-enable-table-editor)]
19590 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
19591 ["Import from File" org-table-import (not (org-at-table-p))]
19592 ["Export to File" org-table-export (org-at-table-p)]
19593 "--"
19594 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
19596 (easy-menu-define org-org-menu org-mode-map "Org menu"
19597 '("Org"
19598 ("Show/Hide"
19599 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
19600 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
19601 ["Sparse Tree..." org-sparse-tree t]
19602 ["Reveal Context" org-reveal t]
19603 ["Show All" show-all t]
19604 "--"
19605 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
19606 "--"
19607 ["New Heading" org-insert-heading t]
19608 ("Navigate Headings"
19609 ["Up" outline-up-heading t]
19610 ["Next" outline-next-visible-heading t]
19611 ["Previous" outline-previous-visible-heading t]
19612 ["Next Same Level" outline-forward-same-level t]
19613 ["Previous Same Level" outline-backward-same-level t]
19614 "--"
19615 ["Jump" org-goto t])
19616 ("Edit Structure"
19617 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
19618 "--"
19619 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
19620 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
19621 "--"
19622 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
19623 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
19624 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19625 "--"
19626 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19627 "--"
19628 ["Copy visible text" org-copy-visible t]
19629 "--"
19630 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
19631 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
19632 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
19633 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
19634 "--"
19635 ["Sort Region/Children" org-sort t]
19636 "--"
19637 ["Convert to odd levels" org-convert-to-odd-levels t]
19638 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19639 ("Editing"
19640 ["Emphasis..." org-emphasize t]
19641 ["Edit Source Example" org-edit-special t]
19642 "--"
19643 ["Footnote new/jump" org-footnote-action t]
19644 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19645 ("Archive"
19646 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
19647 "--"
19648 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
19649 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
19650 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
19651 )
19652 "--"
19653 ("Hyperlinks"
19654 ["Store Link (Global)" org-store-link t]
19655 ["Find existing link to here" org-occur-link-in-agenda-files t]
19656 ["Insert Link" org-insert-link t]
19657 ["Follow Link" org-open-at-point t]
19658 "--"
19659 ["Next link" org-next-link t]
19660 ["Previous link" org-previous-link t]
19661 "--"
19662 ["Descriptive Links"
19663 org-toggle-link-display
19664 :style radio
19665 :selected org-descriptive-links
19666 ]
19667 ["Literal Links"
19668 org-toggle-link-display
19669 :style radio
19670 :selected (not org-descriptive-links)])
19671 "--"
19672 ("TODO Lists"
19673 ["TODO/DONE/-" org-todo t]
19674 ("Select keyword"
19675 ["Next keyword" org-shiftright (org-at-heading-p)]
19676 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19677 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19678 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19679 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19680 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19681 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19682 "--"
19683 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19684 :selected org-enforce-todo-dependencies :style toggle :active t]
19685 "Settings for tree at point"
19686 ["Do Children sequentially" org-toggle-ordered-property :style radio
19687 :selected (org-entry-get nil "ORDERED")
19688 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19689 ["Do Children parallel" org-toggle-ordered-property :style radio
19690 :selected (not (org-entry-get nil "ORDERED"))
19691 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19692 "--"
19693 ["Set Priority" org-priority t]
19694 ["Priority Up" org-shiftup t]
19695 ["Priority Down" org-shiftdown t]
19696 "--"
19697 ["Get news from all feeds" org-feed-update-all t]
19698 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19699 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19700 ("TAGS and Properties"
19701 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
19702 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19703 "--"
19704 ["Set property" org-set-property (not (org-before-first-heading-p))]
19705 ["Column view of properties" org-columns t]
19706 ["Insert Column View DBlock" org-insert-columns-dblock t])
19707 ("Dates and Scheduling"
19708 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
19709 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
19710 ("Change Date"
19711 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
19712 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
19713 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
19714 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
19715 ["Compute Time Range" org-evaluate-time-range t]
19716 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
19717 ["Deadline" org-deadline (not (org-before-first-heading-p))]
19718 "--"
19719 ["Custom time format" org-toggle-time-stamp-overlays
19720 :style radio :selected org-display-custom-times]
19721 "--"
19722 ["Goto Calendar" org-goto-calendar t]
19723 ["Date from Calendar" org-date-from-calendar t]
19724 "--"
19725 ["Start/Restart Timer" org-timer-start t]
19726 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19727 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19728 ["Insert Timer String" org-timer t]
19729 ["Insert Timer Item" org-timer-item t])
19730 ("Logging work"
19731 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19732 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19733 ["Clock out" org-clock-out t]
19734 ["Clock cancel" org-clock-cancel t]
19735 "--"
19736 ["Mark as default task" org-clock-mark-default-task t]
19737 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19738 ["Goto running clock" org-clock-goto t]
19739 "--"
19740 ["Display times" org-clock-display t]
19741 ["Create clock table" org-clock-report t]
19742 "--"
19743 ["Record DONE time"
19744 (progn (setq org-log-done (not org-log-done))
19745 (message "Switching to %s will %s record a timestamp"
19746 (car org-done-keywords)
19747 (if org-log-done "automatically" "not")))
19748 :style toggle :selected org-log-done])
19749 "--"
19750 ["Agenda Command..." org-agenda t]
19751 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19752 ("File List for Agenda")
19753 ("Special views current file"
19754 ["TODO Tree" org-show-todo-tree t]
19755 ["Check Deadlines" org-check-deadlines t]
19756 ["Timeline" org-timeline t]
19757 ["Tags/Property tree" org-match-sparse-tree t])
19758 "--"
19759 ["Export/Publish..." org-export t]
19760 ("LaTeX"
19761 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19762 :selected org-cdlatex-mode]
19763 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19764 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19765 ["Modify math symbol" org-cdlatex-math-modify
19766 (org-inside-LaTeX-fragment-p)]
19767 ["Insert citation" org-reftex-citation t]
19768 "--"
19769 ["Template for BEAMER" (progn (require 'org-beamer)
19770 (org-insert-beamer-options-template)) t])
19771 "--"
19772 ("MobileOrg"
19773 ["Push Files and Views" org-mobile-push t]
19774 ["Get Captured and Flagged" org-mobile-pull t]
19775 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19776 "--"
19777 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19778 "--"
19779 ("Documentation"
19780 ["Show Version" org-version t]
19781 ["Info Documentation" org-info t])
19782 ("Customize"
19783 ["Browse Org Group" org-customize t]
19784 "--"
19785 ["Expand This Menu" org-create-customize-menu
19786 (fboundp 'customize-menu-create)])
19787 ["Send bug report" org-submit-bug-report t]
19788 "--"
19789 ("Refresh/Reload"
19790 ["Refresh setup current buffer" org-mode-restart t]
19791 ["Reload Org (after update)" org-reload t]
19792 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19793 ))
19795 (defun org-info (&optional node)
19796 "Read documentation for Org-mode in the info system.
19797 With optional NODE, go directly to that node."
19798 (interactive)
19799 (info (format "(org)%s" (or node ""))))
19801 ;;;###autoload
19802 (defun org-submit-bug-report ()
19803 "Submit a bug report on Org-mode via mail.
19805 Don't hesitate to report any problems or inaccurate documentation.
19807 If you don't have setup sending mail from (X)Emacs, please copy the
19808 output buffer into your mail program, as it gives us important
19809 information about your Org-mode version and configuration."
19810 (interactive)
19811 (require 'reporter)
19812 (org-load-modules-maybe)
19813 (org-require-autoloaded-modules)
19814 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19815 (reporter-submit-bug-report
19816 "emacs-orgmode@gnu.org"
19817 (org-version nil 'full)
19818 (let (list)
19819 (save-window-excursion
19820 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19821 (delete-other-windows)
19822 (erase-buffer)
19823 (insert "You are about to submit a bug report to the Org-mode mailing list.
19825 We would like to add your full Org-mode and Outline configuration to the
19826 bug report. This greatly simplifies the work of the maintainer and
19827 other experts on the mailing list.
19829 HOWEVER, some variables you have customized may contain private
19830 information. The names of customers, colleagues, or friends, might
19831 appear in the form of file names, tags, todo states, or search strings.
19832 If you answer yes to the prompt, you might want to check and remove
19833 such private information before sending the email.")
19834 (add-text-properties (point-min) (point-max) '(face org-warning))
19835 (when (yes-or-no-p "Include your Org-mode configuration ")
19836 (mapatoms
19837 (lambda (v)
19838 (and (boundp v)
19840 (or (and (symbol-value v)
19842 (and
19843 (get v 'custom-type) (get v 'standard-value)
19844 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19845 (push v list)))))
19846 (kill-buffer (get-buffer "*Warn about privacy*"))
19847 list))
19848 nil nil
19849 "Remember to cover the basics, that is, what you expected to happen and
19850 what in fact did happen. You don't know how to make a good report? See
19852 http://orgmode.org/manual/Feedback.html#Feedback
19854 Your bug report will be posted to the Org-mode mailing list.
19855 ------------------------------------------------------------------------")
19856 (save-excursion
19861 (defun org-install-agenda-files-menu ()
19862 (let ((bl (buffer-list)))
19863 (save-excursion
19864 (while bl
19865 (set-buffer (pop bl))
19866 (if (derived-mode-p 'org-mode) (setq bl nil)))
19867 (when (derived-mode-p 'org-mode)
19868 (easy-menu-change
19869 '("Org") "File List for Agenda"
19870 (append
19871 (list
19872 ["Edit File List" (org-edit-agenda-file-list) t]
19873 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19874 ["Remove Current File from List" org-remove-file t]
19875 ["Cycle through agenda files" org-cycle-agenda-files t]
19876 ["Occur in all agenda files" org-occur-in-agenda-files t]
19877 "--")
19878 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19880 ;;;; Documentation
19882 (defun org-require-autoloaded-modules ()
19883 (interactive)
19884 (mapc 'require
19885 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19886 org-docbook org-exp org-html org-icalendar
19887 org-id org-latex
19888 org-publish org-remember org-table
19889 org-timer org-xoxo)))
19891 ;;;###autoload
19892 (defun org-reload (&optional uncompiled)
19893 "Reload all org lisp files.
19894 With prefix arg UNCOMPILED, load the uncompiled versions."
19895 (interactive "P")
19896 (require 'find-func)
19898 (dir-org (file-name-directory (org-find-library-dir "org")))
19899 (dir-org-contrib (ignore-errors
19900 (file-name-directory
19901 (org-find-library-dir "org-contribdir"))))
19902 (babel-files
19903 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19904 (append (list nil "comint" "eval" "exp" "keys"
19905 "lob" "ref" "table" "tangle")
19906 (delq nil
19907 (mapcar
19908 (lambda (lang)
19909 (when (cdr lang) (symbol-name (car lang))))
19910 org-babel-load-languages)))))
19911 (files
19912 (append babel-files
19913 (and dir-org-contrib
19914 (directory-files dir-org-contrib t file-re))
19915 (directory-files dir-org t file-re)))
19916 (remove-re (concat (if (featurep 'xemacs)
19917 "org-colview" "org-colview-xemacs")
19919 (setq files (mapcar 'file-name-sans-extension files))
19920 (setq files (mapcar
19921 (lambda (x) (if (string-match remove-re x) nil x))
19922 files))
19923 (setq files (delq nil files))
19924 (mapc
19925 (lambda (f)
19926 (when (featurep (intern (file-name-nondirectory f)))
19927 (if (and (not uncompiled)
19928 (file-exists-p (concat f ".elc")))
19929 (load (concat f ".elc") nil nil 'nosuffix)
19930 (load (concat f ".el") nil nil 'nosuffix))))
19931 files)
19932 (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
19933 (org-version nil 'full 'message))
19935 ;;;###autoload
19936 (defun org-customize ()
19937 "Call the customize function with org as argument."
19938 (interactive)
19939 (org-load-modules-maybe)
19940 (org-require-autoloaded-modules)
19941 (customize-browse 'org))
19943 (defun org-create-customize-menu ()
19944 "Create a full customization menu for Org-mode, insert it into the menu."
19945 (interactive)
19946 (org-load-modules-maybe)
19947 (org-require-autoloaded-modules)
19948 (if (fboundp 'customize-menu-create)
19949 (progn
19950 (easy-menu-change
19951 '("Org") "Customize"
19952 `(["Browse Org group" org-customize t]
19953 "--"
19954 ,(customize-menu-create 'org)
19955 ["Set" Custom-set t]
19956 ["Save" Custom-save t]
19957 ["Reset to Current" Custom-reset-current t]
19958 ["Reset to Saved" Custom-reset-saved t]
19959 ["Reset to Standard Settings" Custom-reset-standard t]))
19961 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19963 ;;;; Miscellaneous stuff
19965 ;;; Generally useful functions
19967 (defun org-get-at-bol (property)
19968 "Get text property PROPERTY at beginning of line."
19969 (get-text-property (point-at-bol) property))
19971 (defun org-find-text-property-in-string (prop s)
19972 "Return the first non-nil value of property PROP in string S."
19973 (or (get-text-property 0 prop s)
19974 (get-text-property (or (next-single-property-change 0 prop s) 0)
19975 prop s)))
19977 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19978 "Display the given MESSAGE as a warning."
19979 (if (fboundp 'display-warning)
19980 (display-warning 'org message
19981 (if (featurep 'xemacs) 'warning :warning))
19982 (let ((buf (get-buffer-create "*Org warnings*")))
19983 (with-current-buffer buf
19984 (goto-char (point-max))
19985 (insert "Warning (Org): " message)
19986 (unless (bolp)
19987 (newline)))
19988 (display-buffer buf)
19989 (sit-for 0))))
19991 (defun org-eval (form)
19992 "Eval FORM and return result."
19993 (condition-case error
19994 (eval form)
19995 (error (format "%%![Error: %s]" error))))
19997 (defun org-in-clocktable-p ()
19998 "Check if the cursor is in a clocktable."
19999 (let ((pos (point)) start)
20000 (save-excursion
20001 (end-of-line 1)
20003 (setq start (match-beginning 0))
20005 (>= (match-end 0) pos)
20006 start))))
20008 (defun org-in-commented-line ()
20009 "Is point in a line starting with `#'?"
20010 (equal (char-after (point-at-bol)) ?#))
20012 (defun org-in-indented-comment-line ()
20013 "Is point in a line starting with `#' after some white space?"
20014 (save-excursion
20015 (save-match-data
20016 (goto-char (point-at-bol))
20019 (defun org-in-verbatim-emphasis ()
20020 (save-match-data
20021 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
20023 (defun org-goto-marker-or-bmk (marker &optional bookmark)
20024 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
20025 (if (and marker (marker-buffer marker)
20026 (buffer-live-p (marker-buffer marker)))
20027 (progn
20028 (org-pop-to-buffer-same-window (marker-buffer marker))
20029 (if (or (> marker (point-max)) (< marker (point-min)))
20030 (widen))
20031 (goto-char marker)
20032 (org-show-context 'org-goto))
20033 (if bookmark
20034 (bookmark-jump bookmark)
20035 (error "Cannot find location"))))
20037 (defun org-quote-csv-field (s)
20038 "Quote field for inclusion in CSV material."
20041 s))
20043 (defun org-force-self-insert (N)
20044 "Needed to enforce self-insert under remapping."
20045 (interactive "p")
20046 (self-insert-command N))
20048 (defun org-string-width (s)
20049 "Compute width of string, ignoring invisible characters.
20050 This ignores character with invisibility property `org-link', and also
20051 characters with property `org-cwidth', because these will become invisible
20052 upon the next fontification round."
20053 (let (b l)
20054 (when (or (eq t buffer-invisibility-spec)
20055 (assq 'org-link buffer-invisibility-spec))
20056 (while (setq b (text-property-any 0 (length s)
20057 'invisible 'org-link s))
20058 (setq s (concat (substring s 0 b)
20059 (substring s (or (next-single-property-change
20060 b 'invisible s) (length s)))))))
20061 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
20062 (setq s (concat (substring s 0 b)
20063 (substring s (or (next-single-property-change
20064 b 'org-cwidth s) (length s))))))
20065 (setq l (string-width s) b -1)
20066 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
20067 (setq l (- l (get-text-property b 'org-dwidth-n s))))
20068 l))
20070 (defun org-shorten-string (s maxlength)
20071 "Shorten string S so tht it is no longer than MAXLENGTH characters.
20072 If the string is shorter or has length MAXLENGTH, just return the
20073 original string. If it is longer, the functions finds a space in the
20074 string, breaks this string off at that locations and adds three dots
20075 as ellipsis. Including the ellipsis, the string will not be longer
20076 than MAXLENGTH. If finding a good breaking point in the string does
20077 not work, the string is just chopped off in the middle of a word
20078 if necessary."
20079 (if (<= (length s) maxlength)
20080 s
20081 (let* ((n (max (- maxlength 4) 1))
20083 (if (string-match re s)
20084 (concat (match-string 1 s) "...")
20085 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
20087 (defun org-get-indentation (&optional line)
20088 "Get the indentation of the current line, interpreting tabs.
20089 When LINE is given, assume it represents a line and compute its indentation."
20090 (if line
20091 (if (string-match "^ *" (org-remove-tabs line))
20092 (match-end 0))
20093 (save-excursion
20094 (beginning-of-line 1)
20096 (current-column))))
20098 (defun org-get-string-indentation (s)
20099 "What indentation has S due to SPACE and TAB at the beginning of the string?"
20100 (let ((n -1) (i 0) (w tab-width) c)
20101 (catch 'exit
20102 (while (< (setq n (1+ n)) (length s))
20103 (setq c (aref s n))
20104 (cond ((= c ?\ ) (setq i (1+ i)))
20106 (t (throw 'exit t)))))
20107 i))
20109 (defun org-remove-tabs (s &optional width)
20110 "Replace tabulators in S with spaces.
20111 Assumes that s is a single line, starting in column 0."
20112 (setq width (or width tab-width))
20114 (setq s (replace-match
20115 (make-string
20116 (- (* width (/ (+ (match-beginning 0) width) width))
20117 (match-beginning 0)) ?\ )
20118 t t s)))
20119 s)
20121 (defun org-fix-indentation (line ind)
20122 "Fix indentation in LINE.
20123 IND is a cons cell with target and minimum indentation.
20124 If the current indentation in LINE is smaller than the minimum,
20125 leave it alone. If it is larger than ind, set it to the target."
20126 (let* ((l (org-remove-tabs line))
20127 (i (org-get-indentation l))
20128 (i1 (car ind)) (i2 (cdr ind)))
20129 (if (>= i i2) (setq l (substring line i2)))
20130 (if (> i1 0)
20131 (concat (make-string i1 ?\ ) l)
20132 l)))
20134 (defun org-remove-indentation (code &optional n)
20135 "Remove the maximum common indentation from the lines in CODE.
20136 N may optionally be the number of spaces to remove."
20137 (with-temp-buffer
20138 (insert code)
20139 (org-do-remove-indentation n)
20140 (buffer-string)))
20142 (defun org-do-remove-indentation (&optional n)
20143 "Remove the maximum common indentation from the buffer."
20144 (untabify (point-min) (point-max))
20145 (let ((min 10000) re)
20146 (if n
20147 (setq min n)
20148 (goto-char (point-min))
20150 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
20151 (unless (or (= min 0) (= min 10000))
20153 (goto-char (point-min))
20154 (while (re-search-forward re nil t)
20155 (replace-match "")
20156 (end-of-line 1))
20157 min)))
20159 (defun org-fill-template (template alist)
20160 "Find each %key of ALIST in TEMPLATE and replace it."
20161 (let ((case-fold-search nil)
20162 entry key value)
20163 (setq alist (sort (copy-sequence alist)
20164 (lambda (a b) (< (length (car a)) (length (car b))))))
20165 (while (setq entry (pop alist))
20166 (setq template
20167 (replace-regexp-in-string
20168 (concat "%" (regexp-quote (car entry)))
20169 (or (cdr entry) "") template t t)))
20170 template))
20172 (defun org-base-buffer (buffer)
20173 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
20174 (if (not buffer)
20175 buffer
20176 (or (buffer-base-buffer buffer)
20177 buffer)))
20179 (defun org-trim (s)
20180 "Remove whitespace at beginning and end of string."
20183 s)
20185 (defun org-wrap (string &optional width lines)
20186 "Wrap string to either a number of lines, or a width in characters.
20187 If WIDTH is non-nil, the string is wrapped to that width, however many lines
20188 that costs. If there is a word longer than WIDTH, the text is actually
20189 wrapped to the length of that word.
20190 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
20191 many lines, whatever width that takes.
20192 The return value is a list of lines, without newlines at the end."
20194 (maxword (apply 'max (mapcar 'org-string-width words)))
20195 w ll)
20196 (cond (width
20197 (org-do-wrap words (max maxword width)))
20198 (lines
20199 (setq w maxword)
20200 (setq ll (org-do-wrap words maxword))
20201 (if (<= (length ll) lines)
20202 ll
20203 (setq ll words)
20204 (while (> (length ll) lines)
20205 (setq w (1+ w))
20206 (setq ll (org-do-wrap words w)))
20207 ll))
20208 (t (error "Cannot wrap this")))))
20210 (defun org-do-wrap (words width)
20211 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
20212 (let (lines line)
20213 (while words
20214 (setq line (pop words))
20215 (while (and words (< (+ (length line) (length (car words))) width))
20216 (setq line (concat line " " (pop words))))
20217 (setq lines (push line lines)))
20218 (nreverse lines)))
20220 (defun org-split-string (string &optional separators)
20221 "Splits STRING into substrings at SEPARATORS.
20222 No empty strings are returned if there are matches at the beginning
20223 and end of string."
20225 (start 0)
20226 notfirst
20227 (list nil))
20228 (while (and (string-match rexp string
20229 (if (and notfirst
20230 (= start (match-beginning 0))
20231 (< start (length string)))
20232 (1+ start) start))
20233 (< (match-beginning 0) (length string)))
20234 (setq notfirst t)
20235 (or (eq (match-beginning 0) 0)
20236 (and (eq (match-beginning 0) (match-end 0))
20237 (eq (match-beginning 0) start))
20238 (setq list
20239 (cons (substring string start (match-beginning 0))
20240 list)))
20241 (setq start (match-end 0)))
20242 (or (eq start (length string))
20243 (setq list
20244 (cons (substring string start)
20245 list)))
20246 (nreverse list)))
20248 (defun org-quote-vert (s)
20250 (while (string-match "|" s)
20252 s)
20254 (defun org-uuidgen-p (s)
20255 "Is S an ID created by UUIDGEN?"
20256 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
20258 (defun org-in-src-block-p (&optional inside)
20259 "Whether point is in a code source block.
20260 When INSIDE is non-nil, don't consider we are within a src block
20261 when point is at #+BEGIN_SRC or #+END_SRC."
20262 (let ((case-fold-search t) ov)
20263 (or (and (setq ov (overlays-at (point)))
20264 (memq 'org-block-background
20265 (overlay-properties (car ov))))
20266 (and (not inside)
20267 (save-match-data
20268 (save-excursion
20269 (beginning-of-line)
20272 (defun org-context ()
20273 "Return a list of contexts of the current cursor position.
20274 If several contexts apply, all are returned.
20275 Each context entry is a list with a symbol naming the context, and
20276 two positions indicating start and end of the context. Possible
20277 contexts are:
20279 :headline anywhere in a headline
20280 :headline-stars on the leading stars in a headline
20281 :todo-keyword on a TODO keyword (including DONE) in a headline
20282 :tags on the TAGS in a headline
20283 :priority on the priority cookie in a headline
20284 :item on the first line of a plain list item
20285 :item-bullet on the bullet/number of a plain list item
20286 :checkbox on the checkbox in a plain list item
20287 :table in an org-mode table
20288 :table-special on a special filed in a table
20289 :table-table in a table.el table
20290 :clocktable in a clocktable
20291 :src-block in a source block
20292 :link on a hyperlink
20293 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
20294 :target on a <<target>>
20295 :radio-target on a <<<radio-target>>>
20296 :latex-fragment on a LaTeX fragment
20297 :latex-preview on a LaTeX fragment with overlaid preview image
20299 This function expects the position to be visible because it uses font-lock
20300 faces as a help to recognize the following contexts: :table-special, :link,
20301 and :keyword."
20302 (let* ((f (get-text-property (point) 'face))
20303 (faces (if (listp f) f (list f)))
20304 (case-fold-search t)
20305 (p (point)) clist o)
20306 ;; First the large context
20307 (cond
20308 ((org-at-heading-p t)
20309 (push (list :headline (point-at-bol) (point-at-eol)) clist)
20310 (when (progn
20311 (beginning-of-line 1)
20312 (looking-at org-todo-line-tags-regexp))
20313 (push (org-point-in-group p 1 :headline-stars) clist)
20314 (push (org-point-in-group p 2 :todo-keyword) clist)
20315 (push (org-point-in-group p 4 :tags) clist))
20316 (goto-char p)
20319 (push (org-point-in-group p 0 :priority) clist)))
20321 ((org-at-item-p)
20322 (push (org-point-in-group p 2 :item-bullet) clist)
20323 (push (list :item (point-at-bol)
20324 (save-excursion (org-end-of-item) (point)))
20325 clist)
20326 (and (org-at-item-checkbox-p)
20327 (push (org-point-in-group p 0 :checkbox) clist)))
20329 ((org-at-table-p)
20330 (push (list :table (org-table-begin) (org-table-end)) clist)
20331 (if (memq 'org-formula faces)
20332 (push (list :table-special
20333 (previous-single-property-change p 'face)
20334 (next-single-property-change p 'face)) clist)))
20335 ((org-at-table-p 'any)
20336 (push (list :table-table) clist)))
20337 (goto-char p)
20339 (let ((case-fold-search t))
20340 ;; New the "medium" contexts: clocktables, source blocks
20341 (cond ((org-in-clocktable-p)
20342 (push (list :clocktable
20344 (search-backward "#+BEGIN: clocktable" nil t))
20345 (match-beginning 0))
20347 (match-end 0))) clist))
20348 ((org-in-src-block-p)
20349 (push (list :src-block
20351 (search-backward "#+BEGIN_SRC" nil t))
20352 (match-beginning 0))
20353 (and (search-forward "#+END_SRC" nil t)
20354 (match-beginning 0))) clist))))
20355 (goto-char p)
20357 ;; Now the small context
20358 (cond
20359 ((org-at-timestamp-p)
20360 (push (org-point-in-group p 0 :timestamp) clist))
20361 ((memq 'org-link faces)
20362 (push (list :link
20363 (previous-single-property-change p 'face)
20364 (next-single-property-change p 'face)) clist))
20365 ((memq 'org-special-keyword faces)
20366 (push (list :keyword
20367 (previous-single-property-change p 'face)
20368 (next-single-property-change p 'face)) clist))
20369 ((org-at-target-p)
20370 (push (org-point-in-group p 0 :target) clist)
20371 (goto-char (1- (match-beginning 0)))
20372 (if (looking-at org-radio-target-regexp)
20373 (push (org-point-in-group p 0 :radio-target) clist))
20374 (goto-char p))
20375 ((setq o (car (delq nil
20376 (mapcar
20377 (lambda (x)
20378 (if (memq x org-latex-fragment-image-overlays) x))
20379 (overlays-at (point))))))
20380 (push (list :latex-fragment
20381 (overlay-start o) (overlay-end o)) clist)
20382 (push (list :latex-preview
20383 (overlay-start o) (overlay-end o)) clist))
20384 ((org-inside-LaTeX-fragment-p)
20385 ;; FIXME: positions wrong.
20386 (push (list :latex-fragment (point) (point)) clist)))
20388 (setq clist (nreverse (delq nil clist)))
20389 clist))
20391 ;; FIXME: Compare with at-regexp-p Do we need both?
20392 (defun org-in-regexp (re &optional nlines visually)
20393 "Check if point is inside a match of regexp.
20394 Normally only the current line is checked, but you can include NLINES extra
20395 lines both before and after point into the search.
20396 If VISUALLY is set, require that the cursor is not after the match but
20397 really on, so that the block visually is on the match."
20398 (catch 'exit
20399 (let ((pos (point))
20400 (eol (point-at-eol (+ 1 (or nlines 0))))
20401 (inc (if visually 1 0)))
20402 (save-excursion
20403 (beginning-of-line (- 1 (or nlines 0)))
20404 (while (re-search-forward re eol t)
20405 (if (and (<= (match-beginning 0) pos)
20406 (>= (+ inc (match-end 0)) pos))
20407 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
20409 (defun org-at-regexp-p (regexp)
20410 "Is point inside a match of REGEXP in the current line?"
20411 (catch 'exit
20412 (save-excursion
20413 (let ((pos (point)) (end (point-at-eol)))
20414 (beginning-of-line 1)
20415 (while (re-search-forward regexp end t)
20416 (if (and (<= (match-beginning 0) pos)
20417 (>= (match-end 0) pos))
20418 (throw 'exit t)))
20419 nil))))
20421 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
20422 "Non-nil when point is between matches of START-RE and END-RE.
20424 Also return a non-nil value when point is on one of the matches.
20426 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
20427 buffer positions. Default values are the positions of headlines
20428 surrounding the point.
20430 The functions returns a cons cell whose car (resp. cdr) is the
20431 position before START-RE (resp. after END-RE)."
20432 (save-match-data
20433 (let ((pos (point))
20434 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
20435 (limit-down (or lim-down (save-excursion (outline-next-heading))))
20436 beg end)
20437 (save-excursion
20438 ;; Point is on a block when on START-RE or if START-RE can be
20439 ;; found before it...
20440 (and (or (org-at-regexp-p start-re)
20441 (re-search-backward start-re limit-up t))
20442 (setq beg (match-beginning 0))
20443 ;; ... and END-RE after it...
20444 (goto-char (match-end 0))
20445 (re-search-forward end-re limit-down t)
20446 (> (setq end (match-end 0)) pos)
20447 ;; ... without another START-RE in-between.
20448 (goto-char (match-beginning 0))
20449 (not (re-search-backward start-re (1+ beg) t))
20450 ;; Return value.
20451 (cons beg end))))))
20453 (defun org-in-block-p (names)
20454 "Non-nil when point belongs to a block whose name belongs to NAMES.
20456 NAMES is a list of strings containing names of blocks.
20458 Return first block name matched, or nil. Beware that in case of
20459 nested blocks, the returned name may not belong to the closest
20460 block from point."
20461 (save-match-data
20462 (catch 'exit
20463 (let ((case-fold-search t)
20464 (lim-up (save-excursion (outline-previous-heading)))
20465 (lim-down (save-excursion (outline-next-heading))))
20466 (mapc (lambda (name)
20467 (let ((n (regexp-quote name)))
20468 (when (org-between-regexps-p
20471 lim-up lim-down)
20472 (throw 'exit n))))
20473 names))
20474 nil)))
20476 (defun org-occur-in-agenda-files (regexp &optional nlines)
20477 "Call `multi-occur' with buffers for all agenda files."
20479 (let* ((files (org-agenda-files))
20480 (tnames (mapcar 'file-truename files))
20481 (extra org-agenda-text-search-extra-files)
20482 f)
20483 (when (eq (car extra) 'agenda-archives)
20484 (setq extra (cdr extra))
20485 (setq files (org-add-archive-files files)))
20486 (while (setq f (pop extra))
20487 (unless (member (file-truename f) tnames)
20488 (add-to-list 'files f 'append)
20489 (add-to-list 'tnames (file-truename f) 'append)))
20490 (multi-occur
20491 (mapcar (lambda (x)
20492 (with-current-buffer
20493 (or (get-file-buffer x) (find-file-noselect x))
20494 (widen)
20495 (current-buffer)))
20496 files)
20497 regexp)))
20499 (if (boundp 'occur-mode-find-occurrence-hook)
20500 ;; Emacs 23
20501 (add-hook 'occur-mode-find-occurrence-hook
20502 (lambda ()
20503 (when (derived-mode-p 'org-mode)
20504 (org-reveal))))
20505 ;; Emacs 22
20506 (defadvice occur-mode-goto-occurrence
20507 (after org-occur-reveal activate)
20508 (and (derived-mode-p 'org-mode) (org-reveal)))
20509 (defadvice occur-mode-goto-occurrence-other-window
20510 (after org-occur-reveal activate)
20511 (and (derived-mode-p 'org-mode) (org-reveal)))
20512 (defadvice occur-mode-display-occurrence
20513 (after org-occur-reveal activate)
20514 (when (derived-mode-p 'org-mode)
20515 (let ((pos (occur-mode-find-occurrence)))
20516 (with-current-buffer (marker-buffer pos)
20517 (save-excursion
20518 (goto-char pos)
20519 (org-reveal)))))))
20521 (defun org-occur-link-in-agenda-files ()
20522 "Create a link and search for it in the agendas.
20523 The link is not stored in `org-stored-links', it is just created
20524 for the search purpose."
20525 (interactive)
20526 (let ((link (condition-case nil
20527 (org-store-link nil)
20528 (error "Unable to create a link to here"))))
20529 (org-occur-in-agenda-files (regexp-quote link))))
20531 (defun org-uniquify (list)
20532 "Remove duplicate elements from LIST."
20533 (let (res)
20534 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
20535 res))
20537 (defun org-delete-all (elts list)
20538 "Remove all elements in ELTS from LIST."
20539 (while elts
20540 (setq list (delete (pop elts) list)))
20541 list)
20543 (defun org-count (cl-item cl-seq)
20544 "Count the number of occurrences of ITEM in SEQ.
20545 Taken from `count' in cl-seq.el with all keyword arguments removed."
20546 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
20547 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
20548 (while (< cl-start cl-end)
20549 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
20550 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
20551 (setq cl-start (1+ cl-start)))
20552 cl-count))
20554 (defun org-remove-if (predicate seq)
20555 "Remove everything from SEQ that fulfills PREDICATE."
20556 (let (res e)
20557 (while seq
20558 (setq e (pop seq))
20559 (if (not (funcall predicate e)) (push e res)))
20560 (nreverse res)))
20562 (defun org-remove-if-not (predicate seq)
20563 "Remove everything from SEQ that does not fulfill PREDICATE."
20564 (let (res e)
20565 (while seq
20566 (setq e (pop seq))
20567 (if (funcall predicate e) (push e res)))
20568 (nreverse res)))
20570 (defun org-reduce (cl-func cl-seq &rest cl-keys)
20571 "Reduce two-argument FUNCTION across SEQ.
20572 Taken from `reduce' in cl-seq.el with all keyword arguments but
20574 (let ((cl-accum (cond ((memq :initial-value cl-keys)
20575 (cadr (memq :initial-value cl-keys)))
20576 (cl-seq (pop cl-seq))
20577 (t (funcall cl-func)))))
20578 (while cl-seq
20579 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
20580 cl-accum))
20582 (defun org-back-over-empty-lines ()
20583 "Move backwards over whitespace, to the beginning of the first empty line.
20584 Returns the number of empty lines passed."
20585 (let ((pos (point)))
20586 (if (cdr (assoc 'heading org-blank-before-new-entry))
20588 (unless (eobp)
20589 (forward-line -1)))
20590 (beginning-of-line 2)
20591 (goto-char (min (point) pos))
20592 (count-lines (point) pos)))
20594 (defun org-skip-whitespace ()
20597 (defun org-point-in-group (point group &optional context)
20598 "Check if POINT is in match-group GROUP.
20599 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
20600 match. If the match group does not exist or point is not inside it,
20601 return nil."
20602 (and (match-beginning group)
20603 (>= point (match-beginning group))
20604 (<= point (match-end group))
20605 (if context
20606 (list context (match-beginning group) (match-end group))
20607 t)))
20609 (defun org-switch-to-buffer-other-window (&rest args)
20610 "Switch to buffer in a second window on the current frame.
20611 In particular, do not allow pop-up frames.
20612 Returns the newly created buffer."
20613 (org-no-popups
20614 (apply 'switch-to-buffer-other-window args)))
20616 (defun org-combine-plists (&rest plists)
20617 "Create a single property list from all plists in PLISTS.
20618 The process starts by copying the first list, and then setting properties
20619 from the other lists. Settings in the last list are the most significant
20620 ones and overrule settings in the other lists."
20621 (let ((rtn (copy-sequence (pop plists)))
20622 p v ls)
20623 (while plists
20624 (setq ls (pop plists))
20625 (while ls
20626 (setq p (pop ls) v (pop ls))
20627 (setq rtn (plist-put rtn p v))))
20628 rtn))
20630 (defun org-replace-escapes (string table)
20631 "Replace %-escapes in STRING with values in TABLE.
20633 The sequences in STRING may contain normal field width and padding information,
20635 so values can contain further %-escapes if they are define later in TABLE."
20636 (let ((tbl (copy-alist table))
20637 (case-fold-search nil)
20638 (pchg 0)
20639 e re rpl)
20640 (while (setq e (pop tbl))
20641 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20642 (when (and (cdr e) (string-match re (cdr e)))
20643 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20644 (safe "SREF"))
20645 (add-text-properties 0 3 (list 'sref sref) safe)
20646 (setcdr e (replace-match safe t t (cdr e)))))
20647 (while (string-match re string)
20648 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20649 (cdr e)))
20650 (setq string (replace-match rpl t t string))))
20651 (while (setq pchg (next-property-change pchg string))
20652 (let ((sref (get-text-property pchg 'sref string)))
20653 (when (and sref (string-match "SREF" string pchg))
20654 (setq string (replace-match sref t t string)))))
20655 string))
20657 (defun org-sublist (list start end)
20658 "Return a section of LIST, from START to END.
20659 Counting starts at 1."
20660 (let (rtn (c start))
20661 (setq list (nthcdr (1- start) list))
20662 (while (and list (<= c end))
20663 (push (pop list) rtn)
20664 (setq c (1+ c)))
20665 (nreverse rtn)))
20667 (defun org-find-base-buffer-visiting (file)
20668 "Like `find-buffer-visiting' but always return the base buffer and
20669 not an indirect buffer."
20670 (let ((buf (or (get-file-buffer file)
20671 (find-buffer-visiting file))))
20672 (if buf
20673 (or (buffer-base-buffer buf) buf)
20674 nil)))
20676 (defun org-image-file-name-regexp (&optional extensions)
20677 "Return regexp matching the file names of images.
20678 If EXTENSIONS is given, only match these."
20679 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20680 (image-file-name-regexp)
20681 (let ((image-file-name-extensions
20682 (or extensions
20683 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20684 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20686 (regexp-opt (nconc (mapcar 'upcase
20687 image-file-name-extensions)
20688 image-file-name-extensions)
20689 t)
20692 (defun org-file-image-p (file &optional extensions)
20693 "Return non-nil if FILE is an image."
20694 (save-match-data
20695 (string-match (org-image-file-name-regexp extensions) file)))
20697 (defun org-get-cursor-date ()
20698 "Return the date at cursor in as a time.
20699 This works in the calendar and in the agenda, anywhere else it just
20700 returns the current time."
20701 (let (date day defd)
20702 (cond
20703 ((eq major-mode 'calendar-mode)
20704 (setq date (calendar-cursor-to-date)
20705 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20706 ((eq major-mode 'org-agenda-mode)
20707 (setq day (get-text-property (point) 'day))
20708 (if day
20709 (setq date (calendar-gregorian-from-absolute day)
20710 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20711 (nth 2 date))))))
20712 (or defd (current-time))))
20714 (defun org-mark-subtree (&optional up)
20715 "Mark the current subtree.
20716 This puts point at the start of the current subtree, and mark at
20717 the end. If a numeric prefix UP is given, move up into the
20718 hierarchy of headlines by UP levels before marking the subtree."
20719 (interactive "P")
20720 (org-with-limited-levels
20721 (cond ((org-at-heading-p) (beginning-of-line))
20722 ((org-before-first-heading-p) (error "Not in a subtree"))
20723 (t (outline-previous-visible-heading 1))))
20724 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
20725 (if (org-called-interactively-p 'any)
20726 (call-interactively 'org-mark-element)
20727 (org-mark-element)))
20729 ;;; Indentation
20731 (defun org-indent-line ()
20732 "Indent line depending on context."
20733 (interactive)
20734 (let* ((pos (point))
20735 (itemp (org-at-item-p))
20736 (case-fold-search t)
20738 (inline-task-p (and (featurep 'org-inlinetask)
20739 (org-inlinetask-in-task-p)))
20740 (inline-re (and inline-task-p
20741 (org-inlinetask-outline-regexp)))
20742 column)
20743 (if (and orgstruct-is-++ (eq pos (point)))
20744 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
20745 (indent-according-to-mode))
20746 (beginning-of-line 1)
20747 (cond
20748 ;; Headings
20749 ((looking-at org-outline-regexp) (setq column 0))
20750 ;; Included files
20752 ;; Footnote definition
20753 ((looking-at org-footnote-definition-re) (setq column 0))
20754 ;; Literal examples
20756 (setq column (org-get-indentation))) ; do nothing
20757 ;; Lists
20758 ((ignore-errors (goto-char (org-in-item-p)))
20759 (setq column (if itemp
20760 (org-get-indentation)
20761 (org-list-item-body-column (point))))
20762 (goto-char pos))
20763 ;; Drawers
20765 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20766 (save-excursion
20767 (goto-char (1- (match-beginning 1)))
20768 (setq column (current-column))))
20769 ;; Special blocks
20771 (save-excursion
20772 (re-search-backward
20774 (setq column (org-get-indentation (match-string 0))))
20777 (save-excursion
20779 (setq column
20780 (cond ((equal (downcase (match-string 1)) "src")
20781 ;; src blocks: let `org-edit-src-exit' handle them
20782 (org-get-indentation))
20783 ((equal (downcase (match-string 1)) "example")
20784 (max (org-get-indentation)
20785 (org-get-indentation (match-string 0))))
20786 (t
20787 (org-get-indentation (match-string 0))))))
20788 ;; This line has nothing special, look at the previous relevant
20789 ;; line to compute indentation
20790 (t
20791 (beginning-of-line 0)
20792 (while (and (not (bobp))
20793 (not (looking-at org-drawer-regexp))
20794 ;; When point started in an inline task, do not move
20795 ;; above task starting line.
20796 (not (and inline-task-p (looking-at inline-re)))
20797 ;; Skip drawers, blocks, empty lines, verbatim,
20798 ;; comments, tables, footnotes definitions, lists,
20799 ;; inline tasks.
20801 (re-search-backward org-drawer-regexp nil t))
20805 (looking-at org-footnote-definition-re)
20806 (and (ignore-errors (goto-char (org-in-item-p)))
20807 (goto-char
20808 (org-list-get-top-point (org-list-struct))))
20809 (and (not inline-task-p)
20810 (featurep 'org-inlinetask)
20811 (org-inlinetask-in-task-p)
20812 (or (org-inlinetask-goto-beginning) t))))
20813 (beginning-of-line 0))
20814 (cond
20815 ;; There was an heading above.
20817 (if (not org-adapt-indentation)
20818 (setq column 0)
20819 (goto-char (match-end 0))
20820 (setq column (current-column))))
20821 ;; A drawer had started and is unfinished
20822 ((looking-at org-drawer-regexp)
20823 (goto-char (1- (match-beginning 1)))
20824 (setq column (current-column)))
20825 ;; Else, nothing noticeable found: get indentation and go on.
20826 (t (setq column (org-get-indentation))))))
20827 ;; Now apply indentation and move cursor accordingly
20828 (goto-char pos)
20829 (if (<= (current-column) (current-indentation))
20830 (org-indent-line-to column)
20831 (save-excursion (org-indent-line-to column)))
20832 ;; Special polishing for properties, see `org-property-format'
20833 (setq column (current-column))
20834 (beginning-of-line 1)
20835 (if (looking-at
20837 (replace-match (concat (match-string 1)
20838 (format org-property-format
20839 (match-string 2) (match-string 3)))
20840 t t))
20841 (org-move-to-column column))))
20843 (defun org-indent-drawer ()
20844 "Indent the drawer at point."
20845 (interactive)
20846 (let ((p (point))
20847 (e (and (save-excursion (re-search-forward ":END:" nil t))
20848 (match-end 0)))
20849 (folded
20850 (save-excursion
20851 (end-of-line)
20852 (when (overlays-at (point))
20853 (member 'invisible (overlay-properties
20854 (car (overlays-at (point)))))))))
20855 (when folded (org-cycle))
20856 (indent-for-tab-command)
20857 (while (and (move-beginning-of-line 2) (< (point) e))
20858 (indent-for-tab-command))
20859 (goto-char p)
20860 (when folded (org-cycle)))
20861 (message "Drawer at point indented"))
20863 (defun org-indent-block ()
20864 "Indent the block at point."
20865 (interactive)
20866 (let ((p (point))
20867 (case-fold-search t)
20869 (match-end 0)))
20870 (folded
20871 (save-excursion
20872 (end-of-line)
20873 (when (overlays-at (point))
20874 (member 'invisible (overlay-properties
20875 (car (overlays-at (point)))))))))
20876 (when folded (org-cycle))
20877 (indent-for-tab-command)
20878 (while (and (move-beginning-of-line 2) (< (point) e))
20879 (indent-for-tab-command))
20880 (goto-char p)
20881 (when folded (org-cycle)))
20882 (message "Block at point indented"))
20884 (defun org-indent-region (start end)
20885 "Indent region."
20886 (interactive "r")
20887 (save-excursion
20888 (let ((line-end (org-current-line end)))
20889 (goto-char start)
20890 (while (< (org-current-line) line-end)
20891 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
20892 (t (call-interactively 'org-indent-line)))
20893 (move-beginning-of-line 2)))))
20896 ;;; Filling
20898 ;; We use our own fill-paragraph and auto-fill functions.
20900 ;; `org-fill-paragraph' relies on adaptive filling and context
20901 ;; checking. Appropriate `fill-prefix' is computed with
20902 ;; `org-adaptive-fill-function'.
20904 ;; `org-auto-fill-function' takes care of auto-filling. It calls
20905 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
20906 ;; `org-adaptive-fill-function' value. Internally,
20907 ;; `org-comment-line-break-function' breaks the line.
20909 ;; `org-setup-filling' installs filling and auto-filling related
20910 ;; variables during `org-mode' initialization.
20912 (defun org-setup-filling ()
20913 (interactive)
20914 ;; Prevent auto-fill from inserting unwanted new items.
20915 (when (boundp 'fill-nobreak-predicate)
20916 (org-set-local
20917 'fill-nobreak-predicate
20918 (org-uniquify
20919 (append fill-nobreak-predicate
20920 '(org-fill-paragraph-separate-nobreak-p
20921 org-fill-line-break-nobreak-p)))))
20922 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20923 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
20924 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20925 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
20927 (defvar org-element-paragraph-separate) ; org-element.el
20928 (defun org-fill-paragraph-separate-nobreak-p ()
20929 "Non-nil when a line break at point would insert a new item."
20930 (looking-at (substring org-element-paragraph-separate 1)))
20932 (defun org-fill-line-break-nobreak-p ()
20933 "Non-nil when a line break at point would create an Org line break."
20934 (save-excursion
20939 (declare-function message-in-body-p "message" ())
20940 (defvar org-element--affiliated-re) ; From org-element.el
20941 (defun org-adaptive-fill-function ()
20942 "Compute a fill prefix for the current line.
20943 Return fill prefix, as a string, or nil if current line isn't
20944 meant to be filled."
20945 (org-with-wide-buffer
20946 (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
20947 ;; FIXME: This is really the job of orgstruct++-mode
20948 (let* ((p (line-beginning-position))
20949 (element (save-excursion (beginning-of-line)
20950 (org-element-at-point)))
20951 (type (org-element-type element))
20952 (post-affiliated
20953 (save-excursion
20954 (goto-char (org-element-property :begin element))
20955 (while (looking-at org-element--affiliated-re) (forward-line))
20956 (point))))
20957 (unless (< p post-affiliated)
20958 (case type
20960 (footnote-definition "")
20961 ((item plain-list)
20962 (make-string (org-list-item-body-column post-affiliated) ? ))
20963 (paragraph
20964 ;; Fill prefix is usually the same as the current line,
20965 ;; except if the paragraph is at the beginning of an item.
20966 (let ((parent (org-element-property :parent element)))
20967 (cond ((eq (org-element-type parent) 'item)
20968 (make-string (org-list-item-body-column
20969 (org-element-property :begin parent))
20970 ? ))
20972 (match-string 0))
20973 (t ""))))
20974 (comment-block
20975 ;; Only fill contents if P is within block boundaries.
20976 (let* ((cbeg (save-excursion (goto-char post-affiliated)
20977 (forward-line)
20978 (point)))
20979 (cend (save-excursion
20980 (goto-char (org-element-property :end element))
20982 (line-beginning-position))))
20983 (when (and (>= p cbeg) (< p cend))
20985 (match-string 0)
20986 ""))))))))))
20988 (declare-function message-goto-body "message" ())
20989 (defvar message-cite-prefix-regexp) ; From message.el
20990 (defvar org-element-all-objects) ; From org-element.el
20991 (defun org-fill-paragraph (&optional justify)
20992 "Fill element at point, when applicable.
20994 This function only applies to comment blocks, comments, example
20995 blocks and paragraphs. Also, as a special case, re-align table
20996 when point is at one.
20998 If JUSTIFY is non-nil (interactively, with prefix argument),
20999 justify as well. If `sentence-end-double-space' is non-nil, then
21000 period followed by one space does not end a sentence, so don't
21001 break a line there. The variable `fill-column' controls the
21002 width for filling.
21004 For convenience, when point is at a plain list, an item or
21005 a footnote definition, try to fill the first paragraph within."
21006 (interactive)
21007 (if (and (derived-mode-p 'message-mode)
21008 (or (not (message-in-body-p))
21009 (save-excursion (move-beginning-of-line 1)
21010 (looking-at message-cite-prefix-regexp))))
21011 ;; First ensure filling is correct in message-mode.
21012 (let ((fill-paragraph-function
21013 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
21014 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
21015 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
21016 (paragraph-separate
21017 (cadadr (assoc 'paragraph-separate org-fb-vars))))
21018 (fill-paragraph nil))
21019 (save-excursion
21020 ;; Move to end of line in order to get the first paragraph
21021 ;; within a plain list or a footnote definition.
21022 (end-of-line)
21023 (let ((element (org-element-at-point)))
21024 ;; First check if point is in a blank line at the beginning of
21025 ;; the buffer. In that case, ignore filling.
21026 (if (< (point) (org-element-property :begin element)) t
21027 (case (org-element-type element)
21028 ;; Use major mode filling function is src blocks.
21029 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
21030 ;; Align Org tables, leave table.el tables as-is.
21031 (table-row (org-table-align) t)
21032 (table
21033 (when (eq (org-element-property :type element) 'org)
21034 (org-table-align))
21035 t)
21036 (paragraph
21037 ;; Paragraphs may contain `line-break' type objects.
21038 (let ((beg (max (point-min)
21039 (org-element-property :contents-begin element)))
21040 (end (min (point-max)
21041 (org-element-property :contents-end element))))
21042 ;; Do nothing if point is at an affiliated keyword.
21043 (if (< (point) beg) t
21044 (when (derived-mode-p 'message-mode)
21045 ;; In `message-mode', do not fill following
21046 ;; citation in current paragraph nor text before
21047 ;; message body.
21048 (let ((body-start (save-excursion (message-goto-body))))
21049 (when body-start (setq beg (max body-start beg))))
21050 (when (save-excursion
21051 (re-search-forward
21052 (concat "^" message-cite-prefix-regexp) end t))
21053 (setq end (match-beginning 0))))
21054 ;; Fill paragraph, taking line breaks into
21055 ;; consideration. For that, slice the paragraph
21056 ;; using line breaks as separators, and fill the
21057 ;; parts in reverse order to avoid messing with
21058 ;; markers.
21059 (save-excursion
21060 (goto-char end)
21061 (mapc
21062 (lambda (pos)
21063 (fill-region-as-paragraph pos (point) justify)
21064 (goto-char pos))
21065 ;; Find the list of ending positions for line
21066 ;; breaks in the current paragraph. Add paragraph
21067 ;; beginning to include first slice.
21068 (nreverse
21069 (cons
21070 beg
21071 (org-element-map
21072 (org-element--parse-objects
21073 beg end nil org-element-all-objects)
21074 'line-break
21075 (lambda (lb) (org-element-property :end lb)))))))
21076 t)))
21077 ;; Contents of `comment-block' type elements should be
21078 ;; filled as plain text, but only if point is within block
21079 ;; markers.
21080 (comment-block
21081 (let* ((case-fold-search t)
21082 (beg (save-excursion
21083 (goto-char (org-element-property :begin element))
21085 (forward-line)
21086 (point)))
21087 (end (save-excursion
21088 (goto-char (org-element-property :end element))
21090 (line-beginning-position))))
21091 (when (and (>= (point) beg) (< (point) end))
21092 (fill-region-as-paragraph
21093 (save-excursion
21094 (end-of-line)
21096 (line-beginning-position))
21097 (save-excursion
21098 (beginning-of-line)
21100 (line-beginning-position))
21101 justify)))
21102 t)
21103 ;; Fill comments.
21104 (comment (fill-comment-paragraph justify))
21105 ;; Ignore every other element.
21106 (otherwise t)))))))
21108 (defun org-auto-fill-function ()
21109 "Auto-fill function."
21110 ;; Check if auto-filling is meaningful.
21111 (let ((fc (current-fill-column)))
21112 (when (and fc (> (current-column) fc))
21113 (let* ((fill-prefix (org-adaptive-fill-function))
21114 ;; Enforce empty fill prefix, if required. Otherwise, it
21115 ;; will be computed again.
21116 (adaptive-fill-mode (not (equal fill-prefix ""))))
21117 (when fill-prefix (do-auto-fill))))))
21119 (defun org-comment-line-break-function (&optional soft)
21120 "Break line at point and indent, continuing comment if within one.
21121 The inserted newline is marked hard if variable
21122 `use-hard-newlines' is true, unless optional argument SOFT is
21123 non-nil."
21125 (save-excursion (forward-char -1) (delete-horizontal-space))
21126 (delete-horizontal-space)
21127 (indent-to-left-margin)
21128 (insert-before-markers-and-inherit fill-prefix))
21131 ;;; Comments
21133 ;; Org comments syntax is quite complex. It requires the entire line
21134 ;; to be just a comment. Also, even with the right syntax at the
21135 ;; beginning of line, some some elements (i.e. verse-block or
21136 ;; example-block) don't accept comments. Usual Emacs comment commands
21137 ;; cannot cope with those requirements. Therefore, Org replaces them.
21139 ;; Org still relies on `comment-dwim', but cannot trust
21140 ;; `comment-only-p'. So, `comment-region-function' and
21141 ;; `uncomment-region-function' both point
21142 ;; to`org-comment-or-uncomment-region'. Eventually,
21143 ;; `org-insert-comment' takes care of insertion of comments at the
21144 ;; beginning of line.
21146 ;; `org-setup-comments-handling' install comments related variables
21147 ;; during `org-mode' initialization.
21149 (defun org-setup-comments-handling ()
21150 (interactive)
21151 (org-set-local 'comment-use-syntax nil)
21152 (org-set-local 'comment-start "# ")
21154 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
21155 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
21156 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
21158 (defun org-insert-comment ()
21159 "Insert an empty comment above current line.
21160 If the line is empty, insert comment at its beginning."
21161 (beginning-of-line)
21163 (org-indent-line)
21164 (insert "# "))
21166 (defvar comment-empty-lines) ; From newcomment.el.
21167 (defun org-comment-or-uncomment-region (beg end &rest ignore)
21168 "Comment or uncomment each non-blank line in the region.
21169 Uncomment each non-blank line between BEG and END if it only
21170 contains commented lines. Otherwise, comment them."
21171 (save-restriction
21172 ;; Restrict region
21173 (narrow-to-region (save-excursion (goto-char beg)
21175 (line-beginning-position))
21176 (save-excursion (goto-char end)
21178 (line-end-position)))
21179 (let ((uncommentp
21180 ;; UNCOMMENTP is non-nil when every non blank line between
21181 ;; BEG and END is a comment.
21182 (save-excursion
21183 (goto-char (point-min))
21184 (while (and (not (eobp))
21185 (let ((element (org-element-at-point)))
21186 (and (eq (org-element-type element) 'comment)
21187 (goto-char (min (point-max)
21188 (org-element-property
21189 :end element)))))))
21190 (eobp))))
21191 (if uncommentp
21192 ;; Only blank lines and comments in region: uncomment it.
21193 (save-excursion
21194 (goto-char (point-min))
21195 (while (not (eobp))
21197 (replace-match "" nil nil nil 1))
21198 (forward-line)))
21199 ;; Comment each line in region.
21200 (let ((min-indent (point-max)))
21201 ;; First find the minimum indentation across all lines.
21202 (save-excursion
21203 (goto-char (point-min))
21204 (while (and (not (eobp)) (not (zerop min-indent)))
21206 (setq min-indent (min min-indent (current-indentation))))
21207 (forward-line)))
21208 ;; Then loop over all lines.
21209 (save-excursion
21210 (goto-char (point-min))
21211 (while (not (eobp))
21213 (org-move-to-column min-indent t)
21214 (insert comment-start))
21215 (forward-line))))))))
21218 ;;; Other stuff.
21220 (defun org-toggle-fixed-width-section (arg)
21221 "Toggle the fixed-width export.
21222 If there is no active region, the QUOTE keyword at the current headline is
21223 inserted or removed. When present, it causes the text between this headline
21224 and the next to be exported as fixed-width text, and unmodified.
21225 If there is an active region, this command adds or removes a colon as the
21226 first character of this line. If the first character of a line is a colon,
21227 this line is also exported in fixed-width font."
21228 (interactive "P")
21229 (let* ((cc 0)
21230 (regionp (org-region-active-p))
21231 (beg (if regionp (region-beginning) (point)))
21232 (end (if regionp (region-end)))
21233 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
21234 (case-fold-search nil)
21236 off)
21237 (if regionp
21238 (save-excursion
21239 (goto-char beg)
21240 (setq cc (current-column))
21241 (beginning-of-line 1)
21242 (setq off (looking-at re))
21243 (while (> nlines 0)
21244 (setq nlines (1- nlines))
21245 (beginning-of-line 1)
21246 (cond
21247 (arg
21248 (org-move-to-column cc t)
21250 (forward-line -1))
21251 ((and off (looking-at re))
21252 (replace-match "" t t nil 1))
21253 ((not off) (org-move-to-column cc t) (insert ": ")))
21254 (forward-line 1)))
21255 (save-excursion
21256 (org-back-to-heading)
21257 (cond
21258 ((looking-at (format org-heading-keyword-regexp-format
21259 org-quote-string))
21260 (goto-char (match-end 1))
21261 (looking-at (concat " +" org-quote-string))
21262 (replace-match "" t t)
21263 (when (eolp) (insert " ")))
21264 ((looking-at org-outline-regexp)
21265 (goto-char (match-end 0))
21266 (insert org-quote-string " ")))))))
21268 (defun org-reftex-citation ()
21269 "Use reftex-citation to insert a citation into the buffer.
21270 This looks for a line like
21272 #+BIBLIOGRAPHY: foo plain option:-d
21274 and derives from it that foo.bib is the bibliography file relevant
21275 for this document. It then installs the necessary environment for RefTeX
21276 to work in this buffer and calls `reftex-citation' to insert a citation
21277 into the buffer.
21279 Export of such citations to both LaTeX and HTML is handled by the contributed
21280 package org-exp-bibtex by Taru Karttunen."
21281 (interactive)
21282 (let ((reftex-docstruct-symbol 'rds)
21284 rds bib)
21285 (save-excursion
21286 (save-restriction
21287 (widen)
21288 (let ((case-fold-search t)
21290 (if (not (save-excursion
21291 (or (re-search-forward re nil t)
21292 (re-search-backward re nil t))))
21293 (error "No bibliography defined in file")
21294 (setq bib (concat (match-string 1) ".bib")
21295 rds (list (list 'bib bib)))))))
21296 (call-interactively 'reftex-citation)))
21298 ;;;; Functions extending outline functionality
21300 (defun org-beginning-of-line (&optional arg)
21301 "Go to the beginning of the current line. If that is invisible, continue
21302 to a visible line beginning. This makes the function of C-a more intuitive.
21303 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
21304 first attempt, and only move to after the tags when the cursor is already
21305 beyond the end of the headline."
21306 (interactive "P")
21307 (let ((pos (point))
21308 (special (if (consp org-special-ctrl-a/e)
21309 (car org-special-ctrl-a/e)
21310 org-special-ctrl-a/e))
21311 refpos)
21312 (if (org-bound-and-true-p visual-line-mode)
21313 (beginning-of-visual-line 1)
21314 (beginning-of-line 1))
21315 (if (and arg (fboundp 'move-beginning-of-line))
21316 (call-interactively 'move-beginning-of-line)
21317 (if (bobp)
21318 nil
21319 (backward-char 1)
21320 (if (org-truely-invisible-p)
21321 (while (and (not (bobp)) (org-truely-invisible-p))
21322 (backward-char 1)
21323 (beginning-of-line 1))
21324 (forward-char 1))))
21325 (when special
21326 (cond
21327 ((and (looking-at org-complex-heading-regexp)
21328 (= (char-after (match-end 1)) ?\ ))
21329 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
21330 (point-at-eol)))
21331 (goto-char
21332 (if (eq special t)
21333 (cond ((> pos refpos) refpos)
21334 ((= pos (point)) refpos)
21335 (t (point)))
21336 (cond ((> pos (point)) (point))
21337 ((not (eq last-command this-command)) (point))
21338 (t refpos)))))
21339 ((org-at-item-p)
21340 ;; Being at an item and not looking at an the item means point
21341 ;; was previously moved to beginning of a visual line, which
21342 ;; doesn't contain the item. Therefore, do nothing special,
21343 ;; just stay here.
21344 (when (looking-at org-list-full-item-re)
21345 ;; Set special position at first white space character after
21346 ;; bullet, and check-box, if any.
21347 (let ((after-bullet
21348 (let ((box (match-end 3)))
21349 (if (not box) (match-end 1)
21350 (let ((after (char-after box)))
21351 (if (and after (= after ? )) (1+ box) box))))))
21352 ;; Special case: Move point to special position when
21353 ;; currently after it or at beginning of line.
21354 (if (eq special t)
21355 (when (or (> pos after-bullet) (= (point) pos))
21356 (goto-char after-bullet))
21357 ;; Reversed case: Move point to special position when
21358 ;; point was already at beginning of line and command is
21359 ;; repeated.
21360 (when (and (= (point) pos) (eq last-command this-command))
21361 (goto-char after-bullet))))))))
21362 (org-no-warnings
21363 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21365 (defun org-end-of-line (&optional arg)
21366 "Go to the end of the line.
21367 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
21368 tags on the first attempt, and only move to after the tags when
21369 the cursor is already beyond the end of the headline."
21370 (interactive "P")
21371 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
21372 org-special-ctrl-a/e))
21373 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
21374 'end-of-visual-line)
21375 ((fboundp 'move-end-of-line) 'move-end-of-line)
21376 (t 'end-of-line))))
21377 (if (or (not special) arg) (call-interactively move-fun)
21378 (let* ((element (save-excursion (beginning-of-line)
21379 (org-element-at-point)))
21380 (type (org-element-type element)))
21381 (cond
21382 ((memq type '(headline inlinetask))
21383 (let ((pos (point)))
21384 (beginning-of-line 1)
21386 (if (eq special t)
21387 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
21388 (goto-char (match-beginning 1))
21389 (goto-char (match-end 0)))
21390 (if (or (< pos (match-end 0))
21391 (not (eq this-command last-command)))
21392 (goto-char (match-end 0))
21393 (goto-char (match-beginning 1))))
21394 (call-interactively move-fun))))
21395 ((org-element-property :hiddenp element)
21396 ;; If element is hidden, `move-end-of-line' would put point
21397 ;; after it. Use `end-of-line' to stay on current line.
21398 (call-interactively 'end-of-line))
21399 (t (call-interactively move-fun)))))
21400 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21402 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
21403 (define-key org-mode-map "\C-e" 'org-end-of-line)
21405 (defun org-backward-sentence (&optional arg)
21406 "Go to beginning of sentence, or beginning of table field.
21407 This will call `backward-sentence' or `org-table-beginning-of-field',
21408 depending on context."
21409 (interactive "P")
21410 (cond
21411 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
21412 (t (call-interactively 'backward-sentence))))
21414 (defun org-forward-sentence (&optional arg)
21415 "Go to end of sentence, or end of table field.
21416 This will call `forward-sentence' or `org-table-end-of-field',
21417 depending on context."
21418 (interactive "P")
21419 (cond
21420 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
21421 (t (call-interactively 'forward-sentence))))
21423 (define-key org-mode-map "\M-a" 'org-backward-sentence)
21424 (define-key org-mode-map "\M-e" 'org-forward-sentence)
21426 (defun org-kill-line (&optional arg)
21427 "Kill line, to tags or end of line."
21428 (interactive "P")
21429 (cond
21430 ((or (not org-special-ctrl-k)
21431 (bolp)
21432 (not (org-at-heading-p)))
21433 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
21434 org-ctrl-k-protect-subtree)
21435 (if (or (eq org-ctrl-k-protect-subtree 'error)
21436 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
21437 (error "C-k aborted - would kill hidden subtree")))
21438 (call-interactively
21439 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
21441 (kill-region (point) (match-beginning 1))
21442 (org-set-tags nil t))
21443 (t (kill-region (point) (point-at-eol)))))
21445 (define-key org-mode-map "\C-k" 'org-kill-line)
21447 (defun org-yank (&optional arg)
21448 "Yank. If the kill is a subtree, treat it specially.
21449 This command will look at the current kill and check if is a single
21450 subtree, or a series of subtrees[1]. If it passes the test, and if the
21451 cursor is at the beginning of a line or after the stars of a currently
21452 empty headline, then the yank is handled specially. How exactly depends
21453 on the value of the following variables, both set by default.
21455 org-yank-folded-subtrees
21456 When set, the subtree(s) will be folded after insertion, but only
21457 if doing so would now swallow text after the yanked text.
21459 org-yank-adjusted-subtrees
21460 When set, the subtree will be promoted or demoted in order to
21461 fit into the local outline tree structure, which means that the level
21462 will be adjusted so that it becomes the smaller one of the two
21463 *visible* surrounding headings.
21465 Any prefix to this command will cause `yank' to be called directly with
21467 will just
21468 plainly yank the text as it is.
21470 \[1] The test checks if the first non-white line is a heading
21471 and if there are no other headings with fewer stars."
21472 (interactive "P")
21473 (org-yank-generic 'yank arg))
21475 (defun org-yank-generic (command arg)
21476 "Perform some yank-like command.
21478 This function implements the behavior described in the `org-yank'
21479 documentation. However, it has been generalized to work for any
21480 interactive command with similar behavior."
21482 ;; pretend to be command COMMAND
21483 (setq this-command command)
21485 (if arg
21486 (call-interactively command)
21488 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
21489 (and (org-kill-is-subtree-p)
21490 (or (bolp)
21492 (string-match
21494 (buffer-substring (point-at-bol) (point)))))))
21495 swallowp)
21496 (cond
21497 ((and subtreep org-yank-folded-subtrees)
21498 (let ((beg (point))
21499 end)
21500 (if (and subtreep org-yank-adjusted-subtrees)
21501 (org-paste-subtree nil nil 'for-yank)
21502 (call-interactively command))
21504 (setq end (point))
21505 (goto-char beg)
21506 (when (and (bolp) subtreep
21507 (not (setq swallowp
21508 (org-yank-folding-would-swallow-text beg end))))
21509 (org-with-limited-levels
21510 (or (looking-at org-outline-regexp)
21511 (re-search-forward org-outline-regexp-bol end t))
21512 (while (and (< (point) end) (looking-at org-outline-regexp))
21513 (hide-subtree)
21514 (org-cycle-show-empty-lines 'folded)
21515 (condition-case nil
21516 (outline-forward-same-level 1)
21517 (error (goto-char end))))))
21518 (when swallowp
21519 (message
21520 "Inserted text not folded because that would swallow text"))
21522 (goto-char end)
21524 (beginning-of-line 1)
21525 (push-mark beg 'nomsg)))
21526 ((and subtreep org-yank-adjusted-subtrees)
21527 (let ((beg (point-at-bol)))
21528 (org-paste-subtree nil nil 'for-yank)
21529 (push-mark beg 'nomsg)))
21530 (t
21531 (call-interactively command))))))
21533 (defun org-yank-folding-would-swallow-text (beg end)
21534 "Would hide-subtree at BEG swallow any text after END?"
21535 (let (level)
21536 (org-with-limited-levels
21537 (save-excursion
21538 (goto-char beg)
21539 (when (or (looking-at org-outline-regexp)
21540 (re-search-forward org-outline-regexp-bol end t))
21541 (setq level (org-outline-level)))
21542 (goto-char end)
21544 (if (or (eobp)
21545 (and (bolp) (looking-at org-outline-regexp)
21546 (<= (org-outline-level) level)))
21547 nil ; Nothing would be swallowed
21548 t))))) ; something would swallow
21550 (define-key org-mode-map "\C-y" 'org-yank)
21552 (defun org-truely-invisible-p ()
21553 "Check if point is at a character currently not visible.
21554 This version does not only check the character property, but also
21555 `visible-mode'."
21556 ;; Early versions of noutline don't have `outline-invisible-p'.
21557 (if (org-bound-and-true-p visible-mode)
21558 nil
21559 (outline-invisible-p)))
21561 (defun org-invisible-p2 ()
21562 "Check if point is at a character currently not visible."
21563 (save-excursion
21564 (if (and (eolp) (not (bobp))) (backward-char 1))
21565 ;; Early versions of noutline don't have `outline-invisible-p'.
21566 (outline-invisible-p)))
21568 (defun org-back-to-heading (&optional invisible-ok)
21569 "Call `outline-back-to-heading', but provide a better error message."
21570 (condition-case nil
21571 (outline-back-to-heading invisible-ok)
21572 (error (error "Before first headline at position %d in buffer %s"
21573 (point) (current-buffer)))))
21575 (defun org-before-first-heading-p ()
21576 "Before first heading?"
21577 (save-excursion
21578 (end-of-line)
21579 (null (re-search-backward org-outline-regexp-bol nil t))))
21581 (defun org-at-heading-p (&optional ignored)
21582 (outline-on-heading-p t))
21583 ;; Compatibility alias with Org versions < 7.8.03
21584 (defalias 'org-on-heading-p 'org-at-heading-p)
21586 (defun org-at-comment-p nil
21587 "Is cursor in a line starting with a # character?"
21588 (save-excursion
21589 (beginning-of-line)
21590 (looking-at "^#")))
21592 (defun org-at-drawer-p nil
21593 "Is cursor at a drawer keyword?"
21594 (save-excursion
21595 (move-beginning-of-line 1)
21596 (looking-at org-drawer-regexp)))
21598 (defun org-at-block-p nil
21599 "Is cursor at a block keyword?"
21600 (save-excursion
21601 (move-beginning-of-line 1)
21602 (looking-at org-block-regexp)))
21604 (defun org-point-at-end-of-empty-headline ()
21605 "If point is at the end of an empty headline, return t, else nil.
21606 If the heading only contains a TODO keyword, it is still still considered
21607 empty."
21609 (when org-todo-line-regexp
21610 (save-excursion
21611 (beginning-of-line 1)
21612 (let ((case-fold-search nil))
21613 (looking-at org-todo-line-regexp)
21614 (string= (match-string 3) ""))))))
21616 (defun org-at-heading-or-item-p ()
21617 (or (org-at-heading-p) (org-at-item-p)))
21619 (defun org-at-target-p ()
21620 (or (org-in-regexp org-radio-target-regexp)
21621 (org-in-regexp org-target-regexp)))
21622 ;; Compatibility alias with Org versions < 7.8.03
21623 (defalias 'org-on-target-p 'org-at-target-p)
21625 (defun org-up-heading-all (arg)
21626 "Move to the heading line of which the present line is a subheading.
21627 This function considers both visible and invisible heading lines.
21628 With argument, move up ARG levels."
21629 (if (fboundp 'outline-up-heading-all)
21630 (outline-up-heading-all arg) ; emacs 21 version of outline.el
21631 (outline-up-heading arg t))) ; emacs 22 version of outline.el
21633 (defun org-up-heading-safe ()
21634 "Move to the heading line of which the present line is a subheading.
21635 This version will not throw an error. It will return the level of the
21636 headline found, or nil if no higher level is found.
21638 Also, this function will be a lot faster than `outline-up-heading',
21639 because it relies on stars being the outline starters. This can really
21640 make a significant difference in outlines with very many siblings."
21641 (let (start-level re)
21642 (org-back-to-heading t)
21643 (setq start-level (funcall outline-level))
21644 (if (equal start-level 1)
21645 nil
21647 (if (re-search-backward re nil t)
21648 (funcall outline-level)))))
21650 (defun org-first-sibling-p ()
21651 "Is this heading the first child of its parents?"
21652 (interactive)
21653 (let ((re org-outline-regexp-bol)
21654 level l)
21655 (unless (org-at-heading-p t)
21656 (error "Not at a heading"))
21657 (setq level (funcall outline-level))
21658 (save-excursion
21659 (if (not (re-search-backward re nil t))
21660 t
21661 (setq l (funcall outline-level))
21662 (< l level)))))
21664 (defun org-goto-sibling (&optional previous)
21665 "Goto the next sibling, even if it is invisible.
21666 When PREVIOUS is set, go to the previous sibling instead. Returns t
21667 when a sibling was found. When none is found, return nil and don't
21668 move point."
21669 (let ((fun (if previous 're-search-backward 're-search-forward))
21670 (pos (point))
21671 (re org-outline-regexp-bol)
21672 level l)
21673 (when (condition-case nil (org-back-to-heading t) (error nil))
21674 (setq level (funcall outline-level))
21675 (catch 'exit
21676 (or previous (forward-char 1))
21677 (while (funcall fun re nil t)
21678 (setq l (funcall outline-level))
21679 (when (< l level) (goto-char pos) (throw 'exit nil))
21680 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
21681 (goto-char pos)
21682 nil))))
21684 (defun org-show-siblings ()
21685 "Show all siblings of the current headline."
21686 (save-excursion
21687 (while (org-goto-sibling) (org-flag-heading nil)))
21688 (save-excursion
21689 (while (org-goto-sibling 'previous)
21690 (org-flag-heading nil))))
21692 (defun org-goto-first-child ()
21693 "Goto the first child, even if it is invisible.
21694 Return t when a child was found. Otherwise don't move point and
21695 return nil."
21696 (let (level (pos (point)) (re org-outline-regexp-bol))
21697 (when (condition-case nil (org-back-to-heading t) (error nil))
21698 (setq level (outline-level))
21699 (forward-char 1)
21700 (if (and (re-search-forward re nil t) (> (outline-level) level))
21701 (progn (goto-char (match-beginning 0)) t)
21702 (goto-char pos) nil))))
21704 (defun org-show-hidden-entry ()
21705 "Show an entry where even the heading is hidden."
21706 (save-excursion
21707 (org-show-entry)))
21709 (defun org-flag-heading (flag &optional entry)
21710 "Flag the current heading. FLAG non-nil means make invisible.
21711 When ENTRY is non-nil, show the entire entry."
21712 (save-excursion
21713 (org-back-to-heading t)
21714 ;; Check if we should show the entire entry
21715 (if entry
21716 (progn
21717 (org-show-entry)
21718 (save-excursion
21719 (and (outline-next-heading)
21720 (org-flag-heading nil))))
21721 (outline-flag-region (max (point-min) (1- (point)))
21722 (save-excursion (outline-end-of-heading) (point))
21723 flag))))
21725 (defun org-get-next-sibling ()
21726 "Move to next heading of the same level, and return point.
21727 If there is no such heading, return nil.
21728 This is like outline-next-sibling, but invisible headings are ok."
21729 (let ((level (funcall outline-level)))
21730 (outline-next-heading)
21731 (while (and (not (eobp)) (> (funcall outline-level) level))
21732 (outline-next-heading))
21733 (if (or (eobp) (< (funcall outline-level) level))
21734 nil
21735 (point))))
21737 (defun org-get-last-sibling ()
21738 "Move to previous heading of the same level, and return point.
21739 If there is no such heading, return nil."
21740 (let ((opoint (point))
21741 (level (funcall outline-level)))
21742 (outline-previous-heading)
21743 (when (and (/= (point) opoint) (outline-on-heading-p t))
21744 (while (and (> (funcall outline-level) level)
21745 (not (bobp)))
21746 (outline-previous-heading))
21747 (if (< (funcall outline-level) level)
21748 nil
21749 (point)))))
21751 (defun org-end-of-subtree (&optional invisible-ok to-heading)
21752 "Goto to the end of a subtree."
21753 ;; This contains an exact copy of the original function, but it uses
21754 ;; `org-back-to-heading', to make it work also in invisible
21755 ;; trees. And is uses an invisible-ok argument.
21756 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21757 ;; Furthermore, when used inside Org, finding the end of a large subtree
21758 ;; with many children and grandchildren etc, this can be much faster
21759 ;; than the outline version.
21760 (org-back-to-heading invisible-ok)
21761 (let ((first t)
21762 (level (funcall outline-level)))
21763 (if (and (derived-mode-p 'org-mode) (< level 1000))
21764 ;; A true heading (not a plain list item), in Org-mode
21765 ;; This means we can easily find the end by looking
21766 ;; only for the right number of stars. Using a regexp to do
21767 ;; this is so much faster than using a Lisp loop.
21769 (forward-char 1)
21770 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21771 ;; something else, do it the slow way
21772 (while (and (not (eobp))
21773 (or first (> (funcall outline-level) level)))
21774 (setq first nil)
21775 (outline-next-heading)))
21776 (unless to-heading
21778 (progn
21779 ;; Go to end of line before heading
21780 (forward-char -1)
21782 ;; leave blank line before heading
21783 (forward-char -1))))))
21784 (point))
21786 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21787 "Use Org version in org-mode, for dramatic speed-up."
21788 (if (derived-mode-p 'org-mode)
21789 (progn
21790 (org-end-of-subtree nil t)
21791 (unless (eobp) (backward-char 1)))
21792 ad-do-it))
21794 (defun org-end-of-meta-data-and-drawers ()
21795 "Jump to the first text after meta data and drawers in the current entry.
21796 This will move over empty lines, lines with planning time stamps,
21797 clocking lines, and drawers."
21798 (org-back-to-heading t)
21799 (let ((end (save-excursion (outline-next-heading) (point)))
21802 (forward-line 1)
21803 (while (re-search-forward re end t)
21804 (if (not (match-end 1))
21805 ;; empty or planning line
21806 (forward-line 1)
21807 ;; a drawer, find the end
21809 (forward-line 1)))
21811 (point)))
21813 (defun org-forward-heading-same-level (arg &optional invisible-ok)
21814 "Move forward to the arg'th subheading at same level as this one.
21815 Stop at the first and last subheadings of a superior heading.
21816 Normally this only looks at visible headings, but when INVISIBLE-OK is
21817 non-nil it will also look at invisible ones."
21818 (interactive "p")
21819 (org-back-to-heading invisible-ok)
21820 (org-at-heading-p)
21821 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21823 l)
21824 (forward-char 1)
21825 (while (> arg 0)
21826 (while (and (re-search-forward re nil 'move)
21827 (setq l (- (match-end 0) (match-beginning 0) 1))
21828 (= l level)
21829 (not invisible-ok)
21830 (progn (backward-char 1) (outline-invisible-p)))
21831 (if (< l level) (setq arg 1)))
21832 (setq arg (1- arg)))
21833 (beginning-of-line 1)))
21835 (defun org-backward-heading-same-level (arg &optional invisible-ok)
21836 "Move backward to the arg'th subheading at same level as this one.
21837 Stop at the first and last subheadings of a superior heading."
21838 (interactive "p")
21839 (org-back-to-heading)
21840 (org-at-heading-p)
21841 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21843 l)
21844 (while (> arg 0)
21845 (while (and (re-search-backward re nil 'move)
21846 (setq l (- (match-end 0) (match-beginning 0) 1))
21847 (= l level)
21848 (not invisible-ok)
21849 (outline-invisible-p))
21850 (if (< l level) (setq arg 1)))
21851 (setq arg (1- arg)))))
21853 (defun org-forward-element ()
21854 "Move forward by one element.
21855 Move to the next element at the same level, when possible."
21856 (interactive)
21857 (cond ((eobp) (error "Cannot move further down"))
21858 ((org-with-limited-levels (org-at-heading-p))
21859 (let ((origin (point)))
21860 (org-forward-heading-same-level 1)
21861 (unless (org-with-limited-levels (org-at-heading-p))
21862 (goto-char origin)
21863 (error "Cannot move further down"))))
21864 (t
21865 (let* ((elem (org-element-at-point))
21866 (end (org-element-property :end elem))
21867 (parent (org-element-property :parent elem)))
21868 (if (and parent (= (org-element-property :contents-end parent) end))
21869 (goto-char (org-element-property :end parent))
21870 (goto-char end))))))
21872 (defun org-backward-element ()
21873 "Move backward by one element.
21874 Move to the previous element at the same level, when possible."
21875 (interactive)
21876 (cond ((bobp) (error "Cannot move further up"))
21877 ((org-with-limited-levels (org-at-heading-p))
21878 ;; At an headline, move to the previous one, if any, or stay
21879 ;; here.
21880 (let ((origin (point)))
21881 (org-backward-heading-same-level 1)
21882 (unless (org-with-limited-levels (org-at-heading-p))
21883 (goto-char origin)
21884 (error "Cannot move further up"))))
21885 (t
21886 (let* ((trail (org-element-at-point 'keep-trail))
21887 (elem (car trail))
21888 (prev-elem (nth 1 trail))
21889 (beg (org-element-property :begin elem)))
21890 (cond
21891 ;; Move to beginning of current element if point isn't
21892 ;; there already.
21893 ((/= (point) beg) (goto-char beg))
21894 (prev-elem (goto-char (org-element-property :begin prev-elem)))
21895 ((org-before-first-heading-p) (goto-char (point-min)))
21896 (t (org-back-to-heading)))))))
21898 (defun org-up-element ()
21899 "Move to upper element."
21900 (interactive)
21901 (if (org-with-limited-levels (org-at-heading-p))
21902 (unless (org-up-heading-safe) (error "No surrounding element"))
21903 (let* ((elem (org-element-at-point))
21904 (parent (org-element-property :parent elem)))
21905 (if parent (goto-char (org-element-property :begin parent))
21906 (if (org-with-limited-levels (org-before-first-heading-p))
21907 (error "No surrounding element")
21908 (org-with-limited-levels (org-back-to-heading)))))))
21910 (defvar org-element-greater-elements)
21911 (defun org-down-element ()
21912 "Move to inner element."
21913 (interactive)
21914 (let ((element (org-element-at-point)))
21915 (cond
21916 ((memq (org-element-type element) '(plain-list table))
21917 (goto-char (org-element-property :contents-begin element))
21918 (forward-char))
21919 ((memq (org-element-type element) org-element-greater-elements)
21920 ;; If contents are hidden, first disclose them.
21921 (when (org-element-property :hiddenp element) (org-cycle))
21922 (goto-char (or (org-element-property :contents-begin element)
21923 (error "No content for this element"))))
21924 (t (error "No inner element")))))
21926 (defun org-drag-element-backward ()
21927 "Move backward element at point."
21928 (interactive)
21929 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
21930 (let* ((trail (org-element-at-point 'keep-trail))
21931 (elem (car trail))
21932 (prev-elem (nth 1 trail)))
21933 ;; Error out if no previous element or previous element is
21934 ;; a parent of the current one.
21935 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
21936 (error "Cannot drag element backward")
21937 (let ((pos (point)))
21938 (org-element-swap-A-B prev-elem elem)
21939 (goto-char (+ (org-element-property :begin prev-elem)
21940 (- pos (org-element-property :begin elem)))))))))
21942 (defun org-drag-element-forward ()
21943 "Move forward element at point."
21944 (interactive)
21945 (let* ((pos (point))
21946 (elem (org-element-at-point)))
21947 (when (= (point-max) (org-element-property :end elem))
21948 (error "Cannot drag element forward"))
21949 (goto-char (org-element-property :end elem))
21950 (let ((next-elem (org-element-at-point)))
21951 (when (or (org-element-nested-p elem next-elem)
21952 (and (eq (org-element-type next-elem) 'headline)
21953 (not (eq (org-element-type elem) 'headline))))
21954 (goto-char pos)
21955 (error "Cannot drag element forward"))
21956 ;; Compute new position of point: it's shifted by NEXT-ELEM
21957 ;; body's length (without final blanks) and by the length of
21958 ;; blanks between ELEM and NEXT-ELEM.
21959 (let ((size-next (- (save-excursion
21960 (goto-char (org-element-property :end next-elem))
21962 (forward-line)
21963 ;; Small correction if buffer doesn't end
21964 ;; with a newline character.
21965 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
21966 (org-element-property :begin next-elem)))
21967 (size-blank (- (org-element-property :end elem)
21968 (save-excursion
21969 (goto-char (org-element-property :end elem))
21971 (forward-line)
21972 (point)))))
21973 (org-element-swap-A-B elem next-elem)
21974 (goto-char (+ pos size-next size-blank))))))
21976 (defun org-mark-element ()
21977 "Put point at beginning of this element, mark at end.
21979 Interactively, if this command is repeated or (in Transient Mark
21980 mode) if the mark is active, it marks the next element after the
21981 ones already marked."
21982 (interactive)
21983 (let (deactivate-mark)
21984 (if (and (org-called-interactively-p 'any)
21985 (or (and (eq last-command this-command) (mark t))
21986 (and transient-mark-mode mark-active)))
21987 (set-mark
21988 (save-excursion
21989 (goto-char (mark))
21990 (goto-char (org-element-property :end (org-element-at-point)))))
21991 (let ((element (org-element-at-point)))
21992 (end-of-line)
21993 (push-mark (org-element-property :end element) t t)
21994 (goto-char (org-element-property :begin element))))))
21996 (defun org-narrow-to-element ()
21997 "Narrow buffer to current element."
21998 (interactive)
21999 (let ((elem (org-element-at-point)))
22000 (cond
22001 ((eq (car elem) 'headline)
22002 (narrow-to-region
22003 (org-element-property :begin elem)
22004 (org-element-property :end elem)))
22005 ((memq (car elem) org-element-greater-elements)
22006 (narrow-to-region
22007 (org-element-property :contents-begin elem)
22008 (org-element-property :contents-end elem)))
22009 (t
22010 (narrow-to-region
22011 (org-element-property :begin elem)
22012 (org-element-property :end elem))))))
22014 (defun org-transpose-element ()
22015 "Transpose current and previous elements, keeping blank lines between.
22016 Point is moved after both elements."
22017 (interactive)
22018 (org-skip-whitespace)
22019 (let ((end (org-element-property :end (org-element-at-point))))
22020 (org-drag-element-backward)
22021 (goto-char end)))
22023 (defun org-unindent-buffer ()
22024 "Un-indent the visible part of the buffer.
22025 Relative indentation (between items, inside blocks, etc.) isn't
22026 modified."
22027 (interactive)
22028 (unless (eq major-mode 'org-mode)
22029 (error "Cannot un-indent a buffer not in Org mode"))
22030 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
22031 unindent-tree ; For byte-compiler.
22032 (unindent-tree
22033 (function
22034 (lambda (contents)
22035 (mapc
22036 (lambda (element)
22037 (if (memq (org-element-type element) '(headline section))
22038 (funcall unindent-tree (org-element-contents element))
22039 (save-excursion
22040 (save-restriction
22041 (narrow-to-region
22042 (org-element-property :begin element)
22043 (org-element-property :end element))
22044 (org-do-remove-indentation)))))
22045 (reverse contents))))))
22046 (funcall unindent-tree (org-element-contents parse-tree))))
22048 (defun org-show-subtree ()
22049 "Show everything after this heading at deeper levels."
22050 (interactive)
22051 (outline-flag-region
22052 (point)
22053 (save-excursion
22054 (org-end-of-subtree t t))
22055 nil))
22057 (defun org-show-entry ()
22058 "Show the body directly following this heading.
22059 Show the heading too, if it is currently invisible."
22060 (interactive)
22061 (save-excursion
22062 (condition-case nil
22063 (progn
22064 (org-back-to-heading t)
22065 (outline-flag-region
22066 (max (point-min) (1- (point)))
22067 (save-excursion
22068 (if (re-search-forward
22070 (match-beginning 1)
22071 (point-max)))
22072 nil)
22073 (org-cycle-hide-drawers 'children))
22074 (error nil))))
22076 (defun org-make-options-regexp (kwds &optional extra)
22077 "Make a regular expression for keyword lines."
22078 (concat
22084 ;; Make isearch reveal the necessary context
22085 (defun org-isearch-end ()
22086 "Reveal context after isearch exits."
22087 (when isearch-success ; only if search was successful
22088 (if (featurep 'xemacs)
22089 ;; Under XEmacs, the hook is run in the correct place,
22090 ;; we directly show the context.
22091 (org-show-context 'isearch)
22092 ;; In Emacs the hook runs *before* restoring the overlays.
22093 ;; So we have to use a one-time post-command-hook to do this.
22094 ;; (Emacs 22 has a special variable, see function `org-mode')
22095 (unless (and (boundp 'isearch-mode-end-hook-quit)
22096 isearch-mode-end-hook-quit)
22097 ;; Only when the isearch was not quitted.
22098 (org-add-hook 'post-command-hook 'org-isearch-post-command
22099 'append 'local)))))
22101 (defun org-isearch-post-command ()
22102 "Remove self from hook, and show context."
22103 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
22104 (org-show-context 'isearch))
22107 ;;;; Integration with and fixes for other packages
22109 ;;; Imenu support
22111 (defvar org-imenu-markers nil
22112 "All markers currently used by Imenu.")
22113 (make-variable-buffer-local 'org-imenu-markers)
22115 (defun org-imenu-new-marker (&optional pos)
22116 "Return a new marker for use by Imenu, and remember the marker."
22117 (let ((m (make-marker)))
22118 (move-marker m (or pos (point)))
22119 (push m org-imenu-markers)
22120 m))
22122 (defun org-imenu-get-tree ()
22123 "Produce the index for Imenu."
22124 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
22125 (setq org-imenu-markers nil)
22126 (let* ((n org-imenu-depth)
22127 (re (concat "^" (org-get-limited-outline-regexp)))
22128 (subs (make-vector (1+ n) nil))
22129 (last-level 0)
22130 m level head)
22131 (save-excursion
22132 (save-restriction
22133 (widen)
22134 (goto-char (point-max))
22135 (while (re-search-backward re nil t)
22136 (setq level (org-reduced-level (funcall outline-level)))
22137 (when (and (<= level n)
22138 (looking-at org-complex-heading-regexp))
22139 (setq head (org-link-display-format
22140 (org-match-string-no-properties 4))
22141 m (org-imenu-new-marker))
22142 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
22143 (if (>= level last-level)
22144 (push (cons head m) (aref subs level))
22145 (push (cons head (aref subs (1+ level))) (aref subs level))
22146 (loop for i from (1+ level) to n do (aset subs i nil)))
22147 (setq last-level level)))))
22148 (aref subs 1)))
22150 (eval-after-load "imenu"
22151 '(progn
22152 (add-hook 'imenu-after-jump-hook
22153 (lambda ()
22154 (if (derived-mode-p 'org-mode)
22155 (org-show-context 'org-goto))))))
22157 (defun org-link-display-format (link)
22158 "Replace a link with either the description, or the link target
22159 if no description is present"
22160 (save-match-data
22161 (if (string-match org-bracket-link-analytic-regexp link)
22162 (replace-match (if (match-end 5)
22163 (match-string 5 link)
22164 (concat (match-string 1 link)
22165 (match-string 3 link)))
22166 nil t link)
22167 link)))
22169 (defun org-toggle-link-display ()
22170 "Toggle the literal or descriptive display of links."
22171 (interactive)
22172 (if org-descriptive-links
22173 (progn (org-remove-from-invisibility-spec '(org-link))
22174 (org-restart-font-lock)
22175 (setq org-descriptive-links nil))
22176 (progn (add-to-invisibility-spec '(org-link))
22177 (org-restart-font-lock)
22178 (setq org-descriptive-links t))))
22180 ;; Speedbar support
22182 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
22183 "Overlay marking the agenda restriction line in speedbar.")
22184 (overlay-put org-speedbar-restriction-lock-overlay
22185 'face 'org-agenda-restriction-lock)
22186 (overlay-put org-speedbar-restriction-lock-overlay
22187 'help-echo "Agendas are currently limited to this item.")
22188 (org-detach-overlay org-speedbar-restriction-lock-overlay)
22190 (defun org-speedbar-set-agenda-restriction ()
22191 "Restrict future agenda commands to the location at point in speedbar.
22193 (interactive)
22194 (require 'org-agenda)
22195 (let (p m tp np dir txt)
22196 (cond
22197 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22198 'org-imenu t))
22199 (setq m (get-text-property p 'org-imenu-marker))
22200 (with-current-buffer (marker-buffer m)
22201 (goto-char m)
22202 (org-agenda-set-restriction-lock 'subtree)))
22203 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22204 'speedbar-function 'speedbar-find-file))
22205 (setq tp (previous-single-property-change
22206 (1+ p) 'speedbar-function)
22207 np (next-single-property-change
22208 tp 'speedbar-function)
22209 dir (speedbar-line-directory)
22210 txt (buffer-substring-no-properties (or tp (point-min))
22211 (or np (point-max))))
22212 (with-current-buffer (find-file-noselect
22213 (let ((default-directory dir))
22214 (expand-file-name txt)))
22215 (unless (derived-mode-p 'org-mode)
22216 (error "Cannot restrict to non-Org-mode file"))
22217 (org-agenda-set-restriction-lock 'file)))
22218 (t (error "Don't know how to restrict Org-mode's agenda")))
22219 (move-overlay org-speedbar-restriction-lock-overlay
22220 (point-at-bol) (point-at-eol))
22221 (setq current-prefix-arg nil)
22222 (org-agenda-maybe-redo)))
22224 (eval-after-load "speedbar"
22225 '(progn
22226 (speedbar-add-supported-extension ".org")
22227 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
22228 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
22229 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
22230 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
22231 (add-hook 'speedbar-visiting-tag-hook
22232 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
22234 ;;; Fixes and Hacks for problems with other packages
22236 ;; Make flyspell not check words in links, to not mess up our keymap
22237 (defun org-mode-flyspell-verify ()
22238 "Don't let flyspell put overlays at active buttons, or on
22239 {todo,all-time,additional-option-like}-keywords."
22240 (let ((pos (max (1- (point)) (point-min)))
22241 (word (thing-at-point 'word)))
22242 (and (not (get-text-property pos 'keymap))
22243 (not (get-text-property pos 'org-no-flyspell))
22244 (not (member word org-todo-keywords-1))
22245 (not (member word org-all-time-keywords))
22246 (not (member word org-options-keywords))
22247 (not (member word (mapcar 'car org-startup-options)))
22248 (not (member word org-additional-option-like-keywords-for-flyspell)))))
22250 (defun org-remove-flyspell-overlays-in (beg end)
22251 "Remove flyspell overlays in region."
22252 (and (org-bound-and-true-p flyspell-mode)
22253 (fboundp 'flyspell-delete-region-overlays)
22254 (flyspell-delete-region-overlays beg end))
22255 (add-text-properties beg end '(org-no-flyspell t)))
22257 ;; Make `bookmark-jump' shows the jump location if it was hidden.
22258 (eval-after-load "bookmark"
22259 '(if (boundp 'bookmark-after-jump-hook)
22260 ;; We can use the hook
22261 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
22262 ;; Hook not available, use advice
22263 (defadvice bookmark-jump (after org-make-visible activate)
22264 "Make the position visible."
22265 (org-bookmark-jump-unhide))))
22267 ;; Make sure saveplace shows the location if it was hidden
22268 (eval-after-load "saveplace"
22269 '(defadvice save-place-find-file-hook (after org-make-visible activate)
22270 "Make the position visible."
22271 (org-bookmark-jump-unhide)))
22273 ;; Make sure ecb shows the location if it was hidden
22274 (eval-after-load "ecb"
22275 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
22276 "Make hierarchy visible when jumping into location from ECB tree buffer."
22277 (if (derived-mode-p 'org-mode)
22278 (org-show-context))))
22280 (defun org-bookmark-jump-unhide ()
22281 "Unhide the current position, to show the bookmark location."
22282 (and (derived-mode-p 'org-mode)
22283 (or (outline-invisible-p)
22284 (save-excursion (goto-char (max (point-min) (1- (point))))
22285 (outline-invisible-p)))
22286 (org-show-context 'bookmark-jump)))
22288 ;; Make session.el ignore our circular variable
22289 (eval-after-load "session"
22290 '(add-to-list 'session-globals-exclude 'org-mark-ring))
22292 ;;;; Experimental code
22294 (defun org-closed-in-range ()
22295 "Sparse tree of items closed in a certain time range.
22296 Still experimental, may disappear in the future."
22297 (interactive)
22298 ;; Get the time interval from the user.
22299 (let* ((time1 (org-float-time
22300 (org-read-date nil 'to-time nil "Starting date: ")))
22301 (time2 (org-float-time
22302 (org-read-date nil 'to-time nil "End date:")))
22303 ;; callback function
22304 (callback (lambda ()
22305 (let ((time
22306 (org-float-time
22307 (apply 'encode-time
22308 (org-parse-time-string
22309 (match-string 1))))))
22310 ;; check if time in interval
22311 (and (>= time time1) (<= time time2))))))
22312 ;; make tree, check each match with the callback
22315 ;;;; Finish up
22317 (provide 'org)
22319 (run-hooks 'org-load-hook)
22321 ;;; org.el ends here