| blob | 6cf5b8d081e87c01e075ac160cdc20f7b0b80972 |
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 (org-offer-links-in-entry arg)
9652 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9653 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9654 ((and (org-at-timestamp-p t)
9655 (not (org-in-regexp org-bracket-link-regexp)))
9656 (org-follow-timestamp-link))
9657 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9658 (not (org-in-regexp org-any-link-re)))
9659 (org-footnote-action))
9660 (t
9661 (let (type path link line search (pos (point)))
9662 (catch 'match
9663 (save-excursion
9665 (when (org-in-regexp org-bracket-link-regexp 1)
9666 (setq link (org-extract-attributes
9667 (org-link-unescape (org-match-string-no-properties 1))))
9669 (setq link (replace-match " " t t link)))
9670 (setq link (org-link-expand-abbrev link))
9671 (cond
9672 ((or (file-name-absolute-p link)
9674 (setq type "file" path link))
9675 ((string-match org-link-re-with-space3 link)
9676 (setq type (match-string 1 link) path (match-string 2 link)))
9678 (setq type "help" path (match-string 1 link)))
9679 (t (setq type "thisfile" path link)))
9680 (throw 'match t)))
9682 (when (get-text-property (point) 'org-linked-text)
9683 (setq type "thisfile"
9684 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9685 (1+ (point)) (point))
9686 path (buffer-substring
9687 (or (previous-single-property-change pos 'org-linked-text)
9688 (point-min))
9689 (or (next-single-property-change pos 'org-linked-text)
9690 (point-max))))
9691 (throw 'match t))
9693 (save-excursion
9694 (let ((plinkpos (org-in-regexp org-plain-link-re)))
9695 (when (or (org-in-regexp org-angle-link-re)
9696 (and plinkpos (goto-char (car plinkpos))
9698 (setq type (match-string 1)
9699 path (org-link-unescape (match-string 2)))
9700 (throw 'match t))))
9701 (save-excursion
9703 (setq type "tags"
9704 path (match-string 1))
9705 (while (string-match ":" path)
9706 (setq path (replace-match "+" t t path)))
9707 (throw 'match t)))
9709 (setq type "tree-match"
9710 path (match-string 1))
9711 (throw 'match t)))
9712 (unless path
9713 (user-error "No link found"))
9715 ;; switch back to reference buffer
9716 ;; needed when if called in a temporary buffer through
9717 ;; org-open-link-from-string
9718 (with-current-buffer (or reference-buffer (current-buffer))
9720 ;; Remove any trailing spaces in path
9722 (setq path (replace-match "" t t path)))
9723 (if (and org-link-translation-function
9724 (fboundp org-link-translation-function))
9725 ;; Check if we need to translate the link
9726 (let ((tmp (funcall org-link-translation-function type path)))
9727 (setq type (car tmp) path (cdr tmp))))
9729 (cond
9731 ((assoc type org-link-protocols)
9732 (funcall (nth 1 (assoc type org-link-protocols)) path))
9734 ((equal type "help")
9735 (let ((f-or-v (intern path)))
9736 (cond ((fboundp f-or-v)
9737 (describe-function f-or-v))
9738 ((boundp f-or-v)
9739 (describe-variable f-or-v))
9740 (t (error "Not a known function or variable")))))
9742 ((equal type "mailto")
9743 (let ((cmd (car org-link-mailto-program))
9744 (args (cdr org-link-mailto-program)) args1
9745 (address path) (subject "") a)
9747 (setq address (match-string 1 path)
9748 subject (org-link-escape (match-string 2 path))))
9749 (while args
9750 (cond
9751 ((not (stringp (car args))) (push (pop args) args1))
9752 (t (setq a (pop args))
9753 (if (string-match "%a" a)
9754 (setq a (replace-match address t t a)))
9755 (if (string-match "%s" a)
9756 (setq a (replace-match subject t t a)))
9757 (push a args1))))
9758 (apply cmd (nreverse args1))))
9760 ((member type '("http" "https" "ftp" "news"))
9761 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9762 (org-link-escape
9763 path org-link-escape-chars-browser)
9764 path))))
9766 ((string= type "doi")
9767 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
9768 (org-link-escape
9769 path org-link-escape-chars-browser)
9770 path))))
9772 ((member type '("message"))
9773 (browse-url (concat type ":" path)))
9775 ((string= type "tags")
9776 (org-tags-view arg path))
9778 ((string= type "tree-match")
9781 ((string= type "file")
9783 (setq line (string-to-number (match-string 1 path))
9784 path (substring path 0 (match-beginning 0)))
9786 (setq search (match-string 1 path)
9787 path (substring path 0 (match-beginning 0)))))
9788 (if (string-match "[*?{]" (file-name-nondirectory path))
9789 (dired path)
9790 (org-open-file path arg line search)))
9792 ((string= type "shell")
9793 (let ((buf (generate-new-buffer "*Org Shell Output"))
9794 (cmd path))
9795 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9796 (string-match org-confirm-shell-link-not-regexp cmd))
9797 (not org-confirm-shell-link-function)
9798 (funcall org-confirm-shell-link-function
9800 (org-add-props cmd nil
9801 'face 'org-warning))))
9802 (progn
9803 (message "Executing %s" cmd)
9804 (shell-command cmd buf)
9805 (if (featurep 'midnight)
9806 (setq clean-buffer-list-kill-buffer-names
9807 (cons buf clean-buffer-list-kill-buffer-names))))
9808 (error "Abort"))))
9810 ((string= type "elisp")
9811 (let ((cmd path))
9812 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9813 (string-match org-confirm-elisp-link-not-regexp cmd))
9814 (not org-confirm-elisp-link-function)
9815 (funcall org-confirm-elisp-link-function
9817 (org-add-props cmd nil
9818 'face 'org-warning))))
9819 (message "%s => %s" cmd
9820 (if (equal (string-to-char cmd) ?\()
9821 (eval (read cmd))
9822 (call-interactively (read cmd))))
9823 (error "Abort"))))
9825 ((and (string= type "thisfile")
9826 (run-hook-with-args-until-success
9827 'org-open-link-functions path)))
9829 ((string= type "thisfile")
9830 (if arg
9831 (switch-to-buffer-other-window
9832 (org-get-buffer-for-internal-link (current-buffer)))
9833 (org-mark-ring-push))
9834 (let ((cmd `(org-link-search
9835 ,path
9836 ,(cond ((equal arg '(4)) ''occur)
9837 ((equal arg '(16)) ''org-occur))
9838 ,pos)))
9839 (condition-case nil (let ((org-link-search-inhibit-query t))
9840 (eval cmd))
9841 (error (progn (widen) (eval cmd))))))
9843 (t (browse-url-at-point)))))))
9844 (move-marker org-open-link-marker nil)
9845 (run-hook-with-args 'org-follow-link-hook)))
9847 (defun org-offer-links-in-entry (&optional nth zero)
9848 "Offer links in the current entry and follow the selected link.
9849 If there is only one link, follow it immediately as well.
9850 If NTH is an integer, immediately pick the NTH link found.
9851 If ZERO is a string, check also this string for a link, and if
9852 there is one, offer it as link number zero."
9856 (cnt ?0)
9857 (in-emacs (if (integerp nth) nil nth))
9858 have-zero end links link c)
9859 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9860 (push (match-string 0 zero) links)
9861 (setq cnt (1- cnt) have-zero t))
9862 (save-excursion
9863 (org-back-to-heading t)
9864 (setq end (save-excursion (outline-next-heading) (point)))
9865 (while (re-search-forward re end t)
9866 (push (match-string 0) links))
9867 (setq links (org-uniquify (reverse links))))
9869 (cond
9870 ((null links)
9871 (message "No links"))
9872 ((equal (length links) 1)
9873 (setq link (list (car links))))
9874 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9875 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9876 (t ; we have to select a link
9877 (save-excursion
9878 (save-window-excursion
9879 (delete-other-windows)
9880 (with-output-to-temp-buffer "*Select Link*"
9881 (mapc (lambda (l)
9882 (if (not (string-match org-bracket-link-regexp l))
9884 (org-remove-angle-brackets l)))
9885 (if (match-end 3)
9887 (match-string 3 l) (match-string 1 l)))
9889 (match-string 1 l))))))
9890 links))
9891 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9892 (message "Select link to open, RET to open all:")
9893 (setq c (read-char-exclusive))
9894 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9895 (when (equal c ?q) (error "Abort"))
9896 (if (equal c ?\C-m)
9897 (setq link links)
9898 (setq nth (- c ?0))
9899 (if have-zero (setq nth (1+ nth)))
9900 (unless (and (integerp nth) (>= (length links) nth))
9901 (error "Invalid link selection"))
9902 (setq link (list (nth (1- nth) links))))))
9903 (if link
9904 (let ((buf (current-buffer)))
9905 (dolist (l link)
9906 (org-open-link-from-string l in-emacs buf))
9907 t)
9908 nil)))
9910 ;; Add special file links that specify the way of opening
9912 (org-add-link-type "file+sys" 'org-open-file-with-system)
9913 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9914 (defun org-open-file-with-system (path)
9915 "Open file at PATH using the system way of opening it."
9916 (org-open-file path 'system))
9917 (defun org-open-file-with-emacs (path)
9918 "Open file at PATH in Emacs."
9919 (org-open-file path 'emacs))
9920 (defun org-remove-file-link-modifiers ()
9921 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9922 (goto-char (point-min))
9924 (org-if-unprotected
9925 (replace-match "file:" t t))))
9926 (eval-after-load "org-exp"
9927 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9928 'org-remove-file-link-modifiers))
9930 ;;;; Time estimates
9932 (defun org-get-effort (&optional pom)
9933 "Get the effort estimate for the current entry."
9934 (org-entry-get pom org-effort-property))
9936 ;;; File search
9938 (defvar org-create-file-search-functions nil
9939 "List of functions to construct the right search string for a file link.
9940 These functions are called in turn with point at the location to
9941 which the link should point.
9943 A function in the hook should first test if it would like to
9944 handle this file type, for example by checking the `major-mode'
9945 or the file extension. If it decides not to handle this file, it
9946 should just return nil to give other functions a chance. If it
9947 does handle the file, it must return the search string to be used
9948 when following the link. The search string will be part of the
9949 file link, given after a double colon, and `org-open-at-point'
9950 will automatically search for it. If special measures must be
9951 taken to make the search successful, another function should be
9952 added to the companion hook `org-execute-file-search-functions',
9953 which see.
9955 A function in this hook may also use `setq' to set the variable
9956 `description' to provide a suggestion for the descriptive text to
9957 be used for this link when it gets inserted into an Org-mode
9960 (defvar org-execute-file-search-functions nil
9961 "List of functions to execute a file search triggered by a link.
9963 Functions added to this hook must accept a single argument, the
9964 search string that was part of the file link, the part after the
9965 double colon. The function must first check if it would like to
9966 handle this search, for example by checking the `major-mode' or
9967 the file extension. If it decides not to handle this search, it
9968 should just return nil to give other functions a chance. If it
9969 does handle the search, it must return a non-nil value to keep
9970 other functions from trying.
9972 Each function can access the current prefix argument through the
9973 variable `current-prefix-argument'. Note that a single prefix is
9974 used to force opening a link in Emacs, so it may be good to only
9975 use a numeric or double prefix to guide the search function.
9977 In case this is needed, a function in this hook can also restore
9978 the window configuration before `org-open-at-point' was called using:
9980 (set-window-configuration org-window-config-before-follow-link)")
9982 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9983 (defun org-link-search (s &optional type avoid-pos stealth)
9984 "Search for a link search option.
9985 If S is surrounded by forward slashes, it is interpreted as a
9986 regular expression. In org-mode files, this will create an `org-occur'
9987 sparse tree. In ordinary files, `occur' will be used to list matches.
9988 If the current buffer is in `dired-mode', grep will be used to search
9989 in all files. If AVOID-POS is given, ignore matches near that position.
9991 When optional argument STEALTH is non-nil, do not modify
9992 visibility around point, thus ignoring
9993 `org-show-hierarchy-above', `org-show-following-heading' and
9994 `org-show-siblings' variables."
9995 (let ((case-fold-search t)
9999 org-emphasis-alist)
10001 (pos (point))
10002 (pre nil) (post nil)
10003 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10004 (cond
10005 ;; First check if there are any special search functions
10006 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10007 ;; Now try the builtin stuff
10008 ((and (equal (string-to-char s0) ?#)
10009 (> (length s0) 1)
10010 (save-excursion
10011 (goto-char (point-min))
10012 (and
10013 (re-search-forward
10015 (setq type 'dedicated
10016 pos (match-beginning 0))))
10017 ;; There is an exact target for this
10018 (goto-char pos)
10019 (org-back-to-heading t)))
10020 ((save-excursion
10021 (goto-char (point-min))
10022 (and
10023 (re-search-forward
10024 (concat "<<" (regexp-quote s0) ">>") nil t)
10025 (setq type 'dedicated
10026 pos (match-beginning 0))))
10027 ;; There is an exact target for this
10028 (goto-char pos))
10029 ((save-excursion
10030 (goto-char (point-min))
10031 (and
10032 (re-search-forward
10034 (setq type 'dedicated pos (match-beginning 0))))
10035 ;; Found an invisible target.
10036 (goto-char pos))
10037 ((save-excursion
10038 (goto-char (point-min))
10039 (and
10040 (re-search-forward
10042 (setq type 'dedicated pos (match-beginning 0))))
10043 ;; Found an element with a matching #+name affiliated keyword.
10044 (goto-char pos))
10046 (save-excursion
10047 (goto-char (point-min))
10048 (and
10049 (re-search-forward
10050 (concat "[^[]" (regexp-quote
10051 (format org-coderef-label-format
10052 (match-string 1 s0))))
10053 nil t)
10054 (setq type 'dedicated
10055 pos (1+ (match-beginning 0))))))
10056 ;; There is a coderef target for this
10057 (goto-char pos))
10059 ;; A regular expression
10060 (cond
10061 ((derived-mode-p 'org-mode)
10062 (org-occur (match-string 1 s)))
10063 ;;((eq major-mode 'dired-mode)
10064 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
10065 (t (org-do-occur (match-string 1 s)))))
10066 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10067 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10068 (goto-char (point-min))
10069 (cond
10070 ((let (case-fold-search)
10071 (re-search-forward (format org-complex-heading-regexp-format
10072 (regexp-quote s))
10073 nil t))
10074 ;; OK, found a match
10075 (setq type 'dedicated)
10076 (goto-char (match-beginning 0)))
10077 ((and (not org-link-search-inhibit-query)
10078 (eq org-link-search-must-match-exact-headline 'query-to-create)
10079 (y-or-n-p "No match - create this as a new heading? "))
10080 (goto-char (point-max))
10081 (or (bolp) (newline))
10083 (beginning-of-line 0))
10084 (t
10085 (goto-char pos)
10086 (error "No match"))))
10087 (t
10088 ;; A normal search string
10089 (when (equal (string-to-char s) ?*)
10090 ;; Anchor on headlines, post may include tags.
10093 s (substring s 1)))
10094 (remove-text-properties
10095 0 (length s)
10096 '(face nil mouse-face nil keymap nil fontified nil) s)
10097 ;; Make a series of regular expressions to find a match
10106 re4 (concat "[^a-zA-Z_]" re4_)
10108 re1 (concat pre re2 post)
10109 re3 (concat pre (if pre re4_ re4) post)
10110 re5 (concat pre ".*" re4)
10111 re2 (concat pre re2)
10112 re2a (concat pre (if pre re2a_ re2a))
10113 re4 (concat pre (if pre re4_ re4))
10117 ))
10118 (cond
10119 ((eq type 'org-occur) (org-occur reall))
10120 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10121 (t (goto-char (point-min))
10122 (setq type 'fuzzy)
10123 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10124 (org-search-not-self 1 re1 nil t)
10125 (org-search-not-self 1 re2 nil t)
10126 (org-search-not-self 1 re2a nil t)
10127 (org-search-not-self 1 re3 nil t)
10128 (org-search-not-self 1 re4 nil t)
10129 (org-search-not-self 1 re5 nil t)
10130 )
10131 (goto-char (match-beginning 1))
10132 (goto-char pos)
10133 (error "No match"))))))
10134 (and (derived-mode-p 'org-mode)
10135 (not stealth)
10136 (org-show-context 'link-search))
10137 type))
10139 (defun org-search-not-self (group &rest args)
10140 "Execute `re-search-forward', but only accept matches that do not
10141 enclose the position of `org-open-link-marker'."
10142 (let ((m org-open-link-marker))
10143 (catch 'exit
10144 (while (apply 're-search-forward args)
10145 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10146 (goto-char (match-end group))
10147 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10148 (> (match-beginning 0) (marker-position m))
10149 (< (match-end 0) (marker-position m)))
10150 (save-match-data
10151 (or (not (org-in-regexp
10152 org-bracket-link-analytic-regexp 1))
10153 (not (match-end 4)) ; no description
10154 (and (<= (match-beginning 4) (point))
10155 (>= (match-end 4) (point))))))
10156 (throw 'exit (point))))))))
10158 (defun org-get-buffer-for-internal-link (buffer)
10159 "Return a buffer to be used for displaying the link target of internal links."
10160 (cond
10161 ((not org-display-internal-link-with-indirect-buffer)
10162 buffer)
10163 ((string-match "(Clone)$" (buffer-name buffer))
10164 (message "Buffer is already a clone, not making another one")
10165 ;; we also do not modify visibility in this case
10166 buffer)
10167 (t ; make a new indirect buffer for displaying the link
10168 (let* ((bn (buffer-name buffer))
10169 (ibn (concat bn "(Clone)"))
10170 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10171 (with-current-buffer ib (org-overview))
10172 ib))))
10174 (defun org-do-occur (regexp &optional cleanup)
10175 "Call the Emacs command `occur'.
10176 If CLEANUP is non-nil, remove the printout of the regular expression
10177 in the *Occur* buffer. This is useful if the regex is long and not useful
10178 to read."
10179 (occur regexp)
10180 (when cleanup
10181 (let ((cwin (selected-window)) win beg end)
10182 (when (setq win (get-buffer-window "*Occur*"))
10183 (select-window win))
10184 (goto-char (point-min))
10185 (when (re-search-forward "match[a-z]+" nil t)
10186 (setq beg (match-end 0))
10188 (setq end (1- (match-beginning 0)))))
10189 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10190 (goto-char (point-min))
10191 (select-window cwin))))
10193 ;;; The mark ring for links jumps
10195 (defvar org-mark-ring nil
10196 "Mark ring for positions before jumps in Org-mode.")
10197 (defvar org-mark-ring-last-goto nil
10198 "Last position in the mark ring used to go back.")
10199 ;; Fill and close the ring
10200 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10201 (loop for i from 1 to org-mark-ring-length do
10202 (push (make-marker) org-mark-ring))
10203 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10204 org-mark-ring)
10206 (defun org-mark-ring-push (&optional pos buffer)
10207 "Put the current position or POS into the mark ring and rotate it."
10208 (interactive)
10209 (setq pos (or pos (point)))
10210 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10211 (move-marker (car org-mark-ring)
10212 (or pos (point))
10213 (or buffer (current-buffer)))
10214 (message "%s"
10215 (substitute-command-keys
10218 (defun org-mark-ring-goto (&optional n)
10219 "Jump to the previous position in the mark ring.
10220 With prefix arg N, jump back that many stored positions. When
10221 called several times in succession, walk through the entire ring.
10222 Org-mode commands jumping to a different position in the current file,
10223 or to another Org-mode file, automatically push the old position
10224 onto the ring."
10225 (interactive "p")
10226 (let (p m)
10227 (if (eq last-command this-command)
10228 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10229 (setq p org-mark-ring))
10230 (setq org-mark-ring-last-goto p)
10231 (setq m (car p))
10232 (org-pop-to-buffer-same-window (marker-buffer m))
10233 (goto-char m)
10234 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10236 (defun org-remove-angle-brackets (s)
10237 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10238 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10239 s)
10240 (defun org-add-angle-brackets (s)
10241 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10242 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10243 s)
10244 (defun org-remove-double-quotes (s)
10247 s)
10249 ;;; Following specific links
10251 (defun org-follow-timestamp-link ()
10252 "Open an agenda view for the time-stamp date/range at point."
10253 (cond
10254 ((org-at-date-range-p t)
10255 (let ((org-agenda-start-on-weekday)
10256 (t1 (match-string 1))
10257 (t2 (match-string 2)) tt1 tt2)
10258 (setq tt1 (time-to-days (org-time-string-to-time t1))
10259 tt2 (time-to-days (org-time-string-to-time t2)))
10260 (let ((org-agenda-buffer-tmp-name
10261 (format "*Org Agenda(a:%s)"
10262 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10263 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10264 ((org-at-timestamp-p t)
10265 (let ((org-agenda-buffer-tmp-name
10266 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10267 (org-agenda-list nil (time-to-days (org-time-string-to-time
10268 (substring (match-string 1) 0 10)))
10269 1)))
10270 (t (error "This should not happen"))))
10273 ;;; Following file links
10274 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10275 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10276 (declare-function mailcap-mime-info
10277 "mailcap" (string &optional request no-decode))
10278 (defvar org-wait nil)
10279 (defun org-open-file (path &optional in-emacs line search)
10280 "Open the file at PATH.
10281 First, this expands any special file name abbreviations. Then the
10282 configuration variable `org-file-apps' is checked if it contains an
10283 entry for this file type, and if yes, the corresponding command is launched.
10285 If no application is found, Emacs simply visits the file.
10287 With optional prefix argument IN-EMACS, Emacs will visit the file.
10289 prefix arg, Org tries to avoid opening in Emacs
10290 and to use an external application to visit the file.
10292 Optional LINE specifies a line to go to, optional SEARCH a string
10293 to search for. If LINE or SEARCH is given, the file will be
10294 opened in Emacs, unless an entry from org-file-apps that makes
10295 use of groups in a regexp matches.
10297 If you want to change the way frames are used when following a
10298 link, please customize `org-link-frame-setup'.
10300 If the file does not exist, an error is thrown."
10301 (let* ((file (if (equal path "")
10302 buffer-file-name
10303 (substitute-in-file-name (expand-file-name path))))
10304 (file-apps (append org-file-apps (org-default-apps)))
10305 (apps (org-remove-if
10306 'org-file-apps-entry-match-against-dlink-p file-apps))
10307 (apps-dlink (org-remove-if-not
10308 'org-file-apps-entry-match-against-dlink-p file-apps))
10309 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10310 (dirp (if remp nil (file-directory-p file)))
10311 (file (if (and dirp org-open-directory-means-index-dot-org)
10312 (concat (file-name-as-directory file) "index.org")
10313 file))
10314 (a-m-a-p (assq 'auto-mode apps))
10315 (dfile (downcase file))
10316 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10317 (link (cond ((and (eq line nil)
10318 (eq search nil))
10319 file)
10320 (line
10321 (concat file "::" (number-to-string line)))
10322 (search
10323 (concat file "::" search))))
10324 (dlink (downcase link))
10325 (old-buffer (current-buffer))
10326 (old-pos (point))
10327 (old-mode major-mode)
10328 ext cmd link-match-data)
10330 (setq ext (match-string 1 dfile))
10332 (setq ext (match-string 1 dfile))))
10333 (cond
10334 ((member in-emacs '((16) system))
10335 (setq cmd (cdr (assoc 'system apps))))
10336 (in-emacs (setq cmd 'emacs))
10337 (t
10338 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10339 (and dirp (cdr (assoc 'directory apps)))
10340 ; first, try matching against apps-dlink
10341 ; if we get a match here, store the match data for later
10342 (let ((match (assoc-default dlink apps-dlink
10343 'string-match)))
10344 (if match
10345 (progn (setq link-match-data (match-data))
10346 match)
10347 (progn (setq in-emacs (or in-emacs line search))
10348 nil))) ; if we have no match in apps-dlink,
10349 ; always open the file in emacs if line or search
10350 ; is given (for backwards compatibility)
10351 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10352 'string-match)
10353 (cdr (assoc ext apps))
10354 (cdr (assoc t apps))))))
10355 (when (eq cmd 'system)
10356 (setq cmd (cdr (assoc 'system apps))))
10357 (when (eq cmd 'default)
10358 (setq cmd (cdr (assoc t apps))))
10359 (when (eq cmd 'mailcap)
10360 (require 'mailcap)
10361 (mailcap-parse-mailcaps)
10362 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10363 (command (mailcap-mime-info mime-type)))
10364 (if (stringp command)
10365 (setq cmd command)
10366 (setq cmd 'emacs))))
10367 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10368 (not (file-exists-p file))
10369 (not org-open-non-existing-files))
10370 (error "No such file: %s" file))
10371 (cond
10373 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10375 (setq cmd (replace-match "%s" t t cmd)))
10376 (while (string-match "%s" cmd)
10377 (setq cmd (replace-match
10378 (save-match-data
10379 (shell-quote-argument
10380 (convert-standard-filename file)))
10381 t t cmd)))
10383 ;; Replace "%1", "%2" etc. in command with group matches from regex
10384 (save-match-data
10385 (let ((match-index 1)
10386 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10387 (set-match-data link-match-data)
10388 (while (<= match-index number-of-groups)
10389 (let ((regex (concat "%" (number-to-string match-index)))
10390 (replace-with (match-string match-index dlink)))
10391 (while (string-match regex cmd)
10392 (setq cmd (replace-match replace-with t t cmd))))
10393 (setq match-index (+ match-index 1)))))
10395 (save-window-excursion
10396 (start-process-shell-command cmd nil cmd)
10397 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10398 ))
10399 ((or (stringp cmd)
10400 (eq cmd 'emacs))
10401 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10402 (widen)
10403 (if line (org-goto-line line)
10404 (if search (org-link-search search))))
10405 ((consp cmd)
10406 (let ((file (convert-standard-filename file)))
10407 (save-match-data
10408 (set-match-data link-match-data)
10409 (eval cmd))))
10410 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10411 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10412 (or (not (equal old-buffer (current-buffer)))
10413 (not (equal old-pos (point))))
10414 (org-mark-ring-push old-pos old-buffer))))
10416 (defun org-file-apps-entry-match-against-dlink-p (entry)
10417 "This function returns non-nil if `entry' uses a regular
10418 expression which should be matched against the whole link by
10419 org-open-file.
10421 It assumes that is the case when the entry uses a regular
10422 expression which has at least one grouping construct and the
10423 action is either a lisp form or a command string containing
10424 '%1', i.e. using at least one subexpression match as a
10425 parameter."
10426 (let ((selector (car entry))
10427 (action (cdr entry)))
10428 (if (stringp selector)
10429 (and (> (regexp-opt-depth selector) 0)
10430 (or (and (stringp action)
10431 (string-match "%[0-9]" action))
10432 (consp action)))
10433 nil)))
10435 (defun org-default-apps ()
10436 "Return the default applications for this operating system."
10437 (cond
10438 ((eq system-type 'darwin)
10439 org-file-apps-defaults-macosx)
10440 ((eq system-type 'windows-nt)
10441 org-file-apps-defaults-windowsnt)
10442 (t org-file-apps-defaults-gnu)))
10444 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10445 "Convert extensions to regular expressions in the cars of LIST.
10446 Also, weed out any non-string entries, because the return value is used
10447 only for regexp matching.
10448 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10449 point to the symbol `emacs', indicating that the file should
10450 be opened in Emacs."
10451 (append
10452 (delq nil
10453 (mapcar (lambda (x)
10454 (if (not (stringp (car x)))
10455 nil
10457 x
10459 list))
10460 (if add-auto-mode
10461 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10463 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10464 (defun org-file-remote-p (file)
10465 "Test whether FILE specifies a location on a remote system.
10466 Return non-nil if the location is indeed remote.
10470 (cond ((fboundp 'file-remote-p)
10471 (file-remote-p file))
10472 ((fboundp 'tramp-handle-file-remote-p)
10473 (tramp-handle-file-remote-p file))
10474 ((and (boundp 'ange-ftp-name-format)
10475 (string-match (car ange-ftp-name-format) file))
10476 t)))
10479 ;;;; Refiling
10481 (defun org-get-org-file ()
10482 "Read a filename, with default directory `org-directory'."
10483 (let ((default (or org-default-notes-file remember-data-file)))
10484 (read-file-name (format "File name [%s]: " default)
10485 (file-name-as-directory org-directory)
10486 default)))
10488 (defun org-notes-order-reversed-p ()
10489 "Check if the current file should receive notes in reversed order."
10490 (cond
10491 ((not org-reverse-note-order) nil)
10492 ((eq t org-reverse-note-order) t)
10493 ((not (listp org-reverse-note-order)) nil)
10494 (t (catch 'exit
10495 (let ((all org-reverse-note-order)
10496 entry)
10497 (while (setq entry (pop all))
10498 (if (string-match (car entry) buffer-file-name)
10499 (throw 'exit (cdr entry))))
10500 nil)))))
10502 (defvar org-refile-target-table nil
10503 "The list of refile targets, created by `org-refile'.")
10505 (defvar org-agenda-new-buffers nil
10506 "Buffers created to visit agenda files.")
10508 (defvar org-refile-cache nil
10509 "Cache for refile targets.")
10511 (defvar org-refile-markers nil
10512 "All the markers used for caching refile locations.")
10514 (defun org-refile-marker (pos)
10515 "Get a new refile marker, but only if caching is in use."
10516 (if (not org-refile-use-cache)
10517 pos
10518 (let ((m (make-marker)))
10519 (move-marker m pos)
10520 (push m org-refile-markers)
10521 m)))
10523 (defun org-refile-cache-clear ()
10524 "Clear the refile cache and disable all the markers."
10525 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10526 (setq org-refile-markers nil)
10527 (setq org-refile-cache nil)
10528 (message "Refile cache has been cleared"))
10530 (defun org-refile-cache-check-set (set)
10531 "Check if all the markers in the cache still have live buffers."
10532 (let (marker)
10533 (catch 'exit
10534 (while (and set (setq marker (nth 3 (pop set))))
10535 ;; if org-refile-use-outline-path is 'file, marker may be nil
10536 (when (and marker (null (marker-buffer marker)))
10537 (message "not found") (sit-for 3)
10538 (throw 'exit nil)))
10539 t)))
10541 (defun org-refile-cache-put (set &rest identifiers)
10542 "Push the refile targets SET into the cache, under IDENTIFIERS."
10543 (let* ((key (sha1 (prin1-to-string identifiers)))
10544 (entry (assoc key org-refile-cache)))
10545 (if entry
10546 (setcdr entry set)
10547 (push (cons key set) org-refile-cache))))
10549 (defun org-refile-cache-get (&rest identifiers)
10550 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10551 (cond
10552 ((not org-refile-cache) nil)
10553 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10554 (t
10555 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10556 org-refile-cache))))
10557 (and set (org-refile-cache-check-set set) set)))))
10559 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10560 "Produce a table with refile targets."
10561 (let ((case-fold-search nil)
10562 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10563 (entries (or org-refile-targets '((nil . (:level . 1)))))
10564 targets tgs txt re files f desc descre fast-path-p level pos0)
10565 (message "Getting targets...")
10566 (with-current-buffer (or default-buffer (current-buffer))
10567 (while (setq entry (pop entries))
10568 (setq files (car entry) desc (cdr entry))
10569 (setq fast-path-p nil)
10570 (cond
10571 ((null files) (setq files (list (current-buffer))))
10572 ((eq files 'org-agenda-files)
10573 (setq files (org-agenda-files 'unrestricted)))
10574 ((and (symbolp files) (fboundp files))
10575 (setq files (funcall files)))
10576 ((and (symbolp files) (boundp files))
10577 (setq files (symbol-value files))))
10578 (if (stringp files) (setq files (list files)))
10579 (cond
10580 ((eq (car desc) :tag)
10582 ((eq (car desc) :todo)
10584 ((eq (car desc) :regexp)
10585 (setq descre (cdr desc)))
10586 ((eq (car desc) :level)
10588 (if org-odd-levels-only
10589 (1- (* 2 (cdr desc)))
10590 (cdr desc)))
10592 ((eq (car desc) :maxlevel)
10593 (setq fast-path-p t)
10595 (if org-odd-levels-only
10596 (1- (* 2 (cdr desc)))
10597 (cdr desc)))
10599 (t (error "Bad refiling target description %s" desc)))
10600 (while (setq f (pop files))
10601 (with-current-buffer
10602 (if (bufferp f) f (org-get-agenda-file-buffer f))
10603 (or
10604 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10605 (progn
10606 (if (bufferp f) (setq f (buffer-file-name
10607 (buffer-base-buffer f))))
10608 (setq f (and f (expand-file-name f)))
10609 (if (eq org-refile-use-outline-path 'file)
10610 (push (list (file-name-nondirectory f) f nil nil) tgs))
10611 (save-excursion
10612 (save-restriction
10613 (widen)
10614 (goto-char (point-min))
10615 (while (re-search-forward descre nil t)
10616 (goto-char (setq pos0 (point-at-bol)))
10617 (catch 'next
10618 (when org-refile-target-verify-function
10619 (save-match-data
10620 (or (funcall org-refile-target-verify-function)
10621 (throw 'next t))))
10622 (when (and (looking-at org-complex-heading-regexp)
10623 (not (member (match-string 4) excluded-entries))
10624 (match-string 4))
10625 (setq level (org-reduced-level
10626 (- (match-end 1) (match-beginning 1)))
10627 txt (org-link-display-format (match-string 4))
10629 re (format org-complex-heading-regexp-format
10630 (regexp-quote (match-string 4))))
10631 (when org-refile-use-outline-path
10632 (setq txt (mapconcat
10633 'org-protect-slash
10634 (append
10635 (if (eq org-refile-use-outline-path
10636 'file)
10637 (list (file-name-nondirectory
10638 (buffer-file-name
10639 (buffer-base-buffer))))
10640 (if (eq org-refile-use-outline-path
10641 'full-file-path)
10642 (list (buffer-file-name
10643 (buffer-base-buffer)))))
10644 (org-get-outline-path fast-path-p
10645 level txt)
10646 (list txt))
10647 "/")))
10648 (push (list txt f re (org-refile-marker (point)))
10649 tgs)))
10650 (when (= (point) pos0)
10651 ;; verification function has not moved point
10652 (goto-char (point-at-eol))))))))
10653 (when org-refile-use-cache
10654 (org-refile-cache-put tgs (buffer-file-name) descre))
10655 (setq targets (append tgs targets))
10656 ))))
10657 (message "Getting targets...done")
10658 (nreverse targets)))
10660 (defun org-protect-slash (s)
10661 (while (string-match "/" s)
10663 s)
10665 (defvar org-olpa (make-vector 20 nil))
10667 (defun org-get-outline-path (&optional fastp level heading)
10668 "Return the outline path to the current entry, as a list.
10670 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10671 routine which makes outline path derivations for an entire file,
10672 avoiding backtracing. Refile target collection makes use of that."
10673 (if fastp
10674 (progn
10675 (if (> level 19)
10676 (error "Outline path failure, more than 19 levels"))
10677 (loop for i from level upto 19 do
10678 (aset org-olpa i nil))
10679 (prog1
10680 (delq nil (append org-olpa nil))
10681 (aset org-olpa level heading)))
10682 (let (rtn case-fold-search)
10683 (save-excursion
10684 (save-restriction
10685 (widen)
10686 (while (org-up-heading-safe)
10687 (when (looking-at org-complex-heading-regexp)
10688 (push (org-match-string-no-properties 4) rtn)))
10689 rtn)))))
10691 (defun org-format-outline-path (path &optional width prefix)
10692 "Format the outline path PATH for display.
10693 Width is the maximum number of characters that is available.
10694 Prefix is a prefix to be included in the returned string,
10695 such as the file name."
10696 (setq width (or width 79))
10697 (if prefix (setq width (- width (length prefix))))
10698 (if (not path)
10699 (or prefix "")
10700 (let* ((nsteps (length path))
10701 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10702 (maxwidth (if (<= total-width width)
10703 10000 ;; everything fits
10704 ;; we need to shorten the level headings
10705 (/ (- width nsteps) nsteps)))
10706 (org-odd-levels-only nil)
10707 (n 0)
10708 (total (1+ (length prefix))))
10709 (setq maxwidth (max maxwidth 10))
10710 (concat prefix
10711 (mapconcat
10712 (lambda (h)
10713 (setq n (1+ n))
10714 (if (and (= n nsteps) (< maxwidth 10000))
10715 (setq maxwidth (- total-width total)))
10716 (if (< (length h) maxwidth)
10717 (progn (setq total (+ total (length h) 1)) h)
10718 (setq h (substring h 0 (- maxwidth 2))
10719 total (+ total maxwidth 1))
10721 (setq h (substring h 0 (match-beginning 0))))
10722 (setq h (concat h "..")))
10723 (org-add-props h nil 'face
10724 (nth (% (1- n) org-n-level-faces)
10725 org-level-faces))
10726 h)
10727 path "/")))))
10729 (defun org-display-outline-path (&optional file current)
10730 "Display the current outline path in the echo area."
10731 (interactive "P")
10732 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10733 (case-fold-search nil)
10734 (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
10735 (if current (setq path (append path
10736 (save-excursion
10737 (org-back-to-heading t)
10738 (if (looking-at org-complex-heading-regexp)
10739 (list (match-string 4)))))))
10740 (message "%s"
10741 (org-format-outline-path
10742 path
10743 (1- (frame-width))
10744 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10746 (defvar org-refile-history nil
10747 "History for refiling operations.")
10749 (defvar org-after-refile-insert-hook nil
10750 "Hook run after `org-refile' has inserted its stuff at the new location.
10751 Note that this is still *before* the stuff will be removed from
10752 the *old* location.")
10754 (defvar org-capture-last-stored-marker)
10755 (defun org-refile (&optional goto default-buffer rfloc)
10756 "Move the entry or entries at point to another heading.
10757 The list of target headings is compiled using the information in
10758 `org-refile-targets', which see.
10760 At the target location, the entry is filed as a subitem of the target
10761 heading. Depending on `org-reverse-note-order', the new subitem will
10762 either be the first or the last subitem.
10764 If there is an active region, all entries in that region will be moved.
10765 However, the region must fulfill the requirement that the first heading
10766 is the first one sets the top-level of the moved text - at most siblings
10767 below it are allowed.
10769 With prefix arg GOTO, the command will only visit the target location
10770 and not actually move anything.
10773 go to the location where the last refiling operation has put the subtree.
10774 With a prefix argument of `2', refile to the running clock.
10776 RFLOC can be a refile location obtained in a different way.
10778 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10780 If you are using target caching (see `org-refile-use-cache'),
10781 you have to clear the target cache in order to find new targets.
10782 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10783 prefix argument (`C-u C-u C-u C-c C-w')."
10785 (interactive "P")
10786 (if (member goto '(0 (64)))
10787 (org-refile-cache-clear)
10788 (let* ((cbuf (current-buffer))
10789 (regionp (org-region-active-p))
10790 (region-start (and regionp (region-beginning)))
10791 (region-end (and regionp (region-end)))
10792 (region-length (and regionp (- region-end region-start)))
10793 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10794 pos it nbuf file re level reversed)
10795 (setq last-command nil)
10796 (when regionp
10797 (goto-char region-start)
10798 (or (bolp) (goto-char (point-at-bol)))
10799 (setq region-start (point))
10800 (unless (or (org-kill-is-subtree-p
10801 (buffer-substring region-start region-end))
10802 (prog1 org-refile-active-region-within-subtree
10803 (org-toggle-heading)))
10804 (error "The region is not a (sequence of) subtree(s)")))
10805 (if (equal goto '(16))
10806 (org-refile-goto-last-stored)
10807 (when (or
10808 (and (equal goto 2)
10809 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10810 (prog1
10811 (setq it (list (or org-clock-heading "running clock")
10812 (buffer-file-name
10813 (marker-buffer org-clock-hd-marker))
10814 ""
10815 (marker-position org-clock-hd-marker)))
10816 (setq goto nil)))
10817 (setq it (or rfloc
10818 (let (heading-text)
10819 (save-excursion
10820 (unless goto
10821 (org-back-to-heading t)
10822 (setq heading-text
10823 (nth 4 (org-heading-components))))
10824 (org-refile-get-location
10825 (cond (goto "Goto")
10826 (regionp "Refile region to")
10829 default-buffer
10830 (and (not (equal '(4) goto))
10831 org-refile-allow-creating-parent-nodes)
10832 goto))))))
10833 (setq file (nth 1 it)
10834 re (nth 2 it)
10835 pos (nth 3 it))
10836 (if (and (not goto)
10837 pos
10838 (equal (buffer-file-name) file)
10839 (if regionp
10840 (and (>= pos region-start)
10841 (<= pos region-end))
10842 (and (>= pos (point))
10843 (< pos (save-excursion
10844 (org-end-of-subtree t t))))))
10845 (error "Cannot refile to position inside the tree or region"))
10847 (setq nbuf (or (find-buffer-visiting file)
10848 (find-file-noselect file)))
10849 (if goto
10850 (progn
10851 (org-pop-to-buffer-same-window nbuf)
10852 (goto-char pos)
10853 (org-show-context 'org-goto))
10854 (if regionp
10855 (progn
10856 (org-kill-new (buffer-substring region-start region-end))
10857 (org-save-markers-in-region region-start region-end))
10858 (org-copy-subtree 1 nil t))
10859 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10860 (find-file-noselect file)))
10861 (setq reversed (org-notes-order-reversed-p))
10862 (save-excursion
10863 (save-restriction
10864 (widen)
10865 (if pos
10866 (progn
10867 (goto-char pos)
10868 (looking-at org-outline-regexp)
10869 (setq level (org-get-valid-level (funcall outline-level) 1))
10870 (goto-char
10871 (if reversed
10872 (or (outline-next-heading) (point-max))
10873 (or (save-excursion (org-get-next-sibling))
10874 (org-end-of-subtree t t)
10875 (point-max)))))
10876 (setq level 1)
10877 (if (not reversed)
10878 (goto-char (point-max))
10879 (goto-char (point-min))
10880 (or (outline-next-heading) (goto-char (point-max)))))
10881 (if (not (bolp)) (newline))
10882 (org-paste-subtree level)
10883 (when org-log-refile
10884 (org-add-log-setup 'refile nil nil 'findpos
10885 org-log-refile)
10886 (unless (eq org-log-refile 'note)
10887 (save-excursion (org-add-log-note))))
10888 (and org-auto-align-tags
10889 (let ((org-loop-over-headlines-in-active-region nil))
10890 (org-set-tags nil t)))
10891 (with-demoted-errors
10892 (bookmark-set "org-refile-last-stored"))
10893 ;; If we are refiling for capture, make sure that the
10894 ;; last-capture pointers point here
10895 (when (org-bound-and-true-p org-refile-for-capture)
10896 (with-demoted-errors
10897 (bookmark-set "org-capture-last-stored-marker"))
10898 (move-marker org-capture-last-stored-marker (point)))
10899 (if (fboundp 'deactivate-mark) (deactivate-mark))
10900 (run-hooks 'org-after-refile-insert-hook))))
10901 (if regionp
10902 (delete-region (point) (+ (point) region-length))
10903 (org-cut-subtree))
10904 (when (featurep 'org-inlinetask)
10905 (org-inlinetask-remove-END-maybe))
10906 (setq org-markers-to-move nil)
10909 (defun org-refile-goto-last-stored ()
10910 "Go to the location where the last refile was stored."
10911 (interactive)
10912 (bookmark-jump "org-refile-last-stored")
10913 (message "This is the location of the last refile"))
10915 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10916 no-exclude)
10917 "Prompt the user for a refile location, using PROMPT.
10918 PROMPT should not be suffixed with a colon and a space, because
10919 this function appends the default value from
10920 `org-refile-history' automatically, if that is not empty.
10921 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10922 this is used for the GOTO interface."
10923 (let ((org-refile-targets org-refile-targets)
10924 (org-refile-use-outline-path org-refile-use-outline-path)
10925 excluded-entries)
10926 (when (and (derived-mode-p 'org-mode)
10927 (not org-refile-use-cache)
10928 (not no-exclude))
10929 (org-map-tree
10930 (lambda()
10931 (setq excluded-entries
10932 (append excluded-entries (list (org-get-heading t t)))))))
10933 (setq org-refile-target-table
10934 (org-refile-get-targets default-buffer excluded-entries)))
10935 (unless org-refile-target-table
10936 (error "No refile targets"))
10937 (let* ((prompt (concat prompt
10938 (and (car org-refile-history)
10939 (concat " (default " (car org-refile-history) ")"))
10940 ": "))
10941 (cbuf (current-buffer))
10942 (partial-completion-mode nil)
10943 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10944 (cfunc (if (and org-refile-use-outline-path
10945 org-outline-path-complete-in-steps)
10946 'org-olpath-completing-read
10947 'org-icompleting-read))
10948 (extra (if org-refile-use-outline-path "/" ""))
10949 (filename (and cfn (expand-file-name cfn)))
10950 (tbl (mapcar
10951 (lambda (x)
10952 (if (and (not (member org-refile-use-outline-path
10953 '(file full-file-path)))
10954 (not (equal filename (nth 1 x))))
10955 (cons (concat (car x) extra " ("
10956 (file-name-nondirectory (nth 1 x)) ")")
10957 (cdr x))
10958 (cons (concat (car x) extra) (cdr x))))
10959 org-refile-target-table))
10960 (completion-ignore-case t)
10961 pa answ parent-target child parent old-hist)
10962 (setq old-hist org-refile-history)
10963 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10964 nil 'org-refile-history (car org-refile-history)))
10965 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10966 (org-refile-check-position pa)
10967 (if pa
10968 (progn
10969 (when (or (not org-refile-history)
10970 (not (eq old-hist org-refile-history))
10971 (not (equal (car pa) (car org-refile-history))))
10972 (setq org-refile-history
10973 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10974 org-refile-history
10975 (cdr org-refile-history))))
10976 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10977 (pop org-refile-history)))
10978 pa)
10980 (progn
10981 (setq parent (match-string 1 answ)
10982 child (match-string 2 answ))
10983 (setq parent-target (or (assoc parent tbl)
10984 (assoc (concat parent "/") tbl)))
10985 (when (and parent-target
10986 (or (eq new-nodes t)
10987 (and (eq new-nodes 'confirm)
10989 child)))))
10990 (org-refile-new-child parent-target child)))
10991 (error "Invalid target location")))))
10993 (declare-function org-string-nw-p "org-macs" (s))
10994 (defun org-refile-check-position (refile-pointer)
10995 "Check if the refile pointer matches the headline to which it points."
10996 (let* ((file (nth 1 refile-pointer))
10997 (re (nth 2 refile-pointer))
10998 (pos (nth 3 refile-pointer))
10999 buffer)
11000 (if (and (not (markerp pos)) (not file))
11001 (error "Please save the buffer to a file before refiling")
11002 (when (org-string-nw-p re)
11003 (setq buffer (if (markerp pos)
11004 (marker-buffer pos)
11005 (or (find-buffer-visiting file)
11006 (find-file-noselect file))))
11007 (with-current-buffer buffer
11008 (save-excursion
11009 (save-restriction
11010 (widen)
11011 (goto-char pos)
11012 (beginning-of-line 1)
11013 (unless (org-looking-at-p re)
11014 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11016 (defun org-refile-new-child (parent-target child)
11017 "Use refile target PARENT-TARGET to add new CHILD below it."
11018 (unless parent-target
11019 (error "Cannot find parent for new node"))
11020 (let ((file (nth 1 parent-target))
11021 (pos (nth 3 parent-target))
11022 level)
11023 (with-current-buffer (or (find-buffer-visiting file)
11024 (find-file-noselect file))
11025 (save-excursion
11026 (save-restriction
11027 (widen)
11028 (if pos
11029 (goto-char pos)
11030 (goto-char (point-max))
11031 (if (not (bolp)) (newline)))
11032 (when (looking-at org-outline-regexp)
11033 (setq level (funcall outline-level))
11034 (org-end-of-subtree t t))
11035 (org-back-over-empty-lines)
11037 (if pos (org-get-valid-level level 1) 1) ?*)
11039 (beginning-of-line 0)
11040 (list (concat (car parent-target) "/" child) file "" (point)))))))
11042 (defun org-olpath-completing-read (prompt collection &rest args)
11043 "Read an outline path like a file name."
11044 (let ((thetable collection)
11045 (org-completion-use-ido nil) ; does not work with ido.
11046 (org-completion-use-iswitchb nil)) ; or iswitchb
11047 (apply
11048 'org-icompleting-read prompt
11049 (lambda (string predicate &optional flag)
11050 (let (rtn r f (l (length string)))
11051 (cond
11052 ((eq flag nil)
11053 ;; try completion
11054 (try-completion string thetable))
11055 ((eq flag t)
11056 ;; all-completions
11057 (setq rtn (all-completions string thetable predicate))
11058 (mapcar
11059 (lambda (x)
11060 (setq r (substring x l))
11061 (if (string-match " ([^)]*)$" x)
11062 (setq f (match-string 0 x))
11063 (setq f ""))
11064 (if (string-match "/" r)
11065 (concat string (substring r 0 (match-end 0)) f)
11066 x))
11067 rtn))
11068 ((eq flag 'lambda)
11069 ;; exact match?
11070 (assoc string thetable)))))
11071 args)))
11073 ;;;; Dynamic blocks
11075 (defun org-find-dblock (name)
11076 "Find the first dynamic block with name NAME in the buffer.
11077 If not found, stay at current position and return nil."
11078 (let ((case-fold-search t) pos)
11079 (save-excursion
11080 (goto-char (point-min))
11081 (setq pos (and (re-search-forward
11083 (match-beginning 0))))
11084 (if pos (goto-char pos))
11085 pos))
11087 (defconst org-dblock-start-re
11089 "Matches the start line of a dynamic block, with parameters.")
11092 "Matches the end of a dynamic block.")
11094 (defun org-create-dblock (plist)
11095 "Create a dynamic block section, with parameters taken from PLIST.
11096 PLIST must contain a :name entry which is used as name of the block."
11098 (end-of-line 1)
11099 (newline))
11100 (let ((col (current-column))
11101 (name (plist-get plist :name)))
11102 (insert "#+BEGIN: " name)
11103 (while plist
11104 (if (eq (car plist) :name)
11105 (setq plist (cddr plist))
11106 (insert " " (prin1-to-string (pop plist)))))
11108 (beginning-of-line -2)))
11110 (defun org-prepare-dblock ()
11111 "Prepare dynamic block for refresh.
11112 This empties the block, puts the cursor at the insert position and returns
11113 the property list including an extra property :name with the block name."
11114 (unless (looking-at org-dblock-start-re)
11115 (error "Not at a dynamic block"))
11116 (let* ((begdel (1+ (match-end 0)))
11117 (name (org-no-properties (match-string 1)))
11118 (params (append (list :name name)
11119 (read (concat "(" (match-string 3) ")")))))
11120 (save-excursion
11121 (beginning-of-line 1)
11123 (setq params (plist-put params :indentation-column (current-column))))
11124 (unless (re-search-forward org-dblock-end-re nil t)
11125 (error "Dynamic block not terminated"))
11126 (setq params
11127 (append params
11128 (list :content (buffer-substring
11129 begdel (match-beginning 0)))))
11130 (delete-region begdel (match-beginning 0))
11131 (goto-char begdel)
11132 (open-line 1)
11133 params))
11135 (defun org-map-dblocks (&optional command)
11136 "Apply COMMAND to all dynamic blocks in the current buffer.
11137 If COMMAND is not given, use `org-update-dblock'."
11138 (let ((cmd (or command 'org-update-dblock)))
11139 (save-excursion
11140 (goto-char (point-min))
11141 (while (re-search-forward org-dblock-start-re nil t)
11142 (goto-char (match-beginning 0))
11143 (save-excursion
11144 (condition-case nil
11145 (funcall cmd)
11146 (error (message "Error during update of dynamic block"))))
11147 (unless (re-search-forward org-dblock-end-re nil t)
11148 (error "Dynamic block not terminated"))))))
11150 (defun org-dblock-update (&optional arg)
11151 "User command for updating dynamic blocks.
11152 Update the dynamic block at point. With prefix ARG, update all dynamic
11153 blocks in the buffer."
11154 (interactive "P")
11155 (if arg
11156 (org-update-all-dblocks)
11157 (or (looking-at org-dblock-start-re)
11158 (org-beginning-of-dblock))
11159 (org-update-dblock)))
11161 (defun org-update-dblock ()
11162 "Update the dynamic block at point.
11163 This means to empty the block, parse for parameters and then call
11164 the correct writing function."
11165 (interactive)
11166 (save-window-excursion
11167 (let* ((pos (point))
11168 (line (org-current-line))
11169 (params (org-prepare-dblock))
11170 (name (plist-get params :name))
11171 (indent (plist-get params :indentation-column))
11172 (cmd (intern (concat "org-dblock-write:" name))))
11173 (message "Updating dynamic block `%s' at line %d..." name line)
11174 (funcall cmd params)
11175 (message "Updating dynamic block `%s' at line %d...done" name line)
11176 (goto-char pos)
11177 (when (and indent (> indent 0))
11178 (setq indent (make-string indent ?\ ))
11179 (save-excursion
11180 (org-beginning-of-dblock)
11181 (forward-line 1)
11182 (while (not (looking-at org-dblock-end-re))
11183 (insert indent)
11184 (beginning-of-line 2))
11185 (when (looking-at org-dblock-end-re)
11187 (replace-match ""))
11188 (insert indent)))))))
11190 (defun org-beginning-of-dblock ()
11191 "Find the beginning of the dynamic block at point.
11192 Error if there is no such block at point."
11193 (let ((pos (point))
11194 beg)
11195 (end-of-line 1)
11196 (if (and (re-search-backward org-dblock-start-re nil t)
11197 (setq beg (match-beginning 0))
11198 (re-search-forward org-dblock-end-re nil t)
11199 (> (match-end 0) pos))
11200 (goto-char beg)
11201 (goto-char pos)
11202 (error "Not in a dynamic block"))))
11204 (defun org-update-all-dblocks ()
11205 "Update all dynamic blocks in the buffer.
11206 This function can be used in a hook."
11207 (interactive)
11208 (when (derived-mode-p 'org-mode)
11209 (org-map-dblocks 'org-update-dblock)))
11212 ;;;; Completion
11214 (defconst org-additional-option-like-keywords
11215 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11216 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11217 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11218 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11219 "BEGIN:" "END:"
11220 "ORGTBL" "TBLFM:" "TBLNAME:"
11221 "BEGIN_EXAMPLE" "END_EXAMPLE"
11222 "BEGIN_VERBATIM" "END_VERBATIM"
11223 "BEGIN_QUOTE" "END_QUOTE"
11224 "BEGIN_VERSE" "END_VERSE"
11225 "BEGIN_CENTER" "END_CENTER"
11226 "BEGIN_SRC" "END_SRC"
11227 "BEGIN_RESULT" "END_RESULT"
11228 "BEGIN_lstlisting" "END_lstlisting"
11229 "NAME:" "RESULTS:"
11230 "HEADER:" "HEADERS:"
11231 "COLUMNS:" "PROPERTY:"
11232 "CAPTION:" "LABEL:"
11233 "SETUPFILE:"
11234 "INCLUDE:" "INDEX:"
11235 "BIND:"
11236 "MACRO:"))
11238 (defconst org-options-keywords
11239 '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
11240 "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
11241 "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
11242 "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
11243 "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
11244 "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:" "STYLE:"
11245 "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
11247 (defconst org-additional-option-like-keywords-for-flyspell
11248 (delete-dups
11249 (split-string
11250 (mapconcat (lambda(k)
11251 (replace-regexp-in-string
11253 (concat k " " (downcase k) " " (upcase k))))
11254 (append org-options-keywords org-additional-option-like-keywords)
11255 " ")
11256 " +" t)))
11258 (defcustom org-structure-template-alist
11273 ("L" "#+LaTeX: "
11277 ("H" "#+HTML: "
11280 ("A" "#+ASCII: ")
11281 ("i" "#+INDEX: ?"
11282 "#+INDEX: ?")
11283 ("I" "#+INCLUDE: %file ?"
11285 "Structure completion elements.
11286 This is a list of abbreviation keys and values. The value gets inserted
11287 if you type `<' followed by the key and then press the completion key,
11288 usually `M-TAB'. %file will be replaced by a file name after prompting
11289 for the file using completion. The cursor will be placed at the position
11290 of the `?` in the template.
11291 There are two templates for each key, the first uses the original Org syntax,
11292 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11293 the default when the /org-mtags.el/ module has been loaded. See also the
11294 variable `org-mtags-prefer-muse-templates'."
11295 :group 'org-completion
11296 :type '(repeat
11297 (string :tag "Key")
11298 (string :tag "Template")
11299 (string :tag "Muse Template")))
11301 (defun org-try-structure-completion ()
11302 "Try to complete a structure template before point.
11304 expands them."
11305 (let ((l (buffer-substring (point-at-bol) (point)))
11306 a)
11309 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11310 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11311 (match-beginning 1)) a)
11312 t)))
11314 (defun org-complete-expand-structure-template (start cell)
11315 "Expand a structure template."
11316 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11317 (rpl (nth (if musep 2 1) cell))
11318 (ind ""))
11319 (delete-region start (point))
11321 (cond
11322 ((bolp))
11324 (setq ind (buffer-substring (point-at-bol) (point))))
11325 (t (newline))))
11326 (setq start (point))
11327 (if (string-match "%file" rpl)
11328 (setq rpl (replace-match
11329 (concat
11331 (save-match-data
11332 (abbreviate-file-name (read-file-name "Include file: ")))
11334 t t rpl)))
11337 (insert rpl)
11340 ;;;; TODO, DEADLINE, Comments
11342 (defun org-toggle-comment ()
11343 "Change the COMMENT state of an entry."
11344 (interactive)
11345 (save-excursion
11346 (org-back-to-heading)
11347 (let (case-fold-search)
11348 (cond
11349 ((looking-at (format org-heading-keyword-regexp-format
11350 org-comment-string))
11351 (goto-char (match-end 1))
11352 (looking-at (concat " +" org-comment-string))
11353 (replace-match "" t t)
11354 (when (eolp) (insert " ")))
11355 ((looking-at org-outline-regexp)
11356 (goto-char (match-end 0))
11357 (insert org-comment-string " "))))))
11359 (defvar org-last-todo-state-is-todo nil
11360 "This is non-nil when the last TODO state change led to a TODO state.
11361 If the last change removed the TODO tag or switched to DONE, then
11362 this is nil.")
11364 (defvar org-setting-tags nil) ; dynamically skipped
11366 (defvar org-todo-setup-filter-hook nil
11367 "Hook for functions that pre-filter todo specs.
11368 Each function takes a todo spec and returns either nil or the spec
11369 transformed into canonical form." )
11371 (defvar org-todo-get-default-hook nil
11372 "Hook for functions that get a default item for todo.
11373 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11374 nil or a string to be used for the todo mark." )
11376 (defvar org-agenda-headline-snapshot-before-repeat)
11378 (defun org-current-effective-time ()
11379 "Return current time adjusted for `org-extend-today-until' variable."
11380 (let* ((ct (org-current-time))
11381 (dct (decode-time ct))
11382 (ct1
11383 (if (and org-use-effective-time
11384 (< (nth 2 dct) org-extend-today-until))
11385 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11386 ct)))
11387 ct1))
11389 (defun org-todo-yesterday (&optional arg)
11390 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11391 (interactive "P")
11392 (if (eq major-mode 'org-agenda-mode)
11393 (apply 'org-agenda-todo-yesterday arg)
11394 (let* ((hour (third (decode-time
11395 (org-current-time))))
11396 (org-extend-today-until (1+ hour)))
11397 (org-todo arg))))
11399 (defun org-todo (&optional arg)
11400 "Change the TODO state of an item.
11401 The state of an item is given by a keyword at the start of the heading,
11402 like
11403 *** TODO Write paper
11404 *** DONE Call mom
11406 The different keywords are specified in the variable `org-todo-keywords'.
11408 So for this example: when the item starts with TODO, it is changed to DONE.
11409 When it starts with DONE, the DONE is removed. And when neither TODO nor
11410 DONE are present, add TODO at the beginning of the heading.
11413 state.
11414 With numeric prefix arg, switch to that state.
11416 keywords (nextset).
11418 With a numeric prefix arg of 0, inhibit note taking for the change.
11420 For calling through lisp, arg is also interpreted in the following way:
11421 'none -> empty state
11423 'done -> switch to DONE
11424 'nextset -> switch to the next set of keywords
11425 'previousset -> switch to the previous set of keywords
11427 really is a member of `org-todo-keywords'."
11428 (interactive "P")
11429 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11430 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11431 'region-start-level 'region))
11432 org-loop-over-headlines-in-active-region)
11433 (org-map-entries
11434 `(org-todo ,arg)
11435 org-loop-over-headlines-in-active-region
11436 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11437 (if (equal arg '(16)) (setq arg 'nextset))
11438 (let ((org-blocker-hook org-blocker-hook)
11439 commentp
11440 case-fold-search)
11441 (when (equal arg '(64))
11442 (setq arg nil org-blocker-hook nil))
11443 (when (and org-blocker-hook
11444 (or org-inhibit-blocking
11445 (org-entry-get nil "NOBLOCKING")))
11446 (setq org-blocker-hook nil))
11447 (save-excursion
11448 (catch 'exit
11449 (org-back-to-heading t)
11451 (org-toggle-comment)
11452 (setq commentp t))
11453 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11456 (let* ((match-data (match-data))
11457 (startpos (point-at-bol))
11458 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11459 (org-log-done org-log-done)
11460 (org-log-repeat org-log-repeat)
11461 (org-todo-log-states org-todo-log-states)
11462 (org-inhibit-logging
11463 (if (equal arg 0)
11464 (progn (setq arg nil) 'note) org-inhibit-logging))
11465 (this (match-string 1))
11466 (hl-pos (match-beginning 0))
11467 (head (org-get-todo-sequence-head this))
11468 (ass (assoc head org-todo-kwd-alist))
11469 (interpret (nth 1 ass))
11470 (done-word (nth 3 ass))
11471 (final-done-word (nth 4 ass))
11472 (org-last-state (or this ""))
11473 (completion-ignore-case t)
11474 (member (member this org-todo-keywords-1))
11475 (tail (cdr member))
11476 (org-state (cond
11477 ((and org-todo-key-trigger
11478 (or (and (equal arg '(4))
11479 (eq org-use-fast-todo-selection 'prefix))
11480 (and (not arg) org-use-fast-todo-selection
11481 (not (eq org-use-fast-todo-selection
11482 'prefix)))))
11483 ;; Use fast selection
11484 (org-fast-todo-selection))
11485 ((and (equal arg '(4))
11486 (or (not org-use-fast-todo-selection)
11487 (not org-todo-key-trigger)))
11488 ;; Read a state with completion
11489 (org-icompleting-read
11490 "State: " (mapcar (lambda(x) (list x))
11491 org-todo-keywords-1)
11492 nil t))
11493 ((eq arg 'right)
11494 (if this
11495 (if tail (car tail) nil)
11496 (car org-todo-keywords-1)))
11497 ((eq arg 'left)
11498 (if (equal member org-todo-keywords-1)
11499 nil
11500 (if this
11501 (nth (- (length org-todo-keywords-1)
11502 (length tail) 2)
11503 org-todo-keywords-1)
11504 (org-last org-todo-keywords-1))))
11505 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11506 (setq arg nil))) ; hack to fall back to cycling
11507 (arg
11508 ;; user or caller requests a specific state
11509 (cond
11510 ((equal arg "") nil)
11511 ((eq arg 'none) nil)
11512 ((eq arg 'done) (or done-word (car org-done-keywords)))
11513 ((eq arg 'nextset)
11514 (or (car (cdr (member head org-todo-heads)))
11515 (car org-todo-heads)))
11516 ((eq arg 'previousset)
11517 (let ((org-todo-heads (reverse org-todo-heads)))
11518 (or (car (cdr (member head org-todo-heads)))
11519 (car org-todo-heads))))
11520 ((car (member arg org-todo-keywords-1)))
11521 ((stringp arg)
11522 (error "State `%s' not valid in this file" arg))
11523 ((nth (1- (prefix-numeric-value arg))
11524 org-todo-keywords-1))))
11525 ((null member) (or head (car org-todo-keywords-1)))
11526 ((equal this final-done-word) nil) ;; -> make empty
11527 ((null tail) nil) ;; -> first entry
11528 ((memq interpret '(type priority))
11529 (if (eq this-command last-command)
11530 (car tail)
11531 (if (> (length tail) 0)
11532 (or done-word (car org-done-keywords))
11533 nil)))
11534 (t
11535 (car tail))))
11536 (org-state (or
11537 (run-hook-with-args-until-success
11538 'org-todo-get-default-hook org-state org-last-state)
11539 org-state))
11540 (next (if org-state (concat " " org-state " ") " "))
11541 (change-plist (list :type 'todo-state-change :from this :to org-state
11542 :position startpos))
11543 dolog now-done-p)
11544 (when org-blocker-hook
11545 (setq org-last-todo-state-is-todo
11546 (not (member this org-done-keywords)))
11547 (unless (save-excursion
11548 (save-match-data
11549 (org-with-wide-buffer
11550 (run-hook-with-args-until-failure
11551 'org-blocker-hook change-plist))))
11552 (if (org-called-interactively-p 'interactive)
11553 (error "TODO state change from %s to %s blocked" this org-state)
11554 ;; fail silently
11555 (message "TODO state change from %s to %s blocked" this org-state)
11556 (throw 'exit nil))))
11557 (store-match-data match-data)
11558 (replace-match next t t)
11559 (unless (pos-visible-in-window-p hl-pos)
11560 (message "TODO state changed to %s" (org-trim next)))
11561 (unless head
11562 (setq head (org-get-todo-sequence-head org-state)
11563 ass (assoc head org-todo-kwd-alist)
11564 interpret (nth 1 ass)
11565 done-word (nth 3 ass)
11566 final-done-word (nth 4 ass)))
11567 (when (memq arg '(nextset previousset))
11568 (message "Keyword-Set %d/%d: %s"
11569 (- (length org-todo-sets) -1
11570 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11571 (length org-todo-sets)
11572 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11573 (setq org-last-todo-state-is-todo
11574 (not (member org-state org-done-keywords)))
11575 (setq now-done-p (and (member org-state org-done-keywords)
11576 (not (member this org-done-keywords))))
11577 (and logging (org-local-logging logging))
11578 (when (and (or org-todo-log-states org-log-done)
11579 (not (eq org-inhibit-logging t))
11580 (not (memq arg '(nextset previousset))))
11581 ;; we need to look at recording a time and note
11582 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11583 (nth 2 (assoc this org-todo-log-states))))
11584 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11585 (setq dolog 'time))
11586 (when (and org-state
11587 (member org-state org-not-done-keywords)
11588 (not (member this org-not-done-keywords)))
11589 ;; This is now a todo state and was not one before
11590 ;; If there was a CLOSED time stamp, get rid of it.
11591 (org-add-planning-info nil nil 'closed))
11592 (when (and now-done-p org-log-done)
11593 ;; It is now done, and it was not done before
11594 (org-add-planning-info 'closed (org-current-effective-time))
11595 (if (and (not dolog) (eq 'note org-log-done))
11596 (org-add-log-setup 'done org-state this 'findpos 'note)))
11597 (when (and org-state dolog)
11598 ;; This is a non-nil state, and we need to log it
11599 (org-add-log-setup 'state org-state this 'findpos dolog)))
11600 ;; Fixup tag positioning
11601 (org-todo-trigger-tag-changes org-state)
11602 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11603 (when org-provide-todo-statistics
11604 (org-update-parent-todo-statistics))
11605 (run-hooks 'org-after-todo-state-change-hook)
11606 (if (and arg (not (member org-state org-done-keywords)))
11607 (setq head (org-get-todo-sequence-head org-state)))
11608 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11609 ;; Do we need to trigger a repeat?
11610 (when now-done-p
11611 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11612 ;; This is for the agenda, take a snapshot of the headline.
11613 (save-match-data
11614 (setq org-agenda-headline-snapshot-before-repeat
11615 (org-get-heading))))
11616 (org-auto-repeat-maybe org-state))
11617 ;; Fixup cursor location if close to the keyword
11618 (if (and (outline-on-heading-p)
11619 (not (bolp))
11620 (save-excursion (beginning-of-line 1)
11621 (looking-at org-todo-line-regexp))
11622 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11623 (progn
11624 (goto-char (or (match-end 2) (match-end 1)))
11625 (and (looking-at " ") (just-one-space))))
11626 (when org-trigger-hook
11627 (save-excursion
11628 (run-hook-with-args 'org-trigger-hook change-plist)))
11629 (when commentp (org-toggle-comment))))))))
11631 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11632 "Block turning an entry into a TODO, using the hierarchy.
11633 This checks whether the current task should be blocked from state
11634 changes. Such blocking occurs when:
11636 1. The task has children which are not all in a completed state.
11638 2. A task has a parent with the property :ORDERED:, and there
11639 are siblings prior to the current task with incomplete
11640 status.
11642 3. The parent of the task is blocked because it has siblings that should
11643 be done first, or is child of a block grandparent TODO entry."
11645 (if (not org-enforce-todo-dependencies)
11646 t ; if locally turned off don't block
11647 (catch 'dont-block
11648 ;; If this is not a todo state change, or if this entry is already DONE,
11649 ;; do not block
11650 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11651 (member (plist-get change-plist :from)
11652 (cons 'done org-done-keywords))
11653 (member (plist-get change-plist :to)
11654 (cons 'todo org-not-done-keywords))
11655 (not (plist-get change-plist :to)))
11656 (throw 'dont-block t))
11657 ;; If this task has children, and any are undone, it's blocked
11658 (save-excursion
11659 (org-back-to-heading t)
11660 (let ((this-level (funcall outline-level)))
11661 (outline-next-heading)
11662 (let ((child-level (funcall outline-level)))
11663 (while (and (not (eobp))
11664 (> child-level this-level))
11665 ;; this todo has children, check whether they are all
11666 ;; completed
11667 (if (and (not (org-entry-is-done-p))
11668 (org-entry-is-todo-p))
11669 (throw 'dont-block nil))
11670 (outline-next-heading)
11671 (setq child-level (funcall outline-level))))))
11672 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11673 ;; any previous siblings are undone, it's blocked
11674 (save-excursion
11675 (org-back-to-heading t)
11676 (let* ((pos (point))
11677 (parent-pos (and (org-up-heading-safe) (point))))
11678 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11679 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11680 (forward-line 1)
11681 (re-search-forward org-not-done-heading-regexp pos t))
11682 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11683 ;; Search further up the hierarchy, to see if an ancestor is blocked
11684 (while t
11685 (goto-char parent-pos)
11686 (if (not (looking-at org-not-done-heading-regexp))
11687 (throw 'dont-block t)) ; do not block, parent is not a TODO
11688 (setq pos (point))
11689 (setq parent-pos (and (org-up-heading-safe) (point)))
11690 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11691 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11692 (forward-line 1)
11693 (re-search-forward org-not-done-heading-regexp pos t))
11694 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11696 (defcustom org-track-ordered-property-with-tag nil
11697 "Should the ORDERED property also be shown as a tag?
11698 The ORDERED property decides if an entry should require subtasks to be
11699 completed in sequence. Since a property is not very visible, setting
11700 this option means that toggling the ORDERED property with the command
11701 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11702 not relevant for the behavior, but it makes things more visible.
11704 Note that toggling the tag with tags commands will not change the property
11705 and therefore not influence behavior!
11707 This can be t, meaning the tag ORDERED should be used, It can also be a
11708 string to select a different tag for this task."
11709 :group 'org-todo
11710 :type '(choice
11711 (const :tag "No tracking" nil)
11712 (const :tag "Track with ORDERED tag" t)
11713 (string :tag "Use other tag")))
11715 (defun org-toggle-ordered-property ()
11716 "Toggle the ORDERED property of the current entry.
11717 For better visibility, you can track the value of this property with a tag.
11718 See variable `org-track-ordered-property-with-tag'."
11719 (interactive)
11720 (let* ((t1 org-track-ordered-property-with-tag)
11721 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11722 (save-excursion
11723 (org-back-to-heading)
11724 (if (org-entry-get nil "ORDERED")
11725 (progn
11726 (org-delete-property "ORDERED")
11727 (and tag (org-toggle-tag tag 'off))
11728 (message "Subtasks can be completed in arbitrary order"))
11729 (org-entry-put nil "ORDERED" "t")
11730 (and tag (org-toggle-tag tag 'on))
11731 (message "Subtasks must be completed in sequence")))))
11733 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11734 (defun org-block-todo-from-checkboxes (change-plist)
11735 "Block turning an entry into a TODO, using checkboxes.
11736 This checks whether the current task should be blocked from state
11737 changes because there are unchecked boxes in this entry."
11738 (if (not org-enforce-todo-checkbox-dependencies)
11739 t ; if locally turned off don't block
11740 (catch 'dont-block
11741 ;; If this is not a todo state change, or if this entry is already DONE,
11742 ;; do not block
11743 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11744 (member (plist-get change-plist :from)
11745 (cons 'done org-done-keywords))
11746 (member (plist-get change-plist :to)
11747 (cons 'todo org-not-done-keywords))
11748 (not (plist-get change-plist :to)))
11749 (throw 'dont-block t))
11750 ;; If this task has checkboxes that are not checked, it's blocked
11751 (save-excursion
11752 (org-back-to-heading t)
11753 (let ((beg (point)) end)
11754 (outline-next-heading)
11755 (setq end (point))
11756 (goto-char beg)
11757 (if (org-list-search-forward
11758 (concat (org-item-beginning-re)
11761 end t)
11762 (progn
11763 (if (boundp 'org-blocked-by-checkboxes)
11764 (setq org-blocked-by-checkboxes t))
11765 (throw 'dont-block nil)))))
11766 t))) ; do not block
11768 (defun org-entry-blocked-p ()
11769 "Is the current entry blocked?"
11770 (if (org-entry-get nil "NOBLOCKING")
11771 nil ;; Never block this entry
11772 (not
11773 (run-hook-with-args-until-failure
11774 'org-blocker-hook
11775 (list :type 'todo-state-change
11776 :position (point)
11777 :from 'todo
11778 :to 'done)))))
11780 (defun org-update-statistics-cookies (all)
11781 "Update the statistics cookie, either from TODO or from checkboxes.
11782 This should be called with the cursor in a line with a statistics cookie."
11783 (interactive "P")
11784 (if all
11785 (progn
11786 (org-update-checkbox-count 'all)
11787 (org-map-entries 'org-update-parent-todo-statistics))
11788 (if (not (org-at-heading-p))
11789 (org-update-checkbox-count)
11790 (let ((pos (point-marker))
11791 end l1 l2)
11792 (ignore-errors (org-back-to-heading t))
11793 (if (not (org-at-heading-p))
11794 (org-update-checkbox-count)
11795 (setq l1 (org-outline-level))
11796 (setq end (save-excursion
11797 (outline-next-heading)
11798 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11799 (point)))
11800 (if (and (save-excursion
11801 (re-search-forward
11803 (not (save-excursion (re-search-forward
11805 (org-update-checkbox-count)
11806 (if (and l2 (> l2 l1))
11807 (progn
11808 (goto-char end)
11809 (org-update-parent-todo-statistics))
11810 (goto-char pos)
11811 (beginning-of-line 1)
11812 (while (re-search-forward
11814 (point-at-eol) t)
11815 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11816 (goto-char pos)
11817 (move-marker pos nil)))))
11819 (defvar org-entry-property-inherited-from) ;; defined below
11820 (defun org-update-parent-todo-statistics ()
11821 "Update any statistics cookie in the parent of the current headline.
11822 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11823 the entire subtree and this will travel up the hierarchy and update
11824 statistics everywhere."
11825 (let* ((prop (save-excursion (org-up-heading-safe)
11826 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11827 (recursive (or (not org-hierarchical-todo-statistics)
11829 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11830 0))
11831 (first t)
11833 level ltoggle l1 new ndel
11834 (cnt-all 0) (cnt-done 0) is-percent kwd
11835 checkbox-beg ov ovs ove cookie-present)
11836 (catch 'exit
11837 (save-excursion
11838 (beginning-of-line 1)
11839 (setq ltoggle (funcall outline-level))
11840 ;; Three situations are to consider:
11842 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11843 ;; to the top-level ancestor on the headline;
11845 ;; 2. If parent has "recursive" property, repeat up to the
11846 ;; headline setting that property, taking inheritance into
11847 ;; account;
11849 ;; 3. Else, move up to direct parent and proceed only once.
11850 (while (and (setq level (org-up-heading-safe))
11851 (or recursive first)
11852 (>= (point) lim))
11853 (setq first nil cookie-present nil)
11854 (unless (and level
11855 (not (string-match
11857 (downcase (or (org-entry-get nil "COOKIE_DATA")
11858 "")))))
11859 (throw 'exit nil))
11860 (while (re-search-forward box-re (point-at-eol) t)
11861 (setq cnt-all 0 cnt-done 0 cookie-present t)
11862 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11863 (save-match-data
11864 (unless (outline-next-heading) (throw 'exit nil))
11865 (while (and (looking-at org-complex-heading-regexp)
11866 (> (setq l1 (length (match-string 1))) level))
11867 (setq kwd (and (or recursive (= l1 ltoggle))
11868 (match-string 2)))
11869 (if (or (eq org-provide-todo-statistics 'all-headlines)
11870 (and (listp org-provide-todo-statistics)
11871 (or (member kwd org-provide-todo-statistics)
11872 (member kwd org-done-keywords))))
11873 (setq cnt-all (1+ cnt-all))
11874 (if (eq org-provide-todo-statistics t)
11875 (and kwd (setq cnt-all (1+ cnt-all)))))
11876 (and (member kwd org-done-keywords)
11877 (setq cnt-done (1+ cnt-done)))
11878 (outline-next-heading)))
11879 (setq new
11880 (if is-percent
11881 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11882 (format "[%d/%d]" cnt-done cnt-all))
11883 ndel (- (match-end 0) checkbox-beg))
11884 ;; handle overlays when updating cookie from column view
11885 (when (setq ov (car (overlays-at checkbox-beg)))
11886 (setq ovs (overlay-start ov) ove (overlay-end ov))
11887 (delete-overlay ov))
11888 (goto-char checkbox-beg)
11889 (insert new)
11890 (delete-region (point) (+ (point) ndel))
11891 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11892 (when ov (move-overlay ov ovs ove)))
11893 (when cookie-present
11894 (run-hook-with-args 'org-after-todo-statistics-hook
11895 cnt-done (- cnt-all cnt-done))))))
11896 (run-hooks 'org-todo-statistics-hook)))
11898 (defvar org-after-todo-statistics-hook nil
11899 "Hook that is called after a TODO statistics cookie has been updated.
11900 Each function is called with two arguments: the number of not-done entries
11901 and the number of done entries.
11903 For example, the following function, when added to this hook, will switch
11904 an entry to DONE when all children are done, and back to TODO when new
11905 entries are set to a TODO status. Note that this hook is only called
11906 when there is a statistics cookie in the headline!
11908 (defun org-summary-todo (n-done n-not-done)
11910 (let (org-log-done org-log-states) ; turn off logging
11912 ")
11914 (defvar org-todo-statistics-hook nil
11915 "Hook that is run whenever Org thinks TODO statistics should be updated.
11916 This hook runs even if there is no statistics cookie present, in which case
11917 `org-after-todo-statistics-hook' would not run.")
11919 (defun org-todo-trigger-tag-changes (state)
11920 "Apply the changes defined in `org-todo-state-tags-triggers'."
11921 (let ((l org-todo-state-tags-triggers)
11922 changes)
11923 (when (or (not state) (equal state ""))
11924 (setq changes (append changes (cdr (assoc "" l)))))
11925 (when (and (stringp state) (> (length state) 0))
11926 (setq changes (append changes (cdr (assoc state l)))))
11927 (when (member state org-not-done-keywords)
11928 (setq changes (append changes (cdr (assoc 'todo l)))))
11929 (when (member state org-done-keywords)
11930 (setq changes (append changes (cdr (assoc 'done l)))))
11931 (dolist (c changes)
11932 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11934 (defun org-local-logging (value)
11935 "Get logging settings from a property VALUE."
11936 (let* (words w a)
11937 ;; directly set the variables, they are already local.
11938 (setq org-log-done nil
11939 org-log-repeat nil
11940 org-todo-log-states nil)
11941 (setq words (org-split-string value))
11942 (while (setq w (pop words))
11943 (cond
11944 ((setq a (assoc w org-startup-options))
11945 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11946 (set (nth 1 a) (nth 2 a))))
11947 ((setq a (org-extract-log-state-settings w))
11948 (and (member (car a) org-todo-keywords-1)
11949 (push a org-todo-log-states)))))))
11951 (defun org-get-todo-sequence-head (kwd)
11952 "Return the head of the TODO sequence to which KWD belongs.
11953 If KWD is not set, check if there is a text property remembering the
11954 right sequence."
11955 (let (p)
11956 (cond
11957 ((not kwd)
11958 (or (get-text-property (point-at-bol) 'org-todo-head)
11959 (progn
11960 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11961 nil (point-at-eol)))
11962 (get-text-property p 'org-todo-head))))
11963 ((not (member kwd org-todo-keywords-1))
11964 (car org-todo-keywords-1))
11965 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11967 (defun org-fast-todo-selection ()
11968 "Fast TODO keyword selection with single keys.
11969 Returns the new TODO keyword, or nil if no state change should occur."
11970 (let* ((fulltable org-todo-key-alist)
11971 (done-keywords org-done-keywords) ;; needed for the faces.
11972 (maxlen (apply 'max (mapcar
11973 (lambda (x)
11974 (if (stringp (car x)) (string-width (car x)) 0))
11975 fulltable)))
11976 (expert nil)
11977 (fwidth (+ maxlen 3 1 3))
11978 (ncol (/ (- (window-width) 4) fwidth))
11979 tg cnt e c tbl
11980 groups ingroup)
11981 (save-excursion
11982 (save-window-excursion
11983 (if expert
11984 (set-buffer (get-buffer-create " *Org todo*"))
11985 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11986 (erase-buffer)
11987 (org-set-local 'org-done-keywords done-keywords)
11988 (setq tbl fulltable cnt 0)
11989 (while (setq e (pop tbl))
11990 (cond
11991 ((equal e '(:startgroup))
11992 (push '() groups) (setq ingroup t)
11993 (when (not (= cnt 0))
11994 (setq cnt 0)
11996 (insert "{ "))
11997 ((equal e '(:endgroup))
11998 (setq ingroup nil cnt 0)
12000 ((equal e '(:newline))
12001 (when (not (= cnt 0))
12002 (setq cnt 0)
12004 (setq e (car tbl))
12005 (while (equal (car tbl) '(:newline))
12007 (setq tbl (cdr tbl)))))
12008 (t
12009 (setq tg (car e) c (cdr e))
12010 (if ingroup (push tg (car groups)))
12011 (setq tg (org-add-props tg nil 'face
12012 (org-get-todo-face tg)))
12013 (if (and (= cnt 0) (not ingroup)) (insert " "))
12014 (insert "[" c "] " tg (make-string
12015 (- fwidth 4 (length tg)) ?\ ))
12016 (when (= (setq cnt (1+ cnt)) ncol)
12018 (if ingroup (insert " "))
12019 (setq cnt 0)))))
12021 (goto-char (point-min))
12022 (if (not expert) (org-fit-window-to-buffer))
12023 (message "[a-z..]:Set [SPC]:clear")
12024 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12025 (cond
12026 ((or (= c ?\C-g)
12027 (and (= c ?q) (not (rassoc c fulltable))))
12028 (setq quit-flag t))
12029 ((= c ?\ ) nil)
12030 ((setq e (rassoc c fulltable) tg (car e))
12031 tg)
12032 (t (setq quit-flag t)))))))
12034 (defun org-entry-is-todo-p ()
12035 (member (org-get-todo-state) org-not-done-keywords))
12037 (defun org-entry-is-done-p ()
12038 (member (org-get-todo-state) org-done-keywords))
12040 (defun org-get-todo-state ()
12041 (save-excursion
12042 (org-back-to-heading t)
12043 (and (looking-at org-todo-line-regexp)
12044 (match-end 2)
12045 (match-string 2))))
12047 (defun org-at-date-range-p (&optional inactive-ok)
12048 "Is the cursor inside a date range?"
12049 (interactive)
12050 (save-excursion
12051 (catch 'exit
12052 (let ((pos (point)))
12054 (skip-chars-backward "<[")
12055 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12056 (>= (match-end 0) pos)
12057 (throw 'exit t))
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)))
12063 nil)))
12065 (defun org-get-repeat (&optional tagline)
12066 "Check if there is a deadline/schedule with repeater in this entry."
12067 (save-match-data
12068 (save-excursion
12069 (org-back-to-heading t)
12070 (and (re-search-forward (if tagline
12072 org-repeat-re)
12073 (org-entry-end-position) t)
12074 (match-string-no-properties 1)))))
12076 (defvar org-last-changed-timestamp)
12077 (defvar org-last-inserted-timestamp)
12078 (defvar org-log-post-message)
12079 (defvar org-log-note-purpose)
12080 (defvar org-log-note-how)
12081 (defvar org-log-note-extra)
12082 (defun org-auto-repeat-maybe (done-word)
12083 "Check if the current headline contains a repeated deadline/schedule.
12084 If yes, set TODO state back to what it was and change the base date
12085 of repeating deadline/scheduled time stamps to new date.
12086 This function is run automatically after each state change to a DONE state."
12087 ;; last-state is dynamically scoped into this function
12088 (let* ((repeat (org-get-repeat))
12089 (aa (assoc org-last-state org-todo-kwd-alist))
12090 (interpret (nth 1 aa))
12091 (head (nth 2 aa))
12092 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12093 (msg "Entry repeats: ")
12094 (org-log-done nil)
12095 (org-todo-log-states nil)
12096 re type n what ts time to-state)
12097 (when repeat
12098 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12099 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12100 org-todo-repeat-to-state))
12101 (unless (and to-state (member to-state org-todo-keywords-1))
12102 (setq to-state (if (eq interpret 'type) org-last-state head)))
12103 (org-todo to-state)
12104 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12105 (org-entry-put nil "LAST_REPEAT" (format-time-string
12106 (org-time-stamp-format t t))))
12107 (when org-log-repeat
12108 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12109 (memq 'org-add-log-note post-command-hook))
12110 ;; OK, we are already setup for some record
12111 (if (eq org-log-repeat 'note)
12112 ;; make sure we take a note, not only a time stamp
12113 (setq org-log-note-how 'note))
12114 ;; Set up for taking a record
12115 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12116 org-last-state
12117 'findpos org-log-repeat)))
12118 (org-back-to-heading t)
12119 (org-add-planning-info nil nil 'closed)
12123 (while (re-search-forward
12124 re (save-excursion (outline-next-heading) (point)) t)
12125 (setq type (if (match-end 1) org-scheduled-string
12126 (if (match-end 3) org-deadline-string "Plain:"))
12127 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12129 (setq n (string-to-number (match-string 2 ts))
12130 what (match-string 3 ts))
12131 (if (equal what "w") (setq n (* n 7) what "d"))
12133 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12134 ;; Preparation, see if we need to modify the start date for the change
12135 (when (match-end 1)
12136 (setq time (save-match-data (org-time-string-to-time ts)))
12137 (cond
12138 ((equal (match-string 1 ts) ".")
12139 ;; Shift starting date to today
12140 (org-timestamp-change
12141 (- (org-today) (time-to-days time))
12142 'day))
12143 ((equal (match-string 1 ts) "+")
12144 (let ((nshiftmax 10) (nshift 0))
12145 (while (or (= nshift 0)
12146 (<= (time-to-days time)
12147 (time-to-days (current-time))))
12148 (when (= (incf nshift) nshiftmax)
12149 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12150 (error "Abort")))
12151 (org-timestamp-change n (cdr (assoc what whata)))
12152 (org-at-timestamp-p t)
12153 (setq ts (match-string 1))
12154 (setq time (save-match-data (org-time-string-to-time ts)))))
12155 (org-timestamp-change (- n) (cdr (assoc what whata)))
12156 ;; rematch, so that we have everything in place for the real shift
12157 (org-at-timestamp-p t)
12158 (setq ts (match-string 1))
12160 (org-timestamp-change n (cdr (assoc what whata)))
12161 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12162 (setq org-log-post-message msg)
12163 (message "%s" msg))))
12165 (defun org-show-todo-tree (arg)
12166 "Make a compact tree which shows all headlines marked with TODO.
12167 The tree will show the lines where the regexp matches, and all higher
12168 headlines above the match.
12170 With a numeric prefix N, construct a sparse tree for the Nth element
12171 of `org-todo-keywords-1'."
12172 (interactive "P")
12173 (let ((case-fold-search nil)
12174 (kwd-re
12175 (cond ((null arg) org-not-done-regexp)
12176 ((equal arg '(4))
12177 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12178 (mapcar 'list org-todo-keywords-1))))
12182 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12183 (regexp-quote (nth (1- (prefix-numeric-value arg))
12184 org-todo-keywords-1)))
12185 (t (error "Invalid prefix argument: %s" arg)))))
12186 (message "%d TODO entries found"
12187 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12189 (defun org-deadline (&optional remove time)
12191 With argument REMOVE, remove any deadline from the item.
12192 With argument TIME, set the deadline at the corresponding date. TIME
12194 (interactive "P")
12195 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12196 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12197 'region-start-level 'region))
12198 org-loop-over-headlines-in-active-region)
12199 (org-map-entries
12200 `(org-deadline ',remove ,time)
12201 org-loop-over-headlines-in-active-region
12202 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12203 (let* ((old-date (org-entry-get nil "DEADLINE"))
12204 (repeater (and old-date
12205 (string-match
12207 old-date)
12208 (match-string 1 old-date))))
12209 (if remove
12210 (progn
12211 (when (and old-date org-log-redeadline)
12212 (org-add-log-setup 'deldeadline nil old-date 'findpos
12213 org-log-redeadline))
12214 (org-remove-timestamp-with-keyword org-deadline-string)
12215 (message "Item no longer has a deadline."))
12216 (org-add-planning-info 'deadline time 'closed)
12217 (when (and old-date org-log-redeadline
12218 (not (equal old-date
12219 (substring org-last-inserted-timestamp 1 -1))))
12220 (org-add-log-setup 'redeadline nil old-date 'findpos
12221 org-log-redeadline))
12222 (when repeater
12223 (save-excursion
12224 (org-back-to-heading t)
12225 (when (re-search-forward (concat org-deadline-string " "
12226 org-last-inserted-timestamp)
12227 (save-excursion
12228 (outline-next-heading) (point)) t)
12229 (goto-char (1- (match-end 0)))
12230 (insert " " repeater)
12231 (setq org-last-inserted-timestamp
12232 (concat (substring org-last-inserted-timestamp 0 -1)
12233 " " repeater
12234 (substring org-last-inserted-timestamp -1))))))
12235 (message "Deadline on %s" org-last-inserted-timestamp)))))
12237 (defun org-schedule (&optional remove time)
12238 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12239 With argument REMOVE, remove any scheduling date from the item.
12240 With argument TIME, scheduled at the corresponding date. TIME can
12242 (interactive "P")
12243 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12244 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12245 'region-start-level 'region))
12246 org-loop-over-headlines-in-active-region)
12247 (org-map-entries
12248 `(org-schedule ',remove ,time)
12249 org-loop-over-headlines-in-active-region
12250 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12251 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12252 (repeater (and old-date
12253 (string-match
12255 old-date)
12256 (match-string 1 old-date))))
12257 (if remove
12258 (progn
12259 (when (and old-date org-log-reschedule)
12260 (org-add-log-setup 'delschedule nil old-date 'findpos
12261 org-log-reschedule))
12262 (org-remove-timestamp-with-keyword org-scheduled-string)
12263 (message "Item is no longer scheduled."))
12264 (org-add-planning-info 'scheduled time 'closed)
12265 (when (and old-date org-log-reschedule
12266 (not (equal old-date
12267 (substring org-last-inserted-timestamp 1 -1))))
12268 (org-add-log-setup 'reschedule nil old-date 'findpos
12269 org-log-reschedule))
12270 (when repeater
12271 (save-excursion
12272 (org-back-to-heading t)
12273 (when (re-search-forward (concat org-scheduled-string " "
12274 org-last-inserted-timestamp)
12275 (save-excursion
12276 (outline-next-heading) (point)) t)
12277 (goto-char (1- (match-end 0)))
12278 (insert " " repeater)
12279 (setq org-last-inserted-timestamp
12280 (concat (substring org-last-inserted-timestamp 0 -1)
12281 " " repeater
12282 (substring org-last-inserted-timestamp -1))))))
12283 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12285 (defun org-get-scheduled-time (pom &optional inherit)
12286 "Get the scheduled time as a time tuple, of a format suitable
12287 for calling org-schedule with, or if there is no scheduling,
12288 returns nil."
12289 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12290 (when time
12291 (apply 'encode-time (org-parse-time-string time)))))
12293 (defun org-get-deadline-time (pom &optional inherit)
12294 "Get the deadline as a time tuple, of a format suitable for
12295 calling org-deadline with, or if there is no scheduling, returns
12296 nil."
12297 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12298 (when time
12299 (apply 'encode-time (org-parse-time-string time)))))
12301 (defun org-remove-timestamp-with-keyword (keyword)
12302 "Remove all time stamps with KEYWORD in the current entry."
12304 beg)
12305 (save-excursion
12306 (org-back-to-heading t)
12307 (setq beg (point))
12308 (outline-next-heading)
12309 (while (re-search-backward re beg t)
12310 (replace-match "")
12312 (equal (char-before) ?\ ))
12313 (backward-delete-char 1)
12315 (point-at-bol) (point-at-eol)))
12316 (delete-region (point-at-bol)
12317 (min (point-max) (1+ (point-at-eol))))))))))
12319 (defun org-add-planning-info (what &optional time &rest remove)
12320 "Insert new timestamp with keyword in the line directly after the headline.
12321 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12322 If non is given, the user is prompted for a date.
12323 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12324 be removed."
12325 (interactive)
12326 (let (org-time-was-given org-end-time-was-given ts
12327 end default-time default-input)
12329 (catch 'exit
12330 (when (and (memq what '(scheduled deadline))
12331 (or (not time)
12332 (and (stringp time)
12333 (string-match "^[-+]+[0-9]" time))))
12334 ;; Try to get a default date/time from existing timestamp
12335 (save-excursion
12336 (org-back-to-heading t)
12337 (setq end (save-excursion (outline-next-heading) (point)))
12338 (when (re-search-forward (if (eq what 'scheduled)
12339 org-scheduled-time-regexp
12340 org-deadline-time-regexp)
12341 end t)
12342 (setq ts (match-string 1)
12343 default-time
12344 (apply 'encode-time (org-parse-time-string ts))
12345 default-input (and ts (org-get-compact-tod ts))))))
12346 (when what
12347 (setq time
12348 (if (stringp time)
12349 ;; This is a string (relative or absolute), set proper date
12350 (apply 'encode-time
12351 (org-read-date-analyze
12352 time default-time (decode-time default-time)))
12353 ;; If necessary, get the time from the user
12354 (or time (org-read-date nil 'to-time nil nil
12355 default-time default-input)))))
12357 (when (and org-insert-labeled-timestamps-at-point
12358 (member what '(scheduled deadline)))
12359 (insert
12360 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12361 (org-insert-time-stamp time org-time-was-given
12362 nil nil nil (list org-end-time-was-given))
12363 (setq what nil))
12364 (save-excursion
12365 (save-restriction
12366 (let (col list elt ts buffer-invisibility-spec)
12367 (org-back-to-heading t)
12369 (goto-char (match-end 1))
12370 (setq col (current-column))
12371 (goto-char (match-end 0))
12373 (when (and (not what)
12374 (not (looking-at
12376 org-keyword-time-not-clock-regexp))))
12377 ;; Nothing to add, nothing to remove...... :-)
12378 (throw 'exit nil))
12379 (if (and (not (looking-at org-outline-regexp))
12382 (not (equal (match-string 1) org-clock-string)))
12383 (narrow-to-region (match-beginning 0) (match-end 0))
12385 (backward-char 1)
12386 (narrow-to-region (point) (point))
12387 (and org-adapt-indentation (org-indent-to-column col)))
12388 ;; Check if we have to remove something.
12389 (setq list (cons what remove))
12390 (while list
12391 (setq elt (pop list))
12392 (when (or (and (eq elt 'scheduled)
12393 (re-search-forward org-scheduled-time-regexp nil t))
12394 (and (eq elt 'deadline)
12395 (re-search-forward org-deadline-time-regexp nil t))
12396 (and (eq elt 'closed)
12397 (re-search-forward org-closed-time-regexp nil t)))
12398 (replace-match "")
12399 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12401 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12402 (when what
12403 (insert
12404 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12405 (cond ((eq what 'scheduled) org-scheduled-string)
12406 ((eq what 'deadline) org-deadline-string)
12407 ((eq what 'closed) org-closed-string))
12408 " ")
12409 (setq ts (org-insert-time-stamp
12410 time
12411 (or org-time-was-given
12412 (and (eq what 'closed) org-log-done-with-time))
12413 (eq what 'closed)
12414 nil nil (list org-end-time-was-given)))
12415 (insert
12416 (if (not (or (bolp) (eq (char-before) ?\ )
12417 (memq (char-after) '(32 10))
12418 (eobp))) " " ""))
12419 (end-of-line 1))
12420 (goto-char (point-min))
12421 (widen)
12424 (delete-region (1- (point)) (point-at-eol)))
12425 ts))))))
12427 (defvar org-log-note-marker (make-marker))
12428 (defvar org-log-note-purpose nil)
12429 (defvar org-log-note-state nil)
12430 (defvar org-log-note-previous-state nil)
12431 (defvar org-log-note-how nil)
12432 (defvar org-log-note-extra nil)
12433 (defvar org-log-note-window-configuration nil)
12434 (defvar org-log-note-return-to (make-marker))
12435 (defvar org-log-note-effective-time nil
12436 "Remembered current time so that dynamically scoped
12437 `org-extend-today-until' affects tha timestamps in state change
12438 log")
12440 (defvar org-log-post-message nil
12441 "Message to be displayed after a log note has been stored.
12442 The auto-repeater uses this.")
12444 (defun org-add-note ()
12445 "Add a note to the current entry.
12446 This is done in the same way as adding a state change note."
12447 (interactive)
12448 (org-add-log-setup 'note nil nil 'findpos nil))
12450 (defvar org-property-end-re)
12451 (defun org-add-log-setup (&optional purpose state prev-state
12452 findpos how extra)
12453 "Set up the post command hook to take a note.
12454 If this is about to TODO state change, the new state is expected in STATE.
12455 When FINDPOS is non-nil, find the correct position for the note in
12456 the current entry. If not, assume that it can be inserted at point.
12457 HOW is an indicator what kind of note should be created.
12458 EXTRA is additional text that will be inserted into the notes buffer."
12459 (let* ((org-log-into-drawer (org-log-into-drawer))
12460 (drawer (cond ((stringp org-log-into-drawer)
12461 org-log-into-drawer)
12462 (org-log-into-drawer "LOGBOOK"))))
12463 (save-restriction
12464 (save-excursion
12465 (when findpos
12466 (org-back-to-heading t)
12467 (narrow-to-region (point) (save-excursion
12468 (outline-next-heading) (point)))
12472 (goto-char (match-end 0))
12473 (cond
12474 (drawer
12476 nil t)
12477 (progn
12478 (goto-char (match-end 0))
12479 (or org-log-states-order-reversed
12480 (and (re-search-forward org-property-end-re nil t)
12481 (goto-char (1- (match-beginning 0))))))
12483 (beginning-of-line 0)
12484 (org-indent-line)
12485 (beginning-of-line 2)
12486 (org-indent-line)
12487 (end-of-line 0)))
12488 ((and org-log-state-notes-insert-after-drawers
12489 (save-excursion
12490 (forward-line) (looking-at org-drawer-regexp)))
12491 (forward-line)
12492 (while (looking-at org-drawer-regexp)
12493 (goto-char (match-end 0))
12494 (re-search-forward org-property-end-re (point-max) t)
12495 (forward-line))
12496 (forward-line -1)))
12497 (unless org-log-states-order-reversed
12499 (org-skip-over-state-notes)
12501 (move-marker org-log-note-marker (point))
12502 (setq org-log-note-purpose purpose
12503 org-log-note-state state
12504 org-log-note-previous-state prev-state
12505 org-log-note-how how
12506 org-log-note-extra extra
12507 org-log-note-effective-time (org-current-effective-time))
12508 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12510 (defun org-skip-over-state-notes ()
12511 "Skip past the list of State notes in an entry."
12513 (when (ignore-errors (goto-char (org-in-item-p)))
12514 (let* ((struct (org-list-struct))
12515 (prevs (org-list-prevs-alist struct)))
12517 (goto-char (or (org-list-get-next-item (point) struct prevs)
12518 (org-list-get-item-end (point) struct)))))))
12520 (defun org-add-log-note (&optional purpose)
12521 "Pop up a window for taking a note, and add this note later at point."
12522 (remove-hook 'post-command-hook 'org-add-log-note)
12523 (setq org-log-note-window-configuration (current-window-configuration))
12524 (delete-other-windows)
12525 (move-marker org-log-note-return-to (point))
12526 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12527 (goto-char org-log-note-marker)
12528 (org-switch-to-buffer-other-window "*Org Note*")
12529 (erase-buffer)
12530 (if (memq org-log-note-how '(time state))
12531 (let (current-prefix-arg) (org-store-log-note))
12532 (let ((org-inhibit-startup t)) (org-mode))
12533 (insert (format "# Insert note for %s.
12535 (cond
12536 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12537 ((eq org-log-note-purpose 'done) "closed todo item")
12538 ((eq org-log-note-purpose 'state)
12540 (or org-log-note-previous-state "")
12541 (or org-log-note-state "")))
12542 ((eq org-log-note-purpose 'reschedule)
12543 "rescheduling")
12544 ((eq org-log-note-purpose 'delschedule)
12545 "no longer scheduled")
12546 ((eq org-log-note-purpose 'redeadline)
12547 "changing deadline")
12548 ((eq org-log-note-purpose 'deldeadline)
12549 "removing deadline")
12550 ((eq org-log-note-purpose 'refile)
12551 "refiling")
12552 ((eq org-log-note-purpose 'note)
12553 "this entry")
12554 (t (error "This should not happen")))))
12555 (if org-log-note-extra (insert org-log-note-extra))
12556 (org-set-local 'org-finish-function 'org-store-log-note)
12557 (run-hooks 'org-log-buffer-setup-hook)))
12559 (defvar org-note-abort nil) ; dynamically scoped
12560 (defun org-store-log-note ()
12561 "Finish taking a log note, and insert it to where it belongs."
12562 (let ((txt (buffer-string))
12563 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12564 lines ind bul)
12565 (kill-buffer (current-buffer))
12567 (setq txt (replace-match "" t t txt)))
12569 (setq txt (replace-match "" t t txt)))
12572 (setq note
12573 (org-replace-escapes
12574 note
12575 (list (cons "%u" (user-login-name))
12576 (cons "%U" user-full-name)
12577 (cons "%t" (format-time-string
12578 (org-time-stamp-format 'long 'inactive)
12579 org-log-note-effective-time))
12580 (cons "%T" (format-time-string
12581 (org-time-stamp-format 'long nil)
12582 org-log-note-effective-time))
12583 (cons "%d" (format-time-string
12584 (org-time-stamp-format nil 'inactive)
12585 org-log-note-effective-time))
12586 (cons "%D" (format-time-string
12587 (org-time-stamp-format nil nil)
12588 org-log-note-effective-time))
12589 (cons "%s" (if org-log-note-state
12591 ""))
12592 (cons "%S" (if org-log-note-previous-state
12596 (push note lines))
12597 (when (or current-prefix-arg org-note-abort)
12598 (when org-log-into-drawer
12599 (org-remove-empty-drawer-at
12600 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12601 org-log-note-marker))
12602 (setq lines nil))
12603 (when lines
12604 (with-current-buffer (marker-buffer org-log-note-marker)
12605 (save-excursion
12606 (goto-char org-log-note-marker)
12607 (move-marker org-log-note-marker nil)
12608 (end-of-line 1)
12610 (setq ind (save-excursion
12611 (if (ignore-errors (goto-char (org-in-item-p)))
12612 (let ((struct (org-list-struct)))
12613 (org-list-get-ind
12614 (org-list-get-top-point struct) struct))
12616 (cond
12617 ((and (org-at-heading-p)
12618 org-adapt-indentation)
12619 (1+ (org-current-level)))
12620 ((org-at-heading-p) 0)
12621 (t (org-get-indentation))))))
12622 (setq bul (org-list-bullet-string "-"))
12623 (org-indent-line-to ind)
12624 (insert bul (pop lines))
12625 (let ((ind-body (+ (length bul) ind)))
12626 (while lines
12628 (org-indent-line-to ind-body)
12629 (insert (pop lines))))
12630 (message "Note stored")
12631 (org-back-to-heading t)
12632 (org-cycle-hide-drawers 'children)))))
12633 (set-window-configuration org-log-note-window-configuration)
12634 (with-current-buffer (marker-buffer org-log-note-return-to)
12635 (goto-char org-log-note-return-to))
12636 (move-marker org-log-note-return-to nil)
12637 (and org-log-post-message (message "%s" org-log-post-message)))
12639 (defun org-remove-empty-drawer-at (drawer pos)
12640 "Remove an empty drawer DRAWER at position POS.
12641 POS may also be a marker."
12642 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12643 (save-excursion
12644 (save-restriction
12645 (widen)
12646 (goto-char pos)
12647 (if (org-in-regexp
12649 (replace-match ""))))))
12651 (defvar org-ts-type nil)
12652 (defun org-sparse-tree (&optional arg type)
12653 "Create a sparse tree, prompt for the details.
12654 This command can create sparse trees. You first need to select the type
12655 of match used to create the tree:
12657 t Show all TODO entries.
12658 T Show entries with a specific TODO keyword.
12659 m Show entries selected by a tags/property match.
12660 p Enter a property name and its value (both with completion on existing
12661 names/values) and show entries with that property.
12662 r Show entries matching a regular expression (`/' can be used as well).
12663 b Show deadlines and scheduled items before a date.
12664 a Show deadlines and scheduled items after a date.
12665 d Show deadlines due within `org-deadline-warning-days'.
12666 D Show deadlines and scheduled items between a date range."
12667 (interactive "P")
12668 (let (ans kwd value ts-type)
12669 (setq type (or type org-sparse-tree-default-date-type))
12670 (setq org-ts-type type)
12671 (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"
12672 (cond ((eq type 'all) "all timestamps")
12673 ((eq type 'scheduled) "only scheduled")
12674 ((eq type 'deadline) "only deadline")
12675 ((eq type 'active) "only active timestamps")
12676 ((eq type 'inactive) "only inactive timestamps")
12677 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
12678 (t "scheduled/deadline")))
12679 (setq ans (read-char-exclusive))
12680 (cond
12681 ((equal ans ?c)
12682 (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
12683 ((equal ans ?d)
12684 (call-interactively 'org-check-deadlines))
12685 ((equal ans ?b)
12686 (call-interactively 'org-check-before-date))
12687 ((equal ans ?a)
12688 (call-interactively 'org-check-after-date))
12689 ((equal ans ?D)
12690 (call-interactively 'org-check-dates-range))
12691 ((equal ans ?t)
12692 (call-interactively 'org-show-todo-tree))
12693 ((equal ans ?T)
12694 (org-show-todo-tree '(4)))
12695 ((member ans '(?T ?m))
12696 (call-interactively 'org-match-sparse-tree))
12697 ((member ans '(?p ?P))
12698 (setq kwd (org-icompleting-read "Property: "
12699 (mapcar 'list (org-buffer-property-keys))))
12700 (setq value (org-icompleting-read "Value: "
12701 (mapcar 'list (org-property-values kwd))))
12704 (org-match-sparse-tree arg (concat kwd "=" value)))
12705 ((member ans '(?r ?R ?/))
12706 (call-interactively 'org-occur))
12709 (defvar org-occur-highlights nil
12710 "List of overlays used for occur matches.")
12711 (make-variable-buffer-local 'org-occur-highlights)
12712 (defvar org-occur-parameters nil
12713 "Parameters of the active org-occur calls.
12714 This is a list, each call to org-occur pushes as cons cell,
12715 containing the regular expression and the callback, onto the list.
12716 The list can contain several entries if `org-occur' has been called
12717 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12718 will only contain one set of parameters. When the highlights are
12719 removed (for example with `C-c C-c', or with the next edit (depending
12720 on `org-remove-highlights-with-change'), this variable is emptied
12721 as well.")
12722 (make-variable-buffer-local 'org-occur-parameters)
12724 (defun org-occur (regexp &optional keep-previous callback)
12725 "Make a compact tree which shows all matches of REGEXP.
12726 The tree will show the lines where the regexp matches, and all higher
12727 headlines above the match. It will also show the heading after the match,
12728 to make sure editing the matching entry is easy.
12729 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12730 call to `org-occur' will be kept, to allow stacking of calls to this
12731 command.
12732 If CALLBACK is non-nil, it is a function which is called to confirm
12733 that the match should indeed be shown."
12735 (when (equal regexp "")
12736 (error "Regexp cannot be empty"))
12737 (unless keep-previous
12738 (org-remove-occur-highlights nil nil t))
12739 (push (cons regexp callback) org-occur-parameters)
12740 (let ((cnt 0))
12741 (save-excursion
12742 (goto-char (point-min))
12743 (if (or (not keep-previous) ; do not want to keep
12744 (not org-occur-highlights)) ; no previous matches
12745 ;; hide everything
12746 (org-overview))
12747 (while (re-search-forward regexp nil t)
12748 (when (or (not callback)
12749 (save-match-data (funcall callback)))
12750 (setq cnt (1+ cnt))
12751 (when org-highlight-sparse-tree-matches
12752 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12753 (org-show-context 'occur-tree))))
12754 (when org-remove-highlights-with-change
12755 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12756 nil 'local))
12757 (unless org-sparse-tree-open-archived-trees
12758 (org-hide-archived-subtrees (point-min) (point-max)))
12759 (run-hooks 'org-occur-hook)
12760 (if (org-called-interactively-p 'interactive)
12761 (message "%d match(es) for regexp %s" cnt regexp))
12762 cnt))
12764 (defun org-occur-next-match (&optional n reset)
12765 "Function for `next-error-function' to find sparse tree matches.
12766 N is the number of matches to move, when negative move backwards.
12767 RESET is entirely ignored - this function always goes back to the
12768 starting point when no match is found."
12769 (let* ((limit (if (< n 0) (point-min) (point-max)))
12770 (search-func (if (< n 0)
12771 'previous-single-char-property-change
12772 'next-single-char-property-change))
12773 (n (abs n))
12774 (pos (point))
12775 p1)
12776 (catch 'exit
12777 (while (setq p1 (funcall search-func (point) 'org-type))
12778 (when (equal p1 limit)
12779 (goto-char pos)
12780 (error "No more matches"))
12781 (when (equal (get-char-property p1 'org-type) 'org-occur)
12782 (setq n (1- n))
12783 (when (= n 0)
12784 (goto-char p1)
12785 (throw 'exit (point))))
12786 (goto-char p1))
12787 (goto-char p1)
12788 (error "No more matches"))))
12790 (defun org-show-context (&optional key)
12791 "Make sure point and context are visible.
12792 How much context is shown depends upon the variables
12793 `org-show-hierarchy-above', `org-show-following-heading',
12794 `org-show-entry-below' and `org-show-siblings'."
12795 (let ((heading-p (org-at-heading-p t))
12796 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12797 (following-p (org-get-alist-option org-show-following-heading key))
12798 (entry-p (org-get-alist-option org-show-entry-below key))
12799 (siblings-p (org-get-alist-option org-show-siblings key)))
12800 (catch 'exit
12801 ;; Show heading or entry text
12802 (if (and heading-p (not entry-p))
12803 (org-flag-heading nil) ; only show the heading
12804 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12805 (org-show-hidden-entry))) ; show entire entry
12806 (when following-p
12807 ;; Show next sibling, or heading below text
12808 (save-excursion
12809 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12810 (org-flag-heading nil))))
12811 (when siblings-p (org-show-siblings))
12812 (when hierarchy-p
12813 ;; show all higher headings, possibly with siblings
12814 (save-excursion
12815 (while (and (condition-case nil
12816 (progn (org-up-heading-all 1) t)
12817 (error nil))
12818 (not (bobp)))
12819 (org-flag-heading nil)
12820 (when siblings-p (org-show-siblings))))))))
12822 (defvar org-reveal-start-hook nil
12823 "Hook run before revealing a location.")
12825 (defun org-reveal (&optional siblings)
12826 "Show current entry, hierarchy above it, and the following headline.
12827 This can be used to show a consistent set of context around locations
12828 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12829 not t for the search context.
12831 With optional argument SIBLINGS, on each level of the hierarchy all
12832 siblings are shown. This repairs the tree structure to what it would
12833 look like when opened with hierarchical calls to `org-cycle'.
12835 go to the parent and show the
12836 entire tree."
12837 (interactive "P")
12838 (run-hooks 'org-reveal-start-hook)
12839 (let ((org-show-hierarchy-above t)
12840 (org-show-following-heading t)
12841 (org-show-siblings (if siblings t org-show-siblings)))
12842 (org-show-context nil))
12843 (when (equal siblings '(16))
12844 (save-excursion
12845 (when (org-up-heading-safe)
12846 (org-show-subtree)
12847 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12849 (defun org-highlight-new-match (beg end)
12850 "Highlight from BEG to END and mark the highlight is an occur headline."
12851 (let ((ov (make-overlay beg end)))
12852 (overlay-put ov 'face 'secondary-selection)
12853 (overlay-put ov 'org-type 'org-occur)
12854 (push ov org-occur-highlights)))
12856 (defun org-remove-occur-highlights (&optional beg end noremove)
12857 "Remove the occur highlights from the buffer.
12858 BEG and END are ignored. If NOREMOVE is nil, remove this function
12859 from the `before-change-functions' in the current buffer."
12860 (interactive)
12861 (unless org-inhibit-highlight-removal
12862 (mapc 'delete-overlay org-occur-highlights)
12863 (setq org-occur-highlights nil)
12864 (setq org-occur-parameters nil)
12865 (unless noremove
12866 (remove-hook 'before-change-functions
12867 'org-remove-occur-highlights 'local))))
12869 ;;;; Priorities
12872 "Regular expression matching the priority indicator.")
12874 (defvar org-remove-priority-next-time nil)
12876 (defun org-priority-up ()
12877 "Increase the priority of the current item."
12878 (interactive)
12879 (org-priority 'up))
12881 (defun org-priority-down ()
12882 "Decrease the priority of the current item."
12883 (interactive)
12884 (org-priority 'down))
12886 (defun org-priority (&optional action show)
12887 "Change the priority of an item.
12888 ACTION can be `set', `up', `down', or a character."
12889 (interactive "P")
12890 (if (equal action '(4))
12891 (org-show-priority)
12892 (unless org-enable-priority-commands
12893 (error "Priority commands are disabled"))
12894 (setq action (or action 'set))
12895 (let (current new news have remove)
12896 (save-excursion
12897 (org-back-to-heading t)
12898 (if (looking-at org-priority-regexp)
12899 (setq current (string-to-char (match-string 2))
12900 have t))
12901 (cond
12902 ((eq action 'remove)
12903 (setq remove t new ?\ ))
12904 ((or (eq action 'set)
12905 (if (featurep 'xemacs) (characterp action) (integerp action)))
12906 (if (not (eq action 'set))
12907 (setq new action)
12908 (message "Priority %c-%c, SPC to remove: "
12909 org-highest-priority org-lowest-priority)
12910 (save-match-data
12911 (setq new (read-char-exclusive))))
12912 (if (and (= (upcase org-highest-priority) org-highest-priority)
12913 (= (upcase org-lowest-priority) org-lowest-priority))
12914 (setq new (upcase new)))
12915 (cond ((equal new ?\ ) (setq remove t))
12916 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12917 (error "Priority must be between `%c' and `%c'"
12918 org-highest-priority org-lowest-priority))))
12919 ((eq action 'up)
12920 (setq new (if have
12921 (1- current) ; normal cycling
12922 ;; last priority was empty
12923 (if (eq last-command this-command)
12924 org-lowest-priority ; wrap around empty to lowest
12925 ;; default
12926 (if org-priority-start-cycle-with-default
12927 org-default-priority
12928 (1- org-default-priority))))))
12929 ((eq action 'down)
12930 (setq new (if have
12931 (1+ current) ; normal cycling
12932 ;; last priority was empty
12933 (if (eq last-command this-command)
12934 org-highest-priority ; wrap around empty to highest
12935 ;; default
12936 (if org-priority-start-cycle-with-default
12937 org-default-priority
12938 (1+ org-default-priority))))))
12939 (t (error "Invalid action")))
12940 (if (or (< (upcase new) org-highest-priority)
12941 (> (upcase new) org-lowest-priority))
12942 (if (and (memq action '(up down))
12943 (not have) (not (eq last-command this-command)))
12944 ;; `new' is from default priority
12945 (error
12946 "The default can not be set, see `org-default-priority' why")
12947 ;; normal cycling: `new' is beyond highest/lowest priority
12948 ;; and is wrapped around to the empty priority
12949 (setq remove t)))
12950 (setq news (format "%c" new))
12951 (if have
12952 (if remove
12953 (replace-match "" t t nil 1)
12954 (replace-match news t t nil 2))
12955 (if remove
12956 (error "No priority cookie found in line")
12957 (let ((case-fold-search nil))
12958 (looking-at org-todo-line-regexp))
12959 (if (match-end 2)
12960 (progn
12961 (goto-char (match-end 2))
12962 (insert " [#" news "]"))
12963 (goto-char (match-beginning 3))
12964 (insert "[#" news "] "))))
12965 (org-preserve-lc (org-set-tags nil 'align)))
12966 (if remove
12967 (message "Priority removed")
12968 (message "Priority of current item set to %s" news)))))
12970 (defun org-show-priority ()
12971 "Show the priority of the current item.
12972 This priority is composed of the main priority given with the [#A] cookies,
12973 and by additional input from the age of a schedules or deadline entry."
12974 (interactive)
12975 (let ((pri (if (eq major-mode 'org-agenda-mode)
12976 (org-get-at-bol 'priority)
12977 (save-excursion
12978 (save-match-data
12979 (beginning-of-line)
12980 (and (looking-at org-heading-regexp)
12981 (org-get-priority (match-string 0))))))))
12982 (message "Priority is %d" (if pri pri -1000))))
12984 (defun org-get-priority (s)
12985 "Find priority cookie and return priority."
12986 (if (functionp org-get-priority-function)
12987 (funcall org-get-priority-function)
12988 (save-match-data
12989 (if (not (string-match org-priority-regexp s))
12990 (* 1000 (- org-lowest-priority org-default-priority))
12991 (* 1000 (- org-lowest-priority
12992 (string-to-char (match-string 2 s))))))))
12994 ;;;; Tags
12996 (defvar org-agenda-archives-mode)
12997 (defvar org-map-continue-from nil
12998 "Position from where mapping should continue.
12999 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13001 (defvar org-scanner-tags nil
13002 "The current tag list while the tags scanner is running.")
13003 (defvar org-trust-scanner-tags nil
13004 "Should `org-get-tags-at' use the tags for the scanner.
13005 This is for internal dynamical scoping only.
13006 When this is non-nil, the function `org-get-tags-at' will return the value
13007 of `org-scanner-tags' instead of building the list by itself. This
13008 can lead to large speed-ups when the tags scanner is used in a file with
13009 many entries, and when the list of tags is retrieved, for example to
13010 obtain a list of properties. Building the tags list for each entry in such
13011 a file becomes an N^2 operation - but with this variable set, it scales
13012 as N.")
13014 (defun org-scan-tags (action matcher todo-only &optional start-level)
13015 "Scan headline tags with inheritance and produce output ACTION.
13017 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13018 or `agenda' to produce an entry list for an agenda view. It can also be
13019 a Lisp form or a function that should be called at each matched headline, in
13020 this case the return value is a list of all return values from these calls.
13022 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13023 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13024 only lines with a not-done TODO keyword are included in the output.
13025 This should be the same variable that was scoped into
13026 and set by `org-make-tags-matcher' when it constructed MATCHER.
13028 START-LEVEL can be a string with asterisks, reducing the scope to
13029 headlines matching this string."
13030 (require 'org-agenda)
13031 (let* ((re (concat "^"
13032 (if start-level
13033 ;; Get the correct level to match
13035 org-outline-regexp)
13039 (props (list 'face 'default
13040 'done-face 'org-agenda-done
13041 'undone-face 'default
13042 'mouse-face 'highlight
13043 'org-not-done-regexp org-not-done-regexp
13044 'org-todo-regexp org-todo-regexp
13045 'org-complex-heading-regexp org-complex-heading-regexp
13046 'help-echo
13047 (format "mouse-2 or RET jump to org file %s"
13048 (abbreviate-file-name
13049 (or (buffer-file-name (buffer-base-buffer))
13050 (buffer-name (buffer-base-buffer)))))))
13051 (case-fold-search nil)
13052 (org-map-continue-from nil)
13053 lspos tags tags-list
13054 (tags-alist (list (cons 0 org-file-tags)))
13055 (llast 0) rtn rtn1 level category i txt
13056 todo marker entry priority)
13057 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13058 (setq action (list 'lambda nil action)))
13059 (save-excursion
13060 (goto-char (point-min))
13061 (when (eq action 'sparse-tree)
13062 (org-overview)
13063 (org-remove-occur-highlights))
13064 (while (re-search-forward re nil t)
13065 (setq org-map-continue-from nil)
13066 (catch :skip
13067 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13068 tags (if (match-end 4) (org-match-string-no-properties 4)))
13069 (goto-char (setq lspos (match-beginning 0)))
13070 (setq level (org-reduced-level (funcall outline-level))
13071 category (org-get-category))
13072 (setq i llast llast level)
13073 ;; remove tag lists from same and sublevels
13074 (while (>= i level)
13075 (when (setq entry (assoc i tags-alist))
13076 (setq tags-alist (delete entry tags-alist)))
13077 (setq i (1- i)))
13078 ;; add the next tags
13079 (when tags
13080 (setq tags (org-split-string tags ":")
13081 tags-alist
13082 (cons (cons level tags) tags-alist)))
13083 ;; compile tags for current headline
13084 (setq tags-list
13085 (if org-use-tag-inheritance
13086 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13087 tags)
13088 org-scanner-tags tags-list)
13089 (when org-use-tag-inheritance
13090 (setcdr (car tags-alist)
13091 (mapcar (lambda (x)
13092 (setq x (copy-sequence x))
13093 (org-add-prop-inherited x))
13094 (cdar tags-alist))))
13095 (when (and tags org-use-tag-inheritance
13096 (or (not (eq t org-use-tag-inheritance))
13097 org-tags-exclude-from-inheritance))
13098 ;; selective inheritance, remove uninherited ones
13099 (setcdr (car tags-alist)
13100 (org-remove-uninherited-tags (cdar tags-alist))))
13101 (when (and
13103 ;; eval matcher only when the todo condition is OK
13104 (and (or (not todo-only) (member todo org-not-done-keywords))
13105 (let ((case-fold-search t) (org-trust-scanner-tags t))
13106 (eval matcher)))
13108 ;; Call the skipper, but return t if it does not skip,
13109 ;; so that the `and' form continues evaluating
13110 (progn
13111 (unless (eq action 'sparse-tree) (org-agenda-skip))
13112 t)
13114 ;; Check if timestamps are deselecting this entry
13115 (or (not todo-only)
13116 (and (member todo org-not-done-keywords)
13117 (or (not org-agenda-tags-todo-honor-ignore-options)
13118 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
13120 ;; Extra check for the archive tag
13121 ;; FIXME: Does the skipper already do this????
13122 (or
13123 (not (member org-archive-tag tags-list))
13124 ;; we have an archive tag, should we use this anyway?
13125 (or (not org-agenda-skip-archived-trees)
13126 (and (eq action 'agenda) org-agenda-archives-mode))))
13128 ;; select this headline
13130 (cond
13131 ((eq action 'sparse-tree)
13132 (and org-highlight-sparse-tree-matches
13133 (org-get-heading) (match-end 0)
13134 (org-highlight-new-match
13135 (match-beginning 1) (match-end 1)))
13136 (org-show-context 'tags-tree))
13137 ((eq action 'agenda)
13138 (setq txt (org-agenda-format-item
13139 ""
13140 (concat
13141 (if (eq org-tags-match-list-sublevels 'indented)
13142 (make-string (1- level) ?.) "")
13143 (org-get-heading))
13144 category
13145 tags-list)
13146 priority (org-get-priority txt))
13147 (goto-char lspos)
13148 (setq marker (org-agenda-new-marker))
13149 (org-add-props txt props
13150 'org-marker marker 'org-hd-marker marker 'org-category category
13151 'todo-state todo
13152 'priority priority 'type "tagsmatch")
13153 (push txt rtn))
13154 ((functionp action)
13155 (setq org-map-continue-from nil)
13156 (save-excursion
13157 (setq rtn1 (funcall action))
13158 (push rtn1 rtn)))
13159 (t (error "Invalid action")))
13161 ;; if we are to skip sublevels, jump to end of subtree
13162 (unless org-tags-match-list-sublevels
13163 (org-end-of-subtree t)
13164 (backward-char 1))))
13165 ;; Get the correct position from where to continue
13166 (if org-map-continue-from
13167 (goto-char org-map-continue-from)
13168 (and (= (point) lspos) (end-of-line 1)))))
13169 (when (and (eq action 'sparse-tree)
13170 (not org-sparse-tree-open-archived-trees))
13171 (org-hide-archived-subtrees (point-min) (point-max)))
13172 (nreverse rtn)))
13174 (defun org-remove-uninherited-tags (tags)
13175 "Remove all tags that are not inherited from the list TAGS."
13176 (cond
13177 ((eq org-use-tag-inheritance t)
13178 (if org-tags-exclude-from-inheritance
13179 (org-delete-all org-tags-exclude-from-inheritance tags)
13180 tags))
13181 ((not org-use-tag-inheritance) nil)
13182 ((stringp org-use-tag-inheritance)
13183 (delq nil (mapcar
13184 (lambda (x)
13185 (if (and (string-match org-use-tag-inheritance x)
13186 (not (member x org-tags-exclude-from-inheritance)))
13187 x nil))
13188 tags)))
13189 ((listp org-use-tag-inheritance)
13190 (delq nil (mapcar
13191 (lambda (x)
13192 (if (member x org-use-tag-inheritance) x nil))
13193 tags)))))
13195 (defun org-match-sparse-tree (&optional todo-only match)
13196 "Create a sparse tree according to tags string MATCH.
13197 MATCH can contain positive and negative selection of tags, like
13199 If optional argument TODO-ONLY is non-nil, only select lines that are
13200 also TODO lines."
13201 (interactive "P")
13202 (org-agenda-prepare-buffers (list (current-buffer)))
13203 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13205 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13207 (defvar org-cached-props nil)
13208 (defun org-cached-entry-get (pom property)
13209 (if (or (eq t org-use-property-inheritance)
13210 (and (stringp org-use-property-inheritance)
13211 (string-match org-use-property-inheritance property))
13212 (and (listp org-use-property-inheritance)
13213 (member property org-use-property-inheritance)))
13214 ;; Caching is not possible, check it directly
13215 (org-entry-get pom property 'inherit)
13216 ;; Get all properties, so that we can do complicated checks easily
13217 (cdr (assoc property (or org-cached-props
13218 (setq org-cached-props
13219 (org-entry-properties pom)))))))
13221 (defun org-global-tags-completion-table (&optional files)
13222 "Return the list of all tags in all agenda buffer/files.
13223 Optional FILES argument is a list of files which can be used
13224 instead of the agenda files."
13225 (save-excursion
13226 (org-uniquify
13227 (delq nil
13228 (apply 'append
13229 (mapcar
13230 (lambda (file)
13231 (set-buffer (find-file-noselect file))
13232 (append (org-get-buffer-tags)
13233 (mapcar (lambda (x) (if (stringp (car-safe x))
13234 (list (car-safe x)) nil))
13235 org-tag-alist)))
13236 (if (and files (car files))
13237 files
13238 (org-agenda-files))))))))
13240 (defun org-make-tags-matcher (match)
13241 "Create the TAGS/TODO matcher form for the selection string MATCH.
13243 The variable `todo-only' is scoped dynamically into this function.
13244 It will be set to t if the matcher restricts matching to TODO entries,
13245 otherwise will not be touched.
13247 Returns a cons of the selection string MATCH and the constructed
13248 lisp form implementing the matcher. The matcher is to be evaluated
13249 at an Org entry, with point on the headline, and returns t if the
13250 entry matches the selection string MATCH. The returned lisp form
13251 references two variables with information about the entry, which
13252 must be bound around the form's evaluation: todo, the TODO keyword
13253 at the entry (or nil of none); and tags-list, the list of all tags
13254 at the entry including inherited ones. Additionally, the category
13255 of the entry (if any) must be specified as the text property
13256 'org-category on the headline.
13258 See also `org-scan-tags'.
13259 "
13260 (declare (special todo-only))
13261 (unless (boundp 'todo-only)
13262 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13263 (unless match
13264 ;; Get a new match request, with completion
13265 (let ((org-last-tags-completion-table
13266 (org-global-tags-completion-table)))
13267 (setq match (org-completing-read-no-i
13268 "Match: " 'org-tags-completion-function nil nil nil
13269 'org-tags-history))))
13271 ;; Parse the string and create a lisp form
13272 (let ((match0 match)
13273 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13274 minus tag mm
13275 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13276 orterms term orlist re-p str-p level-p level-op time-p
13277 prop-p pn pv po gv rest)
13278 (if (string-match "/+" match)
13279 ;; match contains also a todo-matching request
13280 (progn
13281 (setq tagsmatch (substring match 0 (match-beginning 0))
13282 todomatch (substring match (match-end 0)))
13283 (if (string-match "^!" todomatch)
13284 (setq todo-only t todomatch (substring todomatch 1)))
13286 (setq todomatch nil)))
13287 ;; only matching tags
13288 (setq tagsmatch match todomatch nil))
13290 ;; Make the tags matcher
13292 (setq tagsmatcher t)
13293 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13294 (while (setq term (pop orterms))
13296 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13297 (while (string-match re term)
13298 (setq rest (substring term (match-end 0))
13299 minus (and (match-end 1)
13300 (equal (match-string 1 term) "-"))
13301 tag (save-match-data (replace-regexp-in-string
13303 (match-string 2 term)))
13304 re-p (equal (string-to-char tag) ?{)
13305 level-p (match-end 4)
13306 prop-p (match-end 5)
13307 mm (cond
13308 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13309 (level-p
13310 (setq level-op (org-op-to-function (match-string 3 term)))
13311 `(,level-op level ,(string-to-number
13312 (match-string 4 term))))
13313 (prop-p
13314 (setq pn (match-string 5 term)
13315 po (match-string 6 term)
13316 pv (match-string 7 term)
13317 re-p (equal (string-to-char pv) ?{)
13319 time-p (save-match-data
13321 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13322 (if time-p (setq pv (org-matcher-time pv)))
13323 (setq po (org-op-to-function po (if time-p 'time str-p)))
13324 (cond
13325 ((equal pn "CATEGORY")
13326 (setq gv '(get-text-property (point) 'org-category)))
13327 ((equal pn "TODO")
13328 (setq gv 'todo))
13329 (t
13330 (setq gv `(org-cached-entry-get nil ,pn))))
13331 (if re-p
13332 (if (eq po 'org<>)
13333 `(not (string-match ,pv (or ,gv "")))
13334 `(string-match ,pv (or ,gv "")))
13335 (if str-p
13336 `(,po (or ,gv "") ,pv)
13337 `(,po (string-to-number (or ,gv ""))
13338 ,(string-to-number pv) ))))
13339 (t `(member ,tag tags-list)))
13340 mm (if minus (list 'not mm) mm)
13341 term rest)
13342 (push mm tagsmatcher))
13343 (push (if (> (length tagsmatcher) 1)
13344 (cons 'and tagsmatcher)
13345 (car tagsmatcher))
13346 orlist)
13347 (setq tagsmatcher nil))
13348 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13349 (setq tagsmatcher
13350 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13351 ;; Make the todo matcher
13353 (setq todomatcher t)
13354 (setq orterms (org-split-string todomatch "|") orlist nil)
13355 (while (setq term (pop orterms))
13356 (while (string-match re term)
13357 (setq minus (and (match-end 1)
13358 (equal (match-string 1 term) "-"))
13359 kwd (match-string 2 term)
13360 re-p (equal (string-to-char kwd) ?{)
13361 term (substring term (match-end 0))
13362 mm (if re-p
13363 `(string-match ,(substring kwd 1 -1) todo)
13364 (list 'equal 'todo kwd))
13365 mm (if minus (list 'not mm) mm))
13366 (push mm todomatcher))
13367 (push (if (> (length todomatcher) 1)
13368 (cons 'and todomatcher)
13369 (car todomatcher))
13370 orlist)
13371 (setq todomatcher nil))
13372 (setq todomatcher (if (> (length orlist) 1)
13373 (cons 'or orlist) (car orlist))))
13375 ;; Return the string and lisp forms of the matcher
13376 (setq matcher (if todomatcher
13377 (list 'and tagsmatcher todomatcher)
13378 tagsmatcher))
13379 (when todo-only
13380 (setq matcher (list 'and '(member todo org-not-done-keywords)
13381 matcher)))
13382 (cons match0 matcher)))
13384 (defun org-op-to-function (op &optional stringp)
13385 "Turn an operator into the appropriate function."
13386 (setq op
13387 (cond
13388 ((equal op "<" ) '(< string< org-time<))
13389 ((equal op ">" ) '(> org-string> org-time>))
13390 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13391 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13392 ((member op '("=" "==")) '(= string= org-time=))
13393 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13394 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13396 (defun org<> (a b) (not (= a b)))
13397 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13398 (defun org-string>= (a b) (not (string< a b)))
13399 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13400 (defun org-string<> (a b) (not (string= a b)))
13401 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13402 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13403 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13404 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13405 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13406 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13407 (defun org-2ft (s)
13408 "Convert S to a floating point time.
13409 If S is already a number, just return it. If it is a string, parse
13410 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13411 (cond
13412 ((numberp s) s)
13413 ((stringp s)
13414 (condition-case nil
13415 (float-time (apply 'encode-time (org-parse-time-string s)))
13416 (error 0.)))
13417 (t 0.)))
13419 (defun org-time-today ()
13420 "Time in seconds today at 0:00.
13421 Returns the float number of seconds since the beginning of the
13422 epoch to the beginning of today (00:00)."
13423 (float-time (apply 'encode-time
13424 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13426 (defun org-matcher-time (s)
13427 "Interpret a time comparison value."
13428 (save-match-data
13429 (cond
13430 ((string= s "<now>") (float-time))
13431 ((string= s "<today>") (org-time-today))
13432 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13433 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13435 (+ (org-time-today)
13436 (* (string-to-number (match-string 1 s))
13437 (cdr (assoc (match-string 2 s)
13438 '(("d" . 86400.0) ("w" . 604800.0)
13439 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13440 (t (org-2ft s)))))
13442 (defun org-match-any-p (re list)
13443 "Does re match any element of list?"
13444 (setq list (mapcar (lambda (x) (string-match re x)) list))
13445 (delq nil list))
13447 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13448 (defvar org-tags-overlay (make-overlay 1 1))
13449 (org-detach-overlay org-tags-overlay)
13451 (defun org-get-local-tags-at (&optional pos)
13452 "Get a list of tags defined in the current headline."
13453 (org-get-tags-at pos 'local))
13455 (defun org-get-local-tags ()
13456 "Get a list of tags defined in the current headline."
13457 (org-get-tags-at nil 'local))
13459 (defun org-get-tags-at (&optional pos local)
13460 "Get a list of all headline tags applicable at POS.
13461 POS defaults to point. If tags are inherited, the list contains
13462 the targets in the same sequence as the headlines appear, i.e.
13463 the tags of the current headline come last.
13464 When LOCAL is non-nil, only return tags from the current headline,
13465 ignore inherited ones."
13466 (interactive)
13467 (if (and org-trust-scanner-tags
13468 (or (not pos) (equal pos (point)))
13469 (not local))
13470 org-scanner-tags
13471 (let (tags ltags lastpos parent)
13472 (save-excursion
13473 (save-restriction
13474 (widen)
13475 (goto-char (or pos (point)))
13476 (save-match-data
13477 (catch 'done
13478 (condition-case nil
13479 (progn
13480 (org-back-to-heading t)
13481 (while (not (equal lastpos (point)))
13482 (setq lastpos (point))
13483 (when (looking-at
13485 (setq ltags (org-split-string
13486 (org-match-string-no-properties 1) ":"))
13487 (when parent
13488 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13489 (setq tags (append
13490 (if parent
13491 (org-remove-uninherited-tags ltags)
13492 ltags)
13493 tags)))
13494 (or org-use-tag-inheritance (throw 'done t))
13495 (if local (throw 'done t))
13496 (or (org-up-heading-safe) (error nil))
13497 (setq parent t)))
13498 (error nil)))))
13499 (if local
13500 tags
13501 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13503 (defun org-add-prop-inherited (s)
13504 (add-text-properties 0 (length s) '(inherited t) s)
13505 s)
13507 (defun org-toggle-tag (tag &optional onoff)
13508 "Toggle the tag TAG for the current line.
13509 If ONOFF is `on' or `off', don't toggle but set to this state."
13510 (let (res current)
13511 (save-excursion
13512 (org-back-to-heading t)
13514 (point-at-eol) t)
13515 (progn
13516 (setq current (match-string 1))
13517 (replace-match ""))
13518 (setq current ""))
13519 (setq current (nreverse (org-split-string current ":")))
13520 (cond
13521 ((eq onoff 'on)
13522 (setq res t)
13523 (or (member tag current) (push tag current)))
13524 ((eq onoff 'off)
13525 (or (not (member tag current)) (setq current (delete tag current))))
13526 (t (if (member tag current)
13527 (setq current (delete tag current))
13528 (setq res t)
13529 (push tag current))))
13530 (end-of-line 1)
13531 (if current
13532 (progn
13533 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13534 (org-set-tags nil t))
13535 (delete-horizontal-space))
13536 (run-hooks 'org-after-tags-change-hook))
13537 res))
13539 (defun org-align-tags-here (to-col)
13540 ;; Assumes that this is a headline
13541 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13542 (beginning-of-line 1)
13544 (< pos (match-beginning 2)))
13545 (progn
13546 (setq tags-l (- (match-end 2) (match-beginning 2)))
13547 (goto-char (match-beginning 1))
13548 (insert " ")
13549 (delete-region (point) (1+ (match-beginning 2)))
13550 (setq ncol (max (current-column)
13551 (1+ col)
13552 (if (> to-col 0)
13553 to-col
13554 (- (abs to-col) tags-l))))
13555 (setq p (point))
13556 (insert (make-string (- ncol (current-column)) ?\ ))
13557 (setq ncol (current-column))
13558 (when indent-tabs-mode (tabify p (point-at-eol)))
13559 (org-move-to-column (min ncol col) t))
13560 (goto-char pos))))
13562 (defun org-set-tags-command (&optional arg just-align)
13563 "Call the set-tags command for the current entry."
13564 (interactive "P")
13565 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13566 (org-set-tags arg just-align)
13567 (save-excursion
13568 (org-back-to-heading t)
13569 (org-set-tags arg just-align))))
13571 (defun org-set-tags-to (data)
13572 "Set the tags of the current entry to DATA, replacing the current tags.
13573 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13574 If DATA is nil or the empty string, any tags will be removed."
13575 (interactive "sTags: ")
13576 (setq data
13577 (cond
13578 ((eq data nil) "")
13579 ((equal data "") "")
13580 ((stringp data)
13581 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13582 ":"))
13583 ((listp data)
13584 (concat ":" (mapconcat 'identity data ":") ":"))))
13585 (when data
13586 (save-excursion
13587 (org-back-to-heading t)
13588 (when (looking-at org-complex-heading-regexp)
13589 (if (match-end 5)
13590 (progn
13591 (goto-char (match-beginning 5))
13592 (insert data)
13593 (delete-region (point) (point-at-eol))
13594 (org-set-tags nil 'align))
13595 (goto-char (point-at-eol))
13596 (insert " " data)
13597 (org-set-tags nil 'align)))
13598 (beginning-of-line 1)
13600 (delete-region (match-beginning 1) (match-end 1))))))
13602 (defun org-align-all-tags ()
13603 "Align the tags i all headings."
13604 (interactive)
13605 (save-excursion
13606 (or (ignore-errors (org-back-to-heading t))
13607 (outline-next-heading))
13608 (if (org-at-heading-p)
13609 (org-set-tags t)
13610 (message "No headings"))))
13612 (defvar org-indent-indentation-per-level)
13613 (defun org-set-tags (&optional arg just-align)
13614 "Set the tags for the current headline.
13615 With prefix ARG, realign all tags in headings in the current buffer."
13616 (interactive "P")
13617 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13618 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13619 'region-start-level 'region))
13620 org-loop-over-headlines-in-active-region)
13621 (org-map-entries
13622 ;; We don't use ARG and JUST-ALIGN here these args are not
13623 ;; useful when looping over headlines
13624 `(org-set-tags)
13625 org-loop-over-headlines-in-active-region
13626 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13627 (let* ((re org-outline-regexp-bol)
13628 (current (unless arg (org-get-tags-string)))
13629 (col (current-column))
13630 (org-setting-tags t)
13631 table current-tags inherited-tags ; computed below when needed
13632 tags p0 c0 c1 rpl di tc level)
13633 (if arg
13634 (save-excursion
13635 (goto-char (point-min))
13636 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13637 (while (re-search-forward re nil t)
13638 (org-set-tags nil t)
13639 (end-of-line 1)))
13640 (message "All tags realigned to column %d" org-tags-column))
13641 (if just-align
13642 (setq tags current)
13643 ;; Get a new set of tags from the user
13644 (save-excursion
13645 (setq table (append org-tag-persistent-alist
13646 (or org-tag-alist (org-get-buffer-tags))
13647 (and
13648 org-complete-tags-always-offer-all-agenda-tags
13649 (org-global-tags-completion-table
13650 (org-agenda-files))))
13651 org-last-tags-completion-table table
13652 current-tags (org-split-string current ":")
13653 inherited-tags (nreverse
13654 (nthcdr (length current-tags)
13655 (nreverse (org-get-tags-at))))
13656 tags
13657 (if (or (eq t org-use-fast-tag-selection)
13658 (and org-use-fast-tag-selection
13659 (delq nil (mapcar 'cdr table))))
13660 (org-fast-tag-selection
13661 current-tags inherited-tags table
13662 (if org-fast-tag-selection-include-todo
13663 org-todo-key-alist))
13664 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13665 (org-trim
13666 (org-icompleting-read "Tags: "
13667 'org-tags-completion-function
13668 nil nil current 'org-tags-history))))))
13669 (while (string-match "[-+&]+" tags)
13670 ;; No boolean logic, just a list
13671 (setq tags (replace-match ":" t t tags))))
13673 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13675 (if org-tags-sort-function
13676 (setq tags (mapconcat 'identity
13677 (sort (org-split-string
13678 tags (org-re "[^[:alnum:]_@#%]+"))
13679 org-tags-sort-function) ":")))
13682 (setq tags "")
13683 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13684 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13686 ;; Insert new tags at the correct column
13687 (beginning-of-line 1)
13688 (setq level (or (and (looking-at org-outline-regexp)
13689 (- (match-end 0) (point) 1))
13690 1))
13691 (cond
13692 ((and (equal current "") (equal tags "")))
13693 ((re-search-forward
13695 (point-at-eol) t)
13696 (if (equal tags "")
13697 (setq rpl "")
13698 (goto-char (match-beginning 0))
13699 (setq c0 (current-column)
13700 ;; compute offset for the case of org-indent-mode active
13701 di (if org-indent-mode
13702 (* (1- org-indent-indentation-per-level) (1- level))
13703 0)
13704 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13705 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13706 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13707 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13708 (replace-match rpl t t)
13709 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13710 tags)
13711 (t (error "Tags alignment failed")))
13712 (org-move-to-column col)
13713 (unless just-align
13714 (run-hooks 'org-after-tags-change-hook))))))
13716 (defun org-change-tag-in-region (beg end tag off)
13717 "Add or remove TAG for each entry in the region.
13718 This works in the agenda, and also in an org-mode buffer."
13719 (interactive
13720 (list (region-beginning) (region-end)
13721 (let ((org-last-tags-completion-table
13722 (if (derived-mode-p 'org-mode)
13723 (org-get-buffer-tags)
13724 (org-global-tags-completion-table))))
13725 (org-icompleting-read
13726 "Tag: " 'org-tags-completion-function nil nil nil
13727 'org-tags-history))
13728 (progn
13730 (equal (read-char-exclusive) ?r))))
13731 (if (fboundp 'deactivate-mark) (deactivate-mark))
13732 (let ((agendap (equal major-mode 'org-agenda-mode))
13733 l1 l2 m buf pos newhead (cnt 0))
13734 (goto-char end)
13735 (setq l2 (1- (org-current-line)))
13736 (goto-char beg)
13737 (setq l1 (org-current-line))
13738 (loop for l from l1 to l2 do
13739 (org-goto-line l)
13740 (setq m (get-text-property (point) 'org-hd-marker))
13741 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
13742 (and agendap m))
13743 (setq buf (if agendap (marker-buffer m) (current-buffer))
13744 pos (if agendap m (point)))
13745 (with-current-buffer buf
13746 (save-excursion
13747 (save-restriction
13748 (goto-char pos)
13749 (setq cnt (1+ cnt))
13750 (org-toggle-tag tag (if off 'off 'on))
13751 (setq newhead (org-get-heading)))))
13752 (and agendap (org-agenda-change-all-lines newhead m))))
13753 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13755 (defun org-tags-completion-function (string predicate &optional flag)
13756 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13757 (confirm (lambda (x) (stringp (car x)))))
13759 (setq s1 (match-string 1 string)
13760 s2 (match-string 2 string))
13761 (setq s1 "" s2 string))
13762 (cond
13763 ((eq flag nil)
13764 ;; try completion
13765 (setq rtn (try-completion s2 ctable confirm))
13766 (if (stringp rtn)
13767 (setq rtn
13768 (concat s1 s2 (substring rtn (length s2))
13769 (if (and org-add-colon-after-tag-completion
13770 (assoc rtn ctable))
13771 ":" ""))))
13772 rtn)
13773 ((eq flag t)
13774 ;; all-completions
13775 (all-completions s2 ctable confirm)
13776 )
13777 ((eq flag 'lambda)
13778 ;; exact match?
13779 (assoc s2 ctable)))
13780 ))
13782 (defun org-fast-tag-insert (kwd tags face &optional end)
13783 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13784 (insert (format "%-12s" (concat kwd ":"))
13785 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13786 (or end "")))
13788 (defun org-fast-tag-show-exit (flag)
13789 (save-excursion
13790 (org-goto-line 3)
13792 (replace-match ""))
13793 (when flag
13794 (end-of-line 1)
13795 (org-move-to-column (- (window-width) 19) t)
13796 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13798 (defun org-set-current-tags-overlay (current prefix)
13799 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13800 (if (featurep 'xemacs)
13801 (org-overlay-display org-tags-overlay (concat prefix s)
13802 'secondary-selection)
13803 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13804 (org-overlay-display org-tags-overlay (concat prefix s)))))
13806 (defvar org-last-tag-selection-key nil)
13807 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13808 "Fast tag selection with single keys.
13809 CURRENT is the current list of tags in the headline, INHERITED is the
13810 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13811 possibly with grouping information. TODO-TABLE is a similar table with
13812 TODO keywords, should these have keys assigned to them.
13813 If the keys are nil, a-z are automatically assigned.
13814 Returns the new tags string, or nil to not change the current settings."
13815 (let* ((fulltable (append table todo-table))
13816 (maxlen (apply 'max (mapcar
13817 (lambda (x)
13818 (if (stringp (car x)) (string-width (car x)) 0))
13819 fulltable)))
13820 (buf (current-buffer))
13821 (expert (eq org-fast-tag-selection-single-key 'expert))
13822 (buffer-tags nil)
13823 (fwidth (+ maxlen 3 1 3))
13824 (ncol (/ (- (window-width) 4) fwidth))
13825 (i-face 'org-done)
13826 (c-face 'org-todo)
13827 tg cnt e c char c1 c2 ntable tbl rtn
13828 ov-start ov-end ov-prefix
13829 (exit-after-next org-fast-tag-selection-single-key)
13830 (done-keywords org-done-keywords)
13831 groups ingroup)
13832 (save-excursion
13833 (beginning-of-line 1)
13834 (if (looking-at
13836 (setq ov-start (match-beginning 1)
13837 ov-end (match-end 1)
13838 ov-prefix "")
13839 (setq ov-start (1- (point-at-eol))
13840 ov-end (1+ ov-start))
13842 (setq ov-prefix
13843 (concat
13844 (buffer-substring (1- (point)) (point))
13845 (if (> (current-column) org-tags-column)
13846 " "
13847 (make-string (- org-tags-column (current-column)) ?\ ))))))
13848 (move-overlay org-tags-overlay ov-start ov-end)
13849 (save-window-excursion
13850 (if expert
13851 (set-buffer (get-buffer-create " *Org tags*"))
13852 (delete-other-windows)
13853 (split-window-vertically)
13854 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13855 (erase-buffer)
13856 (org-set-local 'org-done-keywords done-keywords)
13859 (org-fast-tag-show-exit exit-after-next)
13860 (org-set-current-tags-overlay current ov-prefix)
13861 (setq tbl fulltable char ?a cnt 0)
13862 (while (setq e (pop tbl))
13863 (cond
13864 ((equal (car e) :startgroup)
13865 (push '() groups) (setq ingroup t)
13866 (when (not (= cnt 0))
13867 (setq cnt 0)
13869 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13870 ((equal (car e) :endgroup)
13871 (setq ingroup nil cnt 0)
13873 ((equal e '(:newline))
13874 (when (not (= cnt 0))
13875 (setq cnt 0)
13877 (setq e (car tbl))
13878 (while (equal (car tbl) '(:newline))
13880 (setq tbl (cdr tbl)))))
13881 (t
13882 (setq tg (copy-sequence (car e)) c2 nil)
13883 (if (cdr e)
13884 (setq c (cdr e))
13885 ;; automatically assign a character.
13886 (setq c1 (string-to-char
13887 (downcase (substring
13888 tg (if (= (string-to-char tg) ?@) 1 0)))))
13889 (if (or (rassoc c1 ntable) (rassoc c1 table))
13890 (while (or (rassoc char ntable) (rassoc char table))
13891 (setq char (1+ char)))
13892 (setq c2 c1))
13893 (setq c (or c2 char)))
13894 (if ingroup (push tg (car groups)))
13895 (setq tg (org-add-props tg nil 'face
13896 (cond
13897 ((not (assoc tg table))
13898 (org-get-todo-face tg))
13899 ((member tg current) c-face)
13900 ((member tg inherited) i-face))))
13901 (if (and (= cnt 0) (not ingroup)) (insert " "))
13902 (insert "[" c "] " tg (make-string
13903 (- fwidth 4 (length tg)) ?\ ))
13904 (push (cons tg c) ntable)
13905 (when (= (setq cnt (1+ cnt)) ncol)
13907 (if ingroup (insert " "))
13908 (setq cnt 0)))))
13909 (setq ntable (nreverse ntable))
13911 (goto-char (point-min))
13912 (if (not expert) (org-fit-window-to-buffer))
13913 (setq rtn
13914 (catch 'exit
13915 (while t
13916 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13917 (if (not groups) "no " "")
13918 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13919 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13920 (setq org-last-tag-selection-key c)
13921 (cond
13923 ((= c ?!)
13924 (setq groups (not groups))
13925 (goto-char (point-min))
13926 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13927 ((= c ?\C-c)
13928 (if (not expert)
13929 (org-fast-tag-show-exit
13930 (setq exit-after-next (not exit-after-next)))
13931 (setq expert nil)
13932 (delete-other-windows)
13933 (set-window-buffer (split-window-vertically) " *Org tags*")
13934 (org-switch-to-buffer-other-window " *Org tags*")
13935 (org-fit-window-to-buffer)))
13936 ((or (= c ?\C-g)
13937 (and (= c ?q) (not (rassoc c ntable))))
13938 (org-detach-overlay org-tags-overlay)
13939 (setq quit-flag t))
13940 ((= c ?\ )
13941 (setq current nil)
13942 (if exit-after-next (setq exit-after-next 'now)))
13944 (condition-case nil
13945 (setq tg (org-icompleting-read
13946 "Tag: "
13947 (or buffer-tags
13948 (with-current-buffer buf
13949 (org-get-buffer-tags)))))
13950 (quit (setq tg "")))
13952 (add-to-list 'buffer-tags (list tg))
13953 (if (member tg current)
13954 (setq current (delete tg current))
13955 (push tg current)))
13956 (if exit-after-next (setq exit-after-next 'now)))
13957 ((setq e (rassoc c todo-table) tg (car e))
13958 (with-current-buffer buf
13959 (save-excursion (org-todo tg)))
13960 (if exit-after-next (setq exit-after-next 'now)))
13961 ((setq e (rassoc c ntable) tg (car e))
13962 (if (member tg current)
13963 (setq current (delete tg current))
13964 (loop for g in groups do
13965 (if (member tg g)
13966 (mapc (lambda (x)
13967 (setq current (delete x current)))
13968 g)))
13969 (push tg current))
13970 (if exit-after-next (setq exit-after-next 'now))))
13972 ;; Create a sorted list
13973 (setq current
13974 (sort current
13975 (lambda (a b)
13976 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13977 (if (eq exit-after-next 'now) (throw 'exit t))
13978 (goto-char (point-min))
13979 (beginning-of-line 2)
13980 (delete-region (point) (point-at-eol))
13981 (org-fast-tag-insert "Current" current c-face)
13982 (org-set-current-tags-overlay current ov-prefix)
13983 (while (re-search-forward
13985 (setq tg (match-string 1))
13986 (add-text-properties
13987 (match-beginning 1) (match-end 1)
13988 (list 'face
13989 (cond
13990 ((member tg current) c-face)
13991 ((member tg inherited) i-face)
13992 (t (get-text-property (match-beginning 1) 'face))))))
13993 (goto-char (point-min)))))
13994 (org-detach-overlay org-tags-overlay)
13995 (if rtn
13996 (mapconcat 'identity current ":")
13997 nil))))
13999 (defun org-get-tags-string ()
14000 "Get the TAGS string in the current headline."
14001 (unless (org-at-heading-p t)
14002 (error "Not on a heading"))
14003 (save-excursion
14004 (beginning-of-line 1)
14006 (org-match-string-no-properties 1)
14007 "")))
14009 (defun org-get-tags ()
14010 "Get the list of tags specified in the current headline."
14011 (org-split-string (org-get-tags-string) ":"))
14013 (defun org-get-buffer-tags ()
14014 "Get a table of all tags used in the buffer, for completion."
14015 (let (tags)
14016 (save-excursion
14017 (goto-char (point-min))
14018 (while (re-search-forward
14020 (when (equal (char-after (point-at-bol 0)) ?*)
14021 (mapc (lambda (x) (add-to-list 'tags x))
14022 (org-split-string (org-match-string-no-properties 1) ":")))))
14023 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14024 (mapcar 'list tags)))
14026 ;;;; The mapping API
14028 (defun org-map-entries (func &optional match scope &rest skip)
14029 "Call FUNC at each headline selected by MATCH in SCOPE.
14031 FUNC is a function or a lisp form. The function will be called without
14032 arguments, with the cursor positioned at the beginning of the headline.
14033 The return values of all calls to the function will be collected and
14034 returned as a list.
14036 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14037 does not need to preserve point. After evaluation, the cursor will be
14038 moved to the end of the line (presumably of the headline of the
14039 processed entry) and search continues from there. Under some
14040 circumstances, this may not produce the wanted results. For example,
14041 if you have removed (e.g. archived) the current (sub)tree it could
14042 mean that the next entry will be skipped entirely. In such cases, you
14043 can specify the position from where search should continue by making
14044 FUNC set the variable `org-map-continue-from' to the desired buffer
14045 position.
14047 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14048 Only headlines that are matched by this query will be considered during
14049 the iteration. When MATCH is nil or t, all headlines will be
14050 visited by the iteration.
14052 SCOPE determines the scope of this command. It can be any of:
14054 nil The current buffer, respecting the restriction if any
14055 tree The subtree started with the entry at point
14056 region The entries within the active region, if any
14057 region-start-level
14058 The entries within the active region, but only those at
14059 the same level than the first one.
14060 file The current buffer, without restriction
14061 file-with-archives
14062 The current buffer, and any archives associated with it
14063 agenda All agenda files
14064 agenda-with-archives
14065 All agenda files with any archive files associated with them
14066 \(file1 file2 ...)
14067 If this is a list, all files in the list will be scanned
14069 The remaining args are treated as settings for the skipping facilities of
14070 the scanner. The following items can be given here:
14072 archive skip trees with the archive tag.
14073 comment skip trees with the COMMENT keyword
14074 function or Emacs Lisp form:
14075 will be used as value for `org-agenda-skip-function', so whenever
14076 the function returns t, FUNC will not be called for that
14077 entry and search will continue from the point where the
14078 function leaves it.
14080 If your function needs to retrieve the tags including inherited tags
14081 at the *current* entry, you can use the value of the variable
14082 `org-scanner-tags' which will be much faster than getting the value
14083 with `org-get-tags-at'. If your function gets properties with
14084 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14085 to t around the call to `org-entry-properties' to get the same speedup.
14086 Note that if your function moves around to retrieve tags and properties at
14087 a *different* entry, you cannot use these techniques."
14088 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14089 (not (org-region-active-p)))
14090 (let* ((org-agenda-archives-mode nil) ; just to make sure
14091 (org-agenda-skip-archived-trees (memq 'archive skip))
14092 (org-agenda-skip-comment-trees (memq 'comment skip))
14093 (org-agenda-skip-function
14094 (car (org-delete-all '(comment archive) skip)))
14095 (org-tags-match-list-sublevels t)
14096 (start-level (eq scope 'region-start-level))
14097 matcher file res
14098 org-todo-keywords-for-agenda
14099 org-done-keywords-for-agenda
14100 org-todo-keyword-alist-for-agenda
14101 org-drawers-for-agenda
14102 org-tag-alist-for-agenda
14103 todo-only)
14105 (cond
14106 ((eq match t) (setq matcher t))
14107 ((eq match nil) (setq matcher t))
14108 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14110 (save-excursion
14111 (save-restriction
14112 (cond ((eq scope 'tree)
14113 (org-back-to-heading t)
14114 (org-narrow-to-subtree)
14115 (setq scope nil))
14116 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14117 (org-region-active-p))
14118 ;; If needed, set start-level to a string like "2"
14119 (when start-level
14120 (save-excursion
14121 (goto-char (region-beginning))
14122 (unless (org-at-heading-p) (outline-next-heading))
14123 (setq start-level (org-current-level))))
14124 (narrow-to-region (region-beginning)
14125 (save-excursion
14126 (goto-char (region-end))
14127 (unless (and (bolp) (org-at-heading-p))
14128 (outline-next-heading))
14129 (point)))
14130 (setq scope nil)))
14132 (if (not scope)
14133 (progn
14134 (org-agenda-prepare-buffers
14135 (list (buffer-file-name (current-buffer))))
14136 (setq res (org-scan-tags func matcher todo-only start-level)))
14137 ;; Get the right scope
14138 (cond
14139 ((and scope (listp scope) (symbolp (car scope)))
14140 (setq scope (eval scope)))
14141 ((eq scope 'agenda)
14142 (setq scope (org-agenda-files t)))
14143 ((eq scope 'agenda-with-archives)
14144 (setq scope (org-agenda-files t))
14145 (setq scope (org-add-archive-files scope)))
14146 ((eq scope 'file)
14147 (setq scope (list (buffer-file-name))))
14148 ((eq scope 'file-with-archives)
14149 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14150 (org-agenda-prepare-buffers scope)
14151 (while (setq file (pop scope))
14152 (with-current-buffer (org-find-base-buffer-visiting file)
14153 (save-excursion
14154 (save-restriction
14155 (widen)
14156 (goto-char (point-min))
14157 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14158 res)))
14160 ;;;; Properties
14162 ;;; Setting and retrieving properties
14164 (defconst org-special-properties
14165 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14166 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14167 "The special properties valid in Org-mode.
14169 These are properties that are not defined in the property drawer,
14170 but in some other way.")
14172 (defconst org-default-properties
14173 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14174 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14175 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14176 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14177 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14178 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14179 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14180 "Some properties that are used by Org-mode for various purposes.
14181 Being in this list makes sure that they are offered for completion.")
14184 "Regular expression matching the first line of a property drawer.")
14187 "Regular expression matching the last line of a property drawer.")
14190 "Regular expression matching the first line of a property drawer.")
14193 "Regular expression matching the first line of a property drawer.")
14195 (defconst org-property-drawer-re
14198 "Matches an entire property drawer.")
14200 (defconst org-clock-drawer-re
14203 "Matches an entire clock drawer.")
14205 (defsubst org-re-property (property)
14206 "Return a regexp matching a PROPERTY line.
14207 Match group 1 will be set to the value."
14210 (defsubst org-re-property-keyword (property)
14211 "Return a regexp matching a PROPERTY line, possibly with no
14212 value for the property."
14215 (defun org-property-action ()
14216 "Do an action on properties."
14217 (interactive)
14218 (let (c)
14219 (org-at-property-p)
14220 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14221 (setq c (read-char-exclusive))
14222 (cond
14223 ((equal c ?s)
14224 (call-interactively 'org-set-property))
14225 ((equal c ?d)
14226 (call-interactively 'org-delete-property))
14227 ((equal c ?D)
14228 (call-interactively 'org-delete-property-globally))
14229 ((equal c ?c)
14230 (call-interactively 'org-compute-property-at-point))
14231 (t (error "No such property action %c" c)))))
14233 (defun org-inc-effort ()
14234 "Increment the value of the effort property in the current entry."
14235 (interactive)
14236 (org-set-effort nil t))
14238 (defun org-set-effort (&optional value increment)
14239 "Set the effort property of the current entry.
14240 With numerical prefix arg, use the nth allowed value, 0 stands for the
14241 10th allowed value.
14243 When INCREMENT is non-nil, set the property to the next allowed value."
14244 (interactive "P")
14245 (if (equal value 0) (setq value 10))
14246 (let* ((completion-ignore-case t)
14247 (prop org-effort-property)
14248 (cur (org-entry-get nil prop))
14249 (allowed (org-property-get-allowed-values nil prop 'table))
14250 (existing (mapcar 'list (org-property-values prop)))
14251 rpl
14252 (val (cond
14253 ((stringp value) value)
14254 ((and allowed (integerp value))
14255 (or (car (nth (1- value) allowed))
14256 (car (org-last allowed))))
14257 ((and allowed increment)
14258 (or (caadr (member (list cur) allowed))
14259 (error "Allowed effort values are not set")))
14260 (allowed
14261 (message "Select 1-9,0, [RET%s]: %s"
14262 (if cur (concat "=" cur) "")
14263 (mapconcat 'car allowed " "))
14264 (setq rpl (read-char-exclusive))
14266 cur
14267 (setq rpl (- rpl ?0))
14268 (if (equal rpl 0) (setq rpl 10))
14269 (if (and (> rpl 0) (<= rpl (length allowed)))
14270 (car (nth (1- rpl) allowed))
14271 (org-completing-read "Effort: " allowed nil))))
14272 (t
14273 (let (org-completion-use-ido org-completion-use-iswitchb)
14274 (org-completing-read
14276 (concat "[" cur "]") "")
14277 ": ")
14278 existing nil nil "" nil cur))))))
14279 (unless (equal (org-entry-get nil prop) val)
14280 (org-entry-put nil prop val))
14281 (message "%s is now %s" prop val)))
14283 (defun org-at-property-p ()
14284 "Is cursor inside a property drawer?"
14285 (save-excursion
14286 (beginning-of-line 1)
14288 (save-match-data ;; Used by calling procedures
14289 (let ((p (point))
14290 (range (unless (org-before-first-heading-p)
14291 (org-get-property-block))))
14292 (and range (<= (car range) p) (< p (cdr range))))))))
14294 (defun org-get-property-block (&optional beg end force)
14295 "Return the (beg . end) range of the body of the property drawer.
14296 BEG and END are the beginning and end of the current subtree, or of
14297 the part before the first headline. If they are not given, they will
14298 be found. If the drawer does not exist and FORCE is non-nil, create
14299 the drawer."
14300 (catch 'exit
14301 (save-excursion
14302 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
14303 (progn (org-back-to-heading t) (point))))
14304 (end (or end (and (not (outline-next-heading)) (point-max))
14305 (point))))
14306 (goto-char beg)
14307 (if (re-search-forward org-property-start-re end t)
14308 (setq beg (1+ (match-end 0)))
14309 (if force
14310 (save-excursion
14311 (org-insert-property-drawer)
14312 (setq end (progn (outline-next-heading) (point))))
14313 (throw 'exit nil))
14314 (goto-char beg)
14315 (if (re-search-forward org-property-start-re end t)
14316 (setq beg (1+ (match-end 0)))))
14317 (if (re-search-forward org-property-end-re end t)
14318 (setq end (match-beginning 0))
14319 (or force (throw 'exit nil))
14320 (goto-char beg)
14321 (setq end beg)
14322 (org-indent-line)
14324 (cons beg end)))))
14326 (defun org-entry-properties (&optional pom which specific)
14327 "Get all properties of the entry at point-or-marker POM.
14328 This includes the TODO keyword, the tags, time strings for deadline,
14329 scheduled, and clocking, and any additional properties defined in the
14330 entry. The return value is an alist, keys may occur multiple times
14331 if the property key was used several times.
14332 POM may also be nil, in which case the current entry is used.
14333 If WHICH is nil or `all', get all properties. If WHICH is
14334 `special' or `standard', only get that subclass. If WHICH
14335 is a string only get exactly this property. SPECIFIC can be a string, the
14336 specific property we are interested in. Specifying it can speed
14337 things up because then unnecessary parsing is avoided."
14338 (setq which (or which 'all))
14339 (org-with-point-at pom
14340 (let ((clockstr (substring org-clock-string 0 -1))
14341 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14342 (case-fold-search nil)
14343 beg end range props sum-props key key1 value string clocksum clocksumt)
14344 (save-excursion
14345 (when (condition-case nil
14346 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14347 (error nil))
14348 (setq beg (point))
14349 (setq sum-props (get-text-property (point) 'org-summaries))
14350 (setq clocksum (get-text-property (point) :org-clock-minutes)
14351 clocksumt (get-text-property (point) :org-clock-minutes-today))
14352 (outline-next-heading)
14353 (setq end (point))
14354 (when (memq which '(all special))
14355 ;; Get the special properties, like TODO and tags
14356 (goto-char beg)
14357 (when (and (or (not specific) (string= specific "TODO"))
14358 (looking-at org-todo-line-regexp) (match-end 2))
14359 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14360 (when (and (or (not specific) (string= specific "PRIORITY"))
14361 (looking-at org-priority-regexp))
14362 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14363 (when (or (not specific) (string= specific "FILE"))
14364 (push (cons "FILE" buffer-file-name) props))
14365 (when (and (or (not specific) (string= specific "TAGS"))
14366 (setq value (org-get-tags-string))
14368 (push (cons "TAGS" value) props))
14369 (when (and (or (not specific) (string= specific "ALLTAGS"))
14370 (setq value (org-get-tags-at)))
14371 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14372 ":"))
14373 props))
14374 (when (or (not specific) (string= specific "BLOCKED"))
14375 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14376 (when (or (not specific)
14377 (member specific
14378 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14379 "TIMESTAMP" "TIMESTAMP_IA")))
14380 (catch 'match
14381 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14382 (setq key (if (match-end 1)
14383 (substring (org-match-string-no-properties 1)
14384 0 -1))
14385 string (if (equal key clockstr)
14386 (org-trim
14387 (buffer-substring-no-properties
14388 (match-beginning 3) (goto-char
14389 (point-at-eol))))
14390 (substring (org-match-string-no-properties 3)
14391 1 -1)))
14392 ;; Get the correct property name from the key. This is
14393 ;; necessary if the user has configured time keywords.
14394 (setq key1 (concat key ":"))
14395 (cond
14396 ((not key)
14397 (setq key
14398 (if (= (char-after (match-beginning 3)) ?\[)
14399 "TIMESTAMP_IA" "TIMESTAMP")))
14400 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14401 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14402 ((equal key1 org-closed-string) (setq key "CLOSED"))
14403 ((equal key1 org-clock-string) (setq key "CLOCK")))
14404 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14405 (progn
14406 (push (cons key string) props)
14407 ;; no need to search further if match is found
14408 (throw 'match t))
14409 (when (or (equal key "CLOCK") (not (assoc key props)))
14410 (push (cons key string) props)))))))
14412 (when (memq which '(all standard))
14413 ;; Get the standard properties, like :PROP: ...
14414 (setq range (org-get-property-block beg end))
14415 (when range
14416 (goto-char (car range))
14417 (while (re-search-forward
14419 (cdr range) t)
14420 (setq key (org-match-string-no-properties 1)
14421 value (org-trim (or (org-match-string-no-properties 2) "")))
14422 (unless (member key excluded)
14423 (push (cons key (or value "")) props)))))
14424 (if clocksum
14425 (push (cons "CLOCKSUM"
14426 (org-columns-number-to-string (/ (float clocksum) 60.)
14427 'add_times))
14428 props))
14429 (if clocksumt
14430 (push (cons "CLOCKSUM_T"
14431 (org-columns-number-to-string (/ (float clocksumt) 60.)
14432 'add_times))
14433 props))
14434 (unless (assoc "CATEGORY" props)
14435 (push (cons "CATEGORY" (org-get-category)) props))
14436 (append sum-props (nreverse props)))))))
14438 (defun org-entry-get (pom property &optional inherit literal-nil)
14439 "Get value of PROPERTY for entry or content at point-or-marker POM.
14440 If INHERIT is non-nil and the entry does not have the property,
14441 then also check higher levels of the hierarchy.
14442 If INHERIT is the symbol `selective', use inheritance only if the setting
14443 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14444 If the property is present but empty, the return value is the empty string.
14445 If the property is not present at all, nil is returned.
14448 do not interpret it as the list atom nil. This is used for inheritance
14450 (org-with-point-at pom
14451 (if (and inherit (if (eq inherit 'selective)
14452 (org-property-inherit-p property)
14453 t))
14454 (org-entry-get-with-inheritance property literal-nil)
14455 (if (member property org-special-properties)
14456 ;; We need a special property. Use `org-entry-properties' to
14457 ;; retrieve it, but specify the wanted property
14458 (cdr (assoc property (org-entry-properties nil 'special property)))
14459 (let* ((range (org-get-property-block))
14460 (props (list (or (assoc property org-file-properties)
14461 (assoc property org-global-properties)
14462 (assoc property org-global-properties-fixed))))
14463 (ap (lambda (key)
14464 (when (re-search-forward
14465 (org-re-property key) (cdr range) t)
14466 (setq props
14467 (org-update-property-plist
14468 key
14469 (if (match-end 1)
14470 (org-match-string-no-properties 1) "")
14471 props)))))
14472 val)
14473 (when (and range (goto-char (car range)))
14474 (funcall ap property)
14475 (goto-char (car range))
14476 (while (funcall ap (concat property "+")))
14477 (setq val (cdr (assoc property props)))
14478 (when val (if literal-nil val (org-not-nil val)))))))))
14480 (defun org-property-or-variable-value (var &optional inherit)
14481 "Check if there is a property fixing the value of VAR.
14482 If yes, return this value. If not, return the current value of the variable."
14483 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14485 (read prop)
14486 (symbol-value var))))
14488 (defun org-entry-delete (pom property)
14489 "Delete the property PROPERTY from entry at point-or-marker POM."
14490 (org-with-point-at pom
14491 (if (member property org-special-properties)
14492 nil ; cannot delete these properties.
14493 (let ((range (org-get-property-block)))
14494 (if (and range
14495 (goto-char (car range))
14496 (re-search-forward
14497 (org-re-property property)
14498 (cdr range) t))
14499 (progn
14500 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14501 t)
14502 nil)))))
14504 ;; Multi-values properties are properties that contain multiple values
14505 ;; These values are assumed to be single words, separated by whitespace.
14506 (defun org-entry-add-to-multivalued-property (pom property value)
14507 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14508 (let* ((old (org-entry-get pom property))
14510 (setq value (org-entry-protect-space value))
14511 (unless (member value values)
14512 (setq values (cons value values))
14513 (org-entry-put pom property
14514 (mapconcat 'identity values " ")))))
14516 (defun org-entry-remove-from-multivalued-property (pom property value)
14517 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14518 (let* ((old (org-entry-get pom property))
14520 (setq value (org-entry-protect-space value))
14521 (when (member value values)
14522 (setq values (delete value values))
14523 (org-entry-put pom property
14524 (mapconcat 'identity values " ")))))
14526 (defun org-entry-member-in-multivalued-property (pom property value)
14527 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14528 (let* ((old (org-entry-get pom property))
14530 (setq value (org-entry-protect-space value))
14531 (member value values)))
14533 (defun org-entry-get-multivalued-property (pom property)
14534 "Return a list of values in a multivalued property."
14535 (let* ((value (org-entry-get pom property))
14537 (mapcar 'org-entry-restore-space values)))
14539 (defun org-entry-put-multivalued-property (pom property &rest values)
14540 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14541 VALUES should be a list of strings. Spaces will be protected."
14542 (org-entry-put pom property
14543 (mapconcat 'org-entry-protect-space values " "))
14544 (let* ((value (org-entry-get pom property))
14546 (mapcar 'org-entry-restore-space values)))
14548 (defun org-entry-protect-space (s)
14549 "Protect spaces and newline in string S."
14550 (while (string-match " " s)
14551 (setq s (replace-match "%20" t t s)))
14553 (setq s (replace-match "%0A" t t s)))
14554 s)
14556 (defun org-entry-restore-space (s)
14557 "Restore spaces and newline in string S."
14558 (while (string-match "%20" s)
14559 (setq s (replace-match " " t t s)))
14560 (while (string-match "%0A" s)
14562 s)
14564 (defvar org-entry-property-inherited-from (make-marker)
14565 "Marker pointing to the entry from where a property was inherited.
14566 Each call to `org-entry-get-with-inheritance' will set this marker to the
14567 location of the entry where the inheritance search matched. If there was
14568 no match, the marker will point nowhere.
14569 Note that also `org-entry-get' calls this function, if the INHERIT flag
14570 is set.")
14572 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14573 "Get PROPERTY of entry or content at point, search higher levels if needed.
14574 The search will stop at the first ancestor which has the property defined.
14576 should be considered as undefined (this is the meaning of nil here).
14578 (move-marker org-entry-property-inherited-from nil)
14579 (let (tmp)
14580 (save-excursion
14581 (save-restriction
14582 (widen)
14583 (catch 'ex
14584 (while t
14585 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14586 (or (ignore-errors (org-back-to-heading t))
14587 (goto-char (point-min)))
14588 (move-marker org-entry-property-inherited-from (point))
14589 (throw 'ex tmp))
14590 (or (ignore-errors (org-up-heading-safe))
14591 (throw 'ex nil))))))
14592 (setq tmp (or tmp
14593 (cdr (assoc property org-file-properties))
14594 (cdr (assoc property org-global-properties))
14595 (cdr (assoc property org-global-properties-fixed))))
14596 (if literal-nil tmp (org-not-nil tmp))))
14598 (defvar org-property-changed-functions nil
14599 "Hook called when the value of a property has changed.
14600 Each hook function should accept two arguments, the name of the property
14601 and the new value.")
14603 (defun org-entry-put (pom property value)
14604 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14605 (org-with-point-at pom
14606 (org-back-to-heading t)
14607 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14608 range)
14609 (cond
14610 ((equal property "TODO")
14612 (not (member value org-todo-keywords-1)))
14614 (if (or (not value)
14616 (setq value 'none))
14617 (org-todo value)
14618 (org-set-tags nil 'align))
14619 ((equal property "PRIORITY")
14621 (string-to-char value) ?\ ))
14622 (org-set-tags nil 'align))
14623 ((equal property "SCHEDULED")
14624 (if (re-search-forward org-scheduled-time-regexp end t)
14625 (cond
14626 ((eq value 'earlier) (org-timestamp-change -1 'day))
14627 ((eq value 'later) (org-timestamp-change 1 'day))
14628 (t (call-interactively 'org-schedule)))
14629 (call-interactively 'org-schedule)))
14630 ((equal property "DEADLINE")
14631 (if (re-search-forward org-deadline-time-regexp end t)
14632 (cond
14633 ((eq value 'earlier) (org-timestamp-change -1 'day))
14634 ((eq value 'later) (org-timestamp-change 1 'day))
14635 (t (call-interactively 'org-deadline)))
14636 (call-interactively 'org-deadline)))
14637 ((member property org-special-properties)
14638 (error "The %s property can not yet be set with `org-entry-put'"
14639 property))
14640 (t ; a non-special property
14641 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14642 (setq range (org-get-property-block beg end 'force))
14643 (goto-char (car range))
14644 (if (re-search-forward
14645 (org-re-property-keyword property) (cdr range) t)
14646 (progn
14647 (delete-region (match-beginning 0) (match-end 0))
14648 (goto-char (match-beginning 0)))
14649 (goto-char (cdr range))
14651 (backward-char 1)
14652 (org-indent-line))
14653 (insert ":" property ":")
14654 (and value (insert " " value))
14655 (org-indent-line)))))
14656 (run-hook-with-args 'org-property-changed-functions property value)))
14658 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14659 "Get all property keys in the current buffer.
14660 With INCLUDE-SPECIALS, also list the special properties that reflect things
14661 like tags and TODO state.
14662 With INCLUDE-DEFAULTS, also include properties that has special meaning
14663 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14664 and others.
14665 With INCLUDE-COLUMNS, also include property names given in COLUMN
14666 formats in the current buffer."
14667 (let (rtn range cfmt s p)
14668 (save-excursion
14669 (save-restriction
14670 (widen)
14671 (goto-char (point-min))
14672 (while (re-search-forward org-property-start-re nil t)
14673 (setq range (org-get-property-block))
14674 (goto-char (car range))
14675 (while (re-search-forward
14677 (cdr range) t)
14678 (add-to-list 'rtn (org-match-string-no-properties 1)))
14679 (outline-next-heading))))
14681 (when include-specials
14682 (setq rtn (append org-special-properties rtn)))
14684 (when include-defaults
14685 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14686 (add-to-list 'rtn org-effort-property))
14688 (when include-columns
14689 (save-excursion
14690 (save-restriction
14691 (widen)
14692 (goto-char (point-min))
14693 (while (re-search-forward
14695 nil t)
14696 (setq cfmt (match-string 2) s 0)
14698 cfmt s)
14699 (setq s (match-end 0)
14700 p (match-string 1 cfmt))
14701 (unless (or (equal p "ITEM")
14702 (member p org-special-properties))
14703 (add-to-list 'rtn (match-string 1 cfmt))))))))
14705 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14707 (defun org-property-values (key)
14708 "Return a list of all values of property KEY in the current buffer."
14709 (save-excursion
14710 (save-restriction
14711 (widen)
14712 (goto-char (point-min))
14713 (let ((re (org-re-property key))
14714 values)
14715 (while (re-search-forward re nil t)
14716 (add-to-list 'values (org-trim (match-string 1))))
14717 (delete "" values)))))
14719 (defun org-insert-property-drawer ()
14720 "Insert a property drawer into the current entry."
14721 (org-back-to-heading t)
14722 (looking-at org-outline-regexp)
14723 (let ((indent (if org-adapt-indentation
14724 (- (match-end 0) (match-beginning 0))
14725 0))
14726 (beg (point))
14728 end hiddenp)
14729 (outline-next-heading)
14730 (setq end (point))
14731 (goto-char beg)
14732 (while (re-search-forward re end t))
14733 (setq hiddenp (outline-invisible-p))
14734 (end-of-line 1)
14737 (if (member (match-string 1) '("CLOCK:" ":END:"))
14738 ;; just skip this line
14739 (beginning-of-line 2)
14740 ;; Drawer start, find the end
14742 (beginning-of-line 1)))
14743 (org-skip-over-state-notes)
14745 (if (eq (char-before) ?*) (forward-char 1))
14747 (beginning-of-line 0)
14748 (org-indent-to-column indent)
14749 (beginning-of-line 2)
14750 (org-indent-to-column indent)
14751 (beginning-of-line 0)
14752 (if hiddenp
14753 (save-excursion
14754 (org-back-to-heading t)
14755 (hide-entry))
14756 (org-flag-drawer t))))
14758 (defun org-insert-drawer (&optional arg drawer)
14759 "Insert a drawer at point.
14761 Optional argument DRAWER, when non-nil, is a string representing
14762 drawer's name. Otherwise, the user is prompted for a name.
14764 If a region is active, insert the drawer around that region
14765 instead.
14767 Point is left between drawer's boundaries."
14768 (interactive "P")
14769 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14770 "LOGBOOK"))
14771 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14772 ;; internally by Org. They are meant to be inserted
14773 ;; automatically.
14774 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14775 ;; Remove system drawers from list. Note: For some reason,
14776 ;; `org-completing-read' ignores the predicate while
14777 ;; `completing-read' handles it fine.
14778 (drawer (if arg "PROPERTIES"
14779 (or drawer
14780 (completing-read
14781 "Drawer: " org-drawers
14782 (lambda (d) (not (member d system-drawers))))))))
14783 (cond
14784 ;; With C-u, fall back on `org-insert-property-drawer'
14785 (arg (org-insert-property-drawer))
14786 ;; With an active region, insert a drawer at point.
14787 ((not (org-region-active-p))
14788 (progn
14791 (forward-line -2)))
14792 ;; Otherwise, insert the drawer at point
14793 (t
14794 (let ((rbeg (region-beginning))
14795 (rend (copy-marker (region-end))))
14796 (unwind-protect
14797 (progn
14798 (goto-char rbeg)
14799 (beginning-of-line)
14800 (when (save-excursion
14801 (re-search-forward org-outline-regexp-bol rend t))
14802 (error "Drawers cannot contain headlines"))
14803 ;; Position point at the beginning of the first
14804 ;; non-blank line in region. Insert drawer's opening
14805 ;; there, then indent it.
14806 (org-skip-whitespace)
14807 (beginning-of-line)
14809 (forward-line -1)
14810 (indent-for-tab-command)
14811 ;; Move point to the beginning of the first blank line
14812 ;; after the last non-blank line in region. Insert
14813 ;; drawer's closing, then indent it.
14814 (goto-char rend)
14817 (deactivate-mark t)
14818 (indent-for-tab-command)
14820 ;; Clear marker, whatever the outcome of insertion is.
14821 (set-marker rend nil)))))))
14823 (defvar org-property-set-functions-alist nil
14824 "Property set function alist.
14825 Each entry should have the following format:
14827 (PROPERTY . READ-FUNCTION)
14829 The read function will be called with the same argument as
14830 `org-completing-read'.")
14832 (defun org-set-property-function (property)
14833 "Get the function that should be used to set PROPERTY.
14834 This is computed according to `org-property-set-functions-alist'."
14835 (or (cdr (assoc property org-property-set-functions-alist))
14836 'org-completing-read))
14838 (defun org-read-property-value (property)
14839 "Read PROPERTY value from user."
14840 (let* ((completion-ignore-case t)
14841 (allowed (org-property-get-allowed-values nil property 'table))
14842 (cur (org-entry-get nil property))
14843 (prompt (concat property " value"
14845 (concat " [" cur "]") "") ": "))
14846 (set-function (org-set-property-function property))
14847 (val (if allowed
14848 (funcall set-function prompt allowed nil
14849 (not (get-text-property 0 'org-unrestricted
14850 (caar allowed))))
14851 (let (org-completion-use-ido org-completion-use-iswitchb)
14852 (funcall set-function prompt
14853 (mapcar 'list (org-property-values property))
14854 nil nil "" nil cur)))))
14855 (if (equal val "")
14856 cur
14857 val)))
14859 (defvar org-last-set-property nil)
14860 (defun org-read-property-name ()
14861 "Read a property name."
14862 (let* ((completion-ignore-case t)
14863 (keys (org-buffer-property-keys nil t t))
14864 (default-prop (or (save-excursion
14865 (save-match-data
14866 (beginning-of-line)
14868 (null (string= (match-string 1) "END"))
14869 (match-string 1))))
14870 org-last-set-property))
14871 (property (org-icompleting-read
14872 (concat "Property"
14873 (if default-prop (concat " [" default-prop "]") "")
14874 ": ")
14875 (mapcar 'list keys)
14876 nil nil nil nil
14877 default-prop
14878 )))
14879 (if (member property keys)
14880 property
14881 (or (cdr (assoc (downcase property)
14882 (mapcar (lambda (x) (cons (downcase x) x))
14883 keys)))
14884 property))))
14886 (defun org-set-property (property value)
14887 "In the current entry, set PROPERTY to VALUE.
14888 When called interactively, this will prompt for a property name, offering
14889 completion on existing and default properties. And then it will prompt
14890 for a value, offering completion either on allowed values (via an inherited
14891 xxx_ALL property) or on existing values in other instances of this property
14892 in the current file."
14893 (interactive (list nil nil))
14894 (let* ((property (or property (org-read-property-name)))
14895 (value (or value (org-read-property-value property)))
14896 (fn (cdr (assoc property org-properties-postprocess-alist))))
14897 (setq org-last-set-property property)
14898 ;; Possibly postprocess the inserted value:
14899 (when fn (setq value (funcall fn value)))
14900 (unless (equal (org-entry-get nil property) value)
14901 (org-entry-put nil property value))))
14903 (defun org-delete-property (property)
14904 "In the current entry, delete PROPERTY."
14905 (interactive
14906 (let* ((completion-ignore-case t)
14907 (prop (org-icompleting-read "Property: "
14908 (org-entry-properties nil 'standard))))
14909 (list prop)))
14910 (message "Property %s %s" property
14911 (if (org-entry-delete nil property)
14912 "deleted"
14913 "was not present in the entry")))
14915 (defun org-delete-property-globally (property)
14916 "Remove PROPERTY globally, from all entries."
14917 (interactive
14918 (let* ((completion-ignore-case t)
14919 (prop (org-icompleting-read
14920 "Globally remove property: "
14921 (mapcar 'list (org-buffer-property-keys)))))
14922 (list prop)))
14923 (save-excursion
14924 (save-restriction
14925 (widen)
14926 (goto-char (point-min))
14927 (let ((cnt 0))
14928 (while (re-search-forward
14929 (org-re-property property)
14930 nil t)
14931 (setq cnt (1+ cnt))
14932 (delete-region (match-beginning 0) (1+ (point-at-eol))))
14935 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14937 (defun org-compute-property-at-point ()
14938 "Compute the property at point.
14939 This looks for an enclosing column format, extracts the operator and
14940 then applies it to the property in the column format's scope."
14941 (interactive)
14942 (unless (org-at-property-p)
14943 (error "Not at a property"))
14944 (let ((prop (org-match-string-no-properties 2)))
14945 (org-columns-get-format-and-top-level)
14946 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14947 (error "No operator defined for property %s" prop))
14948 (org-columns-compute prop)))
14950 (defvar org-property-allowed-value-functions nil
14951 "Hook for functions supplying allowed values for a specific property.
14952 The functions must take a single argument, the name of the property, and
14954 the values, this means that these values are intended as defaults for
14955 completion, but that other values should be allowed too.
14956 The functions must return nil if they are not responsible for this
14957 property.")
14959 (defun org-property-get-allowed-values (pom property &optional table)
14960 "Get allowed values for the property PROPERTY.
14961 When TABLE is non-nil, return an alist that can directly be used for
14962 completion."
14963 (let (vals)
14964 (cond
14965 ((equal property "TODO")
14966 (setq vals (org-with-point-at pom
14967 (append org-todo-keywords-1 '("")))))
14968 ((equal property "PRIORITY")
14969 (let ((n org-lowest-priority))
14970 (while (>= n org-highest-priority)
14971 (push (char-to-string n) vals)
14972 (setq n (1- n)))))
14973 ((member property org-special-properties))
14974 ((setq vals (run-hook-with-args-until-success
14975 'org-property-allowed-value-functions property)))
14976 (t
14977 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14979 (setq vals (car (read-from-string (concat "(" vals ")"))))
14980 (setq vals (mapcar (lambda (x)
14981 (cond ((stringp x) x)
14982 ((numberp x) (number-to-string x))
14983 ((symbolp x) (symbol-name x))
14984 (t "???")))
14985 vals)))))
14986 (when (member ":ETC" vals)
14987 (setq vals (remove ":ETC" vals))
14988 (org-add-props (car vals) '(org-unrestricted t)))
14989 (if table (mapcar 'list vals) vals)))
14991 (defun org-property-previous-allowed-value (&optional previous)
14992 "Switch to the next allowed value for this property."
14993 (interactive)
14994 (org-property-next-allowed-value t))
14996 (defun org-property-next-allowed-value (&optional previous)
14997 "Switch to the next allowed value for this property."
14998 (interactive)
14999 (unless (org-at-property-p)
15000 (error "Not at a property"))
15001 (let* ((key (match-string 2))
15002 (value (match-string 3))
15003 (allowed (or (org-property-get-allowed-values (point) key)
15004 (and (member value '("[ ]" "[-]" "[X]"))
15005 '("[ ]" "[X]"))))
15006 nval)
15007 (unless allowed
15008 (error "Allowed values for this property have not been defined"))
15009 (if previous (setq allowed (reverse allowed)))
15010 (if (member value allowed)
15011 (setq nval (car (cdr (member value allowed)))))
15012 (setq nval (or nval (car allowed)))
15013 (if (equal nval value)
15014 (error "Only one allowed value for this property"))
15015 (org-at-property-p)
15016 (replace-match (concat " :" key ": " nval) t t)
15017 (org-indent-line)
15018 (beginning-of-line 1)
15020 (run-hook-with-args 'org-property-changed-functions key nval)))
15022 (defun org-find-olp (path &optional this-buffer)
15023 "Return a marker pointing to the entry at outline path OLP.
15024 If anything goes wrong, throw an error.
15025 You can wrap this call to catch the error like this:
15027 (condition-case msg
15028 (org-mobile-locate-entry (match-string 4))
15029 (error (nth 1 msg)))
15031 The return value will then be either a string with the error message,
15032 or a marker if everything is OK.
15034 If THIS-BUFFER is set, the outline path does not contain a file,
15035 only headings."
15036 (let* ((file (if this-buffer buffer-file-name (pop path)))
15037 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15038 (level 1)
15039 (lmin 1)
15040 (lmax 1)
15041 limit re end found pos heading cnt flevel)
15042 (unless buffer (error "File not found :%s" file))
15043 (with-current-buffer buffer
15044 (save-excursion
15045 (save-restriction
15046 (widen)
15047 (setq limit (point-max))
15048 (goto-char (point-min))
15049 (while (setq heading (pop path))
15050 (setq re (format org-complex-heading-regexp-format
15051 (regexp-quote heading)))
15052 (setq cnt 0 pos (point))
15053 (while (re-search-forward re end t)
15054 (setq level (- (match-end 1) (match-beginning 1)))
15055 (if (and (>= level lmin) (<= level lmax))
15056 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15057 (when (= cnt 0) (error "Heading not found on level %d: %s"
15058 lmax heading))
15059 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15060 lmax heading))
15061 (goto-char found)
15062 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15063 (setq end (save-excursion (org-end-of-subtree t t))))
15064 (when (org-at-heading-p)
15065 (point-marker)))))))
15067 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15068 "Find node HEADING in BUFFER.
15069 Return a marker to the heading if it was found, or nil if not.
15070 If POS-ONLY is set, return just the position instead of a marker.
15072 The heading text must match exact, but it may have a TODO keyword,
15073 a priority cookie and tags in the standard locations."
15074 (with-current-buffer (or buffer (current-buffer))
15075 (save-excursion
15076 (save-restriction
15077 (widen)
15078 (goto-char (point-min))
15079 (let (case-fold-search)
15080 (if (re-search-forward
15081 (format org-complex-heading-regexp-format
15082 (regexp-quote heading)) nil t)
15083 (if pos-only
15084 (match-beginning 0)
15085 (move-marker (make-marker) (match-beginning 0)))))))))
15087 (defun org-find-exact-heading-in-directory (heading &optional dir)
15088 "Find Org node headline HEADING in all .org files in directory DIR.
15089 When the target headline is found, return a marker to this location."
15090 (let ((files (directory-files (or dir default-directory)
15092 file visiting m buffer)
15093 (catch 'found
15094 (while (setq file (pop files))
15095 (message "trying %s" file)
15096 (setq visiting (org-find-base-buffer-visiting file))
15097 (setq buffer (or visiting (find-file-noselect file)))
15098 (setq m (org-find-exact-headline-in-buffer
15099 heading buffer))
15100 (when (and (not m) (not visiting)) (kill-buffer buffer))
15101 (and m (throw 'found m))))))
15103 (defun org-find-entry-with-id (ident)
15104 "Locate the entry that contains the ID property with exact value IDENT.
15105 IDENT can be a string, a symbol or a number, this function will search for
15106 the string representation of it.
15107 Return the position where this entry starts, or nil if there is no such entry."
15108 (interactive "sID: ")
15109 (let ((id (cond
15110 ((stringp ident) ident)
15111 ((symbol-name ident) (symbol-name ident))
15112 ((numberp ident) (number-to-string ident))
15113 (t (error "IDENT %s must be a string, symbol or number" ident))))
15114 (case-fold-search nil))
15115 (save-excursion
15116 (save-restriction
15117 (widen)
15118 (goto-char (point-min))
15119 (when (re-search-forward
15121 nil t)
15122 (org-back-to-heading t)
15123 (point))))))
15125 ;;;; Timestamps
15127 (defvar org-last-changed-timestamp nil)
15128 (defvar org-last-inserted-timestamp nil
15129 "The last time stamp inserted with `org-insert-time-stamp'.")
15130 (defvar org-time-was-given) ; dynamically scoped parameter
15131 (defvar org-end-time-was-given) ; dynamically scoped parameter
15132 (defvar org-ts-what) ; dynamically scoped parameter
15134 (defun org-time-stamp (arg &optional inactive)
15135 "Prompt for a date/time and insert a time stamp.
15136 If the user specifies a time like HH:MM or if this command is
15137 called with at least one prefix argument, the time stamp contains
15138 the date and the time. Otherwise, only the date is be included.
15140 All parts of a date not specified by the user is filled in from
15141 the current date/time. So if you just press return without
15142 typing anything, the time stamp will represent the current
15143 date/time.
15145 If there is already a timestamp at the cursor, it will be
15146 modified.
15148 With two universal prefix arguments, insert an active timestamp
15149 with the current time without prompting the user."
15150 (interactive "P")
15151 (let* ((ts nil)
15152 (default-time
15153 ;; Default time is either today, or, when entering a range,
15154 ;; the range start.
15155 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15156 (save-excursion
15157 (re-search-backward
15159 (- (point) 20) t)))
15160 (apply 'encode-time (org-parse-time-string (match-string 1)))
15161 (current-time)))
15162 (default-input (and ts (org-get-compact-tod ts)))
15163 (repeater (save-excursion
15164 (save-match-data
15165 (beginning-of-line)
15166 (when (re-search-forward
15168 (save-excursion (progn (end-of-line) (point))) t)
15169 (match-string 0)))))
15170 org-time-was-given org-end-time-was-given time)
15171 (cond
15172 ((and (org-at-timestamp-p t)
15173 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15174 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15175 (insert "--")
15176 (setq time (let ((this-command this-command))
15177 (org-read-date arg 'totime nil nil
15178 default-time default-input inactive)))
15179 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15180 ((org-at-timestamp-p t)
15181 (setq time (let ((this-command this-command))
15182 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15183 (when (org-at-timestamp-p t) ; just to get the match data
15184 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15185 (replace-match "")
15186 (setq org-last-changed-timestamp
15187 (org-insert-time-stamp
15188 time (or org-time-was-given arg)
15189 inactive nil nil (list org-end-time-was-given)))
15190 (when repeater (goto-char (1- (point))) (insert " " repeater)
15191 (setq org-last-changed-timestamp
15192 (concat (substring org-last-inserted-timestamp 0 -1)
15193 " " repeater ">"))))
15194 (message "Timestamp updated"))
15195 ((equal arg '(16))
15196 (org-insert-time-stamp (current-time) t))
15197 (t
15198 (setq time (let ((this-command this-command))
15199 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15200 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15201 nil nil (list org-end-time-was-given))))))
15203 ;; FIXME: can we use this for something else, like computing time differences?
15204 (defun org-get-compact-tod (s)
15205 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15206 (let* ((t1 (match-string 1 s))
15207 (h1 (string-to-number (match-string 2 s)))
15208 (m1 (string-to-number (match-string 3 s)))
15209 (t2 (and (match-end 4) (match-string 5 s)))
15210 (h2 (and t2 (string-to-number (match-string 6 s))))
15211 (m2 (and t2 (string-to-number (match-string 7 s))))
15212 dh dm)
15213 (if (not t2)
15214 t1
15215 (setq dh (- h2 h1) dm (- m2 m1))
15216 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15217 (concat t1 "+" (number-to-string dh)
15218 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15220 (defun org-time-stamp-inactive (&optional arg)
15221 "Insert an inactive time stamp.
15222 An inactive time stamp is enclosed in square brackets instead of angle
15223 brackets. It is inactive in the sense that it does not trigger agenda entries,
15224 does not link to the calendar and cannot be changed with the S-cursor keys.
15225 So these are more for recording a certain time/date."
15226 (interactive "P")
15227 (org-time-stamp arg 'inactive))
15229 (defvar org-date-ovl (make-overlay 1 1))
15230 (overlay-put org-date-ovl 'face 'org-date-selected)
15231 (org-detach-overlay org-date-ovl)
15233 (defvar org-ans1) ; dynamically scoped parameter
15234 (defvar org-ans2) ; dynamically scoped parameter
15236 (defvar org-plain-time-of-day-regexp) ; defined below
15238 (defvar org-overriding-default-time nil) ; dynamically scoped
15239 (defvar org-read-date-overlay nil)
15240 (defvar org-dcst nil) ; dynamically scoped
15241 (defvar org-read-date-history nil)
15242 (defvar org-read-date-final-answer nil)
15243 (defvar org-read-date-analyze-futurep nil)
15244 (defvar org-read-date-analyze-forced-year nil)
15245 (defvar org-read-date-inactive)
15247 (defun org-read-date (&optional org-with-time to-time from-string prompt
15248 default-time default-input inactive)
15249 "Read a date, possibly a time, and make things smooth for the user.
15250 The prompt will suggest to enter an ISO date, but you can also enter anything
15251 which will at least partially be understood by `parse-time-string'.
15252 Unrecognized parts of the date will default to the current day, month, year,
15253 hour and minute. If this command is called to replace a timestamp at point,
15254 or to enter the second timestamp of a range, the default time is taken
15255 from the existing stamp. Furthermore, the command prefers the future,
15256 so if you are giving a date where the year is not given, and the day-month
15257 combination is already past in the current year, it will assume you
15258 mean next year. For details, see the manual. A few examples:
15260 3-2-5 --> 2003-02-05
15261 feb 15 --> currentyear-02-15
15262 2/15 --> currentyear-02-15
15263 sep 12 9 --> 2009-09-12
15264 12:45 --> today 12:45
15265 22 sept 0:34 --> currentyear-09-22 0:34
15266 12 --> currentyear-currentmonth-12
15267 Fri --> nearest Friday (today or later)
15268 etc.
15270 Furthermore you can specify a relative date by giving, as the *first* thing
15271 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15272 change in days weeks, months, years.
15273 With a single plus or minus, the date is relative to today. With a double
15274 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15275 +4d --> four days from today
15276 +4 --> same as above
15277 +2w --> two weeks from today
15278 ++5 --> five days from default date
15280 The function understands only English month and weekday abbreviations.
15282 While prompting, a calendar is popped up - you can also select the
15283 date with the mouse (button 1). The calendar shows a period of three
15284 months. To scroll it to other months, use the keys `>' and `<'.
15285 If you don't like the calendar, turn it off with
15286 \(setq org-read-date-popup-calendar nil)
15288 With optional argument TO-TIME, the date will immediately be converted
15289 to an internal time.
15290 With an optional argument ORG-WITH-TIME, the prompt will suggest to
15291 also insert a time. Note that when ORG-WITH-TIME is not set, you can
15292 still enter a time, and this function will inform the calling routine
15293 about this change. The calling routine may then choose to change the
15294 format used to insert the time stamp into the buffer to include the time.
15295 With optional argument FROM-STRING, read from this string instead from
15296 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15297 the time/date that is used for everything that is not specified by the
15298 user."
15299 (require 'parse-time)
15300 (let* ((org-time-stamp-rounding-minutes
15301 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15302 (org-dcst org-display-custom-times)
15303 (ct (org-current-time))
15304 (org-def (or org-overriding-default-time default-time ct))
15305 (org-defdecode (decode-time org-def))
15306 (dummy (progn
15307 (when (< (nth 2 org-defdecode) org-extend-today-until)
15308 (setcar (nthcdr 2 org-defdecode) -1)
15309 (setcar (nthcdr 1 org-defdecode) 59)
15310 (setq org-def (apply 'encode-time org-defdecode)
15311 org-defdecode (decode-time org-def)))))
15312 (calendar-frame-setup nil)
15313 (calendar-setup nil)
15314 (calendar-move-hook nil)
15315 (calendar-view-diary-initially-flag nil)
15316 (calendar-view-holidays-initially-flag nil)
15317 (timestr (format-time-string
15318 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15319 (prompt (concat (if prompt (concat prompt " ") "")
15320 (format "Date+time [%s]: " timestr)))
15321 ans (org-ans0 "") org-ans1 org-ans2 final)
15323 (cond
15324 (from-string (setq ans from-string))
15325 (org-read-date-popup-calendar
15326 (save-excursion
15327 (save-window-excursion
15328 (calendar)
15329 (org-eval-in-calendar '(setq cursor-type nil) t)
15330 (unwind-protect
15331 (progn
15332 (calendar-forward-day (- (time-to-days org-def)
15333 (calendar-absolute-from-gregorian
15334 (calendar-current-date))))
15335 (org-eval-in-calendar nil t)
15336 (let* ((old-map (current-local-map))
15337 (map (copy-keymap calendar-mode-map))
15338 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15339 (org-defkey map (kbd "RET") 'org-calendar-select)
15340 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15341 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15342 (org-defkey minibuffer-local-map [(meta shift left)]
15343 (lambda () (interactive)
15344 (org-eval-in-calendar '(calendar-backward-month 1))))
15345 (org-defkey minibuffer-local-map [(meta shift right)]
15346 (lambda () (interactive)
15347 (org-eval-in-calendar '(calendar-forward-month 1))))
15348 (org-defkey minibuffer-local-map [(meta shift up)]
15349 (lambda () (interactive)
15350 (org-eval-in-calendar '(calendar-backward-year 1))))
15351 (org-defkey minibuffer-local-map [(meta shift down)]
15352 (lambda () (interactive)
15353 (org-eval-in-calendar '(calendar-forward-year 1))))
15354 (org-defkey minibuffer-local-map [?\e (shift left)]
15355 (lambda () (interactive)
15356 (org-eval-in-calendar '(calendar-backward-month 1))))
15357 (org-defkey minibuffer-local-map [?\e (shift right)]
15358 (lambda () (interactive)
15359 (org-eval-in-calendar '(calendar-forward-month 1))))
15360 (org-defkey minibuffer-local-map [?\e (shift up)]
15361 (lambda () (interactive)
15362 (org-eval-in-calendar '(calendar-backward-year 1))))
15363 (org-defkey minibuffer-local-map [?\e (shift down)]
15364 (lambda () (interactive)
15365 (org-eval-in-calendar '(calendar-forward-year 1))))
15366 (org-defkey minibuffer-local-map [(shift up)]
15367 (lambda () (interactive)
15368 (org-eval-in-calendar '(calendar-backward-week 1))))
15369 (org-defkey minibuffer-local-map [(shift down)]
15370 (lambda () (interactive)
15371 (org-eval-in-calendar '(calendar-forward-week 1))))
15372 (org-defkey minibuffer-local-map [(shift left)]
15373 (lambda () (interactive)
15374 (org-eval-in-calendar '(calendar-backward-day 1))))
15375 (org-defkey minibuffer-local-map [(shift right)]
15376 (lambda () (interactive)
15377 (org-eval-in-calendar '(calendar-forward-day 1))))
15378 (org-defkey minibuffer-local-map ">"
15379 (lambda () (interactive)
15380 (org-eval-in-calendar '(scroll-calendar-left 1))))
15381 (org-defkey minibuffer-local-map "<"
15382 (lambda () (interactive)
15383 (org-eval-in-calendar '(scroll-calendar-right 1))))
15384 (org-defkey minibuffer-local-map "\C-v"
15385 (lambda () (interactive)
15386 (org-eval-in-calendar
15387 '(calendar-scroll-left-three-months 1))))
15388 (org-defkey minibuffer-local-map "\M-v"
15389 (lambda () (interactive)
15390 (org-eval-in-calendar
15391 '(calendar-scroll-right-three-months 1))))
15392 (run-hooks 'org-read-date-minibuffer-setup-hook)
15393 (unwind-protect
15394 (progn
15395 (use-local-map map)
15396 (setq org-read-date-inactive inactive)
15397 (add-hook 'post-command-hook 'org-read-date-display)
15398 (setq org-ans0 (read-string prompt default-input
15399 'org-read-date-history nil))
15400 ;; org-ans0: from prompt
15401 ;; org-ans1: from mouse click
15402 ;; org-ans2: from calendar motion
15403 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15404 (remove-hook 'post-command-hook 'org-read-date-display)
15405 (use-local-map old-map)
15406 (when org-read-date-overlay
15407 (delete-overlay org-read-date-overlay)
15408 (setq org-read-date-overlay nil)))))
15409 (bury-buffer "*Calendar*")))))
15411 (t ; Naked prompt only
15412 (unwind-protect
15413 (setq ans (read-string prompt default-input
15414 'org-read-date-history timestr))
15415 (when org-read-date-overlay
15416 (delete-overlay org-read-date-overlay)
15417 (setq org-read-date-overlay nil)))))
15419 (setq final (org-read-date-analyze ans org-def org-defdecode))
15421 (when org-read-date-analyze-forced-year
15422 (message "Year was forced into %s"
15423 (if org-read-date-force-compatible-dates
15424 "compatible range (1970-2037)"
15425 "range representable on this machine"))
15426 (ding))
15428 ;; One round trip to get rid of 34th of August and stuff like that....
15429 (setq final (decode-time (apply 'encode-time final)))
15431 (setq org-read-date-final-answer ans)
15433 (if to-time
15434 (apply 'encode-time final)
15435 (if (and (boundp 'org-time-was-given) org-time-was-given)
15436 (format "%04d-%02d-%02d %02d:%02d"
15437 (nth 5 final) (nth 4 final) (nth 3 final)
15438 (nth 2 final) (nth 1 final))
15439 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15441 (defvar org-def)
15442 (defvar org-defdecode)
15443 (defvar org-with-time)
15444 (defun org-read-date-display ()
15445 "Display the current date prompt interpretation in the minibuffer."
15446 (when org-read-date-display-live
15447 (when org-read-date-overlay
15448 (delete-overlay org-read-date-overlay))
15449 (when (minibufferp (current-buffer))
15450 (save-excursion
15451 (end-of-line 1)
15452 (while (not (equal (buffer-substring
15453 (max (point-min) (- (point) 4)) (point))
15454 " "))
15455 (insert " ")))
15456 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15457 " " (or org-ans1 org-ans2)))
15458 (org-end-time-was-given nil)
15459 (f (org-read-date-analyze ans org-def org-defdecode))
15460 (fmts (if org-dcst
15461 org-time-stamp-custom-formats
15462 org-time-stamp-formats))
15463 (fmt (if (or org-with-time
15464 (and (boundp 'org-time-was-given) org-time-was-given))
15465 (cdr fmts)
15466 (car fmts)))
15467 (txt (format-time-string fmt (apply 'encode-time f)))
15468 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15469 (txt (concat "=> " txt)))
15470 (when (and org-end-time-was-given
15471 (string-match org-plain-time-of-day-regexp txt))
15472 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15473 org-end-time-was-given
15474 (substring txt (match-end 0)))))
15475 (when org-read-date-analyze-futurep
15476 (setq txt (concat txt " (=>F)")))
15477 (setq org-read-date-overlay
15478 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15479 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
15481 (defun org-read-date-analyze (ans org-def org-defdecode)
15482 "Analyze the combined answer of the date prompt."
15483 ;; FIXME: cleanup and comment
15484 (let ((nowdecode (decode-time (current-time)))
15485 delta deltan deltaw deltadef year month day
15486 hour minute second wday pm h2 m2 tl wday1
15487 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15488 (setq org-read-date-analyze-futurep nil
15489 org-read-date-analyze-forced-year nil)
15491 (setq ans "+0"))
15493 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15494 (setq ans (replace-match "" t t ans)
15495 deltan (car delta)
15496 deltaw (nth 1 delta)
15497 deltadef (nth 2 delta)))
15499 ;; Check if there is an iso week date in there. If yes, store the
15500 ;; info and postpone interpreting it until the rest of the parsing
15501 ;; is done.
15502 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15503 (setq iso-year (if (match-end 1)
15504 (org-small-year-to-year
15505 (string-to-number (match-string 1 ans))))
15506 iso-weekday (if (match-end 3)
15507 (string-to-number (match-string 3 ans)))
15508 iso-week (string-to-number (match-string 2 ans)))
15509 (setq ans (replace-match "" t t ans)))
15511 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15512 (when (string-match
15514 (setq year (if (match-end 2)
15515 (string-to-number (match-string 2 ans))
15516 (progn (setq kill-year t)
15517 (string-to-number (format-time-string "%Y"))))
15518 month (string-to-number (match-string 3 ans))
15519 day (string-to-number (match-string 4 ans)))
15520 (if (< year 100) (setq year (+ 2000 year)))
15522 t nil ans)))
15524 ;; Help matching dotted european dates
15525 (when (string-match
15526 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
15527 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
15528 (setq kill-year t)
15529 (string-to-number (format-time-string "%Y")))
15530 day (string-to-number (match-string 1 ans))
15531 month (string-to-number (match-string 2 ans))
15532 ans (replace-match (format "%04d-%02d-%02d" year month day)
15533 t nil ans)))
15535 ;; Help matching american dates, like 5/30 or 5/30/7
15536 (when (string-match
15537 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15538 (setq year (if (match-end 4)
15539 (string-to-number (match-string 4 ans))
15540 (progn (setq kill-year t)
15541 (string-to-number (format-time-string "%Y"))))
15542 month (string-to-number (match-string 1 ans))
15543 day (string-to-number (match-string 2 ans)))
15544 (if (< year 100) (setq year (+ 2000 year)))
15546 t nil ans)))
15547 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15548 ;; If there is a time with am/pm, and *no* time without it, we convert
15549 ;; so that matching will be successful.
15550 (loop for i from 1 to 2 do ; twice, for end time as well
15553 (setq hour (string-to-number (match-string 1 ans))
15554 minute (if (match-end 3)
15555 (string-to-number (match-string 3 ans))
15556 0)
15557 pm (equal ?p
15558 (string-to-char (downcase (match-string 4 ans)))))
15559 (if (and (= hour 12) (not pm))
15560 (setq hour 0)
15561 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15562 (setq ans (replace-match (format "%02d:%02d" hour minute)
15563 t t ans))))
15565 ;; Check if a time range is given as a duration
15566 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15567 (setq hour (string-to-number (match-string 1 ans))
15568 h2 (+ hour (string-to-number (match-string 3 ans)))
15569 minute (string-to-number (match-string 2 ans))
15570 m2 (+ minute (if (match-end 5) (string-to-number
15571 (match-string 5 ans))0)))
15572 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15573 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15574 t t ans)))
15576 ;; Check if there is a time range
15577 (when (boundp 'org-end-time-was-given)
15578 (setq org-time-was-given nil)
15579 (when (and (string-match org-plain-time-of-day-regexp ans)
15580 (match-end 8))
15581 (setq org-end-time-was-given (match-string 8 ans))
15582 (setq ans (concat (substring ans 0 (match-beginning 7))
15583 (substring ans (match-end 7))))))
15585 (setq tl (parse-time-string ans)
15586 day (or (nth 3 tl) (nth 3 org-defdecode))
15587 month (or (nth 4 tl)
15588 (if (and org-read-date-prefer-future
15589 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15590 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15591 (nth 4 org-defdecode)))
15592 year (or (and (not kill-year) (nth 5 tl))
15593 (if (and org-read-date-prefer-future
15594 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15595 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15596 (nth 5 org-defdecode)))
15597 hour (or (nth 2 tl) (nth 2 org-defdecode))
15598 minute (or (nth 1 tl) (nth 1 org-defdecode))
15599 second (or (nth 0 tl) 0)
15600 wday (nth 6 tl))
15602 (when (and (eq org-read-date-prefer-future 'time)
15603 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15604 (equal day (nth 3 nowdecode))
15605 (equal month (nth 4 nowdecode))
15606 (equal year (nth 5 nowdecode))
15607 (nth 2 tl)
15608 (or (< (nth 2 tl) (nth 2 nowdecode))
15609 (and (= (nth 2 tl) (nth 2 nowdecode))
15610 (nth 1 tl)
15611 (< (nth 1 tl) (nth 1 nowdecode)))))
15612 (setq day (1+ day)
15613 futurep t))
15615 ;; Special date definitions below
15616 (cond
15617 (iso-week
15618 ;; There was an iso week
15619 (require 'cal-iso)
15620 (setq futurep nil)
15621 (setq year (or iso-year year)
15622 day (or iso-weekday wday 1)
15623 wday nil ; to make sure that the trigger below does not match
15624 iso-date (calendar-gregorian-from-absolute
15625 (calendar-absolute-from-iso
15626 (list iso-week day year))))
15627 ; FIXME: Should we also push ISO weeks into the future?
15628 ; (when (and org-read-date-prefer-future
15629 ; (not iso-year)
15630 ; (< (calendar-absolute-from-gregorian iso-date)
15631 ; (time-to-days (current-time))))
15632 ; (setq year (1+ year)
15633 ; iso-date (calendar-gregorian-from-absolute
15634 ; (calendar-absolute-from-iso
15635 ; (list iso-week day year)))))
15636 (setq month (car iso-date)
15637 year (nth 2 iso-date)
15638 day (nth 1 iso-date)))
15639 (deltan
15640 (setq futurep nil)
15641 (unless deltadef
15642 (let ((now (decode-time (current-time))))
15643 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15644 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15645 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15646 ((equal deltaw "m") (setq month (+ month deltan)))
15647 ((equal deltaw "y") (setq year (+ year deltan)))))
15648 ((and wday (not (nth 3 tl)))
15649 ;; Weekday was given, but no day, so pick that day in the week
15650 ;; on or after the derived date.
15651 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15652 (unless (equal wday wday1)
15653 (setq day (+ day (% (- wday wday1 -7) 7))))))
15654 (if (and (boundp 'org-time-was-given)
15655 (nth 2 tl))
15656 (setq org-time-was-given t))
15657 (if (< year 100) (setq year (+ 2000 year)))
15658 ;; Check of the date is representable
15659 (if org-read-date-force-compatible-dates
15660 (progn
15661 (if (< year 1970)
15662 (setq year 1970 org-read-date-analyze-forced-year t))
15663 (if (> year 2037)
15664 (setq year 2037 org-read-date-analyze-forced-year t)))
15665 (condition-case nil
15666 (ignore (encode-time second minute hour day month year))
15667 (error
15668 (setq year (nth 5 org-defdecode))
15669 (setq org-read-date-analyze-forced-year t))))
15670 (setq org-read-date-analyze-futurep futurep)
15671 (list second minute hour day month year)))
15673 (defvar parse-time-weekdays)
15674 (defun org-read-date-get-relative (s today default)
15675 "Check string S for special relative date string.
15676 TODAY and DEFAULT are internal times, for today and for a default.
15677 Return shift list (N what def-flag)
15679 N is the number of WHATs to shift.
15680 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15681 the DEFAULT date rather than TODAY."
15682 (require 'parse-time)
15683 (when (and
15684 (string-match
15685 (concat
15690 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15691 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15692 (string-to-char (substring (match-string 1 s) -1))
15693 ?+))
15694 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15695 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15696 (what (if (match-end 3) (match-string 3 s) "d"))
15697 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15698 (date (if rel default today))
15699 (wday (nth 6 (decode-time date)))
15700 delta)
15701 (if wday1
15702 (progn
15703 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15704 (if (= dir ?-) (setq delta (- delta 7)))
15705 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15706 (list delta "d" rel))
15707 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15709 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15710 "Turn a user-specified date into the internal representation.
15711 The internal representation needed by the calendar is (month day year).
15712 This is a wrapper to handle the brain-dead convention in calendar that
15713 user function argument order change dependent on argument order."
15714 (if (boundp 'calendar-date-style)
15715 (cond
15716 ((eq calendar-date-style 'american)
15717 (list arg1 arg2 arg3))
15718 ((eq calendar-date-style 'european)
15719 (list arg2 arg1 arg3))
15720 ((eq calendar-date-style 'iso)
15721 (list arg2 arg3 arg1)))
15722 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15723 (if (org-bound-and-true-p european-calendar-style)
15724 (list arg2 arg1 arg3)
15725 (list arg1 arg2 arg3)))))
15727 (defun org-eval-in-calendar (form &optional keepdate)
15728 "Eval FORM in the calendar window and return to current window.
15729 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
15730 otherwise stick to the current value of `org-ans2'."
15731 (let ((sf (selected-frame))
15732 (sw (selected-window)))
15733 (select-window (get-buffer-window "*Calendar*" t))
15734 (eval form)
15735 (when (and (not keepdate) (calendar-cursor-to-date))
15736 (let* ((date (calendar-cursor-to-date))
15737 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15738 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15739 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15740 (select-window sw)
15741 (org-select-frame-set-input-focus sf)))
15743 (defun org-calendar-select ()
15744 "Return to `org-read-date' with the date currently selected.
15745 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15746 (interactive)
15747 (when (calendar-cursor-to-date)
15748 (let* ((date (calendar-cursor-to-date))
15749 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15750 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15751 (if (active-minibuffer-window) (exit-minibuffer))))
15753 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15754 "Insert a date stamp for the date given by the internal TIME.
15755 WITH-HM means use the stamp format that includes the time of the day.
15756 INACTIVE means use square brackets instead of angular ones, so that the
15757 stamp will not contribute to the agenda.
15758 PRE and POST are optional strings to be inserted before and after the
15759 stamp.
15760 The command returns the inserted time stamp."
15761 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15762 stamp)
15763 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15764 (insert-before-markers (or pre ""))
15765 (when (listp extra)
15766 (setq extra (car extra))
15767 (if (and (stringp extra)
15769 (setq extra (format "-%02d:%02d"
15770 (string-to-number (match-string 1 extra))
15771 (string-to-number (match-string 2 extra))))
15772 (setq extra nil)))
15773 (when extra
15774 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15775 (insert-before-markers (setq stamp (format-time-string fmt time)))
15776 (insert-before-markers (or post ""))
15777 (setq org-last-inserted-timestamp stamp)))
15779 (defun org-toggle-time-stamp-overlays ()
15780 "Toggle the use of custom time stamp formats."
15781 (interactive)
15782 (setq org-display-custom-times (not org-display-custom-times))
15783 (unless org-display-custom-times
15784 (let ((p (point-min)) (bmp (buffer-modified-p)))
15785 (while (setq p (next-single-property-change p 'display))
15786 (if (and (get-text-property p 'display)
15787 (eq (get-text-property p 'face) 'org-date))
15788 (remove-text-properties
15789 p (setq p (next-single-property-change p 'display))
15790 '(display t))))
15791 (set-buffer-modified-p bmp)))
15792 (if (featurep 'xemacs)
15793 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15794 (org-restart-font-lock)
15795 (setq org-table-may-need-update t)
15796 (if org-display-custom-times
15797 (message "Time stamps are overlaid with custom format")
15798 (message "Time stamp overlays removed")))
15800 (defun org-display-custom-time (beg end)
15801 "Overlay modified time stamp format over timestamp between BEG and END."
15802 (let* ((ts (buffer-substring beg end))
15803 t1 w1 with-hm tf time str w2 (off 0))
15804 (save-match-data
15805 (setq t1 (org-parse-time-string ts t))
15806 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
15807 (setq off (- (match-end 0) (match-beginning 0)))))
15808 (setq end (- end off))
15809 (setq w1 (- end beg)
15810 with-hm (and (nth 1 t1) (nth 2 t1))
15811 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15812 time (org-fix-decoded-time t1)
15813 str (org-add-props
15814 (format-time-string
15815 (substring tf 1 -1) (apply 'encode-time time))
15816 nil 'mouse-face 'highlight)
15817 w2 (length str))
15818 (if (not (= w2 w1))
15819 (add-text-properties (1+ beg) (+ 2 beg)
15820 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15821 (if (featurep 'xemacs)
15822 (progn
15823 (put-text-property beg end 'invisible t)
15824 (put-text-property beg end 'end-glyph (make-glyph str)))
15825 (put-text-property beg end 'display str))))
15827 (defun org-translate-time (string)
15828 "Translate all timestamps in STRING to custom format.
15829 But do this only if the variable `org-display-custom-times' is set."
15830 (when org-display-custom-times
15831 (save-match-data
15832 (let* ((start 0)
15833 (re org-ts-regexp-both)
15834 t1 with-hm inactive tf time str beg end)
15835 (while (setq start (string-match re string start))
15836 (setq beg (match-beginning 0)
15837 end (match-end 0)
15838 t1 (save-match-data
15839 (org-parse-time-string (substring string beg end) t))
15840 with-hm (and (nth 1 t1) (nth 2 t1))
15841 inactive (equal (substring string beg (1+ beg)) "[")
15842 tf (funcall (if with-hm 'cdr 'car)
15843 org-time-stamp-custom-formats)
15844 time (org-fix-decoded-time t1)
15845 str (format-time-string
15846 (concat
15847 (if inactive "[" "<") (substring tf 1 -1)
15848 (if inactive "]" ">"))
15849 (apply 'encode-time time))
15850 string (replace-match str t t string)
15851 start (+ start (length str)))))))
15852 string)
15854 (defun org-fix-decoded-time (time)
15855 "Set 0 instead of nil for the first 6 elements of time.
15856 Don't touch the rest."
15857 (let ((n 0))
15858 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15860 (defun org-days-to-time (timestamp-string)
15861 "Difference between TIMESTAMP-STRING and now in days."
15862 (- (time-to-days (org-time-string-to-time timestamp-string))
15863 (time-to-days (current-time))))
15865 (defun org-deadline-close (timestamp-string &optional ndays)
15866 "Is the time in TIMESTAMP-STRING close to the current date?"
15867 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15868 (and (< (org-days-to-time timestamp-string) ndays)
15869 (not (org-entry-is-done-p))))
15871 (defun org-get-wdays (ts)
15872 "Get the deadline lead time appropriate for timestring TS."
15873 (cond
15874 ((<= org-deadline-warning-days 0)
15875 ;; 0 or negative, enforce this value no matter what
15876 (- org-deadline-warning-days))
15878 ;; lead time is specified.
15879 (floor (* (string-to-number (match-string 1 ts))
15880 (cdr (assoc (match-string 2 ts)
15881 '(("d" . 1) ("w" . 7)
15882 ("m" . 30.4) ("y" . 365.25)))))))
15883 ;; go for the default.
15884 (t org-deadline-warning-days)))
15886 (defun org-calendar-select-mouse (ev)
15887 "Return to `org-read-date' with the date currently selected.
15888 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15889 (interactive "e")
15890 (mouse-set-point ev)
15891 (when (calendar-cursor-to-date)
15892 (let* ((date (calendar-cursor-to-date))
15893 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15894 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15895 (if (active-minibuffer-window) (exit-minibuffer))))
15897 (defun org-check-deadlines (ndays)
15898 "Check if there are any deadlines due or past due.
15899 A deadline is considered due if it happens within `org-deadline-warning-days'
15900 days from today's date. If the deadline appears in an entry marked DONE,
15901 it is not shown. The prefix arg NDAYS can be used to test that many
15903 (interactive "P")
15904 (let* ((org-warn-days
15905 (cond
15906 ((equal ndays '(4)) 100000)
15907 (ndays (prefix-numeric-value ndays))
15908 (t (abs org-deadline-warning-days))))
15909 (case-fold-search nil)
15911 (callback
15912 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15914 (message "%d deadlines past-due or due within %d days"
15915 (org-occur regexp nil callback)
15916 org-warn-days)))
15918 (defsubst org-re-timestamp (type)
15919 "Return a regexp for timestamp TYPE.
15920 Allowed values for TYPE are:
15922 all: all timestamps
15923 active: only active timestamps (<...>)
15924 inactive: only inactive timestamps ([...])
15925 scheduled: only scheduled timestamps
15926 deadline: only deadline timestamps
15928 When TYPE is nil, fall back on returning a regexp that matches
15929 both scheduled and deadline timestamps."
15930 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
15931 ((eq type 'active) org-ts-regexp)
15935 ((eq type 'scheduled-or-deadline)
15938 (defun org-check-before-date (date)
15939 "Check if there are deadlines or scheduled entries before DATE."
15940 (interactive (list (org-read-date)))
15941 (let ((case-fold-search nil)
15942 (regexp (org-re-timestamp org-ts-type))
15943 (callback
15944 (lambda () (time-less-p
15945 (org-time-string-to-time (match-string 1))
15946 (org-time-string-to-time date)))))
15947 (message "%d entries before %s"
15948 (org-occur regexp nil callback) date)))
15950 (defun org-check-after-date (date)
15951 "Check if there are deadlines or scheduled entries after DATE."
15952 (interactive (list (org-read-date)))
15953 (let ((case-fold-search nil)
15954 (regexp (org-re-timestamp org-ts-type))
15955 (callback
15956 (lambda () (not
15957 (time-less-p
15958 (org-time-string-to-time (match-string 1))
15959 (org-time-string-to-time date))))))
15960 (message "%d entries after %s"
15961 (org-occur regexp nil callback) date)))
15963 (defun org-check-dates-range (start-date end-date)
15964 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15965 (interactive (list (org-read-date nil nil nil "Range starts")
15966 (org-read-date nil nil nil "Range end")))
15967 (let ((case-fold-search nil)
15968 (regexp (org-re-timestamp org-ts-type))
15969 (callback
15970 (lambda ()
15971 (let ((match (match-string 1)))
15972 (and
15973 (not (time-less-p
15974 (org-time-string-to-time match)
15975 (org-time-string-to-time start-date)))
15976 (time-less-p
15977 (org-time-string-to-time match)
15978 (org-time-string-to-time end-date)))))))
15979 (message "%d entries between %s and %s"
15980 (org-occur regexp nil callback) start-date end-date)))
15982 (defun org-evaluate-time-range (&optional to-buffer)
15983 "Evaluate a time range by computing the difference between start and end.
15984 Normally the result is just printed in the echo area, but with prefix arg
15985 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15986 If the time range is actually in a table, the result is inserted into the
15987 next column.
15988 For time difference computation, a year is assumed to be exactly 365
15989 days in order to avoid rounding problems."
15990 (interactive "P")
15991 (or
15992 (org-clock-update-time-maybe)
15993 (save-excursion
15994 (unless (org-at-date-range-p t)
15995 (goto-char (point-at-bol))
15996 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15997 (if (not (org-at-date-range-p t))
15998 (error "Not at a time-stamp range, and none found in current line")))
15999 (let* ((ts1 (match-string 1))
16000 (ts2 (match-string 2))
16001 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16002 (match-end (match-end 0))
16003 (time1 (org-time-string-to-time ts1))
16004 (time2 (org-time-string-to-time ts2))
16005 (t1 (org-float-time time1))
16006 (t2 (org-float-time time2))
16007 (diff (abs (- t2 t1)))
16008 (negative (< (- t2 t1) 0))
16009 ;; (ys (floor (* 365 24 60 60)))
16010 (ds (* 24 60 60))
16011 (hs (* 60 60))
16012 (fy "%dy %dd %02d:%02d")
16013 (fy1 "%dy %dd")
16014 (fd "%dd %02d:%02d")
16015 (fd1 "%dd")
16016 (fh "%02d:%02d")
16017 y d h m align)
16018 (if havetime
16019 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16020 y 0
16021 d (floor (/ diff ds)) diff (mod diff ds)
16022 h (floor (/ diff hs)) diff (mod diff hs)
16023 m (floor (/ diff 60)))
16024 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16025 y 0
16026 d (floor (+ (/ diff ds) 0.5))
16027 h 0 m 0))
16028 (if (not to-buffer)
16029 (message "%s" (org-make-tdiff-string y d h m))
16030 (if (org-at-table-p)
16031 (progn
16032 (goto-char match-end)
16033 (setq align t)
16034 (and (looking-at " *|") (goto-char (match-end 0))))
16035 (goto-char match-end))
16036 (if (looking-at
16038 (replace-match ""))
16039 (if negative (insert " -"))
16040 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16041 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16042 (insert " " (format fh h m))))
16043 (if align (org-table-align))
16044 (message "Time difference inserted")))))
16046 (defun org-make-tdiff-string (y d h m)
16047 (let ((fmt "")
16048 (l nil))
16049 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16050 l (push y l)))
16051 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16052 l (push d l)))
16053 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16054 l (push h l)))
16055 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16056 l (push m l)))
16057 (apply 'format fmt (nreverse l))))
16059 (defun org-time-string-to-time (s &optional buffer pos)
16060 "Convert a timestamp string into internal time."
16061 (condition-case errdata
16062 (apply 'encode-time (org-parse-time-string s))
16064 s (if (not (and buffer pos))
16065 ""
16066 (format " at %d in buffer `%s'" pos buffer))
16067 (cdr errdata)))))
16069 (defun org-time-string-to-seconds (s)
16070 "Convert a timestamp string to a number of seconds."
16071 (org-float-time (org-time-string-to-time s)))
16073 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16074 "Convert a time stamp to an absolute day number.
16075 If there is a specifier for a cyclic time stamp, get the closest date to
16076 DAYNR.
16077 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16078 The variable date is bound by the calendar when this is called."
16079 (cond
16081 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16082 daynr
16083 (+ daynr 1000)))
16085 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16086 (time-to-days (current-time))) (match-string 0 s)
16087 prefer show-all))
16088 (t (time-to-days
16089 (condition-case errdata
16090 (apply 'encode-time (org-parse-time-string s))
16092 s (if (not (and buffer pos))
16093 ""
16094 (format " at %d in buffer `%s'" pos buffer))
16095 (cdr errdata))))))))
16097 (defun org-days-to-iso-week (days)
16098 "Return the iso week number."
16099 (require 'cal-iso)
16100 (car (calendar-iso-from-absolute days)))
16102 (defun org-small-year-to-year (year)
16103 "Convert 2-digit years into 4-digit years.
16104 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16105 The year 2000 cannot be abbreviated. Any year larger than 99
16106 is returned unchanged."
16107 (if (< year 38)
16108 (setq year (+ 2000 year))
16109 (if (< year 100)
16110 (setq year (+ 1900 year))))
16111 year)
16113 (defun org-time-from-absolute (d)
16114 "Return the time corresponding to date D.
16115 D may be an absolute day number, or a calendar-type list (month day year)."
16116 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16117 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16119 (defun org-calendar-holiday ()
16120 "List of holidays, for Diary display in Org-mode."
16121 (require 'holidays)
16122 (let ((hl (funcall
16123 (if (fboundp 'calendar-check-holidays)
16124 'calendar-check-holidays 'check-calendar-holidays) date)))
16125 (if hl (mapconcat 'identity hl "; "))))
16127 (defun org-diary-sexp-entry (sexp entry date)
16128 "Process a SEXP diary ENTRY for DATE."
16129 (require 'diary-lib)
16130 (let ((result (if calendar-debug-sexp
16131 (let ((stack-trace-on-error t))
16132 (eval (car (read-from-string sexp))))
16133 (condition-case nil
16134 (eval (car (read-from-string sexp)))
16135 (error
16136 (beep)
16137 (message "Bad sexp at line %d in %s: %s"
16138 (org-current-line)
16139 (buffer-file-name) sexp)
16140 (sleep-for 2))))))
16141 (cond ((stringp result) (split-string result "; "))
16142 ((and (consp result)
16143 (not (consp (cdr result)))
16144 (stringp (cdr result))) (cdr result))
16145 ((and (consp result)
16146 (stringp (car result))) result)
16147 (result entry))))
16149 (defun org-diary-to-ical-string (frombuf)
16150 "Get iCalendar entries from diary entries in buffer FROMBUF.
16151 This uses the icalendar.el library."
16152 (let* ((tmpdir (if (featurep 'xemacs)
16153 (temp-directory)
16154 temporary-file-directory))
16155 (tmpfile (make-temp-name
16156 (expand-file-name "orgics" tmpdir)))
16157 buf rtn b e)
16158 (with-current-buffer frombuf
16159 (icalendar-export-region (point-min) (point-max) tmpfile)
16160 (setq buf (find-buffer-visiting tmpfile))
16161 (set-buffer buf)
16162 (goto-char (point-min))
16163 (if (re-search-forward "^BEGIN:VEVENT" nil t)
16164 (setq b (match-beginning 0)))
16165 (goto-char (point-max))
16166 (if (re-search-backward "^END:VEVENT" nil t)
16167 (setq e (match-end 0)))
16169 (kill-buffer buf)
16170 (delete-file tmpfile)
16171 rtn))
16173 (defun org-closest-date (start current change prefer show-all)
16174 "Find the date closest to CURRENT that is consistent with START and CHANGE.
16175 When PREFER is `past', return a date that is either CURRENT or past.
16176 When PREFER is `future', return a date that is either CURRENT or future.
16177 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
16178 ;; Make the proper lists from the dates
16179 (catch 'exit
16180 (let ((a1 '(("h" . hour)
16181 ("d" . day)
16182 ("w" . week)
16183 ("m" . month)
16184 ("y" . year)))
16185 (shour (nth 2 (org-parse-time-string start)))
16186 dn dw sday cday n1 n2 n0
16187 d m y y1 y2 date1 date2 nmonths nm ny m2)
16189 (setq start (org-date-to-gregorian start)
16190 current (org-date-to-gregorian
16191 (if show-all
16192 current
16193 (time-to-days (current-time))))
16194 sday (calendar-absolute-from-gregorian start)
16195 cday (calendar-absolute-from-gregorian current))
16197 (if (<= cday sday) (throw 'exit sday))
16200 (setq dn (string-to-number (match-string 1 change))
16201 dw (cdr (assoc (match-string 2 change) a1)))
16202 (error "Invalid change specifier: %s" change))
16203 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16204 (cond
16205 ((eq dw 'hour)
16206 (let ((missing-hours
16207 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
16208 dn)))
16209 (setq n1 (if (zerop missing-hours) cday
16210 (- cday (1+ (floor (/ missing-hours 24)))))
16211 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
16212 ((eq dw 'day)
16213 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16214 n2 (+ n1 dn)))
16215 ((eq dw 'year)
16216 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16217 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16218 (setq date1 (list m d y1)
16219 n1 (calendar-absolute-from-gregorian date1)
16220 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16221 n2 (calendar-absolute-from-gregorian date2)))
16222 ((eq dw 'month)
16223 ;; approx number of month between the two dates
16224 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16225 ;; How often does dn fit in there?
16226 (setq d (nth 1 start) m (car start) y (nth 2 start)
16227 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16228 m (+ m nm)
16229 ny (floor (/ m 12))
16230 y (+ y ny)
16231 m (- m (* ny 12)))
16232 (while (> m 12) (setq m (- m 12) y (1+ y)))
16233 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16234 (setq m2 (+ m dn) y2 y)
16235 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16236 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16237 (while (<= n2 cday)
16238 (setq n1 n2 m m2 y y2)
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 ;; Make sure n1 is the earlier date
16243 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16244 (if show-all
16245 (cond
16246 ((eq prefer 'past) (if (= cday n2) n2 n1))
16247 ((eq prefer 'future) (if (= cday n1) n1 n2))
16248 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16249 (cond
16250 ((eq prefer 'past) (if (= cday n2) n2 n1))
16251 ((eq prefer 'future) (if (= cday n1) n1 n2))
16252 (t (if (= cday n1) n1 n2)))))))
16254 (defun org-date-to-gregorian (date)
16255 "Turn any specification of DATE into a Gregorian date for the calendar."
16256 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16257 ((and (listp date) (= (length date) 3)) date)
16258 ((stringp date)
16259 (setq date (org-parse-time-string date))
16260 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16261 ((listp date)
16262 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16264 (defun org-parse-time-string (s &optional nodefault)
16265 "Parse the standard Org-mode time string.
16266 This should be a lot faster than the normal `parse-time-string'.
16267 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16268 hour and minute fields will be nil if not given."
16269 (if (string-match org-ts-regexp0 s)
16270 (list 0
16271 (if (or (match-beginning 8) (not nodefault))
16272 (string-to-number (or (match-string 8 s) "0")))
16273 (if (or (match-beginning 7) (not nodefault))
16274 (string-to-number (or (match-string 7 s) "0")))
16275 (string-to-number (match-string 4 s))
16276 (string-to-number (match-string 3 s))
16277 (string-to-number (match-string 2 s))
16278 nil nil nil)
16279 (error "Not a standard Org-mode time string: %s" s)))
16281 (defun org-timestamp-up (&optional arg)
16282 "Increase the date item at the cursor by one.
16283 If the cursor is on the year, change the year. If it is on the month,
16284 the day or the time, change that.
16285 With prefix ARG, change by that many units."
16286 (interactive "p")
16287 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16289 (defun org-timestamp-down (&optional arg)
16290 "Decrease the date item at the cursor by one.
16291 If the cursor is on the year, change the year. If it is on the month,
16292 the day or the time, change that.
16293 With prefix ARG, change by that many units."
16294 (interactive "p")
16295 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16297 (defun org-timestamp-up-day (&optional arg)
16298 "Increase the date in the time stamp by one day.
16299 With prefix ARG, change that many days."
16300 (interactive "p")
16301 (if (and (not (org-at-timestamp-p t))
16302 (org-at-heading-p))
16303 (org-todo 'up)
16304 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16306 (defun org-timestamp-down-day (&optional arg)
16307 "Decrease the date in the time stamp by one day.
16308 With prefix ARG, change that many days."
16309 (interactive "p")
16310 (if (and (not (org-at-timestamp-p t))
16311 (org-at-heading-p))
16312 (org-todo 'down)
16313 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16315 (defun org-at-timestamp-p (&optional inactive-ok)
16316 "Determine if the cursor is in or at a timestamp."
16317 (interactive)
16318 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16319 (pos (point))
16320 (ans (or (looking-at tsr)
16321 (save-excursion
16323 (if (> (point) (point-min)) (backward-char 1))
16324 (and (looking-at tsr)
16325 (> (- (match-end 0) pos) -1))))))
16326 (and ans
16327 (boundp 'org-ts-what)
16328 (setq org-ts-what
16329 (cond
16330 ((= pos (match-beginning 0)) 'bracket)
16331 ;; Point is considered to be "on the bracket" whether
16332 ;; it's really on it or right after it.
16333 ((= pos (1- (match-end 0))) 'bracket)
16334 ((= pos (match-end 0)) 'after)
16335 ((org-pos-in-match-range pos 2) 'year)
16336 ((org-pos-in-match-range pos 3) 'month)
16337 ((org-pos-in-match-range pos 7) 'hour)
16338 ((org-pos-in-match-range pos 8) 'minute)
16339 ((or (org-pos-in-match-range pos 4)
16340 (org-pos-in-match-range pos 5)) 'day)
16341 ((and (> pos (or (match-end 8) (match-end 5)))
16342 (< pos (match-end 0)))
16343 (- pos (or (match-end 8) (match-end 5))))
16344 (t 'day))))
16345 ans))
16347 (defun org-toggle-timestamp-type ()
16348 "Toggle the type (<active> or [inactive]) of a time stamp."
16349 (interactive)
16350 (when (org-at-timestamp-p t)
16351 (let ((beg (match-beginning 0)) (end (match-end 0))
16352 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16353 (save-excursion
16354 (goto-char beg)
16355 (while (re-search-forward "[][<>]" end t)
16356 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16357 t t)))
16358 (message "Timestamp is now %sactive"
16359 (if (equal (char-after beg) ?<) "" "in")))))
16361 (defvar org-clock-history) ; defined in org-clock.el
16362 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
16363 (defun org-timestamp-change (n &optional what updown)
16364 "Change the date in the time stamp at point.
16365 The date will be changed by N times WHAT. WHAT can be `day', `month',
16366 `year', `minute', `second'. If WHAT is not given, the cursor position
16367 in the timestamp determines what will be changed."
16368 (let ((origin (point)) origin-cat
16369 with-hm inactive
16370 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16371 org-ts-what
16372 extra rem
16373 ts time time0 fixnext clrgx)
16374 (if (not (org-at-timestamp-p t))
16375 (error "Not at a timestamp"))
16376 (if (and (not what) (eq org-ts-what 'bracket))
16377 (org-toggle-timestamp-type)
16378 ;; Point isn't on brackets. Remember the part of the time-stamp
16379 ;; the point was in. Indeed, size of time-stamps may change,
16380 ;; but point must be kept in the same category nonetheless.
16381 (setq origin-cat org-ts-what)
16382 (if (and (not what) (not (eq org-ts-what 'day))
16383 org-display-custom-times
16384 (get-text-property (point) 'display)
16385 (not (get-text-property (1- (point)) 'display)))
16386 (setq org-ts-what 'day))
16387 (setq org-ts-what (or what org-ts-what)
16388 inactive (= (char-after (match-beginning 0)) ?\[)
16389 ts (match-string 0))
16390 (replace-match "")
16391 (if (string-match
16393 ts)
16394 (setq extra (match-string 1 ts)))
16396 (setq with-hm t))
16397 (setq time0 (org-parse-time-string ts))
16398 (when (and updown
16399 (eq org-ts-what 'minute)
16400 (not current-prefix-arg))
16401 ;; This looks like s-up and s-down. Change by one rounding step.
16402 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16403 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16404 (setcar (cdr time0) (+ (nth 1 time0)
16405 (if (> n 0) (- rem) (- dm rem))))))
16406 (setq time
16407 (encode-time (or (car time0) 0)
16408 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16409 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16410 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16411 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16412 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16413 (nthcdr 6 time0)))
16414 (when (and (member org-ts-what '(hour minute))
16415 extra
16417 (setq extra (org-modify-ts-extra
16418 extra
16419 (if (eq org-ts-what 'hour) 2 5)
16420 n dm)))
16421 (when (integerp org-ts-what)
16422 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16423 (if (eq what 'calendar)
16424 (let ((cal-date (org-get-date-from-calendar)))
16425 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16426 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16427 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16428 (setcar time0 (or (car time0) 0))
16429 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16430 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16431 (setq time (apply 'encode-time time0))))
16432 ;; Insert the new time-stamp, and ensure point stays in the same
16433 ;; category as before (i.e. not after the last position in that
16434 ;; category).
16435 (let ((pos (point)))
16436 ;; Stay before inserted string. `save-excursion' is of no use.
16437 (setq org-last-changed-timestamp
16438 (org-insert-time-stamp time with-hm inactive nil nil extra))
16439 (goto-char pos))
16440 (save-match-data
16441 (looking-at org-ts-regexp3)
16442 (goto-char (cond
16443 ;; `day' category ends before `hour' if any, or at
16444 ;; the end of the day name.
16445 ((eq origin-cat 'day)
16446 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16447 ((eq origin-cat 'hour) (min (match-end 7) origin))
16448 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16449 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16450 ;; `year' and `month' have both fixed size: point
16451 ;; couldn't have moved into another part.
16452 (t origin))))
16453 ;; Update clock if on a CLOCK line.
16454 (org-clock-update-time-maybe)
16455 ;; Maybe adjust the closest clock in `org-clock-history'
16456 (when org-clock-adjust-closest
16457 (if (not (and (org-at-clock-log-p)
16458 (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
16459 org-clock-history))))))
16460 (message "No clock to adjust")
16461 (cond ((save-excursion ; fix previous clock?
16462 (re-search-backward org-ts-regexp0 nil t)
16465 ((save-excursion ; fix next clock?
16466 (re-search-backward org-ts-regexp0 nil t)
16469 (save-window-excursion
16470 ;; Find closest clock to point, adjust the previous/next one in history
16471 (let* ((p (save-excursion (org-back-to-heading t)))
16472 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
16473 (clfixnth
16474 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
16475 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
16476 (if (not clfixpos)
16477 (message "No clock to adjust")
16478 (save-excursion
16479 (org-goto-marker-or-bmk clfixpos)
16480 (org-show-subtree)
16481 (when (re-search-forward clrgx nil t)
16482 (goto-char (match-beginning 1))
16483 (let (org-clock-adjust-closest)
16484 (org-timestamp-change n org-ts-what updown))
16485 (message "Clock adjusted in %s for heading: %s"
16486 (file-name-nondirectory (buffer-file-name))
16487 (org-get-heading t t)))))))))
16488 ;; Try to recenter the calendar window, if any.
16489 (if (and org-calendar-follow-timestamp-change
16490 (get-buffer-window "*Calendar*" t)
16491 (memq org-ts-what '(day month year)))
16492 (org-recenter-calendar (time-to-days time))))))
16494 (defun org-modify-ts-extra (s pos n dm)
16495 "Change the different parts of the lead-time and repeat fields in timestamp."
16496 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16497 ng h m new rem)
16498 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16499 (cond
16500 ((or (org-pos-in-match-range pos 2)
16501 (org-pos-in-match-range pos 3))
16502 (setq m (string-to-number (match-string 3 s))
16503 h (string-to-number (match-string 2 s)))
16504 (if (org-pos-in-match-range pos 2)
16505 (setq h (+ h n))
16506 (setq n (* dm (org-no-warnings (signum n))))
16507 (when (not (= 0 (setq rem (% m dm))))
16508 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16509 (setq m (+ m n)))
16510 (if (< m 0) (setq m (+ m 60) h (1- h)))
16511 (if (> m 59) (setq m (- m 60) h (1+ h)))
16512 (setq h (min 24 (max 0 h)))
16513 (setq ng 1 new (format "-%02d:%02d" h m)))
16514 ((org-pos-in-match-range pos 6)
16515 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16516 ((org-pos-in-match-range pos 5)
16517 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16519 ((org-pos-in-match-range pos 9)
16520 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16521 ((org-pos-in-match-range pos 8)
16522 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16524 (when ng
16525 (setq s (concat
16526 (substring s 0 (match-beginning ng))
16527 new
16528 (substring s (match-end ng))))))
16529 s))
16531 (defun org-recenter-calendar (date)
16532 "If the calendar is visible, recenter it to DATE."
16533 (let ((cwin (get-buffer-window "*Calendar*" t)))
16534 (when cwin
16535 (let ((calendar-move-hook nil))
16536 (with-selected-window cwin
16537 (calendar-goto-date (if (listp date) date
16538 (calendar-gregorian-from-absolute date))))))))
16540 (defun org-goto-calendar (&optional arg)
16541 "Go to the Emacs calendar at the current date.
16542 If there is a time stamp in the current line, go to that date.
16543 A prefix ARG can be used to force the current date."
16544 (interactive "P")
16545 (let ((tsr org-ts-regexp) diff
16546 (calendar-move-hook nil)
16547 (calendar-view-holidays-initially-flag nil)
16548 (calendar-view-diary-initially-flag nil))
16549 (if (or (org-at-timestamp-p)
16550 (save-excursion
16551 (beginning-of-line 1)
16552 (looking-at (concat ".*" tsr))))
16553 (let ((d1 (time-to-days (current-time)))
16554 (d2 (time-to-days
16555 (org-time-string-to-time (match-string 1)))))
16556 (setq diff (- d2 d1))))
16557 (calendar)
16558 (calendar-goto-today)
16559 (if (and diff (not arg)) (calendar-forward-day diff))))
16561 (defun org-get-date-from-calendar ()
16562 "Return a list (month day year) of date at point in calendar."
16563 (with-current-buffer "*Calendar*"
16564 (save-match-data
16565 (calendar-cursor-to-date))))
16567 (defun org-date-from-calendar ()
16568 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16569 If there is already a time stamp at the cursor position, update it."
16570 (interactive)
16571 (if (org-at-timestamp-p t)
16572 (org-timestamp-change 0 'calendar)
16573 (let ((cal-date (org-get-date-from-calendar)))
16574 (org-insert-time-stamp
16575 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16577 (defun org-minutes-to-hh:mm-string (m)
16578 "Compute H:MM from a number of minutes."
16579 (let ((h (/ m 60)))
16580 (setq m (- m (* 60 h)))
16581 (format org-time-clocksum-format h m)))
16583 (defun org-hh:mm-string-to-minutes (s)
16584 "Convert a string H:MM to a number of minutes.
16585 If the string is just a number, interpret it as minutes.
16586 In fact, the first hh:mm or number in the string will be taken,
16587 there can be extra stuff in the string.
16588 If no number is found, the return value is 0."
16589 (cond
16590 ((integerp s) s)
16592 (+ (* (string-to-number (match-string 1 s)) 60)
16593 (string-to-number (match-string 2 s))))
16595 (string-to-number (match-string 1 s)))
16596 (t 0)))
16598 (defcustom org-effort-durations
16599 `(("h" . 60)
16600 ("d" . ,(* 60 8))
16601 ("w" . ,(* 60 8 5))
16602 ("m" . ,(* 60 8 5 4))
16603 ("y" . ,(* 60 8 5 40)))
16604 "Conversion factor to minutes for an effort modifier.
16606 Each entry has the form (MODIFIER . MINUTES).
16608 In an effort string, a number followed by MODIFIER is multiplied
16609 by the specified number of MINUTES to obtain an effort in
16610 minutes.
16614 :group 'org-agenda
16615 :version "24.1"
16616 :type '(alist :key-type (string :tag "Modifier")
16617 :value-type (number :tag "Minutes")))
16619 (defun org-duration-string-to-minutes (s &optional output-to-string)
16620 "Convert a duration string S to minutes.
16622 A bare number is interpreted as minutes, modifiers can be set by
16623 customizing `org-effort-durations' (which see).
16625 Entries containing a colon are interpreted as H:MM by
16626 `org-hh:mm-string-to-minutes'."
16627 (let ((result 0)
16629 (regexp-opt (mapcar 'car org-effort-durations))
16631 (while (string-match re s)
16632 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16633 (string-to-number (match-string 1 s))))
16634 (setq s (replace-match "" nil t s)))
16635 (setq result (floor result))
16636 (incf result (org-hh:mm-string-to-minutes s))
16637 (if output-to-string (number-to-string result) result)))
16639 ;;;; Files
16641 (defun org-save-all-org-buffers ()
16642 "Save all Org-mode buffers without user confirmation."
16643 (interactive)
16644 (message "Saving all Org-mode buffers...")
16645 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
16646 (when (featurep 'org-id) (org-id-locations-save))
16647 (message "Saving all Org-mode buffers... done"))
16649 (defun org-revert-all-org-buffers ()
16650 "Revert all Org-mode buffers.
16651 Prompt for confirmation when there are unsaved changes.
16652 Be sure you know what you are doing before letting this function
16653 overwrite your changes.
16655 This function is useful in a setup where one tracks org files
16656 with a version control system, to revert on one machine after pulling
16657 changes from another. I believe the procedure must be like this:
16659 1. M-x org-save-all-org-buffers
16660 2. Pull changes from the other machine, resolve conflicts
16661 3. M-x org-revert-all-org-buffers"
16662 (interactive)
16663 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16664 (error "Abort"))
16665 (save-excursion
16666 (save-window-excursion
16667 (mapc
16668 (lambda (b)
16669 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
16670 (with-current-buffer b buffer-file-name))
16671 (org-pop-to-buffer-same-window b)
16672 (revert-buffer t 'no-confirm)))
16673 (buffer-list))
16674 (when (and (featurep 'org-id) org-id-track-globally)
16675 (org-id-locations-load)))))
16677 ;;;; Agenda files
16679 ;;;###autoload
16680 (defun org-switchb (&optional arg)
16681 "Switch between Org buffers.
16682 With one prefix argument, restrict available buffers to files.
16683 With two prefix arguments, restrict available buffers to agenda files.
16685 Defaults to `iswitchb' for buffer name completion.
16686 Set `org-completion-use-ido' to make it use ido instead."
16687 (interactive "P")
16688 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16689 ((equal arg '(16)) (org-buffer-list 'agenda))
16690 (t (org-buffer-list))))
16691 (org-completion-use-iswitchb org-completion-use-iswitchb)
16692 (org-completion-use-ido org-completion-use-ido))
16693 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16694 (setq org-completion-use-iswitchb t))
16695 (org-pop-to-buffer-same-window
16696 (org-icompleting-read "Org buffer: "
16697 (mapcar 'list (mapcar 'buffer-name blist))
16698 nil t))))
16700 ;;; Define some older names previously used for this functionality
16701 ;;;###autoload
16702 (defalias 'org-ido-switchb 'org-switchb)
16703 ;;;###autoload
16704 (defalias 'org-iswitchb 'org-switchb)
16706 (defun org-buffer-list (&optional predicate exclude-tmp)
16707 "Return a list of Org buffers.
16708 PREDICATE can be `export', `files' or `agenda'.
16710 export restrict the list to Export buffers.
16711 files restrict the list to buffers visiting Org files.
16712 agenda restrict the list to buffers visiting agenda files.
16714 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16715 (let* ((bfn nil)
16716 (agenda-files (and (eq predicate 'agenda)
16717 (mapcar 'file-truename (org-agenda-files t))))
16718 (filter
16719 (cond
16720 ((eq predicate 'files)
16721 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
16722 ((eq predicate 'export)
16723 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16724 ((eq predicate 'agenda)
16725 (lambda (b)
16726 (with-current-buffer b
16727 (and (derived-mode-p 'org-mode)
16728 (setq bfn (buffer-file-name b))
16729 (member (file-truename bfn) agenda-files)))))
16730 (t (lambda (b) (with-current-buffer b
16731 (or (derived-mode-p 'org-mode)
16732 (string-match "\*Org .*Export"
16733 (buffer-name b)))))))))
16734 (delq nil
16735 (mapcar
16736 (lambda(b)
16737 (if (and (funcall filter b)
16738 (or (not exclude-tmp)
16739 (not (string-match "tmp" (buffer-name b)))))
16740 b
16741 nil))
16742 (buffer-list)))))
16744 (defun org-agenda-files (&optional unrestricted archives)
16745 "Get the list of agenda files.
16746 Optional UNRESTRICTED means return the full list even if a restriction
16747 is currently in place.
16748 When ARCHIVES is t, include all archive files that are really being
16749 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16750 `org-agenda-archives-mode' is t."
16751 (let ((files
16752 (cond
16753 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16754 ((stringp org-agenda-files) (org-read-agenda-file-list))
16755 ((listp org-agenda-files) org-agenda-files)
16756 (t (error "Invalid value of `org-agenda-files'")))))
16757 (setq files (apply 'append
16758 (mapcar (lambda (f)
16759 (if (file-directory-p f)
16760 (directory-files
16761 f t org-agenda-file-regexp)
16762 (list f)))
16763 files)))
16764 (when org-agenda-skip-unavailable-files
16765 (setq files (delq nil
16766 (mapcar (function
16767 (lambda (file)
16768 (and (file-readable-p file) file)))
16769 files))))
16770 (when (or (eq archives t)
16771 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16772 (setq files (org-add-archive-files files)))
16773 files))
16775 (defun org-agenda-file-p (&optional file)
16776 "Return non-nil, if FILE is an agenda file.
16777 If FILE is omitted, use the file associated with the current
16778 buffer."
16779 (member (or file (buffer-file-name))
16780 (org-agenda-files t)))
16782 (defun org-edit-agenda-file-list ()
16783 "Edit the list of agenda files.
16784 Depending on setup, this either uses customize to edit the variable
16785 `org-agenda-files', or it visits the file that is holding the list. In the
16786 latter case, the buffer is set up in a way that saving it automatically kills
16787 the buffer and restores the previous window configuration."
16788 (interactive)
16789 (if (stringp org-agenda-files)
16790 (let ((cw (current-window-configuration)))
16791 (find-file org-agenda-files)
16792 (org-set-local 'org-window-configuration cw)
16793 (org-add-hook 'after-save-hook
16794 (lambda ()
16795 (set-window-configuration
16796 (prog1 org-window-configuration
16797 (kill-buffer (current-buffer))))
16798 (org-install-agenda-files-menu)
16799 (message "New agenda file list installed"))
16800 nil 'local)
16801 (message "%s" (substitute-command-keys
16803 (customize-variable 'org-agenda-files)))
16805 (defun org-store-new-agenda-file-list (list)
16806 "Set new value for the agenda file list and save it correctly."
16807 (if (stringp org-agenda-files)
16808 (let ((fe (org-read-agenda-file-list t)) b u)
16809 (while (setq b (find-buffer-visiting org-agenda-files))
16810 (kill-buffer b))
16811 (with-temp-file org-agenda-files
16812 (insert
16813 (mapconcat
16814 (lambda (f) ;; Keep un-expanded entries.
16815 (if (setq u (assoc f fe))
16816 (cdr u)
16817 f))
16820 (let ((org-mode-hook nil) (org-inhibit-startup t)
16821 (org-insert-mode-line-in-empty-file nil))
16822 (setq org-agenda-files list)
16823 (customize-save-variable 'org-agenda-files org-agenda-files))))
16825 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16826 "Read the list of agenda files from a file.
16827 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16828 filenames, used by `org-store-new-agenda-file-list' to write back
16829 un-expanded file names."
16830 (when (file-directory-p org-agenda-files)
16831 (error "`org-agenda-files' cannot be a single directory"))
16832 (when (stringp org-agenda-files)
16833 (with-temp-buffer
16834 (insert-file-contents org-agenda-files)
16835 (mapcar
16836 (lambda (f)
16837 (let ((e (expand-file-name (substitute-in-file-name f)
16838 org-directory)))
16839 (if pair-with-expansion
16840 (cons e f)
16841 e)))
16844 ;;;###autoload
16845 (defun org-cycle-agenda-files ()
16846 "Cycle through the files in `org-agenda-files'.
16847 If the current buffer visits an agenda file, find the next one in the list.
16848 If the current buffer does not, find the first agenda file."
16849 (interactive)
16850 (let* ((fs (org-agenda-files t))
16851 (files (append fs (list (car fs))))
16852 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16853 file)
16854 (unless files (error "No agenda files"))
16855 (catch 'exit
16856 (while (setq file (pop files))
16857 (if (equal (file-truename file) tcf)
16858 (when (car files)
16859 (find-file (car files))
16860 (throw 'exit t))))
16861 (find-file (car fs)))
16862 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16864 (defun org-agenda-file-to-front (&optional to-end)
16865 "Move/add the current file to the top of the agenda file list.
16866 If the file is not present in the list, it is added to the front. If it is
16867 present, it is moved there. With optional argument TO-END, add/move to the
16868 end of the list."
16869 (interactive "P")
16870 (let ((org-agenda-skip-unavailable-files nil)
16871 (file-alist (mapcar (lambda (x)
16872 (cons (file-truename x) x))
16873 (org-agenda-files t)))
16874 (ctf (file-truename
16875 (or buffer-file-name
16876 (error "Please save the current buffer to a file"))))
16877 x had)
16878 (setq x (assoc ctf file-alist) had x)
16880 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16881 (if to-end
16882 (setq file-alist (append (delq x file-alist) (list x)))
16883 (setq file-alist (cons x (delq x file-alist))))
16884 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16885 (org-install-agenda-files-menu)
16886 (message "File %s to %s of agenda file list"
16887 (if had "moved" "added") (if to-end "end" "front"))))
16889 (defun org-remove-file (&optional file)
16890 "Remove current file from the list of files in variable `org-agenda-files'.
16891 These are the files which are being checked for agenda entries.
16892 Optional argument FILE means use this file instead of the current."
16893 (interactive)
16894 (let* ((org-agenda-skip-unavailable-files nil)
16895 (file (or file buffer-file-name
16896 (error "Current buffer does not visit a file")))
16897 (true-file (file-truename file))
16898 (afile (abbreviate-file-name file))
16899 (files (delq nil (mapcar
16900 (lambda (x)
16901 (if (equal true-file
16902 (file-truename x))
16903 nil x))
16904 (org-agenda-files t)))))
16905 (if (not (= (length files) (length (org-agenda-files t))))
16906 (progn
16907 (org-store-new-agenda-file-list files)
16908 (org-install-agenda-files-menu)
16909 (message "Removed file: %s" afile))
16910 (message "File was not in list: %s (not removed)" afile))))
16912 (defun org-file-menu-entry (file)
16913 (vector file (list 'find-file file) t))
16915 (defun org-check-agenda-file (file)
16916 "Make sure FILE exists. If not, ask user what to do."
16917 (when (not (file-exists-p file))
16918 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
16919 (abbreviate-file-name file))
16920 (let ((r (downcase (read-char-exclusive))))
16921 (cond
16922 ((equal r ?r)
16923 (org-remove-file file)
16924 (throw 'nextfile t))
16925 (t (error "Abort"))))))
16927 (defun org-get-agenda-file-buffer (file)
16928 "Get a buffer visiting FILE. If the buffer needs to be created, add
16929 it to the list of buffers which might be released later."
16930 (let ((buf (org-find-base-buffer-visiting file)))
16931 (if buf
16932 buf ; just return it
16933 ;; Make a new buffer and remember it
16934 (setq buf (find-file-noselect file))
16935 (if buf (push buf org-agenda-new-buffers))
16936 buf)))
16938 (defun org-release-buffers (blist)
16939 "Release all buffers in list, asking the user for confirmation when needed.
16940 When a buffer is unmodified, it is just killed. When modified, it is saved
16941 \(if the user agrees) and then killed."
16942 (let (buf file)
16943 (while (setq buf (pop blist))
16944 (setq file (buffer-file-name buf))
16945 (when (and (buffer-modified-p buf)
16946 file
16947 (y-or-n-p (format "Save file %s? " file)))
16948 (with-current-buffer buf (save-buffer)))
16949 (kill-buffer buf))))
16951 (defun org-agenda-prepare-buffers (files)
16952 "Create buffers for all agenda files, protect archived trees and comments."
16953 (interactive)
16954 (let ((pa '(:org-archived t))
16955 (pc '(:org-comment t))
16956 (pall '(:org-archived t :org-comment t))
16957 (inhibit-read-only t)
16958 (rea (concat ":" org-archive-tag ":"))
16959 bmp file re)
16960 (save-excursion
16961 (save-restriction
16962 (while (setq file (pop files))
16963 (catch 'nextfile
16964 (if (bufferp file)
16965 (set-buffer file)
16966 (org-check-agenda-file file)
16967 (set-buffer (org-get-agenda-file-buffer file)))
16968 (widen)
16969 (setq bmp (buffer-modified-p))
16970 (org-refresh-category-properties)
16971 (setq org-todo-keywords-for-agenda
16972 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16973 (setq org-done-keywords-for-agenda
16974 (append org-done-keywords-for-agenda org-done-keywords))
16975 (setq org-todo-keyword-alist-for-agenda
16976 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16977 (setq org-drawers-for-agenda
16978 (append org-drawers-for-agenda org-drawers))
16979 (setq org-tag-alist-for-agenda
16980 (append org-tag-alist-for-agenda org-tag-alist))
16982 (save-excursion
16983 (remove-text-properties (point-min) (point-max) pall)
16984 (when org-agenda-skip-archived-trees
16985 (goto-char (point-min))
16986 (while (re-search-forward rea nil t)
16987 (if (org-at-heading-p t)
16988 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16989 (goto-char (point-min))
16990 (setq re (format org-heading-keyword-regexp-format
16991 org-comment-string))
16992 (while (re-search-forward re nil t)
16993 (add-text-properties
16994 (match-beginning 0) (org-end-of-subtree t) pc)))
16995 (set-buffer-modified-p bmp)))))
16996 (setq org-todo-keywords-for-agenda
16997 (org-uniquify org-todo-keywords-for-agenda))
16998 (setq org-todo-keyword-alist-for-agenda
16999 (org-uniquify org-todo-keyword-alist-for-agenda)
17000 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
17002 ;;;; Embedded LaTeX
17004 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17005 "Keymap for the minor `org-cdlatex-mode'.")
17007 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
17008 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
17009 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
17010 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
17011 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
17013 (defvar org-cdlatex-texmathp-advice-is-done nil
17014 "Flag remembering if we have applied the advice to texmathp already.")
17016 (define-minor-mode org-cdlatex-mode
17017 "Toggle the minor `org-cdlatex-mode'.
17018 This mode supports entering LaTeX environment and math in LaTeX fragments
17019 in Org-mode.
17021 nil " OCDL" nil
17022 (when org-cdlatex-mode
17023 (require 'cdlatex)
17024 (run-hooks 'cdlatex-mode-hook)
17025 (cdlatex-compute-tables))
17026 (unless org-cdlatex-texmathp-advice-is-done
17027 (setq org-cdlatex-texmathp-advice-is-done t)
17028 (defadvice texmathp (around org-math-always-on activate)
17029 "Always return t in org-mode buffers.
17030 This is because we want to insert math symbols without dollars even outside
17031 the LaTeX math segments. If Orgmode thinks that point is actually inside
17032 an embedded LaTeX fragment, let texmathp do its job.
17034 (interactive)
17035 (let (p)
17036 (cond
17037 ((not (derived-mode-p 'org-mode)) ad-do-it)
17038 ((eq this-command 'cdlatex-math-symbol)
17039 (setq ad-return-value t
17040 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
17041 (t
17042 (let ((p (org-inside-LaTeX-fragment-p)))
17043 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
17044 (setq ad-return-value t
17045 texmathp-why '("Org-mode embedded math" . 0))
17046 (if p ad-do-it)))))))))
17048 (defun turn-on-org-cdlatex ()
17049 "Unconditionally turn on `org-cdlatex-mode'."
17050 (org-cdlatex-mode 1))
17052 (defun org-inside-LaTeX-fragment-p ()
17053 "Test if point is inside a LaTeX fragment.
17055 sequence appearing also before point.
17056 Even though the matchers for math are configurable, this function assumes
17058 delimiters are skipped when they have been removed by customization.
17059 The return value is nil, or a cons cell with the delimiter and the
17060 position of this delimiter.
17062 This function does a reasonably good job, but can locally be fooled by
17063 for example currency specifications. For example it will assume being in
17065 fragments that are properly closed, but during editing, we have to live
17066 with the uncertainty caused by missing closing delimiters. This function
17067 looks only before point, not after."
17068 (catch 'exit
17069 (let ((pos (point))
17070 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
17071 (lim (progn
17073 (point)))
17074 dd-on str (start 0) m re)
17075 (goto-char pos)
17076 (when dodollar
17078 re (nth 1 (assoc "$" org-latex-regexps)))
17079 (while (string-match re str start)
17080 (cond
17081 ((= (match-end 0) (length str))
17082 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
17083 ((= (match-end 0) (- (length str) 5))
17084 (throw 'exit nil))
17085 (t (setq start (match-end 0))))))
17086 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17087 (goto-char pos)
17088 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
17089 (and (match-beginning 2) (throw 'exit nil))
17090 ;; count $$
17092 (setq dd-on (not dd-on)))
17093 (goto-char pos)
17094 (if dd-on (cons "$$" m))))))
17096 (defun org-inside-latex-macro-p ()
17097 "Is point inside a LaTeX macro or its arguments?"
17098 (save-match-data
17099 (org-in-regexp
17102 (defun org-try-cdlatex-tab ()
17103 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17104 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17105 - inside a LaTeX fragment, or
17106 - after the first word in a line, where an abbreviation expansion could
17107 insert a LaTeX environment."
17108 (when org-cdlatex-mode
17109 (cond
17110 ;; Before any word on the line: No expansion possible.
17112 ;; Just after first word on the line: Expand it. Make sure it
17113 ;; cannot happen on headlines, though.
17114 ((save-excursion
17115 (skip-chars-backward "a-zA-Z0-9*")
17117 (and (bolp) (not (org-at-heading-p))))
17118 (cdlatex-tab) t)
17119 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
17121 (defun org-cdlatex-underscore-caret (&optional arg)
17122 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17123 Revert to the normal definition outside of these fragments."
17124 (interactive "P")
17125 (if (org-inside-LaTeX-fragment-p)
17126 (call-interactively 'cdlatex-sub-superscript)
17127 (let (org-cdlatex-mode)
17128 (call-interactively (key-binding (vector last-input-event))))))
17130 (defun org-cdlatex-math-modify (&optional arg)
17131 "Execute `cdlatex-math-modify' in LaTeX fragments.
17132 Revert to the normal definition outside of these fragments."
17133 (interactive "P")
17134 (if (org-inside-LaTeX-fragment-p)
17135 (call-interactively 'cdlatex-math-modify)
17136 (let (org-cdlatex-mode)
17137 (call-interactively (key-binding (vector last-input-event))))))
17139 (defvar org-latex-fragment-image-overlays nil
17140 "List of overlays carrying the images of latex fragments.")
17141 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
17143 (defun org-remove-latex-fragment-image-overlays ()
17144 "Remove all overlays with LaTeX fragment images in current buffer."
17145 (mapc 'delete-overlay org-latex-fragment-image-overlays)
17146 (setq org-latex-fragment-image-overlays nil))
17148 (defun org-preview-latex-fragment (&optional subtree)
17149 "Preview the LaTeX fragment at point, or all locally or globally.
17150 If the cursor is in a LaTeX fragment, create the image and overlay
17151 it over the source code. If there is no fragment at point, display
17152 all fragments in the current text, from one headline to the next. With
17153 prefix SUBTREE, display all fragments in the current subtree. With a
17155 the cursor is before the first headline,
17156 display all fragments in the buffer.
17158 (interactive "P")
17159 (unless buffer-file-name
17160 (error "Can't preview LaTeX fragment in a non-file buffer"))
17161 (org-remove-latex-fragment-image-overlays)
17162 (save-excursion
17163 (save-restriction
17164 (let (beg end at msg)
17165 (cond
17166 ((or (equal subtree '(16))
17167 (not (save-excursion
17168 (re-search-backward org-outline-regexp-bol nil t))))
17169 (setq beg (point-min) end (point-max)
17170 msg "Creating images for buffer...%s"))
17171 ((equal subtree '(4))
17172 (org-back-to-heading)
17173 (setq beg (point) end (org-end-of-subtree t)
17174 msg "Creating images for subtree...%s"))
17175 (t
17176 (if (setq at (org-inside-LaTeX-fragment-p))
17177 (goto-char (max (point-min) (- (cdr at) 2)))
17178 (org-back-to-heading))
17179 (setq beg (point) end (progn (outline-next-heading) (point))
17180 msg (if at "Creating image...%s"
17181 "Creating images for entry...%s"))))
17182 (message msg "")
17183 (narrow-to-region beg end)
17184 (goto-char beg)
17185 (org-format-latex
17186 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
17187 (file-name-nondirectory
17188 buffer-file-name)))
17189 default-directory 'overlays msg at 'forbuffer
17190 org-latex-create-formula-image-program)
17191 (message msg "done. Use `C-c C-c' to remove images.")))))
17193 (defvar org-latex-regexps
17195 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17198 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
17202 "Regular expressions for matching embedded LaTeX.")
17204 (defvar org-export-have-math nil) ;; dynamic scoping
17205 (defun org-format-latex (prefix &optional dir overlays msg at
17206 forbuffer processing-type)
17207 "Replace LaTeX fragments with links to an image, and produce images.
17208 Some of the options can be changed using the variable
17209 `org-format-latex-options'."
17210 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
17211 (let* ((prefixnodir (file-name-nondirectory prefix))
17212 (absprefix (expand-file-name prefix dir))
17213 (todir (file-name-directory absprefix))
17214 (opt org-format-latex-options)
17215 (matchers (plist-get opt :matchers))
17216 (re-list org-latex-regexps)
17217 (org-format-latex-header-extra
17218 (plist-get (org-infile-export-plist) :latex-header-extra))
17219 (cnt 0) txt hash link beg end re e checkdir
17220 executables-checked string
17221 m n block-type block linkfile movefile ov)
17222 ;; Check the different regular expressions
17223 (while (setq e (pop re-list))
17224 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
17226 (when (member m matchers)
17227 (goto-char (point-min))
17228 (while (re-search-forward re nil t)
17229 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
17230 (not (get-text-property (match-beginning n)
17231 'org-protected))
17232 (or (not overlays)
17233 (not (eq (get-char-property (match-beginning n)
17234 'org-overlay-type)
17235 'org-latex-overlay))))
17236 (setq org-export-have-math t)
17237 (cond
17238 ((eq processing-type 'verbatim)
17239 ;; Leave the text verbatim, just protect it
17240 (add-text-properties (match-beginning n) (match-end n)
17241 '(org-protected t)))
17242 ((eq processing-type 'mathjax)
17243 ;; Prepare for MathJax processing
17244 (setq string (match-string n))
17245 (if (member m '("$" "$1"))
17246 (save-excursion
17247 (delete-region (match-beginning n) (match-end n))
17248 (goto-char (match-beginning n))
17251 '(org-protected t))))
17252 (add-text-properties (match-beginning n) (match-end n)
17253 '(org-protected t))))
17254 ((or (eq processing-type 'dvipng)
17255 (eq processing-type 'imagemagick))
17256 ;; Process to an image
17257 (setq txt (match-string n)
17258 beg (match-beginning n) end (match-end n)
17259 cnt (1+ cnt))
17260 (let (print-length print-level) ; make sure full list is printed
17261 (setq hash (sha1 (prin1-to-string
17262 (list org-format-latex-header
17263 org-format-latex-header-extra
17264 org-export-latex-default-packages-alist
17265 org-export-latex-packages-alist
17266 org-format-latex-options
17267 forbuffer txt)))
17268 linkfile (format "%s_%s.png" prefix hash)
17269 movefile (format "%s_%s.png" absprefix hash)))
17270 (setq link (concat block "[[file:" linkfile "]]" block))
17271 (if msg (message msg cnt))
17272 (goto-char beg)
17273 (unless checkdir ; make sure the directory exists
17274 (setq checkdir t)
17275 (or (file-directory-p todir) (make-directory todir t)))
17276 (cond
17277 ((eq processing-type 'dvipng)
17278 (unless executables-checked
17279 (org-check-external-command
17280 "latex" "needed to convert LaTeX fragments to images")
17281 (org-check-external-command
17282 "dvipng" "needed to convert LaTeX fragments to images")
17283 (setq executables-checked t))
17284 (unless (file-exists-p movefile)
17285 (org-create-formula-image-with-dvipng
17286 txt movefile opt forbuffer)))
17287 ((eq processing-type 'imagemagick)
17288 (unless executables-checked
17289 (org-check-external-command
17290 "convert" "you need to install imagemagick")
17291 (setq executables-checked t))
17292 (unless (file-exists-p movefile)
17293 (org-create-formula-image-with-imagemagick
17294 txt movefile opt forbuffer))))
17295 (if overlays
17296 (progn
17297 (mapc (lambda (o)
17298 (if (eq (overlay-get o 'org-overlay-type)
17299 'org-latex-overlay)
17300 (delete-overlay o)))
17301 (overlays-in beg end))
17302 (setq ov (make-overlay beg end))
17303 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17304 (if (featurep 'xemacs)
17305 (progn
17306 (overlay-put ov 'invisible t)
17307 (overlay-put
17308 ov 'end-glyph
17309 (make-glyph (vector 'png :file movefile))))
17310 (overlay-put
17311 ov 'display
17312 (list 'image :type 'png :file movefile :ascent 'center)))
17313 (push ov org-latex-fragment-image-overlays)
17314 (goto-char end))
17315 (delete-region beg end)
17316 (insert (org-add-props link
17317 (list 'org-latex-src
17318 (replace-regexp-in-string
17320 'org-latex-src-embed-type
17321 (if block-type 'paragraph 'character))))))
17322 ((eq processing-type 'mathml)
17323 ;; Process to MathML
17324 (unless executables-checked
17325 (unless (save-match-data (org-format-latex-mathml-available-p))
17326 (error "LaTeX to MathML converter not configured"))
17327 (setq executables-checked t))
17328 (setq txt (match-string n)
17329 beg (match-beginning n) end (match-end n)
17330 cnt (1+ cnt))
17331 (if msg (message msg cnt))
17332 (goto-char beg)
17333 (delete-region beg end)
17334 (insert (org-format-latex-as-mathml
17335 txt block-type prefix dir)))
17336 (t
17337 (error "Unknown conversion type %s for latex fragments"
17338 processing-type)))))))))
17340 (defun org-create-math-formula (latex-frag &optional mathml-file)
17341 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17342 Use `org-latex-to-mathml-convert-command'. If the conversion is
17344 elements otherwise return nil. When MATHML-FILE is specified,
17345 write the results in to that file. When invoked as an
17346 interactive command, prompt for LATEX-FRAG, with initial value
17347 set to the current active region and echo the results for user
17348 inspection."
17349 (interactive (list (let ((frag (when (org-region-active-p)
17350 (buffer-substring-no-properties
17351 (region-beginning) (region-end)))))
17352 (read-string "LaTeX Fragment: " frag nil frag))))
17353 (unless latex-frag (error "Invalid latex-frag"))
17354 (let* ((tmp-in-file (file-relative-name
17355 (make-temp-name (expand-file-name "ltxmathml-in"))))
17356 (ignore (write-region latex-frag nil tmp-in-file))
17357 (tmp-out-file (file-relative-name
17358 (make-temp-name (expand-file-name "ltxmathml-out"))))
17359 (cmd (format-spec
17360 org-latex-to-mathml-convert-command
17361 `((?j . ,(shell-quote-argument
17362 (expand-file-name org-latex-to-mathml-jar-file)))
17363 (?I . ,(shell-quote-argument tmp-in-file))
17364 (?o . ,(shell-quote-argument tmp-out-file)))))
17365 mathml shell-command-output)
17366 (when (org-called-interactively-p 'any)
17367 (unless (org-format-latex-mathml-available-p)
17368 (error "LaTeX to MathML converter not configured")))
17369 (message "Running %s" cmd)
17370 (setq shell-command-output (shell-command-to-string cmd))
17371 (setq mathml
17372 (when (file-readable-p tmp-out-file)
17373 (with-current-buffer (find-file-noselect tmp-out-file t)
17374 (goto-char (point-min))
17375 (when (re-search-forward
17376 (concat
17377 (regexp-quote
17380 (regexp-quote "</math>")) nil t)
17381 (prog1 (match-string 0) (kill-buffer))))))
17382 (cond
17383 (mathml
17384 (setq mathml
17386 (when mathml-file
17387 (write-region mathml nil mathml-file))
17388 (when (org-called-interactively-p 'any)
17389 (message mathml)))
17390 ((message "LaTeX to MathML conversion failed")
17391 (message shell-command-output)))
17392 (delete-file tmp-in-file)
17393 (when (file-exists-p tmp-out-file)
17394 (delete-file tmp-out-file))
17395 mathml))
17397 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17398 prefix &optional dir)
17399 "Use `org-create-math-formula' but check local cache first."
17400 (let* ((absprefix (expand-file-name prefix dir))
17401 (print-length nil) (print-level nil)
17402 (formula-id (concat
17403 "formula-"
17404 (sha1
17405 (prin1-to-string
17406 (list latex-frag
17407 org-latex-to-mathml-convert-command)))))
17408 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17409 (formula-cache-dir (file-name-directory formula-cache)))
17411 (unless (file-directory-p formula-cache-dir)
17412 (make-directory formula-cache-dir t))
17414 (unless (file-exists-p formula-cache)
17415 (org-create-math-formula latex-frag formula-cache))
17417 (if (file-exists-p formula-cache)
17418 ;; Successful conversion. Return the link to MathML file.
17419 (org-add-props
17420 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17422 'org-latex-src-embed-type (if latex-frag-type
17423 'paragraph 'character)))
17424 ;; Failed conversion. Return the LaTeX fragment verbatim
17425 (add-text-properties
17426 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17427 latex-frag)))
17429 ;; This function borrows from Ganesh Swami's latex2png.el
17430 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
17431 "This calls dvipng."
17432 (require 'org-latex)
17433 (let* ((tmpdir (if (featurep 'xemacs)
17434 (temp-directory)
17435 temporary-file-directory))
17436 (texfilebase (make-temp-name
17437 (expand-file-name "orgtex" tmpdir)))
17438 (texfile (concat texfilebase ".tex"))
17439 (dvifile (concat texfilebase ".dvi"))
17440 (pngfile (concat texfilebase ".png"))
17441 (fnh (if (featurep 'xemacs)
17442 (font-height (face-font 'default))
17443 (face-attribute 'default :height nil)))
17444 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17445 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17446 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17447 "Black"))
17448 (bg (or (plist-get options (if buffer :background :html-background))
17449 "Transparent")))
17450 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17451 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17452 (with-temp-file texfile
17453 (insert (org-splice-latex-header
17454 org-format-latex-header
17455 org-export-latex-default-packages-alist
17456 org-export-latex-packages-alist t
17457 org-format-latex-header-extra))
17459 (require 'org-latex)
17460 (org-export-latex-fix-inputenc))
17461 (let ((dir default-directory))
17462 (condition-case nil
17463 (progn
17464 (cd tmpdir)
17465 (call-process "latex" nil nil nil texfile))
17466 (error nil))
17467 (cd dir))
17468 (if (not (file-exists-p dvifile))
17469 (progn (message "Failed to create dvi file from %s" texfile) nil)
17470 (condition-case nil
17471 (if (featurep 'xemacs)
17472 (call-process "dvipng" nil nil nil
17473 "-fg" fg "-bg" bg
17474 "-T" "tight"
17475 "-o" pngfile
17476 dvifile)
17477 (call-process "dvipng" nil nil nil
17478 "-fg" fg "-bg" bg
17479 "-D" dpi
17480 ;;"-x" scale "-y" scale
17481 "-T" "tight"
17482 "-o" pngfile
17483 dvifile))
17484 (error nil))
17485 (if (not (file-exists-p pngfile))
17486 (if org-format-latex-signal-error
17487 (error "Failed to create png file from %s" texfile)
17488 (message "Failed to create png file from %s" texfile)
17489 nil)
17490 ;; Use the requested file name and clean up
17491 (copy-file pngfile tofile 'replace)
17492 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
17493 (if (file-exists-p (concat texfilebase e))
17494 (delete-file (concat texfilebase e))))
17495 pngfile))))
17497 (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
17498 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
17499 "This calls convert, which is included into imagemagick."
17500 (require 'org-latex)
17501 (let* ((tmpdir (if (featurep 'xemacs)
17502 (temp-directory)
17503 temporary-file-directory))
17504 (texfilebase (make-temp-name
17505 (expand-file-name "orgtex" tmpdir)))
17506 (texfile (concat texfilebase ".tex"))
17507 (pdffile (concat texfilebase ".pdf"))
17508 (pngfile (concat texfilebase ".png"))
17509 (fnh (if (featurep 'xemacs)
17510 (font-height (face-font 'default))
17511 (face-attribute 'default :height nil)))
17512 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17513 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17514 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17515 "black"))
17516 (bg (or (plist-get options (if buffer :background :html-background))
17517 "white")))
17518 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
17519 (setq fg (org-latex-color-format fg)))
17520 (if (eq bg 'default) (setq bg (org-latex-color :background))
17521 (setq bg (org-latex-color-format
17522 (if (string= bg "Transparent")(setq bg "white")))))
17523 (with-temp-file texfile
17524 (insert (org-splice-latex-header
17525 org-format-latex-header
17526 org-export-latex-default-packages-alist
17527 org-export-latex-packages-alist t
17528 org-format-latex-header-extra))
17534 string
17537 (require 'org-latex)
17538 (org-export-latex-fix-inputenc))
17539 (let ((dir default-directory) cmd cmds latex-frags-cmds)
17540 (condition-case nil
17541 (progn
17542 (cd tmpdir)
17543 (setq cmds org-latex-to-pdf-process)
17544 (while cmds
17545 (setq latex-frags-cmds (pop cmds))
17546 (if (listp latex-frags-cmds)
17547 (setq cmds nil)
17548 (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
17549 (while latex-frags-cmds
17550 (setq cmd (pop latex-frags-cmds))
17551 (while (string-match "%b" cmd)
17552 (setq cmd (replace-match
17553 (save-match-data
17554 (shell-quote-argument texfile))
17555 t t cmd)))
17556 (while (string-match "%f" cmd)
17557 (setq cmd (replace-match
17558 (save-match-data
17559 (shell-quote-argument (file-name-nondirectory texfile)))
17560 t t cmd)))
17561 (while (string-match "%o" cmd)
17562 (setq cmd (replace-match
17563 (save-match-data
17564 (shell-quote-argument (file-name-directory texfile)))
17565 t t cmd)))
17566 (setq cmd (split-string cmd))
17567 (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
17568 (error nil))
17569 (cd dir))
17570 (if (not (file-exists-p pdffile))
17571 (progn (message "Failed to create pdf file from %s" texfile) nil)
17572 (condition-case nil
17573 (if (featurep 'xemacs)
17574 (call-process "convert" nil nil nil
17575 "-density" "96"
17576 "-trim"
17577 "-antialias"
17578 pdffile
17579 "-quality" "100"
17580 ;; "-sharpen" "0x1.0"
17581 pngfile)
17582 (call-process "convert" nil nil nil
17583 "-density" dpi
17584 "-trim"
17585 "-antialias"
17586 pdffile
17587 "-quality" "100"
17588 ; "-sharpen" "0x1.0"
17589 pngfile))
17590 (error nil))
17591 (if (not (file-exists-p pngfile))
17592 (if org-format-latex-signal-error
17593 (error "Failed to create png file from %s" texfile)
17594 (message "Failed to create png file from %s" texfile)
17595 nil)
17596 ;; Use the requested file name and clean up
17597 (copy-file pngfile tofile 'replace)
17598 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
17599 (if (file-exists-p (concat texfilebase e))
17600 (delete-file (concat texfilebase e))))
17601 pngfile))))
17603 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17604 "Fill a LaTeX header template TPL.
17605 In the template, the following place holders will be recognized:
17608 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17610 [NO-PACKAGES] do not include PKG
17611 [EXTRA] the string EXTRA
17612 [NO-EXTRA] do not include EXTRA
17614 For backward compatibility, if both the positive and the negative place
17616 assumed to be present at the end of the template.
17617 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17618 EXTRA is a string.
17619 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17620 (let (rpl (end ""))
17622 (setq rpl (if (or (match-end 1) (not def-pkg))
17623 "" (org-latex-packages-to-string def-pkg snippets-p t))
17624 tpl (replace-match rpl t t tpl))
17625 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17628 (setq rpl (if (or (match-end 1) (not pkg))
17629 "" (org-latex-packages-to-string pkg snippets-p t))
17630 tpl (replace-match rpl t t tpl))
17631 (if pkg (setq end
17633 (org-latex-packages-to-string pkg snippets-p)))))
17636 (setq rpl (if (or (match-end 1) (not extra))
17638 tpl (replace-match rpl t t tpl))
17644 tpl)))
17646 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17648 (setq pkg (mapconcat (lambda(p)
17649 (cond
17650 ((stringp p) p)
17651 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17652 (format "%% Package %s omitted" (cadr p)))
17653 ((equal "" (car p))
17655 (t
17657 (car p) (cadr p)))))
17658 pkg
17662 (defun org-dvipng-color (attr)
17663 "Return a RGB color specification for dvipng."
17664 (apply 'format "rgb %s %s %s"
17665 (mapcar 'org-normalize-color
17666 (if (featurep 'xemacs)
17667 (color-rgb-components
17668 (face-property 'default
17669 (cond ((eq attr :foreground) 'foreground)
17670 ((eq attr :background) 'background))))
17671 (color-values (face-attribute 'default attr nil))))))
17673 (defun org-latex-color (attr)
17674 "Return a RGB color for the LaTeX color package."
17675 (apply 'format "%s,%s,%s"
17676 (mapcar 'org-normalize-color
17677 (if (featurep 'xemacs)
17678 (color-rgb-components
17679 (face-property 'default
17680 (cond ((eq attr :foreground) 'foreground)
17681 ((eq attr :background) 'background))))
17682 (color-values (face-attribute 'default attr nil))))))
17684 (defun org-latex-color-format (color-name)
17685 "Convert COLOR-NAME to a RGB color value."
17686 (apply 'format "%s,%s,%s"
17687 (mapcar 'org-normalize-color
17688 (color-values color-name))))
17690 (defun org-normalize-color (value)
17691 "Return string to be used as color value for an RGB component."
17692 (format "%g" (/ value 65535.0)))
17694 ;; Image display
17697 (defvar org-inline-image-overlays nil)
17698 (make-variable-buffer-local 'org-inline-image-overlays)
17700 (defun org-toggle-inline-images (&optional include-linked)
17701 "Toggle the display of inline images.
17702 INCLUDE-LINKED is passed to `org-display-inline-images'."
17703 (interactive "P")
17704 (if org-inline-image-overlays
17705 (progn
17706 (org-remove-inline-images)
17707 (message "Inline image display turned off"))
17708 (org-display-inline-images include-linked)
17709 (if org-inline-image-overlays
17710 (message "%d images displayed inline"
17711 (length org-inline-image-overlays))
17712 (message "No images to display inline"))))
17714 (defun org-redisplay-inline-images ()
17715 "Refresh the display of inline images."
17716 (interactive)
17717 (if (not org-inline-image-overlays)
17718 (org-toggle-inline-images)
17719 (org-toggle-inline-images)
17720 (org-toggle-inline-images)))
17722 (defun org-display-inline-images (&optional include-linked refresh beg end)
17723 "Display inline images.
17724 Normally only links without a description part are inlined, because this
17725 is how it will work for export. When INCLUDE-LINKED is set, also links
17726 with a description part will be inlined. This can be nice for a quick
17727 look at those images, but it does not reflect what exported files will look
17728 like.
17729 When REFRESH is set, refresh existing images between BEG and END.
17730 This will create new image displays only if necessary.
17731 BEG and END default to the buffer boundaries."
17732 (interactive "P")
17733 (unless refresh
17734 (org-remove-inline-images)
17735 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17736 (save-excursion
17737 (save-restriction
17738 (widen)
17739 (setq beg (or beg (point-min)) end (or end (point-max)))
17740 (goto-char beg)
17742 (substring (org-image-file-name-regexp) 0 -2)
17744 old file ov img)
17745 (while (re-search-forward re end t)
17746 (setq old (get-char-property-and-overlay (match-beginning 1)
17747 'org-image-overlay))
17748 (setq file (expand-file-name
17749 (concat (or (match-string 3) "") (match-string 4))))
17750 (when (file-exists-p file)
17751 (if (and (car-safe old) refresh)
17752 (image-refresh (overlay-get (cdr old) 'display))
17753 (setq img (save-match-data (create-image file)))
17754 (when img
17755 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17756 (overlay-put ov 'display img)
17757 (overlay-put ov 'face 'default)
17758 (overlay-put ov 'org-image-overlay t)
17759 (overlay-put ov 'modification-hooks
17760 (list 'org-display-inline-remove-overlay))
17761 (push ov org-inline-image-overlays)))))))))
17763 (define-obsolete-function-alias
17764 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
17766 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
17767 "Remove inline-display overlay if a corresponding region is modified."
17768 (let ((inhibit-modification-hooks t))
17769 (when (and ov after)
17770 (delete ov org-inline-image-overlays)
17771 (delete-overlay ov))))
17773 (defun org-remove-inline-images ()
17774 "Remove inline display of images."
17775 (interactive)
17776 (mapc 'delete-overlay org-inline-image-overlays)
17777 (setq org-inline-image-overlays nil))
17779 ;;;; Key bindings
17781 ;; Outline functions from `outline-mode-prefix-map'
17782 ;; that can be remapped in Org:
17783 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17784 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17785 (define-key org-mode-map [remap outline-forward-same-level]
17786 'org-forward-heading-same-level)
17787 (define-key org-mode-map [remap outline-backward-same-level]
17788 'org-backward-heading-same-level)
17789 (define-key org-mode-map [remap show-branches]
17790 'org-kill-note-or-show-branches)
17791 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17792 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17793 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17795 ;; Outline functions from `outline-mode-prefix-map' that can not
17796 ;; be remapped in Org:
17797 ;;
17798 ;; - the column "key binding" shows whether the Outline function is still
17799 ;; available in Org mode on the same key that it has been bound to in
17800 ;; Outline mode:
17801 ;; - "overridden": key used for a different functionality in Org mode
17802 ;; - else: key still bound to the same Outline function in Org mode
17803 ;;
17804 ;; | Outline function | key binding | Org replacement |
17805 ;; |------------------------------------+-------------+-----------------------|
17806 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17807 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17808 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17809 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
17810 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17811 ;; | `show-entry' | overridden | no replacement |
17812 ;; | `show-children' | `C-c C-i' | visibility cycling |
17813 ;; | `show-branches' | `C-c C-k' | still same function |
17814 ;; | `show-subtree' | overridden | visibility cycling |
17815 ;; | `show-all' | overridden | no replacement |
17816 ;; | `hide-subtree' | overridden | visibility cycling |
17817 ;; | `hide-body' | overridden | no replacement |
17818 ;; | `hide-entry' | overridden | visibility cycling |
17819 ;; | `hide-leaves' | overridden | no replacement |
17820 ;; | `hide-sublevels' | overridden | no replacement |
17821 ;; | `hide-other' | overridden | no replacement |
17823 ;; Make `C-c C-x' a prefix key
17824 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17826 ;; TAB key with modifiers
17827 (org-defkey org-mode-map "\C-i" 'org-cycle)
17828 (org-defkey org-mode-map [(tab)] 'org-cycle)
17829 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17831 ;; The following line is necessary under Suse GNU/Linux
17832 (unless (featurep 'xemacs)
17833 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17834 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17835 (define-key org-mode-map [backtab] 'org-shifttab)
17837 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17838 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17839 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17841 ;; Cursor keys with modifiers
17842 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17843 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17844 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17845 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17847 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17848 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17849 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17850 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17852 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17853 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17854 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17855 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17857 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17858 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17859 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17860 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17862 ;; Babel keys
17863 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17864 (mapc (lambda (pair)
17865 (define-key org-babel-map (car pair) (cdr pair)))
17866 org-babel-key-bindings)
17868 ;;; Extra keys for tty access.
17869 ;; We only set them when really needed because otherwise the
17870 ;; menus don't show the simple keys
17872 (when (or org-use-extra-keys
17873 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17874 (not window-system))
17875 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17876 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17877 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17878 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17879 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17880 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17881 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17882 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17883 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17884 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17885 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17886 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17887 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17888 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17889 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17890 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17891 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17892 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17893 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17894 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17895 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17896 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17897 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17898 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17899 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17900 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17901 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17902 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17904 ;; All the other keys
17906 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17907 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17908 (if (boundp 'narrow-map)
17909 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17910 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17911 (if (boundp 'narrow-map)
17912 (org-defkey narrow-map "b" 'org-narrow-to-block)
17913 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17914 (if (boundp 'narrow-map)
17915 (org-defkey narrow-map "e" 'org-narrow-to-element)
17916 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
17917 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
17918 (org-defkey org-mode-map "\M-}" 'org-forward-element)
17919 (org-defkey org-mode-map "\M-{" 'org-backward-element)
17920 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
17921 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
17922 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
17923 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
17924 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17925 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17926 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17927 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17928 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17929 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17930 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17931 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17932 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17933 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17934 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17935 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17936 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17937 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17938 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17940 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17941 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17942 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17943 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17944 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17945 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17946 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17947 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17948 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17949 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
17950 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17951 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17952 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17953 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17954 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17955 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17956 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17957 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17958 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17959 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17960 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17962 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17963 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17964 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17965 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17966 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17967 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17968 (org-defkey org-mode-map "\C-c^" 'org-sort)
17969 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17970 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17971 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17972 (org-defkey org-mode-map "\C-m" 'org-return)
17973 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17974 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17975 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17976 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17977 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17978 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17979 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17980 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17981 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17982 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17983 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17984 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17985 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17986 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17987 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17988 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17989 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17990 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17991 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17992 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17993 (org-defkey org-mode-map "\M-h" 'org-mark-element)
17994 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17995 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17997 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17998 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17999 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
18001 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
18002 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
18003 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
18004 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
18005 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
18006 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
18007 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
18008 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
18009 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
18010 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
18011 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
18012 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
18013 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
18015 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
18016 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
18017 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
18018 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
18019 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
18020 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
18021 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
18022 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
18024 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
18025 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
18026 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
18027 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
18028 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
18030 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
18032 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
18034 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
18035 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
18037 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
18040 (when (featurep 'xemacs)
18041 (org-defkey org-mode-map 'button3 'popup-mode-menu))
18044 (defconst org-speed-commands-default
18045 '(
18046 ("Outline Navigation")
18047 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
18048 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
18049 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
18050 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
18051 ("u" . (org-speed-move-safe 'outline-up-heading))
18052 ("j" . org-goto)
18053 ("g" . (org-refile t))
18054 ("Outline Visibility")
18055 ("c" . org-cycle)
18056 ("C" . org-shifttab)
18057 (" " . org-display-outline-path)
18058 (":" . org-columns)
18059 ("Outline Structure Editing")
18060 ("U" . org-shiftmetaup)
18061 ("D" . org-shiftmetadown)
18062 ("r" . org-metaright)
18063 ("l" . org-metaleft)
18064 ("R" . org-shiftmetaright)
18065 ("L" . org-shiftmetaleft)
18066 ("i" . (progn (forward-char 1) (call-interactively
18067 'org-insert-heading-respect-content)))
18068 ("^" . org-sort)
18069 ("w" . org-refile)
18070 ("a" . org-archive-subtree-default-with-confirmation)
18071 ("." . org-mark-subtree)
18072 ("#" . org-toggle-comment)
18073 ("Clock Commands")
18074 ("I" . org-clock-in)
18075 ("O" . org-clock-out)
18076 ("Meta Data Editing")
18077 ("t" . org-todo)
18078 ("," . (org-priority))
18079 ("0" . (org-priority ?\ ))
18080 ("1" . (org-priority ?A))
18081 ("2" . (org-priority ?B))
18082 ("3" . (org-priority ?C))
18083 (";" . org-set-tags-command)
18084 ("e" . org-set-effort)
18085 ("E" . org-inc-effort)
18086 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
18087 (org-entry-put (point) "APPT_WARNTIME" m)))
18088 ("Agenda Views etc")
18089 ("v" . org-agenda)
18090 ("/" . org-sparse-tree)
18091 ("Misc")
18092 ("o" . org-open-at-point)
18093 ("?" . org-speed-command-help)
18094 ("<" . (org-agenda-set-restriction-lock 'subtree))
18095 (">" . (org-agenda-remove-restriction-lock))
18096 )
18097 "The default speed commands.")
18099 (defun org-print-speed-command (e)
18100 (if (> (length (car e)) 1)
18101 (progn
18103 (princ (car e))
18105 (princ (make-string (length (car e)) ?-))
18107 (princ (car e))
18108 (princ " ")
18109 (if (symbolp (cdr e))
18110 (princ (symbol-name (cdr e)))
18111 (prin1 (cdr e)))
18114 (defun org-speed-command-help ()
18115 "Show the available speed commands."
18116 (interactive)
18117 (if (not org-use-speed-commands)
18118 (error "Speed commands are not activated, customize `org-use-speed-commands'")
18119 (with-output-to-temp-buffer "*Help*"
18121 (mapc 'org-print-speed-command org-speed-commands-user)
18124 (mapc 'org-print-speed-command org-speed-commands-default))
18125 (with-current-buffer "*Help*"
18126 (setq truncate-lines t))))
18128 (defun org-speed-move-safe (cmd)
18129 "Execute CMD, but make sure that the cursor always ends up in a headline.
18130 If not, return to the original position and throw an error."
18131 (interactive)
18132 (let ((pos (point)))
18133 (call-interactively cmd)
18134 (unless (and (bolp) (org-at-heading-p))
18135 (goto-char pos)
18136 (error "Boundary reached while executing %s" cmd))))
18138 (defvar org-self-insert-command-undo-counter 0)
18140 (defvar org-table-auto-blank-field) ; defined in org-table.el
18141 (defvar org-speed-command nil)
18143 (define-obsolete-function-alias
18144 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
18146 (defun org-speed-command-activate (keys)
18147 "Hook for activating single-letter speed commands.
18148 `org-speed-commands-default' specifies a minimal command set.
18149 Use `org-speed-commands-user' for further customization."
18150 (when (or (and (bolp) (looking-at org-outline-regexp))
18151 (and (functionp org-use-speed-commands)
18152 (funcall org-use-speed-commands)))
18153 (cdr (assoc keys (append org-speed-commands-user
18154 org-speed-commands-default)))))
18156 (define-obsolete-function-alias
18157 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
18159 (defun org-babel-speed-command-activate (keys)
18160 "Hook for activating single-letter code block commands."
18161 (when (and (bolp) (looking-at org-babel-src-block-regexp))
18162 (cdr (assoc keys org-babel-key-bindings))))
18164 (defcustom org-speed-command-hook
18165 '(org-speed-command-default-hook org-babel-speed-command-hook)
18166 "Hook for activating speed commands at strategic locations.
18167 Hook functions are called in sequence until a valid handler is
18168 found.
18170 Each hook takes a single argument, a user-pressed command key
18171 which is also a `self-insert-command' from the global map.
18173 Within the hook, examine the cursor position and the command key
18174 and return nil or a valid handler as appropriate. Handler could
18175 be one of an interactive command, a function, or a form.
18177 Set `org-use-speed-commands' to non-nil value to enable this
18178 hook. The default setting is `org-speed-command-activate'."
18179 :group 'org-structure
18180 :version "24.1"
18181 :type 'hook)
18183 (defun org-self-insert-command (N)
18184 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18185 If the cursor is in a table looking at whitespace, the whitespace is
18186 overwritten, and the table is not marked as requiring realignment."
18187 (interactive "p")
18188 (org-check-before-invisible-edit 'insert)
18189 (cond
18190 ((and org-use-speed-commands
18191 (setq org-speed-command
18192 (run-hook-with-args-until-success
18193 'org-speed-command-hook (this-command-keys))))
18194 (cond
18195 ((commandp org-speed-command)
18196 (setq this-command org-speed-command)
18197 (call-interactively org-speed-command))
18198 ((functionp org-speed-command)
18199 (funcall org-speed-command))
18200 ((and org-speed-command (listp org-speed-command))
18201 (eval org-speed-command))
18202 (t (let (org-use-speed-commands)
18203 (call-interactively 'org-self-insert-command)))))
18204 ((and
18205 (org-table-p)
18206 (progn
18207 ;; check if we blank the field, and if that triggers align
18208 (and (featurep 'org-table) org-table-auto-blank-field
18209 (member last-command
18210 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
18212 ;; got extra space, this field does not determine column width
18213 (let (org-table-may-need-update) (org-table-blank-field))
18214 ;; no extra space, this field may determine column width
18215 (org-table-blank-field)))
18216 t)
18217 (eq N 1)
18219 (let (org-table-may-need-update)
18220 (goto-char (1- (match-end 0)))
18221 (backward-delete-char 1)
18222 (goto-char (match-beginning 0))
18223 (self-insert-command N)))
18224 (t
18225 (setq org-table-may-need-update t)
18226 (self-insert-command N)
18227 (org-fix-tags-on-the-fly)
18228 (if org-self-insert-cluster-for-undo
18229 (if (not (eq last-command 'org-self-insert-command))
18230 (setq org-self-insert-command-undo-counter 1)
18231 (if (>= org-self-insert-command-undo-counter 20)
18232 (setq org-self-insert-command-undo-counter 1)
18233 (and (> org-self-insert-command-undo-counter 0)
18234 buffer-undo-list (listp buffer-undo-list)
18235 (not (cadr buffer-undo-list)) ; remove nil entry
18236 (setcdr buffer-undo-list (cddr buffer-undo-list)))
18237 (setq org-self-insert-command-undo-counter
18238 (1+ org-self-insert-command-undo-counter))))))))
18240 (defun org-check-before-invisible-edit (kind)
18241 "Check is editing if kind KIND would be dangerous with invisible text around.
18242 The detailed reaction depends on the user option `org-catch-invisible-edits'."
18243 ;; First, try to get out of here as quickly as possible, to reduce overhead
18244 (if (and org-catch-invisible-edits
18245 (or (not (boundp 'visible-mode)) (not visible-mode))
18246 (or (get-char-property (point) 'invisible)
18247 (get-char-property (max (point-min) (1- (point))) 'invisible)))
18248 ;; OK, we need to take a closer look
18249 (let* ((invisible-at-point (get-char-property (point) 'invisible))
18250 (invisible-before-point (if (bobp) nil (get-char-property
18251 (1- (point)) 'invisible)))
18252 (border-and-ok-direction
18253 (or
18254 ;; Check if we are acting predictably before invisible text
18255 (and invisible-at-point (not invisible-before-point)
18256 (memq kind '(insert delete-backward)))
18257 ;; Check if we are acting predictably after invisible text
18258 ;; This works not well, and I have turned it off. It seems
18259 ;; better to always show and stop after invisible text.
18260 ;; (and (not invisible-at-point) invisible-before-point
18261 ;; (memq kind '(insert delete)))
18262 )))
18263 (when (or (memq invisible-at-point '(outline org-hide-block t))
18264 (memq invisible-before-point '(outline org-hide-block t)))
18265 (if (eq org-catch-invisible-edits 'error)
18266 (error "Editing in invisible areas is prohibited - make visible first"))
18267 (if (and org-custom-properties-overlays
18268 (y-or-n-p "Display invisible properties in this buffer? "))
18269 (org-toggle-custom-properties-visibility)
18270 ;; Make the area visible
18271 (save-excursion
18272 (if invisible-before-point
18273 (goto-char (previous-single-char-property-change
18274 (point) 'invisible)))
18275 (org-cycle))
18276 (cond
18277 ((eq org-catch-invisible-edits 'show)
18278 ;; That's it, we do the edit after showing
18279 (message
18280 "Unfolding invisible region around point before editing")
18281 (sit-for 1))
18282 ((and (eq org-catch-invisible-edits 'smart)
18283 border-and-ok-direction)
18284 (message "Unfolding invisible region around point before editing"))
18285 (t
18286 ;; Don't do the edit, make the user repeat it in full visibility
18287 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
18289 (defun org-fix-tags-on-the-fly ()
18290 (when (and (equal (char-after (point-at-bol)) ?*)
18291 (org-at-heading-p))
18292 (org-align-tags-here org-tags-column)))
18294 (defun org-delete-backward-char (N)
18295 "Like `delete-backward-char', insert whitespace at field end in tables.
18296 When deleting backwards, in tables this function will insert whitespace in
18298 still be marked for re-alignment if the field did fill the entire column,
18299 because, in this case the deletion might narrow the column."
18300 (interactive "p")
18301 (save-match-data
18302 (org-check-before-invisible-edit 'delete-backward)
18303 (if (and (org-table-p)
18304 (eq N 1)
18305 (string-match "|" (buffer-substring (point-at-bol) (point)))
18306 (looking-at ".*?|"))
18307 (let ((pos (point))
18309 (c org-table-may-need-update))
18310 (backward-delete-char N)
18311 (if (not overwrite-mode)
18312 (progn
18313 (skip-chars-forward "^|")
18314 (insert " ")
18315 (goto-char (1- pos))))
18316 ;; noalign: if there were two spaces at the end, this field
18317 ;; does not determine the width of the column.
18318 (if noalign (setq org-table-may-need-update c)))
18319 (backward-delete-char N)
18320 (org-fix-tags-on-the-fly))))
18322 (defun org-delete-char (N)
18323 "Like `delete-char', but insert whitespace at field end in tables.
18324 When deleting characters, in tables this function will insert whitespace in
18326 still be marked for re-alignment if the field did fill the entire column,
18327 because, in this case the deletion might narrow the column."
18328 (interactive "p")
18329 (save-match-data
18330 (org-check-before-invisible-edit 'delete)
18331 (if (and (org-table-p)
18332 (not (bolp))
18333 (not (= (char-after) ?|))
18334 (eq N 1))
18335 (if (looking-at ".*?|")
18336 (let ((pos (point))
18338 (c org-table-may-need-update))
18339 (replace-match (concat
18340 (substring (match-string 0) 1 -1)
18341 " |"))
18342 (goto-char pos)
18343 ;; noalign: if there were two spaces at the end, this field
18344 ;; does not determine the width of the column.
18345 (if noalign (setq org-table-may-need-update c)))
18346 (delete-char N))
18347 (delete-char N)
18348 (org-fix-tags-on-the-fly))))
18350 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
18351 (put 'org-self-insert-command 'delete-selection t)
18352 (put 'orgtbl-self-insert-command 'delete-selection t)
18353 (put 'org-delete-char 'delete-selection 'supersede)
18354 (put 'org-delete-backward-char 'delete-selection 'supersede)
18355 (put 'org-yank 'delete-selection 'yank)
18357 ;; Make `flyspell-mode' delay after some commands
18358 (put 'org-self-insert-command 'flyspell-delayed t)
18359 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
18360 (put 'org-delete-char 'flyspell-delayed t)
18361 (put 'org-delete-backward-char 'flyspell-delayed t)
18363 ;; Make pabbrev-mode expand after org-mode commands
18364 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
18365 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
18367 ;; How to do this: Measure non-white length of current string
18368 ;; If equal to column width, we should realign.
18370 (defun org-remap (map &rest commands)
18371 "In MAP, remap the functions given in COMMANDS.
18372 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
18373 (let (new old)
18374 (while commands
18375 (setq old (pop commands) new (pop commands))
18376 (if (fboundp 'command-remapping)
18377 (org-defkey map (vector 'remap old) new)
18378 (substitute-key-definition old new map global-map)))))
18380 (when (eq org-enable-table-editor 'optimized)
18381 ;; If the user wants maximum table support, we need to hijack
18382 ;; some standard editing functions
18383 (org-remap org-mode-map
18384 'self-insert-command 'org-self-insert-command
18385 'delete-char 'org-delete-char
18386 'delete-backward-char 'org-delete-backward-char)
18387 (org-defkey org-mode-map "|" 'org-force-self-insert))
18389 (defvar org-ctrl-c-ctrl-c-hook nil
18390 "Hook for functions attaching themselves to `C-c C-c'.
18392 This can be used to add additional functionality to the C-c C-c
18393 key which executes context-dependent commands. This hook is run
18394 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
18395 run after the last test.
18397 Each function will be called with no arguments. The function
18398 must check if the context is appropriate for it to act. If yes,
18399 it should do its thing and then return a non-nil value. If the
18400 context is wrong, just do nothing and return nil.")
18402 (defvar org-ctrl-c-ctrl-c-final-hook nil
18403 "Hook for functions attaching themselves to `C-c C-c'.
18405 This can be used to add additional functionality to the C-c C-c
18406 key which executes context-dependent commands. This hook is run
18407 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
18408 before the first test.
18410 Each function will be called with no arguments. The function
18411 must check if the context is appropriate for it to act. If yes,
18412 it should do its thing and then return a non-nil value. If the
18413 context is wrong, just do nothing and return nil.")
18415 (defvar org-tab-first-hook nil
18416 "Hook for functions to attach themselves to TAB.
18417 See `org-ctrl-c-ctrl-c-hook' for more information.
18418 This hook runs as the first action when TAB is pressed, even before
18419 `org-cycle' messes around with the `outline-regexp' to cater for
18420 inline tasks and plain list item folding.
18421 If any function in this hook returns t, any other actions that
18422 would have been caused by TAB (such as table field motion or visibility
18423 cycling) will not occur.")
18425 (defvar org-tab-after-check-for-table-hook nil
18426 "Hook for functions to attach themselves to TAB.
18427 See `org-ctrl-c-ctrl-c-hook' for more information.
18428 This hook runs after it has been established that the cursor is not in a
18429 table, but before checking if the cursor is in a headline or if global cycling
18430 should be done.
18431 If any function in this hook returns t, not other actions like visibility
18432 cycling will be done.")
18434 (defvar org-tab-after-check-for-cycling-hook nil
18435 "Hook for functions to attach themselves to TAB.
18436 See `org-ctrl-c-ctrl-c-hook' for more information.
18437 This hook runs after it has been established that not table field motion and
18438 not visibility should be done because of current context. This is probably
18439 the place where a package like yasnippets can hook in.")
18441 (defvar org-tab-before-tab-emulation-hook nil
18442 "Hook for functions to attach themselves to TAB.
18443 See `org-ctrl-c-ctrl-c-hook' for more information.
18444 This hook runs after every other options for TAB have been exhausted, but
18447 (defvar org-metaleft-hook nil
18448 "Hook for functions attaching themselves to `M-left'.
18449 See `org-ctrl-c-ctrl-c-hook' for more information.")
18450 (defvar org-metaright-hook nil
18451 "Hook for functions attaching themselves to `M-right'.
18452 See `org-ctrl-c-ctrl-c-hook' for more information.")
18453 (defvar org-metaup-hook nil
18454 "Hook for functions attaching themselves to `M-up'.
18455 See `org-ctrl-c-ctrl-c-hook' for more information.")
18456 (defvar org-metadown-hook nil
18457 "Hook for functions attaching themselves to `M-down'.
18458 See `org-ctrl-c-ctrl-c-hook' for more information.")
18459 (defvar org-shiftmetaleft-hook nil
18460 "Hook for functions attaching themselves to `M-S-left'.
18461 See `org-ctrl-c-ctrl-c-hook' for more information.")
18462 (defvar org-shiftmetaright-hook nil
18463 "Hook for functions attaching themselves to `M-S-right'.
18464 See `org-ctrl-c-ctrl-c-hook' for more information.")
18465 (defvar org-shiftmetaup-hook nil
18466 "Hook for functions attaching themselves to `M-S-up'.
18467 See `org-ctrl-c-ctrl-c-hook' for more information.")
18468 (defvar org-shiftmetadown-hook nil
18469 "Hook for functions attaching themselves to `M-S-down'.
18470 See `org-ctrl-c-ctrl-c-hook' for more information.")
18471 (defvar org-metareturn-hook nil
18472 "Hook for functions attaching themselves to `M-RET'.
18473 See `org-ctrl-c-ctrl-c-hook' for more information.")
18474 (defvar org-shiftup-hook nil
18475 "Hook for functions attaching themselves to `S-up'.
18476 See `org-ctrl-c-ctrl-c-hook' for more information.")
18477 (defvar org-shiftup-final-hook nil
18478 "Hook for functions attaching themselves to `S-up'.
18479 This one runs after all other options except shift-select have been excluded.
18480 See `org-ctrl-c-ctrl-c-hook' for more information.")
18481 (defvar org-shiftdown-hook nil
18482 "Hook for functions attaching themselves to `S-down'.
18483 See `org-ctrl-c-ctrl-c-hook' for more information.")
18484 (defvar org-shiftdown-final-hook nil
18485 "Hook for functions attaching themselves to `S-down'.
18486 This one runs after all other options except shift-select have been excluded.
18487 See `org-ctrl-c-ctrl-c-hook' for more information.")
18488 (defvar org-shiftleft-hook nil
18489 "Hook for functions attaching themselves to `S-left'.
18490 See `org-ctrl-c-ctrl-c-hook' for more information.")
18491 (defvar org-shiftleft-final-hook nil
18492 "Hook for functions attaching themselves to `S-left'.
18493 This one runs after all other options except shift-select have been excluded.
18494 See `org-ctrl-c-ctrl-c-hook' for more information.")
18495 (defvar org-shiftright-hook nil
18496 "Hook for functions attaching themselves to `S-right'.
18497 See `org-ctrl-c-ctrl-c-hook' for more information.")
18498 (defvar org-shiftright-final-hook nil
18499 "Hook for functions attaching themselves to `S-right'.
18500 This one runs after all other options except shift-select have been excluded.
18501 See `org-ctrl-c-ctrl-c-hook' for more information.")
18503 (defun org-modifier-cursor-error ()
18504 "Throw an error, a modified cursor command was applied in wrong context."
18505 (error "This command is active in special context like tables, headlines or items"))
18507 (defun org-shiftselect-error ()
18508 "Throw an error because Shift-Cursor command was applied in wrong context."
18509 (if (and (boundp 'shift-select-mode) shift-select-mode)
18510 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
18511 (error "This command works only in special context like headlines or timestamps")))
18513 (defun org-call-for-shift-select (cmd)
18514 (let ((this-command-keys-shift-translated t))
18515 (call-interactively cmd)))
18517 (defun org-shifttab (&optional arg)
18518 "Global visibility cycling or move to previous table field.
18519 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
18520 on context.
18521 See the individual commands for more information."
18522 (interactive "P")
18523 (cond
18524 ((org-at-table-p) (call-interactively 'org-table-previous-field))
18525 ((integerp arg)
18526 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18527 (message "Content view to level: %d" arg)
18528 (org-content (prefix-numeric-value arg2))
18529 (setq org-cycle-global-status 'overview)))
18530 (t (call-interactively 'org-global-cycle))))
18532 (defun org-shiftmetaleft ()
18533 "Promote subtree or delete table column.
18534 Calls `org-promote-subtree', `org-outdent-item-tree', or
18535 `org-table-delete-column', depending on context. See the
18536 individual commands for more information."
18537 (interactive)
18538 (cond
18539 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18540 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18541 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18542 ((if (not (org-region-active-p)) (org-at-item-p)
18543 (save-excursion (goto-char (region-beginning))
18544 (org-at-item-p)))
18545 (call-interactively 'org-outdent-item-tree))
18546 (t (org-modifier-cursor-error))))
18548 (defun org-shiftmetaright ()
18549 "Demote subtree or insert table column.
18550 Calls `org-demote-subtree', `org-indent-item-tree', or
18551 `org-table-insert-column', depending on context. See the
18552 individual commands for more information."
18553 (interactive)
18554 (cond
18555 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18556 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18557 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18558 ((if (not (org-region-active-p)) (org-at-item-p)
18559 (save-excursion (goto-char (region-beginning))
18560 (org-at-item-p)))
18561 (call-interactively 'org-indent-item-tree))
18562 (t (org-modifier-cursor-error))))
18564 (defun org-shiftmetaup (&optional arg)
18565 "Move subtree up or kill table row.
18566 Calls `org-move-subtree-up' or `org-table-kill-row' or
18567 `org-move-item-up' or `org-timestamp-up', depending on context.
18568 See the individual commands for more information."
18569 (interactive "P")
18570 (cond
18571 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18572 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18573 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18574 ((org-at-item-p) (call-interactively 'org-move-item-up))
18575 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18576 (call-interactively 'org-timestamp-up)))
18577 (t (org-modifier-cursor-error))))
18579 (defun org-shiftmetadown (&optional arg)
18580 "Move subtree down or insert table row.
18581 Calls `org-move-subtree-down' or `org-table-insert-row' or
18582 `org-move-item-down' or `org-timestamp-up', depending on context.
18583 See the individual commands for more information."
18584 (interactive "P")
18585 (cond
18586 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18587 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18588 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18589 ((org-at-item-p) (call-interactively 'org-move-item-down))
18590 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18591 (call-interactively 'org-timestamp-down)))
18592 (t (org-modifier-cursor-error))))
18594 (defsubst org-hidden-tree-error ()
18595 (error
18596 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18598 (defun org-metaleft (&optional arg)
18599 "Promote heading or move table column to left.
18600 Calls `org-do-promote' or `org-table-move-column', depending on context.
18601 With no specific context, calls the Emacs default `backward-word'.
18602 See the individual commands for more information."
18603 (interactive "P")
18604 (cond
18605 ((run-hook-with-args-until-success 'org-metaleft-hook))
18606 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18607 ((org-with-limited-levels
18608 (or (org-at-heading-p)
18609 (and (org-region-active-p)
18610 (save-excursion
18611 (goto-char (region-beginning))
18612 (org-at-heading-p)))))
18613 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18614 (call-interactively 'org-do-promote))
18615 ;; At an inline task.
18616 ((org-at-heading-p)
18617 (call-interactively 'org-inlinetask-promote))
18618 ((or (org-at-item-p)
18619 (and (org-region-active-p)
18620 (save-excursion
18621 (goto-char (region-beginning))
18622 (org-at-item-p))))
18623 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18624 (call-interactively 'org-outdent-item))
18625 (t (call-interactively 'backward-word))))
18627 (defun org-metaright (&optional arg)
18628 "Demote a subtree, a list item or move table column to right.
18629 In front of a drawer or a block keyword, indent it correctly.
18630 With no specific context, calls the Emacs default `forward-word'.
18631 See the individual commands for more information."
18632 (interactive "P")
18633 (cond
18634 ((run-hook-with-args-until-success 'org-metaright-hook))
18635 ((org-at-table-p) (call-interactively 'org-table-move-column))
18636 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18637 ((org-at-block-p) (call-interactively 'org-indent-block))
18638 ((org-with-limited-levels
18639 (or (org-at-heading-p)
18640 (and (org-region-active-p)
18641 (save-excursion
18642 (goto-char (region-beginning))
18643 (org-at-heading-p)))))
18644 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18645 (call-interactively 'org-do-demote))
18646 ;; At an inline task.
18647 ((org-at-heading-p)
18648 (call-interactively 'org-inlinetask-demote))
18649 ((or (org-at-item-p)
18650 (and (org-region-active-p)
18651 (save-excursion
18652 (goto-char (region-beginning))
18653 (org-at-item-p))))
18654 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18655 (call-interactively 'org-indent-item))
18656 (t (call-interactively 'forward-word))))
18658 (defun org-check-for-hidden (what)
18659 "Check if there are hidden headlines/items in the current visual line.
18660 WHAT can be either `headlines' or `items'. If the current line is
18661 an outline or item heading and it has a folded subtree below it,
18662 this function returns t, nil otherwise."
18663 (let ((re (cond
18664 ((eq what 'headlines) org-outline-regexp-bol)
18665 ((eq what 'items) (org-item-beginning-re))
18666 (t (error "This should not happen"))))
18667 beg end)
18668 (save-excursion
18669 (catch 'exit
18670 (unless (org-region-active-p)
18671 (setq beg (point-at-bol))
18672 (beginning-of-line 2)
18673 (while (and (not (eobp)) ;; this is like `next-line'
18674 (get-char-property (1- (point)) 'invisible))
18675 (beginning-of-line 2))
18676 (setq end (point))
18677 (goto-char beg)
18678 (goto-char (point-at-eol))
18679 (setq end (max end (point)))
18680 (while (re-search-forward re end t)
18681 (if (get-char-property (match-beginning 0) 'invisible)
18682 (throw 'exit t))))
18683 nil))))
18685 (autoload 'org-element-at-point "org-element")
18686 (autoload 'org-element-type "org-element")
18688 (declare-function org-element-at-point "org-element" (&optional keep-trail))
18689 (declare-function org-element-type "org-element" (element))
18690 (declare-function org-element-contents "org-element" (element))
18691 (declare-function org-element-property "org-element" (property element))
18692 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
18693 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
18694 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
18695 (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
18696 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
18698 (defun org-metaup (&optional arg)
18699 "Move subtree up or move table row up.
18700 Calls `org-move-subtree-up' or `org-table-move-row' or
18701 `org-move-item-up', depending on context. See the individual commands
18702 for more information."
18703 (interactive "P")
18704 (cond
18705 ((run-hook-with-args-until-success 'org-metaup-hook))
18706 ((org-region-active-p)
18707 (let* ((a (min (region-beginning) (region-end)))
18708 (b (1- (max (region-beginning) (region-end))))
18709 (c (save-excursion (goto-char a)
18710 (move-beginning-of-line 0)))
18711 (d (save-excursion (goto-char a)
18712 (move-end-of-line 0) (point))))
18713 (transpose-regions a b c d)
18714 (goto-char c)))
18715 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18716 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18717 ((org-at-item-p) (call-interactively 'org-move-item-up))
18718 (t (org-drag-element-backward))))
18720 (defun org-metadown (&optional arg)
18721 "Move subtree down or move table row down.
18722 Calls `org-move-subtree-down' or `org-table-move-row' or
18723 `org-move-item-down', depending on context. See the individual
18724 commands for more information."
18725 (interactive "P")
18726 (cond
18727 ((run-hook-with-args-until-success 'org-metadown-hook))
18728 ((org-region-active-p)
18729 (let* ((a (min (region-beginning) (region-end)))
18730 (b (max (region-beginning) (region-end)))
18731 (c (save-excursion (goto-char b)
18732 (move-beginning-of-line 1)))
18733 (d (save-excursion (goto-char b)
18734 (move-end-of-line 1) (1+ (point)))))
18735 (transpose-regions a b c d)
18736 (goto-char d)))
18737 ((org-at-table-p) (call-interactively 'org-table-move-row))
18738 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18739 ((org-at-item-p) (call-interactively 'org-move-item-down))
18740 (t (org-drag-element-forward))))
18742 (defun org-shiftup (&optional arg)
18743 "Increase item in timestamp or increase priority of current headline.
18744 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18745 depending on context. See the individual commands for more information."
18746 (interactive "P")
18747 (cond
18748 ((run-hook-with-args-until-success 'org-shiftup-hook))
18749 ((and org-support-shift-select (org-region-active-p))
18750 (org-call-for-shift-select 'previous-line))
18751 ((org-at-timestamp-p t)
18752 (call-interactively (if org-edit-timestamp-down-means-later
18753 'org-timestamp-down 'org-timestamp-up)))
18754 ((and (not (eq org-support-shift-select 'always))
18755 org-enable-priority-commands
18756 (org-at-heading-p))
18757 (call-interactively 'org-priority-up))
18758 ((and (not org-support-shift-select) (org-at-item-p))
18759 (call-interactively 'org-previous-item))
18760 ((org-clocktable-try-shift 'up arg))
18761 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18762 (org-support-shift-select
18763 (org-call-for-shift-select 'previous-line))
18764 (t (org-shiftselect-error))))
18766 (defun org-shiftdown (&optional arg)
18767 "Decrease item in timestamp or decrease priority of current headline.
18768 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18769 depending on context. See the individual commands for more information."
18770 (interactive "P")
18771 (cond
18772 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18773 ((and org-support-shift-select (org-region-active-p))
18774 (org-call-for-shift-select 'next-line))
18775 ((org-at-timestamp-p t)
18776 (call-interactively (if org-edit-timestamp-down-means-later
18777 'org-timestamp-up 'org-timestamp-down)))
18778 ((and (not (eq org-support-shift-select 'always))
18779 org-enable-priority-commands
18780 (org-at-heading-p))
18781 (call-interactively 'org-priority-down))
18782 ((and (not org-support-shift-select) (org-at-item-p))
18783 (call-interactively 'org-next-item))
18784 ((org-clocktable-try-shift 'down arg))
18785 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18786 (org-support-shift-select
18787 (org-call-for-shift-select 'next-line))
18788 (t (org-shiftselect-error))))
18790 (defun org-shiftright (&optional arg)
18791 "Cycle the thing at point or in the current line, depending on context.
18792 Depending on context, this does one of the following:
18794 - switch a timestamp at point one day into the future
18795 - on a headline, switch to the next TODO keyword.
18796 - on an item, switch entire list to the next bullet type
18797 - on a property line, switch to the next allowed value
18798 - on a clocktable definition line, move time block into the future"
18799 (interactive "P")
18800 (cond
18801 ((run-hook-with-args-until-success 'org-shiftright-hook))
18802 ((and org-support-shift-select (org-region-active-p))
18803 (org-call-for-shift-select 'forward-char))
18804 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18805 ((and (not (eq org-support-shift-select 'always))
18806 (org-at-heading-p))
18807 (let ((org-inhibit-logging
18808 (not org-treat-S-cursor-todo-selection-as-state-change))
18809 (org-inhibit-blocking
18810 (not org-treat-S-cursor-todo-selection-as-state-change)))
18811 (org-call-with-arg 'org-todo 'right)))
18812 ((or (and org-support-shift-select
18813 (not (eq org-support-shift-select 'always))
18814 (org-at-item-bullet-p))
18815 (and (not org-support-shift-select) (org-at-item-p)))
18816 (org-call-with-arg 'org-cycle-list-bullet nil))
18817 ((and (not (eq org-support-shift-select 'always))
18818 (org-at-property-p))
18819 (call-interactively 'org-property-next-allowed-value))
18820 ((org-clocktable-try-shift 'right arg))
18821 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18822 (org-support-shift-select
18823 (org-call-for-shift-select 'forward-char))
18824 (t (org-shiftselect-error))))
18826 (defun org-shiftleft (&optional arg)
18827 "Cycle the thing at point or in the current line, depending on context.
18828 Depending on context, this does one of the following:
18830 - switch a timestamp at point one day into the past
18831 - on a headline, switch to the previous TODO keyword.
18832 - on an item, switch entire list to the previous bullet type
18833 - on a property line, switch to the previous allowed value
18834 - on a clocktable definition line, move time block into the past"
18835 (interactive "P")
18836 (cond
18837 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18838 ((and org-support-shift-select (org-region-active-p))
18839 (org-call-for-shift-select 'backward-char))
18840 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18841 ((and (not (eq org-support-shift-select 'always))
18842 (org-at-heading-p))
18843 (let ((org-inhibit-logging
18844 (not org-treat-S-cursor-todo-selection-as-state-change))
18845 (org-inhibit-blocking
18846 (not org-treat-S-cursor-todo-selection-as-state-change)))
18847 (org-call-with-arg 'org-todo 'left)))
18848 ((or (and org-support-shift-select
18849 (not (eq org-support-shift-select 'always))
18850 (org-at-item-bullet-p))
18851 (and (not org-support-shift-select) (org-at-item-p)))
18852 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18853 ((and (not (eq org-support-shift-select 'always))
18854 (org-at-property-p))
18855 (call-interactively 'org-property-previous-allowed-value))
18856 ((org-clocktable-try-shift 'left arg))
18857 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18858 (org-support-shift-select
18859 (org-call-for-shift-select 'backward-char))
18860 (t (org-shiftselect-error))))
18862 (defun org-shiftcontrolright ()
18863 "Switch to next TODO set."
18864 (interactive)
18865 (cond
18866 ((and org-support-shift-select (org-region-active-p))
18867 (org-call-for-shift-select 'forward-word))
18868 ((and (not (eq org-support-shift-select 'always))
18869 (org-at-heading-p))
18870 (org-call-with-arg 'org-todo 'nextset))
18871 (org-support-shift-select
18872 (org-call-for-shift-select 'forward-word))
18873 (t (org-shiftselect-error))))
18875 (defun org-shiftcontrolleft ()
18876 "Switch to previous TODO set."
18877 (interactive)
18878 (cond
18879 ((and org-support-shift-select (org-region-active-p))
18880 (org-call-for-shift-select 'backward-word))
18881 ((and (not (eq org-support-shift-select 'always))
18882 (org-at-heading-p))
18883 (org-call-with-arg 'org-todo 'previousset))
18884 (org-support-shift-select
18885 (org-call-for-shift-select 'backward-word))
18886 (t (org-shiftselect-error))))
18888 (defun org-shiftcontrolup ()
18889 "Change timestamps synchronously up in CLOCK log lines."
18890 (interactive)
18891 (cond ((and (not org-support-shift-select)
18892 (org-at-clock-log-p)
18893 (org-at-timestamp-p t))
18894 (org-clock-timestamps-up))
18895 (t (org-shiftselect-error))))
18897 (defun org-shiftcontroldown ()
18898 "Change timestamps synchronously down in CLOCK log lines."
18899 (interactive)
18900 (cond ((and (not org-support-shift-select)
18901 (org-at-clock-log-p)
18902 (org-at-timestamp-p t))
18903 (org-clock-timestamps-down))
18904 (t (org-shiftselect-error))))
18906 (defun org-ctrl-c-ret ()
18907 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18908 (interactive)
18909 (cond
18910 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18911 (t (call-interactively 'org-insert-heading))))
18913 (defun org-find-visible ()
18914 (let ((s (point)))
18915 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18916 (get-char-property s 'invisible)))
18917 s))
18918 (defun org-find-invisible ()
18919 (let ((s (point)))
18920 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18921 (not (get-char-property s 'invisible))))
18922 s))
18924 (defun org-copy-visible (beg end)
18925 "Copy the visible parts of the region."
18926 (interactive "r")
18927 (let (snippets s)
18928 (save-excursion
18929 (save-restriction
18930 (narrow-to-region beg end)
18931 (setq s (goto-char (point-min)))
18932 (while (not (= (point) (point-max)))
18933 (goto-char (org-find-invisible))
18934 (push (buffer-substring s (point)) snippets)
18935 (setq s (goto-char (org-find-visible))))))
18936 (kill-new (apply 'concat (nreverse snippets)))))
18938 (defun org-copy-special ()
18939 "Copy region in table or copy current subtree.
18940 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18941 See the individual commands for more information."
18942 (interactive)
18943 (call-interactively
18944 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18946 (defun org-cut-special ()
18947 "Cut region in table or cut current subtree.
18948 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18949 See the individual commands for more information."
18950 (interactive)
18951 (call-interactively
18952 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18954 (defun org-paste-special (arg)
18955 "Paste rectangular region into table, or past subtree relative to level.
18956 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18957 See the individual commands for more information."
18958 (interactive "P")
18959 (if (org-at-table-p)
18960 (org-table-paste-rectangle)
18961 (org-paste-subtree arg)))
18963 (defsubst org-in-fixed-width-region-p ()
18964 "Is point in a fixed-width region?"
18965 (save-match-data
18966 (eq 'fixed-width (org-element-type (org-element-at-point)))))
18968 (defun org-edit-special (&optional arg)
18969 "Call a special editor for the stuff at point.
18970 When at a table, call the formula editor with `org-table-edit-formulas'.
18971 When in a source code block, call `org-edit-src-code'.
18972 When in a fixed-width region, call `org-edit-fixed-width-region'.
18973 When in an #+include line, visit the included file.
18974 On a link, call `ffap' to visit the link at point.
18975 Otherwise, return a user error."
18976 (interactive)
18977 ;; possibly prep session before editing source
18978 (when (and (org-in-src-block-p) arg)
18979 (let* ((info (org-babel-get-src-block-info))
18980 (lang (nth 0 info))
18981 (params (nth 2 info))
18982 (session (cdr (assoc :session params))))
18983 (when (and info session) ;; we are in a source-code block with a session
18984 (funcall
18985 (intern (concat "org-babel-prep-session:" lang)) session params))))
18986 (cond ;; proceed with `org-edit-special'
18987 ((save-excursion
18988 (beginning-of-line 1)
18989 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18990 (find-file (org-trim (match-string 1))))
18991 ((or (org-at-table-p)
18992 (save-excursion
18993 (beginning-of-line 1)
18995 (call-interactively 'org-table-edit-formulas))
18996 ((or (org-in-block-p '("src" "example" "latex" "html"))
18997 (org-at-table.el-p))
18998 (org-edit-src-code))
18999 ((org-in-fixed-width-region-p) (org-edit-fixed-width-region))
19000 ((org-at-regexp-p org-any-link-re) (call-interactively 'ffap))
19001 (t (user-error "No special environment to edit here"))))
19003 (defvar org-table-coordinate-overlays) ; defined in org-table.el
19004 (defun org-ctrl-c-ctrl-c (&optional arg)
19005 "Set tags in headline, or update according to changed information at point.
19007 This command does many different things, depending on context:
19009 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
19010 this is what we do.
19012 - If the cursor is on a statistics cookie, update it.
19014 - If the cursor is in a headline, prompt for tags and insert them
19015 into the current line, aligned to `org-tags-column'. When called
19016 with prefix arg, realign all tags in the current buffer.
19018 - If the cursor is in one of the special #+KEYWORD lines, this
19019 triggers scanning the buffer for these lines and updating the
19020 information.
19022 - If the cursor is inside a table, realign the table. This command
19023 works even if the automatic table editor has been turned off.
19025 - If the cursor is on a #+TBLFM line, re-apply the formulas to
19026 the entire table.
19028 - If the cursor is at a footnote reference or definition, jump to
19029 the corresponding definition or references, respectively.
19031 - If the cursor is a the beginning of a dynamic block, update it.
19033 - If the current buffer is a capture buffer, close note and file it.
19035 - If the cursor is on a <<<target>>>, update radio targets and
19036 corresponding links in this buffer.
19038 - If the cursor is on a numbered item in a plain list, renumber the
19039 ordered list.
19041 - If the cursor is on a checkbox, toggle it.
19043 - If the cursor is on a code block, evaluate it. The variable
19044 `org-confirm-babel-evaluate' can be used to control prompting
19045 before code block evaluation, by default every code block
19046 evaluation requires confirmation. Code block evaluation can be
19047 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
19048 (interactive "P")
19049 (let ((org-enable-table-editor t))
19050 (cond
19051 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
19052 org-occur-highlights
19053 org-latex-fragment-image-overlays)
19054 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
19055 (org-remove-occur-highlights)
19056 (org-remove-latex-fragment-image-overlays)
19057 (message "Temporary highlights/overlays removed from current buffer"))
19058 ((and (local-variable-p 'org-finish-function (current-buffer))
19059 (fboundp org-finish-function))
19060 (funcall org-finish-function))
19061 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
19062 ((org-in-regexp org-ts-regexp-both)
19063 (org-timestamp-change 0 'day))
19064 ((or (looking-at org-property-start-re)
19065 (org-at-property-p))
19066 (call-interactively 'org-property-action))
19067 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
19069 (or (org-at-heading-p) (org-at-item-p)))
19070 (call-interactively 'org-update-statistics-cookies))
19071 ((org-at-heading-p) (call-interactively 'org-set-tags))
19072 ((org-at-table.el-p)
19073 (message "Use C-c ' to edit table.el tables"))
19074 ((org-at-table-p)
19075 (org-table-maybe-eval-formula)
19076 (if arg
19077 (call-interactively 'org-table-recalculate)
19078 (org-table-maybe-recalculate-line))
19079 (call-interactively 'org-table-align)
19080 (orgtbl-send-table 'maybe))
19081 ((or (org-footnote-at-reference-p)
19082 (org-footnote-at-definition-p))
19083 (call-interactively 'org-footnote-action))
19084 ((org-at-item-checkbox-p)
19085 ;; Cursor at a checkbox: repair list and update checkboxes. Send
19086 ;; list only if at top item.
19087 (let* ((cbox (match-string 1))
19088 (struct (org-list-struct))
19089 (old-struct (copy-tree struct))
19090 (parents (org-list-parents-alist struct))
19091 (orderedp (org-entry-get nil "ORDERED"))
19092 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19093 block-item)
19094 ;; Use a light version of `org-toggle-checkbox' to avoid
19095 ;; computing list structure twice.
19096 (let ((new-box (cond
19097 ((equal arg '(16)) "[-]")
19098 ((equal arg '(4)) nil)
19099 ((equal "[X]" cbox) "[ ]")
19100 (t "[X]"))))
19101 (if (and firstp arg)
19102 ;; If at first item of sub-list, remove check-box from
19103 ;; every item at the same level.
19104 (mapc
19105 (lambda (pos) (org-list-set-checkbox pos struct new-box))
19106 (org-list-get-all-items
19107 (point-at-bol) struct (org-list-prevs-alist struct)))
19108 (org-list-set-checkbox (point-at-bol) struct new-box)))
19109 ;; Replicate `org-list-write-struct', while grabbing a return
19110 ;; value from `org-list-struct-fix-box'.
19111 (org-list-struct-fix-ind struct parents 2)
19112 (org-list-struct-fix-item-end struct)
19113 (let ((prevs (org-list-prevs-alist struct)))
19114 (org-list-struct-fix-bul struct prevs)
19115 (org-list-struct-fix-ind struct parents)
19116 (setq block-item
19117 (org-list-struct-fix-box struct parents prevs orderedp)))
19118 (org-list-struct-apply-struct struct old-struct)
19119 (org-update-checkbox-count-maybe)
19120 (when block-item
19121 (message
19122 "Checkboxes were removed due to unchecked box at line %d"
19123 (org-current-line block-item)))
19124 (when firstp (org-list-send-list 'maybe))))
19125 ((org-at-item-p)
19126 ;; Cursor at an item: repair list. Do checkbox related actions
19127 ;; only if function was called with an argument. Send list only
19128 ;; if at top item.
19129 (let* ((struct (org-list-struct))
19130 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19131 old-struct)
19132 (when arg
19133 (setq old-struct (copy-tree struct))
19134 (if firstp
19135 ;; If at first item of sub-list, add check-box to every
19136 ;; item at the same level.
19137 (mapc
19138 (lambda (pos)
19139 (unless (org-list-get-checkbox pos struct)
19140 (org-list-set-checkbox pos struct "[ ]")))
19141 (org-list-get-all-items
19142 (point-at-bol) struct (org-list-prevs-alist struct)))
19143 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
19144 (org-list-write-struct
19145 struct (org-list-parents-alist struct) old-struct)
19146 (when arg (org-update-checkbox-count-maybe))
19147 (when firstp (org-list-send-list 'maybe))))
19148 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
19149 ;; Dynamic block
19150 (beginning-of-line 1)
19151 (save-excursion (org-update-dblock)))
19152 ((save-excursion
19153 (let ((case-fold-search t))
19154 (beginning-of-line 1)
19156 (cond
19157 ((or (equal (match-string 1) "TBLFM")
19158 (equal (match-string 1) "tblfm"))
19159 ;; Recalculate the table before this line
19160 (save-excursion
19161 (beginning-of-line 1)
19163 (if (org-at-table-p)
19164 (org-call-with-arg 'org-table-recalculate (or arg t)))))
19165 (t
19166 (let ((org-inhibit-startup-visibility-stuff t)
19167 (org-startup-align-all-tables nil))
19168 (when (boundp 'org-table-coordinate-overlays)
19169 (mapc 'delete-overlay org-table-coordinate-overlays)
19170 (setq org-table-coordinate-overlays nil))
19171 (org-save-outline-visibility 'use-markers (org-mode-restart)))
19172 (message "Local setup has been refreshed"))))
19173 ((org-clock-update-time-maybe))
19174 (t
19175 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19176 (error "C-c C-c can do nothing useful at this location"))))))
19178 (defun org-mode-restart ()
19179 "Restart Org-mode, to scan again for special lines.
19180 Also updates the keyword regular expressions."
19181 (interactive)
19182 (org-mode)
19183 (message "Org-mode restarted"))
19185 (defun org-kill-note-or-show-branches ()
19186 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
19187 (interactive)
19188 (if (not org-finish-function)
19189 (progn
19190 (hide-subtree)
19191 (call-interactively 'show-branches))
19192 (let ((org-note-abort t))
19193 (funcall org-finish-function))))
19195 (defun org-return (&optional indent)
19196 "Goto next table row or insert a newline.
19197 Calls `org-table-next-row' or `newline', depending on context.
19198 See the individual commands for more information."
19199 (interactive)
19200 (let (org-ts-what)
19201 (cond
19202 ((or (bobp) (org-in-src-block-p))
19203 (if indent (newline-and-indent) (newline)))
19204 ((org-at-table-p)
19205 (org-table-justify-field-maybe)
19206 (call-interactively 'org-table-next-row))
19207 ;; when `newline-and-indent' is called within a list, make sure
19208 ;; text moved stays inside the item.
19209 ((and (org-in-item-p) indent)
19210 (if (and (org-at-item-p) (>= (point) (match-end 0)))
19211 (progn
19212 (save-match-data (newline))
19213 (org-indent-line-to (length (match-string 0))))
19214 (let ((ind (org-get-indentation)))
19215 (newline)
19216 (if (org-looking-back org-list-end-re)
19217 (org-indent-line)
19218 (org-indent-line-to ind)))))
19219 ((and org-return-follows-link
19220 (org-at-timestamp-p t)
19221 (not (eq org-ts-what 'after)))
19222 (org-follow-timestamp-link))
19223 ((and org-return-follows-link
19224 (let ((tprop (get-text-property (point) 'face)))
19225 (or (eq tprop 'org-link)
19226 (and (listp tprop) (memq 'org-link tprop)))))
19227 (call-interactively 'org-open-at-point))
19228 ((and (org-at-heading-p)
19229 (looking-at
19231 (org-show-entry)
19232 (end-of-line 1)
19233 (newline))
19234 (t (if indent (newline-and-indent) (newline))))))
19236 (defun org-return-indent ()
19237 "Goto next table row or insert a newline and indent.
19238 Calls `org-table-next-row' or `newline-and-indent', depending on
19239 context. See the individual commands for more information."
19240 (interactive)
19241 (org-return t))
19243 (defun org-ctrl-c-star ()
19244 "Compute table, or change heading status of lines.
19245 Calls `org-table-recalculate' or `org-toggle-heading',
19246 depending on context."
19247 (interactive)
19248 (cond
19249 ((org-at-table-p)
19250 (call-interactively 'org-table-recalculate))
19251 (t
19252 ;; Convert all lines in region to list items
19253 (call-interactively 'org-toggle-heading))))
19255 (defun org-ctrl-c-minus ()
19256 "Insert separator line in table or modify bullet status of line.
19257 Also turns a plain line or a region of lines into list items.
19258 Calls `org-table-insert-hline', `org-toggle-item', or
19259 `org-cycle-list-bullet', depending on context."
19260 (interactive)
19261 (cond
19262 ((org-at-table-p)
19263 (call-interactively 'org-table-insert-hline))
19264 ((org-region-active-p)
19265 (call-interactively 'org-toggle-item))
19266 ((org-in-item-p)
19267 (call-interactively 'org-cycle-list-bullet))
19268 (t
19269 (call-interactively 'org-toggle-item))))
19271 (defun org-toggle-item (arg)
19272 "Convert headings or normal lines to items, items to normal lines.
19273 If there is no active region, only the current line is considered.
19275 If the first non blank line in the region is an headline, convert
19276 all headlines to items, shifting text accordingly.
19278 If it is an item, convert all items to normal lines.
19280 If it is normal text, change region into an item. With a prefix
19281 argument ARG, change each line in region into an item."
19282 (interactive "P")
19283 (let ((shift-text
19284 (function
19285 ;; Shift text in current section to IND, from point to END.
19286 ;; The function leaves point to END line.
19287 (lambda (ind end)
19288 (let ((min-i 1000) (end (copy-marker end)))
19289 ;; First determine the minimum indentation (MIN-I) of
19290 ;; the text.
19291 (save-excursion
19292 (catch 'exit
19293 (while (< (point) end)
19294 (let ((i (org-get-indentation)))
19295 (cond
19296 ;; Skip blank lines and inline tasks.
19298 ((looking-at org-outline-regexp-bol))
19299 ;; We can't find less than 0 indentation.
19300 ((zerop i) (throw 'exit (setq min-i 0)))
19301 ((< i min-i) (setq min-i i))))
19302 (forward-line))))
19303 ;; Then indent each line so that a line indented to
19304 ;; MIN-I becomes indented to IND. Ignore blank lines
19305 ;; and inline tasks in the process.
19306 (let ((delta (- ind min-i)))
19307 (while (< (point) end)
19309 (looking-at org-outline-regexp-bol))
19310 (org-indent-line-to (+ (org-get-indentation) delta)))
19311 (forward-line)))))))
19312 (skip-blanks
19313 (function
19314 ;; Return beginning of first non-blank line, starting from
19315 ;; line at POS.
19316 (lambda (pos)
19317 (save-excursion
19318 (goto-char pos)
19320 (point-at-bol)))))
19321 beg end)
19322 ;; Determine boundaries of changes.
19323 (if (org-region-active-p)
19324 (setq beg (funcall skip-blanks (region-beginning))
19325 end (copy-marker (region-end)))
19326 (setq beg (funcall skip-blanks (point-at-bol))
19327 end (copy-marker (point-at-eol))))
19328 ;; Depending on the starting line, choose an action on the text
19329 ;; between BEG and END.
19330 (org-with-limited-levels
19331 (save-excursion
19332 (goto-char beg)
19333 (cond
19334 ;; Case 1. Start at an item: de-itemize. Note that it only
19335 ;; happens when a region is active: `org-ctrl-c-minus'
19336 ;; would call `org-cycle-list-bullet' otherwise.
19337 ((org-at-item-p)
19338 (while (< (point) end)
19339 (when (org-at-item-p)
19341 (delete-region (point) (match-end 0)))
19342 (forward-line)))
19343 ;; Case 2. Start at an heading: convert to items.
19344 ((org-at-heading-p)
19345 (let* ((bul (org-list-bullet-string "-"))
19346 (bul-len (length bul))
19347 ;; Indentation of the first heading. It should be
19348 ;; relative to the indentation of its parent, if any.
19349 (start-ind (save-excursion
19350 (cond
19351 ((not org-adapt-indentation) 0)
19352 ((not (outline-previous-heading)) 0)
19353 (t (length (match-string 0))))))
19354 ;; Level of first heading. Further headings will be
19355 ;; compared to it to determine hierarchy in the list.
19356 (ref-level (org-reduced-level (org-outline-level))))
19357 (while (< (point) end)
19358 (let* ((level (org-reduced-level (org-outline-level)))
19359 (delta (max 0 (- level ref-level))))
19360 ;; If current headline is less indented than the first
19361 ;; one, set it as reference, in order to preserve
19362 ;; subtrees.
19363 (when (< level ref-level) (setq ref-level level))
19364 (replace-match bul t t)
19365 (org-indent-line-to (+ start-ind (* delta bul-len)))
19366 ;; Ensure all text down to END (or SECTION-END) belongs
19367 ;; to the newly created item.
19368 (let ((section-end (save-excursion
19369 (or (outline-next-heading) (point)))))
19370 (forward-line)
19371 (funcall shift-text
19372 (+ start-ind (* (1+ delta) bul-len))
19373 (min end section-end)))))))
19374 ;; Case 3. Normal line with ARG: turn each non-item line into
19375 ;; an item.
19376 (arg
19377 (while (< (point) end)
19378 (unless (or (org-at-heading-p) (org-at-item-p))
19380 (replace-match
19382 (forward-line)))
19383 ;; Case 4. Normal line without ARG: make the first line of
19384 ;; region an item, and shift indentation of others
19385 ;; lines to set them as item's body.
19386 (t (let* ((bul (org-list-bullet-string "-"))
19387 (bul-len (length bul))
19388 (ref-ind (org-get-indentation)))
19390 (insert bul)
19391 (forward-line)
19392 (while (< (point) end)
19393 ;; Ensure that lines less indented than first one
19394 ;; still get included in item body.
19395 (funcall shift-text
19396 (+ ref-ind bul-len)
19397 (min end (save-excursion (or (outline-next-heading)
19398 (point)))))
19399 (forward-line)))))))))
19401 (defun org-toggle-heading (&optional nstars)
19402 "Convert headings to normal text, or items or text to headings.
19403 If there is no active region, only the current line is considered.
19406 point into heading.
19408 In a region:
19410 - If the first non blank line is an headline, remove the stars
19411 from all headlines in the region.
19413 - If it is a normal line turn each and every normal line (i.e. not an
19414 heading or an item) in the region into a heading.
19416 - If it is a plain list item, turn all plain list items into headings.
19418 When converting a line into a heading, the number of stars is chosen
19419 such that the lines become children of the current entry. However,
19420 when a prefix argument is given, its value determines the number of
19421 stars to add."
19422 (interactive "P")
19423 (let ((skip-blanks
19424 (function
19425 ;; Return beginning of first non-blank line, starting from
19426 ;; line at POS.
19427 (lambda (pos)
19428 (save-excursion
19429 (goto-char pos)
19430 (while (org-at-comment-p) (forward-line))
19432 (point-at-bol)))))
19433 beg end toggled)
19434 ;; Determine boundaries of changes. If a universal prefix has
19435 ;; been given, put the list in a region. If region ends at a bol,
19436 ;; do not consider the last line to be in the region.
19438 (when (and current-prefix-arg (org-at-item-p))
19439 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
19440 (org-mark-element))
19442 (if (org-region-active-p)
19443 (setq beg (funcall skip-blanks (region-beginning))
19444 end (copy-marker (save-excursion
19445 (goto-char (region-end))
19446 (if (bolp) (point) (point-at-eol)))))
19447 (setq beg (funcall skip-blanks (point-at-bol))
19448 end (copy-marker (point-at-eol))))
19449 ;; Ensure inline tasks don't count as headings.
19450 (org-with-limited-levels
19451 (save-excursion
19452 (goto-char beg)
19453 (cond
19454 ;; Case 1. Started at an heading: de-star headings.
19455 ((org-at-heading-p)
19456 (while (< (point) end)
19457 (when (org-at-heading-p t)
19458 (looking-at org-outline-regexp) (replace-match "")
19459 (setq toggled t))
19460 (forward-line)))
19461 ;; Case 2. Started at an item: change items into headlines.
19462 ;; One star will be added by `org-list-to-subtree'.
19463 ((org-at-item-p)
19464 (let* ((stars (make-string
19465 (if nstars
19466 ;; subtract the star that will be added again by
19467 ;; `org-list-to-subtree'
19468 (1- (prefix-numeric-value current-prefix-arg))
19469 (or (org-current-level) 0))
19470 ?*))
19471 (add-stars
19472 (cond (nstars "") ; stars from prefix only
19473 ((equal stars "") "") ; before first heading
19474 (org-odd-levels-only "*") ; inside heading, odd
19475 (t "")))) ; inside heading, oddeven
19476 (while (< (point) end)
19477 (when (org-at-item-p)
19478 ;; Pay attention to cases when region ends before list.
19479 (let* ((struct (org-list-struct))
19480 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
19481 (save-restriction
19482 (narrow-to-region (point) list-end)
19483 (insert
19484 (org-list-to-subtree
19485 (org-list-parse-list t)
19486 '(:istart (concat stars add-stars (funcall get-stars depth))
19487 :icount (concat stars add-stars (funcall get-stars depth)))))))
19488 (setq toggled t))
19489 (forward-line))))
19490 ;; Case 3. Started at normal text: make every line an heading,
19491 ;; skipping headlines and items.
19492 (t (let* ((stars (make-string
19493 (if nstars
19494 (prefix-numeric-value current-prefix-arg)
19495 (or (org-current-level) 0))
19496 ?*))
19497 (add-stars
19498 (cond (nstars "") ; stars from prefix only
19499 ((equal stars "") "*") ; before first heading
19500 (org-odd-levels-only "**") ; inside heading, odd
19501 (t "*"))) ; inside heading, oddeven
19502 (rpl (concat stars add-stars " ")))
19503 (while (< (point) end)
19504 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
19506 (replace-match (concat rpl (match-string 2))) (setq toggled t))
19507 (forward-line)))))))
19508 (unless toggled (message "Cannot toggle heading from here"))))
19510 (defun org-meta-return (&optional arg)
19511 "Insert a new heading or wrap a region in a table.
19512 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
19513 See the individual commands for more information."
19514 (interactive "P")
19515 (cond
19516 ((run-hook-with-args-until-success 'org-metareturn-hook))
19517 ((or (org-at-drawer-p) (org-at-property-p))
19518 (newline-and-indent))
19519 ((org-at-table-p)
19520 (call-interactively 'org-table-wrap-region))
19521 (t (call-interactively 'org-insert-heading))))
19523 ;;; Menu entries
19525 (defsubst org-in-subtree-not-table-p ()
19526 "Are we in a subtree and not in a table?"
19527 (and (not (org-before-first-heading-p))
19528 (not (org-at-table-p))))
19530 ;; Define the Org-mode menus
19531 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
19532 '("Tbl"
19533 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
19534 ["Next Field" org-cycle (org-at-table-p)]
19535 ["Previous Field" org-shifttab (org-at-table-p)]
19536 ["Next Row" org-return (org-at-table-p)]
19537 "--"
19538 ["Blank Field" org-table-blank-field (org-at-table-p)]
19539 ["Edit Field" org-table-edit-field (org-at-table-p)]
19540 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
19541 "--"
19542 ("Column"
19543 ["Move Column Left" org-metaleft (org-at-table-p)]
19544 ["Move Column Right" org-metaright (org-at-table-p)]
19545 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
19546 ["Insert Column" org-shiftmetaright (org-at-table-p)])
19547 ("Row"
19548 ["Move Row Up" org-metaup (org-at-table-p)]
19549 ["Move Row Down" org-metadown (org-at-table-p)]
19550 ["Delete Row" org-shiftmetaup (org-at-table-p)]
19551 ["Insert Row" org-shiftmetadown (org-at-table-p)]
19552 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
19553 "--"
19554 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
19555 ("Rectangle"
19556 ["Copy Rectangle" org-copy-special (org-at-table-p)]
19557 ["Cut Rectangle" org-cut-special (org-at-table-p)]
19558 ["Paste Rectangle" org-paste-special (org-at-table-p)]
19559 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
19560 "--"
19561 ("Calculate"
19562 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
19563 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
19564 ["Edit Formulas" org-edit-special (org-at-table-p)]
19565 "--"
19566 ["Recalculate line" org-table-recalculate (org-at-table-p)]
19567 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
19568 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
19569 "--"
19570 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
19571 "--"
19572 ["Sum Column/Rectangle" org-table-sum
19573 (or (org-at-table-p) (org-region-active-p))]
19574 ["Which Column?" org-table-current-column (org-at-table-p)])
19575 ["Debug Formulas"
19576 org-table-toggle-formula-debugger
19577 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
19578 ["Show Col/Row Numbers"
19579 org-table-toggle-coordinate-overlays
19580 :style toggle
19581 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
19582 "--"
19583 ["Create" org-table-create (and (not (org-at-table-p))
19584 org-enable-table-editor)]
19585 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
19586 ["Import from File" org-table-import (not (org-at-table-p))]
19587 ["Export to File" org-table-export (org-at-table-p)]
19588 "--"
19589 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
19591 (easy-menu-define org-org-menu org-mode-map "Org menu"
19592 '("Org"
19593 ("Show/Hide"
19594 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
19595 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
19596 ["Sparse Tree..." org-sparse-tree t]
19597 ["Reveal Context" org-reveal t]
19598 ["Show All" show-all t]
19599 "--"
19600 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
19601 "--"
19602 ["New Heading" org-insert-heading t]
19603 ("Navigate Headings"
19604 ["Up" outline-up-heading t]
19605 ["Next" outline-next-visible-heading t]
19606 ["Previous" outline-previous-visible-heading t]
19607 ["Next Same Level" outline-forward-same-level t]
19608 ["Previous Same Level" outline-backward-same-level t]
19609 "--"
19610 ["Jump" org-goto t])
19611 ("Edit Structure"
19612 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
19613 "--"
19614 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
19615 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
19616 "--"
19617 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
19618 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
19619 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19620 "--"
19621 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19622 "--"
19623 ["Copy visible text" org-copy-visible t]
19624 "--"
19625 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
19626 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
19627 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
19628 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
19629 "--"
19630 ["Sort Region/Children" org-sort t]
19631 "--"
19632 ["Convert to odd levels" org-convert-to-odd-levels t]
19633 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19634 ("Editing"
19635 ["Emphasis..." org-emphasize t]
19636 ["Edit Source Example" org-edit-special t]
19637 "--"
19638 ["Footnote new/jump" org-footnote-action t]
19639 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19640 ("Archive"
19641 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
19642 "--"
19643 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
19644 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
19645 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
19646 )
19647 "--"
19648 ("Hyperlinks"
19649 ["Store Link (Global)" org-store-link t]
19650 ["Find existing link to here" org-occur-link-in-agenda-files t]
19651 ["Insert Link" org-insert-link t]
19652 ["Follow Link" org-open-at-point t]
19653 "--"
19654 ["Next link" org-next-link t]
19655 ["Previous link" org-previous-link t]
19656 "--"
19657 ["Descriptive Links"
19658 org-toggle-link-display
19659 :style radio
19660 :selected org-descriptive-links
19661 ]
19662 ["Literal Links"
19663 org-toggle-link-display
19664 :style radio
19665 :selected (not org-descriptive-links)])
19666 "--"
19667 ("TODO Lists"
19668 ["TODO/DONE/-" org-todo t]
19669 ("Select keyword"
19670 ["Next keyword" org-shiftright (org-at-heading-p)]
19671 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19672 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19673 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19674 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19675 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19676 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19677 "--"
19678 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19679 :selected org-enforce-todo-dependencies :style toggle :active t]
19680 "Settings for tree at point"
19681 ["Do Children sequentially" org-toggle-ordered-property :style radio
19682 :selected (org-entry-get nil "ORDERED")
19683 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19684 ["Do Children parallel" org-toggle-ordered-property :style radio
19685 :selected (not (org-entry-get nil "ORDERED"))
19686 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19687 "--"
19688 ["Set Priority" org-priority t]
19689 ["Priority Up" org-shiftup t]
19690 ["Priority Down" org-shiftdown t]
19691 "--"
19692 ["Get news from all feeds" org-feed-update-all t]
19693 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19694 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19695 ("TAGS and Properties"
19696 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
19697 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19698 "--"
19699 ["Set property" org-set-property (not (org-before-first-heading-p))]
19700 ["Column view of properties" org-columns t]
19701 ["Insert Column View DBlock" org-insert-columns-dblock t])
19702 ("Dates and Scheduling"
19703 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
19704 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
19705 ("Change Date"
19706 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
19707 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
19708 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
19709 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
19710 ["Compute Time Range" org-evaluate-time-range t]
19711 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
19712 ["Deadline" org-deadline (not (org-before-first-heading-p))]
19713 "--"
19714 ["Custom time format" org-toggle-time-stamp-overlays
19715 :style radio :selected org-display-custom-times]
19716 "--"
19717 ["Goto Calendar" org-goto-calendar t]
19718 ["Date from Calendar" org-date-from-calendar t]
19719 "--"
19720 ["Start/Restart Timer" org-timer-start t]
19721 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19722 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19723 ["Insert Timer String" org-timer t]
19724 ["Insert Timer Item" org-timer-item t])
19725 ("Logging work"
19726 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19727 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19728 ["Clock out" org-clock-out t]
19729 ["Clock cancel" org-clock-cancel t]
19730 "--"
19731 ["Mark as default task" org-clock-mark-default-task t]
19732 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19733 ["Goto running clock" org-clock-goto t]
19734 "--"
19735 ["Display times" org-clock-display t]
19736 ["Create clock table" org-clock-report t]
19737 "--"
19738 ["Record DONE time"
19739 (progn (setq org-log-done (not org-log-done))
19740 (message "Switching to %s will %s record a timestamp"
19741 (car org-done-keywords)
19742 (if org-log-done "automatically" "not")))
19743 :style toggle :selected org-log-done])
19744 "--"
19745 ["Agenda Command..." org-agenda t]
19746 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19747 ("File List for Agenda")
19748 ("Special views current file"
19749 ["TODO Tree" org-show-todo-tree t]
19750 ["Check Deadlines" org-check-deadlines t]
19751 ["Timeline" org-timeline t]
19752 ["Tags/Property tree" org-match-sparse-tree t])
19753 "--"
19754 ["Export/Publish..." org-export t]
19755 ("LaTeX"
19756 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19757 :selected org-cdlatex-mode]
19758 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19759 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19760 ["Modify math symbol" org-cdlatex-math-modify
19761 (org-inside-LaTeX-fragment-p)]
19762 ["Insert citation" org-reftex-citation t]
19763 "--"
19764 ["Template for BEAMER" (progn (require 'org-beamer)
19765 (org-insert-beamer-options-template)) t])
19766 "--"
19767 ("MobileOrg"
19768 ["Push Files and Views" org-mobile-push t]
19769 ["Get Captured and Flagged" org-mobile-pull t]
19770 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19771 "--"
19772 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19773 "--"
19774 ("Documentation"
19775 ["Show Version" org-version t]
19776 ["Info Documentation" org-info t])
19777 ("Customize"
19778 ["Browse Org Group" org-customize t]
19779 "--"
19780 ["Expand This Menu" org-create-customize-menu
19781 (fboundp 'customize-menu-create)])
19782 ["Send bug report" org-submit-bug-report t]
19783 "--"
19784 ("Refresh/Reload"
19785 ["Refresh setup current buffer" org-mode-restart t]
19786 ["Reload Org (after update)" org-reload t]
19787 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19788 ))
19790 (defun org-info (&optional node)
19791 "Read documentation for Org-mode in the info system.
19792 With optional NODE, go directly to that node."
19793 (interactive)
19794 (info (format "(org)%s" (or node ""))))
19796 ;;;###autoload
19797 (defun org-submit-bug-report ()
19798 "Submit a bug report on Org-mode via mail.
19800 Don't hesitate to report any problems or inaccurate documentation.
19802 If you don't have setup sending mail from (X)Emacs, please copy the
19803 output buffer into your mail program, as it gives us important
19804 information about your Org-mode version and configuration."
19805 (interactive)
19806 (require 'reporter)
19807 (org-load-modules-maybe)
19808 (org-require-autoloaded-modules)
19809 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19810 (reporter-submit-bug-report
19811 "emacs-orgmode@gnu.org"
19812 (org-version nil 'full)
19813 (let (list)
19814 (save-window-excursion
19815 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19816 (delete-other-windows)
19817 (erase-buffer)
19818 (insert "You are about to submit a bug report to the Org-mode mailing list.
19820 We would like to add your full Org-mode and Outline configuration to the
19821 bug report. This greatly simplifies the work of the maintainer and
19822 other experts on the mailing list.
19824 HOWEVER, some variables you have customized may contain private
19825 information. The names of customers, colleagues, or friends, might
19826 appear in the form of file names, tags, todo states, or search strings.
19827 If you answer yes to the prompt, you might want to check and remove
19828 such private information before sending the email.")
19829 (add-text-properties (point-min) (point-max) '(face org-warning))
19830 (when (yes-or-no-p "Include your Org-mode configuration ")
19831 (mapatoms
19832 (lambda (v)
19833 (and (boundp v)
19835 (or (and (symbol-value v)
19837 (and
19838 (get v 'custom-type) (get v 'standard-value)
19839 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19840 (push v list)))))
19841 (kill-buffer (get-buffer "*Warn about privacy*"))
19842 list))
19843 nil nil
19844 "Remember to cover the basics, that is, what you expected to happen and
19845 what in fact did happen. You don't know how to make a good report? See
19847 http://orgmode.org/manual/Feedback.html#Feedback
19849 Your bug report will be posted to the Org-mode mailing list.
19850 ------------------------------------------------------------------------")
19851 (save-excursion
19856 (defun org-install-agenda-files-menu ()
19857 (let ((bl (buffer-list)))
19858 (save-excursion
19859 (while bl
19860 (set-buffer (pop bl))
19861 (if (derived-mode-p 'org-mode) (setq bl nil)))
19862 (when (derived-mode-p 'org-mode)
19863 (easy-menu-change
19864 '("Org") "File List for Agenda"
19865 (append
19866 (list
19867 ["Edit File List" (org-edit-agenda-file-list) t]
19868 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19869 ["Remove Current File from List" org-remove-file t]
19870 ["Cycle through agenda files" org-cycle-agenda-files t]
19871 ["Occur in all agenda files" org-occur-in-agenda-files t]
19872 "--")
19873 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19875 ;;;; Documentation
19877 (defun org-require-autoloaded-modules ()
19878 (interactive)
19879 (mapc 'require
19880 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19881 org-docbook org-exp org-html org-icalendar
19882 org-id org-latex
19883 org-publish org-remember org-table
19884 org-timer org-xoxo)))
19886 ;;;###autoload
19887 (defun org-reload (&optional uncompiled)
19888 "Reload all org lisp files.
19889 With prefix arg UNCOMPILED, load the uncompiled versions."
19890 (interactive "P")
19891 (require 'find-func)
19893 (dir-org (file-name-directory (org-find-library-dir "org")))
19894 (dir-org-contrib (ignore-errors
19895 (file-name-directory
19896 (org-find-library-dir "org-contribdir"))))
19897 (babel-files
19898 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19899 (append (list nil "comint" "eval" "exp" "keys"
19900 "lob" "ref" "table" "tangle")
19901 (delq nil
19902 (mapcar
19903 (lambda (lang)
19904 (when (cdr lang) (symbol-name (car lang))))
19905 org-babel-load-languages)))))
19906 (files
19907 (append babel-files
19908 (and dir-org-contrib
19909 (directory-files dir-org-contrib t file-re))
19910 (directory-files dir-org t file-re)))
19911 (remove-re (concat (if (featurep 'xemacs)
19912 "org-colview" "org-colview-xemacs")
19914 (setq files (mapcar 'file-name-sans-extension files))
19915 (setq files (mapcar
19916 (lambda (x) (if (string-match remove-re x) nil x))
19917 files))
19918 (setq files (delq nil files))
19919 (mapc
19920 (lambda (f)
19921 (when (featurep (intern (file-name-nondirectory f)))
19922 (if (and (not uncompiled)
19923 (file-exists-p (concat f ".elc")))
19924 (load (concat f ".elc") nil nil 'nosuffix)
19925 (load (concat f ".el") nil nil 'nosuffix))))
19926 files)
19927 (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
19928 (org-version nil 'full 'message))
19930 ;;;###autoload
19931 (defun org-customize ()
19932 "Call the customize function with org as argument."
19933 (interactive)
19934 (org-load-modules-maybe)
19935 (org-require-autoloaded-modules)
19936 (customize-browse 'org))
19938 (defun org-create-customize-menu ()
19939 "Create a full customization menu for Org-mode, insert it into the menu."
19940 (interactive)
19941 (org-load-modules-maybe)
19942 (org-require-autoloaded-modules)
19943 (if (fboundp 'customize-menu-create)
19944 (progn
19945 (easy-menu-change
19946 '("Org") "Customize"
19947 `(["Browse Org group" org-customize t]
19948 "--"
19949 ,(customize-menu-create 'org)
19950 ["Set" Custom-set t]
19951 ["Save" Custom-save t]
19952 ["Reset to Current" Custom-reset-current t]
19953 ["Reset to Saved" Custom-reset-saved t]
19954 ["Reset to Standard Settings" Custom-reset-standard t]))
19956 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19958 ;;;; Miscellaneous stuff
19960 ;;; Generally useful functions
19962 (defun org-get-at-bol (property)
19963 "Get text property PROPERTY at beginning of line."
19964 (get-text-property (point-at-bol) property))
19966 (defun org-find-text-property-in-string (prop s)
19967 "Return the first non-nil value of property PROP in string S."
19968 (or (get-text-property 0 prop s)
19969 (get-text-property (or (next-single-property-change 0 prop s) 0)
19970 prop s)))
19972 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19973 "Display the given MESSAGE as a warning."
19974 (if (fboundp 'display-warning)
19975 (display-warning 'org message
19976 (if (featurep 'xemacs) 'warning :warning))
19977 (let ((buf (get-buffer-create "*Org warnings*")))
19978 (with-current-buffer buf
19979 (goto-char (point-max))
19980 (insert "Warning (Org): " message)
19981 (unless (bolp)
19982 (newline)))
19983 (display-buffer buf)
19984 (sit-for 0))))
19986 (defun org-eval (form)
19987 "Eval FORM and return result."
19988 (condition-case error
19989 (eval form)
19990 (error (format "%%![Error: %s]" error))))
19992 (defun org-in-clocktable-p ()
19993 "Check if the cursor is in a clocktable."
19994 (let ((pos (point)) start)
19995 (save-excursion
19996 (end-of-line 1)
19998 (setq start (match-beginning 0))
20000 (>= (match-end 0) pos)
20001 start))))
20003 (defun org-in-commented-line ()
20004 "Is point in a line starting with `#'?"
20005 (equal (char-after (point-at-bol)) ?#))
20007 (defun org-in-indented-comment-line ()
20008 "Is point in a line starting with `#' after some white space?"
20009 (save-excursion
20010 (save-match-data
20011 (goto-char (point-at-bol))
20014 (defun org-in-verbatim-emphasis ()
20015 (save-match-data
20016 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
20018 (defun org-goto-marker-or-bmk (marker &optional bookmark)
20019 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
20020 (if (and marker (marker-buffer marker)
20021 (buffer-live-p (marker-buffer marker)))
20022 (progn
20023 (org-pop-to-buffer-same-window (marker-buffer marker))
20024 (if (or (> marker (point-max)) (< marker (point-min)))
20025 (widen))
20026 (goto-char marker)
20027 (org-show-context 'org-goto))
20028 (if bookmark
20029 (bookmark-jump bookmark)
20030 (error "Cannot find location"))))
20032 (defun org-quote-csv-field (s)
20033 "Quote field for inclusion in CSV material."
20036 s))
20038 (defun org-force-self-insert (N)
20039 "Needed to enforce self-insert under remapping."
20040 (interactive "p")
20041 (self-insert-command N))
20043 (defun org-string-width (s)
20044 "Compute width of string, ignoring invisible characters.
20045 This ignores character with invisibility property `org-link', and also
20046 characters with property `org-cwidth', because these will become invisible
20047 upon the next fontification round."
20048 (let (b l)
20049 (when (or (eq t buffer-invisibility-spec)
20050 (assq 'org-link buffer-invisibility-spec))
20051 (while (setq b (text-property-any 0 (length s)
20052 'invisible 'org-link s))
20053 (setq s (concat (substring s 0 b)
20054 (substring s (or (next-single-property-change
20055 b 'invisible s) (length s)))))))
20056 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
20057 (setq s (concat (substring s 0 b)
20058 (substring s (or (next-single-property-change
20059 b 'org-cwidth s) (length s))))))
20060 (setq l (string-width s) b -1)
20061 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
20062 (setq l (- l (get-text-property b 'org-dwidth-n s))))
20063 l))
20065 (defun org-shorten-string (s maxlength)
20066 "Shorten string S so tht it is no longer than MAXLENGTH characters.
20067 If the string is shorter or has length MAXLENGTH, just return the
20068 original string. If it is longer, the functions finds a space in the
20069 string, breaks this string off at that locations and adds three dots
20070 as ellipsis. Including the ellipsis, the string will not be longer
20071 than MAXLENGTH. If finding a good breaking point in the string does
20072 not work, the string is just chopped off in the middle of a word
20073 if necessary."
20074 (if (<= (length s) maxlength)
20075 s
20076 (let* ((n (max (- maxlength 4) 1))
20078 (if (string-match re s)
20079 (concat (match-string 1 s) "...")
20080 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
20082 (defun org-get-indentation (&optional line)
20083 "Get the indentation of the current line, interpreting tabs.
20084 When LINE is given, assume it represents a line and compute its indentation."
20085 (if line
20086 (if (string-match "^ *" (org-remove-tabs line))
20087 (match-end 0))
20088 (save-excursion
20089 (beginning-of-line 1)
20091 (current-column))))
20093 (defun org-get-string-indentation (s)
20094 "What indentation has S due to SPACE and TAB at the beginning of the string?"
20095 (let ((n -1) (i 0) (w tab-width) c)
20096 (catch 'exit
20097 (while (< (setq n (1+ n)) (length s))
20098 (setq c (aref s n))
20099 (cond ((= c ?\ ) (setq i (1+ i)))
20101 (t (throw 'exit t)))))
20102 i))
20104 (defun org-remove-tabs (s &optional width)
20105 "Replace tabulators in S with spaces.
20106 Assumes that s is a single line, starting in column 0."
20107 (setq width (or width tab-width))
20109 (setq s (replace-match
20110 (make-string
20111 (- (* width (/ (+ (match-beginning 0) width) width))
20112 (match-beginning 0)) ?\ )
20113 t t s)))
20114 s)
20116 (defun org-fix-indentation (line ind)
20117 "Fix indentation in LINE.
20118 IND is a cons cell with target and minimum indentation.
20119 If the current indentation in LINE is smaller than the minimum,
20120 leave it alone. If it is larger than ind, set it to the target."
20121 (let* ((l (org-remove-tabs line))
20122 (i (org-get-indentation l))
20123 (i1 (car ind)) (i2 (cdr ind)))
20124 (if (>= i i2) (setq l (substring line i2)))
20125 (if (> i1 0)
20126 (concat (make-string i1 ?\ ) l)
20127 l)))
20129 (defun org-remove-indentation (code &optional n)
20130 "Remove the maximum common indentation from the lines in CODE.
20131 N may optionally be the number of spaces to remove."
20132 (with-temp-buffer
20133 (insert code)
20134 (org-do-remove-indentation n)
20135 (buffer-string)))
20137 (defun org-do-remove-indentation (&optional n)
20138 "Remove the maximum common indentation from the buffer."
20139 (untabify (point-min) (point-max))
20140 (let ((min 10000) re)
20141 (if n
20142 (setq min n)
20143 (goto-char (point-min))
20145 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
20146 (unless (or (= min 0) (= min 10000))
20148 (goto-char (point-min))
20149 (while (re-search-forward re nil t)
20150 (replace-match "")
20151 (end-of-line 1))
20152 min)))
20154 (defun org-fill-template (template alist)
20155 "Find each %key of ALIST in TEMPLATE and replace it."
20156 (let ((case-fold-search nil)
20157 entry key value)
20158 (setq alist (sort (copy-sequence alist)
20159 (lambda (a b) (< (length (car a)) (length (car b))))))
20160 (while (setq entry (pop alist))
20161 (setq template
20162 (replace-regexp-in-string
20163 (concat "%" (regexp-quote (car entry)))
20164 (or (cdr entry) "") template t t)))
20165 template))
20167 (defun org-base-buffer (buffer)
20168 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
20169 (if (not buffer)
20170 buffer
20171 (or (buffer-base-buffer buffer)
20172 buffer)))
20174 (defun org-trim (s)
20175 "Remove whitespace at beginning and end of string."
20178 s)
20180 (defun org-wrap (string &optional width lines)
20181 "Wrap string to either a number of lines, or a width in characters.
20182 If WIDTH is non-nil, the string is wrapped to that width, however many lines
20183 that costs. If there is a word longer than WIDTH, the text is actually
20184 wrapped to the length of that word.
20185 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
20186 many lines, whatever width that takes.
20187 The return value is a list of lines, without newlines at the end."
20189 (maxword (apply 'max (mapcar 'org-string-width words)))
20190 w ll)
20191 (cond (width
20192 (org-do-wrap words (max maxword width)))
20193 (lines
20194 (setq w maxword)
20195 (setq ll (org-do-wrap words maxword))
20196 (if (<= (length ll) lines)
20197 ll
20198 (setq ll words)
20199 (while (> (length ll) lines)
20200 (setq w (1+ w))
20201 (setq ll (org-do-wrap words w)))
20202 ll))
20203 (t (error "Cannot wrap this")))))
20205 (defun org-do-wrap (words width)
20206 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
20207 (let (lines line)
20208 (while words
20209 (setq line (pop words))
20210 (while (and words (< (+ (length line) (length (car words))) width))
20211 (setq line (concat line " " (pop words))))
20212 (setq lines (push line lines)))
20213 (nreverse lines)))
20215 (defun org-split-string (string &optional separators)
20216 "Splits STRING into substrings at SEPARATORS.
20217 No empty strings are returned if there are matches at the beginning
20218 and end of string."
20220 (start 0)
20221 notfirst
20222 (list nil))
20223 (while (and (string-match rexp string
20224 (if (and notfirst
20225 (= start (match-beginning 0))
20226 (< start (length string)))
20227 (1+ start) start))
20228 (< (match-beginning 0) (length string)))
20229 (setq notfirst t)
20230 (or (eq (match-beginning 0) 0)
20231 (and (eq (match-beginning 0) (match-end 0))
20232 (eq (match-beginning 0) start))
20233 (setq list
20234 (cons (substring string start (match-beginning 0))
20235 list)))
20236 (setq start (match-end 0)))
20237 (or (eq start (length string))
20238 (setq list
20239 (cons (substring string start)
20240 list)))
20241 (nreverse list)))
20243 (defun org-quote-vert (s)
20245 (while (string-match "|" s)
20247 s)
20249 (defun org-uuidgen-p (s)
20250 "Is S an ID created by UUIDGEN?"
20251 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
20253 (defun org-in-src-block-p (&optional inside)
20254 "Whether point is in a code source block.
20255 When INSIDE is non-nil, don't consider we are within a src block
20256 when point is at #+BEGIN_SRC or #+END_SRC."
20257 (let ((case-fold-search t) ov)
20258 (or (and (setq ov (overlays-at (point)))
20259 (memq 'org-block-background
20260 (overlay-properties (car ov))))
20261 (and (not inside)
20262 (save-match-data
20263 (save-excursion
20264 (beginning-of-line)
20267 (defun org-context ()
20268 "Return a list of contexts of the current cursor position.
20269 If several contexts apply, all are returned.
20270 Each context entry is a list with a symbol naming the context, and
20271 two positions indicating start and end of the context. Possible
20272 contexts are:
20274 :headline anywhere in a headline
20275 :headline-stars on the leading stars in a headline
20276 :todo-keyword on a TODO keyword (including DONE) in a headline
20277 :tags on the TAGS in a headline
20278 :priority on the priority cookie in a headline
20279 :item on the first line of a plain list item
20280 :item-bullet on the bullet/number of a plain list item
20281 :checkbox on the checkbox in a plain list item
20282 :table in an org-mode table
20283 :table-special on a special filed in a table
20284 :table-table in a table.el table
20285 :clocktable in a clocktable
20286 :src-block in a source block
20287 :link on a hyperlink
20288 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
20289 :target on a <<target>>
20290 :radio-target on a <<<radio-target>>>
20291 :latex-fragment on a LaTeX fragment
20292 :latex-preview on a LaTeX fragment with overlaid preview image
20294 This function expects the position to be visible because it uses font-lock
20295 faces as a help to recognize the following contexts: :table-special, :link,
20296 and :keyword."
20297 (let* ((f (get-text-property (point) 'face))
20298 (faces (if (listp f) f (list f)))
20299 (case-fold-search t)
20300 (p (point)) clist o)
20301 ;; First the large context
20302 (cond
20303 ((org-at-heading-p t)
20304 (push (list :headline (point-at-bol) (point-at-eol)) clist)
20305 (when (progn
20306 (beginning-of-line 1)
20307 (looking-at org-todo-line-tags-regexp))
20308 (push (org-point-in-group p 1 :headline-stars) clist)
20309 (push (org-point-in-group p 2 :todo-keyword) clist)
20310 (push (org-point-in-group p 4 :tags) clist))
20311 (goto-char p)
20314 (push (org-point-in-group p 0 :priority) clist)))
20316 ((org-at-item-p)
20317 (push (org-point-in-group p 2 :item-bullet) clist)
20318 (push (list :item (point-at-bol)
20319 (save-excursion (org-end-of-item) (point)))
20320 clist)
20321 (and (org-at-item-checkbox-p)
20322 (push (org-point-in-group p 0 :checkbox) clist)))
20324 ((org-at-table-p)
20325 (push (list :table (org-table-begin) (org-table-end)) clist)
20326 (if (memq 'org-formula faces)
20327 (push (list :table-special
20328 (previous-single-property-change p 'face)
20329 (next-single-property-change p 'face)) clist)))
20330 ((org-at-table-p 'any)
20331 (push (list :table-table) clist)))
20332 (goto-char p)
20334 (let ((case-fold-search t))
20335 ;; New the "medium" contexts: clocktables, source blocks
20336 (cond ((org-in-clocktable-p)
20337 (push (list :clocktable
20339 (search-backward "#+BEGIN: clocktable" nil t))
20340 (match-beginning 0))
20342 (match-end 0))) clist))
20343 ((org-in-src-block-p)
20344 (push (list :src-block
20346 (search-backward "#+BEGIN_SRC" nil t))
20347 (match-beginning 0))
20348 (and (search-forward "#+END_SRC" nil t)
20349 (match-beginning 0))) clist))))
20350 (goto-char p)
20352 ;; Now the small context
20353 (cond
20354 ((org-at-timestamp-p)
20355 (push (org-point-in-group p 0 :timestamp) clist))
20356 ((memq 'org-link faces)
20357 (push (list :link
20358 (previous-single-property-change p 'face)
20359 (next-single-property-change p 'face)) clist))
20360 ((memq 'org-special-keyword faces)
20361 (push (list :keyword
20362 (previous-single-property-change p 'face)
20363 (next-single-property-change p 'face)) clist))
20364 ((org-at-target-p)
20365 (push (org-point-in-group p 0 :target) clist)
20366 (goto-char (1- (match-beginning 0)))
20367 (if (looking-at org-radio-target-regexp)
20368 (push (org-point-in-group p 0 :radio-target) clist))
20369 (goto-char p))
20370 ((setq o (car (delq nil
20371 (mapcar
20372 (lambda (x)
20373 (if (memq x org-latex-fragment-image-overlays) x))
20374 (overlays-at (point))))))
20375 (push (list :latex-fragment
20376 (overlay-start o) (overlay-end o)) clist)
20377 (push (list :latex-preview
20378 (overlay-start o) (overlay-end o)) clist))
20379 ((org-inside-LaTeX-fragment-p)
20380 ;; FIXME: positions wrong.
20381 (push (list :latex-fragment (point) (point)) clist)))
20383 (setq clist (nreverse (delq nil clist)))
20384 clist))
20386 ;; FIXME: Compare with at-regexp-p Do we need both?
20387 (defun org-in-regexp (re &optional nlines visually)
20388 "Check if point is inside a match of regexp.
20389 Normally only the current line is checked, but you can include NLINES extra
20390 lines both before and after point into the search.
20391 If VISUALLY is set, require that the cursor is not after the match but
20392 really on, so that the block visually is on the match."
20393 (catch 'exit
20394 (let ((pos (point))
20395 (eol (point-at-eol (+ 1 (or nlines 0))))
20396 (inc (if visually 1 0)))
20397 (save-excursion
20398 (beginning-of-line (- 1 (or nlines 0)))
20399 (while (re-search-forward re eol t)
20400 (if (and (<= (match-beginning 0) pos)
20401 (>= (+ inc (match-end 0)) pos))
20402 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
20404 (defun org-at-regexp-p (regexp)
20405 "Is point inside a match of REGEXP in the current line?"
20406 (catch 'exit
20407 (save-excursion
20408 (let ((pos (point)) (end (point-at-eol)))
20409 (beginning-of-line 1)
20410 (while (re-search-forward regexp end t)
20411 (if (and (<= (match-beginning 0) pos)
20412 (>= (match-end 0) pos))
20413 (throw 'exit t)))
20414 nil))))
20416 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
20417 "Non-nil when point is between matches of START-RE and END-RE.
20419 Also return a non-nil value when point is on one of the matches.
20421 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
20422 buffer positions. Default values are the positions of headlines
20423 surrounding the point.
20425 The functions returns a cons cell whose car (resp. cdr) is the
20426 position before START-RE (resp. after END-RE)."
20427 (save-match-data
20428 (let ((pos (point))
20429 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
20430 (limit-down (or lim-down (save-excursion (outline-next-heading))))
20431 beg end)
20432 (save-excursion
20433 ;; Point is on a block when on START-RE or if START-RE can be
20434 ;; found before it...
20435 (and (or (org-at-regexp-p start-re)
20436 (re-search-backward start-re limit-up t))
20437 (setq beg (match-beginning 0))
20438 ;; ... and END-RE after it...
20439 (goto-char (match-end 0))
20440 (re-search-forward end-re limit-down t)
20441 (> (setq end (match-end 0)) pos)
20442 ;; ... without another START-RE in-between.
20443 (goto-char (match-beginning 0))
20444 (not (re-search-backward start-re (1+ beg) t))
20445 ;; Return value.
20446 (cons beg end))))))
20448 (defun org-in-block-p (names)
20449 "Non-nil when point belongs to a block whose name belongs to NAMES.
20451 NAMES is a list of strings containing names of blocks.
20453 Return first block name matched, or nil. Beware that in case of
20454 nested blocks, the returned name may not belong to the closest
20455 block from point."
20456 (save-match-data
20457 (catch 'exit
20458 (let ((case-fold-search t)
20459 (lim-up (save-excursion (outline-previous-heading)))
20460 (lim-down (save-excursion (outline-next-heading))))
20461 (mapc (lambda (name)
20462 (let ((n (regexp-quote name)))
20463 (when (org-between-regexps-p
20466 lim-up lim-down)
20467 (throw 'exit n))))
20468 names))
20469 nil)))
20471 (defun org-occur-in-agenda-files (regexp &optional nlines)
20472 "Call `multi-occur' with buffers for all agenda files."
20474 (let* ((files (org-agenda-files))
20475 (tnames (mapcar 'file-truename files))
20476 (extra org-agenda-text-search-extra-files)
20477 f)
20478 (when (eq (car extra) 'agenda-archives)
20479 (setq extra (cdr extra))
20480 (setq files (org-add-archive-files files)))
20481 (while (setq f (pop extra))
20482 (unless (member (file-truename f) tnames)
20483 (add-to-list 'files f 'append)
20484 (add-to-list 'tnames (file-truename f) 'append)))
20485 (multi-occur
20486 (mapcar (lambda (x)
20487 (with-current-buffer
20488 (or (get-file-buffer x) (find-file-noselect x))
20489 (widen)
20490 (current-buffer)))
20491 files)
20492 regexp)))
20494 (if (boundp 'occur-mode-find-occurrence-hook)
20495 ;; Emacs 23
20496 (add-hook 'occur-mode-find-occurrence-hook
20497 (lambda ()
20498 (when (derived-mode-p 'org-mode)
20499 (org-reveal))))
20500 ;; Emacs 22
20501 (defadvice occur-mode-goto-occurrence
20502 (after org-occur-reveal activate)
20503 (and (derived-mode-p 'org-mode) (org-reveal)))
20504 (defadvice occur-mode-goto-occurrence-other-window
20505 (after org-occur-reveal activate)
20506 (and (derived-mode-p 'org-mode) (org-reveal)))
20507 (defadvice occur-mode-display-occurrence
20508 (after org-occur-reveal activate)
20509 (when (derived-mode-p 'org-mode)
20510 (let ((pos (occur-mode-find-occurrence)))
20511 (with-current-buffer (marker-buffer pos)
20512 (save-excursion
20513 (goto-char pos)
20514 (org-reveal)))))))
20516 (defun org-occur-link-in-agenda-files ()
20517 "Create a link and search for it in the agendas.
20518 The link is not stored in `org-stored-links', it is just created
20519 for the search purpose."
20520 (interactive)
20521 (let ((link (condition-case nil
20522 (org-store-link nil)
20523 (error "Unable to create a link to here"))))
20524 (org-occur-in-agenda-files (regexp-quote link))))
20526 (defun org-uniquify (list)
20527 "Remove duplicate elements from LIST."
20528 (let (res)
20529 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
20530 res))
20532 (defun org-delete-all (elts list)
20533 "Remove all elements in ELTS from LIST."
20534 (while elts
20535 (setq list (delete (pop elts) list)))
20536 list)
20538 (defun org-count (cl-item cl-seq)
20539 "Count the number of occurrences of ITEM in SEQ.
20540 Taken from `count' in cl-seq.el with all keyword arguments removed."
20541 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
20542 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
20543 (while (< cl-start cl-end)
20544 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
20545 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
20546 (setq cl-start (1+ cl-start)))
20547 cl-count))
20549 (defun org-remove-if (predicate seq)
20550 "Remove everything from SEQ that fulfills PREDICATE."
20551 (let (res e)
20552 (while seq
20553 (setq e (pop seq))
20554 (if (not (funcall predicate e)) (push e res)))
20555 (nreverse res)))
20557 (defun org-remove-if-not (predicate seq)
20558 "Remove everything from SEQ that does not fulfill PREDICATE."
20559 (let (res e)
20560 (while seq
20561 (setq e (pop seq))
20562 (if (funcall predicate e) (push e res)))
20563 (nreverse res)))
20565 (defun org-reduce (cl-func cl-seq &rest cl-keys)
20566 "Reduce two-argument FUNCTION across SEQ.
20567 Taken from `reduce' in cl-seq.el with all keyword arguments but
20569 (let ((cl-accum (cond ((memq :initial-value cl-keys)
20570 (cadr (memq :initial-value cl-keys)))
20571 (cl-seq (pop cl-seq))
20572 (t (funcall cl-func)))))
20573 (while cl-seq
20574 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
20575 cl-accum))
20577 (defun org-back-over-empty-lines ()
20578 "Move backwards over whitespace, to the beginning of the first empty line.
20579 Returns the number of empty lines passed."
20580 (let ((pos (point)))
20581 (if (cdr (assoc 'heading org-blank-before-new-entry))
20583 (unless (eobp)
20584 (forward-line -1)))
20585 (beginning-of-line 2)
20586 (goto-char (min (point) pos))
20587 (count-lines (point) pos)))
20589 (defun org-skip-whitespace ()
20592 (defun org-point-in-group (point group &optional context)
20593 "Check if POINT is in match-group GROUP.
20594 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
20595 match. If the match group does not exist or point is not inside it,
20596 return nil."
20597 (and (match-beginning group)
20598 (>= point (match-beginning group))
20599 (<= point (match-end group))
20600 (if context
20601 (list context (match-beginning group) (match-end group))
20602 t)))
20604 (defun org-switch-to-buffer-other-window (&rest args)
20605 "Switch to buffer in a second window on the current frame.
20606 In particular, do not allow pop-up frames.
20607 Returns the newly created buffer."
20608 (org-no-popups
20609 (apply 'switch-to-buffer-other-window args)))
20611 (defun org-combine-plists (&rest plists)
20612 "Create a single property list from all plists in PLISTS.
20613 The process starts by copying the first list, and then setting properties
20614 from the other lists. Settings in the last list are the most significant
20615 ones and overrule settings in the other lists."
20616 (let ((rtn (copy-sequence (pop plists)))
20617 p v ls)
20618 (while plists
20619 (setq ls (pop plists))
20620 (while ls
20621 (setq p (pop ls) v (pop ls))
20622 (setq rtn (plist-put rtn p v))))
20623 rtn))
20625 (defun org-replace-escapes (string table)
20626 "Replace %-escapes in STRING with values in TABLE.
20628 The sequences in STRING may contain normal field width and padding information,
20630 so values can contain further %-escapes if they are define later in TABLE."
20631 (let ((tbl (copy-alist table))
20632 (case-fold-search nil)
20633 (pchg 0)
20634 e re rpl)
20635 (while (setq e (pop tbl))
20636 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20637 (when (and (cdr e) (string-match re (cdr e)))
20638 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20639 (safe "SREF"))
20640 (add-text-properties 0 3 (list 'sref sref) safe)
20641 (setcdr e (replace-match safe t t (cdr e)))))
20642 (while (string-match re string)
20643 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20644 (cdr e)))
20645 (setq string (replace-match rpl t t string))))
20646 (while (setq pchg (next-property-change pchg string))
20647 (let ((sref (get-text-property pchg 'sref string)))
20648 (when (and sref (string-match "SREF" string pchg))
20649 (setq string (replace-match sref t t string)))))
20650 string))
20652 (defun org-sublist (list start end)
20653 "Return a section of LIST, from START to END.
20654 Counting starts at 1."
20655 (let (rtn (c start))
20656 (setq list (nthcdr (1- start) list))
20657 (while (and list (<= c end))
20658 (push (pop list) rtn)
20659 (setq c (1+ c)))
20660 (nreverse rtn)))
20662 (defun org-find-base-buffer-visiting (file)
20663 "Like `find-buffer-visiting' but always return the base buffer and
20664 not an indirect buffer."
20665 (let ((buf (or (get-file-buffer file)
20666 (find-buffer-visiting file))))
20667 (if buf
20668 (or (buffer-base-buffer buf) buf)
20669 nil)))
20671 (defun org-image-file-name-regexp (&optional extensions)
20672 "Return regexp matching the file names of images.
20673 If EXTENSIONS is given, only match these."
20674 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20675 (image-file-name-regexp)
20676 (let ((image-file-name-extensions
20677 (or extensions
20678 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20679 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20681 (regexp-opt (nconc (mapcar 'upcase
20682 image-file-name-extensions)
20683 image-file-name-extensions)
20684 t)
20687 (defun org-file-image-p (file &optional extensions)
20688 "Return non-nil if FILE is an image."
20689 (save-match-data
20690 (string-match (org-image-file-name-regexp extensions) file)))
20692 (defun org-get-cursor-date ()
20693 "Return the date at cursor in as a time.
20694 This works in the calendar and in the agenda, anywhere else it just
20695 returns the current time."
20696 (let (date day defd)
20697 (cond
20698 ((eq major-mode 'calendar-mode)
20699 (setq date (calendar-cursor-to-date)
20700 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20701 ((eq major-mode 'org-agenda-mode)
20702 (setq day (get-text-property (point) 'day))
20703 (if day
20704 (setq date (calendar-gregorian-from-absolute day)
20705 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20706 (nth 2 date))))))
20707 (or defd (current-time))))
20709 (defun org-mark-subtree (&optional up)
20710 "Mark the current subtree.
20711 This puts point at the start of the current subtree, and mark at
20712 the end. If a numeric prefix UP is given, move up into the
20713 hierarchy of headlines by UP levels before marking the subtree."
20714 (interactive "P")
20715 (org-with-limited-levels
20716 (cond ((org-at-heading-p) (beginning-of-line))
20717 ((org-before-first-heading-p) (error "Not in a subtree"))
20718 (t (outline-previous-visible-heading 1))))
20719 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
20720 (if (org-called-interactively-p 'any)
20721 (call-interactively 'org-mark-element)
20722 (org-mark-element)))
20724 ;;; Indentation
20726 (defun org-indent-line ()
20727 "Indent line depending on context."
20728 (interactive)
20729 (let* ((pos (point))
20730 (itemp (org-at-item-p))
20731 (case-fold-search t)
20733 (inline-task-p (and (featurep 'org-inlinetask)
20734 (org-inlinetask-in-task-p)))
20735 (inline-re (and inline-task-p
20736 (org-inlinetask-outline-regexp)))
20737 column)
20738 (if (and orgstruct-is-++ (eq pos (point)))
20739 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
20740 (indent-according-to-mode))
20741 (beginning-of-line 1)
20742 (cond
20743 ;; Headings
20744 ((looking-at org-outline-regexp) (setq column 0))
20745 ;; Included files
20747 ;; Footnote definition
20748 ((looking-at org-footnote-definition-re) (setq column 0))
20749 ;; Literal examples
20751 (setq column (org-get-indentation))) ; do nothing
20752 ;; Lists
20753 ((ignore-errors (goto-char (org-in-item-p)))
20754 (setq column (if itemp
20755 (org-get-indentation)
20756 (org-list-item-body-column (point))))
20757 (goto-char pos))
20758 ;; Drawers
20760 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20761 (save-excursion
20762 (goto-char (1- (match-beginning 1)))
20763 (setq column (current-column))))
20764 ;; Special blocks
20766 (save-excursion
20767 (re-search-backward
20769 (setq column (org-get-indentation (match-string 0))))
20772 (save-excursion
20774 (setq column
20775 (cond ((equal (downcase (match-string 1)) "src")
20776 ;; src blocks: let `org-edit-src-exit' handle them
20777 (org-get-indentation))
20778 ((equal (downcase (match-string 1)) "example")
20779 (max (org-get-indentation)
20780 (org-get-indentation (match-string 0))))
20781 (t
20782 (org-get-indentation (match-string 0))))))
20783 ;; This line has nothing special, look at the previous relevant
20784 ;; line to compute indentation
20785 (t
20786 (beginning-of-line 0)
20787 (while (and (not (bobp))
20788 (not (looking-at org-drawer-regexp))
20789 ;; When point started in an inline task, do not move
20790 ;; above task starting line.
20791 (not (and inline-task-p (looking-at inline-re)))
20792 ;; Skip drawers, blocks, empty lines, verbatim,
20793 ;; comments, tables, footnotes definitions, lists,
20794 ;; inline tasks.
20796 (re-search-backward org-drawer-regexp nil t))
20800 (looking-at org-footnote-definition-re)
20801 (and (ignore-errors (goto-char (org-in-item-p)))
20802 (goto-char
20803 (org-list-get-top-point (org-list-struct))))
20804 (and (not inline-task-p)
20805 (featurep 'org-inlinetask)
20806 (org-inlinetask-in-task-p)
20807 (or (org-inlinetask-goto-beginning) t))))
20808 (beginning-of-line 0))
20809 (cond
20810 ;; There was an heading above.
20812 (if (not org-adapt-indentation)
20813 (setq column 0)
20814 (goto-char (match-end 0))
20815 (setq column (current-column))))
20816 ;; A drawer had started and is unfinished
20817 ((looking-at org-drawer-regexp)
20818 (goto-char (1- (match-beginning 1)))
20819 (setq column (current-column)))
20820 ;; Else, nothing noticeable found: get indentation and go on.
20821 (t (setq column (org-get-indentation))))))
20822 ;; Now apply indentation and move cursor accordingly
20823 (goto-char pos)
20824 (if (<= (current-column) (current-indentation))
20825 (org-indent-line-to column)
20826 (save-excursion (org-indent-line-to column)))
20827 ;; Special polishing for properties, see `org-property-format'
20828 (setq column (current-column))
20829 (beginning-of-line 1)
20830 (if (looking-at
20832 (replace-match (concat (match-string 1)
20833 (format org-property-format
20834 (match-string 2) (match-string 3)))
20835 t t))
20836 (org-move-to-column column))))
20838 (defun org-indent-drawer ()
20839 "Indent the drawer at point."
20840 (interactive)
20841 (let ((p (point))
20842 (e (and (save-excursion (re-search-forward ":END:" nil t))
20843 (match-end 0)))
20844 (folded
20845 (save-excursion
20846 (end-of-line)
20847 (when (overlays-at (point))
20848 (member 'invisible (overlay-properties
20849 (car (overlays-at (point)))))))))
20850 (when folded (org-cycle))
20851 (indent-for-tab-command)
20852 (while (and (move-beginning-of-line 2) (< (point) e))
20853 (indent-for-tab-command))
20854 (goto-char p)
20855 (when folded (org-cycle)))
20856 (message "Drawer at point indented"))
20858 (defun org-indent-block ()
20859 "Indent the block at point."
20860 (interactive)
20861 (let ((p (point))
20862 (case-fold-search t)
20864 (match-end 0)))
20865 (folded
20866 (save-excursion
20867 (end-of-line)
20868 (when (overlays-at (point))
20869 (member 'invisible (overlay-properties
20870 (car (overlays-at (point)))))))))
20871 (when folded (org-cycle))
20872 (indent-for-tab-command)
20873 (while (and (move-beginning-of-line 2) (< (point) e))
20874 (indent-for-tab-command))
20875 (goto-char p)
20876 (when folded (org-cycle)))
20877 (message "Block at point indented"))
20879 (defun org-indent-region (start end)
20880 "Indent region."
20881 (interactive "r")
20882 (save-excursion
20883 (let ((line-end (org-current-line end)))
20884 (goto-char start)
20885 (while (< (org-current-line) line-end)
20886 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
20887 (t (call-interactively 'org-indent-line)))
20888 (move-beginning-of-line 2)))))
20891 ;;; Filling
20893 ;; We use our own fill-paragraph and auto-fill functions.
20895 ;; `org-fill-paragraph' relies on adaptive filling and context
20896 ;; checking. Appropriate `fill-prefix' is computed with
20897 ;; `org-adaptive-fill-function'.
20899 ;; `org-auto-fill-function' takes care of auto-filling. It calls
20900 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
20901 ;; `org-adaptive-fill-function' value. Internally,
20902 ;; `org-comment-line-break-function' breaks the line.
20904 ;; `org-setup-filling' installs filling and auto-filling related
20905 ;; variables during `org-mode' initialization.
20907 (defun org-setup-filling ()
20908 (interactive)
20909 ;; Prevent auto-fill from inserting unwanted new items.
20910 (when (boundp 'fill-nobreak-predicate)
20911 (org-set-local
20912 'fill-nobreak-predicate
20913 (org-uniquify
20914 (append fill-nobreak-predicate
20915 '(org-fill-paragraph-separate-nobreak-p
20916 org-fill-line-break-nobreak-p)))))
20917 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20918 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
20919 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20920 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
20922 (defvar org-element-paragraph-separate) ; org-element.el
20923 (defun org-fill-paragraph-separate-nobreak-p ()
20924 "Non-nil when a line break at point would insert a new item."
20925 (looking-at (substring org-element-paragraph-separate 1)))
20927 (defun org-fill-line-break-nobreak-p ()
20928 "Non-nil when a line break at point would create an Org line break."
20929 (save-excursion
20934 (declare-function message-in-body-p "message" ())
20935 (defvar org-element--affiliated-re) ; From org-element.el
20936 (defun org-adaptive-fill-function ()
20937 "Compute a fill prefix for the current line.
20938 Return fill prefix, as a string, or nil if current line isn't
20939 meant to be filled."
20940 (org-with-wide-buffer
20941 (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
20942 ;; FIXME: This is really the job of orgstruct++-mode
20943 (let* ((p (line-beginning-position))
20944 (element (save-excursion (beginning-of-line)
20945 (org-element-at-point)))
20946 (type (org-element-type element))
20947 (post-affiliated
20948 (save-excursion
20949 (goto-char (org-element-property :begin element))
20950 (while (looking-at org-element--affiliated-re) (forward-line))
20951 (point))))
20952 (unless (< p post-affiliated)
20953 (case type
20955 (footnote-definition "")
20956 ((item plain-list)
20957 (make-string (org-list-item-body-column post-affiliated) ? ))
20958 (paragraph
20959 ;; Fill prefix is usually the same as the current line,
20960 ;; except if the paragraph is at the beginning of an item.
20961 (let ((parent (org-element-property :parent element)))
20962 (cond ((eq (org-element-type parent) 'item)
20963 (make-string (org-list-item-body-column
20964 (org-element-property :begin parent))
20965 ? ))
20967 (match-string 0))
20968 (t ""))))
20969 (comment-block
20970 ;; Only fill contents if P is within block boundaries.
20971 (let* ((cbeg (save-excursion (goto-char post-affiliated)
20972 (forward-line)
20973 (point)))
20974 (cend (save-excursion
20975 (goto-char (org-element-property :end element))
20977 (line-beginning-position))))
20978 (when (and (>= p cbeg) (< p cend))
20980 (match-string 0)
20981 ""))))))))))
20983 (declare-function message-goto-body "message" ())
20984 (defvar message-cite-prefix-regexp) ; From message.el
20985 (defvar org-element-all-objects) ; From org-element.el
20986 (defun org-fill-paragraph (&optional justify)
20987 "Fill element at point, when applicable.
20989 This function only applies to comment blocks, comments, example
20990 blocks and paragraphs. Also, as a special case, re-align table
20991 when point is at one.
20993 If JUSTIFY is non-nil (interactively, with prefix argument),
20994 justify as well. If `sentence-end-double-space' is non-nil, then
20995 period followed by one space does not end a sentence, so don't
20996 break a line there. The variable `fill-column' controls the
20997 width for filling.
20999 For convenience, when point is at a plain list, an item or
21000 a footnote definition, try to fill the first paragraph within."
21001 (interactive)
21002 (if (and (derived-mode-p 'message-mode)
21003 (or (not (message-in-body-p))
21004 (save-excursion (move-beginning-of-line 1)
21005 (looking-at message-cite-prefix-regexp))))
21006 ;; First ensure filling is correct in message-mode.
21007 (let ((fill-paragraph-function
21008 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
21009 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
21010 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
21011 (paragraph-separate
21012 (cadadr (assoc 'paragraph-separate org-fb-vars))))
21013 (fill-paragraph nil))
21014 (save-excursion
21015 ;; Move to end of line in order to get the first paragraph
21016 ;; within a plain list or a footnote definition.
21017 (end-of-line)
21018 (let ((element (org-element-at-point)))
21019 ;; First check if point is in a blank line at the beginning of
21020 ;; the buffer. In that case, ignore filling.
21021 (if (< (point) (org-element-property :begin element)) t
21022 (case (org-element-type element)
21023 ;; Use major mode filling function is src blocks.
21024 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
21025 ;; Align Org tables, leave table.el tables as-is.
21026 (table-row (org-table-align) t)
21027 (table
21028 (when (eq (org-element-property :type element) 'org)
21029 (org-table-align))
21030 t)
21031 (paragraph
21032 ;; Paragraphs may contain `line-break' type objects.
21033 (let ((beg (max (point-min)
21034 (org-element-property :contents-begin element)))
21035 (end (min (point-max)
21036 (org-element-property :contents-end element))))
21037 ;; Do nothing if point is at an affiliated keyword.
21038 (if (< (point) beg) t
21039 (when (derived-mode-p 'message-mode)
21040 ;; In `message-mode', do not fill following
21041 ;; citation in current paragraph nor text before
21042 ;; message body.
21043 (let ((body-start (save-excursion (message-goto-body))))
21044 (when body-start (setq beg (max body-start beg))))
21045 (when (save-excursion
21046 (re-search-forward
21047 (concat "^" message-cite-prefix-regexp) end t))
21048 (setq end (match-beginning 0))))
21049 ;; Fill paragraph, taking line breaks into
21050 ;; consideration. For that, slice the paragraph
21051 ;; using line breaks as separators, and fill the
21052 ;; parts in reverse order to avoid messing with
21053 ;; markers.
21054 (save-excursion
21055 (goto-char end)
21056 (mapc
21057 (lambda (pos)
21058 (fill-region-as-paragraph pos (point) justify)
21059 (goto-char pos))
21060 ;; Find the list of ending positions for line
21061 ;; breaks in the current paragraph. Add paragraph
21062 ;; beginning to include first slice.
21063 (nreverse
21064 (cons
21065 beg
21066 (org-element-map
21067 (org-element--parse-objects
21068 beg end nil org-element-all-objects)
21069 'line-break
21070 (lambda (lb) (org-element-property :end lb)))))))
21071 t)))
21072 ;; Contents of `comment-block' type elements should be
21073 ;; filled as plain text, but only if point is within block
21074 ;; markers.
21075 (comment-block
21076 (let* ((case-fold-search t)
21077 (beg (save-excursion
21078 (goto-char (org-element-property :begin element))
21080 (forward-line)
21081 (point)))
21082 (end (save-excursion
21083 (goto-char (org-element-property :end element))
21085 (line-beginning-position))))
21086 (when (and (>= (point) beg) (< (point) end))
21087 (fill-region-as-paragraph
21088 (save-excursion
21089 (end-of-line)
21091 (line-beginning-position))
21092 (save-excursion
21093 (beginning-of-line)
21095 (line-beginning-position))
21096 justify)))
21097 t)
21098 ;; Fill comments.
21099 (comment (fill-comment-paragraph justify))
21100 ;; Ignore every other element.
21101 (otherwise t)))))))
21103 (defun org-auto-fill-function ()
21104 "Auto-fill function."
21105 ;; Check if auto-filling is meaningful.
21106 (let ((fc (current-fill-column)))
21107 (when (and fc (> (current-column) fc))
21108 (let* ((fill-prefix (org-adaptive-fill-function))
21109 ;; Enforce empty fill prefix, if required. Otherwise, it
21110 ;; will be computed again.
21111 (adaptive-fill-mode (not (equal fill-prefix ""))))
21112 (when fill-prefix (do-auto-fill))))))
21114 (defun org-comment-line-break-function (&optional soft)
21115 "Break line at point and indent, continuing comment if within one.
21116 The inserted newline is marked hard if variable
21117 `use-hard-newlines' is true, unless optional argument SOFT is
21118 non-nil."
21120 (save-excursion (forward-char -1) (delete-horizontal-space))
21121 (delete-horizontal-space)
21122 (indent-to-left-margin)
21123 (insert-before-markers-and-inherit fill-prefix))
21126 ;;; Comments
21128 ;; Org comments syntax is quite complex. It requires the entire line
21129 ;; to be just a comment. Also, even with the right syntax at the
21130 ;; beginning of line, some some elements (i.e. verse-block or
21131 ;; example-block) don't accept comments. Usual Emacs comment commands
21132 ;; cannot cope with those requirements. Therefore, Org replaces them.
21134 ;; Org still relies on `comment-dwim', but cannot trust
21135 ;; `comment-only-p'. So, `comment-region-function' and
21136 ;; `uncomment-region-function' both point
21137 ;; to`org-comment-or-uncomment-region'. Eventually,
21138 ;; `org-insert-comment' takes care of insertion of comments at the
21139 ;; beginning of line.
21141 ;; `org-setup-comments-handling' install comments related variables
21142 ;; during `org-mode' initialization.
21144 (defun org-setup-comments-handling ()
21145 (interactive)
21146 (org-set-local 'comment-use-syntax nil)
21147 (org-set-local 'comment-start "# ")
21149 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
21150 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
21151 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
21153 (defun org-insert-comment ()
21154 "Insert an empty comment above current line.
21155 If the line is empty, insert comment at its beginning."
21156 (beginning-of-line)
21158 (org-indent-line)
21159 (insert "# "))
21161 (defvar comment-empty-lines) ; From newcomment.el.
21162 (defun org-comment-or-uncomment-region (beg end &rest ignore)
21163 "Comment or uncomment each non-blank line in the region.
21164 Uncomment each non-blank line between BEG and END if it only
21165 contains commented lines. Otherwise, comment them."
21166 (save-restriction
21167 ;; Restrict region
21168 (narrow-to-region (save-excursion (goto-char beg)
21170 (line-beginning-position))
21171 (save-excursion (goto-char end)
21173 (line-end-position)))
21174 (let ((uncommentp
21175 ;; UNCOMMENTP is non-nil when every non blank line between
21176 ;; BEG and END is a comment.
21177 (save-excursion
21178 (goto-char (point-min))
21179 (while (and (not (eobp))
21180 (let ((element (org-element-at-point)))
21181 (and (eq (org-element-type element) 'comment)
21182 (goto-char (min (point-max)
21183 (org-element-property
21184 :end element)))))))
21185 (eobp))))
21186 (if uncommentp
21187 ;; Only blank lines and comments in region: uncomment it.
21188 (save-excursion
21189 (goto-char (point-min))
21190 (while (not (eobp))
21192 (replace-match "" nil nil nil 1))
21193 (forward-line)))
21194 ;; Comment each line in region.
21195 (let ((min-indent (point-max)))
21196 ;; First find the minimum indentation across all lines.
21197 (save-excursion
21198 (goto-char (point-min))
21199 (while (and (not (eobp)) (not (zerop min-indent)))
21201 (setq min-indent (min min-indent (current-indentation))))
21202 (forward-line)))
21203 ;; Then loop over all lines.
21204 (save-excursion
21205 (goto-char (point-min))
21206 (while (not (eobp))
21208 (org-move-to-column min-indent t)
21209 (insert comment-start))
21210 (forward-line))))))))
21213 ;;; Other stuff.
21215 (defun org-toggle-fixed-width-section (arg)
21216 "Toggle the fixed-width export.
21217 If there is no active region, the QUOTE keyword at the current headline is
21218 inserted or removed. When present, it causes the text between this headline
21219 and the next to be exported as fixed-width text, and unmodified.
21220 If there is an active region, this command adds or removes a colon as the
21221 first character of this line. If the first character of a line is a colon,
21222 this line is also exported in fixed-width font."
21223 (interactive "P")
21224 (let* ((cc 0)
21225 (regionp (org-region-active-p))
21226 (beg (if regionp (region-beginning) (point)))
21227 (end (if regionp (region-end)))
21228 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
21229 (case-fold-search nil)
21231 off)
21232 (if regionp
21233 (save-excursion
21234 (goto-char beg)
21235 (setq cc (current-column))
21236 (beginning-of-line 1)
21237 (setq off (looking-at re))
21238 (while (> nlines 0)
21239 (setq nlines (1- nlines))
21240 (beginning-of-line 1)
21241 (cond
21242 (arg
21243 (org-move-to-column cc t)
21245 (forward-line -1))
21246 ((and off (looking-at re))
21247 (replace-match "" t t nil 1))
21248 ((not off) (org-move-to-column cc t) (insert ": ")))
21249 (forward-line 1)))
21250 (save-excursion
21251 (org-back-to-heading)
21252 (cond
21253 ((looking-at (format org-heading-keyword-regexp-format
21254 org-quote-string))
21255 (goto-char (match-end 1))
21256 (looking-at (concat " +" org-quote-string))
21257 (replace-match "" t t)
21258 (when (eolp) (insert " ")))
21259 ((looking-at org-outline-regexp)
21260 (goto-char (match-end 0))
21261 (insert org-quote-string " ")))))))
21263 (defun org-reftex-citation ()
21264 "Use reftex-citation to insert a citation into the buffer.
21265 This looks for a line like
21267 #+BIBLIOGRAPHY: foo plain option:-d
21269 and derives from it that foo.bib is the bibliography file relevant
21270 for this document. It then installs the necessary environment for RefTeX
21271 to work in this buffer and calls `reftex-citation' to insert a citation
21272 into the buffer.
21274 Export of such citations to both LaTeX and HTML is handled by the contributed
21275 package org-exp-bibtex by Taru Karttunen."
21276 (interactive)
21277 (let ((reftex-docstruct-symbol 'rds)
21279 rds bib)
21280 (save-excursion
21281 (save-restriction
21282 (widen)
21283 (let ((case-fold-search t)
21285 (if (not (save-excursion
21286 (or (re-search-forward re nil t)
21287 (re-search-backward re nil t))))
21288 (error "No bibliography defined in file")
21289 (setq bib (concat (match-string 1) ".bib")
21290 rds (list (list 'bib bib)))))))
21291 (call-interactively 'reftex-citation)))
21293 ;;;; Functions extending outline functionality
21295 (defun org-beginning-of-line (&optional arg)
21296 "Go to the beginning of the current line. If that is invisible, continue
21297 to a visible line beginning. This makes the function of C-a more intuitive.
21298 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
21299 first attempt, and only move to after the tags when the cursor is already
21300 beyond the end of the headline."
21301 (interactive "P")
21302 (let ((pos (point))
21303 (special (if (consp org-special-ctrl-a/e)
21304 (car org-special-ctrl-a/e)
21305 org-special-ctrl-a/e))
21306 refpos)
21307 (if (org-bound-and-true-p visual-line-mode)
21308 (beginning-of-visual-line 1)
21309 (beginning-of-line 1))
21310 (if (and arg (fboundp 'move-beginning-of-line))
21311 (call-interactively 'move-beginning-of-line)
21312 (if (bobp)
21313 nil
21314 (backward-char 1)
21315 (if (org-truely-invisible-p)
21316 (while (and (not (bobp)) (org-truely-invisible-p))
21317 (backward-char 1)
21318 (beginning-of-line 1))
21319 (forward-char 1))))
21320 (when special
21321 (cond
21322 ((and (looking-at org-complex-heading-regexp)
21323 (= (char-after (match-end 1)) ?\ ))
21324 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
21325 (point-at-eol)))
21326 (goto-char
21327 (if (eq special t)
21328 (cond ((> pos refpos) refpos)
21329 ((= pos (point)) refpos)
21330 (t (point)))
21331 (cond ((> pos (point)) (point))
21332 ((not (eq last-command this-command)) (point))
21333 (t refpos)))))
21334 ((org-at-item-p)
21335 ;; Being at an item and not looking at an the item means point
21336 ;; was previously moved to beginning of a visual line, which
21337 ;; doesn't contain the item. Therefore, do nothing special,
21338 ;; just stay here.
21339 (when (looking-at org-list-full-item-re)
21340 ;; Set special position at first white space character after
21341 ;; bullet, and check-box, if any.
21342 (let ((after-bullet
21343 (let ((box (match-end 3)))
21344 (if (not box) (match-end 1)
21345 (let ((after (char-after box)))
21346 (if (and after (= after ? )) (1+ box) box))))))
21347 ;; Special case: Move point to special position when
21348 ;; currently after it or at beginning of line.
21349 (if (eq special t)
21350 (when (or (> pos after-bullet) (= (point) pos))
21351 (goto-char after-bullet))
21352 ;; Reversed case: Move point to special position when
21353 ;; point was already at beginning of line and command is
21354 ;; repeated.
21355 (when (and (= (point) pos) (eq last-command this-command))
21356 (goto-char after-bullet))))))))
21357 (org-no-warnings
21358 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21360 (defun org-end-of-line (&optional arg)
21361 "Go to the end of the line.
21362 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
21363 tags on the first attempt, and only move to after the tags when
21364 the cursor is already beyond the end of the headline."
21365 (interactive "P")
21366 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
21367 org-special-ctrl-a/e))
21368 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
21369 'end-of-visual-line)
21370 ((fboundp 'move-end-of-line) 'move-end-of-line)
21371 (t 'end-of-line))))
21372 (if (or (not special) arg) (call-interactively move-fun)
21373 (let* ((element (save-excursion (beginning-of-line)
21374 (org-element-at-point)))
21375 (type (org-element-type element)))
21376 (cond
21377 ((memq type '(headline inlinetask))
21378 (let ((pos (point)))
21379 (beginning-of-line 1)
21381 (if (eq special t)
21382 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
21383 (goto-char (match-beginning 1))
21384 (goto-char (match-end 0)))
21385 (if (or (< pos (match-end 0))
21386 (not (eq this-command last-command)))
21387 (goto-char (match-end 0))
21388 (goto-char (match-beginning 1))))
21389 (call-interactively move-fun))))
21390 ((org-element-property :hiddenp element)
21391 ;; If element is hidden, `move-end-of-line' would put point
21392 ;; after it. Use `end-of-line' to stay on current line.
21393 (call-interactively 'end-of-line))
21394 (t (call-interactively move-fun)))))
21395 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21397 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
21398 (define-key org-mode-map "\C-e" 'org-end-of-line)
21400 (defun org-backward-sentence (&optional arg)
21401 "Go to beginning of sentence, or beginning of table field.
21402 This will call `backward-sentence' or `org-table-beginning-of-field',
21403 depending on context."
21404 (interactive "P")
21405 (cond
21406 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
21407 (t (call-interactively 'backward-sentence))))
21409 (defun org-forward-sentence (&optional arg)
21410 "Go to end of sentence, or end of table field.
21411 This will call `forward-sentence' or `org-table-end-of-field',
21412 depending on context."
21413 (interactive "P")
21414 (cond
21415 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
21416 (t (call-interactively 'forward-sentence))))
21418 (define-key org-mode-map "\M-a" 'org-backward-sentence)
21419 (define-key org-mode-map "\M-e" 'org-forward-sentence)
21421 (defun org-kill-line (&optional arg)
21422 "Kill line, to tags or end of line."
21423 (interactive "P")
21424 (cond
21425 ((or (not org-special-ctrl-k)
21426 (bolp)
21427 (not (org-at-heading-p)))
21428 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
21429 org-ctrl-k-protect-subtree)
21430 (if (or (eq org-ctrl-k-protect-subtree 'error)
21431 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
21432 (error "C-k aborted - would kill hidden subtree")))
21433 (call-interactively
21434 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
21436 (kill-region (point) (match-beginning 1))
21437 (org-set-tags nil t))
21438 (t (kill-region (point) (point-at-eol)))))
21440 (define-key org-mode-map "\C-k" 'org-kill-line)
21442 (defun org-yank (&optional arg)
21443 "Yank. If the kill is a subtree, treat it specially.
21444 This command will look at the current kill and check if is a single
21445 subtree, or a series of subtrees[1]. If it passes the test, and if the
21446 cursor is at the beginning of a line or after the stars of a currently
21447 empty headline, then the yank is handled specially. How exactly depends
21448 on the value of the following variables, both set by default.
21450 org-yank-folded-subtrees
21451 When set, the subtree(s) will be folded after insertion, but only
21452 if doing so would now swallow text after the yanked text.
21454 org-yank-adjusted-subtrees
21455 When set, the subtree will be promoted or demoted in order to
21456 fit into the local outline tree structure, which means that the level
21457 will be adjusted so that it becomes the smaller one of the two
21458 *visible* surrounding headings.
21460 Any prefix to this command will cause `yank' to be called directly with
21462 will just
21463 plainly yank the text as it is.
21465 \[1] The test checks if the first non-white line is a heading
21466 and if there are no other headings with fewer stars."
21467 (interactive "P")
21468 (org-yank-generic 'yank arg))
21470 (defun org-yank-generic (command arg)
21471 "Perform some yank-like command.
21473 This function implements the behavior described in the `org-yank'
21474 documentation. However, it has been generalized to work for any
21475 interactive command with similar behavior."
21477 ;; pretend to be command COMMAND
21478 (setq this-command command)
21480 (if arg
21481 (call-interactively command)
21483 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
21484 (and (org-kill-is-subtree-p)
21485 (or (bolp)
21487 (string-match
21489 (buffer-substring (point-at-bol) (point)))))))
21490 swallowp)
21491 (cond
21492 ((and subtreep org-yank-folded-subtrees)
21493 (let ((beg (point))
21494 end)
21495 (if (and subtreep org-yank-adjusted-subtrees)
21496 (org-paste-subtree nil nil 'for-yank)
21497 (call-interactively command))
21499 (setq end (point))
21500 (goto-char beg)
21501 (when (and (bolp) subtreep
21502 (not (setq swallowp
21503 (org-yank-folding-would-swallow-text beg end))))
21504 (org-with-limited-levels
21505 (or (looking-at org-outline-regexp)
21506 (re-search-forward org-outline-regexp-bol end t))
21507 (while (and (< (point) end) (looking-at org-outline-regexp))
21508 (hide-subtree)
21509 (org-cycle-show-empty-lines 'folded)
21510 (condition-case nil
21511 (outline-forward-same-level 1)
21512 (error (goto-char end))))))
21513 (when swallowp
21514 (message
21515 "Inserted text not folded because that would swallow text"))
21517 (goto-char end)
21519 (beginning-of-line 1)
21520 (push-mark beg 'nomsg)))
21521 ((and subtreep org-yank-adjusted-subtrees)
21522 (let ((beg (point-at-bol)))
21523 (org-paste-subtree nil nil 'for-yank)
21524 (push-mark beg 'nomsg)))
21525 (t
21526 (call-interactively command))))))
21528 (defun org-yank-folding-would-swallow-text (beg end)
21529 "Would hide-subtree at BEG swallow any text after END?"
21530 (let (level)
21531 (org-with-limited-levels
21532 (save-excursion
21533 (goto-char beg)
21534 (when (or (looking-at org-outline-regexp)
21535 (re-search-forward org-outline-regexp-bol end t))
21536 (setq level (org-outline-level)))
21537 (goto-char end)
21539 (if (or (eobp)
21540 (and (bolp) (looking-at org-outline-regexp)
21541 (<= (org-outline-level) level)))
21542 nil ; Nothing would be swallowed
21543 t))))) ; something would swallow
21545 (define-key org-mode-map "\C-y" 'org-yank)
21547 (defun org-truely-invisible-p ()
21548 "Check if point is at a character currently not visible.
21549 This version does not only check the character property, but also
21550 `visible-mode'."
21551 ;; Early versions of noutline don't have `outline-invisible-p'.
21552 (if (org-bound-and-true-p visible-mode)
21553 nil
21554 (outline-invisible-p)))
21556 (defun org-invisible-p2 ()
21557 "Check if point is at a character currently not visible."
21558 (save-excursion
21559 (if (and (eolp) (not (bobp))) (backward-char 1))
21560 ;; Early versions of noutline don't have `outline-invisible-p'.
21561 (outline-invisible-p)))
21563 (defun org-back-to-heading (&optional invisible-ok)
21564 "Call `outline-back-to-heading', but provide a better error message."
21565 (condition-case nil
21566 (outline-back-to-heading invisible-ok)
21567 (error (error "Before first headline at position %d in buffer %s"
21568 (point) (current-buffer)))))
21570 (defun org-before-first-heading-p ()
21571 "Before first heading?"
21572 (save-excursion
21573 (end-of-line)
21574 (null (re-search-backward org-outline-regexp-bol nil t))))
21576 (defun org-at-heading-p (&optional ignored)
21577 (outline-on-heading-p t))
21578 ;; Compatibility alias with Org versions < 7.8.03
21579 (defalias 'org-on-heading-p 'org-at-heading-p)
21581 (defun org-at-comment-p nil
21582 "Is cursor in a line starting with a # character?"
21583 (save-excursion
21584 (beginning-of-line)
21585 (looking-at "^#")))
21587 (defun org-at-drawer-p nil
21588 "Is cursor at a drawer keyword?"
21589 (save-excursion
21590 (move-beginning-of-line 1)
21591 (looking-at org-drawer-regexp)))
21593 (defun org-at-block-p nil
21594 "Is cursor at a block keyword?"
21595 (save-excursion
21596 (move-beginning-of-line 1)
21597 (looking-at org-block-regexp)))
21599 (defun org-point-at-end-of-empty-headline ()
21600 "If point is at the end of an empty headline, return t, else nil.
21601 If the heading only contains a TODO keyword, it is still still considered
21602 empty."
21604 (when org-todo-line-regexp
21605 (save-excursion
21606 (beginning-of-line 1)
21607 (let ((case-fold-search nil))
21608 (looking-at org-todo-line-regexp)
21609 (string= (match-string 3) ""))))))
21611 (defun org-at-heading-or-item-p ()
21612 (or (org-at-heading-p) (org-at-item-p)))
21614 (defun org-at-target-p ()
21615 (or (org-in-regexp org-radio-target-regexp)
21616 (org-in-regexp org-target-regexp)))
21617 ;; Compatibility alias with Org versions < 7.8.03
21618 (defalias 'org-on-target-p 'org-at-target-p)
21620 (defun org-up-heading-all (arg)
21621 "Move to the heading line of which the present line is a subheading.
21622 This function considers both visible and invisible heading lines.
21623 With argument, move up ARG levels."
21624 (if (fboundp 'outline-up-heading-all)
21625 (outline-up-heading-all arg) ; emacs 21 version of outline.el
21626 (outline-up-heading arg t))) ; emacs 22 version of outline.el
21628 (defun org-up-heading-safe ()
21629 "Move to the heading line of which the present line is a subheading.
21630 This version will not throw an error. It will return the level of the
21631 headline found, or nil if no higher level is found.
21633 Also, this function will be a lot faster than `outline-up-heading',
21634 because it relies on stars being the outline starters. This can really
21635 make a significant difference in outlines with very many siblings."
21636 (let (start-level re)
21637 (org-back-to-heading t)
21638 (setq start-level (funcall outline-level))
21639 (if (equal start-level 1)
21640 nil
21642 (if (re-search-backward re nil t)
21643 (funcall outline-level)))))
21645 (defun org-first-sibling-p ()
21646 "Is this heading the first child of its parents?"
21647 (interactive)
21648 (let ((re org-outline-regexp-bol)
21649 level l)
21650 (unless (org-at-heading-p t)
21651 (error "Not at a heading"))
21652 (setq level (funcall outline-level))
21653 (save-excursion
21654 (if (not (re-search-backward re nil t))
21655 t
21656 (setq l (funcall outline-level))
21657 (< l level)))))
21659 (defun org-goto-sibling (&optional previous)
21660 "Goto the next sibling, even if it is invisible.
21661 When PREVIOUS is set, go to the previous sibling instead. Returns t
21662 when a sibling was found. When none is found, return nil and don't
21663 move point."
21664 (let ((fun (if previous 're-search-backward 're-search-forward))
21665 (pos (point))
21666 (re org-outline-regexp-bol)
21667 level l)
21668 (when (condition-case nil (org-back-to-heading t) (error nil))
21669 (setq level (funcall outline-level))
21670 (catch 'exit
21671 (or previous (forward-char 1))
21672 (while (funcall fun re nil t)
21673 (setq l (funcall outline-level))
21674 (when (< l level) (goto-char pos) (throw 'exit nil))
21675 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
21676 (goto-char pos)
21677 nil))))
21679 (defun org-show-siblings ()
21680 "Show all siblings of the current headline."
21681 (save-excursion
21682 (while (org-goto-sibling) (org-flag-heading nil)))
21683 (save-excursion
21684 (while (org-goto-sibling 'previous)
21685 (org-flag-heading nil))))
21687 (defun org-goto-first-child ()
21688 "Goto the first child, even if it is invisible.
21689 Return t when a child was found. Otherwise don't move point and
21690 return nil."
21691 (let (level (pos (point)) (re org-outline-regexp-bol))
21692 (when (condition-case nil (org-back-to-heading t) (error nil))
21693 (setq level (outline-level))
21694 (forward-char 1)
21695 (if (and (re-search-forward re nil t) (> (outline-level) level))
21696 (progn (goto-char (match-beginning 0)) t)
21697 (goto-char pos) nil))))
21699 (defun org-show-hidden-entry ()
21700 "Show an entry where even the heading is hidden."
21701 (save-excursion
21702 (org-show-entry)))
21704 (defun org-flag-heading (flag &optional entry)
21705 "Flag the current heading. FLAG non-nil means make invisible.
21706 When ENTRY is non-nil, show the entire entry."
21707 (save-excursion
21708 (org-back-to-heading t)
21709 ;; Check if we should show the entire entry
21710 (if entry
21711 (progn
21712 (org-show-entry)
21713 (save-excursion
21714 (and (outline-next-heading)
21715 (org-flag-heading nil))))
21716 (outline-flag-region (max (point-min) (1- (point)))
21717 (save-excursion (outline-end-of-heading) (point))
21718 flag))))
21720 (defun org-get-next-sibling ()
21721 "Move to next heading of the same level, and return point.
21722 If there is no such heading, return nil.
21723 This is like outline-next-sibling, but invisible headings are ok."
21724 (let ((level (funcall outline-level)))
21725 (outline-next-heading)
21726 (while (and (not (eobp)) (> (funcall outline-level) level))
21727 (outline-next-heading))
21728 (if (or (eobp) (< (funcall outline-level) level))
21729 nil
21730 (point))))
21732 (defun org-get-last-sibling ()
21733 "Move to previous heading of the same level, and return point.
21734 If there is no such heading, return nil."
21735 (let ((opoint (point))
21736 (level (funcall outline-level)))
21737 (outline-previous-heading)
21738 (when (and (/= (point) opoint) (outline-on-heading-p t))
21739 (while (and (> (funcall outline-level) level)
21740 (not (bobp)))
21741 (outline-previous-heading))
21742 (if (< (funcall outline-level) level)
21743 nil
21744 (point)))))
21746 (defun org-end-of-subtree (&optional invisible-ok to-heading)
21747 "Goto to the end of a subtree."
21748 ;; This contains an exact copy of the original function, but it uses
21749 ;; `org-back-to-heading', to make it work also in invisible
21750 ;; trees. And is uses an invisible-ok argument.
21751 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21752 ;; Furthermore, when used inside Org, finding the end of a large subtree
21753 ;; with many children and grandchildren etc, this can be much faster
21754 ;; than the outline version.
21755 (org-back-to-heading invisible-ok)
21756 (let ((first t)
21757 (level (funcall outline-level)))
21758 (if (and (derived-mode-p 'org-mode) (< level 1000))
21759 ;; A true heading (not a plain list item), in Org-mode
21760 ;; This means we can easily find the end by looking
21761 ;; only for the right number of stars. Using a regexp to do
21762 ;; this is so much faster than using a Lisp loop.
21764 (forward-char 1)
21765 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21766 ;; something else, do it the slow way
21767 (while (and (not (eobp))
21768 (or first (> (funcall outline-level) level)))
21769 (setq first nil)
21770 (outline-next-heading)))
21771 (unless to-heading
21773 (progn
21774 ;; Go to end of line before heading
21775 (forward-char -1)
21777 ;; leave blank line before heading
21778 (forward-char -1))))))
21779 (point))
21781 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21782 "Use Org version in org-mode, for dramatic speed-up."
21783 (if (derived-mode-p 'org-mode)
21784 (progn
21785 (org-end-of-subtree nil t)
21786 (unless (eobp) (backward-char 1)))
21787 ad-do-it))
21789 (defun org-end-of-meta-data-and-drawers ()
21790 "Jump to the first text after meta data and drawers in the current entry.
21791 This will move over empty lines, lines with planning time stamps,
21792 clocking lines, and drawers."
21793 (org-back-to-heading t)
21794 (let ((end (save-excursion (outline-next-heading) (point)))
21797 (forward-line 1)
21798 (while (re-search-forward re end t)
21799 (if (not (match-end 1))
21800 ;; empty or planning line
21801 (forward-line 1)
21802 ;; a drawer, find the end
21804 (forward-line 1)))
21806 (point)))
21808 (defun org-forward-heading-same-level (arg &optional invisible-ok)
21809 "Move forward to the arg'th subheading at same level as this one.
21810 Stop at the first and last subheadings of a superior heading.
21811 Normally this only looks at visible headings, but when INVISIBLE-OK is
21812 non-nil it will also look at invisible ones."
21813 (interactive "p")
21814 (org-back-to-heading invisible-ok)
21815 (org-at-heading-p)
21816 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21818 l)
21819 (forward-char 1)
21820 (while (> arg 0)
21821 (while (and (re-search-forward re nil 'move)
21822 (setq l (- (match-end 0) (match-beginning 0) 1))
21823 (= l level)
21824 (not invisible-ok)
21825 (progn (backward-char 1) (outline-invisible-p)))
21826 (if (< l level) (setq arg 1)))
21827 (setq arg (1- arg)))
21828 (beginning-of-line 1)))
21830 (defun org-backward-heading-same-level (arg &optional invisible-ok)
21831 "Move backward to the arg'th subheading at same level as this one.
21832 Stop at the first and last subheadings of a superior heading."
21833 (interactive "p")
21834 (org-back-to-heading)
21835 (org-at-heading-p)
21836 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21838 l)
21839 (while (> arg 0)
21840 (while (and (re-search-backward re nil 'move)
21841 (setq l (- (match-end 0) (match-beginning 0) 1))
21842 (= l level)
21843 (not invisible-ok)
21844 (outline-invisible-p))
21845 (if (< l level) (setq arg 1)))
21846 (setq arg (1- arg)))))
21848 (defun org-forward-element ()
21849 "Move forward by one element.
21850 Move to the next element at the same level, when possible."
21851 (interactive)
21852 (cond ((eobp) (error "Cannot move further down"))
21853 ((org-with-limited-levels (org-at-heading-p))
21854 (let ((origin (point)))
21855 (org-forward-heading-same-level 1)
21856 (unless (org-with-limited-levels (org-at-heading-p))
21857 (goto-char origin)
21858 (error "Cannot move further down"))))
21859 (t
21860 (let* ((elem (org-element-at-point))
21861 (end (org-element-property :end elem))
21862 (parent (org-element-property :parent elem)))
21863 (if (and parent (= (org-element-property :contents-end parent) end))
21864 (goto-char (org-element-property :end parent))
21865 (goto-char end))))))
21867 (defun org-backward-element ()
21868 "Move backward by one element.
21869 Move to the previous element at the same level, when possible."
21870 (interactive)
21871 (cond ((bobp) (error "Cannot move further up"))
21872 ((org-with-limited-levels (org-at-heading-p))
21873 ;; At an headline, move to the previous one, if any, or stay
21874 ;; here.
21875 (let ((origin (point)))
21876 (org-backward-heading-same-level 1)
21877 (unless (org-with-limited-levels (org-at-heading-p))
21878 (goto-char origin)
21879 (error "Cannot move further up"))))
21880 (t
21881 (let* ((trail (org-element-at-point 'keep-trail))
21882 (elem (car trail))
21883 (prev-elem (nth 1 trail))
21884 (beg (org-element-property :begin elem)))
21885 (cond
21886 ;; Move to beginning of current element if point isn't
21887 ;; there already.
21888 ((/= (point) beg) (goto-char beg))
21889 (prev-elem (goto-char (org-element-property :begin prev-elem)))
21890 ((org-before-first-heading-p) (goto-char (point-min)))
21891 (t (org-back-to-heading)))))))
21893 (defun org-up-element ()
21894 "Move to upper element."
21895 (interactive)
21896 (if (org-with-limited-levels (org-at-heading-p))
21897 (unless (org-up-heading-safe) (error "No surrounding element"))
21898 (let* ((elem (org-element-at-point))
21899 (parent (org-element-property :parent elem)))
21900 (if parent (goto-char (org-element-property :begin parent))
21901 (if (org-with-limited-levels (org-before-first-heading-p))
21902 (error "No surrounding element")
21903 (org-with-limited-levels (org-back-to-heading)))))))
21905 (defvar org-element-greater-elements)
21906 (defun org-down-element ()
21907 "Move to inner element."
21908 (interactive)
21909 (let ((element (org-element-at-point)))
21910 (cond
21911 ((memq (org-element-type element) '(plain-list table))
21912 (goto-char (org-element-property :contents-begin element))
21913 (forward-char))
21914 ((memq (org-element-type element) org-element-greater-elements)
21915 ;; If contents are hidden, first disclose them.
21916 (when (org-element-property :hiddenp element) (org-cycle))
21917 (goto-char (or (org-element-property :contents-begin element)
21918 (error "No content for this element"))))
21919 (t (error "No inner element")))))
21921 (defun org-drag-element-backward ()
21922 "Move backward element at point."
21923 (interactive)
21924 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
21925 (let* ((trail (org-element-at-point 'keep-trail))
21926 (elem (car trail))
21927 (prev-elem (nth 1 trail)))
21928 ;; Error out if no previous element or previous element is
21929 ;; a parent of the current one.
21930 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
21931 (error "Cannot drag element backward")
21932 (let ((pos (point)))
21933 (org-element-swap-A-B prev-elem elem)
21934 (goto-char (+ (org-element-property :begin prev-elem)
21935 (- pos (org-element-property :begin elem)))))))))
21937 (defun org-drag-element-forward ()
21938 "Move forward element at point."
21939 (interactive)
21940 (let* ((pos (point))
21941 (elem (org-element-at-point)))
21942 (when (= (point-max) (org-element-property :end elem))
21943 (error "Cannot drag element forward"))
21944 (goto-char (org-element-property :end elem))
21945 (let ((next-elem (org-element-at-point)))
21946 (when (or (org-element-nested-p elem next-elem)
21947 (and (eq (org-element-type next-elem) 'headline)
21948 (not (eq (org-element-type elem) 'headline))))
21949 (goto-char pos)
21950 (error "Cannot drag element forward"))
21951 ;; Compute new position of point: it's shifted by NEXT-ELEM
21952 ;; body's length (without final blanks) and by the length of
21953 ;; blanks between ELEM and NEXT-ELEM.
21954 (let ((size-next (- (save-excursion
21955 (goto-char (org-element-property :end next-elem))
21957 (forward-line)
21958 ;; Small correction if buffer doesn't end
21959 ;; with a newline character.
21960 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
21961 (org-element-property :begin next-elem)))
21962 (size-blank (- (org-element-property :end elem)
21963 (save-excursion
21964 (goto-char (org-element-property :end elem))
21966 (forward-line)
21967 (point)))))
21968 (org-element-swap-A-B elem next-elem)
21969 (goto-char (+ pos size-next size-blank))))))
21971 (defun org-mark-element ()
21972 "Put point at beginning of this element, mark at end.
21974 Interactively, if this command is repeated or (in Transient Mark
21975 mode) if the mark is active, it marks the next element after the
21976 ones already marked."
21977 (interactive)
21978 (let (deactivate-mark)
21979 (if (and (org-called-interactively-p 'any)
21980 (or (and (eq last-command this-command) (mark t))
21981 (and transient-mark-mode mark-active)))
21982 (set-mark
21983 (save-excursion
21984 (goto-char (mark))
21985 (goto-char (org-element-property :end (org-element-at-point)))))
21986 (let ((element (org-element-at-point)))
21987 (end-of-line)
21988 (push-mark (org-element-property :end element) t t)
21989 (goto-char (org-element-property :begin element))))))
21991 (defun org-narrow-to-element ()
21992 "Narrow buffer to current element."
21993 (interactive)
21994 (let ((elem (org-element-at-point)))
21995 (cond
21996 ((eq (car elem) 'headline)
21997 (narrow-to-region
21998 (org-element-property :begin elem)
21999 (org-element-property :end elem)))
22000 ((memq (car elem) org-element-greater-elements)
22001 (narrow-to-region
22002 (org-element-property :contents-begin elem)
22003 (org-element-property :contents-end elem)))
22004 (t
22005 (narrow-to-region
22006 (org-element-property :begin elem)
22007 (org-element-property :end elem))))))
22009 (defun org-transpose-element ()
22010 "Transpose current and previous elements, keeping blank lines between.
22011 Point is moved after both elements."
22012 (interactive)
22013 (org-skip-whitespace)
22014 (let ((end (org-element-property :end (org-element-at-point))))
22015 (org-drag-element-backward)
22016 (goto-char end)))
22018 (defun org-unindent-buffer ()
22019 "Un-indent the visible part of the buffer.
22020 Relative indentation (between items, inside blocks, etc.) isn't
22021 modified."
22022 (interactive)
22023 (unless (eq major-mode 'org-mode)
22024 (error "Cannot un-indent a buffer not in Org mode"))
22025 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
22026 unindent-tree ; For byte-compiler.
22027 (unindent-tree
22028 (function
22029 (lambda (contents)
22030 (mapc
22031 (lambda (element)
22032 (if (memq (org-element-type element) '(headline section))
22033 (funcall unindent-tree (org-element-contents element))
22034 (save-excursion
22035 (save-restriction
22036 (narrow-to-region
22037 (org-element-property :begin element)
22038 (org-element-property :end element))
22039 (org-do-remove-indentation)))))
22040 (reverse contents))))))
22041 (funcall unindent-tree (org-element-contents parse-tree))))
22043 (defun org-show-subtree ()
22044 "Show everything after this heading at deeper levels."
22045 (interactive)
22046 (outline-flag-region
22047 (point)
22048 (save-excursion
22049 (org-end-of-subtree t t))
22050 nil))
22052 (defun org-show-entry ()
22053 "Show the body directly following this heading.
22054 Show the heading too, if it is currently invisible."
22055 (interactive)
22056 (save-excursion
22057 (condition-case nil
22058 (progn
22059 (org-back-to-heading t)
22060 (outline-flag-region
22061 (max (point-min) (1- (point)))
22062 (save-excursion
22063 (if (re-search-forward
22065 (match-beginning 1)
22066 (point-max)))
22067 nil)
22068 (org-cycle-hide-drawers 'children))
22069 (error nil))))
22071 (defun org-make-options-regexp (kwds &optional extra)
22072 "Make a regular expression for keyword lines."
22073 (concat
22079 ;; Make isearch reveal the necessary context
22080 (defun org-isearch-end ()
22081 "Reveal context after isearch exits."
22082 (when isearch-success ; only if search was successful
22083 (if (featurep 'xemacs)
22084 ;; Under XEmacs, the hook is run in the correct place,
22085 ;; we directly show the context.
22086 (org-show-context 'isearch)
22087 ;; In Emacs the hook runs *before* restoring the overlays.
22088 ;; So we have to use a one-time post-command-hook to do this.
22089 ;; (Emacs 22 has a special variable, see function `org-mode')
22090 (unless (and (boundp 'isearch-mode-end-hook-quit)
22091 isearch-mode-end-hook-quit)
22092 ;; Only when the isearch was not quitted.
22093 (org-add-hook 'post-command-hook 'org-isearch-post-command
22094 'append 'local)))))
22096 (defun org-isearch-post-command ()
22097 "Remove self from hook, and show context."
22098 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
22099 (org-show-context 'isearch))
22102 ;;;; Integration with and fixes for other packages
22104 ;;; Imenu support
22106 (defvar org-imenu-markers nil
22107 "All markers currently used by Imenu.")
22108 (make-variable-buffer-local 'org-imenu-markers)
22110 (defun org-imenu-new-marker (&optional pos)
22111 "Return a new marker for use by Imenu, and remember the marker."
22112 (let ((m (make-marker)))
22113 (move-marker m (or pos (point)))
22114 (push m org-imenu-markers)
22115 m))
22117 (defun org-imenu-get-tree ()
22118 "Produce the index for Imenu."
22119 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
22120 (setq org-imenu-markers nil)
22121 (let* ((n org-imenu-depth)
22122 (re (concat "^" (org-get-limited-outline-regexp)))
22123 (subs (make-vector (1+ n) nil))
22124 (last-level 0)
22125 m level head)
22126 (save-excursion
22127 (save-restriction
22128 (widen)
22129 (goto-char (point-max))
22130 (while (re-search-backward re nil t)
22131 (setq level (org-reduced-level (funcall outline-level)))
22132 (when (and (<= level n)
22133 (looking-at org-complex-heading-regexp))
22134 (setq head (org-link-display-format
22135 (org-match-string-no-properties 4))
22136 m (org-imenu-new-marker))
22137 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
22138 (if (>= level last-level)
22139 (push (cons head m) (aref subs level))
22140 (push (cons head (aref subs (1+ level))) (aref subs level))
22141 (loop for i from (1+ level) to n do (aset subs i nil)))
22142 (setq last-level level)))))
22143 (aref subs 1)))
22145 (eval-after-load "imenu"
22146 '(progn
22147 (add-hook 'imenu-after-jump-hook
22148 (lambda ()
22149 (if (derived-mode-p 'org-mode)
22150 (org-show-context 'org-goto))))))
22152 (defun org-link-display-format (link)
22153 "Replace a link with either the description, or the link target
22154 if no description is present"
22155 (save-match-data
22156 (if (string-match org-bracket-link-analytic-regexp link)
22157 (replace-match (if (match-end 5)
22158 (match-string 5 link)
22159 (concat (match-string 1 link)
22160 (match-string 3 link)))
22161 nil t link)
22162 link)))
22164 (defun org-toggle-link-display ()
22165 "Toggle the literal or descriptive display of links."
22166 (interactive)
22167 (if org-descriptive-links
22168 (progn (org-remove-from-invisibility-spec '(org-link))
22169 (org-restart-font-lock)
22170 (setq org-descriptive-links nil))
22171 (progn (add-to-invisibility-spec '(org-link))
22172 (org-restart-font-lock)
22173 (setq org-descriptive-links t))))
22175 ;; Speedbar support
22177 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
22178 "Overlay marking the agenda restriction line in speedbar.")
22179 (overlay-put org-speedbar-restriction-lock-overlay
22180 'face 'org-agenda-restriction-lock)
22181 (overlay-put org-speedbar-restriction-lock-overlay
22182 'help-echo "Agendas are currently limited to this item.")
22183 (org-detach-overlay org-speedbar-restriction-lock-overlay)
22185 (defun org-speedbar-set-agenda-restriction ()
22186 "Restrict future agenda commands to the location at point in speedbar.
22188 (interactive)
22189 (require 'org-agenda)
22190 (let (p m tp np dir txt)
22191 (cond
22192 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22193 'org-imenu t))
22194 (setq m (get-text-property p 'org-imenu-marker))
22195 (with-current-buffer (marker-buffer m)
22196 (goto-char m)
22197 (org-agenda-set-restriction-lock 'subtree)))
22198 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22199 'speedbar-function 'speedbar-find-file))
22200 (setq tp (previous-single-property-change
22201 (1+ p) 'speedbar-function)
22202 np (next-single-property-change
22203 tp 'speedbar-function)
22204 dir (speedbar-line-directory)
22205 txt (buffer-substring-no-properties (or tp (point-min))
22206 (or np (point-max))))
22207 (with-current-buffer (find-file-noselect
22208 (let ((default-directory dir))
22209 (expand-file-name txt)))
22210 (unless (derived-mode-p 'org-mode)
22211 (error "Cannot restrict to non-Org-mode file"))
22212 (org-agenda-set-restriction-lock 'file)))
22213 (t (error "Don't know how to restrict Org-mode's agenda")))
22214 (move-overlay org-speedbar-restriction-lock-overlay
22215 (point-at-bol) (point-at-eol))
22216 (setq current-prefix-arg nil)
22217 (org-agenda-maybe-redo)))
22219 (eval-after-load "speedbar"
22220 '(progn
22221 (speedbar-add-supported-extension ".org")
22222 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
22223 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
22224 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
22225 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
22226 (add-hook 'speedbar-visiting-tag-hook
22227 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
22229 ;;; Fixes and Hacks for problems with other packages
22231 ;; Make flyspell not check words in links, to not mess up our keymap
22232 (defun org-mode-flyspell-verify ()
22233 "Don't let flyspell put overlays at active buttons, or on
22234 {todo,all-time,additional-option-like}-keywords."
22235 (let ((pos (max (1- (point)) (point-min)))
22236 (word (thing-at-point 'word)))
22237 (and (not (get-text-property pos 'keymap))
22238 (not (get-text-property pos 'org-no-flyspell))
22239 (not (member word org-todo-keywords-1))
22240 (not (member word org-all-time-keywords))
22241 (not (member word org-options-keywords))
22242 (not (member word (mapcar 'car org-startup-options)))
22243 (not (member word org-additional-option-like-keywords-for-flyspell)))))
22245 (defun org-remove-flyspell-overlays-in (beg end)
22246 "Remove flyspell overlays in region."
22247 (and (org-bound-and-true-p flyspell-mode)
22248 (fboundp 'flyspell-delete-region-overlays)
22249 (flyspell-delete-region-overlays beg end))
22250 (add-text-properties beg end '(org-no-flyspell t)))
22252 ;; Make `bookmark-jump' shows the jump location if it was hidden.
22253 (eval-after-load "bookmark"
22254 '(if (boundp 'bookmark-after-jump-hook)
22255 ;; We can use the hook
22256 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
22257 ;; Hook not available, use advice
22258 (defadvice bookmark-jump (after org-make-visible activate)
22259 "Make the position visible."
22260 (org-bookmark-jump-unhide))))
22262 ;; Make sure saveplace shows the location if it was hidden
22263 (eval-after-load "saveplace"
22264 '(defadvice save-place-find-file-hook (after org-make-visible activate)
22265 "Make the position visible."
22266 (org-bookmark-jump-unhide)))
22268 ;; Make sure ecb shows the location if it was hidden
22269 (eval-after-load "ecb"
22270 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
22271 "Make hierarchy visible when jumping into location from ECB tree buffer."
22272 (if (derived-mode-p 'org-mode)
22273 (org-show-context))))
22275 (defun org-bookmark-jump-unhide ()
22276 "Unhide the current position, to show the bookmark location."
22277 (and (derived-mode-p 'org-mode)
22278 (or (outline-invisible-p)
22279 (save-excursion (goto-char (max (point-min) (1- (point))))
22280 (outline-invisible-p)))
22281 (org-show-context 'bookmark-jump)))
22283 ;; Make session.el ignore our circular variable
22284 (eval-after-load "session"
22285 '(add-to-list 'session-globals-exclude 'org-mark-ring))
22287 ;;;; Experimental code
22289 (defun org-closed-in-range ()
22290 "Sparse tree of items closed in a certain time range.
22291 Still experimental, may disappear in the future."
22292 (interactive)
22293 ;; Get the time interval from the user.
22294 (let* ((time1 (org-float-time
22295 (org-read-date nil 'to-time nil "Starting date: ")))
22296 (time2 (org-float-time
22297 (org-read-date nil 'to-time nil "End date:")))
22298 ;; callback function
22299 (callback (lambda ()
22300 (let ((time
22301 (org-float-time
22302 (apply 'encode-time
22303 (org-parse-time-string
22304 (match-string 1))))))
22305 ;; check if time in interval
22306 (and (>= time time1) (<= time time2))))))
22307 ;; make tree, check each match with the callback
22310 ;;;; Finish up
22312 (provide 'org)
22314 (run-hooks 'org-load-hook)
22316 ;;; org.el ends here