| blob | 4d755c5964c78306d67693480cced131f629f1bd |
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).
6275 ;; Determine end invisible part of buffer (EOL)
6277 ;; XEmacs doesn't have `next-single-char-property-change'
6287 ;; Find out what to do next and set `this-command'
6290 ;; Nothing is hidden behind this heading
6302 org-cycle-skip-children-state-if-no-children))))
6303 ;; Entire subtree is hidden in one line: children view
6309 ;; FIXME: This slows down the func way too much.
6310 ;; How keep drawers hidden in subtree anyway?
6311 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6312 ;; (org-cycle-hide-drawers 'subtree))
6314 ;; Fold every list in subtree to top-level items.
6336 ;; We just showed the children, or no children are there,
6337 ;; now show everything.
6344 ;; Default action: hide the subtree.
6351 ;;;###autoload
6353 "Cycle the global visibility. For details see `org-cycle'.
6355 With a numeric prefix, show all headlines up to that level."
6371 "Set the visibility required by startup options and properties."
6386 "Switch subtree visibilities according to :VISIBILITY: property."
6393 nil t)
6417 ;; This function uses outline-regexp instead of the more fundamental
6418 ;; org-outline-regexp so that org-cycle-global works outside of Org
6419 ;; buffers, where outline-regexp is needed.
6421 "Switch to overview mode, showing only top-level headlines.
6422 Really, this shows all headlines with level equal or greater than the level
6423 of the first headline in the buffer. This is important, because if the
6424 first headline is not level one, then (hide-sublevels 1) gives confusing
6425 results."
6436 "Show all headlines in the buffer, like a table of contents.
6437 With numerical argument N, show content up to level N."
6440 ;; Visit all headings and show their offspring
6447 t)
6456 "Adjust the window after a change in outline visibility.
6457 This function is the default value of the hook `org-cycle-hook'."
6467 "Remove outline overlays that do not contain non-white stuff."
6477 "Fix visibility issues after moving a subtree."
6478 ;; First, find a reasonable region to look at:
6479 ;; Start two siblings above, end three below
6497 ;; Properly fold already folded siblings
6508 "Show empty lines above all visible headlines.
6509 The region to be covered depends on STATE when called through
6510 `org-cycle-hook'. Lisp program can use t for STATE to get the
6511 entire buffer covered. Note that an empty line is only shown if there
6512 are at least `org-cycle-separator-lines' empty lines before the headline."
6522 beg end b e)
6546 ;; Never hide empty lines at the end of the file.
6556 "Move to the parent and re-show empty lines before visible headlines."
6562 "Return `org-agenda-files' list, plus all open org-mode files.
6563 This is useful for operations that need to scan all of a user's
6564 open and agenda-wise Org files."
6572 files))
6575 "Return the beginning position of the current entry."
6579 "Return the end position of the current entry."
6583 "Re-hide all drawers after a visibility state change."
6598 "When FLAG is non-nil, hide the drawer we are within.
6599 Otherwise make it visible."
6611 "Is the end of the current subtree visible?"
6616 "Move cursor to the first headline and recenter the headline.
6617 Optional argument N means put the headline into the Nth line of the window."
6623 ;;; Saving and restoring visibility
6626 "Return a list of the locations of all outline overlays.
6627 These are overlays with the `invisible' property value `outline'.
6628 The return value is a list of cons cells, with start and stop
6629 positions for each overlay.
6630 If USE-MARKERS is set, return the positions as markers."
6648 "Create visibility overlays for all positions in DATA.
6649 DATA should have been made by `org-outline-overlay-data'."
6657 data)))))
6659 ;;; Folding of blocks
6666 "Call FUNCTION at the head of all source blocks in the current buffer.
6667 Optional arguments START and END can be used to limit the range."
6679 "Toggle the visibility of all blocks in the current buffer."
6683 "Fold all blocks in the current buffer."
6689 "Unfold all blocks in the current buffer."
6695 "Toggle visibility of block at point."
6706 "Toggle the visibility of the current block."
6713 ov)
6729 ;; make the block accessible to isearch
6731 ov 'isearch-open-invisible
6742 ;; org-tab-after-check-for-cycling-hook
6744 ;; Remove overlays when changing major mode
6749 ;;; Org-goto
6755 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6771 nil)
6772 (org-defkey map "q" 'org-goto-quit)
6773 (org-defkey map "n" 'outline-next-visible-heading)
6774 (org-defkey map "p" 'outline-previous-visible-heading)
6775 (org-defkey map "f" 'outline-forward-same-level)
6776 (org-defkey map "b" 'outline-backward-same-level)
6777 (org-defkey map "u" 'outline-up-heading))
6778 (org-defkey map "/" 'org-occur)
6779 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6780 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6781 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6782 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6783 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6784 map))
6786 (defconst org-goto-help
6787 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6788 RET=jump to location [Q]uit and return to previous location
6789 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6791 (defvar org-goto-start-pos) ; dynamically scoped parameter
6793 ;; FIXME: Docstring does not mention both interfaces
6794 (defun org-goto (&optional alternative-interface)
6795 "Look up a different location in the current file, keeping current visibility.
6797 When you want look-up or go to a different location in a
6798 document, the fastest way is often to fold the entire buffer and
6799 then dive into the tree. This method has the disadvantage, that
6800 the previous location will be folded, which may not be what you
6801 want.
6803 This command works around this by showing a copy of the current
6804 buffer in an indirect buffer, in overview mode. You can dive
6805 into the tree in that copy, use org-occur and incremental search
6806 to find a location. When pressing RET or `Q', the command
6807 returns to the original buffer in which the visibility is still
6808 unchanged. After RET it will also jump to the location selected
6809 in the indirect buffer and expose the headline hierarchy above.
6811 With a prefix argument, use the alternative interface: e.g. if
6812 `org-goto-interface' is 'outline use 'outline-path-completion."
6813 (interactive "P")
6814 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6815 (org-refile-use-outline-path t)
6816 (org-refile-target-verify-function nil)
6817 (interface
6818 (if (not alternative-interface)
6819 org-goto-interface
6820 (if (eq org-goto-interface 'outline)
6821 'outline-path-completion
6822 'outline)))
6823 (org-goto-start-pos (point))
6824 (selected-point
6825 (if (eq interface 'outline)
6826 (car (org-get-location (current-buffer) org-goto-help))
6827 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6828 (org-refile-check-position pa)
6829 (nth 3 pa)))))
6830 (if selected-point
6831 (progn
6832 (org-mark-ring-push org-goto-start-pos)
6833 (goto-char selected-point)
6834 (if (or (outline-invisible-p) (org-invisible-p2))
6835 (org-show-context 'org-goto)))
6836 (message "Quit"))))
6838 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6839 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6840 (defvar org-goto-local-auto-isearch-map) ; defined below
6842 (defun org-get-location (buf help)
6843 "Let the user select a location in the Org-mode buffer BUF.
6844 This function uses a recursive edit. It returns the selected position
6845 or nil."
6846 (org-no-popups
6847 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6848 (isearch-hide-immediately nil)
6849 (isearch-search-fun-function
6850 (lambda () 'org-goto-local-search-headings))
6851 (org-goto-selected-point org-goto-exit-command))
6852 (save-excursion
6853 (save-window-excursion
6854 (delete-other-windows)
6855 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6856 (org-pop-to-buffer-same-window
6857 (condition-case nil
6858 (make-indirect-buffer (current-buffer) "*org-goto*")
6859 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6860 (with-output-to-temp-buffer "*Help*"
6861 (princ help))
6862 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6863 (setq buffer-read-only nil)
6864 (let ((org-startup-truncated t)
6865 (org-startup-folded nil)
6866 (org-startup-align-all-tables nil))
6867 (org-mode)
6868 (org-overview))
6869 (setq buffer-read-only t)
6870 (if (and (boundp 'org-goto-start-pos)
6871 (integer-or-marker-p org-goto-start-pos))
6872 (let ((org-show-hierarchy-above t)
6873 (org-show-siblings t)
6874 (org-show-following-heading t))
6875 (goto-char org-goto-start-pos)
6876 (and (outline-invisible-p) (org-show-context)))
6877 (goto-char (point-min)))
6878 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6879 (message "Select location and press RET")
6880 (use-local-map org-goto-map)
6881 (recursive-edit)
6882 ))
6883 (kill-buffer "*org-goto*")
6884 (cons org-goto-selected-point org-goto-exit-command))))
6886 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6887 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6888 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6889 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6891 (defun org-goto-local-search-headings (string bound noerror)
6892 "Search and make sure that any matches are in headlines."
6893 (catch 'return
6894 (while (if isearch-forward
6895 (search-forward string bound noerror)
6896 (search-backward string bound noerror))
6897 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6898 (and (member :headline context)
6899 (not (member :tags context))))
6900 (throw 'return (point))))))
6902 (defun org-goto-local-auto-isearch ()
6903 "Start isearch."
6904 (interactive)
6905 (goto-char (point-min))
6906 (let ((keys (this-command-keys)))
6907 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6908 (isearch-mode t)
6909 (isearch-process-search-char (string-to-char keys)))))
6911 (defun org-goto-ret (&optional arg)
6912 "Finish `org-goto' by going to the new location."
6913 (interactive "P")
6914 (setq org-goto-selected-point (point)
6915 org-goto-exit-command 'return)
6916 (throw 'exit nil))
6918 (defun org-goto-left ()
6919 "Finish `org-goto' by going to the new location."
6920 (interactive)
6921 (if (org-at-heading-p)
6922 (progn
6923 (beginning-of-line 1)
6924 (setq org-goto-selected-point (point)
6925 org-goto-exit-command 'left)
6926 (throw 'exit nil))
6927 (error "Not on a heading")))
6929 (defun org-goto-right ()
6930 "Finish `org-goto' by going to the new location."
6931 (interactive)
6932 (if (org-at-heading-p)
6933 (progn
6934 (setq org-goto-selected-point (point)
6935 org-goto-exit-command 'right)
6936 (throw 'exit nil))
6937 (error "Not on a heading")))
6939 (defun org-goto-quit ()
6940 "Finish `org-goto' without cursor motion."
6941 (interactive)
6942 (setq org-goto-selected-point nil)
6943 (setq org-goto-exit-command 'quit)
6944 (throw 'exit nil))
6946 ;;; Indirect buffer display of subtrees
6948 (defvar org-indirect-dedicated-frame nil
6949 "This is the frame being used for indirect tree display.")
6950 (defvar org-last-indirect-buffer nil)
6952 (defun org-tree-to-indirect-buffer (&optional arg)
6953 "Create indirect buffer and narrow it to current subtree.
6954 With a numerical prefix ARG, go up to this level and then take that tree.
6955 If ARG is negative, go up that many levels.
6957 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6958 indirect buffer previously made with this command, to avoid proliferation of
6959 indirect buffers. However, when you call the command with a \
6961 when `org-indirect-buffer-display' is `new-frame', the last buffer
6962 is kept so that you can work with several indirect buffers at the same time.
6963 If `org-indirect-buffer-display' is `dedicated-frame', the \
6965 requests that a new frame be made for the new buffer, so that the dedicated
6966 frame is not changed."
6967 (interactive "P")
6968 (let ((cbuf (current-buffer))
6969 (cwin (selected-window))
6970 (pos (point))
6971 beg end level heading ibuf)
6972 (save-excursion
6973 (org-back-to-heading t)
6974 (when (numberp arg)
6975 (setq level (org-outline-level))
6976 (if (< arg 0) (setq arg (+ level arg)))
6977 (while (> (setq level (org-outline-level)) arg)
6978 (org-up-heading-safe)))
6979 (setq beg (point)
6980 heading (org-get-heading))
6981 (org-end-of-subtree t t)
6982 (if (org-at-heading-p) (backward-char 1))
6983 (setq end (point)))
6984 (if (and (buffer-live-p org-last-indirect-buffer)
6985 (not (eq org-indirect-buffer-display 'new-frame))
6986 (not arg))
6987 (kill-buffer org-last-indirect-buffer))
6988 (setq ibuf (org-get-indirect-buffer cbuf)
6989 org-last-indirect-buffer ibuf)
6990 (cond
6991 ((or (eq org-indirect-buffer-display 'new-frame)
6992 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6993 (select-frame (make-frame))
6994 (delete-other-windows)
6995 (org-pop-to-buffer-same-window ibuf)
6996 (org-set-frame-title heading))
6997 ((eq org-indirect-buffer-display 'dedicated-frame)
6998 (raise-frame
6999 (select-frame (or (and org-indirect-dedicated-frame
7000 (frame-live-p org-indirect-dedicated-frame)
7001 org-indirect-dedicated-frame)
7002 (setq org-indirect-dedicated-frame (make-frame)))))
7003 (delete-other-windows)
7004 (org-pop-to-buffer-same-window ibuf)
7005 (org-set-frame-title (concat "Indirect: " heading)))
7006 ((eq org-indirect-buffer-display 'current-window)
7007 (org-pop-to-buffer-same-window ibuf))
7008 ((eq org-indirect-buffer-display 'other-window)
7009 (pop-to-buffer ibuf))
7010 (t (error "Invalid value")))
7011 (if (featurep 'xemacs)
7012 (save-excursion (org-mode) (turn-on-font-lock)))
7013 (narrow-to-region beg end)
7014 (show-all)
7015 (goto-char pos)
7016 (run-hook-with-args 'org-cycle-hook 'all)
7017 (and (window-live-p cwin) (select-window cwin))))
7019 (defun org-get-indirect-buffer (&optional buffer)
7020 (setq buffer (or buffer (current-buffer)))
7021 (let ((n 1) (base (buffer-name buffer)) bname)
7022 (while (buffer-live-p
7023 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7024 (setq n (1+ n)))
7025 (condition-case nil
7026 (make-indirect-buffer buffer bname 'clone)
7027 (error (make-indirect-buffer buffer bname)))))
7029 (defun org-set-frame-title (title)
7030 "Set the title of the current frame to the string TITLE."
7031 ;; FIXME: how to name a single frame in XEmacs???
7032 (unless (featurep 'xemacs)
7033 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7035 ;;;; Structure editing
7037 ;;; Inserting headlines
7039 (defun org-previous-line-empty-p ()
7040 (save-excursion
7041 (and (not (bobp))
7042 (or (beginning-of-line 0) t)
7043 (save-match-data
7046 (defun org-insert-heading (&optional force-heading invisible-ok)
7047 "Insert a new heading or item with same depth at point.
7048 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7049 If point is at the beginning of a headline, insert a sibling before the
7050 current headline. If point is not at the beginning, split the line,
7051 create the new headline with the text in the current line after point
7052 \(but see also the variable `org-M-RET-may-split-line').
7054 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7055 This is important for non-interactive uses of the command."
7056 (interactive "P")
7057 (if (or (= (buffer-size) 0)
7058 (and (not (save-excursion
7059 (and (ignore-errors (org-back-to-heading invisible-ok))
7060 (org-at-heading-p))))
7061 (or force-heading (not (org-in-item-p)))))
7062 (progn
7064 (run-hooks 'org-insert-heading-hook))
7065 (when (or force-heading (not (org-insert-item)))
7066 (let* ((empty-line-p nil)
7067 (level nil)
7068 (on-heading (org-at-heading-p))
7069 (head (save-excursion
7070 (condition-case nil
7071 (progn
7072 (org-back-to-heading invisible-ok)
7073 (when (and (not on-heading)
7074 (featurep 'org-inlinetask)
7075 (integerp org-inlinetask-min-level)
7076 (>= (length (match-string 0))
7077 org-inlinetask-min-level))
7078 ;; Find a heading level before the inline task
7079 (while (and (setq level (org-up-heading-safe))
7080 (>= level org-inlinetask-min-level)))
7081 (if (org-at-heading-p)
7082 (org-back-to-heading invisible-ok)
7083 (error "This should not happen")))
7084 (setq empty-line-p (org-previous-line-empty-p))
7085 (match-string 0))
7086 (error "*"))))
7087 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7088 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7089 pos hide-previous previous-pos)
7090 (cond
7091 ((and (org-at-heading-p) (bolp)
7092 (or (bobp)
7093 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7094 ;; insert before the current line
7095 (open-line (if blank 2 1)))
7096 ((and (bolp)
7097 (not org-insert-heading-respect-content)
7098 (or (bobp)
7099 (save-excursion
7100 (backward-char 1) (not (outline-invisible-p)))))
7101 ;; insert right here
7102 nil)
7103 (t
7104 ;; somewhere in the line
7105 (save-excursion
7106 (setq previous-pos (point-at-bol))
7107 (end-of-line)
7108 (setq hide-previous (outline-invisible-p)))
7109 (and org-insert-heading-respect-content (org-show-subtree))
7110 (let ((split
7111 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7112 (save-excursion
7113 (let ((p (point)))
7114 (goto-char (point-at-bol))
7115 (and (looking-at org-complex-heading-regexp)
7116 (match-beginning 4)
7117 (> p (match-beginning 4)))))))
7118 tags pos)
7119 (cond
7120 (org-insert-heading-respect-content
7121 (org-end-of-subtree nil t)
7122 (when (featurep 'org-inlinetask)
7123 (while (and (not (eobp))
7125 (>= (length (match-string 1))
7126 org-inlinetask-min-level))
7127 (org-end-of-subtree nil t)))
7128 (or (bolp) (newline))
7129 (or (org-previous-line-empty-p)
7130 (and blank (newline)))
7131 (open-line 1))
7132 ((org-at-heading-p)
7133 (when hide-previous
7134 (show-children)
7135 (org-show-entry))
7137 (setq tags (and (match-end 2) (match-string 2)))
7138 (and (match-end 1)
7139 (delete-region (match-beginning 1) (match-end 1)))
7140 (setq pos (point-at-bol))
7141 (or split (end-of-line 1))
7142 (delete-horizontal-space)
7144 (buffer-substring (point-at-bol) (point)))
7145 (insert " "))
7146 (newline (if blank 2 1))
7147 (when tags
7148 (save-excursion
7149 (goto-char pos)
7150 (end-of-line 1)
7151 (insert " " tags)
7152 (org-set-tags nil 'align))))
7153 (t
7154 (or split (end-of-line 1))
7155 (newline (if blank 2 1)))))))
7156 (insert head) (just-one-space)
7157 (setq pos (point))
7158 (end-of-line 1)
7159 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7160 (when (and org-insert-heading-respect-content hide-previous)
7161 (save-excursion
7162 (goto-char previous-pos)
7163 (hide-subtree)))
7164 (run-hooks 'org-insert-heading-hook)))))
7166 (defun org-get-heading (&optional no-tags no-todo)
7167 "Return the heading of the current entry, without the stars.
7168 When NO-TAGS is non-nil, don't include tags.
7169 When NO-TODO is non-nil, don't include TODO keywords."
7170 (save-excursion
7171 (org-back-to-heading t)
7172 (cond
7173 ((and no-tags no-todo)
7174 (looking-at org-complex-heading-regexp)
7175 (match-string 4))
7176 (no-tags
7177 (looking-at (concat org-outline-regexp
7180 (match-string 1))
7181 (no-todo
7182 (looking-at org-todo-line-regexp)
7183 (match-string 3))
7184 (t (looking-at org-heading-regexp)
7185 (match-string 2)))))
7187 (defun org-heading-components ()
7188 "Return the components of the current heading.
7189 This is a list with the following elements:
7190 - the level as an integer
7191 - the reduced level, different if `org-odd-levels-only' is set.
7192 - the TODO keyword, or nil
7193 - the priority character, like ?A, or nil if no priority is given
7194 - the headline text itself, or the tags string if no headline text
7195 - the tags string, or nil."
7196 (save-excursion
7197 (org-back-to-heading t)
7198 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7199 (list (length (match-string 1))
7200 (org-reduced-level (length (match-string 1)))
7201 (org-match-string-no-properties 2)
7202 (and (match-end 3) (aref (match-string 3) 2))
7203 (org-match-string-no-properties 4)
7204 (org-match-string-no-properties 5)))))
7206 (defun org-get-entry ()
7207 "Get the entry text, after heading, entire subtree."
7208 (save-excursion
7209 (org-back-to-heading t)
7210 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7212 (defun org-insert-heading-after-current ()
7213 "Insert a new heading with same level as current, after current subtree."
7214 (interactive)
7215 (org-back-to-heading)
7216 (org-insert-heading)
7217 (org-move-subtree-down)
7218 (end-of-line 1))
7220 (defun org-insert-heading-respect-content ()
7221 (interactive)
7222 (let ((org-insert-heading-respect-content t))
7223 (org-insert-heading t)))
7225 (defun org-insert-todo-heading-respect-content (&optional force-state)
7226 (interactive "P")
7227 (let ((org-insert-heading-respect-content t))
7228 (org-insert-todo-heading force-state t)))
7230 (defun org-insert-todo-heading (arg &optional force-heading)
7231 "Insert a new heading with the same level and TODO state as current heading.
7232 If the heading has no TODO state, or if the state is DONE, use the first
7233 state (TODO by default). Also with prefix arg, force first state."
7234 (interactive "P")
7235 (when (or force-heading (not (org-insert-item 'checkbox)))
7236 (org-insert-heading force-heading)
7237 (save-excursion
7238 (org-back-to-heading)
7239 (outline-previous-heading)
7240 (looking-at org-todo-line-regexp))
7241 (let*
7242 ((new-mark-x
7243 (if (or arg
7244 (not (match-beginning 2))
7245 (member (match-string 2) org-done-keywords))
7246 (car org-todo-keywords-1)
7247 (match-string 2)))
7248 (new-mark
7249 (or
7250 (run-hook-with-args-until-success
7251 'org-todo-get-default-hook new-mark-x nil)
7252 new-mark-x)))
7253 (beginning-of-line 1)
7254 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7255 (if org-treat-insert-todo-heading-as-state-change
7256 (org-todo new-mark)
7257 (insert new-mark " "))))
7258 (when org-provide-todo-statistics
7259 (org-update-parent-todo-statistics))))
7261 (defun org-insert-subheading (arg)
7262 "Insert a new subheading and demote it.
7263 Works for outline headings and for plain lists alike."
7264 (interactive "P")
7265 (org-insert-heading arg)
7266 (cond
7267 ((org-at-heading-p) (org-do-demote))
7268 ((org-at-item-p) (org-indent-item))))
7270 (defun org-insert-todo-subheading (arg)
7271 "Insert a new subheading with TODO keyword or checkbox and demote it.
7272 Works for outline headings and for plain lists alike."
7273 (interactive "P")
7274 (org-insert-todo-heading arg)
7275 (cond
7276 ((org-at-heading-p) (org-do-demote))
7277 ((org-at-item-p) (org-indent-item))))
7279 ;;; Promotion and Demotion
7281 (defvar org-after-demote-entry-hook nil
7282 "Hook run after an entry has been demoted.
7283 The cursor will be at the beginning of the entry.
7284 When a subtree is being demoted, the hook will be called for each node.")
7286 (defvar org-after-promote-entry-hook nil
7287 "Hook run after an entry has been promoted.
7288 The cursor will be at the beginning of the entry.
7289 When a subtree is being promoted, the hook will be called for each node.")
7291 (defun org-promote-subtree ()
7292 "Promote the entire subtree.
7293 See also `org-promote'."
7294 (interactive)
7295 (save-excursion
7296 (org-with-limited-levels (org-map-tree 'org-promote)))
7297 (org-fix-position-after-promote))
7299 (defun org-demote-subtree ()
7300 "Demote the entire subtree. See `org-demote'.
7301 See also `org-promote'."
7302 (interactive)
7303 (save-excursion
7304 (org-with-limited-levels (org-map-tree 'org-demote)))
7305 (org-fix-position-after-promote))
7308 (defun org-do-promote ()
7309 "Promote the current heading higher up the tree.
7310 If the region is active in `transient-mark-mode', promote all headings
7311 in the region."
7312 (interactive)
7313 (save-excursion
7314 (if (org-region-active-p)
7315 (org-map-region 'org-promote (region-beginning) (region-end))
7316 (org-promote)))
7317 (org-fix-position-after-promote))
7319 (defun org-do-demote ()
7320 "Demote the current heading lower down the tree.
7321 If the region is active in `transient-mark-mode', demote all headings
7322 in the region."
7323 (interactive)
7324 (save-excursion
7325 (if (org-region-active-p)
7326 (org-map-region 'org-demote (region-beginning) (region-end))
7327 (org-demote)))
7328 (org-fix-position-after-promote))
7330 (defun org-fix-position-after-promote ()
7331 "Make sure that after pro/demotion cursor position is right."
7332 (let ((pos (point)))
7333 (when (save-excursion
7334 (beginning-of-line 1)
7335 (looking-at org-todo-line-regexp)
7336 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7337 (cond ((eobp) (insert " "))
7338 ((eolp) (insert " "))
7339 ((equal (char-after) ?\ ) (forward-char 1))))))
7341 (defun org-current-level ()
7342 "Return the level of the current entry, or nil if before the first headline.
7343 The level is the number of stars at the beginning of the headline."
7344 (save-excursion
7345 (org-with-limited-levels
7346 (if (ignore-errors (org-back-to-heading t))
7347 (funcall outline-level)))))
7349 (defun org-get-previous-line-level ()
7350 "Return the outline depth of the last headline before the current line.
7351 Returns 0 for the first headline in the buffer, and nil if before the
7352 first headline."
7353 (let ((current-level (org-current-level))
7354 (prev-level (when (> (line-number-at-pos) 1)
7355 (save-excursion
7356 (beginning-of-line 0)
7357 (org-current-level)))))
7358 (cond ((null current-level) nil) ; Before first headline
7359 ((null prev-level) 0) ; At first headline
7360 (prev-level))))
7362 (defun org-reduced-level (l)
7363 "Compute the effective level of a heading.
7364 This takes into account the setting of `org-odd-levels-only'."
7365 (cond
7366 ((zerop l) 0)
7367 (org-odd-levels-only (1+ (floor (/ l 2))))
7368 (t l)))
7370 (defun org-level-increment ()
7371 "Return the number of stars that will be added or removed at a
7372 time to headlines when structure editing, based on the value of
7373 `org-odd-levels-only'."
7374 (if org-odd-levels-only 2 1))
7376 (defun org-get-valid-level (level &optional change)
7377 "Rectify a level change under the influence of `org-odd-levels-only'
7378 LEVEL is a current level, CHANGE is by how much the level should be
7379 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7380 even level numbers will become the next higher odd number."
7381 (if org-odd-levels-only
7382 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7383 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7384 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7385 (max 1 (+ level (or change 0)))))
7387 (if (boundp 'define-obsolete-function-alias)
7388 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7389 (define-obsolete-function-alias 'org-get-legal-level
7390 'org-get-valid-level)
7391 (define-obsolete-function-alias 'org-get-legal-level
7392 'org-get-valid-level "23.1")))
7394 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7395 ;; ̀org-with-limited-levels'
7396 (defun org-promote ()
7397 "Promote the current heading higher up the tree.
7398 If the region is active in `transient-mark-mode', promote all headings
7399 in the region."
7400 (org-back-to-heading t)
7401 (let* ((level (save-match-data (funcall outline-level)))
7402 (after-change-functions (remove 'flyspell-after-change-function
7403 after-change-functions))
7404 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7405 (diff (abs (- level (length up-head) -1))))
7406 (cond ((and (= level 1) org-called-with-limited-levels
7407 org-allow-promoting-top-level-subtree)
7408 (replace-match "# " nil t))
7409 ((= level 1)
7410 (error "Cannot promote to level 0. UNDO to recover if necessary"))
7411 (t (replace-match up-head nil t)))
7412 ;; Fixup tag positioning
7413 (unless (= level 1)
7414 (and org-auto-align-tags (org-set-tags nil t))
7415 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7416 (run-hooks 'org-after-promote-entry-hook)))
7418 (defun org-demote ()
7419 "Demote the current heading lower down the tree.
7420 If the region is active in `transient-mark-mode', demote all headings
7421 in the region."
7422 (org-back-to-heading t)
7423 (let* ((level (save-match-data (funcall outline-level)))
7424 (after-change-functions (remove 'flyspell-after-change-function
7425 after-change-functions))
7426 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7427 (diff (abs (- level (length down-head) -1))))
7428 (replace-match down-head nil t)
7429 ;; Fixup tag positioning
7430 (and org-auto-align-tags (org-set-tags nil t))
7431 (if org-adapt-indentation (org-fixup-indentation diff))
7432 (run-hooks 'org-after-demote-entry-hook)))
7434 (defun org-cycle-level ()
7435 "Cycle the level of an empty headline through possible states.
7436 This goes first to child, then to parent, level, then up the hierarchy.
7437 After top level, it switches back to sibling level."
7438 (interactive)
7439 (let ((org-adapt-indentation nil))
7440 (when (org-point-at-end-of-empty-headline)
7441 (setq this-command 'org-cycle-level) ; Only needed for caching
7442 (let ((cur-level (org-current-level))
7443 (prev-level (org-get-previous-line-level)))
7444 (cond
7445 ;; If first headline in file, promote to top-level.
7446 ((= prev-level 0)
7447 (loop repeat (/ (- cur-level 1) (org-level-increment))
7448 do (org-do-promote)))
7449 ;; If same level as prev, demote one.
7450 ((= prev-level cur-level)
7451 (org-do-demote))
7452 ;; If parent is top-level, promote to top level if not already.
7453 ((= prev-level 1)
7454 (loop repeat (/ (- cur-level 1) (org-level-increment))
7455 do (org-do-promote)))
7456 ;; If top-level, return to prev-level.
7457 ((= cur-level 1)
7458 (loop repeat (/ (- prev-level 1) (org-level-increment))
7459 do (org-do-demote)))
7460 ;; If less than prev-level, promote one.
7461 ((< cur-level prev-level)
7462 (org-do-promote))
7463 ;; If deeper than prev-level, promote until higher than
7464 ;; prev-level.
7465 ((> cur-level prev-level)
7466 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7467 do (org-do-promote))))
7468 t))))
7470 (defun org-map-tree (fun)
7471 "Call FUN for every heading underneath the current one."
7472 (org-back-to-heading)
7473 (let ((level (funcall outline-level)))
7474 (save-excursion
7475 (funcall fun)
7476 (while (and (progn
7477 (outline-next-heading)
7478 (> (funcall outline-level) level))
7479 (not (eobp)))
7480 (funcall fun)))))
7482 (defun org-map-region (fun beg end)
7483 "Call FUN for every heading between BEG and END."
7484 (let ((org-ignore-region t))
7485 (save-excursion
7486 (setq end (copy-marker end))
7487 (goto-char beg)
7488 (if (and (re-search-forward org-outline-regexp-bol nil t)
7489 (< (point) end))
7490 (funcall fun))
7491 (while (and (progn
7492 (outline-next-heading)
7493 (< (point) end))
7494 (not (eobp)))
7495 (funcall fun)))))
7497 (defvar org-property-end-re) ; silence byte-compiler
7498 (defun org-fixup-indentation (diff)
7499 "Change the indentation in the current entry by DIFF.
7500 However, if any line in the current entry has no indentation, or if it
7501 would end up with no indentation after the change, nothing at all is done."
7502 (save-excursion
7503 (let ((end (save-excursion (outline-next-heading)
7504 (point-marker)))
7505 (prohibit (if (> diff 0)
7508 col)
7509 (unless (save-excursion (end-of-line 1)
7510 (re-search-forward prohibit end t))
7511 (while (and (< (point) end)
7513 (goto-char (match-end 0))
7514 (setq col (current-column))
7515 (if (< diff 0) (replace-match ""))
7516 (org-indent-to-column (+ diff col))))
7517 (move-marker end nil))))
7519 (defun org-convert-to-odd-levels ()
7520 "Convert an org-mode file with all levels allowed to one with odd levels.
7521 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7522 level 5 etc."
7523 (interactive)
7524 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7525 (let ((outline-level 'org-outline-level)
7526 (org-odd-levels-only nil) n)
7527 (save-excursion
7528 (goto-char (point-min))
7530 (setq n (- (length (match-string 0)) 2))
7531 (while (>= (setq n (1- n)) 0)
7532 (org-demote))
7533 (end-of-line 1))))))
7535 (defun org-convert-to-oddeven-levels ()
7536 "Convert an org-mode file with only odd levels to one with odd/even levels.
7537 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7538 file contains a section with an even level, conversion would
7539 destroy the structure of the file. An error is signaled in this
7540 case."
7541 (interactive)
7542 (goto-char (point-min))
7543 ;; First check if there are no even levels
7545 (org-show-context t)
7546 (error "Not all levels are odd in this file. Conversion not possible"))
7547 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7548 (let ((outline-regexp org-outline-regexp)
7549 (outline-level 'org-outline-level)
7550 (org-odd-levels-only nil) n)
7551 (save-excursion
7552 (goto-char (point-min))
7554 (setq n (/ (1- (length (match-string 0))) 2))
7555 (while (>= (setq n (1- n)) 0)
7556 (org-promote))
7557 (end-of-line 1))))))
7559 (defun org-tr-level (n)
7560 "Make N odd if required."
7561 (if org-odd-levels-only (1+ (/ n 2)) n))
7563 ;;; Vertical tree motion, cutting and pasting of subtrees
7565 (defun org-move-subtree-up (&optional arg)
7566 "Move the current subtree up past ARG headlines of the same level."
7567 (interactive "p")
7568 (org-move-subtree-down (- (prefix-numeric-value arg))))
7570 (defun org-move-subtree-down (&optional arg)
7571 "Move the current subtree down past ARG headlines of the same level."
7572 (interactive "p")
7573 (setq arg (prefix-numeric-value arg))
7574 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7575 'org-get-last-sibling))
7576 (ins-point (make-marker))
7577 (cnt (abs arg))
7578 (col (current-column))
7579 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7580 ;; Select the tree
7581 (org-back-to-heading)
7582 (setq beg0 (point))
7583 (save-excursion
7584 (setq ne-beg (org-back-over-empty-lines))
7585 (setq beg (point)))
7586 (save-match-data
7587 (save-excursion (outline-end-of-heading)
7588 (setq folded (outline-invisible-p)))
7589 (outline-end-of-subtree))
7590 (outline-next-heading)
7591 (setq ne-end (org-back-over-empty-lines))
7592 (setq end (point))
7593 (goto-char beg0)
7594 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7595 ;; include less whitespace
7596 (save-excursion
7597 (goto-char beg)
7598 (forward-line (- ne-beg ne-end))
7599 (setq beg (point))))
7600 ;; Find insertion point, with error handling
7601 (while (> cnt 0)
7602 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7603 (progn (goto-char beg0)
7604 (error "Cannot move past superior level or buffer limit")))
7605 (setq cnt (1- cnt)))
7606 (if (> arg 0)
7607 ;; Moving forward - still need to move over subtree
7608 (progn (org-end-of-subtree t t)
7609 (save-excursion
7610 (org-back-over-empty-lines)
7611 (or (bolp) (newline)))))
7612 (setq ne-ins (org-back-over-empty-lines))
7613 (move-marker ins-point (point))
7614 (setq txt (buffer-substring beg end))
7615 (org-save-markers-in-region beg end)
7616 (delete-region beg end)
7617 (org-remove-empty-overlays-at beg)
7618 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7619 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7621 (let ((bbb (point)))
7622 (insert-before-markers txt)
7623 (org-reinstall-markers-in-region bbb)
7624 (move-marker ins-point bbb))
7626 (setq ins-end (point))
7627 (goto-char ins-point)
7628 (org-skip-whitespace)
7629 (when (and (< arg 0)
7630 (org-first-sibling-p)
7631 (> ne-ins ne-beg))
7632 ;; Move whitespace back to beginning
7633 (save-excursion
7634 (goto-char ins-end)
7635 (let ((kill-whole-line t))
7636 (kill-line (- ne-ins ne-beg)) (point)))
7638 (move-marker ins-point nil)
7639 (if folded
7640 (hide-subtree)
7641 (org-show-entry)
7642 (show-children)
7643 (org-cycle-hide-drawers 'children))
7644 (org-clean-visibility-after-subtree-move)
7645 ;; move back to the initial column we were at
7646 (move-to-column col)))
7648 (defvar org-subtree-clip ""
7649 "Clipboard for cut and paste of subtrees.
7650 This is actually only a copy of the kill, because we use the normal kill
7651 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7653 (defvar org-subtree-clip-folded nil
7654 "Was the last copied subtree folded?
7655 This is used to fold the tree back after pasting.")
7657 (defun org-cut-subtree (&optional n)
7658 "Cut the current subtree into the clipboard.
7659 With prefix arg N, cut this many sequential subtrees.
7660 This is a short-hand for marking the subtree and then cutting it."
7661 (interactive "p")
7662 (org-copy-subtree n 'cut))
7664 (defun org-copy-subtree (&optional n cut force-store-markers)
7665 "Cut the current subtree into the clipboard.
7666 With prefix arg N, cut this many sequential subtrees.
7667 This is a short-hand for marking the subtree and then copying it.
7668 If CUT is non-nil, actually cut the subtree.
7669 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7670 of some markers in the region, even if CUT is non-nil. This is
7671 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7672 (interactive "p")
7673 (let (beg end folded (beg0 (point)))
7674 (if (org-called-interactively-p 'any)
7675 (org-back-to-heading nil) ; take what looks like a subtree
7676 (org-back-to-heading t)) ; take what is really there
7677 (setq beg (point))
7679 (save-match-data
7680 (save-excursion (outline-end-of-heading)
7681 (setq folded (outline-invisible-p)))
7682 (condition-case nil
7683 (org-forward-heading-same-level (1- n) t)
7684 (error nil))
7685 (org-end-of-subtree t t))
7686 (setq end (point))
7687 (goto-char beg0)
7688 (when (> end beg)
7689 (setq org-subtree-clip-folded folded)
7690 (when (or cut force-store-markers)
7691 (org-save-markers-in-region beg end))
7692 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7693 (setq org-subtree-clip (current-kill 0))
7694 (message "%s: Subtree(s) with %d characters"
7695 (if cut "Cut" "Copied")
7696 (length org-subtree-clip)))))
7698 (defun org-paste-subtree (&optional level tree for-yank)
7699 "Paste the clipboard as a subtree, with modification of headline level.
7700 The entire subtree is promoted or demoted in order to match a new headline
7701 level.
7703 If the cursor is at the beginning of a headline, the same level as
7704 that headline is used to paste the tree
7706 If not, the new level is derived from the *visible* headings
7707 before and after the insertion point, and taken to be the inferior headline
7708 level of the two. So if the previous visible heading is level 3 and the
7709 next is level 4 (or vice versa), level 4 will be used for insertion.
7710 This makes sure that the subtree remains an independent subtree and does
7711 not swallow low level entries.
7713 You can also force a different level, either by using a numeric prefix
7714 argument, or by inserting the heading marker by hand. For example, if the
7717 If optional TREE is given, use this text instead of the kill ring.
7719 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7720 move back over whitespace before inserting, and move point to the end of
7721 the inserted text when done."
7722 (interactive "P")
7723 (setq tree (or tree (and kill-ring (current-kill 0))))
7724 (unless (org-kill-is-subtree-p tree)
7725 (error "%s"
7726 (substitute-command-keys
7728 (org-with-limited-levels
7729 (let* ((visp (not (outline-invisible-p)))
7730 (txt tree)
7732 (old-level (if (string-match org-outline-regexp-bol txt)
7733 (- (match-end 0) (match-beginning 0) 1)
7734 -1))
7735 (force-level (cond (level (prefix-numeric-value level))
7737 (string-match
7739 (point-at-bol) (point))))
7740 (- (match-end 1) (match-beginning 1)))
7741 ((and (bolp)
7742 (looking-at org-outline-regexp))
7743 (- (match-end 0) (point) 1))))
7744 (previous-level (save-excursion
7745 (condition-case nil
7746 (progn
7747 (outline-previous-visible-heading 1)
7748 (if (looking-at ^re_)
7749 (- (match-end 0) (match-beginning 0) 1)
7750 1))
7751 (error 1))))
7752 (next-level (save-excursion
7753 (condition-case nil
7754 (progn
7755 (or (looking-at org-outline-regexp)
7756 (outline-next-visible-heading 1))
7757 (if (looking-at ^re_)
7758 (- (match-end 0) (match-beginning 0) 1)
7759 1))
7760 (error 1))))
7761 (new-level (or force-level (max previous-level next-level)))
7762 (shift (if (or (= old-level -1)
7763 (= new-level -1)
7764 (= old-level new-level))
7765 0
7766 (- new-level old-level)))
7767 (delta (if (> shift 0) -1 1))
7768 (func (if (> shift 0) 'org-demote 'org-promote))
7769 (org-odd-levels-only nil)
7770 beg end newend)
7771 ;; Remove the forced level indicator
7772 (if force-level
7773 (delete-region (point-at-bol) (point)))
7774 ;; Paste
7775 (beginning-of-line (if (bolp) 1 2))
7776 (setq beg (point))
7777 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7778 (insert-before-markers txt)
7780 (setq newend (point))
7781 (org-reinstall-markers-in-region beg)
7782 (setq end (point))
7783 (goto-char beg)
7785 (setq beg (point))
7786 (if (and (outline-invisible-p) visp)
7787 (save-excursion (outline-show-heading)))
7788 ;; Shift if necessary
7789 (unless (= shift 0)
7790 (save-restriction
7791 (narrow-to-region beg end)
7792 (while (not (= shift 0))
7793 (org-map-region func (point-min) (point-max))
7794 (setq shift (+ delta shift)))
7795 (goto-char (point-min))
7796 (setq newend (point-max))))
7797 (when (or (org-called-interactively-p 'interactive) for-yank)
7798 (message "Clipboard pasted as level %d subtree" new-level))
7799 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7800 kill-ring
7801 (eq org-subtree-clip (current-kill 0))
7802 org-subtree-clip-folded)
7803 ;; The tree was folded before it was killed/copied
7804 (hide-subtree))
7805 (and for-yank (goto-char newend)))))
7807 (defun org-kill-is-subtree-p (&optional txt)
7808 "Check if the current kill is an outline subtree, or a set of trees.
7809 Returns nil if kill does not start with a headline, or if the first
7810 headline level is not the largest headline level in the tree.
7811 So this will actually accept several entries of equal levels as well,
7812 which is OK for `org-paste-subtree'.
7813 If optional TXT is given, check this string instead of the current kill."
7814 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7815 (re (org-get-limited-outline-regexp))
7816 (^re (concat "^" re))
7817 (start-level (and kill
7818 (string-match
7820 kill)
7821 (- (match-end 2) (match-beginning 2) 1)))
7822 (start (1+ (or (match-beginning 2) -1))))
7823 (if (not start-level)
7824 (progn
7825 nil) ;; does not even start with a heading
7826 (catch 'exit
7827 (while (setq start (string-match ^re kill (1+ start)))
7828 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7829 (throw 'exit nil)))
7830 t))))
7832 (defvar org-markers-to-move nil
7833 "Markers that should be moved with a cut-and-paste operation.
7834 Those markers are stored together with their positions relative to
7835 the start of the region.")
7837 (defun org-save-markers-in-region (beg end)
7838 "Check markers in region.
7839 If these markers are between BEG and END, record their position relative
7840 to BEG, so that after moving the block of text, we can put the markers back
7841 into place.
7842 This function gets called just before an entry or tree gets cut from the
7843 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7844 called immediately, to move the markers with the entries."
7845 (setq org-markers-to-move nil)
7846 (when (featurep 'org-clock)
7847 (org-clock-save-markers-for-cut-and-paste beg end))
7848 (when (featurep 'org-agenda)
7849 (org-agenda-save-markers-for-cut-and-paste beg end)))
7851 (defun org-check-and-save-marker (marker beg end)
7852 "Check if MARKER is between BEG and END.
7853 If yes, remember the marker and the distance to BEG."
7854 (when (and (marker-buffer marker)
7855 (equal (marker-buffer marker) (current-buffer)))
7856 (if (and (>= marker beg) (< marker end))
7857 (push (cons marker (- marker beg)) org-markers-to-move))))
7859 (defun org-reinstall-markers-in-region (beg)
7860 "Move all remembered markers to their position relative to BEG."
7861 (mapc (lambda (x)
7862 (move-marker (car x) (+ beg (cdr x))))
7863 org-markers-to-move)
7864 (setq org-markers-to-move nil))
7866 (defun org-narrow-to-subtree ()
7867 "Narrow buffer to the current subtree."
7868 (interactive)
7869 (save-excursion
7870 (save-match-data
7871 (org-with-limited-levels
7872 (narrow-to-region
7873 (progn (org-back-to-heading t) (point))
7874 (progn (org-end-of-subtree t t)
7875 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7876 (point)))))))
7878 (defun org-narrow-to-block ()
7879 "Narrow buffer to the current block."
7880 (interactive)
7881 (let* ((case-fold-search t)
7884 (if blockp
7885 (narrow-to-region (car blockp) (cdr blockp))
7886 (error "Not in a block"))))
7888 (eval-when-compile
7889 (defvar org-property-drawer-re))
7891 (defvar org-property-start-re) ;; defined below
7892 (defun org-clone-subtree-with-time-shift (n &optional shift)
7893 "Clone the task (subtree) at point N times.
7894 The clones will be inserted as siblings.
7896 In interactive use, the user will be prompted for the number of
7897 clones to be produced, and for a time SHIFT, which may be a
7898 repeater as used in time stamps, for example `+3d'.
7900 When a valid repeater is given and the entry contains any time
7901 stamps, the clones will become a sequence in time, with time
7902 stamps in the subtree shifted for each clone produced. If SHIFT
7903 is nil or the empty string, time stamps will be left alone. The
7904 ID property of the original subtree is removed.
7906 If the original subtree did contain time stamps with a repeater,
7907 the following will happen:
7908 - the repeater will be removed in each clone
7909 - an additional clone will be produced, with the current, unshifted
7910 date(s) in the entry.
7911 - the original entry will be placed *after* all the clones, with
7912 repeater intact.
7913 - the start days in the repeater in the original entry will be shifted
7914 to past the last clone.
7915 In this way you can spell out a number of instances of a repeating task,
7916 and still retain the repeater to cover future instances of the task."
7917 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7918 (let (beg end template task idprop
7919 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7920 (drawer-re org-drawer-regexp))
7921 (if (not (and (integerp n) (> n 0)))
7922 (error "Invalid number of replications %s" n))
7925 shift)))
7926 (error "Invalid shift specification %s" shift))
7927 (when doshift
7928 (setq shift-n (string-to-number (match-string 1 shift))
7929 shift-what (cdr (assoc (match-string 2 shift)
7930 '(("d" . day) ("w" . week)
7931 ("m" . month) ("y" . year))))))
7932 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7933 (setq nmin 1 nmax n)
7934 (org-back-to-heading t)
7935 (setq beg (point))
7936 (setq idprop (org-entry-get nil "ID"))
7937 (org-end-of-subtree t t)
7939 (setq end (point))
7940 (setq template (buffer-substring beg end))
7941 (when (and doshift
7943 (delete-region beg end)
7944 (setq end beg)
7945 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7946 (goto-char end)
7947 (loop for n from nmin to nmax do
7948 ;; prepare clone
7949 (with-temp-buffer
7950 (insert template)
7951 (org-mode)
7952 (goto-char (point-min))
7953 (org-show-subtree)
7954 (and idprop (if org-clone-delete-id
7955 (org-entry-delete nil "ID")
7956 (org-id-get-create t)))
7957 (unless (= n 0)
7959 (kill-whole-line))
7960 (goto-char (point-min))
7961 (while (re-search-forward drawer-re nil t)
7962 (mapc (lambda (d)
7963 (org-remove-empty-drawer-at d (point))) org-drawers)))
7964 (goto-char (point-min))
7965 (when doshift
7966 (while (re-search-forward org-ts-regexp-both nil t)
7967 (org-timestamp-change (* n shift-n) shift-what))
7968 (unless (= n n-no-remove)
7969 (goto-char (point-min))
7970 (while (re-search-forward org-ts-regexp nil t)
7971 (save-excursion
7972 (goto-char (match-beginning 0))
7974 (delete-region (match-beginning 1) (match-end 1)))))))
7975 (setq task (buffer-string)))
7976 (insert task))
7977 (goto-char beg)))
7979 ;;; Outline Sorting
7981 (defun org-sort (with-case)
7982 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7983 Optional argument WITH-CASE means sort case-sensitively."
7984 (interactive "P")
7985 (cond
7986 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7987 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7988 (t
7989 (org-call-with-arg 'org-sort-entries with-case))))
7991 (defun org-sort-remove-invisible (s)
7992 (remove-text-properties 0 (length s) org-rm-props s)
7993 (while (string-match org-bracket-link-regexp s)
7994 (setq s (replace-match (if (match-end 2)
7995 (match-string 3 s)
7996 (match-string 1 s)) t t s)))
7997 s)
7999 (defvar org-priority-regexp) ; defined later in the file
8001 (defvar org-after-sorting-entries-or-items-hook nil
8002 "Hook that is run after a bunch of entries or items have been sorted.
8003 When children are sorted, the cursor is in the parent line when this
8004 hook gets called. When a region or a plain list is sorted, the cursor
8005 will be in the first entry of the sorted region/list.")
8007 (defun org-sort-entries
8008 (&optional with-case sorting-type getkey-func compare-func property)
8009 "Sort entries on a certain level of an outline tree.
8010 If there is an active region, the entries in the region are sorted.
8011 Else, if the cursor is before the first entry, sort the top-level items.
8012 Else, the children of the entry at point are sorted.
8014 Sorting can be alphabetically, numerically, by date/time as given by
8015 a time stamp, by a property or by priority.
8017 The command prompts for the sorting type unless it has been given to the
8018 function through the SORTING-TYPE argument, which needs to be a character,
8019 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8020 precise meaning of each character:
8022 n Numerically, by converting the beginning of the entry/item to a number.
8023 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8024 o By order of TODO keywords.
8025 t By date/time, either the first active time stamp in the entry, or, if
8026 none exist, by the first inactive one.
8027 s By the scheduled date/time.
8028 d By deadline date/time.
8029 c By creation time, which is assumed to be the first inactive time stamp
8030 at the beginning of a line.
8031 p By priority according to the cookie.
8032 r By the value of a property.
8034 Capital letters will reverse the sort order.
8036 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8037 called with point at the beginning of the record. It must return either
8038 a string or a number that should serve as the sorting key for that record.
8040 Comparing entries ignores case by default. However, with an optional argument
8041 WITH-CASE, the sorting considers case as well."
8042 (interactive "P")
8043 (let ((case-func (if with-case 'identity 'downcase))
8044 (cmstr
8045 ;; The clock marker is lost when using `sort-subr', let's
8046 ;; store the clocking string.
8047 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8048 (save-excursion
8049 (goto-char org-clock-marker)
8050 (looking-back "^.*") (match-string-no-properties 0))))
8051 start beg end stars re re2
8052 txt what tmp)
8053 ;; Find beginning and end of region to sort
8054 (cond
8055 ((org-region-active-p)
8056 ;; we will sort the region
8057 (setq end (region-end)
8058 what "region")
8059 (goto-char (region-beginning))
8060 (if (not (org-at-heading-p)) (outline-next-heading))
8061 (setq start (point)))
8062 ((or (org-at-heading-p)
8063 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8064 ;; we will sort the children of the current headline
8065 (org-back-to-heading)
8066 (setq start (point)
8067 end (progn (org-end-of-subtree t t)
8069 (org-back-over-empty-lines)
8070 (point))
8071 what "children")
8072 (goto-char start)
8073 (show-subtree)
8074 (outline-next-heading))
8075 (t
8076 ;; we will sort the top-level entries in this file
8077 (goto-char (point-min))
8078 (or (org-at-heading-p) (outline-next-heading))
8079 (setq start (point))
8080 (goto-char (point-max))
8081 (beginning-of-line 1)
8083 ;; File ends in a non-white line
8084 (end-of-line 1)
8086 (setq end (point-max))
8087 (setq what "top-level")
8088 (goto-char start)
8089 (show-all)))
8091 (setq beg (point))
8092 (if (>= beg end) (error "Nothing to sort"))
8095 (setq stars (match-string 1)
8096 re (concat "^" (regexp-quote stars) " +")
8098 txt (buffer-substring beg end))
8100 (if (and (not (equal stars "*")) (string-match re2 txt))
8101 (error "Region to sort contains a level above the first entry"))
8103 (unless sorting-type
8104 (message
8105 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8107 A/N/P/R/O/F/T/S/D/C means reversed:"
8108 what)
8109 (setq sorting-type (read-char-exclusive))
8111 (and (= (downcase sorting-type) ?f)
8112 (setq getkey-func
8113 (org-icompleting-read "Sort using function: "
8114 obarray 'fboundp t nil nil))
8115 (setq getkey-func (intern getkey-func)))
8117 (and (= (downcase sorting-type) ?r)
8118 (setq property
8119 (org-icompleting-read "Property: "
8120 (mapcar 'list (org-buffer-property-keys t))
8121 nil t))))
8123 (message "Sorting entries...")
8125 (save-restriction
8126 (narrow-to-region start end)
8127 (let ((dcst (downcase sorting-type))
8128 (case-fold-search nil)
8129 (now (current-time)))
8130 (sort-subr
8131 (/= dcst sorting-type)
8132 ;; This function moves to the beginning character of the "record" to
8133 ;; be sorted.
8134 (lambda nil
8135 (if (re-search-forward re nil t)
8136 (goto-char (match-beginning 0))
8137 (goto-char (point-max))))
8138 ;; This function moves to the last character of the "record" being
8139 ;; sorted.
8140 (lambda nil
8141 (save-match-data
8142 (condition-case nil
8143 (outline-forward-same-level 1)
8144 (error
8145 (goto-char (point-max))))))
8146 ;; This function returns the value that gets sorted against.
8147 (lambda nil
8148 (cond
8149 ((= dcst ?n)
8150 (if (looking-at org-complex-heading-regexp)
8151 (string-to-number (match-string 4))
8152 nil))
8153 ((= dcst ?a)
8154 (if (looking-at org-complex-heading-regexp)
8155 (funcall case-func (match-string 4))
8156 nil))
8157 ((= dcst ?t)
8158 (let ((end (save-excursion (outline-next-heading) (point))))
8159 (if (or (re-search-forward org-ts-regexp end t)
8160 (re-search-forward org-ts-regexp-both end t))
8161 (org-time-string-to-seconds (match-string 0))
8162 (org-float-time now))))
8163 ((= dcst ?c)
8164 (let ((end (save-excursion (outline-next-heading) (point))))
8165 (if (re-search-forward
8167 end t)
8168 (org-time-string-to-seconds (match-string 0))
8169 (org-float-time now))))
8170 ((= dcst ?s)
8171 (let ((end (save-excursion (outline-next-heading) (point))))
8172 (if (re-search-forward org-scheduled-time-regexp end t)
8173 (org-time-string-to-seconds (match-string 1))
8174 (org-float-time now))))
8175 ((= dcst ?d)
8176 (let ((end (save-excursion (outline-next-heading) (point))))
8177 (if (re-search-forward org-deadline-time-regexp end t)
8178 (org-time-string-to-seconds (match-string 1))
8179 (org-float-time now))))
8180 ((= dcst ?p)
8181 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8182 (string-to-char (match-string 2))
8183 org-default-priority))
8184 ((= dcst ?r)
8185 (or (org-entry-get nil property) ""))
8186 ((= dcst ?o)
8187 (if (looking-at org-complex-heading-regexp)
8188 (- 9999 (length (member (match-string 2)
8189 org-todo-keywords-1)))))
8190 ((= dcst ?f)
8191 (if getkey-func
8192 (progn
8193 (setq tmp (funcall getkey-func))
8194 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8195 tmp)
8196 (error "Invalid key function `%s'" getkey-func)))
8197 (t (error "Invalid sorting type `%c'" sorting-type))))
8198 nil
8199 (cond
8200 ((= dcst ?a) 'string<)
8201 ((= dcst ?f) compare-func)
8202 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8203 (run-hooks 'org-after-sorting-entries-or-items-hook)
8204 ;; Reset the clock marker if needed
8205 (when cmstr
8206 (save-excursion
8207 (goto-char start)
8208 (search-forward cmstr nil t)
8209 (move-marker org-clock-marker (point))))
8210 (message "Sorting entries...done")))
8212 (defun org-do-sort (table what &optional with-case sorting-type)
8213 "Sort TABLE of WHAT according to SORTING-TYPE.
8214 The user will be prompted for the SORTING-TYPE if the call to this
8215 function does not specify it. WHAT is only for the prompt, to indicate
8216 what is being sorted. The sorting key will be extracted from
8217 the car of the elements of the table.
8218 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8219 (unless sorting-type
8220 (message
8221 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8222 what)
8223 (setq sorting-type (read-char-exclusive)))
8224 (let ((dcst (downcase sorting-type))
8225 extractfun comparefun)
8226 ;; Define the appropriate functions
8227 (cond
8228 ((= dcst ?n)
8229 (setq extractfun 'string-to-number
8230 comparefun (if (= dcst sorting-type) '< '>)))
8231 ((= dcst ?a)
8232 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8233 (lambda(x) (downcase (org-sort-remove-invisible x))))
8234 comparefun (if (= dcst sorting-type)
8235 'string<
8236 (lambda (a b) (and (not (string< a b))
8237 (not (string= a b)))))))
8238 ((= dcst ?t)
8239 (setq extractfun
8240 (lambda (x)
8241 (if (or (string-match org-ts-regexp x)
8242 (string-match org-ts-regexp-both x))
8243 (org-float-time
8244 (org-time-string-to-time (match-string 0 x)))
8245 0))
8246 comparefun (if (= dcst sorting-type) '< '>)))
8247 (t (error "Invalid sorting type `%c'" sorting-type)))
8249 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8250 table)
8251 (lambda (a b) (funcall comparefun (car a) (car b))))))
8254 ;;; The orgstruct minor mode
8256 ;; Define a minor mode which can be used in other modes in order to
8257 ;; integrate the org-mode structure editing commands.
8259 ;; This is really a hack, because the org-mode structure commands use
8260 ;; keys which normally belong to the major mode. Here is how it
8261 ;; works: The minor mode defines all the keys necessary to operate the
8262 ;; structure commands, but wraps the commands into a function which
8263 ;; tests if the cursor is currently at a headline or a plain list
8264 ;; item. If that is the case, the structure command is used,
8265 ;; temporarily setting many Org-mode variables like regular
8266 ;; expressions for filling etc. However, when any of those keys is
8267 ;; used at a different location, function uses `key-binding' to look
8268 ;; up if the key has an associated command in another currently active
8269 ;; keymap (minor modes, major mode, global), and executes that
8270 ;; command. There might be problems if any of the keys is otherwise
8271 ;; used as a prefix key.
8273 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8274 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8275 ;; addresses this by checking explicitly for both bindings.
8277 (defvar orgstruct-mode-map (make-sparse-keymap)
8278 "Keymap for the minor `orgstruct-mode'.")
8280 (defvar org-local-vars nil
8281 "List of local variables, for use by `orgstruct-mode'.")
8283 ;;;###autoload
8284 (define-minor-mode orgstruct-mode
8285 "Toggle the minor mode `orgstruct-mode'.
8286 This mode is for using Org-mode structure commands in other
8287 modes. The following keys behave as if Org-mode were active, if
8288 the cursor is on a headline, or on a plain list item (both as
8289 defined by Org-mode).
8291 M-up Move entry/item up
8292 M-down Move entry/item down
8293 M-left Promote
8294 M-right Demote
8295 M-S-up Move entry/item up
8296 M-S-down Move entry/item down
8297 M-S-left Promote subtree
8298 M-S-right Demote subtree
8299 M-q Fill paragraph and items like in Org-mode
8300 C-c ^ Sort entries
8301 C-c - Cycle list bullet
8302 TAB Cycle item visibility
8303 M-RET Insert new heading/item
8304 S-M-RET Insert new TODO heading / Checkbox item
8305 C-c C-c Set tags / toggle checkbox"
8306 nil " OrgStruct" nil
8307 (org-load-modules-maybe)
8308 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8310 ;;;###autoload
8311 (defun turn-on-orgstruct ()
8312 "Unconditionally turn on `orgstruct-mode'."
8313 (orgstruct-mode 1))
8315 (defvar org-fb-vars nil)
8316 (make-variable-buffer-local 'org-fb-vars)
8317 (defun orgstruct++-mode (&optional arg)
8318 "Toggle `orgstruct-mode', the enhanced version of it.
8319 In addition to setting orgstruct-mode, this also exports all
8320 indentation and autofilling variables from org-mode into the
8321 buffer. It will also recognize item context in multiline items."
8322 (interactive "P")
8323 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8324 (if (< arg 1)
8325 (progn (orgstruct-mode -1)
8326 (mapc (lambda(v)
8327 (org-set-local (car v)
8328 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8329 org-fb-vars))
8330 (orgstruct-mode 1)
8331 (setq org-fb-vars nil)
8332 (let (var val)
8333 (mapc
8334 (lambda (x)
8335 (when (string-match
8337 (symbol-name (car x)))
8338 (setq var (car x) val (nth 1 x))
8339 (push (list var `(quote ,(eval var))) org-fb-vars)
8340 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8341 org-local-vars)
8342 (org-set-local 'orgstruct-is-++ t))))
8344 (defvar orgstruct-is-++ nil
8345 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8346 (make-variable-buffer-local 'orgstruct-is-++)
8348 ;;;###autoload
8349 (defun turn-on-orgstruct++ ()
8350 "Unconditionally turn on `orgstruct++-mode'."
8351 (orgstruct++-mode 1))
8353 (defun orgstruct-error ()
8354 "Error when there is no default binding for a structure key."
8355 (interactive)
8356 (error "This key has no function outside structure elements"))
8358 (defun orgstruct-setup ()
8359 "Setup orgstruct keymaps."
8360 (let ((nfunc 0)
8361 (bindings
8362 (list
8363 '([(meta up)] org-metaup)
8364 '([(meta down)] org-metadown)
8365 '([(meta left)] org-metaleft)
8366 '([(meta right)] org-metaright)
8367 '([(meta shift up)] org-shiftmetaup)
8368 '([(meta shift down)] org-shiftmetadown)
8369 '([(meta shift left)] org-shiftmetaleft)
8370 '([(meta shift right)] org-shiftmetaright)
8371 '([?\e (up)] org-metaup)
8372 '([?\e (down)] org-metadown)
8373 '([?\e (left)] org-metaleft)
8374 '([?\e (right)] org-metaright)
8375 '([?\e (shift up)] org-shiftmetaup)
8376 '([?\e (shift down)] org-shiftmetadown)
8377 '([?\e (shift left)] org-shiftmetaleft)
8378 '([?\e (shift right)] org-shiftmetaright)
8379 '([(shift up)] org-shiftup)
8380 '([(shift down)] org-shiftdown)
8381 '([(shift left)] org-shiftleft)
8382 '([(shift right)] org-shiftright)
8383 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8384 '("\M-q" fill-paragraph)
8385 '("\C-c^" org-sort)
8386 '("\C-c-" org-cycle-list-bullet)))
8387 elt key fun cmd)
8388 (while (setq elt (pop bindings))
8389 (setq nfunc (1+ nfunc))
8390 (setq key (org-key (car elt))
8391 fun (nth 1 elt)
8392 cmd (orgstruct-make-binding fun nfunc key))
8393 (org-defkey orgstruct-mode-map key cmd))
8395 ;; Prevent an error for users who forgot to make autoloads
8396 (require 'org-element)
8398 ;; Special treatment needed for TAB and RET
8399 (org-defkey orgstruct-mode-map [(tab)]
8400 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8401 (org-defkey orgstruct-mode-map "\C-i"
8402 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8404 (org-defkey orgstruct-mode-map "\M-\C-m"
8405 (orgstruct-make-binding 'org-insert-heading 105
8406 "\M-\C-m" [(meta return)]))
8407 (org-defkey orgstruct-mode-map [(meta return)]
8408 (orgstruct-make-binding 'org-insert-heading 106
8409 [(meta return)] "\M-\C-m"))
8411 (org-defkey orgstruct-mode-map [(shift meta return)]
8412 (orgstruct-make-binding 'org-insert-todo-heading 107
8413 [(meta return)] "\M-\C-m"))
8415 (org-defkey orgstruct-mode-map "\e\C-m"
8416 (orgstruct-make-binding 'org-insert-heading 108
8417 "\e\C-m" [?\e (return)]))
8418 (org-defkey orgstruct-mode-map [?\e (return)]
8419 (orgstruct-make-binding 'org-insert-heading 109
8420 [?\e (return)] "\e\C-m"))
8421 (org-defkey orgstruct-mode-map [?\e (shift return)]
8422 (orgstruct-make-binding 'org-insert-todo-heading 110
8423 [?\e (return)] "\e\C-m"))
8425 (unless org-local-vars
8426 (setq org-local-vars (org-get-local-variables)))
8428 t))
8430 (defun orgstruct-make-binding (fun n &rest keys)
8431 "Create a function for binding in the structure minor mode.
8432 FUN is the command to call inside a table. N is used to create a unique
8433 command name. KEYS are keys that should be checked in for a command
8434 to execute outside of tables."
8435 (eval
8436 (list 'defun
8437 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8438 '(arg)
8440 "Outside of structure, run the binding of `"
8441 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8442 "'.")
8443 '(interactive "p")
8444 (list 'if
8445 `(org-context-p 'headline 'item
8446 (and orgstruct-is-++
8447 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8448 'item-body))
8449 (list 'org-run-like-in-org-mode (list 'quote fun))
8450 (list 'let '(orgstruct-mode)
8451 (list 'call-interactively
8452 (append '(or)
8453 (mapcar (lambda (k)
8454 (list 'key-binding k))
8455 keys)
8456 '('orgstruct-error))))))))
8458 (defun org-contextualize-keys (alist contexts)
8459 "Return valid elements in ALIST depending on CONTEXTS.
8461 `org-agenda-custom-commands' or `org-capture-templates' are the
8462 values used for ALIST, and `org-agenda-custom-commands-contexts'
8463 or `org-capture-templates-contexts' are the associated contexts
8464 definitions."
8465 (let ((contexts
8466 ;; normalize contexts
8467 (mapcar
8468 (lambda(c) (cond ((listp (cadr c))
8469 (list (car c) (car c) (cadr c)))
8470 ((string= "" (cadr c))
8471 (list (car c) (car c) (caddr c)))
8472 (t c))) contexts))
8473 (a alist) c r s)
8474 ;; loop over all commands or templates
8475 (while (setq c (pop a))
8476 (let (vrules repl)
8477 (cond
8478 ((not (assoc (car c) contexts))
8479 (push c r))
8480 ((and (assoc (car c) contexts)
8481 (setq vrules (org-contextualize-validate-key
8482 (car c) contexts)))
8483 (mapc (lambda (vr)
8484 (when (not (equal (car vr) (cadr vr)))
8485 (setq repl vr))) vrules)
8486 (if (not repl) (push c r)
8487 (push (cadr repl) s)
8488 (push
8489 (cons (car c)
8490 (cdr (or (assoc (cadr repl) alist)
8491 (error "Undefined key `%s' as contextual replacement for `%s'"
8492 (cadr repl) (car c)))))
8493 r))))))
8494 ;; Return limited ALIST, possibly with keys modified, and deduplicated
8495 (delq
8496 nil
8497 (delete-dups
8498 (mapcar (lambda (x)
8499 (let ((tpl (car x)))
8500 (when (not (delq
8501 nil
8502 (mapcar (lambda(y)
8503 (equal y tpl)) s))) x)))
8504 (reverse r))))))
8506 (defun org-contextualize-validate-key (key contexts)
8507 "Check CONTEXTS for agenda or capture KEY."
8508 (let (r rr res)
8509 (while (setq r (pop contexts))
8510 (mapc
8511 (lambda (rr)
8512 (when
8513 (and (equal key (car r))
8514 (if (functionp rr) (funcall rr)
8515 (or (and (eq (car rr) 'in-file)
8516 (buffer-file-name)
8517 (string-match (cdr rr) (buffer-file-name)))
8518 (and (eq (car rr) 'in-mode)
8519 (string-match (cdr rr) (symbol-name major-mode)))
8520 (when (and (eq (car rr) 'not-in-file)
8521 (buffer-file-name))
8522 (not (string-match (cdr rr) (buffer-file-name))))
8523 (when (eq (car rr) 'not-in-mode)
8524 (not (string-match (cdr rr) (symbol-name major-mode)))))))
8525 (push r res)))
8526 (car (last r))))
8527 (delete-dups (delq nil res))))
8529 (defun org-context-p (&rest contexts)
8530 "Check if local context is any of CONTEXTS.
8531 Possible values in the list of contexts are `table', `headline', and `item'."
8532 (let ((pos (point)))
8533 (goto-char (point-at-bol))
8534 (prog1 (or (and (memq 'table contexts)
8536 (and (memq 'headline contexts)
8537 (looking-at org-outline-regexp))
8538 (and (memq 'item contexts)
8540 (and (memq 'item-body contexts)
8541 (org-in-item-p)))
8542 (goto-char pos))))
8544 (defun org-get-local-variables ()
8545 "Return a list of all local variables in an Org mode buffer."
8546 (let (varlist)
8547 (with-current-buffer (get-buffer-create "*Org tmp*")
8548 (erase-buffer)
8549 (org-mode)
8550 (setq varlist (buffer-local-variables)))
8551 (kill-buffer "*Org tmp*")
8552 (delq nil
8553 (mapcar
8554 (lambda (x)
8555 (setq x
8556 (if (symbolp x)
8557 (list x)
8558 (list (car x) (list 'quote (cdr x)))))
8559 (if (string-match
8560 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
8561 (symbol-name (car x)))
8562 x nil))
8563 varlist))))
8565 (defun org-clone-local-variables (from-buffer &optional regexp)
8566 "Clone local variables from FROM-BUFFER.
8567 Optional argument REGEXP selects variables to clone."
8568 (mapc
8569 (lambda (pair)
8570 (and (symbolp (car pair))
8571 (or (null regexp)
8572 (string-match regexp (symbol-name (car pair))))
8573 (set (make-local-variable (car pair))
8574 (cdr pair))))
8575 (buffer-local-variables from-buffer)))
8577 ;;;###autoload
8578 (defun org-run-like-in-org-mode (cmd)
8579 "Run a command, pretending that the current buffer is in Org-mode.
8580 This will temporarily bind local variables that are typically bound in
8581 Org-mode to the values they have in Org-mode, and then interactively
8582 call CMD."
8583 (org-load-modules-maybe)
8584 (unless org-local-vars
8585 (setq org-local-vars (org-get-local-variables)))
8586 (eval (list 'let org-local-vars
8587 (list 'call-interactively (list 'quote cmd)))))
8589 ;;;; Archiving
8591 (defun org-get-category (&optional pos force-refresh)
8592 "Get the category applying to position POS."
8593 (save-match-data
8594 (if force-refresh (org-refresh-category-properties))
8595 (let ((pos (or pos (point))))
8596 (or (get-text-property pos 'org-category)
8597 (progn (org-refresh-category-properties)
8598 (get-text-property pos 'org-category))))))
8600 (defun org-refresh-category-properties ()
8601 "Refresh category text properties in the buffer."
8602 (let ((case-fold-search t)
8603 (inhibit-read-only t)
8604 (def-cat (cond
8605 ((null org-category)
8606 (if buffer-file-name
8607 (file-name-sans-extension
8608 (file-name-nondirectory buffer-file-name))
8609 "???"))
8610 ((symbolp org-category) (symbol-name org-category))
8611 (t org-category)))
8612 beg end cat pos optionp)
8613 (org-unmodified
8614 (save-excursion
8615 (save-restriction
8616 (widen)
8617 (goto-char (point-min))
8618 (put-text-property (point) (point-max) 'org-category def-cat)
8619 (while (re-search-forward
8621 (setq pos (match-end 0)
8622 optionp (equal (char-after (match-beginning 0)) ?#)
8623 cat (org-trim (match-string 2)))
8624 (if optionp
8625 (setq beg (point-at-bol) end (point-max))
8626 (org-back-to-heading t)
8627 (setq beg (point) end (org-end-of-subtree t t)))
8628 (put-text-property beg end 'org-category cat)
8629 (put-text-property beg end 'org-category-position beg)
8630 (goto-char pos)))))))
8633 ;;;; Link Stuff
8635 ;;; Link abbreviations
8637 (defun org-link-expand-abbrev (link)
8638 "Apply replacements as defined in `org-link-abbrev-alist'."
8640 (let* ((key (match-string 1 link))
8641 (as (or (assoc key org-link-abbrev-alist-local)
8642 (assoc key org-link-abbrev-alist)))
8643 (tag (and (match-end 2) (match-string 3 link)))
8644 rpl)
8645 (if (not as)
8646 link
8647 (setq rpl (cdr as))
8648 (cond
8649 ((symbolp rpl) (funcall rpl tag))
8651 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
8652 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8653 ((string-match "%h" rpl)
8654 (replace-match (url-hexify-string (or tag "")) t t rpl))
8655 (t (concat rpl tag)))))
8656 link))
8658 ;;; Storing and inserting links
8660 (defvar org-insert-link-history nil
8661 "Minibuffer history for links inserted with `org-insert-link'.")
8663 (defvar org-stored-links nil
8664 "Contains the links stored with `org-store-link'.")
8666 (defvar org-store-link-plist nil
8667 "Plist with info about the most recently link created with `org-store-link'.")
8669 (defvar org-link-protocols nil
8670 "Link protocols added to Org-mode using `org-add-link-type'.")
8672 (defvar org-store-link-functions nil
8673 "List of functions that are called to create and store a link.
8674 Each function will be called in turn until one returns a non-nil
8675 value. Each function should check if it is responsible for creating
8676 this link (for example by looking at the major mode).
8677 If not, it must exit and return nil.
8678 If yes, it should return a non-nil value after a calling
8679 `org-store-link-props' with a list of properties and values.
8680 Special properties are:
8684 This is obligatory as well.
8685 :description Optional default description for the second pair
8686 of brackets in an Org-mode link. The user can still change
8687 this when inserting this link into an Org-mode buffer.
8689 In addition to these, any additional properties can be specified
8690 and then used in capture templates.")
8692 (defun org-add-link-type (type &optional follow export)
8693 "Add TYPE to the list of `org-link-types'.
8694 Re-compute all regular expressions depending on `org-link-types'
8696 FOLLOW and EXPORT are two functions.
8698 FOLLOW should take the link path as the single argument and do whatever
8699 is necessary to follow the link, for example find a file or display
8700 a mail message.
8702 EXPORT should format the link path for export to one of the export formats.
8703 It should be a function accepting three arguments:
8706 desc the description of the link, if any, or a description added by
8707 org-export-normalize-links if there is none
8708 format the export format, a symbol like `html' or `latex' or `ascii'..
8710 The function may use the FORMAT information to return different values
8711 depending on the format. The return value will be put literally into
8712 the exported file. If the return value is nil, this means Org should
8713 do what it normally does with links which do not have EXPORT defined.
8715 Org-mode has a built-in default for exporting links. If you are happy with
8716 this default, there is no need to define an export function for the link
8717 type. For a simple example of an export function, see `org-bbdb.el'."
8718 (add-to-list 'org-link-types type t)
8719 (org-make-link-regexps)
8720 (if (assoc type org-link-protocols)
8721 (setcdr (assoc type org-link-protocols) (list follow export))
8722 (push (list type follow export) org-link-protocols)))
8724 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
8725 (defvar org-link-to-org-use-id) ; Defined in org-id.el
8727 ;;;###autoload
8728 (defun org-store-link (arg)
8730 This link is added to `org-stored-links' and can later be inserted
8733 For some link types, a prefix arg is interpreted:
8734 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8735 For file links, arg negates `org-context-in-file-links'."
8736 (interactive "P")
8737 (org-load-modules-maybe)
8738 (setq org-store-link-plist nil) ; reset
8739 (org-with-limited-levels
8740 (let (link cpltxt desc description search txt custom-id agenda-link)
8741 (cond
8743 ((run-hook-with-args-until-success 'org-store-link-functions)
8744 (setq link (plist-get org-store-link-plist :link)
8745 desc (or (plist-get org-store-link-plist :description) link)))
8747 ((org-src-edit-buffer-p)
8748 (let (label gc)
8749 (while (or (not label)
8750 (save-excursion
8751 (save-restriction
8752 (widen)
8753 (goto-char (point-min))
8754 (re-search-forward
8755 (regexp-quote (format org-coderef-label-format label))
8756 nil t))))
8757 (when label (message "Label exists already") (sit-for 2))
8758 (setq label (read-string "Code line label: " label)))
8759 (end-of-line 1)
8760 (setq link (format org-coderef-label-format label))
8761 (setq gc (- 79 (length link)))
8762 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8763 (insert link)
8764 (setq link (concat "(" label ")") desc nil)))
8766 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8767 ;; We are in the agenda, link to referenced location
8768 (let ((m (or (get-text-property (point) 'org-hd-marker)
8769 (get-text-property (point) 'org-marker))))
8770 (when m
8771 (org-with-point-at m
8772 (setq agenda-link
8773 (if (org-called-interactively-p 'any)
8774 (call-interactively 'org-store-link)
8775 (org-store-link nil)))))))
8777 ((eq major-mode 'calendar-mode)
8778 (let ((cd (calendar-cursor-to-date)))
8779 (setq link
8780 (format-time-string
8781 (car org-time-stamp-formats)
8782 (apply 'encode-time
8783 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8784 nil nil nil))))
8785 (org-store-link-props :type "calendar" :date cd)))
8787 ((eq major-mode 'help-mode)
8788 (setq link (concat "help:" (save-excursion
8789 (goto-char (point-min))
8790 (looking-at "^[^ ]+")
8791 (match-string 0))))
8792 (org-store-link-props :type "help"))
8794 ((eq major-mode 'w3-mode)
8795 (setq cpltxt (if (and (buffer-name)
8796 (not (string-match "Untitled" (buffer-name))))
8797 (buffer-name)
8798 (url-view-url t))
8799 link (url-view-url t))
8800 (org-store-link-props :type "w3" :url (url-view-url t)))
8802 ((eq major-mode 'w3m-mode)
8803 (setq cpltxt (or w3m-current-title w3m-current-url)
8804 link w3m-current-url)
8805 (org-store-link-props :type "w3m" :url (url-view-url t)))
8807 ((setq search (run-hook-with-args-until-success
8808 'org-create-file-search-functions))
8809 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8810 "::" search))
8811 (setq cpltxt (or description link)))
8813 ((eq major-mode 'image-mode)
8814 (setq cpltxt (concat "file:"
8815 (abbreviate-file-name buffer-file-name))
8816 link cpltxt)
8817 (org-store-link-props :type "image" :file buffer-file-name))
8819 ((eq major-mode 'dired-mode)
8820 ;; link to the file in the current line
8821 (let ((file (dired-get-filename nil t)))
8822 (setq file (if file
8823 (abbreviate-file-name
8824 (expand-file-name (dired-get-filename nil t)))
8825 ;; otherwise, no file so use current directory.
8826 default-directory))
8827 (setq cpltxt (concat "file:" file)
8828 link cpltxt)))
8830 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
8831 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8832 (cond
8834 (setq cpltxt
8835 (concat "file:"
8836 (abbreviate-file-name
8837 (buffer-file-name (buffer-base-buffer)))
8838 "::" (match-string 1))
8839 link cpltxt))
8840 ((and (featurep 'org-id)
8841 (or (eq org-link-to-org-use-id t)
8842 (and (org-called-interactively-p 'any)
8843 (or (eq org-link-to-org-use-id 'create-if-interactive)
8844 (and (eq org-link-to-org-use-id
8845 'create-if-interactive-and-no-custom-id)
8846 (not custom-id))))
8847 (and org-link-to-org-use-id (org-entry-get nil "ID"))))
8848 ;; We can make a link using the ID.
8849 (setq link (condition-case nil
8850 (prog1 (org-id-store-link)
8851 (setq desc (plist-get org-store-link-plist :description)))
8852 (error
8853 ;; probably before first headline, link to file only
8854 (concat "file:"
8855 (abbreviate-file-name
8856 (buffer-file-name (buffer-base-buffer))))))))
8857 (t
8858 ;; Just link to current headline
8859 (setq cpltxt (concat "file:"
8860 (abbreviate-file-name
8861 (buffer-file-name (buffer-base-buffer)))))
8862 ;; Add a context search string
8863 (when (org-xor org-context-in-file-links arg)
8864 (setq txt (cond
8865 ((org-at-heading-p) nil)
8866 ((org-region-active-p)
8867 (buffer-substring (region-beginning) (region-end)))))
8869 (setq cpltxt
8870 (concat cpltxt "::"
8871 (condition-case nil
8872 (org-make-org-heading-search-string txt)
8873 (error "")))
8874 desc (or (nth 4 (ignore-errors
8875 (org-heading-components))) "NONE"))))
8877 (setq cpltxt (substring cpltxt 0 -2)))
8878 (setq link cpltxt))))
8880 ((buffer-file-name (buffer-base-buffer))
8881 ;; Just link to this file here.
8882 (setq cpltxt (concat "file:"
8883 (abbreviate-file-name
8884 (buffer-file-name (buffer-base-buffer)))))
8885 ;; Add a context string
8886 (when (org-xor org-context-in-file-links arg)
8887 (setq txt (if (org-region-active-p)
8888 (buffer-substring (region-beginning) (region-end))
8889 (buffer-substring (point-at-bol) (point-at-eol))))
8890 ;; Only use search option if there is some text.
8892 (setq cpltxt
8893 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8894 desc "NONE")))
8895 (setq link cpltxt))
8897 ((org-called-interactively-p 'interactive)
8898 (error "Cannot link to a buffer which is not visiting a file"))
8900 (t (setq link nil)))
8902 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8903 (setq link (or link cpltxt)
8904 desc (or desc cpltxt))
8905 (if (equal desc "NONE") (setq desc nil))
8907 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8908 (progn
8909 (setq org-stored-links
8910 (cons (list link desc) org-stored-links))
8911 (message "Stored: %s" (or desc link))
8912 (when custom-id
8913 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8914 "::#" custom-id))
8915 (setq org-stored-links
8916 (cons (list link desc) org-stored-links))))
8917 (or agenda-link (and link (org-make-link-string link desc)))))))
8919 (defun org-store-link-props (&rest plist)
8920 "Store link properties, extract names and addresses."
8921 (let (x adr)
8922 (when (setq x (plist-get plist :from))
8923 (setq adr (mail-extract-address-components x))
8924 (setq plist (plist-put plist :fromname (car adr)))
8925 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8926 (when (setq x (plist-get plist :to))
8927 (setq adr (mail-extract-address-components x))
8928 (setq plist (plist-put plist :toname (car adr)))
8929 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8930 (let ((from (plist-get plist :from))
8931 (to (plist-get plist :to)))
8932 (when (and from to org-from-is-user-regexp)
8933 (setq plist
8934 (plist-put plist :fromto
8935 (if (string-match org-from-is-user-regexp from)
8936 (concat "to %t")
8937 (concat "from %f"))))))
8938 (setq org-store-link-plist plist))
8940 (defun org-add-link-props (&rest plist)
8941 "Add these properties to the link property list."
8942 (let (key value)
8943 (while plist
8944 (setq key (pop plist) value (pop plist))
8945 (setq org-store-link-plist
8946 (plist-put org-store-link-plist key value)))))
8948 (defun org-email-link-description (&optional fmt)
8949 "Return the description part of an email link.
8950 This takes information from `org-store-link-plist' and formats it
8951 according to FMT (default from `org-email-link-description-format')."
8952 (setq fmt (or fmt org-email-link-description-format))
8953 (let* ((p org-store-link-plist)
8954 (to (plist-get p :toaddress))
8955 (from (plist-get p :fromaddress))
8956 (table
8957 (list
8958 (cons "%c" (plist-get p :fromto))
8959 (cons "%F" (plist-get p :from))
8960 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8961 (cons "%T" (plist-get p :to))
8962 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8963 (cons "%s" (plist-get p :subject))
8964 (cons "%d" (plist-get p :date))
8965 (cons "%m" (plist-get p :message-id)))))
8966 (when (string-match "%c" fmt)
8967 ;; Check if the user wrote this message
8968 (if (and org-from-is-user-regexp from to
8969 (save-match-data (string-match org-from-is-user-regexp from)))
8970 (setq fmt (replace-match "to %t" t t fmt))
8971 (setq fmt (replace-match "from %f" t t fmt))))
8972 (org-replace-escapes fmt table)))
8974 (defun org-make-org-heading-search-string (&optional string heading)
8975 "Make search string for STRING or current headline."
8976 (interactive)
8977 (let ((s (or string (org-get-heading)))
8978 (lines org-context-in-file-links))
8979 (unless (and string (not heading))
8980 ;; We are using a headline, clean up garbage in there.
8981 (if (string-match org-todo-regexp s)
8982 (setq s (replace-match "" t t s)))
8984 (setq s (replace-match "" t t s)))
8985 (setq s (org-trim s))
8988 (setq s (replace-match "" t t s)))
8989 (while (string-match org-ts-regexp s)
8990 (setq s (replace-match "" t t s))))
8991 (or string (setq s (concat "*" s))) ; Add * for headlines
8992 (when (and string (integerp lines) (> lines 0))
8994 (when (< lines (length slines))
8995 (setq s (mapconcat
8996 'identity
8997 (reverse (nthcdr (- (length slines) lines)
9001 (defun org-make-link-string (link &optional description)
9002 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9004 (error "Empty link"))
9005 (when (and description
9006 (stringp description)
9008 (setq description nil))
9009 (when (stringp description)
9010 ;; Remove brackets from the description, they are fatal.
9012 (setq description (replace-match "{" t t description)))
9014 (setq description (replace-match "}" t t description))))
9015 (when (equal link description)
9016 ;; No description needed, it is identical
9017 (setq description nil))
9018 (when (and (not description)
9019 (not (string-match (org-image-file-name-regexp) link))
9020 (not (equal link (org-link-escape link))))
9021 (setq description (org-extract-attributes link)))
9022 (setq link
9023 (cond ((string-match (org-image-file-name-regexp) link) link)
9024 ((string-match org-link-types-re link)
9025 (concat (match-string 1 link)
9026 (org-link-escape (substring link (match-end 1)))))
9027 (t (org-link-escape link))))
9028 (concat "[[" link "]"
9029 (if description (concat "[" description "]") "")
9030 "]"))
9032 (defconst org-link-escape-chars
9033 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9034 "List of characters that should be escaped in link.
9035 This is the list that is used for internal purposes.")
9037 (defconst org-link-escape-chars-browser
9038 '(?\ )
9039 "List of escapes for characters that are problematic in links.
9040 This is the list that is used before handing over to the browser.")
9042 (defun org-link-escape (text &optional table merge)
9043 "Return percent escaped representation of TEXT.
9044 TEXT is a string with the text to escape.
9045 Optional argument TABLE is a list with characters that should be
9046 escaped. When nil, `org-link-escape-chars' is used.
9047 If optional argument MERGE is set, merge TABLE into
9048 `org-link-escape-chars'."
9049 (cond
9050 ((and table merge)
9051 (mapc (lambda (defchr)
9052 (unless (member defchr table)
9053 (setq table (cons defchr table)))) org-link-escape-chars))
9054 ((null table)
9055 (setq table org-link-escape-chars)))
9056 (mapconcat
9057 (lambda (char)
9058 (if (or (member char table)
9059 (and (or (< char 32) (= char 37) (> char 126))
9060 org-url-hexify-p))
9061 (mapconcat (lambda (sequence-element)
9062 (format "%%%.2X" sequence-element))
9063 (or (encode-coding-char char 'utf-8)
9064 (error "Unable to percent escape character: %s"
9065 (char-to-string char))) "")
9066 (char-to-string char))) text ""))
9068 (defun org-link-unescape (str)
9069 "Unhex hexified Unicode strings as returned from the JavaScript function
9070 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9071 (unless (and (null str) (string= "" str))
9072 (let ((pos 0) (case-fold-search t) unhexed)
9074 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9075 (setq str (replace-match unhexed t t str))
9076 (setq pos (+ pos (length unhexed))))))
9077 str)
9079 (defun org-link-unescape-compound (hex)
9080 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9081 Note: this function also decodes single byte encodings like
9082 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9083 (save-match-data
9084 (let* ((bytes (cdr (split-string hex "%")))
9085 (ret "")
9086 (eat 0)
9087 (sum 0))
9088 (while bytes
9089 (let* ((val (string-to-number (pop bytes) 16))
9090 (shift-xor
9091 (if (= 0 eat)
9092 (cond
9093 ((>= val 252) (cons 6 252))
9094 ((>= val 248) (cons 5 248))
9095 ((>= val 240) (cons 4 240))
9096 ((>= val 224) (cons 3 224))
9097 ((>= val 192) (cons 2 192))
9098 (t (cons 0 0)))
9099 (cons 6 128))))
9100 (if (>= val 192) (setq eat (car shift-xor)))
9101 (setq val (logxor val (cdr shift-xor)))
9102 (setq sum (+ (lsh sum (car shift-xor)) val))
9103 (if (> eat 0) (setq eat (- eat 1)))
9104 (cond
9105 ((= 0 eat) ;multi byte
9106 (setq ret (concat ret (org-char-to-string sum)))
9107 (setq sum 0))
9108 ((not bytes) ; single byte(s)
9109 (setq ret (org-link-unescape-single-byte-sequence hex))))
9110 )) ;; end (while bytes
9111 ret )))
9113 (defun org-link-unescape-single-byte-sequence (hex)
9114 "Unhexify hex-encoded single byte character sequences."
9115 (mapconcat (lambda (byte)
9116 (char-to-string (string-to-number byte 16)))
9117 (cdr (split-string hex "%")) ""))
9119 (defun org-xor (a b)
9120 "Exclusive or."
9121 (if a (not b) b))
9123 (defun org-fixup-message-id-for-http (s)
9124 "Replace special characters in a message id, so it can be used in an http query."
9125 (when (string-match "%" s)
9126 (setq s (mapconcat (lambda (c)
9127 (if (eq c ?%)
9128 "%25"
9129 (char-to-string c)))
9130 s "")))
9131 (while (string-match "<" s)
9132 (setq s (replace-match "%3C" t t s)))
9133 (while (string-match ">" s)
9134 (setq s (replace-match "%3E" t t s)))
9135 (while (string-match "@" s)
9136 (setq s (replace-match "%40" t t s)))
9137 s)
9139 (defun org-link-prettify (link)
9140 "Return a human-readable representation of LINK.
9141 The car of LINK must be a raw link the cdr of LINK must be either
9142 a link description or nil."
9143 (let ((desc (or (cadr link) "<no description>")))
9144 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9145 "<" (car link) ">")))
9147 ;;;###autoload
9148 (defun org-insert-link-global ()
9149 "Insert a link like Org-mode does.
9150 This command can be called in any mode to insert a link in Org-mode syntax."
9151 (interactive)
9152 (org-load-modules-maybe)
9153 (org-run-like-in-org-mode 'org-insert-link))
9155 (defun org-insert-all-links (&optional keep)
9156 "Insert all links in `org-stored-links'."
9157 (interactive "P")
9158 (let ((links (copy-sequence org-stored-links)) l)
9159 (while (setq l (if keep (pop links) (pop org-stored-links)))
9160 (insert "- ")
9161 (org-insert-link nil (car l) (cadr l))
9164 (defun org-link-fontify-links-to-this-file ()
9165 "Fontify links to the current file in `org-stored-links'."
9166 (let ((f (buffer-file-name)) a b)
9167 (setq a (mapcar (lambda(l)
9168 (let ((ll (car l)))
9170 (equal f (expand-file-name (match-string 1 ll))))
9171 ll)))
9172 org-stored-links))
9173 (when (featurep 'org-id)
9174 (setq b (mapcar (lambda(l)
9175 (let ((ll (car l)))
9177 (equal f (expand-file-name
9178 (or (org-id-find-id-file
9179 (match-string 1 ll)) ""))))
9180 ll)))
9181 org-stored-links)))
9182 (mapcar (lambda(l)
9183 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9184 (delq nil (append a b)))))
9186 (defvar org-link-links-in-this-file nil)
9187 (defun org-insert-link (&optional complete-file link-location default-description)
9188 "Insert a link. At the prompt, enter the link.
9190 Completion can be used to insert any of the link protocol prefixes like
9191 http or ftp in use.
9193 The history can be used to select a link previously stored with
9194 `org-store-link'. When the empty string is entered (i.e. if you just
9195 press RET at the prompt), the link defaults to the most recently
9196 stored link. As SPC triggers completion in the minibuffer, you need to
9197 use M-SPC or C-q SPC to force the insertion of a space character.
9199 You will also be prompted for a description, and if one is given, it will
9200 be displayed in the buffer instead of the link.
9202 If there is already a link at point, this command will allow you to edit link
9203 and description parts.
9206 be selected using completion. The path to the file will be relative to the
9207 current directory if the file is in the current directory or a subdirectory.
9208 Otherwise, the link will be the absolute path as completed in the minibuffer
9209 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9210 option `org-link-file-path-type'.
9213 the current directory or below.
9216 `org-keep-stored-link-after-insertion'.
9218 If `org-make-link-description-function' is non-nil, this function will be
9219 called with the link target, and the result will be the default
9220 link description.
9222 If the LINK-LOCATION parameter is non-nil, this value will be
9223 used as the link location instead of reading one interactively.
9225 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9226 be used as the default description."
9227 (interactive "P")
9228 (let* ((wcf (current-window-configuration))
9229 (region (if (org-region-active-p)
9230 (buffer-substring (region-beginning) (region-end))))
9231 (remove (and region (list (region-beginning) (region-end))))
9232 (desc region)
9233 tmphist ; byte-compile incorrectly complains about this
9234 (link link-location)
9235 (abbrevs org-link-abbrev-alist-local)
9236 entry file all-prefixes auto-desc)
9237 (cond
9238 (link-location) ; specified by arg, just use it.
9239 ((org-in-regexp org-bracket-link-regexp 1)
9240 ;; We do have a link at point, and we are going to edit it.
9241 (setq remove (list (match-beginning 0) (match-end 0)))
9242 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9243 (setq link (read-string "Link: "
9244 (org-link-unescape
9245 (org-match-string-no-properties 1)))))
9246 ((or (org-in-regexp org-angle-link-re)
9247 (org-in-regexp org-plain-link-re))
9248 ;; Convert to bracket link
9249 (setq remove (list (match-beginning 0) (match-end 0))
9250 link (read-string "Link: "
9251 (org-remove-angle-brackets (match-string 0)))))
9252 ((member complete-file '((4) (16)))
9253 ;; Completing read for file names.
9254 (setq link (org-file-complete-link complete-file)))
9255 (t
9256 ;; Read link, with completion for stored links.
9257 (org-link-fontify-links-to-this-file)
9258 (org-switch-to-buffer-other-window "*Org Links*")
9259 (with-current-buffer "*Org Links*"
9260 (erase-buffer)
9261 (insert "Insert a link.
9263 (when org-stored-links
9265 (insert (mapconcat 'org-link-prettify
9267 (goto-char (point-min)))
9268 (let ((cw (selected-window)))
9269 (select-window (get-buffer-window "*Org Links*" 'visible))
9270 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9271 (unless (pos-visible-in-window-p (point-max))
9272 (org-fit-window-to-buffer))
9273 (and (window-live-p cw) (select-window cw)))
9274 ;; Fake a link history, containing the stored links.
9275 (setq tmphist (append (mapcar 'car org-stored-links)
9276 org-insert-link-history))
9277 (setq all-prefixes (append (mapcar 'car abbrevs)
9278 (mapcar 'car org-link-abbrev-alist)
9279 org-link-types))
9280 (unwind-protect
9281 (progn
9282 (setq link
9283 (let ((org-completion-use-ido nil)
9284 (org-completion-use-iswitchb nil))
9285 (org-completing-read
9286 "Link: "
9287 (append
9288 (mapcar (lambda (x) (list (concat x ":")))
9289 all-prefixes)
9290 (mapcar 'car org-stored-links)
9291 (mapcar 'cadr org-stored-links))
9292 nil nil nil
9293 'tmphist
9294 (caar org-stored-links))))
9296 (error "No link selected"))
9297 (mapc (lambda(l)
9298 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9299 org-stored-links)
9300 (if (or (member link all-prefixes)
9301 (and (equal ":" (substring link -1))
9302 (member (substring link 0 -1) all-prefixes)
9303 (setq link (substring link 0 -1))))
9304 (setq link (org-link-try-special-completion link))))
9305 (set-window-configuration wcf)
9306 (kill-buffer "*Org Links*"))
9307 (setq entry (assoc link org-stored-links))
9308 (or entry (push link org-insert-link-history))
9309 (setq desc (or desc (nth 1 entry)))))
9311 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9312 (not org-keep-stored-link-after-insertion))
9313 (setq org-stored-links (delq (assoc link org-stored-links)
9314 org-stored-links)))
9316 (if (string-match org-plain-link-re link)
9317 ;; URL-like link, normalize the use of angular brackets.
9318 (setq link (org-remove-angle-brackets link)))
9320 ;; Check if we are linking to the current file with a search option
9321 ;; If yes, simplify the link by using only the search option.
9322 (when (and buffer-file-name
9324 (let* ((path (match-string 1 link))
9325 (case-fold-search nil)
9326 (search (match-string 2 link)))
9327 (save-match-data
9328 (if (equal (file-truename buffer-file-name) (file-truename path))
9329 ;; We are linking to this same file, with a search option
9330 (setq link search)))))
9332 ;; Check if we can/should use a relative path. If yes, simplify the link
9334 (let* ((type (match-string 1 link))
9335 (path (match-string 2 link))
9336 (origpath path)
9337 (case-fold-search nil))
9338 (cond
9339 ((or (eq org-link-file-path-type 'absolute)
9340 (equal complete-file '(16)))
9341 (setq path (abbreviate-file-name (expand-file-name path))))
9342 ((eq org-link-file-path-type 'noabbrev)
9343 (setq path (expand-file-name path)))
9344 ((eq org-link-file-path-type 'relative)
9345 (setq path (file-relative-name path)))
9346 (t
9347 (save-match-data
9348 (if (string-match (concat "^" (regexp-quote
9349 (expand-file-name
9350 (file-name-as-directory
9351 default-directory))))
9352 (expand-file-name path))
9353 ;; We are linking a file with relative path name.
9354 (setq path (substring (expand-file-name path)
9355 (match-end 0)))
9356 (setq path (abbreviate-file-name (expand-file-name path)))))))
9357 (setq link (concat type path))
9358 (if (equal desc origpath)
9359 (setq desc path))))
9361 (if org-make-link-description-function
9362 (setq desc
9363 (or (condition-case nil
9364 (funcall org-make-link-description-function link desc)
9365 (error (progn (message "Can't get link description from `%s'"
9366 (symbol-name org-make-link-description-function))
9367 (sit-for 2) nil)))
9368 (read-string "Description: " default-description)))
9369 (if default-description (setq desc default-description)
9370 (setq desc (or (and auto-desc desc)
9371 (read-string "Description: " desc)))))
9374 (if remove (apply 'delete-region remove))
9375 (insert (org-make-link-string link desc))))
9377 (defun org-link-try-special-completion (type)
9378 "If there is completion support for link type TYPE, offer it."
9379 (let ((fun (intern (concat "org-" type "-complete-link"))))
9380 (if (functionp fun)
9381 (funcall fun)
9382 (read-string "Link (no completion support): " (concat type ":")))))
9384 (defun org-file-complete-link (&optional arg)
9385 "Create a file link using completion."
9386 (let (file link)
9387 (setq file (read-file-name "File: "))
9388 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9389 (pwd1 (file-name-as-directory (abbreviate-file-name
9390 (expand-file-name ".")))))
9391 (cond
9392 ((equal arg '(16))
9393 (setq link (concat
9394 "file:"
9395 (abbreviate-file-name (expand-file-name file)))))
9397 (setq link (concat "file:" (match-string 1 file))))
9399 (expand-file-name file))
9400 (setq link (concat
9401 "file:" (match-string 1 (expand-file-name file)))))
9402 (t (setq link (concat "file:" file)))))
9403 link))
9405 (defun org-completing-read (&rest args)
9406 "Completing-read with SPACE being a normal character."
9407 (let ((enable-recursive-minibuffers t)
9408 (minibuffer-local-completion-map
9409 (copy-keymap minibuffer-local-completion-map)))
9410 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9411 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9412 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9413 (apply 'org-icompleting-read args)))
9415 (defun org-completing-read-no-i (&rest args)
9416 (let (org-completion-use-ido org-completion-use-iswitchb)
9417 (apply 'org-completing-read args)))
9419 (defun org-iswitchb-completing-read (prompt choices &rest args)
9420 "Use iswitch as a completing-read replacement to choose from choices.
9421 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9422 from."
9423 (let* ((iswitchb-use-virtual-buffers nil)
9424 (iswitchb-make-buflist-hook
9425 (lambda ()
9426 (setq iswitchb-temp-buflist choices))))
9427 (iswitchb-read-buffer prompt)))
9429 (defun org-icompleting-read (&rest args)
9430 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9431 (org-without-partial-completion
9432 (if (and org-completion-use-ido
9433 (fboundp 'ido-completing-read)
9434 (boundp 'ido-mode) ido-mode
9435 (listp (second args)))
9436 (let ((ido-enter-matching-directory nil))
9437 (apply 'ido-completing-read (concat (car args))
9438 (if (consp (car (nth 1 args)))
9439 (mapcar 'car (nth 1 args))
9440 (nth 1 args))
9441 (cddr args)))
9442 (if (and org-completion-use-iswitchb
9443 (boundp 'iswitchb-mode) iswitchb-mode
9444 (listp (second args)))
9445 (apply 'org-iswitchb-completing-read (concat (car args))
9446 (if (consp (car (nth 1 args)))
9447 (mapcar 'car (nth 1 args))
9448 (nth 1 args))
9449 (cddr args))
9450 (apply 'completing-read args)))))
9452 (defun org-extract-attributes (s)
9453 "Extract the attributes cookie from a string and set as text property."
9454 (let (a attr (start 0) key value)
9455 (save-match-data
9457 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9459 (setq key (match-string 1 a) value (match-string 2 a)
9460 start (match-end 0)
9461 attr (plist-put attr (intern key) value))))
9462 (org-add-props s nil 'org-attr attr))
9463 s))
9465 (defun org-extract-attributes-from-string (tag)
9466 (let (key value attr)
9468 (setq key (match-string 1 tag) value (match-string 2 tag)
9469 tag (replace-match "" t t tag)
9470 attr (plist-put attr (intern key) value)))
9471 (cons tag attr)))
9473 (defun org-attributes-to-string (plist)
9474 "Format a property list into an HTML attribute list."
9475 (let ((s "") key value)
9476 (while plist
9477 (setq key (pop plist) value (pop plist))
9478 (and value
9480 s))
9482 ;;; Opening/following a link
9484 (defvar org-link-search-failed nil)
9486 (defvar org-open-link-functions nil
9487 "Hook for functions finding a plain text link.
9488 These functions must take a single argument, the link content.
9489 They will be called for links that look like [[link text][description]]
9493 These functions will be called *before* Org attempts to resolve the
9494 link by doing text searches in the current buffer - so if you want a
9496 handle this as a special case.
9498 When the function does handle the link, it must return a non-nil value.
9499 If it decides that it is not responsible for this link, it must return
9500 nil to indicate that that Org-mode can continue with other options
9501 like exact and fuzzy text search.")
9503 (defun org-next-link ()
9504 "Move forward to the next link.
9505 If the link is in hidden text, expose it."
9506 (interactive)
9507 (when (and org-link-search-failed (eq this-command last-command))
9508 (goto-char (point-min))
9509 (message "Link search wrapped back to beginning of buffer"))
9510 (setq org-link-search-failed nil)
9511 (let* ((pos (point))
9512 (ct (org-context))
9513 (a (assoc :link ct)))
9514 (if a (goto-char (nth 2 a)))
9515 (if (re-search-forward org-any-link-re nil t)
9516 (progn
9517 (goto-char (match-beginning 0))
9518 (if (outline-invisible-p) (org-show-context)))
9519 (goto-char pos)
9520 (setq org-link-search-failed t)
9521 (error "No further link found"))))
9523 (defun org-previous-link ()
9524 "Move backward to the previous link.
9525 If the link is in hidden text, expose it."
9526 (interactive)
9527 (when (and org-link-search-failed (eq this-command last-command))
9528 (goto-char (point-max))
9529 (message "Link search wrapped back to end of buffer"))
9530 (setq org-link-search-failed nil)
9531 (let* ((pos (point))
9532 (ct (org-context))
9533 (a (assoc :link ct)))
9534 (if a (goto-char (nth 1 a)))
9535 (if (re-search-backward org-any-link-re nil t)
9536 (progn
9537 (goto-char (match-beginning 0))
9538 (if (outline-invisible-p) (org-show-context)))
9539 (goto-char pos)
9540 (setq org-link-search-failed t)
9541 (error "No further link found"))))
9543 (defun org-translate-link (s)
9544 "Translate a link string if a translation function has been defined."
9545 (if (and org-link-translation-function
9546 (fboundp org-link-translation-function)
9548 (progn
9549 (setq s (funcall org-link-translation-function
9550 (match-string 1 s) (match-string 2 s)))
9551 (concat (car s) ":" (cdr s)))
9552 s))
9554 (defun org-translate-link-from-planner (type path)
9555 "Translate a link from Emacs Planner syntax so that Org can follow it.
9556 This is still an experimental function, your mileage may vary."
9557 (cond
9558 ((member type '("http" "https" "news" "ftp"))
9559 ;; standard Internet links are the same.
9560 nil)
9561 ((and (equal type "irc") (string-match "^//" path))
9562 ;; Planner has two / at the beginning of an irc link, we have 1.
9563 ;; We should have zero, actually....
9564 (setq path (substring path 1)))
9565 ((and (equal type "lisp") (string-match "^/" path))
9566 ;; Planner has a slash, we do not.
9567 (setq type "elisp" path (substring path 1)))
9569 ;; A typical message link. Planner has the id after the final slash,
9570 ;; we separate it with a hash mark
9571 (setq path (concat (match-string 1 path) "#"
9572 (org-remove-angle-brackets (match-string 2 path)))))
9573 )
9574 (cons type path))
9576 (defun org-find-file-at-mouse (ev)
9577 "Open file link or URL at mouse."
9578 (interactive "e")
9579 (mouse-set-point ev)
9580 (org-open-at-point 'in-emacs))
9582 (defun org-open-at-mouse (ev)
9583 "Open file link or URL at mouse.
9584 See the docstring of `org-open-file' for details."
9585 (interactive "e")
9586 (mouse-set-point ev)
9587 (if (eq major-mode 'org-agenda-mode)
9588 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9589 (org-open-at-point))
9591 (defvar org-window-config-before-follow-link nil
9592 "The window configuration before following a link.
9593 This is saved in case the need arises to restore it.")
9595 (defvar org-open-link-marker (make-marker)
9596 "Marker pointing to the location where `org-open-at-point; was called.")
9598 ;;;###autoload
9599 (defun org-open-at-point-global ()
9600 "Follow a link like Org-mode does.
9601 This command can be called in any mode to follow a link that has
9602 Org-mode syntax."
9603 (interactive)
9604 (org-run-like-in-org-mode 'org-open-at-point))
9606 ;;;###autoload
9607 (defun org-open-link-from-string (s &optional arg reference-buffer)
9608 "Open a link in the string S, as if it was in Org-mode."
9610 (let ((reference-buffer (or reference-buffer (current-buffer))))
9611 (with-temp-buffer
9612 (let ((org-inhibit-startup (not reference-buffer)))
9613 (org-mode)
9614 (insert s)
9615 (goto-char (point-min))
9616 (when reference-buffer
9617 (setq org-link-abbrev-alist-local
9618 (with-current-buffer reference-buffer
9619 org-link-abbrev-alist-local)))
9620 (org-open-at-point arg reference-buffer)))))
9622 (defvar org-open-at-point-functions nil
9623 "Hook that is run when following a link at point.
9625 Functions in this hook must return t if they identify and follow
9626 a link at point. If they don't find anything interesting at point,
9627 they must return nil.")
9629 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
9630 (defun org-open-at-point (&optional arg reference-buffer)
9631 "Open link at or after point.
9632 If there is no link at point, this function will search forward up to
9633 the end of the current line.
9634 Normally, files will be opened by an appropriate application. If the
9635 optional prefix argument ARG is non-nil, Emacs will visit the file.
9636 With a double prefix argument, try to open outside of Emacs, in the
9637 application the system uses for this file type."
9638 (interactive "P")
9639 ;; if in a code block, then open the block's results
9640 (unless (call-interactively #'org-babel-open-src-block-result)
9641 (org-load-modules-maybe)
9642 (move-marker org-open-link-marker (point))
9643 (setq org-window-config-before-follow-link (current-window-configuration))
9644 (org-remove-occur-highlights nil nil t)
9645 (cond
9646 ((and (org-at-heading-p)
9647 (not (org-at-timestamp-p t))
9648 (not (org-in-regexp
9653 (not (get-text-property (point) 'org-linked-text)))
9654 (or (org-offer-links-in-entry arg)
9655 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9656 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9657 ((and (org-at-timestamp-p t)
9658 (not (org-in-regexp org-bracket-link-regexp)))
9659 (org-follow-timestamp-link))
9660 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9661 (not (org-in-regexp org-any-link-re)))
9662 (org-footnote-action))
9663 (t
9664 (let (type path link line search (pos (point)))
9665 (catch 'match
9666 (save-excursion
9668 (when (org-in-regexp org-bracket-link-regexp 1)
9669 (setq link (org-extract-attributes
9670 (org-link-unescape (org-match-string-no-properties 1))))
9672 (setq link (replace-match " " t t link)))
9673 (setq link (org-link-expand-abbrev link))
9674 (cond
9675 ((or (file-name-absolute-p link)
9677 (setq type "file" path link))
9678 ((string-match org-link-re-with-space3 link)
9679 (setq type (match-string 1 link) path (match-string 2 link)))
9681 (setq type "help" path (match-string 1 link)))
9682 (t (setq type "thisfile" path link)))
9683 (throw 'match t)))
9685 (when (get-text-property (point) 'org-linked-text)
9686 (setq type "thisfile"
9687 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9688 (1+ (point)) (point))
9689 path (buffer-substring
9690 (or (previous-single-property-change pos 'org-linked-text)
9691 (point-min))
9692 (or (next-single-property-change pos 'org-linked-text)
9693 (point-max))))
9694 (throw 'match t))
9696 (save-excursion
9697 (let ((plinkpos (org-in-regexp org-plain-link-re)))
9698 (when (or (org-in-regexp org-angle-link-re)
9699 (and plinkpos (goto-char (car plinkpos))
9701 (setq type (match-string 1)
9702 path (org-link-unescape (match-string 2)))
9703 (throw 'match t))))
9704 (save-excursion
9706 (setq type "tags"
9707 path (match-string 1))
9708 (while (string-match ":" path)
9709 (setq path (replace-match "+" t t path)))
9710 (throw 'match t)))
9712 (setq type "tree-match"
9713 path (match-string 1))
9714 (throw 'match t)))
9715 (unless path
9716 (user-error "No link found"))
9718 ;; switch back to reference buffer
9719 ;; needed when if called in a temporary buffer through
9720 ;; org-open-link-from-string
9721 (with-current-buffer (or reference-buffer (current-buffer))
9723 ;; Remove any trailing spaces in path
9725 (setq path (replace-match "" t t path)))
9726 (if (and org-link-translation-function
9727 (fboundp org-link-translation-function))
9728 ;; Check if we need to translate the link
9729 (let ((tmp (funcall org-link-translation-function type path)))
9730 (setq type (car tmp) path (cdr tmp))))
9732 (cond
9734 ((assoc type org-link-protocols)
9735 (funcall (nth 1 (assoc type org-link-protocols)) path))
9737 ((equal type "help")
9738 (let ((f-or-v (intern path)))
9739 (cond ((fboundp f-or-v)
9740 (describe-function f-or-v))
9741 ((boundp f-or-v)
9742 (describe-variable f-or-v))
9743 (t (error "Not a known function or variable")))))
9745 ((equal type "mailto")
9746 (let ((cmd (car org-link-mailto-program))
9747 (args (cdr org-link-mailto-program)) args1
9748 (address path) (subject "") a)
9750 (setq address (match-string 1 path)
9751 subject (org-link-escape (match-string 2 path))))
9752 (while args
9753 (cond
9754 ((not (stringp (car args))) (push (pop args) args1))
9755 (t (setq a (pop args))
9756 (if (string-match "%a" a)
9757 (setq a (replace-match address t t a)))
9758 (if (string-match "%s" a)
9759 (setq a (replace-match subject t t a)))
9760 (push a args1))))
9761 (apply cmd (nreverse args1))))
9763 ((member type '("http" "https" "ftp" "news"))
9764 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9765 (org-link-escape
9766 path org-link-escape-chars-browser)
9767 path))))
9769 ((string= type "doi")
9770 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
9771 (org-link-escape
9772 path org-link-escape-chars-browser)
9773 path))))
9775 ((member type '("message"))
9776 (browse-url (concat type ":" path)))
9778 ((string= type "tags")
9779 (org-tags-view arg path))
9781 ((string= type "tree-match")
9784 ((string= type "file")
9786 (setq line (string-to-number (match-string 1 path))
9787 path (substring path 0 (match-beginning 0)))
9789 (setq search (match-string 1 path)
9790 path (substring path 0 (match-beginning 0)))))
9791 (if (string-match "[*?{]" (file-name-nondirectory path))
9792 (dired path)
9793 (org-open-file path arg line search)))
9795 ((string= type "shell")
9796 (let ((buf (generate-new-buffer "*Org Shell Output"))
9797 (cmd path))
9798 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9799 (string-match org-confirm-shell-link-not-regexp cmd))
9800 (not org-confirm-shell-link-function)
9801 (funcall org-confirm-shell-link-function
9803 (org-add-props cmd nil
9804 'face 'org-warning))))
9805 (progn
9806 (message "Executing %s" cmd)
9807 (shell-command cmd buf)
9808 (if (featurep 'midnight)
9809 (setq clean-buffer-list-kill-buffer-names
9810 (cons buf clean-buffer-list-kill-buffer-names))))
9811 (error "Abort"))))
9813 ((string= type "elisp")
9814 (let ((cmd path))
9815 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9816 (string-match org-confirm-elisp-link-not-regexp cmd))
9817 (not org-confirm-elisp-link-function)
9818 (funcall org-confirm-elisp-link-function
9820 (org-add-props cmd nil
9821 'face 'org-warning))))
9822 (message "%s => %s" cmd
9823 (if (equal (string-to-char cmd) ?\()
9824 (eval (read cmd))
9825 (call-interactively (read cmd))))
9826 (error "Abort"))))
9828 ((and (string= type "thisfile")
9829 (run-hook-with-args-until-success
9830 'org-open-link-functions path)))
9832 ((string= type "thisfile")
9833 (if arg
9834 (switch-to-buffer-other-window
9835 (org-get-buffer-for-internal-link (current-buffer)))
9836 (org-mark-ring-push))
9837 (let ((cmd `(org-link-search
9838 ,path
9839 ,(cond ((equal arg '(4)) ''occur)
9840 ((equal arg '(16)) ''org-occur))
9841 ,pos)))
9842 (condition-case nil (let ((org-link-search-inhibit-query t))
9843 (eval cmd))
9844 (error (progn (widen) (eval cmd))))))
9846 (t (browse-url-at-point)))))))
9847 (move-marker org-open-link-marker nil)
9848 (run-hook-with-args 'org-follow-link-hook)))
9850 (defun org-offer-links-in-entry (&optional nth zero)
9851 "Offer links in the current entry and follow the selected link.
9852 If there is only one link, follow it immediately as well.
9853 If NTH is an integer, immediately pick the NTH link found.
9854 If ZERO is a string, check also this string for a link, and if
9855 there is one, offer it as link number zero."
9859 (cnt ?0)
9860 (in-emacs (if (integerp nth) nil nth))
9861 have-zero end links link c)
9862 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9863 (push (match-string 0 zero) links)
9864 (setq cnt (1- cnt) have-zero t))
9865 (save-excursion
9866 (org-back-to-heading t)
9867 (setq end (save-excursion (outline-next-heading) (point)))
9868 (while (re-search-forward re end t)
9869 (push (match-string 0) links))
9870 (setq links (org-uniquify (reverse links))))
9872 (cond
9873 ((null links)
9874 (message "No links"))
9875 ((equal (length links) 1)
9876 (setq link (list (car links))))
9877 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9878 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9879 (t ; we have to select a link
9880 (save-excursion
9881 (save-window-excursion
9882 (delete-other-windows)
9883 (with-output-to-temp-buffer "*Select Link*"
9884 (mapc (lambda (l)
9885 (if (not (string-match org-bracket-link-regexp l))
9887 (org-remove-angle-brackets l)))
9888 (if (match-end 3)
9890 (match-string 3 l) (match-string 1 l)))
9892 (match-string 1 l))))))
9893 links))
9894 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9895 (message "Select link to open, RET to open all:")
9896 (setq c (read-char-exclusive))
9897 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9898 (when (equal c ?q) (error "Abort"))
9899 (if (equal c ?\C-m)
9900 (setq link links)
9901 (setq nth (- c ?0))
9902 (if have-zero (setq nth (1+ nth)))
9903 (unless (and (integerp nth) (>= (length links) nth))
9904 (error "Invalid link selection"))
9905 (setq link (list (nth (1- nth) links))))))
9906 (if link
9907 (let ((buf (current-buffer)))
9908 (dolist (l link)
9909 (org-open-link-from-string l in-emacs buf))
9910 t)
9911 nil)))
9913 ;; Add special file links that specify the way of opening
9915 (org-add-link-type "file+sys" 'org-open-file-with-system)
9916 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9917 (defun org-open-file-with-system (path)
9918 "Open file at PATH using the system way of opening it."
9919 (org-open-file path 'system))
9920 (defun org-open-file-with-emacs (path)
9921 "Open file at PATH in Emacs."
9922 (org-open-file path 'emacs))
9923 (defun org-remove-file-link-modifiers ()
9924 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9925 (goto-char (point-min))
9927 (org-if-unprotected
9928 (replace-match "file:" t t))))
9929 (eval-after-load "org-exp"
9930 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9931 'org-remove-file-link-modifiers))
9933 ;;;; Time estimates
9935 (defun org-get-effort (&optional pom)
9936 "Get the effort estimate for the current entry."
9937 (org-entry-get pom org-effort-property))
9939 ;;; File search
9941 (defvar org-create-file-search-functions nil
9942 "List of functions to construct the right search string for a file link.
9943 These functions are called in turn with point at the location to
9944 which the link should point.
9946 A function in the hook should first test if it would like to
9947 handle this file type, for example by checking the `major-mode'
9948 or the file extension. If it decides not to handle this file, it
9949 should just return nil to give other functions a chance. If it
9950 does handle the file, it must return the search string to be used
9951 when following the link. The search string will be part of the
9952 file link, given after a double colon, and `org-open-at-point'
9953 will automatically search for it. If special measures must be
9954 taken to make the search successful, another function should be
9955 added to the companion hook `org-execute-file-search-functions',
9956 which see.
9958 A function in this hook may also use `setq' to set the variable
9959 `description' to provide a suggestion for the descriptive text to
9960 be used for this link when it gets inserted into an Org-mode
9963 (defvar org-execute-file-search-functions nil
9964 "List of functions to execute a file search triggered by a link.
9966 Functions added to this hook must accept a single argument, the
9967 search string that was part of the file link, the part after the
9968 double colon. The function must first check if it would like to
9969 handle this search, for example by checking the `major-mode' or
9970 the file extension. If it decides not to handle this search, it
9971 should just return nil to give other functions a chance. If it
9972 does handle the search, it must return a non-nil value to keep
9973 other functions from trying.
9975 Each function can access the current prefix argument through the
9976 variable `current-prefix-argument'. Note that a single prefix is
9977 used to force opening a link in Emacs, so it may be good to only
9978 use a numeric or double prefix to guide the search function.
9980 In case this is needed, a function in this hook can also restore
9981 the window configuration before `org-open-at-point' was called using:
9983 (set-window-configuration org-window-config-before-follow-link)")
9985 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9986 (defun org-link-search (s &optional type avoid-pos stealth)
9987 "Search for a link search option.
9988 If S is surrounded by forward slashes, it is interpreted as a
9989 regular expression. In org-mode files, this will create an `org-occur'
9990 sparse tree. In ordinary files, `occur' will be used to list matches.
9991 If the current buffer is in `dired-mode', grep will be used to search
9992 in all files. If AVOID-POS is given, ignore matches near that position.
9994 When optional argument STEALTH is non-nil, do not modify
9995 visibility around point, thus ignoring
9996 `org-show-hierarchy-above', `org-show-following-heading' and
9997 `org-show-siblings' variables."
9998 (let ((case-fold-search t)
10002 org-emphasis-alist)
10004 (pos (point))
10005 (pre nil) (post nil)
10006 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10007 (cond
10008 ;; First check if there are any special search functions
10009 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10010 ;; Now try the builtin stuff
10011 ((and (equal (string-to-char s0) ?#)
10012 (> (length s0) 1)
10013 (save-excursion
10014 (goto-char (point-min))
10015 (and
10016 (re-search-forward
10018 (setq type 'dedicated
10019 pos (match-beginning 0))))
10020 ;; There is an exact target for this
10021 (goto-char pos)
10022 (org-back-to-heading t)))
10023 ((save-excursion
10024 (goto-char (point-min))
10025 (and
10026 (re-search-forward
10027 (concat "<<" (regexp-quote s0) ">>") nil t)
10028 (setq type 'dedicated
10029 pos (match-beginning 0))))
10030 ;; There is an exact target for this
10031 (goto-char pos))
10032 ((save-excursion
10033 (goto-char (point-min))
10034 (and
10035 (re-search-forward
10037 (setq type 'dedicated pos (match-beginning 0))))
10038 ;; Found an invisible target.
10039 (goto-char pos))
10040 ((save-excursion
10041 (goto-char (point-min))
10042 (and
10043 (re-search-forward
10045 (setq type 'dedicated pos (match-beginning 0))))
10046 ;; Found an element with a matching #+name affiliated keyword.
10047 (goto-char pos))
10049 (save-excursion
10050 (goto-char (point-min))
10051 (and
10052 (re-search-forward
10053 (concat "[^[]" (regexp-quote
10054 (format org-coderef-label-format
10055 (match-string 1 s0))))
10056 nil t)
10057 (setq type 'dedicated
10058 pos (1+ (match-beginning 0))))))
10059 ;; There is a coderef target for this
10060 (goto-char pos))
10062 ;; A regular expression
10063 (cond
10064 ((derived-mode-p 'org-mode)
10065 (org-occur (match-string 1 s)))
10066 ;;((eq major-mode 'dired-mode)
10067 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
10068 (t (org-do-occur (match-string 1 s)))))
10069 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10070 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10071 (goto-char (point-min))
10072 (cond
10073 ((let (case-fold-search)
10074 (re-search-forward (format org-complex-heading-regexp-format
10075 (regexp-quote s))
10076 nil t))
10077 ;; OK, found a match
10078 (setq type 'dedicated)
10079 (goto-char (match-beginning 0)))
10080 ((and (not org-link-search-inhibit-query)
10081 (eq org-link-search-must-match-exact-headline 'query-to-create)
10082 (y-or-n-p "No match - create this as a new heading? "))
10083 (goto-char (point-max))
10084 (or (bolp) (newline))
10086 (beginning-of-line 0))
10087 (t
10088 (goto-char pos)
10089 (error "No match"))))
10090 (t
10091 ;; A normal search string
10092 (when (equal (string-to-char s) ?*)
10093 ;; Anchor on headlines, post may include tags.
10096 s (substring s 1)))
10097 (remove-text-properties
10098 0 (length s)
10099 '(face nil mouse-face nil keymap nil fontified nil) s)
10100 ;; Make a series of regular expressions to find a match
10109 re4 (concat "[^a-zA-Z_]" re4_)
10111 re1 (concat pre re2 post)
10112 re3 (concat pre (if pre re4_ re4) post)
10113 re5 (concat pre ".*" re4)
10114 re2 (concat pre re2)
10115 re2a (concat pre (if pre re2a_ re2a))
10116 re4 (concat pre (if pre re4_ re4))
10120 ))
10121 (cond
10122 ((eq type 'org-occur) (org-occur reall))
10123 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10124 (t (goto-char (point-min))
10125 (setq type 'fuzzy)
10126 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10127 (org-search-not-self 1 re1 nil t)
10128 (org-search-not-self 1 re2 nil t)
10129 (org-search-not-self 1 re2a nil t)
10130 (org-search-not-self 1 re3 nil t)
10131 (org-search-not-self 1 re4 nil t)
10132 (org-search-not-self 1 re5 nil t)
10133 )
10134 (goto-char (match-beginning 1))
10135 (goto-char pos)
10136 (error "No match"))))))
10137 (and (derived-mode-p 'org-mode)
10138 (not stealth)
10139 (org-show-context 'link-search))
10140 type))
10142 (defun org-search-not-self (group &rest args)
10143 "Execute `re-search-forward', but only accept matches that do not
10144 enclose the position of `org-open-link-marker'."
10145 (let ((m org-open-link-marker))
10146 (catch 'exit
10147 (while (apply 're-search-forward args)
10148 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10149 (goto-char (match-end group))
10150 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10151 (> (match-beginning 0) (marker-position m))
10152 (< (match-end 0) (marker-position m)))
10153 (save-match-data
10154 (or (not (org-in-regexp
10155 org-bracket-link-analytic-regexp 1))
10156 (not (match-end 4)) ; no description
10157 (and (<= (match-beginning 4) (point))
10158 (>= (match-end 4) (point))))))
10159 (throw 'exit (point))))))))
10161 (defun org-get-buffer-for-internal-link (buffer)
10162 "Return a buffer to be used for displaying the link target of internal links."
10163 (cond
10164 ((not org-display-internal-link-with-indirect-buffer)
10165 buffer)
10166 ((string-match "(Clone)$" (buffer-name buffer))
10167 (message "Buffer is already a clone, not making another one")
10168 ;; we also do not modify visibility in this case
10169 buffer)
10170 (t ; make a new indirect buffer for displaying the link
10171 (let* ((bn (buffer-name buffer))
10172 (ibn (concat bn "(Clone)"))
10173 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10174 (with-current-buffer ib (org-overview))
10175 ib))))
10177 (defun org-do-occur (regexp &optional cleanup)
10178 "Call the Emacs command `occur'.
10179 If CLEANUP is non-nil, remove the printout of the regular expression
10180 in the *Occur* buffer. This is useful if the regex is long and not useful
10181 to read."
10182 (occur regexp)
10183 (when cleanup
10184 (let ((cwin (selected-window)) win beg end)
10185 (when (setq win (get-buffer-window "*Occur*"))
10186 (select-window win))
10187 (goto-char (point-min))
10188 (when (re-search-forward "match[a-z]+" nil t)
10189 (setq beg (match-end 0))
10191 (setq end (1- (match-beginning 0)))))
10192 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10193 (goto-char (point-min))
10194 (select-window cwin))))
10196 ;;; The mark ring for links jumps
10198 (defvar org-mark-ring nil
10199 "Mark ring for positions before jumps in Org-mode.")
10200 (defvar org-mark-ring-last-goto nil
10201 "Last position in the mark ring used to go back.")
10202 ;; Fill and close the ring
10203 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10204 (loop for i from 1 to org-mark-ring-length do
10205 (push (make-marker) org-mark-ring))
10206 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10207 org-mark-ring)
10209 (defun org-mark-ring-push (&optional pos buffer)
10210 "Put the current position or POS into the mark ring and rotate it."
10211 (interactive)
10212 (setq pos (or pos (point)))
10213 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10214 (move-marker (car org-mark-ring)
10215 (or pos (point))
10216 (or buffer (current-buffer)))
10217 (message "%s"
10218 (substitute-command-keys
10221 (defun org-mark-ring-goto (&optional n)
10222 "Jump to the previous position in the mark ring.
10223 With prefix arg N, jump back that many stored positions. When
10224 called several times in succession, walk through the entire ring.
10225 Org-mode commands jumping to a different position in the current file,
10226 or to another Org-mode file, automatically push the old position
10227 onto the ring."
10228 (interactive "p")
10229 (let (p m)
10230 (if (eq last-command this-command)
10231 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10232 (setq p org-mark-ring))
10233 (setq org-mark-ring-last-goto p)
10234 (setq m (car p))
10235 (org-pop-to-buffer-same-window (marker-buffer m))
10236 (goto-char m)
10237 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10239 (defun org-remove-angle-brackets (s)
10240 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10241 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10242 s)
10243 (defun org-add-angle-brackets (s)
10244 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10245 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10246 s)
10247 (defun org-remove-double-quotes (s)
10250 s)
10252 ;;; Following specific links
10254 (defun org-follow-timestamp-link ()
10255 "Open an agenda view for the time-stamp date/range at point."
10256 (cond
10257 ((org-at-date-range-p t)
10258 (let ((org-agenda-start-on-weekday)
10259 (t1 (match-string 1))
10260 (t2 (match-string 2)) tt1 tt2)
10261 (setq tt1 (time-to-days (org-time-string-to-time t1))
10262 tt2 (time-to-days (org-time-string-to-time t2)))
10263 (let ((org-agenda-buffer-tmp-name
10264 (format "*Org Agenda(a:%s)"
10265 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10266 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10267 ((org-at-timestamp-p t)
10268 (let ((org-agenda-buffer-tmp-name
10269 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10270 (org-agenda-list nil (time-to-days (org-time-string-to-time
10271 (substring (match-string 1) 0 10)))
10272 1)))
10273 (t (error "This should not happen"))))
10276 ;;; Following file links
10277 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10278 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10279 (declare-function mailcap-mime-info
10280 "mailcap" (string &optional request no-decode))
10281 (defvar org-wait nil)
10282 (defun org-open-file (path &optional in-emacs line search)
10283 "Open the file at PATH.
10284 First, this expands any special file name abbreviations. Then the
10285 configuration variable `org-file-apps' is checked if it contains an
10286 entry for this file type, and if yes, the corresponding command is launched.
10288 If no application is found, Emacs simply visits the file.
10290 With optional prefix argument IN-EMACS, Emacs will visit the file.
10292 prefix arg, Org tries to avoid opening in Emacs
10293 and to use an external application to visit the file.
10295 Optional LINE specifies a line to go to, optional SEARCH a string
10296 to search for. If LINE or SEARCH is given, the file will be
10297 opened in Emacs, unless an entry from org-file-apps that makes
10298 use of groups in a regexp matches.
10300 If you want to change the way frames are used when following a
10301 link, please customize `org-link-frame-setup'.
10303 If the file does not exist, an error is thrown."
10304 (let* ((file (if (equal path "")
10305 buffer-file-name
10306 (substitute-in-file-name (expand-file-name path))))
10307 (file-apps (append org-file-apps (org-default-apps)))
10308 (apps (org-remove-if
10309 'org-file-apps-entry-match-against-dlink-p file-apps))
10310 (apps-dlink (org-remove-if-not
10311 'org-file-apps-entry-match-against-dlink-p file-apps))
10312 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10313 (dirp (if remp nil (file-directory-p file)))
10314 (file (if (and dirp org-open-directory-means-index-dot-org)
10315 (concat (file-name-as-directory file) "index.org")
10316 file))
10317 (a-m-a-p (assq 'auto-mode apps))
10318 (dfile (downcase file))
10319 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10320 (link (cond ((and (eq line nil)
10321 (eq search nil))
10322 file)
10323 (line
10324 (concat file "::" (number-to-string line)))
10325 (search
10326 (concat file "::" search))))
10327 (dlink (downcase link))
10328 (old-buffer (current-buffer))
10329 (old-pos (point))
10330 (old-mode major-mode)
10331 ext cmd link-match-data)
10333 (setq ext (match-string 1 dfile))
10335 (setq ext (match-string 1 dfile))))
10336 (cond
10337 ((member in-emacs '((16) system))
10338 (setq cmd (cdr (assoc 'system apps))))
10339 (in-emacs (setq cmd 'emacs))
10340 (t
10341 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10342 (and dirp (cdr (assoc 'directory apps)))
10343 ; first, try matching against apps-dlink
10344 ; if we get a match here, store the match data for later
10345 (let ((match (assoc-default dlink apps-dlink
10346 'string-match)))
10347 (if match
10348 (progn (setq link-match-data (match-data))
10349 match)
10350 (progn (setq in-emacs (or in-emacs line search))
10351 nil))) ; if we have no match in apps-dlink,
10352 ; always open the file in emacs if line or search
10353 ; is given (for backwards compatibility)
10354 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10355 'string-match)
10356 (cdr (assoc ext apps))
10357 (cdr (assoc t apps))))))
10358 (when (eq cmd 'system)
10359 (setq cmd (cdr (assoc 'system apps))))
10360 (when (eq cmd 'default)
10361 (setq cmd (cdr (assoc t apps))))
10362 (when (eq cmd 'mailcap)
10363 (require 'mailcap)
10364 (mailcap-parse-mailcaps)
10365 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10366 (command (mailcap-mime-info mime-type)))
10367 (if (stringp command)
10368 (setq cmd command)
10369 (setq cmd 'emacs))))
10370 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10371 (not (file-exists-p file))
10372 (not org-open-non-existing-files))
10373 (error "No such file: %s" file))
10374 (cond
10376 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10378 (setq cmd (replace-match "%s" t t cmd)))
10379 (while (string-match "%s" cmd)
10380 (setq cmd (replace-match
10381 (save-match-data
10382 (shell-quote-argument
10383 (convert-standard-filename file)))
10384 t t cmd)))
10386 ;; Replace "%1", "%2" etc. in command with group matches from regex
10387 (save-match-data
10388 (let ((match-index 1)
10389 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10390 (set-match-data link-match-data)
10391 (while (<= match-index number-of-groups)
10392 (let ((regex (concat "%" (number-to-string match-index)))
10393 (replace-with (match-string match-index dlink)))
10394 (while (string-match regex cmd)
10395 (setq cmd (replace-match replace-with t t cmd))))
10396 (setq match-index (+ match-index 1)))))
10398 (save-window-excursion
10399 (start-process-shell-command cmd nil cmd)
10400 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10401 ))
10402 ((or (stringp cmd)
10403 (eq cmd 'emacs))
10404 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10405 (widen)
10406 (if line (org-goto-line line)
10407 (if search (org-link-search search))))
10408 ((consp cmd)
10409 (let ((file (convert-standard-filename file)))
10410 (save-match-data
10411 (set-match-data link-match-data)
10412 (eval cmd))))
10413 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10414 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10415 (or (not (equal old-buffer (current-buffer)))
10416 (not (equal old-pos (point))))
10417 (org-mark-ring-push old-pos old-buffer))))
10419 (defun org-file-apps-entry-match-against-dlink-p (entry)
10420 "This function returns non-nil if `entry' uses a regular
10421 expression which should be matched against the whole link by
10422 org-open-file.
10424 It assumes that is the case when the entry uses a regular
10425 expression which has at least one grouping construct and the
10426 action is either a lisp form or a command string containing
10427 '%1', i.e. using at least one subexpression match as a
10428 parameter."
10429 (let ((selector (car entry))
10430 (action (cdr entry)))
10431 (if (stringp selector)
10432 (and (> (regexp-opt-depth selector) 0)
10433 (or (and (stringp action)
10434 (string-match "%[0-9]" action))
10435 (consp action)))
10436 nil)))
10438 (defun org-default-apps ()
10439 "Return the default applications for this operating system."
10440 (cond
10441 ((eq system-type 'darwin)
10442 org-file-apps-defaults-macosx)
10443 ((eq system-type 'windows-nt)
10444 org-file-apps-defaults-windowsnt)
10445 (t org-file-apps-defaults-gnu)))
10447 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10448 "Convert extensions to regular expressions in the cars of LIST.
10449 Also, weed out any non-string entries, because the return value is used
10450 only for regexp matching.
10451 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10452 point to the symbol `emacs', indicating that the file should
10453 be opened in Emacs."
10454 (append
10455 (delq nil
10456 (mapcar (lambda (x)
10457 (if (not (stringp (car x)))
10458 nil
10460 x
10462 list))
10463 (if add-auto-mode
10464 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10466 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10467 (defun org-file-remote-p (file)
10468 "Test whether FILE specifies a location on a remote system.
10469 Return non-nil if the location is indeed remote.
10473 (cond ((fboundp 'file-remote-p)
10474 (file-remote-p file))
10475 ((fboundp 'tramp-handle-file-remote-p)
10476 (tramp-handle-file-remote-p file))
10477 ((and (boundp 'ange-ftp-name-format)
10478 (string-match (car ange-ftp-name-format) file))
10479 t)))
10482 ;;;; Refiling
10484 (defun org-get-org-file ()
10485 "Read a filename, with default directory `org-directory'."
10486 (let ((default (or org-default-notes-file remember-data-file)))
10487 (read-file-name (format "File name [%s]: " default)
10488 (file-name-as-directory org-directory)
10489 default)))
10491 (defun org-notes-order-reversed-p ()
10492 "Check if the current file should receive notes in reversed order."
10493 (cond
10494 ((not org-reverse-note-order) nil)
10495 ((eq t org-reverse-note-order) t)
10496 ((not (listp org-reverse-note-order)) nil)
10497 (t (catch 'exit
10498 (let ((all org-reverse-note-order)
10499 entry)
10500 (while (setq entry (pop all))
10501 (if (string-match (car entry) buffer-file-name)
10502 (throw 'exit (cdr entry))))
10503 nil)))))
10505 (defvar org-refile-target-table nil
10506 "The list of refile targets, created by `org-refile'.")
10508 (defvar org-agenda-new-buffers nil
10509 "Buffers created to visit agenda files.")
10511 (defvar org-refile-cache nil
10512 "Cache for refile targets.")
10514 (defvar org-refile-markers nil
10515 "All the markers used for caching refile locations.")
10517 (defun org-refile-marker (pos)
10518 "Get a new refile marker, but only if caching is in use."
10519 (if (not org-refile-use-cache)
10520 pos
10521 (let ((m (make-marker)))
10522 (move-marker m pos)
10523 (push m org-refile-markers)
10524 m)))
10526 (defun org-refile-cache-clear ()
10527 "Clear the refile cache and disable all the markers."
10528 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10529 (setq org-refile-markers nil)
10530 (setq org-refile-cache nil)
10531 (message "Refile cache has been cleared"))
10533 (defun org-refile-cache-check-set (set)
10534 "Check if all the markers in the cache still have live buffers."
10535 (let (marker)
10536 (catch 'exit
10537 (while (and set (setq marker (nth 3 (pop set))))
10538 ;; if org-refile-use-outline-path is 'file, marker may be nil
10539 (when (and marker (null (marker-buffer marker)))
10540 (message "not found") (sit-for 3)
10541 (throw 'exit nil)))
10542 t)))
10544 (defun org-refile-cache-put (set &rest identifiers)
10545 "Push the refile targets SET into the cache, under IDENTIFIERS."
10546 (let* ((key (sha1 (prin1-to-string identifiers)))
10547 (entry (assoc key org-refile-cache)))
10548 (if entry
10549 (setcdr entry set)
10550 (push (cons key set) org-refile-cache))))
10552 (defun org-refile-cache-get (&rest identifiers)
10553 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10554 (cond
10555 ((not org-refile-cache) nil)
10556 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10557 (t
10558 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10559 org-refile-cache))))
10560 (and set (org-refile-cache-check-set set) set)))))
10562 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10563 "Produce a table with refile targets."
10564 (let ((case-fold-search nil)
10565 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10566 (entries (or org-refile-targets '((nil . (:level . 1)))))
10567 targets tgs txt re files f desc descre fast-path-p level pos0)
10568 (message "Getting targets...")
10569 (with-current-buffer (or default-buffer (current-buffer))
10570 (while (setq entry (pop entries))
10571 (setq files (car entry) desc (cdr entry))
10572 (setq fast-path-p nil)
10573 (cond
10574 ((null files) (setq files (list (current-buffer))))
10575 ((eq files 'org-agenda-files)
10576 (setq files (org-agenda-files 'unrestricted)))
10577 ((and (symbolp files) (fboundp files))
10578 (setq files (funcall files)))
10579 ((and (symbolp files) (boundp files))
10580 (setq files (symbol-value files))))
10581 (if (stringp files) (setq files (list files)))
10582 (cond
10583 ((eq (car desc) :tag)
10585 ((eq (car desc) :todo)
10587 ((eq (car desc) :regexp)
10588 (setq descre (cdr desc)))
10589 ((eq (car desc) :level)
10591 (if org-odd-levels-only
10592 (1- (* 2 (cdr desc)))
10593 (cdr desc)))
10595 ((eq (car desc) :maxlevel)
10596 (setq fast-path-p t)
10598 (if org-odd-levels-only
10599 (1- (* 2 (cdr desc)))
10600 (cdr desc)))
10602 (t (error "Bad refiling target description %s" desc)))
10603 (while (setq f (pop files))
10604 (with-current-buffer
10605 (if (bufferp f) f (org-get-agenda-file-buffer f))
10606 (or
10607 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10608 (progn
10609 (if (bufferp f) (setq f (buffer-file-name
10610 (buffer-base-buffer f))))
10611 (setq f (and f (expand-file-name f)))
10612 (if (eq org-refile-use-outline-path 'file)
10613 (push (list (file-name-nondirectory f) f nil nil) tgs))
10614 (save-excursion
10615 (save-restriction
10616 (widen)
10617 (goto-char (point-min))
10618 (while (re-search-forward descre nil t)
10619 (goto-char (setq pos0 (point-at-bol)))
10620 (catch 'next
10621 (when org-refile-target-verify-function
10622 (save-match-data
10623 (or (funcall org-refile-target-verify-function)
10624 (throw 'next t))))
10625 (when (and (looking-at org-complex-heading-regexp)
10626 (not (member (match-string 4) excluded-entries))
10627 (match-string 4))
10628 (setq level (org-reduced-level
10629 (- (match-end 1) (match-beginning 1)))
10630 txt (org-link-display-format (match-string 4))
10632 re (format org-complex-heading-regexp-format
10633 (regexp-quote (match-string 4))))
10634 (when org-refile-use-outline-path
10635 (setq txt (mapconcat
10636 'org-protect-slash
10637 (append
10638 (if (eq org-refile-use-outline-path
10639 'file)
10640 (list (file-name-nondirectory
10641 (buffer-file-name
10642 (buffer-base-buffer))))
10643 (if (eq org-refile-use-outline-path
10644 'full-file-path)
10645 (list (buffer-file-name
10646 (buffer-base-buffer)))))
10647 (org-get-outline-path fast-path-p
10648 level txt)
10649 (list txt))
10650 "/")))
10651 (push (list txt f re (org-refile-marker (point)))
10652 tgs)))
10653 (when (= (point) pos0)
10654 ;; verification function has not moved point
10655 (goto-char (point-at-eol))))))))
10656 (when org-refile-use-cache
10657 (org-refile-cache-put tgs (buffer-file-name) descre))
10658 (setq targets (append tgs targets))
10659 ))))
10660 (message "Getting targets...done")
10661 (nreverse targets)))
10663 (defun org-protect-slash (s)
10664 (while (string-match "/" s)
10666 s)
10668 (defvar org-olpa (make-vector 20 nil))
10670 (defun org-get-outline-path (&optional fastp level heading)
10671 "Return the outline path to the current entry, as a list.
10673 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10674 routine which makes outline path derivations for an entire file,
10675 avoiding backtracing. Refile target collection makes use of that."
10676 (if fastp
10677 (progn
10678 (if (> level 19)
10679 (error "Outline path failure, more than 19 levels"))
10680 (loop for i from level upto 19 do
10681 (aset org-olpa i nil))
10682 (prog1
10683 (delq nil (append org-olpa nil))
10684 (aset org-olpa level heading)))
10685 (let (rtn case-fold-search)
10686 (save-excursion
10687 (save-restriction
10688 (widen)
10689 (while (org-up-heading-safe)
10690 (when (looking-at org-complex-heading-regexp)
10691 (push (org-match-string-no-properties 4) rtn)))
10692 rtn)))))
10694 (defun org-format-outline-path (path &optional width prefix)
10695 "Format the outline path PATH for display.
10696 Width is the maximum number of characters that is available.
10697 Prefix is a prefix to be included in the returned string,
10698 such as the file name."
10699 (setq width (or width 79))
10700 (if prefix (setq width (- width (length prefix))))
10701 (if (not path)
10702 (or prefix "")
10703 (let* ((nsteps (length path))
10704 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10705 (maxwidth (if (<= total-width width)
10706 10000 ;; everything fits
10707 ;; we need to shorten the level headings
10708 (/ (- width nsteps) nsteps)))
10709 (org-odd-levels-only nil)
10710 (n 0)
10711 (total (1+ (length prefix))))
10712 (setq maxwidth (max maxwidth 10))
10713 (concat prefix
10714 (mapconcat
10715 (lambda (h)
10716 (setq n (1+ n))
10717 (if (and (= n nsteps) (< maxwidth 10000))
10718 (setq maxwidth (- total-width total)))
10719 (if (< (length h) maxwidth)
10720 (progn (setq total (+ total (length h) 1)) h)
10721 (setq h (substring h 0 (- maxwidth 2))
10722 total (+ total maxwidth 1))
10724 (setq h (substring h 0 (match-beginning 0))))
10725 (setq h (concat h "..")))
10726 (org-add-props h nil 'face
10727 (nth (% (1- n) org-n-level-faces)
10728 org-level-faces))
10729 h)
10730 path "/")))))
10732 (defun org-display-outline-path (&optional file current)
10733 "Display the current outline path in the echo area."
10734 (interactive "P")
10735 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10736 (case-fold-search nil)
10737 (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
10738 (if current (setq path (append path
10739 (save-excursion
10740 (org-back-to-heading t)
10741 (if (looking-at org-complex-heading-regexp)
10742 (list (match-string 4)))))))
10743 (message "%s"
10744 (org-format-outline-path
10745 path
10746 (1- (frame-width))
10747 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10749 (defvar org-refile-history nil
10750 "History for refiling operations.")
10752 (defvar org-after-refile-insert-hook nil
10753 "Hook run after `org-refile' has inserted its stuff at the new location.
10754 Note that this is still *before* the stuff will be removed from
10755 the *old* location.")
10757 (defvar org-capture-last-stored-marker)
10758 (defun org-refile (&optional goto default-buffer rfloc)
10759 "Move the entry or entries at point to another heading.
10760 The list of target headings is compiled using the information in
10761 `org-refile-targets', which see.
10763 At the target location, the entry is filed as a subitem of the target
10764 heading. Depending on `org-reverse-note-order', the new subitem will
10765 either be the first or the last subitem.
10767 If there is an active region, all entries in that region will be moved.
10768 However, the region must fulfill the requirement that the first heading
10769 is the first one sets the top-level of the moved text - at most siblings
10770 below it are allowed.
10772 With prefix arg GOTO, the command will only visit the target location
10773 and not actually move anything.
10776 go to the location where the last refiling operation has put the subtree.
10777 With a prefix argument of `2', refile to the running clock.
10779 RFLOC can be a refile location obtained in a different way.
10781 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10783 If you are using target caching (see `org-refile-use-cache'),
10784 you have to clear the target cache in order to find new targets.
10785 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10786 prefix argument (`C-u C-u C-u C-c C-w')."
10788 (interactive "P")
10789 (if (member goto '(0 (64)))
10790 (org-refile-cache-clear)
10791 (let* ((cbuf (current-buffer))
10792 (regionp (org-region-active-p))
10793 (region-start (and regionp (region-beginning)))
10794 (region-end (and regionp (region-end)))
10795 (region-length (and regionp (- region-end region-start)))
10796 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10797 pos it nbuf file re level reversed)
10798 (setq last-command nil)
10799 (when regionp
10800 (goto-char region-start)
10801 (or (bolp) (goto-char (point-at-bol)))
10802 (setq region-start (point))
10803 (unless (or (org-kill-is-subtree-p
10804 (buffer-substring region-start region-end))
10805 (prog1 org-refile-active-region-within-subtree
10806 (org-toggle-heading)))
10807 (error "The region is not a (sequence of) subtree(s)")))
10808 (if (equal goto '(16))
10809 (org-refile-goto-last-stored)
10810 (when (or
10811 (and (equal goto 2)
10812 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10813 (prog1
10814 (setq it (list (or org-clock-heading "running clock")
10815 (buffer-file-name
10816 (marker-buffer org-clock-hd-marker))
10817 ""
10818 (marker-position org-clock-hd-marker)))
10819 (setq goto nil)))
10820 (setq it (or rfloc
10821 (let (heading-text)
10822 (save-excursion
10823 (unless goto
10824 (org-back-to-heading t)
10825 (setq heading-text
10826 (nth 4 (org-heading-components))))
10827 (org-refile-get-location
10828 (cond (goto "Goto")
10829 (regionp "Refile region to")
10832 default-buffer
10833 (and (not (equal '(4) goto))
10834 org-refile-allow-creating-parent-nodes)
10835 goto))))))
10836 (setq file (nth 1 it)
10837 re (nth 2 it)
10838 pos (nth 3 it))
10839 (if (and (not goto)
10840 pos
10841 (equal (buffer-file-name) file)
10842 (if regionp
10843 (and (>= pos region-start)
10844 (<= pos region-end))
10845 (and (>= pos (point))
10846 (< pos (save-excursion
10847 (org-end-of-subtree t t))))))
10848 (error "Cannot refile to position inside the tree or region"))
10850 (setq nbuf (or (find-buffer-visiting file)
10851 (find-file-noselect file)))
10852 (if goto
10853 (progn
10854 (org-pop-to-buffer-same-window nbuf)
10855 (goto-char pos)
10856 (org-show-context 'org-goto))
10857 (if regionp
10858 (progn
10859 (org-kill-new (buffer-substring region-start region-end))
10860 (org-save-markers-in-region region-start region-end))
10861 (org-copy-subtree 1 nil t))
10862 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10863 (find-file-noselect file)))
10864 (setq reversed (org-notes-order-reversed-p))
10865 (save-excursion
10866 (save-restriction
10867 (widen)
10868 (if pos
10869 (progn
10870 (goto-char pos)
10871 (looking-at org-outline-regexp)
10872 (setq level (org-get-valid-level (funcall outline-level) 1))
10873 (goto-char
10874 (if reversed
10875 (or (outline-next-heading) (point-max))
10876 (or (save-excursion (org-get-next-sibling))
10877 (org-end-of-subtree t t)
10878 (point-max)))))
10879 (setq level 1)
10880 (if (not reversed)
10881 (goto-char (point-max))
10882 (goto-char (point-min))
10883 (or (outline-next-heading) (goto-char (point-max)))))
10884 (if (not (bolp)) (newline))
10885 (org-paste-subtree level)
10886 (when org-log-refile
10887 (org-add-log-setup 'refile nil nil 'findpos
10888 org-log-refile)
10889 (unless (eq org-log-refile 'note)
10890 (save-excursion (org-add-log-note))))
10891 (and org-auto-align-tags
10892 (let ((org-loop-over-headlines-in-active-region nil))
10893 (org-set-tags nil t)))
10894 (with-demoted-errors
10895 (bookmark-set "org-refile-last-stored"))
10896 ;; If we are refiling for capture, make sure that the
10897 ;; last-capture pointers point here
10898 (when (org-bound-and-true-p org-refile-for-capture)
10899 (with-demoted-errors
10900 (bookmark-set "org-capture-last-stored-marker"))
10901 (move-marker org-capture-last-stored-marker (point)))
10902 (if (fboundp 'deactivate-mark) (deactivate-mark))
10903 (run-hooks 'org-after-refile-insert-hook))))
10904 (if regionp
10905 (delete-region (point) (+ (point) region-length))
10906 (org-cut-subtree))
10907 (when (featurep 'org-inlinetask)
10908 (org-inlinetask-remove-END-maybe))
10909 (setq org-markers-to-move nil)
10912 (defun org-refile-goto-last-stored ()
10913 "Go to the location where the last refile was stored."
10914 (interactive)
10915 (bookmark-jump "org-refile-last-stored")
10916 (message "This is the location of the last refile"))
10918 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10919 no-exclude)
10920 "Prompt the user for a refile location, using PROMPT.
10921 PROMPT should not be suffixed with a colon and a space, because
10922 this function appends the default value from
10923 `org-refile-history' automatically, if that is not empty.
10924 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10925 this is used for the GOTO interface."
10926 (let ((org-refile-targets org-refile-targets)
10927 (org-refile-use-outline-path org-refile-use-outline-path)
10928 excluded-entries)
10929 (when (and (derived-mode-p 'org-mode)
10930 (not org-refile-use-cache)
10931 (not no-exclude))
10932 (org-map-tree
10933 (lambda()
10934 (setq excluded-entries
10935 (append excluded-entries (list (org-get-heading t t)))))))
10936 (setq org-refile-target-table
10937 (org-refile-get-targets default-buffer excluded-entries)))
10938 (unless org-refile-target-table
10939 (error "No refile targets"))
10940 (let* ((prompt (concat prompt
10941 (and (car org-refile-history)
10942 (concat " (default " (car org-refile-history) ")"))
10943 ": "))
10944 (cbuf (current-buffer))
10945 (partial-completion-mode nil)
10946 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10947 (cfunc (if (and org-refile-use-outline-path
10948 org-outline-path-complete-in-steps)
10949 'org-olpath-completing-read
10950 'org-icompleting-read))
10951 (extra (if org-refile-use-outline-path "/" ""))
10952 (filename (and cfn (expand-file-name cfn)))
10953 (tbl (mapcar
10954 (lambda (x)
10955 (if (and (not (member org-refile-use-outline-path
10956 '(file full-file-path)))
10957 (not (equal filename (nth 1 x))))
10958 (cons (concat (car x) extra " ("
10959 (file-name-nondirectory (nth 1 x)) ")")
10960 (cdr x))
10961 (cons (concat (car x) extra) (cdr x))))
10962 org-refile-target-table))
10963 (completion-ignore-case t)
10964 pa answ parent-target child parent old-hist)
10965 (setq old-hist org-refile-history)
10966 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10967 nil 'org-refile-history (car org-refile-history)))
10968 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10969 (org-refile-check-position pa)
10970 (if pa
10971 (progn
10972 (when (or (not org-refile-history)
10973 (not (eq old-hist org-refile-history))
10974 (not (equal (car pa) (car org-refile-history))))
10975 (setq org-refile-history
10976 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10977 org-refile-history
10978 (cdr org-refile-history))))
10979 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10980 (pop org-refile-history)))
10981 pa)
10983 (progn
10984 (setq parent (match-string 1 answ)
10985 child (match-string 2 answ))
10986 (setq parent-target (or (assoc parent tbl)
10987 (assoc (concat parent "/") tbl)))
10988 (when (and parent-target
10989 (or (eq new-nodes t)
10990 (and (eq new-nodes 'confirm)
10992 child)))))
10993 (org-refile-new-child parent-target child)))
10994 (error "Invalid target location")))))
10996 (declare-function org-string-nw-p "org-macs" (s))
10997 (defun org-refile-check-position (refile-pointer)
10998 "Check if the refile pointer matches the headline to which it points."
10999 (let* ((file (nth 1 refile-pointer))
11000 (re (nth 2 refile-pointer))
11001 (pos (nth 3 refile-pointer))
11002 buffer)
11003 (if (and (not (markerp pos)) (not file))
11004 (error "Please save the buffer to a file before refiling")
11005 (when (org-string-nw-p re)
11006 (setq buffer (if (markerp pos)
11007 (marker-buffer pos)
11008 (or (find-buffer-visiting file)
11009 (find-file-noselect file))))
11010 (with-current-buffer buffer
11011 (save-excursion
11012 (save-restriction
11013 (widen)
11014 (goto-char pos)
11015 (beginning-of-line 1)
11016 (unless (org-looking-at-p re)
11017 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11019 (defun org-refile-new-child (parent-target child)
11020 "Use refile target PARENT-TARGET to add new CHILD below it."
11021 (unless parent-target
11022 (error "Cannot find parent for new node"))
11023 (let ((file (nth 1 parent-target))
11024 (pos (nth 3 parent-target))
11025 level)
11026 (with-current-buffer (or (find-buffer-visiting file)
11027 (find-file-noselect file))
11028 (save-excursion
11029 (save-restriction
11030 (widen)
11031 (if pos
11032 (goto-char pos)
11033 (goto-char (point-max))
11034 (if (not (bolp)) (newline)))
11035 (when (looking-at org-outline-regexp)
11036 (setq level (funcall outline-level))
11037 (org-end-of-subtree t t))
11038 (org-back-over-empty-lines)
11040 (if pos (org-get-valid-level level 1) 1) ?*)
11042 (beginning-of-line 0)
11043 (list (concat (car parent-target) "/" child) file "" (point)))))))
11045 (defun org-olpath-completing-read (prompt collection &rest args)
11046 "Read an outline path like a file name."
11047 (let ((thetable collection)
11048 (org-completion-use-ido nil) ; does not work with ido.
11049 (org-completion-use-iswitchb nil)) ; or iswitchb
11050 (apply
11051 'org-icompleting-read prompt
11052 (lambda (string predicate &optional flag)
11053 (let (rtn r f (l (length string)))
11054 (cond
11055 ((eq flag nil)
11056 ;; try completion
11057 (try-completion string thetable))
11058 ((eq flag t)
11059 ;; all-completions
11060 (setq rtn (all-completions string thetable predicate))
11061 (mapcar
11062 (lambda (x)
11063 (setq r (substring x l))
11064 (if (string-match " ([^)]*)$" x)
11065 (setq f (match-string 0 x))
11066 (setq f ""))
11067 (if (string-match "/" r)
11068 (concat string (substring r 0 (match-end 0)) f)
11069 x))
11070 rtn))
11071 ((eq flag 'lambda)
11072 ;; exact match?
11073 (assoc string thetable)))))
11074 args)))
11076 ;;;; Dynamic blocks
11078 (defun org-find-dblock (name)
11079 "Find the first dynamic block with name NAME in the buffer.
11080 If not found, stay at current position and return nil."
11081 (let ((case-fold-search t) pos)
11082 (save-excursion
11083 (goto-char (point-min))
11084 (setq pos (and (re-search-forward
11086 (match-beginning 0))))
11087 (if pos (goto-char pos))
11088 pos))
11090 (defconst org-dblock-start-re
11092 "Matches the start line of a dynamic block, with parameters.")
11095 "Matches the end of a dynamic block.")
11097 (defun org-create-dblock (plist)
11098 "Create a dynamic block section, with parameters taken from PLIST.
11099 PLIST must contain a :name entry which is used as name of the block."
11101 (end-of-line 1)
11102 (newline))
11103 (let ((col (current-column))
11104 (name (plist-get plist :name)))
11105 (insert "#+BEGIN: " name)
11106 (while plist
11107 (if (eq (car plist) :name)
11108 (setq plist (cddr plist))
11109 (insert " " (prin1-to-string (pop plist)))))
11111 (beginning-of-line -2)))
11113 (defun org-prepare-dblock ()
11114 "Prepare dynamic block for refresh.
11115 This empties the block, puts the cursor at the insert position and returns
11116 the property list including an extra property :name with the block name."
11117 (unless (looking-at org-dblock-start-re)
11118 (error "Not at a dynamic block"))
11119 (let* ((begdel (1+ (match-end 0)))
11120 (name (org-no-properties (match-string 1)))
11121 (params (append (list :name name)
11122 (read (concat "(" (match-string 3) ")")))))
11123 (save-excursion
11124 (beginning-of-line 1)
11126 (setq params (plist-put params :indentation-column (current-column))))
11127 (unless (re-search-forward org-dblock-end-re nil t)
11128 (error "Dynamic block not terminated"))
11129 (setq params
11130 (append params
11131 (list :content (buffer-substring
11132 begdel (match-beginning 0)))))
11133 (delete-region begdel (match-beginning 0))
11134 (goto-char begdel)
11135 (open-line 1)
11136 params))
11138 (defun org-map-dblocks (&optional command)
11139 "Apply COMMAND to all dynamic blocks in the current buffer.
11140 If COMMAND is not given, use `org-update-dblock'."
11141 (let ((cmd (or command 'org-update-dblock)))
11142 (save-excursion
11143 (goto-char (point-min))
11144 (while (re-search-forward org-dblock-start-re nil t)
11145 (goto-char (match-beginning 0))
11146 (save-excursion
11147 (condition-case nil
11148 (funcall cmd)
11149 (error (message "Error during update of dynamic block"))))
11150 (unless (re-search-forward org-dblock-end-re nil t)
11151 (error "Dynamic block not terminated"))))))
11153 (defun org-dblock-update (&optional arg)
11154 "User command for updating dynamic blocks.
11155 Update the dynamic block at point. With prefix ARG, update all dynamic
11156 blocks in the buffer."
11157 (interactive "P")
11158 (if arg
11159 (org-update-all-dblocks)
11160 (or (looking-at org-dblock-start-re)
11161 (org-beginning-of-dblock))
11162 (org-update-dblock)))
11164 (defun org-update-dblock ()
11165 "Update the dynamic block at point.
11166 This means to empty the block, parse for parameters and then call
11167 the correct writing function."
11168 (interactive)
11169 (save-window-excursion
11170 (let* ((pos (point))
11171 (line (org-current-line))
11172 (params (org-prepare-dblock))
11173 (name (plist-get params :name))
11174 (indent (plist-get params :indentation-column))
11175 (cmd (intern (concat "org-dblock-write:" name))))
11176 (message "Updating dynamic block `%s' at line %d..." name line)
11177 (funcall cmd params)
11178 (message "Updating dynamic block `%s' at line %d...done" name line)
11179 (goto-char pos)
11180 (when (and indent (> indent 0))
11181 (setq indent (make-string indent ?\ ))
11182 (save-excursion
11183 (org-beginning-of-dblock)
11184 (forward-line 1)
11185 (while (not (looking-at org-dblock-end-re))
11186 (insert indent)
11187 (beginning-of-line 2))
11188 (when (looking-at org-dblock-end-re)
11190 (replace-match ""))
11191 (insert indent)))))))
11193 (defun org-beginning-of-dblock ()
11194 "Find the beginning of the dynamic block at point.
11195 Error if there is no such block at point."
11196 (let ((pos (point))
11197 beg)
11198 (end-of-line 1)
11199 (if (and (re-search-backward org-dblock-start-re nil t)
11200 (setq beg (match-beginning 0))
11201 (re-search-forward org-dblock-end-re nil t)
11202 (> (match-end 0) pos))
11203 (goto-char beg)
11204 (goto-char pos)
11205 (error "Not in a dynamic block"))))
11207 (defun org-update-all-dblocks ()
11208 "Update all dynamic blocks in the buffer.
11209 This function can be used in a hook."
11210 (interactive)
11211 (when (derived-mode-p 'org-mode)
11212 (org-map-dblocks 'org-update-dblock)))
11215 ;;;; Completion
11217 (defconst org-additional-option-like-keywords
11218 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11219 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11220 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11221 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11222 "BEGIN:" "END:"
11223 "ORGTBL" "TBLFM:" "TBLNAME:"
11224 "BEGIN_EXAMPLE" "END_EXAMPLE"
11225 "BEGIN_VERBATIM" "END_VERBATIM"
11226 "BEGIN_QUOTE" "END_QUOTE"
11227 "BEGIN_VERSE" "END_VERSE"
11228 "BEGIN_CENTER" "END_CENTER"
11229 "BEGIN_SRC" "END_SRC"
11230 "BEGIN_RESULT" "END_RESULT"
11231 "BEGIN_lstlisting" "END_lstlisting"
11232 "NAME:" "RESULTS:"
11233 "HEADER:" "HEADERS:"
11234 "COLUMNS:" "PROPERTY:"
11235 "CAPTION:" "LABEL:"
11236 "SETUPFILE:"
11237 "INCLUDE:" "INDEX:"
11238 "BIND:"
11239 "MACRO:"))
11241 (defconst org-options-keywords
11242 '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
11243 "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
11244 "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
11245 "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
11246 "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
11247 "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:" "STYLE:"
11248 "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
11250 (defconst org-additional-option-like-keywords-for-flyspell
11251 (delete-dups
11252 (split-string
11253 (mapconcat (lambda(k)
11254 (replace-regexp-in-string
11256 (concat k " " (downcase k) " " (upcase k))))
11257 (append org-options-keywords org-additional-option-like-keywords)
11258 " ")
11259 " +" t)))
11261 (defcustom org-structure-template-alist
11276 ("L" "#+LaTeX: "
11280 ("H" "#+HTML: "
11283 ("A" "#+ASCII: ")
11284 ("i" "#+INDEX: ?"
11285 "#+INDEX: ?")
11286 ("I" "#+INCLUDE: %file ?"
11288 "Structure completion elements.
11289 This is a list of abbreviation keys and values. The value gets inserted
11290 if you type `<' followed by the key and then press the completion key,
11291 usually `M-TAB'. %file will be replaced by a file name after prompting
11292 for the file using completion. The cursor will be placed at the position
11293 of the `?` in the template.
11294 There are two templates for each key, the first uses the original Org syntax,
11295 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11296 the default when the /org-mtags.el/ module has been loaded. See also the
11297 variable `org-mtags-prefer-muse-templates'."
11298 :group 'org-completion
11299 :type '(repeat
11300 (string :tag "Key")
11301 (string :tag "Template")
11302 (string :tag "Muse Template")))
11304 (defun org-try-structure-completion ()
11305 "Try to complete a structure template before point.
11307 expands them."
11308 (let ((l (buffer-substring (point-at-bol) (point)))
11309 a)
11312 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11313 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11314 (match-beginning 1)) a)
11315 t)))
11317 (defun org-complete-expand-structure-template (start cell)
11318 "Expand a structure template."
11319 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11320 (rpl (nth (if musep 2 1) cell))
11321 (ind ""))
11322 (delete-region start (point))
11324 (cond
11325 ((bolp))
11327 (setq ind (buffer-substring (point-at-bol) (point))))
11328 (t (newline))))
11329 (setq start (point))
11330 (if (string-match "%file" rpl)
11331 (setq rpl (replace-match
11332 (concat
11334 (save-match-data
11335 (abbreviate-file-name (read-file-name "Include file: ")))
11337 t t rpl)))
11340 (insert rpl)
11343 ;;;; TODO, DEADLINE, Comments
11345 (defun org-toggle-comment ()
11346 "Change the COMMENT state of an entry."
11347 (interactive)
11348 (save-excursion
11349 (org-back-to-heading)
11350 (let (case-fold-search)
11351 (cond
11352 ((looking-at (format org-heading-keyword-regexp-format
11353 org-comment-string))
11354 (goto-char (match-end 1))
11355 (looking-at (concat " +" org-comment-string))
11356 (replace-match "" t t)
11357 (when (eolp) (insert " ")))
11358 ((looking-at org-outline-regexp)
11359 (goto-char (match-end 0))
11360 (insert org-comment-string " "))))))
11362 (defvar org-last-todo-state-is-todo nil
11363 "This is non-nil when the last TODO state change led to a TODO state.
11364 If the last change removed the TODO tag or switched to DONE, then
11365 this is nil.")
11367 (defvar org-setting-tags nil) ; dynamically skipped
11369 (defvar org-todo-setup-filter-hook nil
11370 "Hook for functions that pre-filter todo specs.
11371 Each function takes a todo spec and returns either nil or the spec
11372 transformed into canonical form." )
11374 (defvar org-todo-get-default-hook nil
11375 "Hook for functions that get a default item for todo.
11376 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11377 nil or a string to be used for the todo mark." )
11379 (defvar org-agenda-headline-snapshot-before-repeat)
11381 (defun org-current-effective-time ()
11382 "Return current time adjusted for `org-extend-today-until' variable."
11383 (let* ((ct (org-current-time))
11384 (dct (decode-time ct))
11385 (ct1
11386 (if (and org-use-effective-time
11387 (< (nth 2 dct) org-extend-today-until))
11388 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11389 ct)))
11390 ct1))
11392 (defun org-todo-yesterday (&optional arg)
11393 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11394 (interactive "P")
11395 (if (eq major-mode 'org-agenda-mode)
11396 (apply 'org-agenda-todo-yesterday arg)
11397 (let* ((hour (third (decode-time
11398 (org-current-time))))
11399 (org-extend-today-until (1+ hour)))
11400 (org-todo arg))))
11402 (defun org-todo (&optional arg)
11403 "Change the TODO state of an item.
11404 The state of an item is given by a keyword at the start of the heading,
11405 like
11406 *** TODO Write paper
11407 *** DONE Call mom
11409 The different keywords are specified in the variable `org-todo-keywords'.
11411 So for this example: when the item starts with TODO, it is changed to DONE.
11412 When it starts with DONE, the DONE is removed. And when neither TODO nor
11413 DONE are present, add TODO at the beginning of the heading.
11416 state.
11417 With numeric prefix arg, switch to that state.
11419 keywords (nextset).
11421 With a numeric prefix arg of 0, inhibit note taking for the change.
11423 For calling through lisp, arg is also interpreted in the following way:
11424 'none -> empty state
11426 'done -> switch to DONE
11427 'nextset -> switch to the next set of keywords
11428 'previousset -> switch to the previous set of keywords
11430 really is a member of `org-todo-keywords'."
11431 (interactive "P")
11432 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11433 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11434 'region-start-level 'region))
11435 org-loop-over-headlines-in-active-region)
11436 (org-map-entries
11437 `(org-todo ,arg)
11438 org-loop-over-headlines-in-active-region
11439 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11440 (if (equal arg '(16)) (setq arg 'nextset))
11441 (let ((org-blocker-hook org-blocker-hook)
11442 commentp
11443 case-fold-search)
11444 (when (equal arg '(64))
11445 (setq arg nil org-blocker-hook nil))
11446 (when (and org-blocker-hook
11447 (or org-inhibit-blocking
11448 (org-entry-get nil "NOBLOCKING")))
11449 (setq org-blocker-hook nil))
11450 (save-excursion
11451 (catch 'exit
11452 (org-back-to-heading t)
11454 (org-toggle-comment)
11455 (setq commentp t))
11456 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11459 (let* ((match-data (match-data))
11460 (startpos (point-at-bol))
11461 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11462 (org-log-done org-log-done)
11463 (org-log-repeat org-log-repeat)
11464 (org-todo-log-states org-todo-log-states)
11465 (org-inhibit-logging
11466 (if (equal arg 0)
11467 (progn (setq arg nil) 'note) org-inhibit-logging))
11468 (this (match-string 1))
11469 (hl-pos (match-beginning 0))
11470 (head (org-get-todo-sequence-head this))
11471 (ass (assoc head org-todo-kwd-alist))
11472 (interpret (nth 1 ass))
11473 (done-word (nth 3 ass))
11474 (final-done-word (nth 4 ass))
11475 (org-last-state (or this ""))
11476 (completion-ignore-case t)
11477 (member (member this org-todo-keywords-1))
11478 (tail (cdr member))
11479 (org-state (cond
11480 ((and org-todo-key-trigger
11481 (or (and (equal arg '(4))
11482 (eq org-use-fast-todo-selection 'prefix))
11483 (and (not arg) org-use-fast-todo-selection
11484 (not (eq org-use-fast-todo-selection
11485 'prefix)))))
11486 ;; Use fast selection
11487 (org-fast-todo-selection))
11488 ((and (equal arg '(4))
11489 (or (not org-use-fast-todo-selection)
11490 (not org-todo-key-trigger)))
11491 ;; Read a state with completion
11492 (org-icompleting-read
11493 "State: " (mapcar (lambda(x) (list x))
11494 org-todo-keywords-1)
11495 nil t))
11496 ((eq arg 'right)
11497 (if this
11498 (if tail (car tail) nil)
11499 (car org-todo-keywords-1)))
11500 ((eq arg 'left)
11501 (if (equal member org-todo-keywords-1)
11502 nil
11503 (if this
11504 (nth (- (length org-todo-keywords-1)
11505 (length tail) 2)
11506 org-todo-keywords-1)
11507 (org-last org-todo-keywords-1))))
11508 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11509 (setq arg nil))) ; hack to fall back to cycling
11510 (arg
11511 ;; user or caller requests a specific state
11512 (cond
11513 ((equal arg "") nil)
11514 ((eq arg 'none) nil)
11515 ((eq arg 'done) (or done-word (car org-done-keywords)))
11516 ((eq arg 'nextset)
11517 (or (car (cdr (member head org-todo-heads)))
11518 (car org-todo-heads)))
11519 ((eq arg 'previousset)
11520 (let ((org-todo-heads (reverse org-todo-heads)))
11521 (or (car (cdr (member head org-todo-heads)))
11522 (car org-todo-heads))))
11523 ((car (member arg org-todo-keywords-1)))
11524 ((stringp arg)
11525 (error "State `%s' not valid in this file" arg))
11526 ((nth (1- (prefix-numeric-value arg))
11527 org-todo-keywords-1))))
11528 ((null member) (or head (car org-todo-keywords-1)))
11529 ((equal this final-done-word) nil) ;; -> make empty
11530 ((null tail) nil) ;; -> first entry
11531 ((memq interpret '(type priority))
11532 (if (eq this-command last-command)
11533 (car tail)
11534 (if (> (length tail) 0)
11535 (or done-word (car org-done-keywords))
11536 nil)))
11537 (t
11538 (car tail))))
11539 (org-state (or
11540 (run-hook-with-args-until-success
11541 'org-todo-get-default-hook org-state org-last-state)
11542 org-state))
11543 (next (if org-state (concat " " org-state " ") " "))
11544 (change-plist (list :type 'todo-state-change :from this :to org-state
11545 :position startpos))
11546 dolog now-done-p)
11547 (when org-blocker-hook
11548 (setq org-last-todo-state-is-todo
11549 (not (member this org-done-keywords)))
11550 (unless (save-excursion
11551 (save-match-data
11552 (org-with-wide-buffer
11553 (run-hook-with-args-until-failure
11554 'org-blocker-hook change-plist))))
11555 (if (org-called-interactively-p 'interactive)
11556 (error "TODO state change from %s to %s blocked" this org-state)
11557 ;; fail silently
11558 (message "TODO state change from %s to %s blocked" this org-state)
11559 (throw 'exit nil))))
11560 (store-match-data match-data)
11561 (replace-match next t t)
11562 (unless (pos-visible-in-window-p hl-pos)
11563 (message "TODO state changed to %s" (org-trim next)))
11564 (unless head
11565 (setq head (org-get-todo-sequence-head org-state)
11566 ass (assoc head org-todo-kwd-alist)
11567 interpret (nth 1 ass)
11568 done-word (nth 3 ass)
11569 final-done-word (nth 4 ass)))
11570 (when (memq arg '(nextset previousset))
11571 (message "Keyword-Set %d/%d: %s"
11572 (- (length org-todo-sets) -1
11573 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11574 (length org-todo-sets)
11575 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11576 (setq org-last-todo-state-is-todo
11577 (not (member org-state org-done-keywords)))
11578 (setq now-done-p (and (member org-state org-done-keywords)
11579 (not (member this org-done-keywords))))
11580 (and logging (org-local-logging logging))
11581 (when (and (or org-todo-log-states org-log-done)
11582 (not (eq org-inhibit-logging t))
11583 (not (memq arg '(nextset previousset))))
11584 ;; we need to look at recording a time and note
11585 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11586 (nth 2 (assoc this org-todo-log-states))))
11587 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11588 (setq dolog 'time))
11589 (when (and org-state
11590 (member org-state org-not-done-keywords)
11591 (not (member this org-not-done-keywords)))
11592 ;; This is now a todo state and was not one before
11593 ;; If there was a CLOSED time stamp, get rid of it.
11594 (org-add-planning-info nil nil 'closed))
11595 (when (and now-done-p org-log-done)
11596 ;; It is now done, and it was not done before
11597 (org-add-planning-info 'closed (org-current-effective-time))
11598 (if (and (not dolog) (eq 'note org-log-done))
11599 (org-add-log-setup 'done org-state this 'findpos 'note)))
11600 (when (and org-state dolog)
11601 ;; This is a non-nil state, and we need to log it
11602 (org-add-log-setup 'state org-state this 'findpos dolog)))
11603 ;; Fixup tag positioning
11604 (org-todo-trigger-tag-changes org-state)
11605 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11606 (when org-provide-todo-statistics
11607 (org-update-parent-todo-statistics))
11608 (run-hooks 'org-after-todo-state-change-hook)
11609 (if (and arg (not (member org-state org-done-keywords)))
11610 (setq head (org-get-todo-sequence-head org-state)))
11611 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11612 ;; Do we need to trigger a repeat?
11613 (when now-done-p
11614 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11615 ;; This is for the agenda, take a snapshot of the headline.
11616 (save-match-data
11617 (setq org-agenda-headline-snapshot-before-repeat
11618 (org-get-heading))))
11619 (org-auto-repeat-maybe org-state))
11620 ;; Fixup cursor location if close to the keyword
11621 (if (and (outline-on-heading-p)
11622 (not (bolp))
11623 (save-excursion (beginning-of-line 1)
11624 (looking-at org-todo-line-regexp))
11625 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11626 (progn
11627 (goto-char (or (match-end 2) (match-end 1)))
11628 (and (looking-at " ") (just-one-space))))
11629 (when org-trigger-hook
11630 (save-excursion
11631 (run-hook-with-args 'org-trigger-hook change-plist)))
11632 (when commentp (org-toggle-comment))))))))
11634 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11635 "Block turning an entry into a TODO, using the hierarchy.
11636 This checks whether the current task should be blocked from state
11637 changes. Such blocking occurs when:
11639 1. The task has children which are not all in a completed state.
11641 2. A task has a parent with the property :ORDERED:, and there
11642 are siblings prior to the current task with incomplete
11643 status.
11645 3. The parent of the task is blocked because it has siblings that should
11646 be done first, or is child of a block grandparent TODO entry."
11648 (if (not org-enforce-todo-dependencies)
11649 t ; if locally turned off don't block
11650 (catch 'dont-block
11651 ;; If this is not a todo state change, or if this entry is already DONE,
11652 ;; do not block
11653 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11654 (member (plist-get change-plist :from)
11655 (cons 'done org-done-keywords))
11656 (member (plist-get change-plist :to)
11657 (cons 'todo org-not-done-keywords))
11658 (not (plist-get change-plist :to)))
11659 (throw 'dont-block t))
11660 ;; If this task has children, and any are undone, it's blocked
11661 (save-excursion
11662 (org-back-to-heading t)
11663 (let ((this-level (funcall outline-level)))
11664 (outline-next-heading)
11665 (let ((child-level (funcall outline-level)))
11666 (while (and (not (eobp))
11667 (> child-level this-level))
11668 ;; this todo has children, check whether they are all
11669 ;; completed
11670 (if (and (not (org-entry-is-done-p))
11671 (org-entry-is-todo-p))
11672 (throw 'dont-block nil))
11673 (outline-next-heading)
11674 (setq child-level (funcall outline-level))))))
11675 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11676 ;; any previous siblings are undone, it's blocked
11677 (save-excursion
11678 (org-back-to-heading t)
11679 (let* ((pos (point))
11680 (parent-pos (and (org-up-heading-safe) (point))))
11681 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11682 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11683 (forward-line 1)
11684 (re-search-forward org-not-done-heading-regexp pos t))
11685 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11686 ;; Search further up the hierarchy, to see if an ancestor is blocked
11687 (while t
11688 (goto-char parent-pos)
11689 (if (not (looking-at org-not-done-heading-regexp))
11690 (throw 'dont-block t)) ; do not block, parent is not a TODO
11691 (setq pos (point))
11692 (setq parent-pos (and (org-up-heading-safe) (point)))
11693 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11694 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11695 (forward-line 1)
11696 (re-search-forward org-not-done-heading-regexp pos t))
11697 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11699 (defcustom org-track-ordered-property-with-tag nil
11700 "Should the ORDERED property also be shown as a tag?
11701 The ORDERED property decides if an entry should require subtasks to be
11702 completed in sequence. Since a property is not very visible, setting
11703 this option means that toggling the ORDERED property with the command
11704 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11705 not relevant for the behavior, but it makes things more visible.
11707 Note that toggling the tag with tags commands will not change the property
11708 and therefore not influence behavior!
11710 This can be t, meaning the tag ORDERED should be used, It can also be a
11711 string to select a different tag for this task."
11712 :group 'org-todo
11713 :type '(choice
11714 (const :tag "No tracking" nil)
11715 (const :tag "Track with ORDERED tag" t)
11716 (string :tag "Use other tag")))
11718 (defun org-toggle-ordered-property ()
11719 "Toggle the ORDERED property of the current entry.
11720 For better visibility, you can track the value of this property with a tag.
11721 See variable `org-track-ordered-property-with-tag'."
11722 (interactive)
11723 (let* ((t1 org-track-ordered-property-with-tag)
11724 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11725 (save-excursion
11726 (org-back-to-heading)
11727 (if (org-entry-get nil "ORDERED")
11728 (progn
11729 (org-delete-property "ORDERED")
11730 (and tag (org-toggle-tag tag 'off))
11731 (message "Subtasks can be completed in arbitrary order"))
11732 (org-entry-put nil "ORDERED" "t")
11733 (and tag (org-toggle-tag tag 'on))
11734 (message "Subtasks must be completed in sequence")))))
11736 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11737 (defun org-block-todo-from-checkboxes (change-plist)
11738 "Block turning an entry into a TODO, using checkboxes.
11739 This checks whether the current task should be blocked from state
11740 changes because there are unchecked boxes in this entry."
11741 (if (not org-enforce-todo-checkbox-dependencies)
11742 t ; if locally turned off don't block
11743 (catch 'dont-block
11744 ;; If this is not a todo state change, or if this entry is already DONE,
11745 ;; do not block
11746 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11747 (member (plist-get change-plist :from)
11748 (cons 'done org-done-keywords))
11749 (member (plist-get change-plist :to)
11750 (cons 'todo org-not-done-keywords))
11751 (not (plist-get change-plist :to)))
11752 (throw 'dont-block t))
11753 ;; If this task has checkboxes that are not checked, it's blocked
11754 (save-excursion
11755 (org-back-to-heading t)
11756 (let ((beg (point)) end)
11757 (outline-next-heading)
11758 (setq end (point))
11759 (goto-char beg)
11760 (if (org-list-search-forward
11761 (concat (org-item-beginning-re)
11764 end t)
11765 (progn
11766 (if (boundp 'org-blocked-by-checkboxes)
11767 (setq org-blocked-by-checkboxes t))
11768 (throw 'dont-block nil)))))
11769 t))) ; do not block
11771 (defun org-entry-blocked-p ()
11772 "Is the current entry blocked?"
11773 (if (org-entry-get nil "NOBLOCKING")
11774 nil ;; Never block this entry
11775 (not
11776 (run-hook-with-args-until-failure
11777 'org-blocker-hook
11778 (list :type 'todo-state-change
11779 :position (point)
11780 :from 'todo
11781 :to 'done)))))
11783 (defun org-update-statistics-cookies (all)
11784 "Update the statistics cookie, either from TODO or from checkboxes.
11785 This should be called with the cursor in a line with a statistics cookie."
11786 (interactive "P")
11787 (if all
11788 (progn
11789 (org-update-checkbox-count 'all)
11790 (org-map-entries 'org-update-parent-todo-statistics))
11791 (if (not (org-at-heading-p))
11792 (org-update-checkbox-count)
11793 (let ((pos (point-marker))
11794 end l1 l2)
11795 (ignore-errors (org-back-to-heading t))
11796 (if (not (org-at-heading-p))
11797 (org-update-checkbox-count)
11798 (setq l1 (org-outline-level))
11799 (setq end (save-excursion
11800 (outline-next-heading)
11801 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11802 (point)))
11803 (if (and (save-excursion
11804 (re-search-forward
11806 (not (save-excursion (re-search-forward
11808 (org-update-checkbox-count)
11809 (if (and l2 (> l2 l1))
11810 (progn
11811 (goto-char end)
11812 (org-update-parent-todo-statistics))
11813 (goto-char pos)
11814 (beginning-of-line 1)
11815 (while (re-search-forward
11817 (point-at-eol) t)
11818 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11819 (goto-char pos)
11820 (move-marker pos nil)))))
11822 (defvar org-entry-property-inherited-from) ;; defined below
11823 (defun org-update-parent-todo-statistics ()
11824 "Update any statistics cookie in the parent of the current headline.
11825 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11826 the entire subtree and this will travel up the hierarchy and update
11827 statistics everywhere."
11828 (let* ((prop (save-excursion (org-up-heading-safe)
11829 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11830 (recursive (or (not org-hierarchical-todo-statistics)
11832 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11833 0))
11834 (first t)
11836 level ltoggle l1 new ndel
11837 (cnt-all 0) (cnt-done 0) is-percent kwd
11838 checkbox-beg ov ovs ove cookie-present)
11839 (catch 'exit
11840 (save-excursion
11841 (beginning-of-line 1)
11842 (setq ltoggle (funcall outline-level))
11843 ;; Three situations are to consider:
11845 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11846 ;; to the top-level ancestor on the headline;
11848 ;; 2. If parent has "recursive" property, repeat up to the
11849 ;; headline setting that property, taking inheritance into
11850 ;; account;
11852 ;; 3. Else, move up to direct parent and proceed only once.
11853 (while (and (setq level (org-up-heading-safe))
11854 (or recursive first)
11855 (>= (point) lim))
11856 (setq first nil cookie-present nil)
11857 (unless (and level
11858 (not (string-match
11860 (downcase (or (org-entry-get nil "COOKIE_DATA")
11861 "")))))
11862 (throw 'exit nil))
11863 (while (re-search-forward box-re (point-at-eol) t)
11864 (setq cnt-all 0 cnt-done 0 cookie-present t)
11865 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11866 (save-match-data
11867 (unless (outline-next-heading) (throw 'exit nil))
11868 (while (and (looking-at org-complex-heading-regexp)
11869 (> (setq l1 (length (match-string 1))) level))
11870 (setq kwd (and (or recursive (= l1 ltoggle))
11871 (match-string 2)))
11872 (if (or (eq org-provide-todo-statistics 'all-headlines)
11873 (and (listp org-provide-todo-statistics)
11874 (or (member kwd org-provide-todo-statistics)
11875 (member kwd org-done-keywords))))
11876 (setq cnt-all (1+ cnt-all))
11877 (if (eq org-provide-todo-statistics t)
11878 (and kwd (setq cnt-all (1+ cnt-all)))))
11879 (and (member kwd org-done-keywords)
11880 (setq cnt-done (1+ cnt-done)))
11881 (outline-next-heading)))
11882 (setq new
11883 (if is-percent
11884 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11885 (format "[%d/%d]" cnt-done cnt-all))
11886 ndel (- (match-end 0) checkbox-beg))
11887 ;; handle overlays when updating cookie from column view
11888 (when (setq ov (car (overlays-at checkbox-beg)))
11889 (setq ovs (overlay-start ov) ove (overlay-end ov))
11890 (delete-overlay ov))
11891 (goto-char checkbox-beg)
11892 (insert new)
11893 (delete-region (point) (+ (point) ndel))
11894 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11895 (when ov (move-overlay ov ovs ove)))
11896 (when cookie-present
11897 (run-hook-with-args 'org-after-todo-statistics-hook
11898 cnt-done (- cnt-all cnt-done))))))
11899 (run-hooks 'org-todo-statistics-hook)))
11901 (defvar org-after-todo-statistics-hook nil
11902 "Hook that is called after a TODO statistics cookie has been updated.
11903 Each function is called with two arguments: the number of not-done entries
11904 and the number of done entries.
11906 For example, the following function, when added to this hook, will switch
11907 an entry to DONE when all children are done, and back to TODO when new
11908 entries are set to a TODO status. Note that this hook is only called
11909 when there is a statistics cookie in the headline!
11911 (defun org-summary-todo (n-done n-not-done)
11913 (let (org-log-done org-log-states) ; turn off logging
11915 ")
11917 (defvar org-todo-statistics-hook nil
11918 "Hook that is run whenever Org thinks TODO statistics should be updated.
11919 This hook runs even if there is no statistics cookie present, in which case
11920 `org-after-todo-statistics-hook' would not run.")
11922 (defun org-todo-trigger-tag-changes (state)
11923 "Apply the changes defined in `org-todo-state-tags-triggers'."
11924 (let ((l org-todo-state-tags-triggers)
11925 changes)
11926 (when (or (not state) (equal state ""))
11927 (setq changes (append changes (cdr (assoc "" l)))))
11928 (when (and (stringp state) (> (length state) 0))
11929 (setq changes (append changes (cdr (assoc state l)))))
11930 (when (member state org-not-done-keywords)
11931 (setq changes (append changes (cdr (assoc 'todo l)))))
11932 (when (member state org-done-keywords)
11933 (setq changes (append changes (cdr (assoc 'done l)))))
11934 (dolist (c changes)
11935 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11937 (defun org-local-logging (value)
11938 "Get logging settings from a property VALUE."
11939 (let* (words w a)
11940 ;; directly set the variables, they are already local.
11941 (setq org-log-done nil
11942 org-log-repeat nil
11943 org-todo-log-states nil)
11944 (setq words (org-split-string value))
11945 (while (setq w (pop words))
11946 (cond
11947 ((setq a (assoc w org-startup-options))
11948 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11949 (set (nth 1 a) (nth 2 a))))
11950 ((setq a (org-extract-log-state-settings w))
11951 (and (member (car a) org-todo-keywords-1)
11952 (push a org-todo-log-states)))))))
11954 (defun org-get-todo-sequence-head (kwd)
11955 "Return the head of the TODO sequence to which KWD belongs.
11956 If KWD is not set, check if there is a text property remembering the
11957 right sequence."
11958 (let (p)
11959 (cond
11960 ((not kwd)
11961 (or (get-text-property (point-at-bol) 'org-todo-head)
11962 (progn
11963 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11964 nil (point-at-eol)))
11965 (get-text-property p 'org-todo-head))))
11966 ((not (member kwd org-todo-keywords-1))
11967 (car org-todo-keywords-1))
11968 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11970 (defun org-fast-todo-selection ()
11971 "Fast TODO keyword selection with single keys.
11972 Returns the new TODO keyword, or nil if no state change should occur."
11973 (let* ((fulltable org-todo-key-alist)
11974 (done-keywords org-done-keywords) ;; needed for the faces.
11975 (maxlen (apply 'max (mapcar
11976 (lambda (x)
11977 (if (stringp (car x)) (string-width (car x)) 0))
11978 fulltable)))
11979 (expert nil)
11980 (fwidth (+ maxlen 3 1 3))
11981 (ncol (/ (- (window-width) 4) fwidth))
11982 tg cnt e c tbl
11983 groups ingroup)
11984 (save-excursion
11985 (save-window-excursion
11986 (if expert
11987 (set-buffer (get-buffer-create " *Org todo*"))
11988 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11989 (erase-buffer)
11990 (org-set-local 'org-done-keywords done-keywords)
11991 (setq tbl fulltable cnt 0)
11992 (while (setq e (pop tbl))
11993 (cond
11994 ((equal e '(:startgroup))
11995 (push '() groups) (setq ingroup t)
11996 (when (not (= cnt 0))
11997 (setq cnt 0)
11999 (insert "{ "))
12000 ((equal e '(:endgroup))
12001 (setq ingroup nil cnt 0)
12003 ((equal e '(:newline))
12004 (when (not (= cnt 0))
12005 (setq cnt 0)
12007 (setq e (car tbl))
12008 (while (equal (car tbl) '(:newline))
12010 (setq tbl (cdr tbl)))))
12011 (t
12012 (setq tg (car e) c (cdr e))
12013 (if ingroup (push tg (car groups)))
12014 (setq tg (org-add-props tg nil 'face
12015 (org-get-todo-face tg)))
12016 (if (and (= cnt 0) (not ingroup)) (insert " "))
12017 (insert "[" c "] " tg (make-string
12018 (- fwidth 4 (length tg)) ?\ ))
12019 (when (= (setq cnt (1+ cnt)) ncol)
12021 (if ingroup (insert " "))
12022 (setq cnt 0)))))
12024 (goto-char (point-min))
12025 (if (not expert) (org-fit-window-to-buffer))
12026 (message "[a-z..]:Set [SPC]:clear")
12027 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12028 (cond
12029 ((or (= c ?\C-g)
12030 (and (= c ?q) (not (rassoc c fulltable))))
12031 (setq quit-flag t))
12032 ((= c ?\ ) nil)
12033 ((setq e (rassoc c fulltable) tg (car e))
12034 tg)
12035 (t (setq quit-flag t)))))))
12037 (defun org-entry-is-todo-p ()
12038 (member (org-get-todo-state) org-not-done-keywords))
12040 (defun org-entry-is-done-p ()
12041 (member (org-get-todo-state) org-done-keywords))
12043 (defun org-get-todo-state ()
12044 (save-excursion
12045 (org-back-to-heading t)
12046 (and (looking-at org-todo-line-regexp)
12047 (match-end 2)
12048 (match-string 2))))
12050 (defun org-at-date-range-p (&optional inactive-ok)
12051 "Is the cursor inside a date range?"
12052 (interactive)
12053 (save-excursion
12054 (catch 'exit
12055 (let ((pos (point)))
12057 (skip-chars-backward "<[")
12058 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12059 (>= (match-end 0) pos)
12060 (throw 'exit t))
12062 (skip-chars-backward "<[")
12063 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12064 (>= (match-end 0) pos)
12065 (throw 'exit t)))
12066 nil)))
12068 (defun org-get-repeat (&optional tagline)
12069 "Check if there is a deadline/schedule with repeater in this entry."
12070 (save-match-data
12071 (save-excursion
12072 (org-back-to-heading t)
12073 (and (re-search-forward (if tagline
12075 org-repeat-re)
12076 (org-entry-end-position) t)
12077 (match-string-no-properties 1)))))
12079 (defvar org-last-changed-timestamp)
12080 (defvar org-last-inserted-timestamp)
12081 (defvar org-log-post-message)
12082 (defvar org-log-note-purpose)
12083 (defvar org-log-note-how)
12084 (defvar org-log-note-extra)
12085 (defun org-auto-repeat-maybe (done-word)
12086 "Check if the current headline contains a repeated deadline/schedule.
12087 If yes, set TODO state back to what it was and change the base date
12088 of repeating deadline/scheduled time stamps to new date.
12089 This function is run automatically after each state change to a DONE state."
12090 ;; last-state is dynamically scoped into this function
12091 (let* ((repeat (org-get-repeat))
12092 (aa (assoc org-last-state org-todo-kwd-alist))
12093 (interpret (nth 1 aa))
12094 (head (nth 2 aa))
12095 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12096 (msg "Entry repeats: ")
12097 (org-log-done nil)
12098 (org-todo-log-states nil)
12099 re type n what ts time to-state)
12100 (when repeat
12101 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12102 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12103 org-todo-repeat-to-state))
12104 (unless (and to-state (member to-state org-todo-keywords-1))
12105 (setq to-state (if (eq interpret 'type) org-last-state head)))
12106 (org-todo to-state)
12107 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12108 (org-entry-put nil "LAST_REPEAT" (format-time-string
12109 (org-time-stamp-format t t))))
12110 (when org-log-repeat
12111 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12112 (memq 'org-add-log-note post-command-hook))
12113 ;; OK, we are already setup for some record
12114 (if (eq org-log-repeat 'note)
12115 ;; make sure we take a note, not only a time stamp
12116 (setq org-log-note-how 'note))
12117 ;; Set up for taking a record
12118 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12119 org-last-state
12120 'findpos org-log-repeat)))
12121 (org-back-to-heading t)
12122 (org-add-planning-info nil nil 'closed)
12126 (while (re-search-forward
12127 re (save-excursion (outline-next-heading) (point)) t)
12128 (setq type (if (match-end 1) org-scheduled-string
12129 (if (match-end 3) org-deadline-string "Plain:"))
12130 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12132 (setq n (string-to-number (match-string 2 ts))
12133 what (match-string 3 ts))
12134 (if (equal what "w") (setq n (* n 7) what "d"))
12136 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12137 ;; Preparation, see if we need to modify the start date for the change
12138 (when (match-end 1)
12139 (setq time (save-match-data (org-time-string-to-time ts)))
12140 (cond
12141 ((equal (match-string 1 ts) ".")
12142 ;; Shift starting date to today
12143 (org-timestamp-change
12144 (- (org-today) (time-to-days time))
12145 'day))
12146 ((equal (match-string 1 ts) "+")
12147 (let ((nshiftmax 10) (nshift 0))
12148 (while (or (= nshift 0)
12149 (<= (time-to-days time)
12150 (time-to-days (current-time))))
12151 (when (= (incf nshift) nshiftmax)
12152 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12153 (error "Abort")))
12154 (org-timestamp-change n (cdr (assoc what whata)))
12155 (org-at-timestamp-p t)
12156 (setq ts (match-string 1))
12157 (setq time (save-match-data (org-time-string-to-time ts)))))
12158 (org-timestamp-change (- n) (cdr (assoc what whata)))
12159 ;; rematch, so that we have everything in place for the real shift
12160 (org-at-timestamp-p t)
12161 (setq ts (match-string 1))
12163 (org-timestamp-change n (cdr (assoc what whata)))
12164 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12165 (setq org-log-post-message msg)
12166 (message "%s" msg))))
12168 (defun org-show-todo-tree (arg)
12169 "Make a compact tree which shows all headlines marked with TODO.
12170 The tree will show the lines where the regexp matches, and all higher
12171 headlines above the match.
12173 With a numeric prefix N, construct a sparse tree for the Nth element
12174 of `org-todo-keywords-1'."
12175 (interactive "P")
12176 (let ((case-fold-search nil)
12177 (kwd-re
12178 (cond ((null arg) org-not-done-regexp)
12179 ((equal arg '(4))
12180 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12181 (mapcar 'list org-todo-keywords-1))))
12185 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12186 (regexp-quote (nth (1- (prefix-numeric-value arg))
12187 org-todo-keywords-1)))
12188 (t (error "Invalid prefix argument: %s" arg)))))
12189 (message "%d TODO entries found"
12190 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12192 (defun org-deadline (&optional remove time)
12194 With argument REMOVE, remove any deadline from the item.
12195 With argument TIME, set the deadline at the corresponding date. TIME
12197 (interactive "P")
12198 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12199 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12200 'region-start-level 'region))
12201 org-loop-over-headlines-in-active-region)
12202 (org-map-entries
12203 `(org-deadline ',remove ,time)
12204 org-loop-over-headlines-in-active-region
12205 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12206 (let* ((old-date (org-entry-get nil "DEADLINE"))
12207 (repeater (and old-date
12208 (string-match
12210 old-date)
12211 (match-string 1 old-date))))
12212 (if remove
12213 (progn
12214 (when (and old-date org-log-redeadline)
12215 (org-add-log-setup 'deldeadline nil old-date 'findpos
12216 org-log-redeadline))
12217 (org-remove-timestamp-with-keyword org-deadline-string)
12218 (message "Item no longer has a deadline."))
12219 (org-add-planning-info 'deadline time 'closed)
12220 (when (and old-date org-log-redeadline
12221 (not (equal old-date
12222 (substring org-last-inserted-timestamp 1 -1))))
12223 (org-add-log-setup 'redeadline nil old-date 'findpos
12224 org-log-redeadline))
12225 (when repeater
12226 (save-excursion
12227 (org-back-to-heading t)
12228 (when (re-search-forward (concat org-deadline-string " "
12229 org-last-inserted-timestamp)
12230 (save-excursion
12231 (outline-next-heading) (point)) t)
12232 (goto-char (1- (match-end 0)))
12233 (insert " " repeater)
12234 (setq org-last-inserted-timestamp
12235 (concat (substring org-last-inserted-timestamp 0 -1)
12236 " " repeater
12237 (substring org-last-inserted-timestamp -1))))))
12238 (message "Deadline on %s" org-last-inserted-timestamp)))))
12240 (defun org-schedule (&optional remove time)
12241 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12242 With argument REMOVE, remove any scheduling date from the item.
12243 With argument TIME, scheduled at the corresponding date. TIME can
12245 (interactive "P")
12246 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12247 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12248 'region-start-level 'region))
12249 org-loop-over-headlines-in-active-region)
12250 (org-map-entries
12251 `(org-schedule ',remove ,time)
12252 org-loop-over-headlines-in-active-region
12253 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12254 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12255 (repeater (and old-date
12256 (string-match
12258 old-date)
12259 (match-string 1 old-date))))
12260 (if remove
12261 (progn
12262 (when (and old-date org-log-reschedule)
12263 (org-add-log-setup 'delschedule nil old-date 'findpos
12264 org-log-reschedule))
12265 (org-remove-timestamp-with-keyword org-scheduled-string)
12266 (message "Item is no longer scheduled."))
12267 (org-add-planning-info 'scheduled time 'closed)
12268 (when (and old-date org-log-reschedule
12269 (not (equal old-date
12270 (substring org-last-inserted-timestamp 1 -1))))
12271 (org-add-log-setup 'reschedule nil old-date 'findpos
12272 org-log-reschedule))
12273 (when repeater
12274 (save-excursion
12275 (org-back-to-heading t)
12276 (when (re-search-forward (concat org-scheduled-string " "
12277 org-last-inserted-timestamp)
12278 (save-excursion
12279 (outline-next-heading) (point)) t)
12280 (goto-char (1- (match-end 0)))
12281 (insert " " repeater)
12282 (setq org-last-inserted-timestamp
12283 (concat (substring org-last-inserted-timestamp 0 -1)
12284 " " repeater
12285 (substring org-last-inserted-timestamp -1))))))
12286 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12288 (defun org-get-scheduled-time (pom &optional inherit)
12289 "Get the scheduled time as a time tuple, of a format suitable
12290 for calling org-schedule with, or if there is no scheduling,
12291 returns nil."
12292 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12293 (when time
12294 (apply 'encode-time (org-parse-time-string time)))))
12296 (defun org-get-deadline-time (pom &optional inherit)
12297 "Get the deadline as a time tuple, of a format suitable for
12298 calling org-deadline with, or if there is no scheduling, returns
12299 nil."
12300 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12301 (when time
12302 (apply 'encode-time (org-parse-time-string time)))))
12304 (defun org-remove-timestamp-with-keyword (keyword)
12305 "Remove all time stamps with KEYWORD in the current entry."
12307 beg)
12308 (save-excursion
12309 (org-back-to-heading t)
12310 (setq beg (point))
12311 (outline-next-heading)
12312 (while (re-search-backward re beg t)
12313 (replace-match "")
12315 (equal (char-before) ?\ ))
12316 (backward-delete-char 1)
12318 (point-at-bol) (point-at-eol)))
12319 (delete-region (point-at-bol)
12320 (min (point-max) (1+ (point-at-eol))))))))))
12322 (defun org-add-planning-info (what &optional time &rest remove)
12323 "Insert new timestamp with keyword in the line directly after the headline.
12324 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12325 If non is given, the user is prompted for a date.
12326 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12327 be removed."
12328 (interactive)
12329 (let (org-time-was-given org-end-time-was-given ts
12330 end default-time default-input)
12332 (catch 'exit
12333 (when (and (memq what '(scheduled deadline))
12334 (or (not time)
12335 (and (stringp time)
12336 (string-match "^[-+]+[0-9]" time))))
12337 ;; Try to get a default date/time from existing timestamp
12338 (save-excursion
12339 (org-back-to-heading t)
12340 (setq end (save-excursion (outline-next-heading) (point)))
12341 (when (re-search-forward (if (eq what 'scheduled)
12342 org-scheduled-time-regexp
12343 org-deadline-time-regexp)
12344 end t)
12345 (setq ts (match-string 1)
12346 default-time
12347 (apply 'encode-time (org-parse-time-string ts))
12348 default-input (and ts (org-get-compact-tod ts))))))
12349 (when what
12350 (setq time
12351 (if (stringp time)
12352 ;; This is a string (relative or absolute), set proper date
12353 (apply 'encode-time
12354 (org-read-date-analyze
12355 time default-time (decode-time default-time)))
12356 ;; If necessary, get the time from the user
12357 (or time (org-read-date nil 'to-time nil nil
12358 default-time default-input)))))
12360 (when (and org-insert-labeled-timestamps-at-point
12361 (member what '(scheduled deadline)))
12362 (insert
12363 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12364 (org-insert-time-stamp time org-time-was-given
12365 nil nil nil (list org-end-time-was-given))
12366 (setq what nil))
12367 (save-excursion
12368 (save-restriction
12369 (let (col list elt ts buffer-invisibility-spec)
12370 (org-back-to-heading t)
12372 (goto-char (match-end 1))
12373 (setq col (current-column))
12374 (goto-char (match-end 0))
12376 (when (and (not what)
12377 (not (looking-at
12379 org-keyword-time-not-clock-regexp))))
12380 ;; Nothing to add, nothing to remove...... :-)
12381 (throw 'exit nil))
12382 (if (and (not (looking-at org-outline-regexp))
12385 (not (equal (match-string 1) org-clock-string)))
12386 (narrow-to-region (match-beginning 0) (match-end 0))
12388 (backward-char 1)
12389 (narrow-to-region (point) (point))
12390 (and org-adapt-indentation (org-indent-to-column col)))
12391 ;; Check if we have to remove something.
12392 (setq list (cons what remove))
12393 (while list
12394 (setq elt (pop list))
12395 (when (or (and (eq elt 'scheduled)
12396 (re-search-forward org-scheduled-time-regexp nil t))
12397 (and (eq elt 'deadline)
12398 (re-search-forward org-deadline-time-regexp nil t))
12399 (and (eq elt 'closed)
12400 (re-search-forward org-closed-time-regexp nil t)))
12401 (replace-match "")
12402 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12404 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12405 (when what
12406 (insert
12407 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12408 (cond ((eq what 'scheduled) org-scheduled-string)
12409 ((eq what 'deadline) org-deadline-string)
12410 ((eq what 'closed) org-closed-string))
12411 " ")
12412 (setq ts (org-insert-time-stamp
12413 time
12414 (or org-time-was-given
12415 (and (eq what 'closed) org-log-done-with-time))
12416 (eq what 'closed)
12417 nil nil (list org-end-time-was-given)))
12418 (insert
12419 (if (not (or (bolp) (eq (char-before) ?\ )
12420 (memq (char-after) '(32 10))
12421 (eobp))) " " ""))
12422 (end-of-line 1))
12423 (goto-char (point-min))
12424 (widen)
12427 (delete-region (1- (point)) (point-at-eol)))
12428 ts))))))
12430 (defvar org-log-note-marker (make-marker))
12431 (defvar org-log-note-purpose nil)
12432 (defvar org-log-note-state nil)
12433 (defvar org-log-note-previous-state nil)
12434 (defvar org-log-note-how nil)
12435 (defvar org-log-note-extra nil)
12436 (defvar org-log-note-window-configuration nil)
12437 (defvar org-log-note-return-to (make-marker))
12438 (defvar org-log-note-effective-time nil
12439 "Remembered current time so that dynamically scoped
12440 `org-extend-today-until' affects tha timestamps in state change
12441 log")
12443 (defvar org-log-post-message nil
12444 "Message to be displayed after a log note has been stored.
12445 The auto-repeater uses this.")
12447 (defun org-add-note ()
12448 "Add a note to the current entry.
12449 This is done in the same way as adding a state change note."
12450 (interactive)
12451 (org-add-log-setup 'note nil nil 'findpos nil))
12453 (defvar org-property-end-re)
12454 (defun org-add-log-setup (&optional purpose state prev-state
12455 findpos how extra)
12456 "Set up the post command hook to take a note.
12457 If this is about to TODO state change, the new state is expected in STATE.
12458 When FINDPOS is non-nil, find the correct position for the note in
12459 the current entry. If not, assume that it can be inserted at point.
12460 HOW is an indicator what kind of note should be created.
12461 EXTRA is additional text that will be inserted into the notes buffer."
12462 (let* ((org-log-into-drawer (org-log-into-drawer))
12463 (drawer (cond ((stringp org-log-into-drawer)
12464 org-log-into-drawer)
12465 (org-log-into-drawer "LOGBOOK"))))
12466 (save-restriction
12467 (save-excursion
12468 (when findpos
12469 (org-back-to-heading t)
12470 (narrow-to-region (point) (save-excursion
12471 (outline-next-heading) (point)))
12475 (goto-char (match-end 0))
12476 (cond
12477 (drawer
12479 nil t)
12480 (progn
12481 (goto-char (match-end 0))
12482 (or org-log-states-order-reversed
12483 (and (re-search-forward org-property-end-re nil t)
12484 (goto-char (1- (match-beginning 0))))))
12486 (beginning-of-line 0)
12487 (org-indent-line)
12488 (beginning-of-line 2)
12489 (org-indent-line)
12490 (end-of-line 0)))
12491 ((and org-log-state-notes-insert-after-drawers
12492 (save-excursion
12493 (forward-line) (looking-at org-drawer-regexp)))
12494 (forward-line)
12495 (while (looking-at org-drawer-regexp)
12496 (goto-char (match-end 0))
12497 (re-search-forward org-property-end-re (point-max) t)
12498 (forward-line))
12499 (forward-line -1)))
12500 (unless org-log-states-order-reversed
12502 (org-skip-over-state-notes)
12504 (move-marker org-log-note-marker (point))
12505 (setq org-log-note-purpose purpose
12506 org-log-note-state state
12507 org-log-note-previous-state prev-state
12508 org-log-note-how how
12509 org-log-note-extra extra
12510 org-log-note-effective-time (org-current-effective-time))
12511 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12513 (defun org-skip-over-state-notes ()
12514 "Skip past the list of State notes in an entry."
12516 (when (ignore-errors (goto-char (org-in-item-p)))
12517 (let* ((struct (org-list-struct))
12518 (prevs (org-list-prevs-alist struct)))
12520 (goto-char (or (org-list-get-next-item (point) struct prevs)
12521 (org-list-get-item-end (point) struct)))))))
12523 (defun org-add-log-note (&optional purpose)
12524 "Pop up a window for taking a note, and add this note later at point."
12525 (remove-hook 'post-command-hook 'org-add-log-note)
12526 (setq org-log-note-window-configuration (current-window-configuration))
12527 (delete-other-windows)
12528 (move-marker org-log-note-return-to (point))
12529 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12530 (goto-char org-log-note-marker)
12531 (org-switch-to-buffer-other-window "*Org Note*")
12532 (erase-buffer)
12533 (if (memq org-log-note-how '(time state))
12534 (let (current-prefix-arg) (org-store-log-note))
12535 (let ((org-inhibit-startup t)) (org-mode))
12536 (insert (format "# Insert note for %s.
12538 (cond
12539 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12540 ((eq org-log-note-purpose 'done) "closed todo item")
12541 ((eq org-log-note-purpose 'state)
12543 (or org-log-note-previous-state "")
12544 (or org-log-note-state "")))
12545 ((eq org-log-note-purpose 'reschedule)
12546 "rescheduling")
12547 ((eq org-log-note-purpose 'delschedule)
12548 "no longer scheduled")
12549 ((eq org-log-note-purpose 'redeadline)
12550 "changing deadline")
12551 ((eq org-log-note-purpose 'deldeadline)
12552 "removing deadline")
12553 ((eq org-log-note-purpose 'refile)
12554 "refiling")
12555 ((eq org-log-note-purpose 'note)
12556 "this entry")
12557 (t (error "This should not happen")))))
12558 (if org-log-note-extra (insert org-log-note-extra))
12559 (org-set-local 'org-finish-function 'org-store-log-note)
12560 (run-hooks 'org-log-buffer-setup-hook)))
12562 (defvar org-note-abort nil) ; dynamically scoped
12563 (defun org-store-log-note ()
12564 "Finish taking a log note, and insert it to where it belongs."
12565 (let ((txt (buffer-string))
12566 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12567 lines ind bul)
12568 (kill-buffer (current-buffer))
12570 (setq txt (replace-match "" t t txt)))
12572 (setq txt (replace-match "" t t txt)))
12575 (setq note
12576 (org-replace-escapes
12577 note
12578 (list (cons "%u" (user-login-name))
12579 (cons "%U" user-full-name)
12580 (cons "%t" (format-time-string
12581 (org-time-stamp-format 'long 'inactive)
12582 org-log-note-effective-time))
12583 (cons "%T" (format-time-string
12584 (org-time-stamp-format 'long nil)
12585 org-log-note-effective-time))
12586 (cons "%d" (format-time-string
12587 (org-time-stamp-format nil 'inactive)
12588 org-log-note-effective-time))
12589 (cons "%D" (format-time-string
12590 (org-time-stamp-format nil nil)
12591 org-log-note-effective-time))
12592 (cons "%s" (if org-log-note-state
12594 ""))
12595 (cons "%S" (if org-log-note-previous-state
12599 (push note lines))
12600 (when (or current-prefix-arg org-note-abort)
12601 (when org-log-into-drawer
12602 (org-remove-empty-drawer-at
12603 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12604 org-log-note-marker))
12605 (setq lines nil))
12606 (when lines
12607 (with-current-buffer (marker-buffer org-log-note-marker)
12608 (save-excursion
12609 (goto-char org-log-note-marker)
12610 (move-marker org-log-note-marker nil)
12611 (end-of-line 1)
12613 (setq ind (save-excursion
12614 (if (ignore-errors (goto-char (org-in-item-p)))
12615 (let ((struct (org-list-struct)))
12616 (org-list-get-ind
12617 (org-list-get-top-point struct) struct))
12619 (cond
12620 ((and (org-at-heading-p)
12621 org-adapt-indentation)
12622 (1+ (org-current-level)))
12623 ((org-at-heading-p) 0)
12624 (t (org-get-indentation))))))
12625 (setq bul (org-list-bullet-string "-"))
12626 (org-indent-line-to ind)
12627 (insert bul (pop lines))
12628 (let ((ind-body (+ (length bul) ind)))
12629 (while lines
12631 (org-indent-line-to ind-body)
12632 (insert (pop lines))))
12633 (message "Note stored")
12634 (org-back-to-heading t)
12635 (org-cycle-hide-drawers 'children)))))
12636 (set-window-configuration org-log-note-window-configuration)
12637 (with-current-buffer (marker-buffer org-log-note-return-to)
12638 (goto-char org-log-note-return-to))
12639 (move-marker org-log-note-return-to nil)
12640 (and org-log-post-message (message "%s" org-log-post-message)))
12642 (defun org-remove-empty-drawer-at (drawer pos)
12643 "Remove an empty drawer DRAWER at position POS.
12644 POS may also be a marker."
12645 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12646 (save-excursion
12647 (save-restriction
12648 (widen)
12649 (goto-char pos)
12650 (if (org-in-regexp
12652 (replace-match ""))))))
12654 (defvar org-ts-type nil)
12655 (defun org-sparse-tree (&optional arg type)
12656 "Create a sparse tree, prompt for the details.
12657 This command can create sparse trees. You first need to select the type
12658 of match used to create the tree:
12660 t Show all TODO entries.
12661 T Show entries with a specific TODO keyword.
12662 m Show entries selected by a tags/property match.
12663 p Enter a property name and its value (both with completion on existing
12664 names/values) and show entries with that property.
12665 r Show entries matching a regular expression (`/' can be used as well).
12666 b Show deadlines and scheduled items before a date.
12667 a Show deadlines and scheduled items after a date.
12668 d Show deadlines due within `org-deadline-warning-days'.
12669 D Show deadlines and scheduled items between a date range."
12670 (interactive "P")
12671 (let (ans kwd value ts-type)
12672 (setq type (or type org-sparse-tree-default-date-type))
12673 (setq org-ts-type type)
12674 (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"
12675 (cond ((eq type 'all) "all timestamps")
12676 ((eq type 'scheduled) "only scheduled")
12677 ((eq type 'deadline) "only deadline")
12678 ((eq type 'active) "only active timestamps")
12679 ((eq type 'inactive) "only inactive timestamps")
12680 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
12681 (t "scheduled/deadline")))
12682 (setq ans (read-char-exclusive))
12683 (cond
12684 ((equal ans ?c)
12685 (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
12686 ((equal ans ?d)
12687 (call-interactively 'org-check-deadlines))
12688 ((equal ans ?b)
12689 (call-interactively 'org-check-before-date))
12690 ((equal ans ?a)
12691 (call-interactively 'org-check-after-date))
12692 ((equal ans ?D)
12693 (call-interactively 'org-check-dates-range))
12694 ((equal ans ?t)
12695 (call-interactively 'org-show-todo-tree))
12696 ((equal ans ?T)
12697 (org-show-todo-tree '(4)))
12698 ((member ans '(?T ?m))
12699 (call-interactively 'org-match-sparse-tree))
12700 ((member ans '(?p ?P))
12701 (setq kwd (org-icompleting-read "Property: "
12702 (mapcar 'list (org-buffer-property-keys))))
12703 (setq value (org-icompleting-read "Value: "
12704 (mapcar 'list (org-property-values kwd))))
12707 (org-match-sparse-tree arg (concat kwd "=" value)))
12708 ((member ans '(?r ?R ?/))
12709 (call-interactively 'org-occur))
12712 (defvar org-occur-highlights nil
12713 "List of overlays used for occur matches.")
12714 (make-variable-buffer-local 'org-occur-highlights)
12715 (defvar org-occur-parameters nil
12716 "Parameters of the active org-occur calls.
12717 This is a list, each call to org-occur pushes as cons cell,
12718 containing the regular expression and the callback, onto the list.
12719 The list can contain several entries if `org-occur' has been called
12720 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12721 will only contain one set of parameters. When the highlights are
12722 removed (for example with `C-c C-c', or with the next edit (depending
12723 on `org-remove-highlights-with-change'), this variable is emptied
12724 as well.")
12725 (make-variable-buffer-local 'org-occur-parameters)
12727 (defun org-occur (regexp &optional keep-previous callback)
12728 "Make a compact tree which shows all matches of REGEXP.
12729 The tree will show the lines where the regexp matches, and all higher
12730 headlines above the match. It will also show the heading after the match,
12731 to make sure editing the matching entry is easy.
12732 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12733 call to `org-occur' will be kept, to allow stacking of calls to this
12734 command.
12735 If CALLBACK is non-nil, it is a function which is called to confirm
12736 that the match should indeed be shown."
12738 (when (equal regexp "")
12739 (error "Regexp cannot be empty"))
12740 (unless keep-previous
12741 (org-remove-occur-highlights nil nil t))
12742 (push (cons regexp callback) org-occur-parameters)
12743 (let ((cnt 0))
12744 (save-excursion
12745 (goto-char (point-min))
12746 (if (or (not keep-previous) ; do not want to keep
12747 (not org-occur-highlights)) ; no previous matches
12748 ;; hide everything
12749 (org-overview))
12750 (while (re-search-forward regexp nil t)
12751 (when (or (not callback)
12752 (save-match-data (funcall callback)))
12753 (setq cnt (1+ cnt))
12754 (when org-highlight-sparse-tree-matches
12755 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12756 (org-show-context 'occur-tree))))
12757 (when org-remove-highlights-with-change
12758 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12759 nil 'local))
12760 (unless org-sparse-tree-open-archived-trees
12761 (org-hide-archived-subtrees (point-min) (point-max)))
12762 (run-hooks 'org-occur-hook)
12763 (if (org-called-interactively-p 'interactive)
12764 (message "%d match(es) for regexp %s" cnt regexp))
12765 cnt))
12767 (defun org-occur-next-match (&optional n reset)
12768 "Function for `next-error-function' to find sparse tree matches.
12769 N is the number of matches to move, when negative move backwards.
12770 RESET is entirely ignored - this function always goes back to the
12771 starting point when no match is found."
12772 (let* ((limit (if (< n 0) (point-min) (point-max)))
12773 (search-func (if (< n 0)
12774 'previous-single-char-property-change
12775 'next-single-char-property-change))
12776 (n (abs n))
12777 (pos (point))
12778 p1)
12779 (catch 'exit
12780 (while (setq p1 (funcall search-func (point) 'org-type))
12781 (when (equal p1 limit)
12782 (goto-char pos)
12783 (error "No more matches"))
12784 (when (equal (get-char-property p1 'org-type) 'org-occur)
12785 (setq n (1- n))
12786 (when (= n 0)
12787 (goto-char p1)
12788 (throw 'exit (point))))
12789 (goto-char p1))
12790 (goto-char p1)
12791 (error "No more matches"))))
12793 (defun org-show-context (&optional key)
12794 "Make sure point and context are visible.
12795 How much context is shown depends upon the variables
12796 `org-show-hierarchy-above', `org-show-following-heading',
12797 `org-show-entry-below' and `org-show-siblings'."
12798 (let ((heading-p (org-at-heading-p t))
12799 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12800 (following-p (org-get-alist-option org-show-following-heading key))
12801 (entry-p (org-get-alist-option org-show-entry-below key))
12802 (siblings-p (org-get-alist-option org-show-siblings key)))
12803 (catch 'exit
12804 ;; Show heading or entry text
12805 (if (and heading-p (not entry-p))
12806 (org-flag-heading nil) ; only show the heading
12807 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12808 (org-show-hidden-entry))) ; show entire entry
12809 (when following-p
12810 ;; Show next sibling, or heading below text
12811 (save-excursion
12812 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12813 (org-flag-heading nil))))
12814 (when siblings-p (org-show-siblings))
12815 (when hierarchy-p
12816 ;; show all higher headings, possibly with siblings
12817 (save-excursion
12818 (while (and (condition-case nil
12819 (progn (org-up-heading-all 1) t)
12820 (error nil))
12821 (not (bobp)))
12822 (org-flag-heading nil)
12823 (when siblings-p (org-show-siblings))))))))
12825 (defvar org-reveal-start-hook nil
12826 "Hook run before revealing a location.")
12828 (defun org-reveal (&optional siblings)
12829 "Show current entry, hierarchy above it, and the following headline.
12830 This can be used to show a consistent set of context around locations
12831 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12832 not t for the search context.
12834 With optional argument SIBLINGS, on each level of the hierarchy all
12835 siblings are shown. This repairs the tree structure to what it would
12836 look like when opened with hierarchical calls to `org-cycle'.
12838 go to the parent and show the
12839 entire tree."
12840 (interactive "P")
12841 (run-hooks 'org-reveal-start-hook)
12842 (let ((org-show-hierarchy-above t)
12843 (org-show-following-heading t)
12844 (org-show-siblings (if siblings t org-show-siblings)))
12845 (org-show-context nil))
12846 (when (equal siblings '(16))
12847 (save-excursion
12848 (when (org-up-heading-safe)
12849 (org-show-subtree)
12850 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12852 (defun org-highlight-new-match (beg end)
12853 "Highlight from BEG to END and mark the highlight is an occur headline."
12854 (let ((ov (make-overlay beg end)))
12855 (overlay-put ov 'face 'secondary-selection)
12856 (overlay-put ov 'org-type 'org-occur)
12857 (push ov org-occur-highlights)))
12859 (defun org-remove-occur-highlights (&optional beg end noremove)
12860 "Remove the occur highlights from the buffer.
12861 BEG and END are ignored. If NOREMOVE is nil, remove this function
12862 from the `before-change-functions' in the current buffer."
12863 (interactive)
12864 (unless org-inhibit-highlight-removal
12865 (mapc 'delete-overlay org-occur-highlights)
12866 (setq org-occur-highlights nil)
12867 (setq org-occur-parameters nil)
12868 (unless noremove
12869 (remove-hook 'before-change-functions
12870 'org-remove-occur-highlights 'local))))
12872 ;;;; Priorities
12875 "Regular expression matching the priority indicator.")
12877 (defvar org-remove-priority-next-time nil)
12879 (defun org-priority-up ()
12880 "Increase the priority of the current item."
12881 (interactive)
12882 (org-priority 'up))
12884 (defun org-priority-down ()
12885 "Decrease the priority of the current item."
12886 (interactive)
12887 (org-priority 'down))
12889 (defun org-priority (&optional action show)
12890 "Change the priority of an item.
12891 ACTION can be `set', `up', `down', or a character."
12892 (interactive "P")
12893 (if (equal action '(4))
12894 (org-show-priority)
12895 (unless org-enable-priority-commands
12896 (error "Priority commands are disabled"))
12897 (setq action (or action 'set))
12898 (let (current new news have remove)
12899 (save-excursion
12900 (org-back-to-heading t)
12901 (if (looking-at org-priority-regexp)
12902 (setq current (string-to-char (match-string 2))
12903 have t))
12904 (cond
12905 ((eq action 'remove)
12906 (setq remove t new ?\ ))
12907 ((or (eq action 'set)
12908 (if (featurep 'xemacs) (characterp action) (integerp action)))
12909 (if (not (eq action 'set))
12910 (setq new action)
12911 (message "Priority %c-%c, SPC to remove: "
12912 org-highest-priority org-lowest-priority)
12913 (save-match-data
12914 (setq new (read-char-exclusive))))
12915 (if (and (= (upcase org-highest-priority) org-highest-priority)
12916 (= (upcase org-lowest-priority) org-lowest-priority))
12917 (setq new (upcase new)))
12918 (cond ((equal new ?\ ) (setq remove t))
12919 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12920 (error "Priority must be between `%c' and `%c'"
12921 org-highest-priority org-lowest-priority))))
12922 ((eq action 'up)
12923 (setq new (if have
12924 (1- current) ; normal cycling
12925 ;; last priority was empty
12926 (if (eq last-command this-command)
12927 org-lowest-priority ; wrap around empty to lowest
12928 ;; default
12929 (if org-priority-start-cycle-with-default
12930 org-default-priority
12931 (1- org-default-priority))))))
12932 ((eq action 'down)
12933 (setq new (if have
12934 (1+ current) ; normal cycling
12935 ;; last priority was empty
12936 (if (eq last-command this-command)
12937 org-highest-priority ; wrap around empty to highest
12938 ;; default
12939 (if org-priority-start-cycle-with-default
12940 org-default-priority
12941 (1+ org-default-priority))))))
12942 (t (error "Invalid action")))
12943 (if (or (< (upcase new) org-highest-priority)
12944 (> (upcase new) org-lowest-priority))
12945 (if (and (memq action '(up down))
12946 (not have) (not (eq last-command this-command)))
12947 ;; `new' is from default priority
12948 (error
12949 "The default can not be set, see `org-default-priority' why")
12950 ;; normal cycling: `new' is beyond highest/lowest priority
12951 ;; and is wrapped around to the empty priority
12952 (setq remove t)))
12953 (setq news (format "%c" new))
12954 (if have
12955 (if remove
12956 (replace-match "" t t nil 1)
12957 (replace-match news t t nil 2))
12958 (if remove
12959 (error "No priority cookie found in line")
12960 (let ((case-fold-search nil))
12961 (looking-at org-todo-line-regexp))
12962 (if (match-end 2)
12963 (progn
12964 (goto-char (match-end 2))
12965 (insert " [#" news "]"))
12966 (goto-char (match-beginning 3))
12967 (insert "[#" news "] "))))
12968 (org-preserve-lc (org-set-tags nil 'align)))
12969 (if remove
12970 (message "Priority removed")
12971 (message "Priority of current item set to %s" news)))))
12973 (defun org-show-priority ()
12974 "Show the priority of the current item.
12975 This priority is composed of the main priority given with the [#A] cookies,
12976 and by additional input from the age of a schedules or deadline entry."
12977 (interactive)
12978 (let ((pri (if (eq major-mode 'org-agenda-mode)
12979 (org-get-at-bol 'priority)
12980 (save-excursion
12981 (save-match-data
12982 (beginning-of-line)
12983 (and (looking-at org-heading-regexp)
12984 (org-get-priority (match-string 0))))))))
12985 (message "Priority is %d" (if pri pri -1000))))
12987 (defun org-get-priority (s)
12988 "Find priority cookie and return priority."
12989 (if (functionp org-get-priority-function)
12990 (funcall org-get-priority-function)
12991 (save-match-data
12992 (if (not (string-match org-priority-regexp s))
12993 (* 1000 (- org-lowest-priority org-default-priority))
12994 (* 1000 (- org-lowest-priority
12995 (string-to-char (match-string 2 s))))))))
12997 ;;;; Tags
12999 (defvar org-agenda-archives-mode)
13000 (defvar org-map-continue-from nil
13001 "Position from where mapping should continue.
13002 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13004 (defvar org-scanner-tags nil
13005 "The current tag list while the tags scanner is running.")
13006 (defvar org-trust-scanner-tags nil
13007 "Should `org-get-tags-at' use the tags for the scanner.
13008 This is for internal dynamical scoping only.
13009 When this is non-nil, the function `org-get-tags-at' will return the value
13010 of `org-scanner-tags' instead of building the list by itself. This
13011 can lead to large speed-ups when the tags scanner is used in a file with
13012 many entries, and when the list of tags is retrieved, for example to
13013 obtain a list of properties. Building the tags list for each entry in such
13014 a file becomes an N^2 operation - but with this variable set, it scales
13015 as N.")
13017 (defun org-scan-tags (action matcher todo-only &optional start-level)
13018 "Scan headline tags with inheritance and produce output ACTION.
13020 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13021 or `agenda' to produce an entry list for an agenda view. It can also be
13022 a Lisp form or a function that should be called at each matched headline, in
13023 this case the return value is a list of all return values from these calls.
13025 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13026 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13027 only lines with a not-done TODO keyword are included in the output.
13028 This should be the same variable that was scoped into
13029 and set by `org-make-tags-matcher' when it constructed MATCHER.
13031 START-LEVEL can be a string with asterisks, reducing the scope to
13032 headlines matching this string."
13033 (require 'org-agenda)
13034 (let* ((re (concat "^"
13035 (if start-level
13036 ;; Get the correct level to match
13038 org-outline-regexp)
13042 (props (list 'face 'default
13043 'done-face 'org-agenda-done
13044 'undone-face 'default
13045 'mouse-face 'highlight
13046 'org-not-done-regexp org-not-done-regexp
13047 'org-todo-regexp org-todo-regexp
13048 'org-complex-heading-regexp org-complex-heading-regexp
13049 'help-echo
13050 (format "mouse-2 or RET jump to org file %s"
13051 (abbreviate-file-name
13052 (or (buffer-file-name (buffer-base-buffer))
13053 (buffer-name (buffer-base-buffer)))))))
13054 (case-fold-search nil)
13055 (org-map-continue-from nil)
13056 lspos tags tags-list
13057 (tags-alist (list (cons 0 org-file-tags)))
13058 (llast 0) rtn rtn1 level category i txt
13059 todo marker entry priority)
13060 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13061 (setq action (list 'lambda nil action)))
13062 (save-excursion
13063 (goto-char (point-min))
13064 (when (eq action 'sparse-tree)
13065 (org-overview)
13066 (org-remove-occur-highlights))
13067 (while (re-search-forward re nil t)
13068 (setq org-map-continue-from nil)
13069 (catch :skip
13070 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13071 tags (if (match-end 4) (org-match-string-no-properties 4)))
13072 (goto-char (setq lspos (match-beginning 0)))
13073 (setq level (org-reduced-level (funcall outline-level))
13074 category (org-get-category))
13075 (setq i llast llast level)
13076 ;; remove tag lists from same and sublevels
13077 (while (>= i level)
13078 (when (setq entry (assoc i tags-alist))
13079 (setq tags-alist (delete entry tags-alist)))
13080 (setq i (1- i)))
13081 ;; add the next tags
13082 (when tags
13083 (setq tags (org-split-string tags ":")
13084 tags-alist
13085 (cons (cons level tags) tags-alist)))
13086 ;; compile tags for current headline
13087 (setq tags-list
13088 (if org-use-tag-inheritance
13089 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13090 tags)
13091 org-scanner-tags tags-list)
13092 (when org-use-tag-inheritance
13093 (setcdr (car tags-alist)
13094 (mapcar (lambda (x)
13095 (setq x (copy-sequence x))
13096 (org-add-prop-inherited x))
13097 (cdar tags-alist))))
13098 (when (and tags org-use-tag-inheritance
13099 (or (not (eq t org-use-tag-inheritance))
13100 org-tags-exclude-from-inheritance))
13101 ;; selective inheritance, remove uninherited ones
13102 (setcdr (car tags-alist)
13103 (org-remove-uninherited-tags (cdar tags-alist))))
13104 (when (and
13106 ;; eval matcher only when the todo condition is OK
13107 (and (or (not todo-only) (member todo org-not-done-keywords))
13108 (let ((case-fold-search t) (org-trust-scanner-tags t))
13109 (eval matcher)))
13111 ;; Call the skipper, but return t if it does not skip,
13112 ;; so that the `and' form continues evaluating
13113 (progn
13114 (unless (eq action 'sparse-tree) (org-agenda-skip))
13115 t)
13117 ;; Check if timestamps are deselecting this entry
13118 (or (not todo-only)
13119 (and (member todo org-not-done-keywords)
13120 (or (not org-agenda-tags-todo-honor-ignore-options)
13121 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
13123 ;; Extra check for the archive tag
13124 ;; FIXME: Does the skipper already do this????
13125 (or
13126 (not (member org-archive-tag tags-list))
13127 ;; we have an archive tag, should we use this anyway?
13128 (or (not org-agenda-skip-archived-trees)
13129 (and (eq action 'agenda) org-agenda-archives-mode))))
13131 ;; select this headline
13133 (cond
13134 ((eq action 'sparse-tree)
13135 (and org-highlight-sparse-tree-matches
13136 (org-get-heading) (match-end 0)
13137 (org-highlight-new-match
13138 (match-beginning 1) (match-end 1)))
13139 (org-show-context 'tags-tree))
13140 ((eq action 'agenda)
13141 (setq txt (org-agenda-format-item
13142 ""
13143 (concat
13144 (if (eq org-tags-match-list-sublevels 'indented)
13145 (make-string (1- level) ?.) "")
13146 (org-get-heading))
13147 category
13148 tags-list)
13149 priority (org-get-priority txt))
13150 (goto-char lspos)
13151 (setq marker (org-agenda-new-marker))
13152 (org-add-props txt props
13153 'org-marker marker 'org-hd-marker marker 'org-category category
13154 'todo-state todo
13155 'priority priority 'type "tagsmatch")
13156 (push txt rtn))
13157 ((functionp action)
13158 (setq org-map-continue-from nil)
13159 (save-excursion
13160 (setq rtn1 (funcall action))
13161 (push rtn1 rtn)))
13162 (t (error "Invalid action")))
13164 ;; if we are to skip sublevels, jump to end of subtree
13165 (unless org-tags-match-list-sublevels
13166 (org-end-of-subtree t)
13167 (backward-char 1))))
13168 ;; Get the correct position from where to continue
13169 (if org-map-continue-from
13170 (goto-char org-map-continue-from)
13171 (and (= (point) lspos) (end-of-line 1)))))
13172 (when (and (eq action 'sparse-tree)
13173 (not org-sparse-tree-open-archived-trees))
13174 (org-hide-archived-subtrees (point-min) (point-max)))
13175 (nreverse rtn)))
13177 (defun org-remove-uninherited-tags (tags)
13178 "Remove all tags that are not inherited from the list TAGS."
13179 (cond
13180 ((eq org-use-tag-inheritance t)
13181 (if org-tags-exclude-from-inheritance
13182 (org-delete-all org-tags-exclude-from-inheritance tags)
13183 tags))
13184 ((not org-use-tag-inheritance) nil)
13185 ((stringp org-use-tag-inheritance)
13186 (delq nil (mapcar
13187 (lambda (x)
13188 (if (and (string-match org-use-tag-inheritance x)
13189 (not (member x org-tags-exclude-from-inheritance)))
13190 x nil))
13191 tags)))
13192 ((listp org-use-tag-inheritance)
13193 (delq nil (mapcar
13194 (lambda (x)
13195 (if (member x org-use-tag-inheritance) x nil))
13196 tags)))))
13198 (defun org-match-sparse-tree (&optional todo-only match)
13199 "Create a sparse tree according to tags string MATCH.
13200 MATCH can contain positive and negative selection of tags, like
13202 If optional argument TODO-ONLY is non-nil, only select lines that are
13203 also TODO lines."
13204 (interactive "P")
13205 (org-agenda-prepare-buffers (list (current-buffer)))
13206 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13208 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13210 (defvar org-cached-props nil)
13211 (defun org-cached-entry-get (pom property)
13212 (if (or (eq t org-use-property-inheritance)
13213 (and (stringp org-use-property-inheritance)
13214 (string-match org-use-property-inheritance property))
13215 (and (listp org-use-property-inheritance)
13216 (member property org-use-property-inheritance)))
13217 ;; Caching is not possible, check it directly
13218 (org-entry-get pom property 'inherit)
13219 ;; Get all properties, so that we can do complicated checks easily
13220 (cdr (assoc property (or org-cached-props
13221 (setq org-cached-props
13222 (org-entry-properties pom)))))))
13224 (defun org-global-tags-completion-table (&optional files)
13225 "Return the list of all tags in all agenda buffer/files.
13226 Optional FILES argument is a list of files which can be used
13227 instead of the agenda files."
13228 (save-excursion
13229 (org-uniquify
13230 (delq nil
13231 (apply 'append
13232 (mapcar
13233 (lambda (file)
13234 (set-buffer (find-file-noselect file))
13235 (append (org-get-buffer-tags)
13236 (mapcar (lambda (x) (if (stringp (car-safe x))
13237 (list (car-safe x)) nil))
13238 org-tag-alist)))
13239 (if (and files (car files))
13240 files
13241 (org-agenda-files))))))))
13243 (defun org-make-tags-matcher (match)
13244 "Create the TAGS/TODO matcher form for the selection string MATCH.
13246 The variable `todo-only' is scoped dynamically into this function.
13247 It will be set to t if the matcher restricts matching to TODO entries,
13248 otherwise will not be touched.
13250 Returns a cons of the selection string MATCH and the constructed
13251 lisp form implementing the matcher. The matcher is to be evaluated
13252 at an Org entry, with point on the headline, and returns t if the
13253 entry matches the selection string MATCH. The returned lisp form
13254 references two variables with information about the entry, which
13255 must be bound around the form's evaluation: todo, the TODO keyword
13256 at the entry (or nil of none); and tags-list, the list of all tags
13257 at the entry including inherited ones. Additionally, the category
13258 of the entry (if any) must be specified as the text property
13259 'org-category on the headline.
13261 See also `org-scan-tags'.
13262 "
13263 (declare (special todo-only))
13264 (unless (boundp 'todo-only)
13265 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13266 (unless match
13267 ;; Get a new match request, with completion
13268 (let ((org-last-tags-completion-table
13269 (org-global-tags-completion-table)))
13270 (setq match (org-completing-read-no-i
13271 "Match: " 'org-tags-completion-function nil nil nil
13272 'org-tags-history))))
13274 ;; Parse the string and create a lisp form
13275 (let ((match0 match)
13276 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13277 minus tag mm
13278 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13279 orterms term orlist re-p str-p level-p level-op time-p
13280 prop-p pn pv po gv rest)
13281 (if (string-match "/+" match)
13282 ;; match contains also a todo-matching request
13283 (progn
13284 (setq tagsmatch (substring match 0 (match-beginning 0))
13285 todomatch (substring match (match-end 0)))
13286 (if (string-match "^!" todomatch)
13287 (setq todo-only t todomatch (substring todomatch 1)))
13289 (setq todomatch nil)))
13290 ;; only matching tags
13291 (setq tagsmatch match todomatch nil))
13293 ;; Make the tags matcher
13295 (setq tagsmatcher t)
13296 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13297 (while (setq term (pop orterms))
13299 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13300 (while (string-match re term)
13301 (setq rest (substring term (match-end 0))
13302 minus (and (match-end 1)
13303 (equal (match-string 1 term) "-"))
13304 tag (save-match-data (replace-regexp-in-string
13306 (match-string 2 term)))
13307 re-p (equal (string-to-char tag) ?{)
13308 level-p (match-end 4)
13309 prop-p (match-end 5)
13310 mm (cond
13311 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13312 (level-p
13313 (setq level-op (org-op-to-function (match-string 3 term)))
13314 `(,level-op level ,(string-to-number
13315 (match-string 4 term))))
13316 (prop-p
13317 (setq pn (match-string 5 term)
13318 po (match-string 6 term)
13319 pv (match-string 7 term)
13320 re-p (equal (string-to-char pv) ?{)
13322 time-p (save-match-data
13324 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13325 (if time-p (setq pv (org-matcher-time pv)))
13326 (setq po (org-op-to-function po (if time-p 'time str-p)))
13327 (cond
13328 ((equal pn "CATEGORY")
13329 (setq gv '(get-text-property (point) 'org-category)))
13330 ((equal pn "TODO")
13331 (setq gv 'todo))
13332 (t
13333 (setq gv `(org-cached-entry-get nil ,pn))))
13334 (if re-p
13335 (if (eq po 'org<>)
13336 `(not (string-match ,pv (or ,gv "")))
13337 `(string-match ,pv (or ,gv "")))
13338 (if str-p
13339 `(,po (or ,gv "") ,pv)
13340 `(,po (string-to-number (or ,gv ""))
13341 ,(string-to-number pv) ))))
13342 (t `(member ,tag tags-list)))
13343 mm (if minus (list 'not mm) mm)
13344 term rest)
13345 (push mm tagsmatcher))
13346 (push (if (> (length tagsmatcher) 1)
13347 (cons 'and tagsmatcher)
13348 (car tagsmatcher))
13349 orlist)
13350 (setq tagsmatcher nil))
13351 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13352 (setq tagsmatcher
13353 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13354 ;; Make the todo matcher
13356 (setq todomatcher t)
13357 (setq orterms (org-split-string todomatch "|") orlist nil)
13358 (while (setq term (pop orterms))
13359 (while (string-match re term)
13360 (setq minus (and (match-end 1)
13361 (equal (match-string 1 term) "-"))
13362 kwd (match-string 2 term)
13363 re-p (equal (string-to-char kwd) ?{)
13364 term (substring term (match-end 0))
13365 mm (if re-p
13366 `(string-match ,(substring kwd 1 -1) todo)
13367 (list 'equal 'todo kwd))
13368 mm (if minus (list 'not mm) mm))
13369 (push mm todomatcher))
13370 (push (if (> (length todomatcher) 1)
13371 (cons 'and todomatcher)
13372 (car todomatcher))
13373 orlist)
13374 (setq todomatcher nil))
13375 (setq todomatcher (if (> (length orlist) 1)
13376 (cons 'or orlist) (car orlist))))
13378 ;; Return the string and lisp forms of the matcher
13379 (setq matcher (if todomatcher
13380 (list 'and tagsmatcher todomatcher)
13381 tagsmatcher))
13382 (when todo-only
13383 (setq matcher (list 'and '(member todo org-not-done-keywords)
13384 matcher)))
13385 (cons match0 matcher)))
13387 (defun org-op-to-function (op &optional stringp)
13388 "Turn an operator into the appropriate function."
13389 (setq op
13390 (cond
13391 ((equal op "<" ) '(< string< org-time<))
13392 ((equal op ">" ) '(> org-string> org-time>))
13393 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13394 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13395 ((member op '("=" "==")) '(= string= org-time=))
13396 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13397 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13399 (defun org<> (a b) (not (= a b)))
13400 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13401 (defun org-string>= (a b) (not (string< a b)))
13402 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13403 (defun org-string<> (a b) (not (string= 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) (<= a b)))
13407 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13408 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13409 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13410 (defun org-2ft (s)
13411 "Convert S to a floating point time.
13412 If S is already a number, just return it. If it is a string, parse
13413 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13414 (cond
13415 ((numberp s) s)
13416 ((stringp s)
13417 (condition-case nil
13418 (float-time (apply 'encode-time (org-parse-time-string s)))
13419 (error 0.)))
13420 (t 0.)))
13422 (defun org-time-today ()
13423 "Time in seconds today at 0:00.
13424 Returns the float number of seconds since the beginning of the
13425 epoch to the beginning of today (00:00)."
13426 (float-time (apply 'encode-time
13427 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13429 (defun org-matcher-time (s)
13430 "Interpret a time comparison value."
13431 (save-match-data
13432 (cond
13433 ((string= s "<now>") (float-time))
13434 ((string= s "<today>") (org-time-today))
13435 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13436 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13438 (+ (org-time-today)
13439 (* (string-to-number (match-string 1 s))
13440 (cdr (assoc (match-string 2 s)
13441 '(("d" . 86400.0) ("w" . 604800.0)
13442 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13443 (t (org-2ft s)))))
13445 (defun org-match-any-p (re list)
13446 "Does re match any element of list?"
13447 (setq list (mapcar (lambda (x) (string-match re x)) list))
13448 (delq nil list))
13450 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13451 (defvar org-tags-overlay (make-overlay 1 1))
13452 (org-detach-overlay org-tags-overlay)
13454 (defun org-get-local-tags-at (&optional pos)
13455 "Get a list of tags defined in the current headline."
13456 (org-get-tags-at pos 'local))
13458 (defun org-get-local-tags ()
13459 "Get a list of tags defined in the current headline."
13460 (org-get-tags-at nil 'local))
13462 (defun org-get-tags-at (&optional pos local)
13463 "Get a list of all headline tags applicable at POS.
13464 POS defaults to point. If tags are inherited, the list contains
13465 the targets in the same sequence as the headlines appear, i.e.
13466 the tags of the current headline come last.
13467 When LOCAL is non-nil, only return tags from the current headline,
13468 ignore inherited ones."
13469 (interactive)
13470 (if (and org-trust-scanner-tags
13471 (or (not pos) (equal pos (point)))
13472 (not local))
13473 org-scanner-tags
13474 (let (tags ltags lastpos parent)
13475 (save-excursion
13476 (save-restriction
13477 (widen)
13478 (goto-char (or pos (point)))
13479 (save-match-data
13480 (catch 'done
13481 (condition-case nil
13482 (progn
13483 (org-back-to-heading t)
13484 (while (not (equal lastpos (point)))
13485 (setq lastpos (point))
13486 (when (looking-at
13488 (setq ltags (org-split-string
13489 (org-match-string-no-properties 1) ":"))
13490 (when parent
13491 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13492 (setq tags (append
13493 (if parent
13494 (org-remove-uninherited-tags ltags)
13495 ltags)
13496 tags)))
13497 (or org-use-tag-inheritance (throw 'done t))
13498 (if local (throw 'done t))
13499 (or (org-up-heading-safe) (error nil))
13500 (setq parent t)))
13501 (error nil)))))
13502 (if local
13503 tags
13504 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13506 (defun org-add-prop-inherited (s)
13507 (add-text-properties 0 (length s) '(inherited t) s)
13508 s)
13510 (defun org-toggle-tag (tag &optional onoff)
13511 "Toggle the tag TAG for the current line.
13512 If ONOFF is `on' or `off', don't toggle but set to this state."
13513 (let (res current)
13514 (save-excursion
13515 (org-back-to-heading t)
13517 (point-at-eol) t)
13518 (progn
13519 (setq current (match-string 1))
13520 (replace-match ""))
13521 (setq current ""))
13522 (setq current (nreverse (org-split-string current ":")))
13523 (cond
13524 ((eq onoff 'on)
13525 (setq res t)
13526 (or (member tag current) (push tag current)))
13527 ((eq onoff 'off)
13528 (or (not (member tag current)) (setq current (delete tag current))))
13529 (t (if (member tag current)
13530 (setq current (delete tag current))
13531 (setq res t)
13532 (push tag current))))
13533 (end-of-line 1)
13534 (if current
13535 (progn
13536 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13537 (org-set-tags nil t))
13538 (delete-horizontal-space))
13539 (run-hooks 'org-after-tags-change-hook))
13540 res))
13542 (defun org-align-tags-here (to-col)
13543 ;; Assumes that this is a headline
13544 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13545 (beginning-of-line 1)
13547 (< pos (match-beginning 2)))
13548 (progn
13549 (setq tags-l (- (match-end 2) (match-beginning 2)))
13550 (goto-char (match-beginning 1))
13551 (insert " ")
13552 (delete-region (point) (1+ (match-beginning 2)))
13553 (setq ncol (max (current-column)
13554 (1+ col)
13555 (if (> to-col 0)
13556 to-col
13557 (- (abs to-col) tags-l))))
13558 (setq p (point))
13559 (insert (make-string (- ncol (current-column)) ?\ ))
13560 (setq ncol (current-column))
13561 (when indent-tabs-mode (tabify p (point-at-eol)))
13562 (org-move-to-column (min ncol col) t))
13563 (goto-char pos))))
13565 (defun org-set-tags-command (&optional arg just-align)
13566 "Call the set-tags command for the current entry."
13567 (interactive "P")
13568 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13569 (org-set-tags arg just-align)
13570 (save-excursion
13571 (org-back-to-heading t)
13572 (org-set-tags arg just-align))))
13574 (defun org-set-tags-to (data)
13575 "Set the tags of the current entry to DATA, replacing the current tags.
13576 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13577 If DATA is nil or the empty string, any tags will be removed."
13578 (interactive "sTags: ")
13579 (setq data
13580 (cond
13581 ((eq data nil) "")
13582 ((equal data "") "")
13583 ((stringp data)
13584 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13585 ":"))
13586 ((listp data)
13587 (concat ":" (mapconcat 'identity data ":") ":"))))
13588 (when data
13589 (save-excursion
13590 (org-back-to-heading t)
13591 (when (looking-at org-complex-heading-regexp)
13592 (if (match-end 5)
13593 (progn
13594 (goto-char (match-beginning 5))
13595 (insert data)
13596 (delete-region (point) (point-at-eol))
13597 (org-set-tags nil 'align))
13598 (goto-char (point-at-eol))
13599 (insert " " data)
13600 (org-set-tags nil 'align)))
13601 (beginning-of-line 1)
13603 (delete-region (match-beginning 1) (match-end 1))))))
13605 (defun org-align-all-tags ()
13606 "Align the tags i all headings."
13607 (interactive)
13608 (save-excursion
13609 (or (ignore-errors (org-back-to-heading t))
13610 (outline-next-heading))
13611 (if (org-at-heading-p)
13612 (org-set-tags t)
13613 (message "No headings"))))
13615 (defvar org-indent-indentation-per-level)
13616 (defun org-set-tags (&optional arg just-align)
13617 "Set the tags for the current headline.
13618 With prefix ARG, realign all tags in headings in the current buffer."
13619 (interactive "P")
13620 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13621 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13622 'region-start-level 'region))
13623 org-loop-over-headlines-in-active-region)
13624 (org-map-entries
13625 ;; We don't use ARG and JUST-ALIGN here these args are not
13626 ;; useful when looping over headlines
13627 `(org-set-tags)
13628 org-loop-over-headlines-in-active-region
13629 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13630 (let* ((re org-outline-regexp-bol)
13631 (current (unless arg (org-get-tags-string)))
13632 (col (current-column))
13633 (org-setting-tags t)
13634 table current-tags inherited-tags ; computed below when needed
13635 tags p0 c0 c1 rpl di tc level)
13636 (if arg
13637 (save-excursion
13638 (goto-char (point-min))
13639 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13640 (while (re-search-forward re nil t)
13641 (org-set-tags nil t)
13642 (end-of-line 1)))
13643 (message "All tags realigned to column %d" org-tags-column))
13644 (if just-align
13645 (setq tags current)
13646 ;; Get a new set of tags from the user
13647 (save-excursion
13648 (setq table (append org-tag-persistent-alist
13649 (or org-tag-alist (org-get-buffer-tags))
13650 (and
13651 org-complete-tags-always-offer-all-agenda-tags
13652 (org-global-tags-completion-table
13653 (org-agenda-files))))
13654 org-last-tags-completion-table table
13655 current-tags (org-split-string current ":")
13656 inherited-tags (nreverse
13657 (nthcdr (length current-tags)
13658 (nreverse (org-get-tags-at))))
13659 tags
13660 (if (or (eq t org-use-fast-tag-selection)
13661 (and org-use-fast-tag-selection
13662 (delq nil (mapcar 'cdr table))))
13663 (org-fast-tag-selection
13664 current-tags inherited-tags table
13665 (if org-fast-tag-selection-include-todo
13666 org-todo-key-alist))
13667 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13668 (org-trim
13669 (org-icompleting-read "Tags: "
13670 'org-tags-completion-function
13671 nil nil current 'org-tags-history))))))
13672 (while (string-match "[-+&]+" tags)
13673 ;; No boolean logic, just a list
13674 (setq tags (replace-match ":" t t tags))))
13676 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13678 (if org-tags-sort-function
13679 (setq tags (mapconcat 'identity
13680 (sort (org-split-string
13681 tags (org-re "[^[:alnum:]_@#%]+"))
13682 org-tags-sort-function) ":")))
13685 (setq tags "")
13686 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13687 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13689 ;; Insert new tags at the correct column
13690 (beginning-of-line 1)
13691 (setq level (or (and (looking-at org-outline-regexp)
13692 (- (match-end 0) (point) 1))
13693 1))
13694 (cond
13695 ((and (equal current "") (equal tags "")))
13696 ((re-search-forward
13698 (point-at-eol) t)
13699 (if (equal tags "")
13700 (setq rpl "")
13701 (goto-char (match-beginning 0))
13702 (setq c0 (current-column)
13703 ;; compute offset for the case of org-indent-mode active
13704 di (if org-indent-mode
13705 (* (1- org-indent-indentation-per-level) (1- level))
13706 0)
13707 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13708 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13709 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13710 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13711 (replace-match rpl t t)
13712 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13713 tags)
13714 (t (error "Tags alignment failed")))
13715 (org-move-to-column col)
13716 (unless just-align
13717 (run-hooks 'org-after-tags-change-hook))))))
13719 (defun org-change-tag-in-region (beg end tag off)
13720 "Add or remove TAG for each entry in the region.
13721 This works in the agenda, and also in an org-mode buffer."
13722 (interactive
13723 (list (region-beginning) (region-end)
13724 (let ((org-last-tags-completion-table
13725 (if (derived-mode-p 'org-mode)
13726 (org-get-buffer-tags)
13727 (org-global-tags-completion-table))))
13728 (org-icompleting-read
13729 "Tag: " 'org-tags-completion-function nil nil nil
13730 'org-tags-history))
13731 (progn
13733 (equal (read-char-exclusive) ?r))))
13734 (if (fboundp 'deactivate-mark) (deactivate-mark))
13735 (let ((agendap (equal major-mode 'org-agenda-mode))
13736 l1 l2 m buf pos newhead (cnt 0))
13737 (goto-char end)
13738 (setq l2 (1- (org-current-line)))
13739 (goto-char beg)
13740 (setq l1 (org-current-line))
13741 (loop for l from l1 to l2 do
13742 (org-goto-line l)
13743 (setq m (get-text-property (point) 'org-hd-marker))
13744 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
13745 (and agendap m))
13746 (setq buf (if agendap (marker-buffer m) (current-buffer))
13747 pos (if agendap m (point)))
13748 (with-current-buffer buf
13749 (save-excursion
13750 (save-restriction
13751 (goto-char pos)
13752 (setq cnt (1+ cnt))
13753 (org-toggle-tag tag (if off 'off 'on))
13754 (setq newhead (org-get-heading)))))
13755 (and agendap (org-agenda-change-all-lines newhead m))))
13756 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13758 (defun org-tags-completion-function (string predicate &optional flag)
13759 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13760 (confirm (lambda (x) (stringp (car x)))))
13762 (setq s1 (match-string 1 string)
13763 s2 (match-string 2 string))
13764 (setq s1 "" s2 string))
13765 (cond
13766 ((eq flag nil)
13767 ;; try completion
13768 (setq rtn (try-completion s2 ctable confirm))
13769 (if (stringp rtn)
13770 (setq rtn
13771 (concat s1 s2 (substring rtn (length s2))
13772 (if (and org-add-colon-after-tag-completion
13773 (assoc rtn ctable))
13774 ":" ""))))
13775 rtn)
13776 ((eq flag t)
13777 ;; all-completions
13778 (all-completions s2 ctable confirm)
13779 )
13780 ((eq flag 'lambda)
13781 ;; exact match?
13782 (assoc s2 ctable)))
13783 ))
13785 (defun org-fast-tag-insert (kwd tags face &optional end)
13786 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13787 (insert (format "%-12s" (concat kwd ":"))
13788 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13789 (or end "")))
13791 (defun org-fast-tag-show-exit (flag)
13792 (save-excursion
13793 (org-goto-line 3)
13795 (replace-match ""))
13796 (when flag
13797 (end-of-line 1)
13798 (org-move-to-column (- (window-width) 19) t)
13799 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13801 (defun org-set-current-tags-overlay (current prefix)
13802 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13803 (if (featurep 'xemacs)
13804 (org-overlay-display org-tags-overlay (concat prefix s)
13805 'secondary-selection)
13806 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13807 (org-overlay-display org-tags-overlay (concat prefix s)))))
13809 (defvar org-last-tag-selection-key nil)
13810 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13811 "Fast tag selection with single keys.
13812 CURRENT is the current list of tags in the headline, INHERITED is the
13813 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13814 possibly with grouping information. TODO-TABLE is a similar table with
13815 TODO keywords, should these have keys assigned to them.
13816 If the keys are nil, a-z are automatically assigned.
13817 Returns the new tags string, or nil to not change the current settings."
13818 (let* ((fulltable (append table todo-table))
13819 (maxlen (apply 'max (mapcar
13820 (lambda (x)
13821 (if (stringp (car x)) (string-width (car x)) 0))
13822 fulltable)))
13823 (buf (current-buffer))
13824 (expert (eq org-fast-tag-selection-single-key 'expert))
13825 (buffer-tags nil)
13826 (fwidth (+ maxlen 3 1 3))
13827 (ncol (/ (- (window-width) 4) fwidth))
13828 (i-face 'org-done)
13829 (c-face 'org-todo)
13830 tg cnt e c char c1 c2 ntable tbl rtn
13831 ov-start ov-end ov-prefix
13832 (exit-after-next org-fast-tag-selection-single-key)
13833 (done-keywords org-done-keywords)
13834 groups ingroup)
13835 (save-excursion
13836 (beginning-of-line 1)
13837 (if (looking-at
13839 (setq ov-start (match-beginning 1)
13840 ov-end (match-end 1)
13841 ov-prefix "")
13842 (setq ov-start (1- (point-at-eol))
13843 ov-end (1+ ov-start))
13845 (setq ov-prefix
13846 (concat
13847 (buffer-substring (1- (point)) (point))
13848 (if (> (current-column) org-tags-column)
13849 " "
13850 (make-string (- org-tags-column (current-column)) ?\ ))))))
13851 (move-overlay org-tags-overlay ov-start ov-end)
13852 (save-window-excursion
13853 (if expert
13854 (set-buffer (get-buffer-create " *Org tags*"))
13855 (delete-other-windows)
13856 (split-window-vertically)
13857 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13858 (erase-buffer)
13859 (org-set-local 'org-done-keywords done-keywords)
13862 (org-fast-tag-show-exit exit-after-next)
13863 (org-set-current-tags-overlay current ov-prefix)
13864 (setq tbl fulltable char ?a cnt 0)
13865 (while (setq e (pop tbl))
13866 (cond
13867 ((equal (car e) :startgroup)
13868 (push '() groups) (setq ingroup t)
13869 (when (not (= cnt 0))
13870 (setq cnt 0)
13872 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13873 ((equal (car e) :endgroup)
13874 (setq ingroup nil cnt 0)
13876 ((equal e '(:newline))
13877 (when (not (= cnt 0))
13878 (setq cnt 0)
13880 (setq e (car tbl))
13881 (while (equal (car tbl) '(:newline))
13883 (setq tbl (cdr tbl)))))
13884 (t
13885 (setq tg (copy-sequence (car e)) c2 nil)
13886 (if (cdr e)
13887 (setq c (cdr e))
13888 ;; automatically assign a character.
13889 (setq c1 (string-to-char
13890 (downcase (substring
13891 tg (if (= (string-to-char tg) ?@) 1 0)))))
13892 (if (or (rassoc c1 ntable) (rassoc c1 table))
13893 (while (or (rassoc char ntable) (rassoc char table))
13894 (setq char (1+ char)))
13895 (setq c2 c1))
13896 (setq c (or c2 char)))
13897 (if ingroup (push tg (car groups)))
13898 (setq tg (org-add-props tg nil 'face
13899 (cond
13900 ((not (assoc tg table))
13901 (org-get-todo-face tg))
13902 ((member tg current) c-face)
13903 ((member tg inherited) i-face))))
13904 (if (and (= cnt 0) (not ingroup)) (insert " "))
13905 (insert "[" c "] " tg (make-string
13906 (- fwidth 4 (length tg)) ?\ ))
13907 (push (cons tg c) ntable)
13908 (when (= (setq cnt (1+ cnt)) ncol)
13910 (if ingroup (insert " "))
13911 (setq cnt 0)))))
13912 (setq ntable (nreverse ntable))
13914 (goto-char (point-min))
13915 (if (not expert) (org-fit-window-to-buffer))
13916 (setq rtn
13917 (catch 'exit
13918 (while t
13919 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13920 (if (not groups) "no " "")
13921 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13922 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13923 (setq org-last-tag-selection-key c)
13924 (cond
13926 ((= c ?!)
13927 (setq groups (not groups))
13928 (goto-char (point-min))
13929 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13930 ((= c ?\C-c)
13931 (if (not expert)
13932 (org-fast-tag-show-exit
13933 (setq exit-after-next (not exit-after-next)))
13934 (setq expert nil)
13935 (delete-other-windows)
13936 (set-window-buffer (split-window-vertically) " *Org tags*")
13937 (org-switch-to-buffer-other-window " *Org tags*")
13938 (org-fit-window-to-buffer)))
13939 ((or (= c ?\C-g)
13940 (and (= c ?q) (not (rassoc c ntable))))
13941 (org-detach-overlay org-tags-overlay)
13942 (setq quit-flag t))
13943 ((= c ?\ )
13944 (setq current nil)
13945 (if exit-after-next (setq exit-after-next 'now)))
13947 (condition-case nil
13948 (setq tg (org-icompleting-read
13949 "Tag: "
13950 (or buffer-tags
13951 (with-current-buffer buf
13952 (org-get-buffer-tags)))))
13953 (quit (setq tg "")))
13955 (add-to-list 'buffer-tags (list tg))
13956 (if (member tg current)
13957 (setq current (delete tg current))
13958 (push tg current)))
13959 (if exit-after-next (setq exit-after-next 'now)))
13960 ((setq e (rassoc c todo-table) tg (car e))
13961 (with-current-buffer buf
13962 (save-excursion (org-todo tg)))
13963 (if exit-after-next (setq exit-after-next 'now)))
13964 ((setq e (rassoc c ntable) tg (car e))
13965 (if (member tg current)
13966 (setq current (delete tg current))
13967 (loop for g in groups do
13968 (if (member tg g)
13969 (mapc (lambda (x)
13970 (setq current (delete x current)))
13971 g)))
13972 (push tg current))
13973 (if exit-after-next (setq exit-after-next 'now))))
13975 ;; Create a sorted list
13976 (setq current
13977 (sort current
13978 (lambda (a b)
13979 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13980 (if (eq exit-after-next 'now) (throw 'exit t))
13981 (goto-char (point-min))
13982 (beginning-of-line 2)
13983 (delete-region (point) (point-at-eol))
13984 (org-fast-tag-insert "Current" current c-face)
13985 (org-set-current-tags-overlay current ov-prefix)
13986 (while (re-search-forward
13988 (setq tg (match-string 1))
13989 (add-text-properties
13990 (match-beginning 1) (match-end 1)
13991 (list 'face
13992 (cond
13993 ((member tg current) c-face)
13994 ((member tg inherited) i-face)
13995 (t (get-text-property (match-beginning 1) 'face))))))
13996 (goto-char (point-min)))))
13997 (org-detach-overlay org-tags-overlay)
13998 (if rtn
13999 (mapconcat 'identity current ":")
14000 nil))))
14002 (defun org-get-tags-string ()
14003 "Get the TAGS string in the current headline."
14004 (unless (org-at-heading-p t)
14005 (error "Not on a heading"))
14006 (save-excursion
14007 (beginning-of-line 1)
14009 (org-match-string-no-properties 1)
14010 "")))
14012 (defun org-get-tags ()
14013 "Get the list of tags specified in the current headline."
14014 (org-split-string (org-get-tags-string) ":"))
14016 (defun org-get-buffer-tags ()
14017 "Get a table of all tags used in the buffer, for completion."
14018 (let (tags)
14019 (save-excursion
14020 (goto-char (point-min))
14021 (while (re-search-forward
14023 (when (equal (char-after (point-at-bol 0)) ?*)
14024 (mapc (lambda (x) (add-to-list 'tags x))
14025 (org-split-string (org-match-string-no-properties 1) ":")))))
14026 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14027 (mapcar 'list tags)))
14029 ;;;; The mapping API
14031 (defun org-map-entries (func &optional match scope &rest skip)
14032 "Call FUNC at each headline selected by MATCH in SCOPE.
14034 FUNC is a function or a lisp form. The function will be called without
14035 arguments, with the cursor positioned at the beginning of the headline.
14036 The return values of all calls to the function will be collected and
14037 returned as a list.
14039 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14040 does not need to preserve point. After evaluation, the cursor will be
14041 moved to the end of the line (presumably of the headline of the
14042 processed entry) and search continues from there. Under some
14043 circumstances, this may not produce the wanted results. For example,
14044 if you have removed (e.g. archived) the current (sub)tree it could
14045 mean that the next entry will be skipped entirely. In such cases, you
14046 can specify the position from where search should continue by making
14047 FUNC set the variable `org-map-continue-from' to the desired buffer
14048 position.
14050 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14051 Only headlines that are matched by this query will be considered during
14052 the iteration. When MATCH is nil or t, all headlines will be
14053 visited by the iteration.
14055 SCOPE determines the scope of this command. It can be any of:
14057 nil The current buffer, respecting the restriction if any
14058 tree The subtree started with the entry at point
14059 region The entries within the active region, if any
14060 region-start-level
14061 The entries within the active region, but only those at
14062 the same level than the first one.
14063 file The current buffer, without restriction
14064 file-with-archives
14065 The current buffer, and any archives associated with it
14066 agenda All agenda files
14067 agenda-with-archives
14068 All agenda files with any archive files associated with them
14069 \(file1 file2 ...)
14070 If this is a list, all files in the list will be scanned
14072 The remaining args are treated as settings for the skipping facilities of
14073 the scanner. The following items can be given here:
14075 archive skip trees with the archive tag.
14076 comment skip trees with the COMMENT keyword
14077 function or Emacs Lisp form:
14078 will be used as value for `org-agenda-skip-function', so whenever
14079 the function returns t, FUNC will not be called for that
14080 entry and search will continue from the point where the
14081 function leaves it.
14083 If your function needs to retrieve the tags including inherited tags
14084 at the *current* entry, you can use the value of the variable
14085 `org-scanner-tags' which will be much faster than getting the value
14086 with `org-get-tags-at'. If your function gets properties with
14087 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14088 to t around the call to `org-entry-properties' to get the same speedup.
14089 Note that if your function moves around to retrieve tags and properties at
14090 a *different* entry, you cannot use these techniques."
14091 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14092 (not (org-region-active-p)))
14093 (let* ((org-agenda-archives-mode nil) ; just to make sure
14094 (org-agenda-skip-archived-trees (memq 'archive skip))
14095 (org-agenda-skip-comment-trees (memq 'comment skip))
14096 (org-agenda-skip-function
14097 (car (org-delete-all '(comment archive) skip)))
14098 (org-tags-match-list-sublevels t)
14099 (start-level (eq scope 'region-start-level))
14100 matcher file res
14101 org-todo-keywords-for-agenda
14102 org-done-keywords-for-agenda
14103 org-todo-keyword-alist-for-agenda
14104 org-drawers-for-agenda
14105 org-tag-alist-for-agenda
14106 todo-only)
14108 (cond
14109 ((eq match t) (setq matcher t))
14110 ((eq match nil) (setq matcher t))
14111 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14113 (save-excursion
14114 (save-restriction
14115 (cond ((eq scope 'tree)
14116 (org-back-to-heading t)
14117 (org-narrow-to-subtree)
14118 (setq scope nil))
14119 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14120 (org-region-active-p))
14121 ;; If needed, set start-level to a string like "2"
14122 (when start-level
14123 (save-excursion
14124 (goto-char (region-beginning))
14125 (unless (org-at-heading-p) (outline-next-heading))
14126 (setq start-level (org-current-level))))
14127 (narrow-to-region (region-beginning)
14128 (save-excursion
14129 (goto-char (region-end))
14130 (unless (and (bolp) (org-at-heading-p))
14131 (outline-next-heading))
14132 (point)))
14133 (setq scope nil)))
14135 (if (not scope)
14136 (progn
14137 (org-agenda-prepare-buffers
14138 (list (buffer-file-name (current-buffer))))
14139 (setq res (org-scan-tags func matcher todo-only start-level)))
14140 ;; Get the right scope
14141 (cond
14142 ((and scope (listp scope) (symbolp (car scope)))
14143 (setq scope (eval scope)))
14144 ((eq scope 'agenda)
14145 (setq scope (org-agenda-files t)))
14146 ((eq scope 'agenda-with-archives)
14147 (setq scope (org-agenda-files t))
14148 (setq scope (org-add-archive-files scope)))
14149 ((eq scope 'file)
14150 (setq scope (list (buffer-file-name))))
14151 ((eq scope 'file-with-archives)
14152 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14153 (org-agenda-prepare-buffers scope)
14154 (while (setq file (pop scope))
14155 (with-current-buffer (org-find-base-buffer-visiting file)
14156 (save-excursion
14157 (save-restriction
14158 (widen)
14159 (goto-char (point-min))
14160 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14161 res)))
14163 ;;;; Properties
14165 ;;; Setting and retrieving properties
14167 (defconst org-special-properties
14168 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14169 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14170 "The special properties valid in Org-mode.
14172 These are properties that are not defined in the property drawer,
14173 but in some other way.")
14175 (defconst org-default-properties
14176 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14177 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14178 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14179 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14180 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14181 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14182 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14183 "Some properties that are used by Org-mode for various purposes.
14184 Being in this list makes sure that they are offered for completion.")
14187 "Regular expression matching the first line of a property drawer.")
14190 "Regular expression matching the last line of a property drawer.")
14193 "Regular expression matching the first line of a property drawer.")
14196 "Regular expression matching the first line of a property drawer.")
14198 (defconst org-property-drawer-re
14201 "Matches an entire property drawer.")
14203 (defconst org-clock-drawer-re
14206 "Matches an entire clock drawer.")
14208 (defsubst org-re-property (property)
14209 "Return a regexp matching a PROPERTY line.
14210 Match group 1 will be set to the value."
14213 (defsubst org-re-property-keyword (property)
14214 "Return a regexp matching a PROPERTY line, possibly with no
14215 value for the property."
14218 (defun org-property-action ()
14219 "Do an action on properties."
14220 (interactive)
14221 (let (c)
14222 (org-at-property-p)
14223 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14224 (setq c (read-char-exclusive))
14225 (cond
14226 ((equal c ?s)
14227 (call-interactively 'org-set-property))
14228 ((equal c ?d)
14229 (call-interactively 'org-delete-property))
14230 ((equal c ?D)
14231 (call-interactively 'org-delete-property-globally))
14232 ((equal c ?c)
14233 (call-interactively 'org-compute-property-at-point))
14234 (t (error "No such property action %c" c)))))
14236 (defun org-inc-effort ()
14237 "Increment the value of the effort property in the current entry."
14238 (interactive)
14239 (org-set-effort nil t))
14241 (defun org-set-effort (&optional value increment)
14242 "Set the effort property of the current entry.
14243 With numerical prefix arg, use the nth allowed value, 0 stands for the
14244 10th allowed value.
14246 When INCREMENT is non-nil, set the property to the next allowed value."
14247 (interactive "P")
14248 (if (equal value 0) (setq value 10))
14249 (let* ((completion-ignore-case t)
14250 (prop org-effort-property)
14251 (cur (org-entry-get nil prop))
14252 (allowed (org-property-get-allowed-values nil prop 'table))
14253 (existing (mapcar 'list (org-property-values prop)))
14254 rpl
14255 (val (cond
14256 ((stringp value) value)
14257 ((and allowed (integerp value))
14258 (or (car (nth (1- value) allowed))
14259 (car (org-last allowed))))
14260 ((and allowed increment)
14261 (or (caadr (member (list cur) allowed))
14262 (error "Allowed effort values are not set")))
14263 (allowed
14264 (message "Select 1-9,0, [RET%s]: %s"
14265 (if cur (concat "=" cur) "")
14266 (mapconcat 'car allowed " "))
14267 (setq rpl (read-char-exclusive))
14269 cur
14270 (setq rpl (- rpl ?0))
14271 (if (equal rpl 0) (setq rpl 10))
14272 (if (and (> rpl 0) (<= rpl (length allowed)))
14273 (car (nth (1- rpl) allowed))
14274 (org-completing-read "Effort: " allowed nil))))
14275 (t
14276 (let (org-completion-use-ido org-completion-use-iswitchb)
14277 (org-completing-read
14279 (concat "[" cur "]") "")
14280 ": ")
14281 existing nil nil "" nil cur))))))
14282 (unless (equal (org-entry-get nil prop) val)
14283 (org-entry-put nil prop val))
14284 (message "%s is now %s" prop val)))
14286 (defun org-at-property-p ()
14287 "Is cursor inside a property drawer?"
14288 (save-excursion
14289 (beginning-of-line 1)
14291 (save-match-data ;; Used by calling procedures
14292 (let ((p (point))
14293 (range (unless (org-before-first-heading-p)
14294 (org-get-property-block))))
14295 (and range (<= (car range) p) (< p (cdr range))))))))
14297 (defun org-get-property-block (&optional beg end force)
14298 "Return the (beg . end) range of the body of the property drawer.
14299 BEG and END are the beginning and end of the current subtree, or of
14300 the part before the first headline. If they are not given, they will
14301 be found. If the drawer does not exist and FORCE is non-nil, create
14302 the drawer."
14303 (catch 'exit
14304 (save-excursion
14305 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
14306 (progn (org-back-to-heading t) (point))))
14307 (end (or end (and (not (outline-next-heading)) (point-max))
14308 (point))))
14309 (goto-char beg)
14310 (if (re-search-forward org-property-start-re end t)
14311 (setq beg (1+ (match-end 0)))
14312 (if force
14313 (save-excursion
14314 (org-insert-property-drawer)
14315 (setq end (progn (outline-next-heading) (point))))
14316 (throw 'exit nil))
14317 (goto-char beg)
14318 (if (re-search-forward org-property-start-re end t)
14319 (setq beg (1+ (match-end 0)))))
14320 (if (re-search-forward org-property-end-re end t)
14321 (setq end (match-beginning 0))
14322 (or force (throw 'exit nil))
14323 (goto-char beg)
14324 (setq end beg)
14325 (org-indent-line)
14327 (cons beg end)))))
14329 (defun org-entry-properties (&optional pom which specific)
14330 "Get all properties of the entry at point-or-marker POM.
14331 This includes the TODO keyword, the tags, time strings for deadline,
14332 scheduled, and clocking, and any additional properties defined in the
14333 entry. The return value is an alist, keys may occur multiple times
14334 if the property key was used several times.
14335 POM may also be nil, in which case the current entry is used.
14336 If WHICH is nil or `all', get all properties. If WHICH is
14337 `special' or `standard', only get that subclass. If WHICH
14338 is a string only get exactly this property. SPECIFIC can be a string, the
14339 specific property we are interested in. Specifying it can speed
14340 things up because then unnecessary parsing is avoided."
14341 (setq which (or which 'all))
14342 (org-with-point-at pom
14343 (let ((clockstr (substring org-clock-string 0 -1))
14344 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14345 (case-fold-search nil)
14346 beg end range props sum-props key key1 value string clocksum clocksumt)
14347 (save-excursion
14348 (when (condition-case nil
14349 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14350 (error nil))
14351 (setq beg (point))
14352 (setq sum-props (get-text-property (point) 'org-summaries))
14353 (setq clocksum (get-text-property (point) :org-clock-minutes)
14354 clocksumt (get-text-property (point) :org-clock-minutes-today))
14355 (outline-next-heading)
14356 (setq end (point))
14357 (when (memq which '(all special))
14358 ;; Get the special properties, like TODO and tags
14359 (goto-char beg)
14360 (when (and (or (not specific) (string= specific "TODO"))
14361 (looking-at org-todo-line-regexp) (match-end 2))
14362 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14363 (when (and (or (not specific) (string= specific "PRIORITY"))
14364 (looking-at org-priority-regexp))
14365 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14366 (when (or (not specific) (string= specific "FILE"))
14367 (push (cons "FILE" buffer-file-name) props))
14368 (when (and (or (not specific) (string= specific "TAGS"))
14369 (setq value (org-get-tags-string))
14371 (push (cons "TAGS" value) props))
14372 (when (and (or (not specific) (string= specific "ALLTAGS"))
14373 (setq value (org-get-tags-at)))
14374 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14375 ":"))
14376 props))
14377 (when (or (not specific) (string= specific "BLOCKED"))
14378 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14379 (when (or (not specific)
14380 (member specific
14381 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14382 "TIMESTAMP" "TIMESTAMP_IA")))
14383 (catch 'match
14384 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14385 (setq key (if (match-end 1)
14386 (substring (org-match-string-no-properties 1)
14387 0 -1))
14388 string (if (equal key clockstr)
14389 (org-trim
14390 (buffer-substring-no-properties
14391 (match-beginning 3) (goto-char
14392 (point-at-eol))))
14393 (substring (org-match-string-no-properties 3)
14394 1 -1)))
14395 ;; Get the correct property name from the key. This is
14396 ;; necessary if the user has configured time keywords.
14397 (setq key1 (concat key ":"))
14398 (cond
14399 ((not key)
14400 (setq key
14401 (if (= (char-after (match-beginning 3)) ?\[)
14402 "TIMESTAMP_IA" "TIMESTAMP")))
14403 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14404 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14405 ((equal key1 org-closed-string) (setq key "CLOSED"))
14406 ((equal key1 org-clock-string) (setq key "CLOCK")))
14407 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14408 (progn
14409 (push (cons key string) props)
14410 ;; no need to search further if match is found
14411 (throw 'match t))
14412 (when (or (equal key "CLOCK") (not (assoc key props)))
14413 (push (cons key string) props)))))))
14415 (when (memq which '(all standard))
14416 ;; Get the standard properties, like :PROP: ...
14417 (setq range (org-get-property-block beg end))
14418 (when range
14419 (goto-char (car range))
14420 (while (re-search-forward
14422 (cdr range) t)
14423 (setq key (org-match-string-no-properties 1)
14424 value (org-trim (or (org-match-string-no-properties 2) "")))
14425 (unless (member key excluded)
14426 (push (cons key (or value "")) props)))))
14427 (if clocksum
14428 (push (cons "CLOCKSUM"
14429 (org-columns-number-to-string (/ (float clocksum) 60.)
14430 'add_times))
14431 props))
14432 (if clocksumt
14433 (push (cons "CLOCKSUM_T"
14434 (org-columns-number-to-string (/ (float clocksumt) 60.)
14435 'add_times))
14436 props))
14437 (unless (assoc "CATEGORY" props)
14438 (push (cons "CATEGORY" (org-get-category)) props))
14439 (append sum-props (nreverse props)))))))
14441 (defun org-entry-get (pom property &optional inherit literal-nil)
14442 "Get value of PROPERTY for entry or content at point-or-marker POM.
14443 If INHERIT is non-nil and the entry does not have the property,
14444 then also check higher levels of the hierarchy.
14445 If INHERIT is the symbol `selective', use inheritance only if the setting
14446 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14447 If the property is present but empty, the return value is the empty string.
14448 If the property is not present at all, nil is returned.
14451 do not interpret it as the list atom nil. This is used for inheritance
14453 (org-with-point-at pom
14454 (if (and inherit (if (eq inherit 'selective)
14455 (org-property-inherit-p property)
14456 t))
14457 (org-entry-get-with-inheritance property literal-nil)
14458 (if (member property org-special-properties)
14459 ;; We need a special property. Use `org-entry-properties' to
14460 ;; retrieve it, but specify the wanted property
14461 (cdr (assoc property (org-entry-properties nil 'special property)))
14462 (let* ((range (org-get-property-block))
14463 (props (list (or (assoc property org-file-properties)
14464 (assoc property org-global-properties)
14465 (assoc property org-global-properties-fixed))))
14466 (ap (lambda (key)
14467 (when (re-search-forward
14468 (org-re-property key) (cdr range) t)
14469 (setq props
14470 (org-update-property-plist
14471 key
14472 (if (match-end 1)
14473 (org-match-string-no-properties 1) "")
14474 props)))))
14475 val)
14476 (when (and range (goto-char (car range)))
14477 (funcall ap property)
14478 (goto-char (car range))
14479 (while (funcall ap (concat property "+")))
14480 (setq val (cdr (assoc property props)))
14481 (when val (if literal-nil val (org-not-nil val)))))))))
14483 (defun org-property-or-variable-value (var &optional inherit)
14484 "Check if there is a property fixing the value of VAR.
14485 If yes, return this value. If not, return the current value of the variable."
14486 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14488 (read prop)
14489 (symbol-value var))))
14491 (defun org-entry-delete (pom property)
14492 "Delete the property PROPERTY from entry at point-or-marker POM."
14493 (org-with-point-at pom
14494 (if (member property org-special-properties)
14495 nil ; cannot delete these properties.
14496 (let ((range (org-get-property-block)))
14497 (if (and range
14498 (goto-char (car range))
14499 (re-search-forward
14500 (org-re-property property)
14501 (cdr range) t))
14502 (progn
14503 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14504 t)
14505 nil)))))
14507 ;; Multi-values properties are properties that contain multiple values
14508 ;; These values are assumed to be single words, separated by whitespace.
14509 (defun org-entry-add-to-multivalued-property (pom property value)
14510 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14511 (let* ((old (org-entry-get pom property))
14513 (setq value (org-entry-protect-space value))
14514 (unless (member value values)
14515 (setq values (cons value values))
14516 (org-entry-put pom property
14517 (mapconcat 'identity values " ")))))
14519 (defun org-entry-remove-from-multivalued-property (pom property value)
14520 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14521 (let* ((old (org-entry-get pom property))
14523 (setq value (org-entry-protect-space value))
14524 (when (member value values)
14525 (setq values (delete value values))
14526 (org-entry-put pom property
14527 (mapconcat 'identity values " ")))))
14529 (defun org-entry-member-in-multivalued-property (pom property value)
14530 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14531 (let* ((old (org-entry-get pom property))
14533 (setq value (org-entry-protect-space value))
14534 (member value values)))
14536 (defun org-entry-get-multivalued-property (pom property)
14537 "Return a list of values in a multivalued property."
14538 (let* ((value (org-entry-get pom property))
14540 (mapcar 'org-entry-restore-space values)))
14542 (defun org-entry-put-multivalued-property (pom property &rest values)
14543 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14544 VALUES should be a list of strings. Spaces will be protected."
14545 (org-entry-put pom property
14546 (mapconcat 'org-entry-protect-space values " "))
14547 (let* ((value (org-entry-get pom property))
14549 (mapcar 'org-entry-restore-space values)))
14551 (defun org-entry-protect-space (s)
14552 "Protect spaces and newline in string S."
14553 (while (string-match " " s)
14554 (setq s (replace-match "%20" t t s)))
14556 (setq s (replace-match "%0A" t t s)))
14557 s)
14559 (defun org-entry-restore-space (s)
14560 "Restore spaces and newline in string S."
14561 (while (string-match "%20" s)
14562 (setq s (replace-match " " t t s)))
14563 (while (string-match "%0A" s)
14565 s)
14567 (defvar org-entry-property-inherited-from (make-marker)
14568 "Marker pointing to the entry from where a property was inherited.
14569 Each call to `org-entry-get-with-inheritance' will set this marker to the
14570 location of the entry where the inheritance search matched. If there was
14571 no match, the marker will point nowhere.
14572 Note that also `org-entry-get' calls this function, if the INHERIT flag
14573 is set.")
14575 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14576 "Get PROPERTY of entry or content at point, search higher levels if needed.
14577 The search will stop at the first ancestor which has the property defined.
14579 should be considered as undefined (this is the meaning of nil here).
14581 (move-marker org-entry-property-inherited-from nil)
14582 (let (tmp)
14583 (save-excursion
14584 (save-restriction
14585 (widen)
14586 (catch 'ex
14587 (while t
14588 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14589 (or (ignore-errors (org-back-to-heading t))
14590 (goto-char (point-min)))
14591 (move-marker org-entry-property-inherited-from (point))
14592 (throw 'ex tmp))
14593 (or (ignore-errors (org-up-heading-safe))
14594 (throw 'ex nil))))))
14595 (setq tmp (or tmp
14596 (cdr (assoc property org-file-properties))
14597 (cdr (assoc property org-global-properties))
14598 (cdr (assoc property org-global-properties-fixed))))
14599 (if literal-nil tmp (org-not-nil tmp))))
14601 (defvar org-property-changed-functions nil
14602 "Hook called when the value of a property has changed.
14603 Each hook function should accept two arguments, the name of the property
14604 and the new value.")
14606 (defun org-entry-put (pom property value)
14607 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14608 (org-with-point-at pom
14609 (org-back-to-heading t)
14610 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14611 range)
14612 (cond
14613 ((equal property "TODO")
14615 (not (member value org-todo-keywords-1)))
14617 (if (or (not value)
14619 (setq value 'none))
14620 (org-todo value)
14621 (org-set-tags nil 'align))
14622 ((equal property "PRIORITY")
14624 (string-to-char value) ?\ ))
14625 (org-set-tags nil 'align))
14626 ((equal property "SCHEDULED")
14627 (if (re-search-forward org-scheduled-time-regexp end t)
14628 (cond
14629 ((eq value 'earlier) (org-timestamp-change -1 'day))
14630 ((eq value 'later) (org-timestamp-change 1 'day))
14631 (t (call-interactively 'org-schedule)))
14632 (call-interactively 'org-schedule)))
14633 ((equal property "DEADLINE")
14634 (if (re-search-forward org-deadline-time-regexp end t)
14635 (cond
14636 ((eq value 'earlier) (org-timestamp-change -1 'day))
14637 ((eq value 'later) (org-timestamp-change 1 'day))
14638 (t (call-interactively 'org-deadline)))
14639 (call-interactively 'org-deadline)))
14640 ((member property org-special-properties)
14641 (error "The %s property can not yet be set with `org-entry-put'"
14642 property))
14643 (t ; a non-special property
14644 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14645 (setq range (org-get-property-block beg end 'force))
14646 (goto-char (car range))
14647 (if (re-search-forward
14648 (org-re-property-keyword property) (cdr range) t)
14649 (progn
14650 (delete-region (match-beginning 0) (match-end 0))
14651 (goto-char (match-beginning 0)))
14652 (goto-char (cdr range))
14654 (backward-char 1)
14655 (org-indent-line))
14656 (insert ":" property ":")
14657 (and value (insert " " value))
14658 (org-indent-line)))))
14659 (run-hook-with-args 'org-property-changed-functions property value)))
14661 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14662 "Get all property keys in the current buffer.
14663 With INCLUDE-SPECIALS, also list the special properties that reflect things
14664 like tags and TODO state.
14665 With INCLUDE-DEFAULTS, also include properties that has special meaning
14666 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14667 and others.
14668 With INCLUDE-COLUMNS, also include property names given in COLUMN
14669 formats in the current buffer."
14670 (let (rtn range cfmt s p)
14671 (save-excursion
14672 (save-restriction
14673 (widen)
14674 (goto-char (point-min))
14675 (while (re-search-forward org-property-start-re nil t)
14676 (setq range (org-get-property-block))
14677 (goto-char (car range))
14678 (while (re-search-forward
14680 (cdr range) t)
14681 (add-to-list 'rtn (org-match-string-no-properties 1)))
14682 (outline-next-heading))))
14684 (when include-specials
14685 (setq rtn (append org-special-properties rtn)))
14687 (when include-defaults
14688 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14689 (add-to-list 'rtn org-effort-property))
14691 (when include-columns
14692 (save-excursion
14693 (save-restriction
14694 (widen)
14695 (goto-char (point-min))
14696 (while (re-search-forward
14698 nil t)
14699 (setq cfmt (match-string 2) s 0)
14701 cfmt s)
14702 (setq s (match-end 0)
14703 p (match-string 1 cfmt))
14704 (unless (or (equal p "ITEM")
14705 (member p org-special-properties))
14706 (add-to-list 'rtn (match-string 1 cfmt))))))))
14708 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14710 (defun org-property-values (key)
14711 "Return a list of all values of property KEY in the current buffer."
14712 (save-excursion
14713 (save-restriction
14714 (widen)
14715 (goto-char (point-min))
14716 (let ((re (org-re-property key))
14717 values)
14718 (while (re-search-forward re nil t)
14719 (add-to-list 'values (org-trim (match-string 1))))
14720 (delete "" values)))))
14722 (defun org-insert-property-drawer ()
14723 "Insert a property drawer into the current entry."
14724 (org-back-to-heading t)
14725 (looking-at org-outline-regexp)
14726 (let ((indent (if org-adapt-indentation
14727 (- (match-end 0) (match-beginning 0))
14728 0))
14729 (beg (point))
14731 end hiddenp)
14732 (outline-next-heading)
14733 (setq end (point))
14734 (goto-char beg)
14735 (while (re-search-forward re end t))
14736 (setq hiddenp (outline-invisible-p))
14737 (end-of-line 1)
14740 (if (member (match-string 1) '("CLOCK:" ":END:"))
14741 ;; just skip this line
14742 (beginning-of-line 2)
14743 ;; Drawer start, find the end
14745 (beginning-of-line 1)))
14746 (org-skip-over-state-notes)
14748 (if (eq (char-before) ?*) (forward-char 1))
14750 (beginning-of-line 0)
14751 (org-indent-to-column indent)
14752 (beginning-of-line 2)
14753 (org-indent-to-column indent)
14754 (beginning-of-line 0)
14755 (if hiddenp
14756 (save-excursion
14757 (org-back-to-heading t)
14758 (hide-entry))
14759 (org-flag-drawer t))))
14761 (defun org-insert-drawer (&optional arg drawer)
14762 "Insert a drawer at point.
14764 Optional argument DRAWER, when non-nil, is a string representing
14765 drawer's name. Otherwise, the user is prompted for a name.
14767 If a region is active, insert the drawer around that region
14768 instead.
14770 Point is left between drawer's boundaries."
14771 (interactive "P")
14772 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14773 "LOGBOOK"))
14774 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14775 ;; internally by Org. They are meant to be inserted
14776 ;; automatically.
14777 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14778 ;; Remove system drawers from list. Note: For some reason,
14779 ;; `org-completing-read' ignores the predicate while
14780 ;; `completing-read' handles it fine.
14781 (drawer (if arg "PROPERTIES"
14782 (or drawer
14783 (completing-read
14784 "Drawer: " org-drawers
14785 (lambda (d) (not (member d system-drawers))))))))
14786 (cond
14787 ;; With C-u, fall back on `org-insert-property-drawer'
14788 (arg (org-insert-property-drawer))
14789 ;; With an active region, insert a drawer at point.
14790 ((not (org-region-active-p))
14791 (progn
14794 (forward-line -2)))
14795 ;; Otherwise, insert the drawer at point
14796 (t
14797 (let ((rbeg (region-beginning))
14798 (rend (copy-marker (region-end))))
14799 (unwind-protect
14800 (progn
14801 (goto-char rbeg)
14802 (beginning-of-line)
14803 (when (save-excursion
14804 (re-search-forward org-outline-regexp-bol rend t))
14805 (error "Drawers cannot contain headlines"))
14806 ;; Position point at the beginning of the first
14807 ;; non-blank line in region. Insert drawer's opening
14808 ;; there, then indent it.
14809 (org-skip-whitespace)
14810 (beginning-of-line)
14812 (forward-line -1)
14813 (indent-for-tab-command)
14814 ;; Move point to the beginning of the first blank line
14815 ;; after the last non-blank line in region. Insert
14816 ;; drawer's closing, then indent it.
14817 (goto-char rend)
14820 (deactivate-mark t)
14821 (indent-for-tab-command)
14823 ;; Clear marker, whatever the outcome of insertion is.
14824 (set-marker rend nil)))))))
14826 (defvar org-property-set-functions-alist nil
14827 "Property set function alist.
14828 Each entry should have the following format:
14830 (PROPERTY . READ-FUNCTION)
14832 The read function will be called with the same argument as
14833 `org-completing-read'.")
14835 (defun org-set-property-function (property)
14836 "Get the function that should be used to set PROPERTY.
14837 This is computed according to `org-property-set-functions-alist'."
14838 (or (cdr (assoc property org-property-set-functions-alist))
14839 'org-completing-read))
14841 (defun org-read-property-value (property)
14842 "Read PROPERTY value from user."
14843 (let* ((completion-ignore-case t)
14844 (allowed (org-property-get-allowed-values nil property 'table))
14845 (cur (org-entry-get nil property))
14846 (prompt (concat property " value"
14848 (concat " [" cur "]") "") ": "))
14849 (set-function (org-set-property-function property))
14850 (val (if allowed
14851 (funcall set-function prompt allowed nil
14852 (not (get-text-property 0 'org-unrestricted
14853 (caar allowed))))
14854 (let (org-completion-use-ido org-completion-use-iswitchb)
14855 (funcall set-function prompt
14856 (mapcar 'list (org-property-values property))
14857 nil nil "" nil cur)))))
14858 (if (equal val "")
14859 cur
14860 val)))
14862 (defvar org-last-set-property nil)
14863 (defun org-read-property-name ()
14864 "Read a property name."
14865 (let* ((completion-ignore-case t)
14866 (keys (org-buffer-property-keys nil t t))
14867 (default-prop (or (save-excursion
14868 (save-match-data
14869 (beginning-of-line)
14871 (null (string= (match-string 1) "END"))
14872 (match-string 1))))
14873 org-last-set-property))
14874 (property (org-icompleting-read
14875 (concat "Property"
14876 (if default-prop (concat " [" default-prop "]") "")
14877 ": ")
14878 (mapcar 'list keys)
14879 nil nil nil nil
14880 default-prop
14881 )))
14882 (if (member property keys)
14883 property
14884 (or (cdr (assoc (downcase property)
14885 (mapcar (lambda (x) (cons (downcase x) x))
14886 keys)))
14887 property))))
14889 (defun org-set-property (property value)
14890 "In the current entry, set PROPERTY to VALUE.
14891 When called interactively, this will prompt for a property name, offering
14892 completion on existing and default properties. And then it will prompt
14893 for a value, offering completion either on allowed values (via an inherited
14894 xxx_ALL property) or on existing values in other instances of this property
14895 in the current file."
14896 (interactive (list nil nil))
14897 (let* ((property (or property (org-read-property-name)))
14898 (value (or value (org-read-property-value property)))
14899 (fn (cdr (assoc property org-properties-postprocess-alist))))
14900 (setq org-last-set-property property)
14901 ;; Possibly postprocess the inserted value:
14902 (when fn (setq value (funcall fn value)))
14903 (unless (equal (org-entry-get nil property) value)
14904 (org-entry-put nil property value))))
14906 (defun org-delete-property (property)
14907 "In the current entry, delete PROPERTY."
14908 (interactive
14909 (let* ((completion-ignore-case t)
14910 (prop (org-icompleting-read "Property: "
14911 (org-entry-properties nil 'standard))))
14912 (list prop)))
14913 (message "Property %s %s" property
14914 (if (org-entry-delete nil property)
14915 "deleted"
14916 "was not present in the entry")))
14918 (defun org-delete-property-globally (property)
14919 "Remove PROPERTY globally, from all entries."
14920 (interactive
14921 (let* ((completion-ignore-case t)
14922 (prop (org-icompleting-read
14923 "Globally remove property: "
14924 (mapcar 'list (org-buffer-property-keys)))))
14925 (list prop)))
14926 (save-excursion
14927 (save-restriction
14928 (widen)
14929 (goto-char (point-min))
14930 (let ((cnt 0))
14931 (while (re-search-forward
14932 (org-re-property property)
14933 nil t)
14934 (setq cnt (1+ cnt))
14935 (delete-region (match-beginning 0) (1+ (point-at-eol))))
14938 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14940 (defun org-compute-property-at-point ()
14941 "Compute the property at point.
14942 This looks for an enclosing column format, extracts the operator and
14943 then applies it to the property in the column format's scope."
14944 (interactive)
14945 (unless (org-at-property-p)
14946 (error "Not at a property"))
14947 (let ((prop (org-match-string-no-properties 2)))
14948 (org-columns-get-format-and-top-level)
14949 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14950 (error "No operator defined for property %s" prop))
14951 (org-columns-compute prop)))
14953 (defvar org-property-allowed-value-functions nil
14954 "Hook for functions supplying allowed values for a specific property.
14955 The functions must take a single argument, the name of the property, and
14957 the values, this means that these values are intended as defaults for
14958 completion, but that other values should be allowed too.
14959 The functions must return nil if they are not responsible for this
14960 property.")
14962 (defun org-property-get-allowed-values (pom property &optional table)
14963 "Get allowed values for the property PROPERTY.
14964 When TABLE is non-nil, return an alist that can directly be used for
14965 completion."
14966 (let (vals)
14967 (cond
14968 ((equal property "TODO")
14969 (setq vals (org-with-point-at pom
14970 (append org-todo-keywords-1 '("")))))
14971 ((equal property "PRIORITY")
14972 (let ((n org-lowest-priority))
14973 (while (>= n org-highest-priority)
14974 (push (char-to-string n) vals)
14975 (setq n (1- n)))))
14976 ((member property org-special-properties))
14977 ((setq vals (run-hook-with-args-until-success
14978 'org-property-allowed-value-functions property)))
14979 (t
14980 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14982 (setq vals (car (read-from-string (concat "(" vals ")"))))
14983 (setq vals (mapcar (lambda (x)
14984 (cond ((stringp x) x)
14985 ((numberp x) (number-to-string x))
14986 ((symbolp x) (symbol-name x))
14987 (t "???")))
14988 vals)))))
14989 (when (member ":ETC" vals)
14990 (setq vals (remove ":ETC" vals))
14991 (org-add-props (car vals) '(org-unrestricted t)))
14992 (if table (mapcar 'list vals) vals)))
14994 (defun org-property-previous-allowed-value (&optional previous)
14995 "Switch to the next allowed value for this property."
14996 (interactive)
14997 (org-property-next-allowed-value t))
14999 (defun org-property-next-allowed-value (&optional previous)
15000 "Switch to the next allowed value for this property."
15001 (interactive)
15002 (unless (org-at-property-p)
15003 (error "Not at a property"))
15004 (let* ((key (match-string 2))
15005 (value (match-string 3))
15006 (allowed (or (org-property-get-allowed-values (point) key)
15007 (and (member value '("[ ]" "[-]" "[X]"))
15008 '("[ ]" "[X]"))))
15009 nval)
15010 (unless allowed
15011 (error "Allowed values for this property have not been defined"))
15012 (if previous (setq allowed (reverse allowed)))
15013 (if (member value allowed)
15014 (setq nval (car (cdr (member value allowed)))))
15015 (setq nval (or nval (car allowed)))
15016 (if (equal nval value)
15017 (error "Only one allowed value for this property"))
15018 (org-at-property-p)
15019 (replace-match (concat " :" key ": " nval) t t)
15020 (org-indent-line)
15021 (beginning-of-line 1)
15023 (run-hook-with-args 'org-property-changed-functions key nval)))
15025 (defun org-find-olp (path &optional this-buffer)
15026 "Return a marker pointing to the entry at outline path OLP.
15027 If anything goes wrong, throw an error.
15028 You can wrap this call to catch the error like this:
15030 (condition-case msg
15031 (org-mobile-locate-entry (match-string 4))
15032 (error (nth 1 msg)))
15034 The return value will then be either a string with the error message,
15035 or a marker if everything is OK.
15037 If THIS-BUFFER is set, the outline path does not contain a file,
15038 only headings."
15039 (let* ((file (if this-buffer buffer-file-name (pop path)))
15040 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15041 (level 1)
15042 (lmin 1)
15043 (lmax 1)
15044 limit re end found pos heading cnt flevel)
15045 (unless buffer (error "File not found :%s" file))
15046 (with-current-buffer buffer
15047 (save-excursion
15048 (save-restriction
15049 (widen)
15050 (setq limit (point-max))
15051 (goto-char (point-min))
15052 (while (setq heading (pop path))
15053 (setq re (format org-complex-heading-regexp-format
15054 (regexp-quote heading)))
15055 (setq cnt 0 pos (point))
15056 (while (re-search-forward re end t)
15057 (setq level (- (match-end 1) (match-beginning 1)))
15058 (if (and (>= level lmin) (<= level lmax))
15059 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15060 (when (= cnt 0) (error "Heading not found on level %d: %s"
15061 lmax heading))
15062 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15063 lmax heading))
15064 (goto-char found)
15065 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15066 (setq end (save-excursion (org-end-of-subtree t t))))
15067 (when (org-at-heading-p)
15068 (point-marker)))))))
15070 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15071 "Find node HEADING in BUFFER.
15072 Return a marker to the heading if it was found, or nil if not.
15073 If POS-ONLY is set, return just the position instead of a marker.
15075 The heading text must match exact, but it may have a TODO keyword,
15076 a priority cookie and tags in the standard locations."
15077 (with-current-buffer (or buffer (current-buffer))
15078 (save-excursion
15079 (save-restriction
15080 (widen)
15081 (goto-char (point-min))
15082 (let (case-fold-search)
15083 (if (re-search-forward
15084 (format org-complex-heading-regexp-format
15085 (regexp-quote heading)) nil t)
15086 (if pos-only
15087 (match-beginning 0)
15088 (move-marker (make-marker) (match-beginning 0)))))))))
15090 (defun org-find-exact-heading-in-directory (heading &optional dir)
15091 "Find Org node headline HEADING in all .org files in directory DIR.
15092 When the target headline is found, return a marker to this location."
15093 (let ((files (directory-files (or dir default-directory)
15095 file visiting m buffer)
15096 (catch 'found
15097 (while (setq file (pop files))
15098 (message "trying %s" file)
15099 (setq visiting (org-find-base-buffer-visiting file))
15100 (setq buffer (or visiting (find-file-noselect file)))
15101 (setq m (org-find-exact-headline-in-buffer
15102 heading buffer))
15103 (when (and (not m) (not visiting)) (kill-buffer buffer))
15104 (and m (throw 'found m))))))
15106 (defun org-find-entry-with-id (ident)
15107 "Locate the entry that contains the ID property with exact value IDENT.
15108 IDENT can be a string, a symbol or a number, this function will search for
15109 the string representation of it.
15110 Return the position where this entry starts, or nil if there is no such entry."
15111 (interactive "sID: ")
15112 (let ((id (cond
15113 ((stringp ident) ident)
15114 ((symbol-name ident) (symbol-name ident))
15115 ((numberp ident) (number-to-string ident))
15116 (t (error "IDENT %s must be a string, symbol or number" ident))))
15117 (case-fold-search nil))
15118 (save-excursion
15119 (save-restriction
15120 (widen)
15121 (goto-char (point-min))
15122 (when (re-search-forward
15124 nil t)
15125 (org-back-to-heading t)
15126 (point))))))
15128 ;;;; Timestamps
15130 (defvar org-last-changed-timestamp nil)
15131 (defvar org-last-inserted-timestamp nil
15132 "The last time stamp inserted with `org-insert-time-stamp'.")
15133 (defvar org-time-was-given) ; dynamically scoped parameter
15134 (defvar org-end-time-was-given) ; dynamically scoped parameter
15135 (defvar org-ts-what) ; dynamically scoped parameter
15137 (defun org-time-stamp (arg &optional inactive)
15138 "Prompt for a date/time and insert a time stamp.
15139 If the user specifies a time like HH:MM or if this command is
15140 called with at least one prefix argument, the time stamp contains
15141 the date and the time. Otherwise, only the date is be included.
15143 All parts of a date not specified by the user is filled in from
15144 the current date/time. So if you just press return without
15145 typing anything, the time stamp will represent the current
15146 date/time.
15148 If there is already a timestamp at the cursor, it will be
15149 modified.
15151 With two universal prefix arguments, insert an active timestamp
15152 with the current time without prompting the user."
15153 (interactive "P")
15154 (let* ((ts nil)
15155 (default-time
15156 ;; Default time is either today, or, when entering a range,
15157 ;; the range start.
15158 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15159 (save-excursion
15160 (re-search-backward
15162 (- (point) 20) t)))
15163 (apply 'encode-time (org-parse-time-string (match-string 1)))
15164 (current-time)))
15165 (default-input (and ts (org-get-compact-tod ts)))
15166 (repeater (save-excursion
15167 (save-match-data
15168 (beginning-of-line)
15169 (when (re-search-forward
15171 (save-excursion (progn (end-of-line) (point))) t)
15172 (match-string 0)))))
15173 org-time-was-given org-end-time-was-given time)
15174 (cond
15175 ((and (org-at-timestamp-p t)
15176 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15177 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15178 (insert "--")
15179 (setq time (let ((this-command this-command))
15180 (org-read-date arg 'totime nil nil
15181 default-time default-input inactive)))
15182 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15183 ((org-at-timestamp-p t)
15184 (setq time (let ((this-command this-command))
15185 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15186 (when (org-at-timestamp-p t) ; just to get the match data
15187 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15188 (replace-match "")
15189 (setq org-last-changed-timestamp
15190 (org-insert-time-stamp
15191 time (or org-time-was-given arg)
15192 inactive nil nil (list org-end-time-was-given)))
15193 (when repeater (goto-char (1- (point))) (insert " " repeater)
15194 (setq org-last-changed-timestamp
15195 (concat (substring org-last-inserted-timestamp 0 -1)
15196 " " repeater ">"))))
15197 (message "Timestamp updated"))
15198 ((equal arg '(16))
15199 (org-insert-time-stamp (current-time) t))
15200 (t
15201 (setq time (let ((this-command this-command))
15202 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15203 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15204 nil nil (list org-end-time-was-given))))))
15206 ;; FIXME: can we use this for something else, like computing time differences?
15207 (defun org-get-compact-tod (s)
15208 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15209 (let* ((t1 (match-string 1 s))
15210 (h1 (string-to-number (match-string 2 s)))
15211 (m1 (string-to-number (match-string 3 s)))
15212 (t2 (and (match-end 4) (match-string 5 s)))
15213 (h2 (and t2 (string-to-number (match-string 6 s))))
15214 (m2 (and t2 (string-to-number (match-string 7 s))))
15215 dh dm)
15216 (if (not t2)
15217 t1
15218 (setq dh (- h2 h1) dm (- m2 m1))
15219 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15220 (concat t1 "+" (number-to-string dh)
15221 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15223 (defun org-time-stamp-inactive (&optional arg)
15224 "Insert an inactive time stamp.
15225 An inactive time stamp is enclosed in square brackets instead of angle
15226 brackets. It is inactive in the sense that it does not trigger agenda entries,
15227 does not link to the calendar and cannot be changed with the S-cursor keys.
15228 So these are more for recording a certain time/date."
15229 (interactive "P")
15230 (org-time-stamp arg 'inactive))
15232 (defvar org-date-ovl (make-overlay 1 1))
15233 (overlay-put org-date-ovl 'face 'org-date-selected)
15234 (org-detach-overlay org-date-ovl)
15236 (defvar org-ans1) ; dynamically scoped parameter
15237 (defvar org-ans2) ; dynamically scoped parameter
15239 (defvar org-plain-time-of-day-regexp) ; defined below
15241 (defvar org-overriding-default-time nil) ; dynamically scoped
15242 (defvar org-read-date-overlay nil)
15243 (defvar org-dcst nil) ; dynamically scoped
15244 (defvar org-read-date-history nil)
15245 (defvar org-read-date-final-answer nil)
15246 (defvar org-read-date-analyze-futurep nil)
15247 (defvar org-read-date-analyze-forced-year nil)
15248 (defvar org-read-date-inactive)
15250 (defun org-read-date (&optional org-with-time to-time from-string prompt
15251 default-time default-input inactive)
15252 "Read a date, possibly a time, and make things smooth for the user.
15253 The prompt will suggest to enter an ISO date, but you can also enter anything
15254 which will at least partially be understood by `parse-time-string'.
15255 Unrecognized parts of the date will default to the current day, month, year,
15256 hour and minute. If this command is called to replace a timestamp at point,
15257 or to enter the second timestamp of a range, the default time is taken
15258 from the existing stamp. Furthermore, the command prefers the future,
15259 so if you are giving a date where the year is not given, and the day-month
15260 combination is already past in the current year, it will assume you
15261 mean next year. For details, see the manual. A few examples:
15263 3-2-5 --> 2003-02-05
15264 feb 15 --> currentyear-02-15
15265 2/15 --> currentyear-02-15
15266 sep 12 9 --> 2009-09-12
15267 12:45 --> today 12:45
15268 22 sept 0:34 --> currentyear-09-22 0:34
15269 12 --> currentyear-currentmonth-12
15270 Fri --> nearest Friday (today or later)
15271 etc.
15273 Furthermore you can specify a relative date by giving, as the *first* thing
15274 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15275 change in days weeks, months, years.
15276 With a single plus or minus, the date is relative to today. With a double
15277 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15278 +4d --> four days from today
15279 +4 --> same as above
15280 +2w --> two weeks from today
15281 ++5 --> five days from default date
15283 The function understands only English month and weekday abbreviations.
15285 While prompting, a calendar is popped up - you can also select the
15286 date with the mouse (button 1). The calendar shows a period of three
15287 months. To scroll it to other months, use the keys `>' and `<'.
15288 If you don't like the calendar, turn it off with
15289 \(setq org-read-date-popup-calendar nil)
15291 With optional argument TO-TIME, the date will immediately be converted
15292 to an internal time.
15293 With an optional argument ORG-WITH-TIME, the prompt will suggest to
15294 also insert a time. Note that when ORG-WITH-TIME is not set, you can
15295 still enter a time, and this function will inform the calling routine
15296 about this change. The calling routine may then choose to change the
15297 format used to insert the time stamp into the buffer to include the time.
15298 With optional argument FROM-STRING, read from this string instead from
15299 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15300 the time/date that is used for everything that is not specified by the
15301 user."
15302 (require 'parse-time)
15303 (let* ((org-time-stamp-rounding-minutes
15304 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15305 (org-dcst org-display-custom-times)
15306 (ct (org-current-time))
15307 (org-def (or org-overriding-default-time default-time ct))
15308 (org-defdecode (decode-time org-def))
15309 (dummy (progn
15310 (when (< (nth 2 org-defdecode) org-extend-today-until)
15311 (setcar (nthcdr 2 org-defdecode) -1)
15312 (setcar (nthcdr 1 org-defdecode) 59)
15313 (setq org-def (apply 'encode-time org-defdecode)
15314 org-defdecode (decode-time org-def)))))
15315 (calendar-frame-setup nil)
15316 (calendar-setup nil)
15317 (calendar-move-hook nil)
15318 (calendar-view-diary-initially-flag nil)
15319 (calendar-view-holidays-initially-flag nil)
15320 (timestr (format-time-string
15321 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15322 (prompt (concat (if prompt (concat prompt " ") "")
15323 (format "Date+time [%s]: " timestr)))
15324 ans (org-ans0 "") org-ans1 org-ans2 final)
15326 (cond
15327 (from-string (setq ans from-string))
15328 (org-read-date-popup-calendar
15329 (save-excursion
15330 (save-window-excursion
15331 (calendar)
15332 (org-eval-in-calendar '(setq cursor-type nil) t)
15333 (unwind-protect
15334 (progn
15335 (calendar-forward-day (- (time-to-days org-def)
15336 (calendar-absolute-from-gregorian
15337 (calendar-current-date))))
15338 (org-eval-in-calendar nil t)
15339 (let* ((old-map (current-local-map))
15340 (map (copy-keymap calendar-mode-map))
15341 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15342 (org-defkey map (kbd "RET") 'org-calendar-select)
15343 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15344 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15345 (org-defkey minibuffer-local-map [(meta shift left)]
15346 (lambda () (interactive)
15347 (org-eval-in-calendar '(calendar-backward-month 1))))
15348 (org-defkey minibuffer-local-map [(meta shift right)]
15349 (lambda () (interactive)
15350 (org-eval-in-calendar '(calendar-forward-month 1))))
15351 (org-defkey minibuffer-local-map [(meta shift up)]
15352 (lambda () (interactive)
15353 (org-eval-in-calendar '(calendar-backward-year 1))))
15354 (org-defkey minibuffer-local-map [(meta shift down)]
15355 (lambda () (interactive)
15356 (org-eval-in-calendar '(calendar-forward-year 1))))
15357 (org-defkey minibuffer-local-map [?\e (shift left)]
15358 (lambda () (interactive)
15359 (org-eval-in-calendar '(calendar-backward-month 1))))
15360 (org-defkey minibuffer-local-map [?\e (shift right)]
15361 (lambda () (interactive)
15362 (org-eval-in-calendar '(calendar-forward-month 1))))
15363 (org-defkey minibuffer-local-map [?\e (shift up)]
15364 (lambda () (interactive)
15365 (org-eval-in-calendar '(calendar-backward-year 1))))
15366 (org-defkey minibuffer-local-map [?\e (shift down)]
15367 (lambda () (interactive)
15368 (org-eval-in-calendar '(calendar-forward-year 1))))
15369 (org-defkey minibuffer-local-map [(shift up)]
15370 (lambda () (interactive)
15371 (org-eval-in-calendar '(calendar-backward-week 1))))
15372 (org-defkey minibuffer-local-map [(shift down)]
15373 (lambda () (interactive)
15374 (org-eval-in-calendar '(calendar-forward-week 1))))
15375 (org-defkey minibuffer-local-map [(shift left)]
15376 (lambda () (interactive)
15377 (org-eval-in-calendar '(calendar-backward-day 1))))
15378 (org-defkey minibuffer-local-map [(shift right)]
15379 (lambda () (interactive)
15380 (org-eval-in-calendar '(calendar-forward-day 1))))
15381 (org-defkey minibuffer-local-map ">"
15382 (lambda () (interactive)
15383 (org-eval-in-calendar '(scroll-calendar-left 1))))
15384 (org-defkey minibuffer-local-map "<"
15385 (lambda () (interactive)
15386 (org-eval-in-calendar '(scroll-calendar-right 1))))
15387 (org-defkey minibuffer-local-map "\C-v"
15388 (lambda () (interactive)
15389 (org-eval-in-calendar
15390 '(calendar-scroll-left-three-months 1))))
15391 (org-defkey minibuffer-local-map "\M-v"
15392 (lambda () (interactive)
15393 (org-eval-in-calendar
15394 '(calendar-scroll-right-three-months 1))))
15395 (run-hooks 'org-read-date-minibuffer-setup-hook)
15396 (unwind-protect
15397 (progn
15398 (use-local-map map)
15399 (setq org-read-date-inactive inactive)
15400 (add-hook 'post-command-hook 'org-read-date-display)
15401 (setq org-ans0 (read-string prompt default-input
15402 'org-read-date-history nil))
15403 ;; org-ans0: from prompt
15404 ;; org-ans1: from mouse click
15405 ;; org-ans2: from calendar motion
15406 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15407 (remove-hook 'post-command-hook 'org-read-date-display)
15408 (use-local-map old-map)
15409 (when org-read-date-overlay
15410 (delete-overlay org-read-date-overlay)
15411 (setq org-read-date-overlay nil)))))
15412 (bury-buffer "*Calendar*")))))
15414 (t ; Naked prompt only
15415 (unwind-protect
15416 (setq ans (read-string prompt default-input
15417 'org-read-date-history timestr))
15418 (when org-read-date-overlay
15419 (delete-overlay org-read-date-overlay)
15420 (setq org-read-date-overlay nil)))))
15422 (setq final (org-read-date-analyze ans org-def org-defdecode))
15424 (when org-read-date-analyze-forced-year
15425 (message "Year was forced into %s"
15426 (if org-read-date-force-compatible-dates
15427 "compatible range (1970-2037)"
15428 "range representable on this machine"))
15429 (ding))
15431 ;; One round trip to get rid of 34th of August and stuff like that....
15432 (setq final (decode-time (apply 'encode-time final)))
15434 (setq org-read-date-final-answer ans)
15436 (if to-time
15437 (apply 'encode-time final)
15438 (if (and (boundp 'org-time-was-given) org-time-was-given)
15439 (format "%04d-%02d-%02d %02d:%02d"
15440 (nth 5 final) (nth 4 final) (nth 3 final)
15441 (nth 2 final) (nth 1 final))
15442 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15444 (defvar org-def)
15445 (defvar org-defdecode)
15446 (defvar org-with-time)
15447 (defun org-read-date-display ()
15448 "Display the current date prompt interpretation in the minibuffer."
15449 (when org-read-date-display-live
15450 (when org-read-date-overlay
15451 (delete-overlay org-read-date-overlay))
15452 (when (minibufferp (current-buffer))
15453 (save-excursion
15454 (end-of-line 1)
15455 (while (not (equal (buffer-substring
15456 (max (point-min) (- (point) 4)) (point))
15457 " "))
15458 (insert " ")))
15459 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15460 " " (or org-ans1 org-ans2)))
15461 (org-end-time-was-given nil)
15462 (f (org-read-date-analyze ans org-def org-defdecode))
15463 (fmts (if org-dcst
15464 org-time-stamp-custom-formats
15465 org-time-stamp-formats))
15466 (fmt (if (or org-with-time
15467 (and (boundp 'org-time-was-given) org-time-was-given))
15468 (cdr fmts)
15469 (car fmts)))
15470 (txt (format-time-string fmt (apply 'encode-time f)))
15471 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15472 (txt (concat "=> " txt)))
15473 (when (and org-end-time-was-given
15474 (string-match org-plain-time-of-day-regexp txt))
15475 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15476 org-end-time-was-given
15477 (substring txt (match-end 0)))))
15478 (when org-read-date-analyze-futurep
15479 (setq txt (concat txt " (=>F)")))
15480 (setq org-read-date-overlay
15481 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15482 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
15484 (defun org-read-date-analyze (ans org-def org-defdecode)
15485 "Analyze the combined answer of the date prompt."
15486 ;; FIXME: cleanup and comment
15487 (let ((nowdecode (decode-time (current-time)))
15488 delta deltan deltaw deltadef year month day
15489 hour minute second wday pm h2 m2 tl wday1
15490 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15491 (setq org-read-date-analyze-futurep nil
15492 org-read-date-analyze-forced-year nil)
15494 (setq ans "+0"))
15496 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15497 (setq ans (replace-match "" t t ans)
15498 deltan (car delta)
15499 deltaw (nth 1 delta)
15500 deltadef (nth 2 delta)))
15502 ;; Check if there is an iso week date in there. If yes, store the
15503 ;; info and postpone interpreting it until the rest of the parsing
15504 ;; is done.
15505 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15506 (setq iso-year (if (match-end 1)
15507 (org-small-year-to-year
15508 (string-to-number (match-string 1 ans))))
15509 iso-weekday (if (match-end 3)
15510 (string-to-number (match-string 3 ans)))
15511 iso-week (string-to-number (match-string 2 ans)))
15512 (setq ans (replace-match "" t t ans)))
15514 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15515 (when (string-match
15517 (setq year (if (match-end 2)
15518 (string-to-number (match-string 2 ans))
15519 (progn (setq kill-year t)
15520 (string-to-number (format-time-string "%Y"))))
15521 month (string-to-number (match-string 3 ans))
15522 day (string-to-number (match-string 4 ans)))
15523 (if (< year 100) (setq year (+ 2000 year)))
15525 t nil ans)))
15527 ;; Help matching dotted european dates
15528 (when (string-match
15529 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
15530 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
15531 (setq kill-year t)
15532 (string-to-number (format-time-string "%Y")))
15533 day (string-to-number (match-string 1 ans))
15534 month (string-to-number (match-string 2 ans))
15535 ans (replace-match (format "%04d-%02d-%02d" year month day)
15536 t nil ans)))
15538 ;; Help matching american dates, like 5/30 or 5/30/7
15539 (when (string-match
15540 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15541 (setq year (if (match-end 4)
15542 (string-to-number (match-string 4 ans))
15543 (progn (setq kill-year t)
15544 (string-to-number (format-time-string "%Y"))))
15545 month (string-to-number (match-string 1 ans))
15546 day (string-to-number (match-string 2 ans)))
15547 (if (< year 100) (setq year (+ 2000 year)))
15549 t nil ans)))
15550 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15551 ;; If there is a time with am/pm, and *no* time without it, we convert
15552 ;; so that matching will be successful.
15553 (loop for i from 1 to 2 do ; twice, for end time as well
15556 (setq hour (string-to-number (match-string 1 ans))
15557 minute (if (match-end 3)
15558 (string-to-number (match-string 3 ans))
15559 0)
15560 pm (equal ?p
15561 (string-to-char (downcase (match-string 4 ans)))))
15562 (if (and (= hour 12) (not pm))
15563 (setq hour 0)
15564 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15565 (setq ans (replace-match (format "%02d:%02d" hour minute)
15566 t t ans))))
15568 ;; Check if a time range is given as a duration
15569 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15570 (setq hour (string-to-number (match-string 1 ans))
15571 h2 (+ hour (string-to-number (match-string 3 ans)))
15572 minute (string-to-number (match-string 2 ans))
15573 m2 (+ minute (if (match-end 5) (string-to-number
15574 (match-string 5 ans))0)))
15575 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15576 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15577 t t ans)))
15579 ;; Check if there is a time range
15580 (when (boundp 'org-end-time-was-given)
15581 (setq org-time-was-given nil)
15582 (when (and (string-match org-plain-time-of-day-regexp ans)
15583 (match-end 8))
15584 (setq org-end-time-was-given (match-string 8 ans))
15585 (setq ans (concat (substring ans 0 (match-beginning 7))
15586 (substring ans (match-end 7))))))
15588 (setq tl (parse-time-string ans)
15589 day (or (nth 3 tl) (nth 3 org-defdecode))
15590 month (or (nth 4 tl)
15591 (if (and org-read-date-prefer-future
15592 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15593 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15594 (nth 4 org-defdecode)))
15595 year (or (and (not kill-year) (nth 5 tl))
15596 (if (and org-read-date-prefer-future
15597 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15598 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15599 (nth 5 org-defdecode)))
15600 hour (or (nth 2 tl) (nth 2 org-defdecode))
15601 minute (or (nth 1 tl) (nth 1 org-defdecode))
15602 second (or (nth 0 tl) 0)
15603 wday (nth 6 tl))
15605 (when (and (eq org-read-date-prefer-future 'time)
15606 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15607 (equal day (nth 3 nowdecode))
15608 (equal month (nth 4 nowdecode))
15609 (equal year (nth 5 nowdecode))
15610 (nth 2 tl)
15611 (or (< (nth 2 tl) (nth 2 nowdecode))
15612 (and (= (nth 2 tl) (nth 2 nowdecode))
15613 (nth 1 tl)
15614 (< (nth 1 tl) (nth 1 nowdecode)))))
15615 (setq day (1+ day)
15616 futurep t))
15618 ;; Special date definitions below
15619 (cond
15620 (iso-week
15621 ;; There was an iso week
15622 (require 'cal-iso)
15623 (setq futurep nil)
15624 (setq year (or iso-year year)
15625 day (or iso-weekday wday 1)
15626 wday nil ; to make sure that the trigger below does not match
15627 iso-date (calendar-gregorian-from-absolute
15628 (calendar-absolute-from-iso
15629 (list iso-week day year))))
15630 ; FIXME: Should we also push ISO weeks into the future?
15631 ; (when (and org-read-date-prefer-future
15632 ; (not iso-year)
15633 ; (< (calendar-absolute-from-gregorian iso-date)
15634 ; (time-to-days (current-time))))
15635 ; (setq year (1+ year)
15636 ; iso-date (calendar-gregorian-from-absolute
15637 ; (calendar-absolute-from-iso
15638 ; (list iso-week day year)))))
15639 (setq month (car iso-date)
15640 year (nth 2 iso-date)
15641 day (nth 1 iso-date)))
15642 (deltan
15643 (setq futurep nil)
15644 (unless deltadef
15645 (let ((now (decode-time (current-time))))
15646 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15647 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15648 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15649 ((equal deltaw "m") (setq month (+ month deltan)))
15650 ((equal deltaw "y") (setq year (+ year deltan)))))
15651 ((and wday (not (nth 3 tl)))
15652 ;; Weekday was given, but no day, so pick that day in the week
15653 ;; on or after the derived date.
15654 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15655 (unless (equal wday wday1)
15656 (setq day (+ day (% (- wday wday1 -7) 7))))))
15657 (if (and (boundp 'org-time-was-given)
15658 (nth 2 tl))
15659 (setq org-time-was-given t))
15660 (if (< year 100) (setq year (+ 2000 year)))
15661 ;; Check of the date is representable
15662 (if org-read-date-force-compatible-dates
15663 (progn
15664 (if (< year 1970)
15665 (setq year 1970 org-read-date-analyze-forced-year t))
15666 (if (> year 2037)
15667 (setq year 2037 org-read-date-analyze-forced-year t)))
15668 (condition-case nil
15669 (ignore (encode-time second minute hour day month year))
15670 (error
15671 (setq year (nth 5 org-defdecode))
15672 (setq org-read-date-analyze-forced-year t))))
15673 (setq org-read-date-analyze-futurep futurep)
15674 (list second minute hour day month year)))
15676 (defvar parse-time-weekdays)
15677 (defun org-read-date-get-relative (s today default)
15678 "Check string S for special relative date string.
15679 TODAY and DEFAULT are internal times, for today and for a default.
15680 Return shift list (N what def-flag)
15682 N is the number of WHATs to shift.
15683 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15684 the DEFAULT date rather than TODAY."
15685 (require 'parse-time)
15686 (when (and
15687 (string-match
15688 (concat
15693 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15694 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15695 (string-to-char (substring (match-string 1 s) -1))
15696 ?+))
15697 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15698 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15699 (what (if (match-end 3) (match-string 3 s) "d"))
15700 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15701 (date (if rel default today))
15702 (wday (nth 6 (decode-time date)))
15703 delta)
15704 (if wday1
15705 (progn
15706 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15707 (if (= dir ?-) (setq delta (- delta 7)))
15708 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15709 (list delta "d" rel))
15710 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15712 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15713 "Turn a user-specified date into the internal representation.
15714 The internal representation needed by the calendar is (month day year).
15715 This is a wrapper to handle the brain-dead convention in calendar that
15716 user function argument order change dependent on argument order."
15717 (if (boundp 'calendar-date-style)
15718 (cond
15719 ((eq calendar-date-style 'american)
15720 (list arg1 arg2 arg3))
15721 ((eq calendar-date-style 'european)
15722 (list arg2 arg1 arg3))
15723 ((eq calendar-date-style 'iso)
15724 (list arg2 arg3 arg1)))
15725 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15726 (if (org-bound-and-true-p european-calendar-style)
15727 (list arg2 arg1 arg3)
15728 (list arg1 arg2 arg3)))))
15730 (defun org-eval-in-calendar (form &optional keepdate)
15731 "Eval FORM in the calendar window and return to current window.
15732 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
15733 otherwise stick to the current value of `org-ans2'."
15734 (let ((sf (selected-frame))
15735 (sw (selected-window)))
15736 (select-window (get-buffer-window "*Calendar*" t))
15737 (eval form)
15738 (when (and (not keepdate) (calendar-cursor-to-date))
15739 (let* ((date (calendar-cursor-to-date))
15740 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15741 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15742 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15743 (select-window sw)
15744 (org-select-frame-set-input-focus sf)))
15746 (defun org-calendar-select ()
15747 "Return to `org-read-date' with the date currently selected.
15748 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15749 (interactive)
15750 (when (calendar-cursor-to-date)
15751 (let* ((date (calendar-cursor-to-date))
15752 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15753 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15754 (if (active-minibuffer-window) (exit-minibuffer))))
15756 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15757 "Insert a date stamp for the date given by the internal TIME.
15758 WITH-HM means use the stamp format that includes the time of the day.
15759 INACTIVE means use square brackets instead of angular ones, so that the
15760 stamp will not contribute to the agenda.
15761 PRE and POST are optional strings to be inserted before and after the
15762 stamp.
15763 The command returns the inserted time stamp."
15764 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15765 stamp)
15766 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15767 (insert-before-markers (or pre ""))
15768 (when (listp extra)
15769 (setq extra (car extra))
15770 (if (and (stringp extra)
15772 (setq extra (format "-%02d:%02d"
15773 (string-to-number (match-string 1 extra))
15774 (string-to-number (match-string 2 extra))))
15775 (setq extra nil)))
15776 (when extra
15777 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15778 (insert-before-markers (setq stamp (format-time-string fmt time)))
15779 (insert-before-markers (or post ""))
15780 (setq org-last-inserted-timestamp stamp)))
15782 (defun org-toggle-time-stamp-overlays ()
15783 "Toggle the use of custom time stamp formats."
15784 (interactive)
15785 (setq org-display-custom-times (not org-display-custom-times))
15786 (unless org-display-custom-times
15787 (let ((p (point-min)) (bmp (buffer-modified-p)))
15788 (while (setq p (next-single-property-change p 'display))
15789 (if (and (get-text-property p 'display)
15790 (eq (get-text-property p 'face) 'org-date))
15791 (remove-text-properties
15792 p (setq p (next-single-property-change p 'display))
15793 '(display t))))
15794 (set-buffer-modified-p bmp)))
15795 (if (featurep 'xemacs)
15796 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15797 (org-restart-font-lock)
15798 (setq org-table-may-need-update t)
15799 (if org-display-custom-times
15800 (message "Time stamps are overlaid with custom format")
15801 (message "Time stamp overlays removed")))
15803 (defun org-display-custom-time (beg end)
15804 "Overlay modified time stamp format over timestamp between BEG and END."
15805 (let* ((ts (buffer-substring beg end))
15806 t1 w1 with-hm tf time str w2 (off 0))
15807 (save-match-data
15808 (setq t1 (org-parse-time-string ts t))
15809 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
15810 (setq off (- (match-end 0) (match-beginning 0)))))
15811 (setq end (- end off))
15812 (setq w1 (- end beg)
15813 with-hm (and (nth 1 t1) (nth 2 t1))
15814 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15815 time (org-fix-decoded-time t1)
15816 str (org-add-props
15817 (format-time-string
15818 (substring tf 1 -1) (apply 'encode-time time))
15819 nil 'mouse-face 'highlight)
15820 w2 (length str))
15821 (if (not (= w2 w1))
15822 (add-text-properties (1+ beg) (+ 2 beg)
15823 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15824 (if (featurep 'xemacs)
15825 (progn
15826 (put-text-property beg end 'invisible t)
15827 (put-text-property beg end 'end-glyph (make-glyph str)))
15828 (put-text-property beg end 'display str))))
15830 (defun org-translate-time (string)
15831 "Translate all timestamps in STRING to custom format.
15832 But do this only if the variable `org-display-custom-times' is set."
15833 (when org-display-custom-times
15834 (save-match-data
15835 (let* ((start 0)
15836 (re org-ts-regexp-both)
15837 t1 with-hm inactive tf time str beg end)
15838 (while (setq start (string-match re string start))
15839 (setq beg (match-beginning 0)
15840 end (match-end 0)
15841 t1 (save-match-data
15842 (org-parse-time-string (substring string beg end) t))
15843 with-hm (and (nth 1 t1) (nth 2 t1))
15844 inactive (equal (substring string beg (1+ beg)) "[")
15845 tf (funcall (if with-hm 'cdr 'car)
15846 org-time-stamp-custom-formats)
15847 time (org-fix-decoded-time t1)
15848 str (format-time-string
15849 (concat
15850 (if inactive "[" "<") (substring tf 1 -1)
15851 (if inactive "]" ">"))
15852 (apply 'encode-time time))
15853 string (replace-match str t t string)
15854 start (+ start (length str)))))))
15855 string)
15857 (defun org-fix-decoded-time (time)
15858 "Set 0 instead of nil for the first 6 elements of time.
15859 Don't touch the rest."
15860 (let ((n 0))
15861 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15863 (defun org-days-to-time (timestamp-string)
15864 "Difference between TIMESTAMP-STRING and now in days."
15865 (- (time-to-days (org-time-string-to-time timestamp-string))
15866 (time-to-days (current-time))))
15868 (defun org-deadline-close (timestamp-string &optional ndays)
15869 "Is the time in TIMESTAMP-STRING close to the current date?"
15870 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15871 (and (< (org-days-to-time timestamp-string) ndays)
15872 (not (org-entry-is-done-p))))
15874 (defun org-get-wdays (ts)
15875 "Get the deadline lead time appropriate for timestring TS."
15876 (cond
15877 ((<= org-deadline-warning-days 0)
15878 ;; 0 or negative, enforce this value no matter what
15879 (- org-deadline-warning-days))
15881 ;; lead time is specified.
15882 (floor (* (string-to-number (match-string 1 ts))
15883 (cdr (assoc (match-string 2 ts)
15884 '(("d" . 1) ("w" . 7)
15885 ("m" . 30.4) ("y" . 365.25)))))))
15886 ;; go for the default.
15887 (t org-deadline-warning-days)))
15889 (defun org-calendar-select-mouse (ev)
15890 "Return to `org-read-date' with the date currently selected.
15891 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15892 (interactive "e")
15893 (mouse-set-point ev)
15894 (when (calendar-cursor-to-date)
15895 (let* ((date (calendar-cursor-to-date))
15896 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15897 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15898 (if (active-minibuffer-window) (exit-minibuffer))))
15900 (defun org-check-deadlines (ndays)
15901 "Check if there are any deadlines due or past due.
15902 A deadline is considered due if it happens within `org-deadline-warning-days'
15903 days from today's date. If the deadline appears in an entry marked DONE,
15904 it is not shown. The prefix arg NDAYS can be used to test that many
15906 (interactive "P")
15907 (let* ((org-warn-days
15908 (cond
15909 ((equal ndays '(4)) 100000)
15910 (ndays (prefix-numeric-value ndays))
15911 (t (abs org-deadline-warning-days))))
15912 (case-fold-search nil)
15914 (callback
15915 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15917 (message "%d deadlines past-due or due within %d days"
15918 (org-occur regexp nil callback)
15919 org-warn-days)))
15921 (defsubst org-re-timestamp (type)
15922 "Return a regexp for timestamp TYPE.
15923 Allowed values for TYPE are:
15925 all: all timestamps
15926 active: only active timestamps (<...>)
15927 inactive: only inactive timestamps ([...])
15928 scheduled: only scheduled timestamps
15929 deadline: only deadline timestamps
15931 When TYPE is nil, fall back on returning a regexp that matches
15932 both scheduled and deadline timestamps."
15933 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
15934 ((eq type 'active) org-ts-regexp)
15938 ((eq type 'scheduled-or-deadline)
15941 (defun org-check-before-date (date)
15942 "Check if there are deadlines or scheduled entries before DATE."
15943 (interactive (list (org-read-date)))
15944 (let ((case-fold-search nil)
15945 (regexp (org-re-timestamp org-ts-type))
15946 (callback
15947 (lambda () (time-less-p
15948 (org-time-string-to-time (match-string 1))
15949 (org-time-string-to-time date)))))
15950 (message "%d entries before %s"
15951 (org-occur regexp nil callback) date)))
15953 (defun org-check-after-date (date)
15954 "Check if there are deadlines or scheduled entries after DATE."
15955 (interactive (list (org-read-date)))
15956 (let ((case-fold-search nil)
15957 (regexp (org-re-timestamp org-ts-type))
15958 (callback
15959 (lambda () (not
15960 (time-less-p
15961 (org-time-string-to-time (match-string 1))
15962 (org-time-string-to-time date))))))
15963 (message "%d entries after %s"
15964 (org-occur regexp nil callback) date)))
15966 (defun org-check-dates-range (start-date end-date)
15967 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15968 (interactive (list (org-read-date nil nil nil "Range starts")
15969 (org-read-date nil nil nil "Range end")))
15970 (let ((case-fold-search nil)
15971 (regexp (org-re-timestamp org-ts-type))
15972 (callback
15973 (lambda ()
15974 (let ((match (match-string 1)))
15975 (and
15976 (not (time-less-p
15977 (org-time-string-to-time match)
15978 (org-time-string-to-time start-date)))
15979 (time-less-p
15980 (org-time-string-to-time match)
15981 (org-time-string-to-time end-date)))))))
15982 (message "%d entries between %s and %s"
15983 (org-occur regexp nil callback) start-date end-date)))
15985 (defun org-evaluate-time-range (&optional to-buffer)
15986 "Evaluate a time range by computing the difference between start and end.
15987 Normally the result is just printed in the echo area, but with prefix arg
15988 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15989 If the time range is actually in a table, the result is inserted into the
15990 next column.
15991 For time difference computation, a year is assumed to be exactly 365
15992 days in order to avoid rounding problems."
15993 (interactive "P")
15994 (or
15995 (org-clock-update-time-maybe)
15996 (save-excursion
15997 (unless (org-at-date-range-p t)
15998 (goto-char (point-at-bol))
15999 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16000 (if (not (org-at-date-range-p t))
16001 (error "Not at a time-stamp range, and none found in current line")))
16002 (let* ((ts1 (match-string 1))
16003 (ts2 (match-string 2))
16004 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16005 (match-end (match-end 0))
16006 (time1 (org-time-string-to-time ts1))
16007 (time2 (org-time-string-to-time ts2))
16008 (t1 (org-float-time time1))
16009 (t2 (org-float-time time2))
16010 (diff (abs (- t2 t1)))
16011 (negative (< (- t2 t1) 0))
16012 ;; (ys (floor (* 365 24 60 60)))
16013 (ds (* 24 60 60))
16014 (hs (* 60 60))
16015 (fy "%dy %dd %02d:%02d")
16016 (fy1 "%dy %dd")
16017 (fd "%dd %02d:%02d")
16018 (fd1 "%dd")
16019 (fh "%02d:%02d")
16020 y d h m align)
16021 (if havetime
16022 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16023 y 0
16024 d (floor (/ diff ds)) diff (mod diff ds)
16025 h (floor (/ diff hs)) diff (mod diff hs)
16026 m (floor (/ diff 60)))
16027 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16028 y 0
16029 d (floor (+ (/ diff ds) 0.5))
16030 h 0 m 0))
16031 (if (not to-buffer)
16032 (message "%s" (org-make-tdiff-string y d h m))
16033 (if (org-at-table-p)
16034 (progn
16035 (goto-char match-end)
16036 (setq align t)
16037 (and (looking-at " *|") (goto-char (match-end 0))))
16038 (goto-char match-end))
16039 (if (looking-at
16041 (replace-match ""))
16042 (if negative (insert " -"))
16043 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16044 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16045 (insert " " (format fh h m))))
16046 (if align (org-table-align))
16047 (message "Time difference inserted")))))
16049 (defun org-make-tdiff-string (y d h m)
16050 (let ((fmt "")
16051 (l nil))
16052 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16053 l (push y l)))
16054 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16055 l (push d l)))
16056 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16057 l (push h l)))
16058 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16059 l (push m l)))
16060 (apply 'format fmt (nreverse l))))
16062 (defun org-time-string-to-time (s &optional buffer pos)
16063 "Convert a timestamp string into internal time."
16064 (condition-case errdata
16065 (apply 'encode-time (org-parse-time-string s))
16067 s (if (not (and buffer pos))
16068 ""
16069 (format " at %d in buffer `%s'" pos buffer))
16070 (cdr errdata)))))
16072 (defun org-time-string-to-seconds (s)
16073 "Convert a timestamp string to a number of seconds."
16074 (org-float-time (org-time-string-to-time s)))
16076 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16077 "Convert a time stamp to an absolute day number.
16078 If there is a specifier for a cyclic time stamp, get the closest date to
16079 DAYNR.
16080 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16081 The variable date is bound by the calendar when this is called."
16082 (cond
16084 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16085 daynr
16086 (+ daynr 1000)))
16088 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16089 (time-to-days (current-time))) (match-string 0 s)
16090 prefer show-all))
16091 (t (time-to-days
16092 (condition-case errdata
16093 (apply 'encode-time (org-parse-time-string s))
16095 s (if (not (and buffer pos))
16096 ""
16097 (format " at %d in buffer `%s'" pos buffer))
16098 (cdr errdata))))))))
16100 (defun org-days-to-iso-week (days)
16101 "Return the iso week number."
16102 (require 'cal-iso)
16103 (car (calendar-iso-from-absolute days)))
16105 (defun org-small-year-to-year (year)
16106 "Convert 2-digit years into 4-digit years.
16107 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16108 The year 2000 cannot be abbreviated. Any year larger than 99
16109 is returned unchanged."
16110 (if (< year 38)
16111 (setq year (+ 2000 year))
16112 (if (< year 100)
16113 (setq year (+ 1900 year))))
16114 year)
16116 (defun org-time-from-absolute (d)
16117 "Return the time corresponding to date D.
16118 D may be an absolute day number, or a calendar-type list (month day year)."
16119 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16120 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16122 (defun org-calendar-holiday ()
16123 "List of holidays, for Diary display in Org-mode."
16124 (require 'holidays)
16125 (let ((hl (funcall
16126 (if (fboundp 'calendar-check-holidays)
16127 'calendar-check-holidays 'check-calendar-holidays) date)))
16128 (if hl (mapconcat 'identity hl "; "))))
16130 (defun org-diary-sexp-entry (sexp entry date)
16131 "Process a SEXP diary ENTRY for DATE."
16132 (require 'diary-lib)
16133 (let ((result (if calendar-debug-sexp
16134 (let ((stack-trace-on-error t))
16135 (eval (car (read-from-string sexp))))
16136 (condition-case nil
16137 (eval (car (read-from-string sexp)))
16138 (error
16139 (beep)
16140 (message "Bad sexp at line %d in %s: %s"
16141 (org-current-line)
16142 (buffer-file-name) sexp)
16143 (sleep-for 2))))))
16144 (cond ((stringp result) (split-string result "; "))
16145 ((and (consp result)
16146 (not (consp (cdr result)))
16147 (stringp (cdr result))) (cdr result))
16148 ((and (consp result)
16149 (stringp (car result))) result)
16150 (result entry))))
16152 (defun org-diary-to-ical-string (frombuf)
16153 "Get iCalendar entries from diary entries in buffer FROMBUF.
16154 This uses the icalendar.el library."
16155 (let* ((tmpdir (if (featurep 'xemacs)
16156 (temp-directory)
16157 temporary-file-directory))
16158 (tmpfile (make-temp-name
16159 (expand-file-name "orgics" tmpdir)))
16160 buf rtn b e)
16161 (with-current-buffer frombuf
16162 (icalendar-export-region (point-min) (point-max) tmpfile)
16163 (setq buf (find-buffer-visiting tmpfile))
16164 (set-buffer buf)
16165 (goto-char (point-min))
16166 (if (re-search-forward "^BEGIN:VEVENT" nil t)
16167 (setq b (match-beginning 0)))
16168 (goto-char (point-max))
16169 (if (re-search-backward "^END:VEVENT" nil t)
16170 (setq e (match-end 0)))
16172 (kill-buffer buf)
16173 (delete-file tmpfile)
16174 rtn))
16176 (defun org-closest-date (start current change prefer show-all)
16177 "Find the date closest to CURRENT that is consistent with START and CHANGE.
16178 When PREFER is `past', return a date that is either CURRENT or past.
16179 When PREFER is `future', return a date that is either CURRENT or future.
16180 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
16181 ;; Make the proper lists from the dates
16182 (catch 'exit
16183 (let ((a1 '(("h" . hour)
16184 ("d" . day)
16185 ("w" . week)
16186 ("m" . month)
16187 ("y" . year)))
16188 (shour (nth 2 (org-parse-time-string start)))
16189 dn dw sday cday n1 n2 n0
16190 d m y y1 y2 date1 date2 nmonths nm ny m2)
16192 (setq start (org-date-to-gregorian start)
16193 current (org-date-to-gregorian
16194 (if show-all
16195 current
16196 (time-to-days (current-time))))
16197 sday (calendar-absolute-from-gregorian start)
16198 cday (calendar-absolute-from-gregorian current))
16200 (if (<= cday sday) (throw 'exit sday))
16203 (setq dn (string-to-number (match-string 1 change))
16204 dw (cdr (assoc (match-string 2 change) a1)))
16205 (error "Invalid change specifier: %s" change))
16206 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16207 (cond
16208 ((eq dw 'hour)
16209 (let ((missing-hours
16210 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
16211 dn)))
16212 (setq n1 (if (zerop missing-hours) cday
16213 (- cday (1+ (floor (/ missing-hours 24)))))
16214 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
16215 ((eq dw 'day)
16216 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16217 n2 (+ n1 dn)))
16218 ((eq dw 'year)
16219 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16220 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16221 (setq date1 (list m d y1)
16222 n1 (calendar-absolute-from-gregorian date1)
16223 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16224 n2 (calendar-absolute-from-gregorian date2)))
16225 ((eq dw 'month)
16226 ;; approx number of month between the two dates
16227 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16228 ;; How often does dn fit in there?
16229 (setq d (nth 1 start) m (car start) y (nth 2 start)
16230 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16231 m (+ m nm)
16232 ny (floor (/ m 12))
16233 y (+ y ny)
16234 m (- m (* ny 12)))
16235 (while (> m 12) (setq m (- m 12) y (1+ y)))
16236 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16237 (setq m2 (+ m dn) y2 y)
16238 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16239 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16240 (while (<= n2 cday)
16241 (setq n1 n2 m m2 y y2)
16242 (setq m2 (+ m dn) y2 y)
16243 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16244 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
16245 ;; Make sure n1 is the earlier date
16246 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16247 (if show-all
16248 (cond
16249 ((eq prefer 'past) (if (= cday n2) n2 n1))
16250 ((eq prefer 'future) (if (= cday n1) n1 n2))
16251 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16252 (cond
16253 ((eq prefer 'past) (if (= cday n2) n2 n1))
16254 ((eq prefer 'future) (if (= cday n1) n1 n2))
16255 (t (if (= cday n1) n1 n2)))))))
16257 (defun org-date-to-gregorian (date)
16258 "Turn any specification of DATE into a Gregorian date for the calendar."
16259 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16260 ((and (listp date) (= (length date) 3)) date)
16261 ((stringp date)
16262 (setq date (org-parse-time-string date))
16263 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16264 ((listp date)
16265 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16267 (defun org-parse-time-string (s &optional nodefault)
16268 "Parse the standard Org-mode time string.
16269 This should be a lot faster than the normal `parse-time-string'.
16270 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16271 hour and minute fields will be nil if not given."
16272 (if (string-match org-ts-regexp0 s)
16273 (list 0
16274 (if (or (match-beginning 8) (not nodefault))
16275 (string-to-number (or (match-string 8 s) "0")))
16276 (if (or (match-beginning 7) (not nodefault))
16277 (string-to-number (or (match-string 7 s) "0")))
16278 (string-to-number (match-string 4 s))
16279 (string-to-number (match-string 3 s))
16280 (string-to-number (match-string 2 s))
16281 nil nil nil)
16282 (error "Not a standard Org-mode time string: %s" s)))
16284 (defun org-timestamp-up (&optional arg)
16285 "Increase the date item at the cursor by one.
16286 If the cursor is on the year, change the year. If it is on the month,
16287 the day or the time, change that.
16288 With prefix ARG, change by that many units."
16289 (interactive "p")
16290 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16292 (defun org-timestamp-down (&optional arg)
16293 "Decrease the date item at the cursor by one.
16294 If the cursor is on the year, change the year. If it is on the month,
16295 the day or the time, change that.
16296 With prefix ARG, change by that many units."
16297 (interactive "p")
16298 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16300 (defun org-timestamp-up-day (&optional arg)
16301 "Increase the date in the time stamp by one day.
16302 With prefix ARG, change that many days."
16303 (interactive "p")
16304 (if (and (not (org-at-timestamp-p t))
16305 (org-at-heading-p))
16306 (org-todo 'up)
16307 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16309 (defun org-timestamp-down-day (&optional arg)
16310 "Decrease the date in the time stamp by one day.
16311 With prefix ARG, change that many days."
16312 (interactive "p")
16313 (if (and (not (org-at-timestamp-p t))
16314 (org-at-heading-p))
16315 (org-todo 'down)
16316 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16318 (defun org-at-timestamp-p (&optional inactive-ok)
16319 "Determine if the cursor is in or at a timestamp."
16320 (interactive)
16321 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16322 (pos (point))
16323 (ans (or (looking-at tsr)
16324 (save-excursion
16326 (if (> (point) (point-min)) (backward-char 1))
16327 (and (looking-at tsr)
16328 (> (- (match-end 0) pos) -1))))))
16329 (and ans
16330 (boundp 'org-ts-what)
16331 (setq org-ts-what
16332 (cond
16333 ((= pos (match-beginning 0)) 'bracket)
16334 ;; Point is considered to be "on the bracket" whether
16335 ;; it's really on it or right after it.
16336 ((= pos (1- (match-end 0))) 'bracket)
16337 ((= pos (match-end 0)) 'after)
16338 ((org-pos-in-match-range pos 2) 'year)
16339 ((org-pos-in-match-range pos 3) 'month)
16340 ((org-pos-in-match-range pos 7) 'hour)
16341 ((org-pos-in-match-range pos 8) 'minute)
16342 ((or (org-pos-in-match-range pos 4)
16343 (org-pos-in-match-range pos 5)) 'day)
16344 ((and (> pos (or (match-end 8) (match-end 5)))
16345 (< pos (match-end 0)))
16346 (- pos (or (match-end 8) (match-end 5))))
16347 (t 'day))))
16348 ans))
16350 (defun org-toggle-timestamp-type ()
16351 "Toggle the type (<active> or [inactive]) of a time stamp."
16352 (interactive)
16353 (when (org-at-timestamp-p t)
16354 (let ((beg (match-beginning 0)) (end (match-end 0))
16355 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16356 (save-excursion
16357 (goto-char beg)
16358 (while (re-search-forward "[][<>]" end t)
16359 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16360 t t)))
16361 (message "Timestamp is now %sactive"
16362 (if (equal (char-after beg) ?<) "" "in")))))
16364 (defvar org-clock-history) ; defined in org-clock.el
16365 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
16366 (defun org-timestamp-change (n &optional what updown)
16367 "Change the date in the time stamp at point.
16368 The date will be changed by N times WHAT. WHAT can be `day', `month',
16369 `year', `minute', `second'. If WHAT is not given, the cursor position
16370 in the timestamp determines what will be changed."
16371 (let ((origin (point)) origin-cat
16372 with-hm inactive
16373 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16374 org-ts-what
16375 extra rem
16376 ts time time0 fixnext clrgx)
16377 (if (not (org-at-timestamp-p t))
16378 (error "Not at a timestamp"))
16379 (if (and (not what) (eq org-ts-what 'bracket))
16380 (org-toggle-timestamp-type)
16381 ;; Point isn't on brackets. Remember the part of the time-stamp
16382 ;; the point was in. Indeed, size of time-stamps may change,
16383 ;; but point must be kept in the same category nonetheless.
16384 (setq origin-cat org-ts-what)
16385 (if (and (not what) (not (eq org-ts-what 'day))
16386 org-display-custom-times
16387 (get-text-property (point) 'display)
16388 (not (get-text-property (1- (point)) 'display)))
16389 (setq org-ts-what 'day))
16390 (setq org-ts-what (or what org-ts-what)
16391 inactive (= (char-after (match-beginning 0)) ?\[)
16392 ts (match-string 0))
16393 (replace-match "")
16394 (if (string-match
16396 ts)
16397 (setq extra (match-string 1 ts)))
16399 (setq with-hm t))
16400 (setq time0 (org-parse-time-string ts))
16401 (when (and updown
16402 (eq org-ts-what 'minute)
16403 (not current-prefix-arg))
16404 ;; This looks like s-up and s-down. Change by one rounding step.
16405 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16406 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16407 (setcar (cdr time0) (+ (nth 1 time0)
16408 (if (> n 0) (- rem) (- dm rem))))))
16409 (setq time
16410 (encode-time (or (car time0) 0)
16411 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16412 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16413 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16414 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16415 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16416 (nthcdr 6 time0)))
16417 (when (and (member org-ts-what '(hour minute))
16418 extra
16420 (setq extra (org-modify-ts-extra
16421 extra
16422 (if (eq org-ts-what 'hour) 2 5)
16423 n dm)))
16424 (when (integerp org-ts-what)
16425 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16426 (if (eq what 'calendar)
16427 (let ((cal-date (org-get-date-from-calendar)))
16428 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16429 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16430 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16431 (setcar time0 (or (car time0) 0))
16432 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16433 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16434 (setq time (apply 'encode-time time0))))
16435 ;; Insert the new time-stamp, and ensure point stays in the same
16436 ;; category as before (i.e. not after the last position in that
16437 ;; category).
16438 (let ((pos (point)))
16439 ;; Stay before inserted string. `save-excursion' is of no use.
16440 (setq org-last-changed-timestamp
16441 (org-insert-time-stamp time with-hm inactive nil nil extra))
16442 (goto-char pos))
16443 (save-match-data
16444 (looking-at org-ts-regexp3)
16445 (goto-char (cond
16446 ;; `day' category ends before `hour' if any, or at
16447 ;; the end of the day name.
16448 ((eq origin-cat 'day)
16449 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16450 ((eq origin-cat 'hour) (min (match-end 7) origin))
16451 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16452 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16453 ;; `year' and `month' have both fixed size: point
16454 ;; couldn't have moved into another part.
16455 (t origin))))
16456 ;; Update clock if on a CLOCK line.
16457 (org-clock-update-time-maybe)
16458 ;; Maybe adjust the closest clock in `org-clock-history'
16459 (when org-clock-adjust-closest
16460 (if (not (and (org-at-clock-log-p)
16461 (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
16462 org-clock-history))))))
16463 (message "No clock to adjust")
16464 (cond ((save-excursion ; fix previous clock?
16465 (re-search-backward org-ts-regexp0 nil t)
16468 ((save-excursion ; fix next clock?
16469 (re-search-backward org-ts-regexp0 nil t)
16472 (save-window-excursion
16473 ;; Find closest clock to point, adjust the previous/next one in history
16474 (let* ((p (save-excursion (org-back-to-heading t)))
16475 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
16476 (clfixnth
16477 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
16478 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
16479 (if (not clfixpos)
16480 (message "No clock to adjust")
16481 (save-excursion
16482 (org-goto-marker-or-bmk clfixpos)
16483 (org-show-subtree)
16484 (when (re-search-forward clrgx nil t)
16485 (goto-char (match-beginning 1))
16486 (let (org-clock-adjust-closest)
16487 (org-timestamp-change n org-ts-what updown))
16488 (message "Clock adjusted in %s for heading: %s"
16489 (file-name-nondirectory (buffer-file-name))
16490 (org-get-heading t t)))))))))
16491 ;; Try to recenter the calendar window, if any.
16492 (if (and org-calendar-follow-timestamp-change
16493 (get-buffer-window "*Calendar*" t)
16494 (memq org-ts-what '(day month year)))
16495 (org-recenter-calendar (time-to-days time))))))
16497 (defun org-modify-ts-extra (s pos n dm)
16498 "Change the different parts of the lead-time and repeat fields in timestamp."
16499 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16500 ng h m new rem)
16501 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16502 (cond
16503 ((or (org-pos-in-match-range pos 2)
16504 (org-pos-in-match-range pos 3))
16505 (setq m (string-to-number (match-string 3 s))
16506 h (string-to-number (match-string 2 s)))
16507 (if (org-pos-in-match-range pos 2)
16508 (setq h (+ h n))
16509 (setq n (* dm (org-no-warnings (signum n))))
16510 (when (not (= 0 (setq rem (% m dm))))
16511 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16512 (setq m (+ m n)))
16513 (if (< m 0) (setq m (+ m 60) h (1- h)))
16514 (if (> m 59) (setq m (- m 60) h (1+ h)))
16515 (setq h (min 24 (max 0 h)))
16516 (setq ng 1 new (format "-%02d:%02d" h m)))
16517 ((org-pos-in-match-range pos 6)
16518 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16519 ((org-pos-in-match-range pos 5)
16520 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16522 ((org-pos-in-match-range pos 9)
16523 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16524 ((org-pos-in-match-range pos 8)
16525 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16527 (when ng
16528 (setq s (concat
16529 (substring s 0 (match-beginning ng))
16530 new
16531 (substring s (match-end ng))))))
16532 s))
16534 (defun org-recenter-calendar (date)
16535 "If the calendar is visible, recenter it to DATE."
16536 (let ((cwin (get-buffer-window "*Calendar*" t)))
16537 (when cwin
16538 (let ((calendar-move-hook nil))
16539 (with-selected-window cwin
16540 (calendar-goto-date (if (listp date) date
16541 (calendar-gregorian-from-absolute date))))))))
16543 (defun org-goto-calendar (&optional arg)
16544 "Go to the Emacs calendar at the current date.
16545 If there is a time stamp in the current line, go to that date.
16546 A prefix ARG can be used to force the current date."
16547 (interactive "P")
16548 (let ((tsr org-ts-regexp) diff
16549 (calendar-move-hook nil)
16550 (calendar-view-holidays-initially-flag nil)
16551 (calendar-view-diary-initially-flag nil))
16552 (if (or (org-at-timestamp-p)
16553 (save-excursion
16554 (beginning-of-line 1)
16555 (looking-at (concat ".*" tsr))))
16556 (let ((d1 (time-to-days (current-time)))
16557 (d2 (time-to-days
16558 (org-time-string-to-time (match-string 1)))))
16559 (setq diff (- d2 d1))))
16560 (calendar)
16561 (calendar-goto-today)
16562 (if (and diff (not arg)) (calendar-forward-day diff))))
16564 (defun org-get-date-from-calendar ()
16565 "Return a list (month day year) of date at point in calendar."
16566 (with-current-buffer "*Calendar*"
16567 (save-match-data
16568 (calendar-cursor-to-date))))
16570 (defun org-date-from-calendar ()
16571 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16572 If there is already a time stamp at the cursor position, update it."
16573 (interactive)
16574 (if (org-at-timestamp-p t)
16575 (org-timestamp-change 0 'calendar)
16576 (let ((cal-date (org-get-date-from-calendar)))
16577 (org-insert-time-stamp
16578 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16580 (defun org-minutes-to-hh:mm-string (m)
16581 "Compute H:MM from a number of minutes."
16582 (let ((h (/ m 60)))
16583 (setq m (- m (* 60 h)))
16584 (format org-time-clocksum-format h m)))
16586 (defun org-hh:mm-string-to-minutes (s)
16587 "Convert a string H:MM to a number of minutes.
16588 If the string is just a number, interpret it as minutes.
16589 In fact, the first hh:mm or number in the string will be taken,
16590 there can be extra stuff in the string.
16591 If no number is found, the return value is 0."
16592 (cond
16593 ((integerp s) s)
16595 (+ (* (string-to-number (match-string 1 s)) 60)
16596 (string-to-number (match-string 2 s))))
16598 (string-to-number (match-string 1 s)))
16599 (t 0)))
16601 (defcustom org-effort-durations
16602 `(("h" . 60)
16603 ("d" . ,(* 60 8))
16604 ("w" . ,(* 60 8 5))
16605 ("m" . ,(* 60 8 5 4))
16606 ("y" . ,(* 60 8 5 40)))
16607 "Conversion factor to minutes for an effort modifier.
16609 Each entry has the form (MODIFIER . MINUTES).
16611 In an effort string, a number followed by MODIFIER is multiplied
16612 by the specified number of MINUTES to obtain an effort in
16613 minutes.
16617 :group 'org-agenda
16618 :version "24.1"
16619 :type '(alist :key-type (string :tag "Modifier")
16620 :value-type (number :tag "Minutes")))
16622 (defun org-duration-string-to-minutes (s &optional output-to-string)
16623 "Convert a duration string S to minutes.
16625 A bare number is interpreted as minutes, modifiers can be set by
16626 customizing `org-effort-durations' (which see).
16628 Entries containing a colon are interpreted as H:MM by
16629 `org-hh:mm-string-to-minutes'."
16630 (let ((result 0)
16632 (regexp-opt (mapcar 'car org-effort-durations))
16634 (while (string-match re s)
16635 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16636 (string-to-number (match-string 1 s))))
16637 (setq s (replace-match "" nil t s)))
16638 (setq result (floor result))
16639 (incf result (org-hh:mm-string-to-minutes s))
16640 (if output-to-string (number-to-string result) result)))
16642 ;;;; Files
16644 (defun org-save-all-org-buffers ()
16645 "Save all Org-mode buffers without user confirmation."
16646 (interactive)
16647 (message "Saving all Org-mode buffers...")
16648 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
16649 (when (featurep 'org-id) (org-id-locations-save))
16650 (message "Saving all Org-mode buffers... done"))
16652 (defun org-revert-all-org-buffers ()
16653 "Revert all Org-mode buffers.
16654 Prompt for confirmation when there are unsaved changes.
16655 Be sure you know what you are doing before letting this function
16656 overwrite your changes.
16658 This function is useful in a setup where one tracks org files
16659 with a version control system, to revert on one machine after pulling
16660 changes from another. I believe the procedure must be like this:
16662 1. M-x org-save-all-org-buffers
16663 2. Pull changes from the other machine, resolve conflicts
16664 3. M-x org-revert-all-org-buffers"
16665 (interactive)
16666 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16667 (error "Abort"))
16668 (save-excursion
16669 (save-window-excursion
16670 (mapc
16671 (lambda (b)
16672 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
16673 (with-current-buffer b buffer-file-name))
16674 (org-pop-to-buffer-same-window b)
16675 (revert-buffer t 'no-confirm)))
16676 (buffer-list))
16677 (when (and (featurep 'org-id) org-id-track-globally)
16678 (org-id-locations-load)))))
16680 ;;;; Agenda files
16682 ;;;###autoload
16683 (defun org-switchb (&optional arg)
16684 "Switch between Org buffers.
16685 With one prefix argument, restrict available buffers to files.
16686 With two prefix arguments, restrict available buffers to agenda files.
16688 Defaults to `iswitchb' for buffer name completion.
16689 Set `org-completion-use-ido' to make it use ido instead."
16690 (interactive "P")
16691 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16692 ((equal arg '(16)) (org-buffer-list 'agenda))
16693 (t (org-buffer-list))))
16694 (org-completion-use-iswitchb org-completion-use-iswitchb)
16695 (org-completion-use-ido org-completion-use-ido))
16696 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16697 (setq org-completion-use-iswitchb t))
16698 (org-pop-to-buffer-same-window
16699 (org-icompleting-read "Org buffer: "
16700 (mapcar 'list (mapcar 'buffer-name blist))
16701 nil t))))
16703 ;;; Define some older names previously used for this functionality
16704 ;;;###autoload
16705 (defalias 'org-ido-switchb 'org-switchb)
16706 ;;;###autoload
16707 (defalias 'org-iswitchb 'org-switchb)
16709 (defun org-buffer-list (&optional predicate exclude-tmp)
16710 "Return a list of Org buffers.
16711 PREDICATE can be `export', `files' or `agenda'.
16713 export restrict the list to Export buffers.
16714 files restrict the list to buffers visiting Org files.
16715 agenda restrict the list to buffers visiting agenda files.
16717 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16718 (let* ((bfn nil)
16719 (agenda-files (and (eq predicate 'agenda)
16720 (mapcar 'file-truename (org-agenda-files t))))
16721 (filter
16722 (cond
16723 ((eq predicate 'files)
16724 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
16725 ((eq predicate 'export)
16726 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16727 ((eq predicate 'agenda)
16728 (lambda (b)
16729 (with-current-buffer b
16730 (and (derived-mode-p 'org-mode)
16731 (setq bfn (buffer-file-name b))
16732 (member (file-truename bfn) agenda-files)))))
16733 (t (lambda (b) (with-current-buffer b
16734 (or (derived-mode-p 'org-mode)
16735 (string-match "\*Org .*Export"
16736 (buffer-name b)))))))))
16737 (delq nil
16738 (mapcar
16739 (lambda(b)
16740 (if (and (funcall filter b)
16741 (or (not exclude-tmp)
16742 (not (string-match "tmp" (buffer-name b)))))
16743 b
16744 nil))
16745 (buffer-list)))))
16747 (defun org-agenda-files (&optional unrestricted archives)
16748 "Get the list of agenda files.
16749 Optional UNRESTRICTED means return the full list even if a restriction
16750 is currently in place.
16751 When ARCHIVES is t, include all archive files that are really being
16752 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16753 `org-agenda-archives-mode' is t."
16754 (let ((files
16755 (cond
16756 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16757 ((stringp org-agenda-files) (org-read-agenda-file-list))
16758 ((listp org-agenda-files) org-agenda-files)
16759 (t (error "Invalid value of `org-agenda-files'")))))
16760 (setq files (apply 'append
16761 (mapcar (lambda (f)
16762 (if (file-directory-p f)
16763 (directory-files
16764 f t org-agenda-file-regexp)
16765 (list f)))
16766 files)))
16767 (when org-agenda-skip-unavailable-files
16768 (setq files (delq nil
16769 (mapcar (function
16770 (lambda (file)
16771 (and (file-readable-p file) file)))
16772 files))))
16773 (when (or (eq archives t)
16774 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16775 (setq files (org-add-archive-files files)))
16776 files))
16778 (defun org-agenda-file-p (&optional file)
16779 "Return non-nil, if FILE is an agenda file.
16780 If FILE is omitted, use the file associated with the current
16781 buffer."
16782 (member (or file (buffer-file-name))
16783 (org-agenda-files t)))
16785 (defun org-edit-agenda-file-list ()
16786 "Edit the list of agenda files.
16787 Depending on setup, this either uses customize to edit the variable
16788 `org-agenda-files', or it visits the file that is holding the list. In the
16789 latter case, the buffer is set up in a way that saving it automatically kills
16790 the buffer and restores the previous window configuration."
16791 (interactive)
16792 (if (stringp org-agenda-files)
16793 (let ((cw (current-window-configuration)))
16794 (find-file org-agenda-files)
16795 (org-set-local 'org-window-configuration cw)
16796 (org-add-hook 'after-save-hook
16797 (lambda ()
16798 (set-window-configuration
16799 (prog1 org-window-configuration
16800 (kill-buffer (current-buffer))))
16801 (org-install-agenda-files-menu)
16802 (message "New agenda file list installed"))
16803 nil 'local)
16804 (message "%s" (substitute-command-keys
16806 (customize-variable 'org-agenda-files)))
16808 (defun org-store-new-agenda-file-list (list)
16809 "Set new value for the agenda file list and save it correctly."
16810 (if (stringp org-agenda-files)
16811 (let ((fe (org-read-agenda-file-list t)) b u)
16812 (while (setq b (find-buffer-visiting org-agenda-files))
16813 (kill-buffer b))
16814 (with-temp-file org-agenda-files
16815 (insert
16816 (mapconcat
16817 (lambda (f) ;; Keep un-expanded entries.
16818 (if (setq u (assoc f fe))
16819 (cdr u)
16820 f))
16823 (let ((org-mode-hook nil) (org-inhibit-startup t)
16824 (org-insert-mode-line-in-empty-file nil))
16825 (setq org-agenda-files list)
16826 (customize-save-variable 'org-agenda-files org-agenda-files))))
16828 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16829 "Read the list of agenda files from a file.
16830 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16831 filenames, used by `org-store-new-agenda-file-list' to write back
16832 un-expanded file names."
16833 (when (file-directory-p org-agenda-files)
16834 (error "`org-agenda-files' cannot be a single directory"))
16835 (when (stringp org-agenda-files)
16836 (with-temp-buffer
16837 (insert-file-contents org-agenda-files)
16838 (mapcar
16839 (lambda (f)
16840 (let ((e (expand-file-name (substitute-in-file-name f)
16841 org-directory)))
16842 (if pair-with-expansion
16843 (cons e f)
16844 e)))
16847 ;;;###autoload
16848 (defun org-cycle-agenda-files ()
16849 "Cycle through the files in `org-agenda-files'.
16850 If the current buffer visits an agenda file, find the next one in the list.
16851 If the current buffer does not, find the first agenda file."
16852 (interactive)
16853 (let* ((fs (org-agenda-files t))
16854 (files (append fs (list (car fs))))
16855 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16856 file)
16857 (unless files (error "No agenda files"))
16858 (catch 'exit
16859 (while (setq file (pop files))
16860 (if (equal (file-truename file) tcf)
16861 (when (car files)
16862 (find-file (car files))
16863 (throw 'exit t))))
16864 (find-file (car fs)))
16865 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16867 (defun org-agenda-file-to-front (&optional to-end)
16868 "Move/add the current file to the top of the agenda file list.
16869 If the file is not present in the list, it is added to the front. If it is
16870 present, it is moved there. With optional argument TO-END, add/move to the
16871 end of the list."
16872 (interactive "P")
16873 (let ((org-agenda-skip-unavailable-files nil)
16874 (file-alist (mapcar (lambda (x)
16875 (cons (file-truename x) x))
16876 (org-agenda-files t)))
16877 (ctf (file-truename
16878 (or buffer-file-name
16879 (error "Please save the current buffer to a file"))))
16880 x had)
16881 (setq x (assoc ctf file-alist) had x)
16883 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16884 (if to-end
16885 (setq file-alist (append (delq x file-alist) (list x)))
16886 (setq file-alist (cons x (delq x file-alist))))
16887 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16888 (org-install-agenda-files-menu)
16889 (message "File %s to %s of agenda file list"
16890 (if had "moved" "added") (if to-end "end" "front"))))
16892 (defun org-remove-file (&optional file)
16893 "Remove current file from the list of files in variable `org-agenda-files'.
16894 These are the files which are being checked for agenda entries.
16895 Optional argument FILE means use this file instead of the current."
16896 (interactive)
16897 (let* ((org-agenda-skip-unavailable-files nil)
16898 (file (or file buffer-file-name
16899 (error "Current buffer does not visit a file")))
16900 (true-file (file-truename file))
16901 (afile (abbreviate-file-name file))
16902 (files (delq nil (mapcar
16903 (lambda (x)
16904 (if (equal true-file
16905 (file-truename x))
16906 nil x))
16907 (org-agenda-files t)))))
16908 (if (not (= (length files) (length (org-agenda-files t))))
16909 (progn
16910 (org-store-new-agenda-file-list files)
16911 (org-install-agenda-files-menu)
16912 (message "Removed file: %s" afile))
16913 (message "File was not in list: %s (not removed)" afile))))
16915 (defun org-file-menu-entry (file)
16916 (vector file (list 'find-file file) t))
16918 (defun org-check-agenda-file (file)
16919 "Make sure FILE exists. If not, ask user what to do."
16920 (when (not (file-exists-p file))
16921 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
16922 (abbreviate-file-name file))
16923 (let ((r (downcase (read-char-exclusive))))
16924 (cond
16925 ((equal r ?r)
16926 (org-remove-file file)
16927 (throw 'nextfile t))
16928 (t (error "Abort"))))))
16930 (defun org-get-agenda-file-buffer (file)
16931 "Get a buffer visiting FILE. If the buffer needs to be created, add
16932 it to the list of buffers which might be released later."
16933 (let ((buf (org-find-base-buffer-visiting file)))
16934 (if buf
16935 buf ; just return it
16936 ;; Make a new buffer and remember it
16937 (setq buf (find-file-noselect file))
16938 (if buf (push buf org-agenda-new-buffers))
16939 buf)))
16941 (defun org-release-buffers (blist)
16942 "Release all buffers in list, asking the user for confirmation when needed.
16943 When a buffer is unmodified, it is just killed. When modified, it is saved
16944 \(if the user agrees) and then killed."
16945 (let (buf file)
16946 (while (setq buf (pop blist))
16947 (setq file (buffer-file-name buf))
16948 (when (and (buffer-modified-p buf)
16949 file
16950 (y-or-n-p (format "Save file %s? " file)))
16951 (with-current-buffer buf (save-buffer)))
16952 (kill-buffer buf))))
16954 (defun org-agenda-prepare-buffers (files)
16955 "Create buffers for all agenda files, protect archived trees and comments."
16956 (interactive)
16957 (let ((pa '(:org-archived t))
16958 (pc '(:org-comment t))
16959 (pall '(:org-archived t :org-comment t))
16960 (inhibit-read-only t)
16961 (rea (concat ":" org-archive-tag ":"))
16962 bmp file re)
16963 (save-excursion
16964 (save-restriction
16965 (while (setq file (pop files))
16966 (catch 'nextfile
16967 (if (bufferp file)
16968 (set-buffer file)
16969 (org-check-agenda-file file)
16970 (set-buffer (org-get-agenda-file-buffer file)))
16971 (widen)
16972 (setq bmp (buffer-modified-p))
16973 (org-refresh-category-properties)
16974 (setq org-todo-keywords-for-agenda
16975 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16976 (setq org-done-keywords-for-agenda
16977 (append org-done-keywords-for-agenda org-done-keywords))
16978 (setq org-todo-keyword-alist-for-agenda
16979 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16980 (setq org-drawers-for-agenda
16981 (append org-drawers-for-agenda org-drawers))
16982 (setq org-tag-alist-for-agenda
16983 (append org-tag-alist-for-agenda org-tag-alist))
16985 (save-excursion
16986 (remove-text-properties (point-min) (point-max) pall)
16987 (when org-agenda-skip-archived-trees
16988 (goto-char (point-min))
16989 (while (re-search-forward rea nil t)
16990 (if (org-at-heading-p t)
16991 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16992 (goto-char (point-min))
16993 (setq re (format org-heading-keyword-regexp-format
16994 org-comment-string))
16995 (while (re-search-forward re nil t)
16996 (add-text-properties
16997 (match-beginning 0) (org-end-of-subtree t) pc)))
16998 (set-buffer-modified-p bmp)))))
16999 (setq org-todo-keywords-for-agenda
17000 (org-uniquify org-todo-keywords-for-agenda))
17001 (setq org-todo-keyword-alist-for-agenda
17002 (org-uniquify org-todo-keyword-alist-for-agenda)
17003 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
17005 ;;;; Embedded LaTeX
17007 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17008 "Keymap for the minor `org-cdlatex-mode'.")
17010 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
17011 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
17012 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
17013 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
17014 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
17016 (defvar org-cdlatex-texmathp-advice-is-done nil
17017 "Flag remembering if we have applied the advice to texmathp already.")
17019 (define-minor-mode org-cdlatex-mode
17020 "Toggle the minor `org-cdlatex-mode'.
17021 This mode supports entering LaTeX environment and math in LaTeX fragments
17022 in Org-mode.
17024 nil " OCDL" nil
17025 (when org-cdlatex-mode
17026 (require 'cdlatex)
17027 (run-hooks 'cdlatex-mode-hook)
17028 (cdlatex-compute-tables))
17029 (unless org-cdlatex-texmathp-advice-is-done
17030 (setq org-cdlatex-texmathp-advice-is-done t)
17031 (defadvice texmathp (around org-math-always-on activate)
17032 "Always return t in org-mode buffers.
17033 This is because we want to insert math symbols without dollars even outside
17034 the LaTeX math segments. If Orgmode thinks that point is actually inside
17035 an embedded LaTeX fragment, let texmathp do its job.
17037 (interactive)
17038 (let (p)
17039 (cond
17040 ((not (derived-mode-p 'org-mode)) ad-do-it)
17041 ((eq this-command 'cdlatex-math-symbol)
17042 (setq ad-return-value t
17043 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
17044 (t
17045 (let ((p (org-inside-LaTeX-fragment-p)))
17046 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
17047 (setq ad-return-value t
17048 texmathp-why '("Org-mode embedded math" . 0))
17049 (if p ad-do-it)))))))))
17051 (defun turn-on-org-cdlatex ()
17052 "Unconditionally turn on `org-cdlatex-mode'."
17053 (org-cdlatex-mode 1))
17055 (defun org-inside-LaTeX-fragment-p ()
17056 "Test if point is inside a LaTeX fragment.
17058 sequence appearing also before point.
17059 Even though the matchers for math are configurable, this function assumes
17061 delimiters are skipped when they have been removed by customization.
17062 The return value is nil, or a cons cell with the delimiter and the
17063 position of this delimiter.
17065 This function does a reasonably good job, but can locally be fooled by
17066 for example currency specifications. For example it will assume being in
17068 fragments that are properly closed, but during editing, we have to live
17069 with the uncertainty caused by missing closing delimiters. This function
17070 looks only before point, not after."
17071 (catch 'exit
17072 (let ((pos (point))
17073 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
17074 (lim (progn
17076 (point)))
17077 dd-on str (start 0) m re)
17078 (goto-char pos)
17079 (when dodollar
17081 re (nth 1 (assoc "$" org-latex-regexps)))
17082 (while (string-match re str start)
17083 (cond
17084 ((= (match-end 0) (length str))
17085 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
17086 ((= (match-end 0) (- (length str) 5))
17087 (throw 'exit nil))
17088 (t (setq start (match-end 0))))))
17089 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17090 (goto-char pos)
17091 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
17092 (and (match-beginning 2) (throw 'exit nil))
17093 ;; count $$
17095 (setq dd-on (not dd-on)))
17096 (goto-char pos)
17097 (if dd-on (cons "$$" m))))))
17099 (defun org-inside-latex-macro-p ()
17100 "Is point inside a LaTeX macro or its arguments?"
17101 (save-match-data
17102 (org-in-regexp
17105 (defun org-try-cdlatex-tab ()
17106 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17107 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17108 - inside a LaTeX fragment, or
17109 - after the first word in a line, where an abbreviation expansion could
17110 insert a LaTeX environment."
17111 (when org-cdlatex-mode
17112 (cond
17113 ;; Before any word on the line: No expansion possible.
17115 ;; Just after first word on the line: Expand it. Make sure it
17116 ;; cannot happen on headlines, though.
17117 ((save-excursion
17118 (skip-chars-backward "a-zA-Z0-9*")
17120 (and (bolp) (not (org-at-heading-p))))
17121 (cdlatex-tab) t)
17122 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
17124 (defun org-cdlatex-underscore-caret (&optional arg)
17125 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17126 Revert to the normal definition outside of these fragments."
17127 (interactive "P")
17128 (if (org-inside-LaTeX-fragment-p)
17129 (call-interactively 'cdlatex-sub-superscript)
17130 (let (org-cdlatex-mode)
17131 (call-interactively (key-binding (vector last-input-event))))))
17133 (defun org-cdlatex-math-modify (&optional arg)
17134 "Execute `cdlatex-math-modify' in LaTeX fragments.
17135 Revert to the normal definition outside of these fragments."
17136 (interactive "P")
17137 (if (org-inside-LaTeX-fragment-p)
17138 (call-interactively 'cdlatex-math-modify)
17139 (let (org-cdlatex-mode)
17140 (call-interactively (key-binding (vector last-input-event))))))
17142 (defvar org-latex-fragment-image-overlays nil
17143 "List of overlays carrying the images of latex fragments.")
17144 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
17146 (defun org-remove-latex-fragment-image-overlays ()
17147 "Remove all overlays with LaTeX fragment images in current buffer."
17148 (mapc 'delete-overlay org-latex-fragment-image-overlays)
17149 (setq org-latex-fragment-image-overlays nil))
17151 (defun org-preview-latex-fragment (&optional subtree)
17152 "Preview the LaTeX fragment at point, or all locally or globally.
17153 If the cursor is in a LaTeX fragment, create the image and overlay
17154 it over the source code. If there is no fragment at point, display
17155 all fragments in the current text, from one headline to the next. With
17156 prefix SUBTREE, display all fragments in the current subtree. With a
17158 the cursor is before the first headline,
17159 display all fragments in the buffer.
17161 (interactive "P")
17162 (unless buffer-file-name
17163 (error "Can't preview LaTeX fragment in a non-file buffer"))
17164 (org-remove-latex-fragment-image-overlays)
17165 (save-excursion
17166 (save-restriction
17167 (let (beg end at msg)
17168 (cond
17169 ((or (equal subtree '(16))
17170 (not (save-excursion
17171 (re-search-backward org-outline-regexp-bol nil t))))
17172 (setq beg (point-min) end (point-max)
17173 msg "Creating images for buffer...%s"))
17174 ((equal subtree '(4))
17175 (org-back-to-heading)
17176 (setq beg (point) end (org-end-of-subtree t)
17177 msg "Creating images for subtree...%s"))
17178 (t
17179 (if (setq at (org-inside-LaTeX-fragment-p))
17180 (goto-char (max (point-min) (- (cdr at) 2)))
17181 (org-back-to-heading))
17182 (setq beg (point) end (progn (outline-next-heading) (point))
17183 msg (if at "Creating image...%s"
17184 "Creating images for entry...%s"))))
17185 (message msg "")
17186 (narrow-to-region beg end)
17187 (goto-char beg)
17188 (org-format-latex
17189 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
17190 (file-name-nondirectory
17191 buffer-file-name)))
17192 default-directory 'overlays msg at 'forbuffer
17193 org-latex-create-formula-image-program)
17194 (message msg "done. Use `C-c C-c' to remove images.")))))
17196 (defvar org-latex-regexps
17198 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17201 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
17205 "Regular expressions for matching embedded LaTeX.")
17207 (defvar org-export-have-math nil) ;; dynamic scoping
17208 (defun org-format-latex (prefix &optional dir overlays msg at
17209 forbuffer processing-type)
17210 "Replace LaTeX fragments with links to an image, and produce images.
17211 Some of the options can be changed using the variable
17212 `org-format-latex-options'."
17213 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
17214 (let* ((prefixnodir (file-name-nondirectory prefix))
17215 (absprefix (expand-file-name prefix dir))
17216 (todir (file-name-directory absprefix))
17217 (opt org-format-latex-options)
17218 (matchers (plist-get opt :matchers))
17219 (re-list org-latex-regexps)
17220 (org-format-latex-header-extra
17221 (plist-get (org-infile-export-plist) :latex-header-extra))
17222 (cnt 0) txt hash link beg end re e checkdir
17223 executables-checked string
17224 m n block-type block linkfile movefile ov)
17225 ;; Check the different regular expressions
17226 (while (setq e (pop re-list))
17227 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
17229 (when (member m matchers)
17230 (goto-char (point-min))
17231 (while (re-search-forward re nil t)
17232 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
17233 (not (get-text-property (match-beginning n)
17234 'org-protected))
17235 (or (not overlays)
17236 (not (eq (get-char-property (match-beginning n)
17237 'org-overlay-type)
17238 'org-latex-overlay))))
17239 (setq org-export-have-math t)
17240 (cond
17241 ((eq processing-type 'verbatim)
17242 ;; Leave the text verbatim, just protect it
17243 (add-text-properties (match-beginning n) (match-end n)
17244 '(org-protected t)))
17245 ((eq processing-type 'mathjax)
17246 ;; Prepare for MathJax processing
17247 (setq string (match-string n))
17248 (if (member m '("$" "$1"))
17249 (save-excursion
17250 (delete-region (match-beginning n) (match-end n))
17251 (goto-char (match-beginning n))
17254 '(org-protected t))))
17255 (add-text-properties (match-beginning n) (match-end n)
17256 '(org-protected t))))
17257 ((or (eq processing-type 'dvipng)
17258 (eq processing-type 'imagemagick))
17259 ;; Process to an image
17260 (setq txt (match-string n)
17261 beg (match-beginning n) end (match-end n)
17262 cnt (1+ cnt))
17263 (let (print-length print-level) ; make sure full list is printed
17264 (setq hash (sha1 (prin1-to-string
17265 (list org-format-latex-header
17266 org-format-latex-header-extra
17267 org-export-latex-default-packages-alist
17268 org-export-latex-packages-alist
17269 org-format-latex-options
17270 forbuffer txt)))
17271 linkfile (format "%s_%s.png" prefix hash)
17272 movefile (format "%s_%s.png" absprefix hash)))
17273 (setq link (concat block "[[file:" linkfile "]]" block))
17274 (if msg (message msg cnt))
17275 (goto-char beg)
17276 (unless checkdir ; make sure the directory exists
17277 (setq checkdir t)
17278 (or (file-directory-p todir) (make-directory todir t)))
17279 (cond
17280 ((eq processing-type 'dvipng)
17281 (unless executables-checked
17282 (org-check-external-command
17283 "latex" "needed to convert LaTeX fragments to images")
17284 (org-check-external-command
17285 "dvipng" "needed to convert LaTeX fragments to images")
17286 (setq executables-checked t))
17287 (unless (file-exists-p movefile)
17288 (org-create-formula-image-with-dvipng
17289 txt movefile opt forbuffer)))
17290 ((eq processing-type 'imagemagick)
17291 (unless executables-checked
17292 (org-check-external-command
17293 "convert" "you need to install imagemagick")
17294 (setq executables-checked t))
17295 (unless (file-exists-p movefile)
17296 (org-create-formula-image-with-imagemagick
17297 txt movefile opt forbuffer))))
17298 (if overlays
17299 (progn
17300 (mapc (lambda (o)
17301 (if (eq (overlay-get o 'org-overlay-type)
17302 'org-latex-overlay)
17303 (delete-overlay o)))
17304 (overlays-in beg end))
17305 (setq ov (make-overlay beg end))
17306 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17307 (if (featurep 'xemacs)
17308 (progn
17309 (overlay-put ov 'invisible t)
17310 (overlay-put
17311 ov 'end-glyph
17312 (make-glyph (vector 'png :file movefile))))
17313 (overlay-put
17314 ov 'display
17315 (list 'image :type 'png :file movefile :ascent 'center)))
17316 (push ov org-latex-fragment-image-overlays)
17317 (goto-char end))
17318 (delete-region beg end)
17319 (insert (org-add-props link
17320 (list 'org-latex-src
17321 (replace-regexp-in-string
17323 'org-latex-src-embed-type
17324 (if block-type 'paragraph 'character))))))
17325 ((eq processing-type 'mathml)
17326 ;; Process to MathML
17327 (unless executables-checked
17328 (unless (save-match-data (org-format-latex-mathml-available-p))
17329 (error "LaTeX to MathML converter not configured"))
17330 (setq executables-checked t))
17331 (setq txt (match-string n)
17332 beg (match-beginning n) end (match-end n)
17333 cnt (1+ cnt))
17334 (if msg (message msg cnt))
17335 (goto-char beg)
17336 (delete-region beg end)
17337 (insert (org-format-latex-as-mathml
17338 txt block-type prefix dir)))
17339 (t
17340 (error "Unknown conversion type %s for latex fragments"
17341 processing-type)))))))))
17343 (defun org-create-math-formula (latex-frag &optional mathml-file)
17344 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17345 Use `org-latex-to-mathml-convert-command'. If the conversion is
17347 elements otherwise return nil. When MATHML-FILE is specified,
17348 write the results in to that file. When invoked as an
17349 interactive command, prompt for LATEX-FRAG, with initial value
17350 set to the current active region and echo the results for user
17351 inspection."
17352 (interactive (list (let ((frag (when (org-region-active-p)
17353 (buffer-substring-no-properties
17354 (region-beginning) (region-end)))))
17355 (read-string "LaTeX Fragment: " frag nil frag))))
17356 (unless latex-frag (error "Invalid latex-frag"))
17357 (let* ((tmp-in-file (file-relative-name
17358 (make-temp-name (expand-file-name "ltxmathml-in"))))
17359 (ignore (write-region latex-frag nil tmp-in-file))
17360 (tmp-out-file (file-relative-name
17361 (make-temp-name (expand-file-name "ltxmathml-out"))))
17362 (cmd (format-spec
17363 org-latex-to-mathml-convert-command
17364 `((?j . ,(shell-quote-argument
17365 (expand-file-name org-latex-to-mathml-jar-file)))
17366 (?I . ,(shell-quote-argument tmp-in-file))
17367 (?o . ,(shell-quote-argument tmp-out-file)))))
17368 mathml shell-command-output)
17369 (when (org-called-interactively-p 'any)
17370 (unless (org-format-latex-mathml-available-p)
17371 (error "LaTeX to MathML converter not configured")))
17372 (message "Running %s" cmd)
17373 (setq shell-command-output (shell-command-to-string cmd))
17374 (setq mathml
17375 (when (file-readable-p tmp-out-file)
17376 (with-current-buffer (find-file-noselect tmp-out-file t)
17377 (goto-char (point-min))
17378 (when (re-search-forward
17379 (concat
17380 (regexp-quote
17383 (regexp-quote "</math>")) nil t)
17384 (prog1 (match-string 0) (kill-buffer))))))
17385 (cond
17386 (mathml
17387 (setq mathml
17389 (when mathml-file
17390 (write-region mathml nil mathml-file))
17391 (when (org-called-interactively-p 'any)
17392 (message mathml)))
17393 ((message "LaTeX to MathML conversion failed")
17394 (message shell-command-output)))
17395 (delete-file tmp-in-file)
17396 (when (file-exists-p tmp-out-file)
17397 (delete-file tmp-out-file))
17398 mathml))
17400 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17401 prefix &optional dir)
17402 "Use `org-create-math-formula' but check local cache first."
17403 (let* ((absprefix (expand-file-name prefix dir))
17404 (print-length nil) (print-level nil)
17405 (formula-id (concat
17406 "formula-"
17407 (sha1
17408 (prin1-to-string
17409 (list latex-frag
17410 org-latex-to-mathml-convert-command)))))
17411 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17412 (formula-cache-dir (file-name-directory formula-cache)))
17414 (unless (file-directory-p formula-cache-dir)
17415 (make-directory formula-cache-dir t))
17417 (unless (file-exists-p formula-cache)
17418 (org-create-math-formula latex-frag formula-cache))
17420 (if (file-exists-p formula-cache)
17421 ;; Successful conversion. Return the link to MathML file.
17422 (org-add-props
17423 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17425 'org-latex-src-embed-type (if latex-frag-type
17426 'paragraph 'character)))
17427 ;; Failed conversion. Return the LaTeX fragment verbatim
17428 (add-text-properties
17429 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17430 latex-frag)))
17432 ;; This function borrows from Ganesh Swami's latex2png.el
17433 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
17434 "This calls dvipng."
17435 (require 'org-latex)
17436 (let* ((tmpdir (if (featurep 'xemacs)
17437 (temp-directory)
17438 temporary-file-directory))
17439 (texfilebase (make-temp-name
17440 (expand-file-name "orgtex" tmpdir)))
17441 (texfile (concat texfilebase ".tex"))
17442 (dvifile (concat texfilebase ".dvi"))
17443 (pngfile (concat texfilebase ".png"))
17444 (fnh (if (featurep 'xemacs)
17445 (font-height (face-font 'default))
17446 (face-attribute 'default :height nil)))
17447 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17448 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17449 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17450 "Black"))
17451 (bg (or (plist-get options (if buffer :background :html-background))
17452 "Transparent")))
17453 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17454 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17455 (with-temp-file texfile
17456 (insert (org-splice-latex-header
17457 org-format-latex-header
17458 org-export-latex-default-packages-alist
17459 org-export-latex-packages-alist t
17460 org-format-latex-header-extra))
17462 (require 'org-latex)
17463 (org-export-latex-fix-inputenc))
17464 (let ((dir default-directory))
17465 (condition-case nil
17466 (progn
17467 (cd tmpdir)
17468 (call-process "latex" nil nil nil texfile))
17469 (error nil))
17470 (cd dir))
17471 (if (not (file-exists-p dvifile))
17472 (progn (message "Failed to create dvi file from %s" texfile) nil)
17473 (condition-case nil
17474 (if (featurep 'xemacs)
17475 (call-process "dvipng" nil nil nil
17476 "-fg" fg "-bg" bg
17477 "-T" "tight"
17478 "-o" pngfile
17479 dvifile)
17480 (call-process "dvipng" nil nil nil
17481 "-fg" fg "-bg" bg
17482 "-D" dpi
17483 ;;"-x" scale "-y" scale
17484 "-T" "tight"
17485 "-o" pngfile
17486 dvifile))
17487 (error nil))
17488 (if (not (file-exists-p pngfile))
17489 (if org-format-latex-signal-error
17490 (error "Failed to create png file from %s" texfile)
17491 (message "Failed to create png file from %s" texfile)
17492 nil)
17493 ;; Use the requested file name and clean up
17494 (copy-file pngfile tofile 'replace)
17495 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
17496 (if (file-exists-p (concat texfilebase e))
17497 (delete-file (concat texfilebase e))))
17498 pngfile))))
17500 (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
17501 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
17502 "This calls convert, which is included into imagemagick."
17503 (require 'org-latex)
17504 (let* ((tmpdir (if (featurep 'xemacs)
17505 (temp-directory)
17506 temporary-file-directory))
17507 (texfilebase (make-temp-name
17508 (expand-file-name "orgtex" tmpdir)))
17509 (texfile (concat texfilebase ".tex"))
17510 (pdffile (concat texfilebase ".pdf"))
17511 (pngfile (concat texfilebase ".png"))
17512 (fnh (if (featurep 'xemacs)
17513 (font-height (face-font 'default))
17514 (face-attribute 'default :height nil)))
17515 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17516 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17517 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17518 "black"))
17519 (bg (or (plist-get options (if buffer :background :html-background))
17520 "white")))
17521 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
17522 (setq fg (org-latex-color-format fg)))
17523 (if (eq bg 'default) (setq bg (org-latex-color :background))
17524 (setq bg (org-latex-color-format
17525 (if (string= bg "Transparent")(setq bg "white")))))
17526 (with-temp-file texfile
17527 (insert (org-splice-latex-header
17528 org-format-latex-header
17529 org-export-latex-default-packages-alist
17530 org-export-latex-packages-alist t
17531 org-format-latex-header-extra))
17537 string
17540 (require 'org-latex)
17541 (org-export-latex-fix-inputenc))
17542 (let ((dir default-directory) cmd cmds latex-frags-cmds)
17543 (condition-case nil
17544 (progn
17545 (cd tmpdir)
17546 (setq cmds org-latex-to-pdf-process)
17547 (while cmds
17548 (setq latex-frags-cmds (pop cmds))
17549 (if (listp latex-frags-cmds)
17550 (setq cmds nil)
17551 (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
17552 (while latex-frags-cmds
17553 (setq cmd (pop latex-frags-cmds))
17554 (while (string-match "%b" cmd)
17555 (setq cmd (replace-match
17556 (save-match-data
17557 (shell-quote-argument texfile))
17558 t t cmd)))
17559 (while (string-match "%f" cmd)
17560 (setq cmd (replace-match
17561 (save-match-data
17562 (shell-quote-argument (file-name-nondirectory texfile)))
17563 t t cmd)))
17564 (while (string-match "%o" cmd)
17565 (setq cmd (replace-match
17566 (save-match-data
17567 (shell-quote-argument (file-name-directory texfile)))
17568 t t cmd)))
17569 (setq cmd (split-string cmd))
17570 (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
17571 (error nil))
17572 (cd dir))
17573 (if (not (file-exists-p pdffile))
17574 (progn (message "Failed to create pdf file from %s" texfile) nil)
17575 (condition-case nil
17576 (if (featurep 'xemacs)
17577 (call-process "convert" nil nil nil
17578 "-density" "96"
17579 "-trim"
17580 "-antialias"
17581 pdffile
17582 "-quality" "100"
17583 ;; "-sharpen" "0x1.0"
17584 pngfile)
17585 (call-process "convert" nil nil nil
17586 "-density" dpi
17587 "-trim"
17588 "-antialias"
17589 pdffile
17590 "-quality" "100"
17591 ; "-sharpen" "0x1.0"
17592 pngfile))
17593 (error nil))
17594 (if (not (file-exists-p pngfile))
17595 (if org-format-latex-signal-error
17596 (error "Failed to create png file from %s" texfile)
17597 (message "Failed to create png file from %s" texfile)
17598 nil)
17599 ;; Use the requested file name and clean up
17600 (copy-file pngfile tofile 'replace)
17601 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
17602 (if (file-exists-p (concat texfilebase e))
17603 (delete-file (concat texfilebase e))))
17604 pngfile))))
17606 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17607 "Fill a LaTeX header template TPL.
17608 In the template, the following place holders will be recognized:
17611 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17613 [NO-PACKAGES] do not include PKG
17614 [EXTRA] the string EXTRA
17615 [NO-EXTRA] do not include EXTRA
17617 For backward compatibility, if both the positive and the negative place
17619 assumed to be present at the end of the template.
17620 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17621 EXTRA is a string.
17622 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17623 (let (rpl (end ""))
17625 (setq rpl (if (or (match-end 1) (not def-pkg))
17626 "" (org-latex-packages-to-string def-pkg snippets-p t))
17627 tpl (replace-match rpl t t tpl))
17628 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17631 (setq rpl (if (or (match-end 1) (not pkg))
17632 "" (org-latex-packages-to-string pkg snippets-p t))
17633 tpl (replace-match rpl t t tpl))
17634 (if pkg (setq end
17636 (org-latex-packages-to-string pkg snippets-p)))))
17639 (setq rpl (if (or (match-end 1) (not extra))
17641 tpl (replace-match rpl t t tpl))
17647 tpl)))
17649 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17651 (setq pkg (mapconcat (lambda(p)
17652 (cond
17653 ((stringp p) p)
17654 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17655 (format "%% Package %s omitted" (cadr p)))
17656 ((equal "" (car p))
17658 (t
17660 (car p) (cadr p)))))
17661 pkg
17665 (defun org-dvipng-color (attr)
17666 "Return a RGB color specification for dvipng."
17667 (apply 'format "rgb %s %s %s"
17668 (mapcar 'org-normalize-color
17669 (if (featurep 'xemacs)
17670 (color-rgb-components
17671 (face-property 'default
17672 (cond ((eq attr :foreground) 'foreground)
17673 ((eq attr :background) 'background))))
17674 (color-values (face-attribute 'default attr nil))))))
17676 (defun org-latex-color (attr)
17677 "Return a RGB color for the LaTeX color package."
17678 (apply 'format "%s,%s,%s"
17679 (mapcar 'org-normalize-color
17680 (if (featurep 'xemacs)
17681 (color-rgb-components
17682 (face-property 'default
17683 (cond ((eq attr :foreground) 'foreground)
17684 ((eq attr :background) 'background))))
17685 (color-values (face-attribute 'default attr nil))))))
17687 (defun org-latex-color-format (color-name)
17688 "Convert COLOR-NAME to a RGB color value."
17689 (apply 'format "%s,%s,%s"
17690 (mapcar 'org-normalize-color
17691 (color-values color-name))))
17693 (defun org-normalize-color (value)
17694 "Return string to be used as color value for an RGB component."
17695 (format "%g" (/ value 65535.0)))
17697 ;; Image display
17700 (defvar org-inline-image-overlays nil)
17701 (make-variable-buffer-local 'org-inline-image-overlays)
17703 (defun org-toggle-inline-images (&optional include-linked)
17704 "Toggle the display of inline images.
17705 INCLUDE-LINKED is passed to `org-display-inline-images'."
17706 (interactive "P")
17707 (if org-inline-image-overlays
17708 (progn
17709 (org-remove-inline-images)
17710 (message "Inline image display turned off"))
17711 (org-display-inline-images include-linked)
17712 (if org-inline-image-overlays
17713 (message "%d images displayed inline"
17714 (length org-inline-image-overlays))
17715 (message "No images to display inline"))))
17717 (defun org-redisplay-inline-images ()
17718 "Refresh the display of inline images."
17719 (interactive)
17720 (if (not org-inline-image-overlays)
17721 (org-toggle-inline-images)
17722 (org-toggle-inline-images)
17723 (org-toggle-inline-images)))
17725 (defun org-display-inline-images (&optional include-linked refresh beg end)
17726 "Display inline images.
17727 Normally only links without a description part are inlined, because this
17728 is how it will work for export. When INCLUDE-LINKED is set, also links
17729 with a description part will be inlined. This can be nice for a quick
17730 look at those images, but it does not reflect what exported files will look
17731 like.
17732 When REFRESH is set, refresh existing images between BEG and END.
17733 This will create new image displays only if necessary.
17734 BEG and END default to the buffer boundaries."
17735 (interactive "P")
17736 (unless refresh
17737 (org-remove-inline-images)
17738 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17739 (save-excursion
17740 (save-restriction
17741 (widen)
17742 (setq beg (or beg (point-min)) end (or end (point-max)))
17743 (goto-char beg)
17745 (substring (org-image-file-name-regexp) 0 -2)
17747 old file ov img)
17748 (while (re-search-forward re end t)
17749 (setq old (get-char-property-and-overlay (match-beginning 1)
17750 'org-image-overlay))
17751 (setq file (expand-file-name
17752 (concat (or (match-string 3) "") (match-string 4))))
17753 (when (file-exists-p file)
17754 (if (and (car-safe old) refresh)
17755 (image-refresh (overlay-get (cdr old) 'display))
17756 (setq img (save-match-data (create-image file)))
17757 (when img
17758 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17759 (overlay-put ov 'display img)
17760 (overlay-put ov 'face 'default)
17761 (overlay-put ov 'org-image-overlay t)
17762 (overlay-put ov 'modification-hooks
17763 (list 'org-display-inline-remove-overlay))
17764 (push ov org-inline-image-overlays)))))))))
17766 (define-obsolete-function-alias
17767 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
17769 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
17770 "Remove inline-display overlay if a corresponding region is modified."
17771 (let ((inhibit-modification-hooks t))
17772 (when (and ov after)
17773 (delete ov org-inline-image-overlays)
17774 (delete-overlay ov))))
17776 (defun org-remove-inline-images ()
17777 "Remove inline display of images."
17778 (interactive)
17779 (mapc 'delete-overlay org-inline-image-overlays)
17780 (setq org-inline-image-overlays nil))
17782 ;;;; Key bindings
17784 ;; Outline functions from `outline-mode-prefix-map'
17785 ;; that can be remapped in Org:
17786 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17787 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17788 (define-key org-mode-map [remap outline-forward-same-level]
17789 'org-forward-heading-same-level)
17790 (define-key org-mode-map [remap outline-backward-same-level]
17791 'org-backward-heading-same-level)
17792 (define-key org-mode-map [remap show-branches]
17793 'org-kill-note-or-show-branches)
17794 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17795 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17796 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17798 ;; Outline functions from `outline-mode-prefix-map' that can not
17799 ;; be remapped in Org:
17800 ;;
17801 ;; - the column "key binding" shows whether the Outline function is still
17802 ;; available in Org mode on the same key that it has been bound to in
17803 ;; Outline mode:
17804 ;; - "overridden": key used for a different functionality in Org mode
17805 ;; - else: key still bound to the same Outline function in Org mode
17806 ;;
17807 ;; | Outline function | key binding | Org replacement |
17808 ;; |------------------------------------+-------------+-----------------------|
17809 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17810 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17811 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17812 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
17813 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17814 ;; | `show-entry' | overridden | no replacement |
17815 ;; | `show-children' | `C-c C-i' | visibility cycling |
17816 ;; | `show-branches' | `C-c C-k' | still same function |
17817 ;; | `show-subtree' | overridden | visibility cycling |
17818 ;; | `show-all' | overridden | no replacement |
17819 ;; | `hide-subtree' | overridden | visibility cycling |
17820 ;; | `hide-body' | overridden | no replacement |
17821 ;; | `hide-entry' | overridden | visibility cycling |
17822 ;; | `hide-leaves' | overridden | no replacement |
17823 ;; | `hide-sublevels' | overridden | no replacement |
17824 ;; | `hide-other' | overridden | no replacement |
17826 ;; Make `C-c C-x' a prefix key
17827 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17829 ;; TAB key with modifiers
17830 (org-defkey org-mode-map "\C-i" 'org-cycle)
17831 (org-defkey org-mode-map [(tab)] 'org-cycle)
17832 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17834 ;; The following line is necessary under Suse GNU/Linux
17835 (unless (featurep 'xemacs)
17836 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17837 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17838 (define-key org-mode-map [backtab] 'org-shifttab)
17840 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17841 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17842 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17844 ;; Cursor keys with modifiers
17845 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17846 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17847 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17848 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17850 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17851 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17852 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17853 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17855 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17856 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17857 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17858 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17860 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17861 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17862 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17863 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17865 ;; Babel keys
17866 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17867 (mapc (lambda (pair)
17868 (define-key org-babel-map (car pair) (cdr pair)))
17869 org-babel-key-bindings)
17871 ;;; Extra keys for tty access.
17872 ;; We only set them when really needed because otherwise the
17873 ;; menus don't show the simple keys
17875 (when (or org-use-extra-keys
17876 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17877 (not window-system))
17878 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17879 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17880 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17881 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17882 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17883 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17884 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17885 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17886 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17887 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17888 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17889 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17890 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17891 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17892 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17893 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17894 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17895 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17896 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17897 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17898 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17899 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17900 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17901 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17902 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17903 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17904 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17905 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17907 ;; All the other keys
17909 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17910 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17911 (if (boundp 'narrow-map)
17912 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17913 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17914 (if (boundp 'narrow-map)
17915 (org-defkey narrow-map "b" 'org-narrow-to-block)
17916 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17917 (if (boundp 'narrow-map)
17918 (org-defkey narrow-map "e" 'org-narrow-to-element)
17919 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
17920 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
17921 (org-defkey org-mode-map "\M-}" 'org-forward-element)
17922 (org-defkey org-mode-map "\M-{" 'org-backward-element)
17923 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
17924 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
17925 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
17926 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
17927 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17928 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17929 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17930 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17931 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17932 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17933 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17934 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17935 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17936 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17937 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17938 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17939 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17940 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17941 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17943 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17944 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17945 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17946 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17947 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17948 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17949 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17950 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17951 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17952 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
17953 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17954 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17955 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17956 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17957 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17958 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17959 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17960 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17961 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17962 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17963 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17965 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17966 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17967 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17968 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17969 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17970 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17971 (org-defkey org-mode-map "\C-c^" 'org-sort)
17972 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17973 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17974 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17975 (org-defkey org-mode-map "\C-m" 'org-return)
17976 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17977 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17978 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17979 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17980 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17981 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17982 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17983 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17984 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17985 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17986 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17987 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17988 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17989 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17990 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17991 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17992 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17993 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17994 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17995 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17996 (org-defkey org-mode-map "\M-h" 'org-mark-element)
17997 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17998 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
18000 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
18001 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
18002 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
18004 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
18005 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
18006 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
18007 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
18008 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
18009 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
18010 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
18011 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
18012 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
18013 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
18014 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
18015 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
18016 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
18018 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
18019 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
18020 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
18021 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
18022 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
18023 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
18024 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
18025 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
18027 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
18028 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
18029 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
18030 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
18031 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
18033 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
18035 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
18037 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
18038 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
18040 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
18043 (when (featurep 'xemacs)
18044 (org-defkey org-mode-map 'button3 'popup-mode-menu))
18047 (defconst org-speed-commands-default
18048 '(
18049 ("Outline Navigation")
18050 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
18051 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
18052 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
18053 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
18054 ("u" . (org-speed-move-safe 'outline-up-heading))
18055 ("j" . org-goto)
18056 ("g" . (org-refile t))
18057 ("Outline Visibility")
18058 ("c" . org-cycle)
18059 ("C" . org-shifttab)
18060 (" " . org-display-outline-path)
18061 (":" . org-columns)
18062 ("Outline Structure Editing")
18063 ("U" . org-shiftmetaup)
18064 ("D" . org-shiftmetadown)
18065 ("r" . org-metaright)
18066 ("l" . org-metaleft)
18067 ("R" . org-shiftmetaright)
18068 ("L" . org-shiftmetaleft)
18069 ("i" . (progn (forward-char 1) (call-interactively
18070 'org-insert-heading-respect-content)))
18071 ("^" . org-sort)
18072 ("w" . org-refile)
18073 ("a" . org-archive-subtree-default-with-confirmation)
18074 ("." . org-mark-subtree)
18075 ("#" . org-toggle-comment)
18076 ("Clock Commands")
18077 ("I" . org-clock-in)
18078 ("O" . org-clock-out)
18079 ("Meta Data Editing")
18080 ("t" . org-todo)
18081 ("," . (org-priority))
18082 ("0" . (org-priority ?\ ))
18083 ("1" . (org-priority ?A))
18084 ("2" . (org-priority ?B))
18085 ("3" . (org-priority ?C))
18086 (";" . org-set-tags-command)
18087 ("e" . org-set-effort)
18088 ("E" . org-inc-effort)
18089 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
18090 (org-entry-put (point) "APPT_WARNTIME" m)))
18091 ("Agenda Views etc")
18092 ("v" . org-agenda)
18093 ("/" . org-sparse-tree)
18094 ("Misc")
18095 ("o" . org-open-at-point)
18096 ("?" . org-speed-command-help)
18097 ("<" . (org-agenda-set-restriction-lock 'subtree))
18098 (">" . (org-agenda-remove-restriction-lock))
18099 )
18100 "The default speed commands.")
18102 (defun org-print-speed-command (e)
18103 (if (> (length (car e)) 1)
18104 (progn
18106 (princ (car e))
18108 (princ (make-string (length (car e)) ?-))
18110 (princ (car e))
18111 (princ " ")
18112 (if (symbolp (cdr e))
18113 (princ (symbol-name (cdr e)))
18114 (prin1 (cdr e)))
18117 (defun org-speed-command-help ()
18118 "Show the available speed commands."
18119 (interactive)
18120 (if (not org-use-speed-commands)
18121 (error "Speed commands are not activated, customize `org-use-speed-commands'")
18122 (with-output-to-temp-buffer "*Help*"
18124 (mapc 'org-print-speed-command org-speed-commands-user)
18127 (mapc 'org-print-speed-command org-speed-commands-default))
18128 (with-current-buffer "*Help*"
18129 (setq truncate-lines t))))
18131 (defun org-speed-move-safe (cmd)
18132 "Execute CMD, but make sure that the cursor always ends up in a headline.
18133 If not, return to the original position and throw an error."
18134 (interactive)
18135 (let ((pos (point)))
18136 (call-interactively cmd)
18137 (unless (and (bolp) (org-at-heading-p))
18138 (goto-char pos)
18139 (error "Boundary reached while executing %s" cmd))))
18141 (defvar org-self-insert-command-undo-counter 0)
18143 (defvar org-table-auto-blank-field) ; defined in org-table.el
18144 (defvar org-speed-command nil)
18146 (define-obsolete-function-alias
18147 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
18149 (defun org-speed-command-activate (keys)
18150 "Hook for activating single-letter speed commands.
18151 `org-speed-commands-default' specifies a minimal command set.
18152 Use `org-speed-commands-user' for further customization."
18153 (when (or (and (bolp) (looking-at org-outline-regexp))
18154 (and (functionp org-use-speed-commands)
18155 (funcall org-use-speed-commands)))
18156 (cdr (assoc keys (append org-speed-commands-user
18157 org-speed-commands-default)))))
18159 (define-obsolete-function-alias
18160 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
18162 (defun org-babel-speed-command-activate (keys)
18163 "Hook for activating single-letter code block commands."
18164 (when (and (bolp) (looking-at org-babel-src-block-regexp))
18165 (cdr (assoc keys org-babel-key-bindings))))
18167 (defcustom org-speed-command-hook
18168 '(org-speed-command-default-hook org-babel-speed-command-hook)
18169 "Hook for activating speed commands at strategic locations.
18170 Hook functions are called in sequence until a valid handler is
18171 found.
18173 Each hook takes a single argument, a user-pressed command key
18174 which is also a `self-insert-command' from the global map.
18176 Within the hook, examine the cursor position and the command key
18177 and return nil or a valid handler as appropriate. Handler could
18178 be one of an interactive command, a function, or a form.
18180 Set `org-use-speed-commands' to non-nil value to enable this
18181 hook. The default setting is `org-speed-command-activate'."
18182 :group 'org-structure
18183 :version "24.1"
18184 :type 'hook)
18186 (defun org-self-insert-command (N)
18187 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18188 If the cursor is in a table looking at whitespace, the whitespace is
18189 overwritten, and the table is not marked as requiring realignment."
18190 (interactive "p")
18191 (org-check-before-invisible-edit 'insert)
18192 (cond
18193 ((and org-use-speed-commands
18194 (setq org-speed-command
18195 (run-hook-with-args-until-success
18196 'org-speed-command-hook (this-command-keys))))
18197 (cond
18198 ((commandp org-speed-command)
18199 (setq this-command org-speed-command)
18200 (call-interactively org-speed-command))
18201 ((functionp org-speed-command)
18202 (funcall org-speed-command))
18203 ((and org-speed-command (listp org-speed-command))
18204 (eval org-speed-command))
18205 (t (let (org-use-speed-commands)
18206 (call-interactively 'org-self-insert-command)))))
18207 ((and
18208 (org-table-p)
18209 (progn
18210 ;; check if we blank the field, and if that triggers align
18211 (and (featurep 'org-table) org-table-auto-blank-field
18212 (member last-command
18213 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
18215 ;; got extra space, this field does not determine column width
18216 (let (org-table-may-need-update) (org-table-blank-field))
18217 ;; no extra space, this field may determine column width
18218 (org-table-blank-field)))
18219 t)
18220 (eq N 1)
18222 (let (org-table-may-need-update)
18223 (goto-char (1- (match-end 0)))
18224 (backward-delete-char 1)
18225 (goto-char (match-beginning 0))
18226 (self-insert-command N)))
18227 (t
18228 (setq org-table-may-need-update t)
18229 (self-insert-command N)
18230 (org-fix-tags-on-the-fly)
18231 (if org-self-insert-cluster-for-undo
18232 (if (not (eq last-command 'org-self-insert-command))
18233 (setq org-self-insert-command-undo-counter 1)
18234 (if (>= org-self-insert-command-undo-counter 20)
18235 (setq org-self-insert-command-undo-counter 1)
18236 (and (> org-self-insert-command-undo-counter 0)
18237 buffer-undo-list (listp buffer-undo-list)
18238 (not (cadr buffer-undo-list)) ; remove nil entry
18239 (setcdr buffer-undo-list (cddr buffer-undo-list)))
18240 (setq org-self-insert-command-undo-counter
18241 (1+ org-self-insert-command-undo-counter))))))))
18243 (defun org-check-before-invisible-edit (kind)
18244 "Check is editing if kind KIND would be dangerous with invisible text around.
18245 The detailed reaction depends on the user option `org-catch-invisible-edits'."
18246 ;; First, try to get out of here as quickly as possible, to reduce overhead
18247 (if (and org-catch-invisible-edits
18248 (or (not (boundp 'visible-mode)) (not visible-mode))
18249 (or (get-char-property (point) 'invisible)
18250 (get-char-property (max (point-min) (1- (point))) 'invisible)))
18251 ;; OK, we need to take a closer look
18252 (let* ((invisible-at-point (get-char-property (point) 'invisible))
18253 (invisible-before-point (if (bobp) nil (get-char-property
18254 (1- (point)) 'invisible)))
18255 (border-and-ok-direction
18256 (or
18257 ;; Check if we are acting predictably before invisible text
18258 (and invisible-at-point (not invisible-before-point)
18259 (memq kind '(insert delete-backward)))
18260 ;; Check if we are acting predictably after invisible text
18261 ;; This works not well, and I have turned it off. It seems
18262 ;; better to always show and stop after invisible text.
18263 ;; (and (not invisible-at-point) invisible-before-point
18264 ;; (memq kind '(insert delete)))
18265 )))
18266 (when (or (memq invisible-at-point '(outline org-hide-block t))
18267 (memq invisible-before-point '(outline org-hide-block t)))
18268 (if (eq org-catch-invisible-edits 'error)
18269 (error "Editing in invisible areas is prohibited - make visible first"))
18270 (if (and org-custom-properties-overlays
18271 (y-or-n-p "Display invisible properties in this buffer? "))
18272 (org-toggle-custom-properties-visibility)
18273 ;; Make the area visible
18274 (save-excursion
18275 (if invisible-before-point
18276 (goto-char (previous-single-char-property-change
18277 (point) 'invisible)))
18278 (org-cycle))
18279 (cond
18280 ((eq org-catch-invisible-edits 'show)
18281 ;; That's it, we do the edit after showing
18282 (message
18283 "Unfolding invisible region around point before editing")
18284 (sit-for 1))
18285 ((and (eq org-catch-invisible-edits 'smart)
18286 border-and-ok-direction)
18287 (message "Unfolding invisible region around point before editing"))
18288 (t
18289 ;; Don't do the edit, make the user repeat it in full visibility
18290 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
18292 (defun org-fix-tags-on-the-fly ()
18293 (when (and (equal (char-after (point-at-bol)) ?*)
18294 (org-at-heading-p))
18295 (org-align-tags-here org-tags-column)))
18297 (defun org-delete-backward-char (N)
18298 "Like `delete-backward-char', insert whitespace at field end in tables.
18299 When deleting backwards, in tables this function will insert whitespace in
18301 still be marked for re-alignment if the field did fill the entire column,
18302 because, in this case the deletion might narrow the column."
18303 (interactive "p")
18304 (org-check-before-invisible-edit 'delete-backward)
18305 (if (and (org-table-p)
18306 (eq N 1)
18307 (string-match "|" (buffer-substring (point-at-bol) (point)))
18308 (looking-at ".*?|"))
18309 (let ((pos (point))
18311 (c org-table-may-need-update))
18312 (backward-delete-char N)
18313 (if (not overwrite-mode)
18314 (progn
18315 (skip-chars-forward "^|")
18316 (insert " ")
18317 (goto-char (1- pos))))
18318 ;; noalign: if there were two spaces at the end, this field
18319 ;; does not determine the width of the column.
18320 (if noalign (setq org-table-may-need-update c)))
18321 (backward-delete-char N)
18322 (org-fix-tags-on-the-fly)))
18324 (defun org-delete-char (N)
18325 "Like `delete-char', but insert whitespace at field end in tables.
18326 When deleting characters, in tables this function will insert whitespace in
18328 still be marked for re-alignment if the field did fill the entire column,
18329 because, in this case the deletion might narrow the column."
18330 (interactive "p")
18331 (org-check-before-invisible-edit 'delete)
18332 (if (and (org-table-p)
18333 (not (bolp))
18334 (not (= (char-after) ?|))
18335 (eq N 1))
18336 (if (looking-at ".*?|")
18337 (let ((pos (point))
18339 (c org-table-may-need-update))
18340 (replace-match (concat
18341 (substring (match-string 0) 1 -1)
18342 " |"))
18343 (goto-char pos)
18344 ;; noalign: if there were two spaces at the end, this field
18345 ;; does not determine the width of the column.
18346 (if noalign (setq org-table-may-need-update c)))
18347 (delete-char N))
18348 (delete-char N)
18349 (org-fix-tags-on-the-fly)))
18351 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
18352 (put 'org-self-insert-command 'delete-selection t)
18353 (put 'orgtbl-self-insert-command 'delete-selection t)
18354 (put 'org-delete-char 'delete-selection 'supersede)
18355 (put 'org-delete-backward-char 'delete-selection 'supersede)
18356 (put 'org-yank 'delete-selection 'yank)
18358 ;; Make `flyspell-mode' delay after some commands
18359 (put 'org-self-insert-command 'flyspell-delayed t)
18360 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
18361 (put 'org-delete-char 'flyspell-delayed t)
18362 (put 'org-delete-backward-char 'flyspell-delayed t)
18364 ;; Make pabbrev-mode expand after org-mode commands
18365 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
18366 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
18368 ;; How to do this: Measure non-white length of current string
18369 ;; If equal to column width, we should realign.
18371 (defun org-remap (map &rest commands)
18372 "In MAP, remap the functions given in COMMANDS.
18373 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
18374 (let (new old)
18375 (while commands
18376 (setq old (pop commands) new (pop commands))
18377 (if (fboundp 'command-remapping)
18378 (org-defkey map (vector 'remap old) new)
18379 (substitute-key-definition old new map global-map)))))
18381 (when (eq org-enable-table-editor 'optimized)
18382 ;; If the user wants maximum table support, we need to hijack
18383 ;; some standard editing functions
18384 (org-remap org-mode-map
18385 'self-insert-command 'org-self-insert-command
18386 'delete-char 'org-delete-char
18387 'delete-backward-char 'org-delete-backward-char)
18388 (org-defkey org-mode-map "|" 'org-force-self-insert))
18390 (defvar org-ctrl-c-ctrl-c-hook nil
18391 "Hook for functions attaching themselves to `C-c C-c'.
18393 This can be used to add additional functionality to the C-c C-c
18394 key which executes context-dependent commands. This hook is run
18395 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
18396 run after the last test.
18398 Each function will be called with no arguments. The function
18399 must check if the context is appropriate for it to act. If yes,
18400 it should do its thing and then return a non-nil value. If the
18401 context is wrong, just do nothing and return nil.")
18403 (defvar org-ctrl-c-ctrl-c-final-hook nil
18404 "Hook for functions attaching themselves to `C-c C-c'.
18406 This can be used to add additional functionality to the C-c C-c
18407 key which executes context-dependent commands. This hook is run
18408 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
18409 before the first test.
18411 Each function will be called with no arguments. The function
18412 must check if the context is appropriate for it to act. If yes,
18413 it should do its thing and then return a non-nil value. If the
18414 context is wrong, just do nothing and return nil.")
18416 (defvar org-tab-first-hook nil
18417 "Hook for functions to attach themselves to TAB.
18418 See `org-ctrl-c-ctrl-c-hook' for more information.
18419 This hook runs as the first action when TAB is pressed, even before
18420 `org-cycle' messes around with the `outline-regexp' to cater for
18421 inline tasks and plain list item folding.
18422 If any function in this hook returns t, any other actions that
18423 would have been caused by TAB (such as table field motion or visibility
18424 cycling) will not occur.")
18426 (defvar org-tab-after-check-for-table-hook nil
18427 "Hook for functions to attach themselves to TAB.
18428 See `org-ctrl-c-ctrl-c-hook' for more information.
18429 This hook runs after it has been established that the cursor is not in a
18430 table, but before checking if the cursor is in a headline or if global cycling
18431 should be done.
18432 If any function in this hook returns t, not other actions like visibility
18433 cycling will be done.")
18435 (defvar org-tab-after-check-for-cycling-hook nil
18436 "Hook for functions to attach themselves to TAB.
18437 See `org-ctrl-c-ctrl-c-hook' for more information.
18438 This hook runs after it has been established that not table field motion and
18439 not visibility should be done because of current context. This is probably
18440 the place where a package like yasnippets can hook in.")
18442 (defvar org-tab-before-tab-emulation-hook nil
18443 "Hook for functions to attach themselves to TAB.
18444 See `org-ctrl-c-ctrl-c-hook' for more information.
18445 This hook runs after every other options for TAB have been exhausted, but
18448 (defvar org-metaleft-hook nil
18449 "Hook for functions attaching themselves to `M-left'.
18450 See `org-ctrl-c-ctrl-c-hook' for more information.")
18451 (defvar org-metaright-hook nil
18452 "Hook for functions attaching themselves to `M-right'.
18453 See `org-ctrl-c-ctrl-c-hook' for more information.")
18454 (defvar org-metaup-hook nil
18455 "Hook for functions attaching themselves to `M-up'.
18456 See `org-ctrl-c-ctrl-c-hook' for more information.")
18457 (defvar org-metadown-hook nil
18458 "Hook for functions attaching themselves to `M-down'.
18459 See `org-ctrl-c-ctrl-c-hook' for more information.")
18460 (defvar org-shiftmetaleft-hook nil
18461 "Hook for functions attaching themselves to `M-S-left'.
18462 See `org-ctrl-c-ctrl-c-hook' for more information.")
18463 (defvar org-shiftmetaright-hook nil
18464 "Hook for functions attaching themselves to `M-S-right'.
18465 See `org-ctrl-c-ctrl-c-hook' for more information.")
18466 (defvar org-shiftmetaup-hook nil
18467 "Hook for functions attaching themselves to `M-S-up'.
18468 See `org-ctrl-c-ctrl-c-hook' for more information.")
18469 (defvar org-shiftmetadown-hook nil
18470 "Hook for functions attaching themselves to `M-S-down'.
18471 See `org-ctrl-c-ctrl-c-hook' for more information.")
18472 (defvar org-metareturn-hook nil
18473 "Hook for functions attaching themselves to `M-RET'.
18474 See `org-ctrl-c-ctrl-c-hook' for more information.")
18475 (defvar org-shiftup-hook nil
18476 "Hook for functions attaching themselves to `S-up'.
18477 See `org-ctrl-c-ctrl-c-hook' for more information.")
18478 (defvar org-shiftup-final-hook nil
18479 "Hook for functions attaching themselves to `S-up'.
18480 This one runs after all other options except shift-select have been excluded.
18481 See `org-ctrl-c-ctrl-c-hook' for more information.")
18482 (defvar org-shiftdown-hook nil
18483 "Hook for functions attaching themselves to `S-down'.
18484 See `org-ctrl-c-ctrl-c-hook' for more information.")
18485 (defvar org-shiftdown-final-hook nil
18486 "Hook for functions attaching themselves to `S-down'.
18487 This one runs after all other options except shift-select have been excluded.
18488 See `org-ctrl-c-ctrl-c-hook' for more information.")
18489 (defvar org-shiftleft-hook nil
18490 "Hook for functions attaching themselves to `S-left'.
18491 See `org-ctrl-c-ctrl-c-hook' for more information.")
18492 (defvar org-shiftleft-final-hook nil
18493 "Hook for functions attaching themselves to `S-left'.
18494 This one runs after all other options except shift-select have been excluded.
18495 See `org-ctrl-c-ctrl-c-hook' for more information.")
18496 (defvar org-shiftright-hook nil
18497 "Hook for functions attaching themselves to `S-right'.
18498 See `org-ctrl-c-ctrl-c-hook' for more information.")
18499 (defvar org-shiftright-final-hook nil
18500 "Hook for functions attaching themselves to `S-right'.
18501 This one runs after all other options except shift-select have been excluded.
18502 See `org-ctrl-c-ctrl-c-hook' for more information.")
18504 (defun org-modifier-cursor-error ()
18505 "Throw an error, a modified cursor command was applied in wrong context."
18506 (error "This command is active in special context like tables, headlines or items"))
18508 (defun org-shiftselect-error ()
18509 "Throw an error because Shift-Cursor command was applied in wrong context."
18510 (if (and (boundp 'shift-select-mode) shift-select-mode)
18511 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
18512 (error "This command works only in special context like headlines or timestamps")))
18514 (defun org-call-for-shift-select (cmd)
18515 (let ((this-command-keys-shift-translated t))
18516 (call-interactively cmd)))
18518 (defun org-shifttab (&optional arg)
18519 "Global visibility cycling or move to previous table field.
18520 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
18521 on context.
18522 See the individual commands for more information."
18523 (interactive "P")
18524 (cond
18525 ((org-at-table-p) (call-interactively 'org-table-previous-field))
18526 ((integerp arg)
18527 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18528 (message "Content view to level: %d" arg)
18529 (org-content (prefix-numeric-value arg2))
18530 (setq org-cycle-global-status 'overview)))
18531 (t (call-interactively 'org-global-cycle))))
18533 (defun org-shiftmetaleft ()
18534 "Promote subtree or delete table column.
18535 Calls `org-promote-subtree', `org-outdent-item-tree', or
18536 `org-table-delete-column', depending on context. See the
18537 individual commands for more information."
18538 (interactive)
18539 (cond
18540 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18541 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18542 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18543 ((if (not (org-region-active-p)) (org-at-item-p)
18544 (save-excursion (goto-char (region-beginning))
18545 (org-at-item-p)))
18546 (call-interactively 'org-outdent-item-tree))
18547 (t (org-modifier-cursor-error))))
18549 (defun org-shiftmetaright ()
18550 "Demote subtree or insert table column.
18551 Calls `org-demote-subtree', `org-indent-item-tree', or
18552 `org-table-insert-column', depending on context. See the
18553 individual commands for more information."
18554 (interactive)
18555 (cond
18556 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18557 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18558 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18559 ((if (not (org-region-active-p)) (org-at-item-p)
18560 (save-excursion (goto-char (region-beginning))
18561 (org-at-item-p)))
18562 (call-interactively 'org-indent-item-tree))
18563 (t (org-modifier-cursor-error))))
18565 (defun org-shiftmetaup (&optional arg)
18566 "Move subtree up or kill table row.
18567 Calls `org-move-subtree-up' or `org-table-kill-row' or
18568 `org-move-item-up' or `org-timestamp-up', depending on context.
18569 See the individual commands for more information."
18570 (interactive "P")
18571 (cond
18572 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18573 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18574 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18575 ((org-at-item-p) (call-interactively 'org-move-item-up))
18576 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18577 (call-interactively 'org-timestamp-up)))
18578 (t (org-modifier-cursor-error))))
18580 (defun org-shiftmetadown (&optional arg)
18581 "Move subtree down or insert table row.
18582 Calls `org-move-subtree-down' or `org-table-insert-row' or
18583 `org-move-item-down' or `org-timestamp-up', depending on context.
18584 See the individual commands for more information."
18585 (interactive "P")
18586 (cond
18587 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18588 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18589 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18590 ((org-at-item-p) (call-interactively 'org-move-item-down))
18591 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18592 (call-interactively 'org-timestamp-down)))
18593 (t (org-modifier-cursor-error))))
18595 (defsubst org-hidden-tree-error ()
18596 (error
18597 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18599 (defun org-metaleft (&optional arg)
18600 "Promote heading or move table column to left.
18601 Calls `org-do-promote' or `org-table-move-column', depending on context.
18602 With no specific context, calls the Emacs default `backward-word'.
18603 See the individual commands for more information."
18604 (interactive "P")
18605 (cond
18606 ((run-hook-with-args-until-success 'org-metaleft-hook))
18607 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18608 ((org-with-limited-levels
18609 (or (org-at-heading-p)
18610 (and (org-region-active-p)
18611 (save-excursion
18612 (goto-char (region-beginning))
18613 (org-at-heading-p)))))
18614 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18615 (call-interactively 'org-do-promote))
18616 ;; At an inline task.
18617 ((org-at-heading-p)
18618 (call-interactively 'org-inlinetask-promote))
18619 ((or (org-at-item-p)
18620 (and (org-region-active-p)
18621 (save-excursion
18622 (goto-char (region-beginning))
18623 (org-at-item-p))))
18624 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18625 (call-interactively 'org-outdent-item))
18626 (t (call-interactively 'backward-word))))
18628 (defun org-metaright (&optional arg)
18629 "Demote a subtree, a list item or move table column to right.
18630 In front of a drawer or a block keyword, indent it correctly.
18631 With no specific context, calls the Emacs default `forward-word'.
18632 See the individual commands for more information."
18633 (interactive "P")
18634 (cond
18635 ((run-hook-with-args-until-success 'org-metaright-hook))
18636 ((org-at-table-p) (call-interactively 'org-table-move-column))
18637 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18638 ((org-at-block-p) (call-interactively 'org-indent-block))
18639 ((org-with-limited-levels
18640 (or (org-at-heading-p)
18641 (and (org-region-active-p)
18642 (save-excursion
18643 (goto-char (region-beginning))
18644 (org-at-heading-p)))))
18645 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18646 (call-interactively 'org-do-demote))
18647 ;; At an inline task.
18648 ((org-at-heading-p)
18649 (call-interactively 'org-inlinetask-demote))
18650 ((or (org-at-item-p)
18651 (and (org-region-active-p)
18652 (save-excursion
18653 (goto-char (region-beginning))
18654 (org-at-item-p))))
18655 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18656 (call-interactively 'org-indent-item))
18657 (t (call-interactively 'forward-word))))
18659 (defun org-check-for-hidden (what)
18660 "Check if there are hidden headlines/items in the current visual line.
18661 WHAT can be either `headlines' or `items'. If the current line is
18662 an outline or item heading and it has a folded subtree below it,
18663 this function returns t, nil otherwise."
18664 (let ((re (cond
18665 ((eq what 'headlines) org-outline-regexp-bol)
18666 ((eq what 'items) (org-item-beginning-re))
18667 (t (error "This should not happen"))))
18668 beg end)
18669 (save-excursion
18670 (catch 'exit
18671 (unless (org-region-active-p)
18672 (setq beg (point-at-bol))
18673 (beginning-of-line 2)
18674 (while (and (not (eobp)) ;; this is like `next-line'
18675 (get-char-property (1- (point)) 'invisible))
18676 (beginning-of-line 2))
18677 (setq end (point))
18678 (goto-char beg)
18679 (goto-char (point-at-eol))
18680 (setq end (max end (point)))
18681 (while (re-search-forward re end t)
18682 (if (get-char-property (match-beginning 0) 'invisible)
18683 (throw 'exit t))))
18684 nil))))
18686 (autoload 'org-element-at-point "org-element")
18687 (autoload 'org-element-type "org-element")
18689 (declare-function org-element-at-point "org-element" (&optional keep-trail))
18690 (declare-function org-element-type "org-element" (element))
18691 (declare-function org-element-contents "org-element" (element))
18692 (declare-function org-element-property "org-element" (property element))
18693 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
18694 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
18695 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
18696 (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
18697 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
18699 (defun org-metaup (&optional arg)
18700 "Move subtree up or move table row up.
18701 Calls `org-move-subtree-up' or `org-table-move-row' or
18702 `org-move-item-up', depending on context. See the individual commands
18703 for more information."
18704 (interactive "P")
18705 (cond
18706 ((run-hook-with-args-until-success 'org-metaup-hook))
18707 ((org-region-active-p)
18708 (let* ((a (min (region-beginning) (region-end)))
18709 (b (1- (max (region-beginning) (region-end))))
18710 (c (save-excursion (goto-char a)
18711 (move-beginning-of-line 0)))
18712 (d (save-excursion (goto-char a)
18713 (move-end-of-line 0) (point))))
18714 (transpose-regions a b c d)
18715 (goto-char c)))
18716 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18717 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18718 ((org-at-item-p) (call-interactively 'org-move-item-up))
18719 (t (org-drag-element-backward))))
18721 (defun org-metadown (&optional arg)
18722 "Move subtree down or move table row down.
18723 Calls `org-move-subtree-down' or `org-table-move-row' or
18724 `org-move-item-down', depending on context. See the individual
18725 commands for more information."
18726 (interactive "P")
18727 (cond
18728 ((run-hook-with-args-until-success 'org-metadown-hook))
18729 ((org-region-active-p)
18730 (let* ((a (min (region-beginning) (region-end)))
18731 (b (max (region-beginning) (region-end)))
18732 (c (save-excursion (goto-char b)
18733 (move-beginning-of-line 1)))
18734 (d (save-excursion (goto-char b)
18735 (move-end-of-line 1) (1+ (point)))))
18736 (transpose-regions a b c d)
18737 (goto-char d)))
18738 ((org-at-table-p) (call-interactively 'org-table-move-row))
18739 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18740 ((org-at-item-p) (call-interactively 'org-move-item-down))
18741 (t (org-drag-element-forward))))
18743 (defun org-shiftup (&optional arg)
18744 "Increase item in timestamp or increase priority of current headline.
18745 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18746 depending on context. See the individual commands for more information."
18747 (interactive "P")
18748 (cond
18749 ((run-hook-with-args-until-success 'org-shiftup-hook))
18750 ((and org-support-shift-select (org-region-active-p))
18751 (org-call-for-shift-select 'previous-line))
18752 ((org-at-timestamp-p t)
18753 (call-interactively (if org-edit-timestamp-down-means-later
18754 'org-timestamp-down 'org-timestamp-up)))
18755 ((and (not (eq org-support-shift-select 'always))
18756 org-enable-priority-commands
18757 (org-at-heading-p))
18758 (call-interactively 'org-priority-up))
18759 ((and (not org-support-shift-select) (org-at-item-p))
18760 (call-interactively 'org-previous-item))
18761 ((org-clocktable-try-shift 'up arg))
18762 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18763 (org-support-shift-select
18764 (org-call-for-shift-select 'previous-line))
18765 (t (org-shiftselect-error))))
18767 (defun org-shiftdown (&optional arg)
18768 "Decrease item in timestamp or decrease priority of current headline.
18769 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18770 depending on context. See the individual commands for more information."
18771 (interactive "P")
18772 (cond
18773 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18774 ((and org-support-shift-select (org-region-active-p))
18775 (org-call-for-shift-select 'next-line))
18776 ((org-at-timestamp-p t)
18777 (call-interactively (if org-edit-timestamp-down-means-later
18778 'org-timestamp-up 'org-timestamp-down)))
18779 ((and (not (eq org-support-shift-select 'always))
18780 org-enable-priority-commands
18781 (org-at-heading-p))
18782 (call-interactively 'org-priority-down))
18783 ((and (not org-support-shift-select) (org-at-item-p))
18784 (call-interactively 'org-next-item))
18785 ((org-clocktable-try-shift 'down arg))
18786 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18787 (org-support-shift-select
18788 (org-call-for-shift-select 'next-line))
18789 (t (org-shiftselect-error))))
18791 (defun org-shiftright (&optional arg)
18792 "Cycle the thing at point or in the current line, depending on context.
18793 Depending on context, this does one of the following:
18795 - switch a timestamp at point one day into the future
18796 - on a headline, switch to the next TODO keyword.
18797 - on an item, switch entire list to the next bullet type
18798 - on a property line, switch to the next allowed value
18799 - on a clocktable definition line, move time block into the future"
18800 (interactive "P")
18801 (cond
18802 ((run-hook-with-args-until-success 'org-shiftright-hook))
18803 ((and org-support-shift-select (org-region-active-p))
18804 (org-call-for-shift-select 'forward-char))
18805 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18806 ((and (not (eq org-support-shift-select 'always))
18807 (org-at-heading-p))
18808 (let ((org-inhibit-logging
18809 (not org-treat-S-cursor-todo-selection-as-state-change))
18810 (org-inhibit-blocking
18811 (not org-treat-S-cursor-todo-selection-as-state-change)))
18812 (org-call-with-arg 'org-todo 'right)))
18813 ((or (and org-support-shift-select
18814 (not (eq org-support-shift-select 'always))
18815 (org-at-item-bullet-p))
18816 (and (not org-support-shift-select) (org-at-item-p)))
18817 (org-call-with-arg 'org-cycle-list-bullet nil))
18818 ((and (not (eq org-support-shift-select 'always))
18819 (org-at-property-p))
18820 (call-interactively 'org-property-next-allowed-value))
18821 ((org-clocktable-try-shift 'right arg))
18822 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18823 (org-support-shift-select
18824 (org-call-for-shift-select 'forward-char))
18825 (t (org-shiftselect-error))))
18827 (defun org-shiftleft (&optional arg)
18828 "Cycle the thing at point or in the current line, depending on context.
18829 Depending on context, this does one of the following:
18831 - switch a timestamp at point one day into the past
18832 - on a headline, switch to the previous TODO keyword.
18833 - on an item, switch entire list to the previous bullet type
18834 - on a property line, switch to the previous allowed value
18835 - on a clocktable definition line, move time block into the past"
18836 (interactive "P")
18837 (cond
18838 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18839 ((and org-support-shift-select (org-region-active-p))
18840 (org-call-for-shift-select 'backward-char))
18841 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18842 ((and (not (eq org-support-shift-select 'always))
18843 (org-at-heading-p))
18844 (let ((org-inhibit-logging
18845 (not org-treat-S-cursor-todo-selection-as-state-change))
18846 (org-inhibit-blocking
18847 (not org-treat-S-cursor-todo-selection-as-state-change)))
18848 (org-call-with-arg 'org-todo 'left)))
18849 ((or (and org-support-shift-select
18850 (not (eq org-support-shift-select 'always))
18851 (org-at-item-bullet-p))
18852 (and (not org-support-shift-select) (org-at-item-p)))
18853 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18854 ((and (not (eq org-support-shift-select 'always))
18855 (org-at-property-p))
18856 (call-interactively 'org-property-previous-allowed-value))
18857 ((org-clocktable-try-shift 'left arg))
18858 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18859 (org-support-shift-select
18860 (org-call-for-shift-select 'backward-char))
18861 (t (org-shiftselect-error))))
18863 (defun org-shiftcontrolright ()
18864 "Switch to next TODO set."
18865 (interactive)
18866 (cond
18867 ((and org-support-shift-select (org-region-active-p))
18868 (org-call-for-shift-select 'forward-word))
18869 ((and (not (eq org-support-shift-select 'always))
18870 (org-at-heading-p))
18871 (org-call-with-arg 'org-todo 'nextset))
18872 (org-support-shift-select
18873 (org-call-for-shift-select 'forward-word))
18874 (t (org-shiftselect-error))))
18876 (defun org-shiftcontrolleft ()
18877 "Switch to previous TODO set."
18878 (interactive)
18879 (cond
18880 ((and org-support-shift-select (org-region-active-p))
18881 (org-call-for-shift-select 'backward-word))
18882 ((and (not (eq org-support-shift-select 'always))
18883 (org-at-heading-p))
18884 (org-call-with-arg 'org-todo 'previousset))
18885 (org-support-shift-select
18886 (org-call-for-shift-select 'backward-word))
18887 (t (org-shiftselect-error))))
18889 (defun org-shiftcontrolup ()
18890 "Change timestamps synchronously up in CLOCK log lines."
18891 (interactive)
18892 (cond ((and (not org-support-shift-select)
18893 (org-at-clock-log-p)
18894 (org-at-timestamp-p t))
18895 (org-clock-timestamps-up))
18896 (t (org-shiftselect-error))))
18898 (defun org-shiftcontroldown ()
18899 "Change timestamps synchronously down in CLOCK log lines."
18900 (interactive)
18901 (cond ((and (not org-support-shift-select)
18902 (org-at-clock-log-p)
18903 (org-at-timestamp-p t))
18904 (org-clock-timestamps-down))
18905 (t (org-shiftselect-error))))
18907 (defun org-ctrl-c-ret ()
18908 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18909 (interactive)
18910 (cond
18911 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18912 (t (call-interactively 'org-insert-heading))))
18914 (defun org-find-visible ()
18915 (let ((s (point)))
18916 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18917 (get-char-property s 'invisible)))
18918 s))
18919 (defun org-find-invisible ()
18920 (let ((s (point)))
18921 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18922 (not (get-char-property s 'invisible))))
18923 s))
18925 (defun org-copy-visible (beg end)
18926 "Copy the visible parts of the region."
18927 (interactive "r")
18928 (let (snippets s)
18929 (save-excursion
18930 (save-restriction
18931 (narrow-to-region beg end)
18932 (setq s (goto-char (point-min)))
18933 (while (not (= (point) (point-max)))
18934 (goto-char (org-find-invisible))
18935 (push (buffer-substring s (point)) snippets)
18936 (setq s (goto-char (org-find-visible))))))
18937 (kill-new (apply 'concat (nreverse snippets)))))
18939 (defun org-copy-special ()
18940 "Copy region in table or copy current subtree.
18941 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18942 See the individual commands for more information."
18943 (interactive)
18944 (call-interactively
18945 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18947 (defun org-cut-special ()
18948 "Cut region in table or cut current subtree.
18949 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18950 See the individual commands for more information."
18951 (interactive)
18952 (call-interactively
18953 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18955 (defun org-paste-special (arg)
18956 "Paste rectangular region into table, or past subtree relative to level.
18957 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18958 See the individual commands for more information."
18959 (interactive "P")
18960 (if (org-at-table-p)
18961 (org-table-paste-rectangle)
18962 (org-paste-subtree arg)))
18964 (defsubst org-in-fixed-width-region-p ()
18965 "Is point in a fixed-width region?"
18966 (save-match-data
18967 (eq 'fixed-width (org-element-type (org-element-at-point)))))
18969 (defun org-edit-special (&optional arg)
18970 "Call a special editor for the stuff at point.
18971 When at a table, call the formula editor with `org-table-edit-formulas'.
18972 When in a source code block, call `org-edit-src-code'.
18973 When in a fixed-width region, call `org-edit-fixed-width-region'.
18974 When in an #+include line, visit the included file.
18975 On a link, call `ffap' to visit the link at point.
18976 Otherwise, return a user error."
18977 (interactive)
18978 ;; possibly prep session before editing source
18979 (when (and (org-in-src-block-p) arg)
18980 (let* ((info (org-babel-get-src-block-info))
18981 (lang (nth 0 info))
18982 (params (nth 2 info))
18983 (session (cdr (assoc :session params))))
18984 (when (and info session) ;; we are in a source-code block with a session
18985 (funcall
18986 (intern (concat "org-babel-prep-session:" lang)) session params))))
18987 (cond ;; proceed with `org-edit-special'
18988 ((save-excursion
18989 (beginning-of-line 1)
18990 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18991 (find-file (org-trim (match-string 1))))
18992 ((or (org-at-table-p)
18993 (save-excursion
18994 (beginning-of-line 1)
18996 (call-interactively 'org-table-edit-formulas))
18997 ((or (org-in-block-p '("src" "example" "verbatim"))
18998 (org-at-table.el-p))
18999 (org-edit-src-code))
19000 ((org-in-fixed-width-region-p) (org-edit-fixed-width-region))
19001 ((org-at-regexp-p org-any-link-re) (call-interactively 'ffap))
19002 (t (user-error "No special environment to edit here"))))
19004 (defvar org-table-coordinate-overlays) ; defined in org-table.el
19005 (defun org-ctrl-c-ctrl-c (&optional arg)
19006 "Set tags in headline, or update according to changed information at point.
19008 This command does many different things, depending on context:
19010 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
19011 this is what we do.
19013 - If the cursor is on a statistics cookie, update it.
19015 - If the cursor is in a headline, prompt for tags and insert them
19016 into the current line, aligned to `org-tags-column'. When called
19017 with prefix arg, realign all tags in the current buffer.
19019 - If the cursor is in one of the special #+KEYWORD lines, this
19020 triggers scanning the buffer for these lines and updating the
19021 information.
19023 - If the cursor is inside a table, realign the table. This command
19024 works even if the automatic table editor has been turned off.
19026 - If the cursor is on a #+TBLFM line, re-apply the formulas to
19027 the entire table.
19029 - If the cursor is at a footnote reference or definition, jump to
19030 the corresponding definition or references, respectively.
19032 - If the cursor is a the beginning of a dynamic block, update it.
19034 - If the current buffer is a capture buffer, close note and file it.
19036 - If the cursor is on a <<<target>>>, update radio targets and
19037 corresponding links in this buffer.
19039 - If the cursor is on a numbered item in a plain list, renumber the
19040 ordered list.
19042 - If the cursor is on a checkbox, toggle it.
19044 - If the cursor is on a code block, evaluate it. The variable
19045 `org-confirm-babel-evaluate' can be used to control prompting
19046 before code block evaluation, by default every code block
19047 evaluation requires confirmation. Code block evaluation can be
19048 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
19049 (interactive "P")
19050 (let ((org-enable-table-editor t))
19051 (cond
19052 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
19053 org-occur-highlights
19054 org-latex-fragment-image-overlays)
19055 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
19056 (org-remove-occur-highlights)
19057 (org-remove-latex-fragment-image-overlays)
19058 (message "Temporary highlights/overlays removed from current buffer"))
19059 ((and (local-variable-p 'org-finish-function (current-buffer))
19060 (fboundp org-finish-function))
19061 (funcall org-finish-function))
19062 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
19063 ((org-in-regexp org-ts-regexp-both)
19064 (org-timestamp-change 0 'day))
19065 ((or (looking-at org-property-start-re)
19066 (org-at-property-p))
19067 (call-interactively 'org-property-action))
19068 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
19070 (or (org-at-heading-p) (org-at-item-p)))
19071 (call-interactively 'org-update-statistics-cookies))
19072 ((org-at-heading-p) (call-interactively 'org-set-tags))
19073 ((org-at-table.el-p)
19074 (message "Use C-c ' to edit table.el tables"))
19075 ((org-at-table-p)
19076 (org-table-maybe-eval-formula)
19077 (if arg
19078 (call-interactively 'org-table-recalculate)
19079 (org-table-maybe-recalculate-line))
19080 (call-interactively 'org-table-align)
19081 (orgtbl-send-table 'maybe))
19082 ((or (org-footnote-at-reference-p)
19083 (org-footnote-at-definition-p))
19084 (call-interactively 'org-footnote-action))
19085 ((org-at-item-checkbox-p)
19086 ;; Cursor at a checkbox: repair list and update checkboxes. Send
19087 ;; list only if at top item.
19088 (let* ((cbox (match-string 1))
19089 (struct (org-list-struct))
19090 (old-struct (copy-tree struct))
19091 (parents (org-list-parents-alist struct))
19092 (orderedp (org-entry-get nil "ORDERED"))
19093 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19094 block-item)
19095 ;; Use a light version of `org-toggle-checkbox' to avoid
19096 ;; computing list structure twice.
19097 (let ((new-box (cond
19098 ((equal arg '(16)) "[-]")
19099 ((equal arg '(4)) nil)
19100 ((equal "[X]" cbox) "[ ]")
19101 (t "[X]"))))
19102 (if (and firstp arg)
19103 ;; If at first item of sub-list, remove check-box from
19104 ;; every item at the same level.
19105 (mapc
19106 (lambda (pos) (org-list-set-checkbox pos struct new-box))
19107 (org-list-get-all-items
19108 (point-at-bol) struct (org-list-prevs-alist struct)))
19109 (org-list-set-checkbox (point-at-bol) struct new-box)))
19110 ;; Replicate `org-list-write-struct', while grabbing a return
19111 ;; value from `org-list-struct-fix-box'.
19112 (org-list-struct-fix-ind struct parents 2)
19113 (org-list-struct-fix-item-end struct)
19114 (let ((prevs (org-list-prevs-alist struct)))
19115 (org-list-struct-fix-bul struct prevs)
19116 (org-list-struct-fix-ind struct parents)
19117 (setq block-item
19118 (org-list-struct-fix-box struct parents prevs orderedp)))
19119 (org-list-struct-apply-struct struct old-struct)
19120 (org-update-checkbox-count-maybe)
19121 (when block-item
19122 (message
19123 "Checkboxes were removed due to unchecked box at line %d"
19124 (org-current-line block-item)))
19125 (when firstp (org-list-send-list 'maybe))))
19126 ((org-at-item-p)
19127 ;; Cursor at an item: repair list. Do checkbox related actions
19128 ;; only if function was called with an argument. Send list only
19129 ;; if at top item.
19130 (let* ((struct (org-list-struct))
19131 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19132 old-struct)
19133 (when arg
19134 (setq old-struct (copy-tree struct))
19135 (if firstp
19136 ;; If at first item of sub-list, add check-box to every
19137 ;; item at the same level.
19138 (mapc
19139 (lambda (pos)
19140 (unless (org-list-get-checkbox pos struct)
19141 (org-list-set-checkbox pos struct "[ ]")))
19142 (org-list-get-all-items
19143 (point-at-bol) struct (org-list-prevs-alist struct)))
19144 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
19145 (org-list-write-struct
19146 struct (org-list-parents-alist struct) old-struct)
19147 (when arg (org-update-checkbox-count-maybe))
19148 (when firstp (org-list-send-list 'maybe))))
19149 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
19150 ;; Dynamic block
19151 (beginning-of-line 1)
19152 (save-excursion (org-update-dblock)))
19153 ((save-excursion
19154 (let ((case-fold-search t))
19155 (beginning-of-line 1)
19157 (cond
19158 ((or (equal (match-string 1) "TBLFM")
19159 (equal (match-string 1) "tblfm"))
19160 ;; Recalculate the table before this line
19161 (save-excursion
19162 (beginning-of-line 1)
19164 (if (org-at-table-p)
19165 (org-call-with-arg 'org-table-recalculate (or arg t)))))
19166 (t
19167 (let ((org-inhibit-startup-visibility-stuff t)
19168 (org-startup-align-all-tables nil))
19169 (when (boundp 'org-table-coordinate-overlays)
19170 (mapc 'delete-overlay org-table-coordinate-overlays)
19171 (setq org-table-coordinate-overlays nil))
19172 (org-save-outline-visibility 'use-markers (org-mode-restart)))
19173 (message "Local setup has been refreshed"))))
19174 ((org-clock-update-time-maybe))
19175 (t
19176 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19177 (error "C-c C-c can do nothing useful at this location"))))))
19179 (defun org-mode-restart ()
19180 "Restart Org-mode, to scan again for special lines.
19181 Also updates the keyword regular expressions."
19182 (interactive)
19183 (org-mode)
19184 (message "Org-mode restarted"))
19186 (defun org-kill-note-or-show-branches ()
19187 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
19188 (interactive)
19189 (if (not org-finish-function)
19190 (progn
19191 (hide-subtree)
19192 (call-interactively 'show-branches))
19193 (let ((org-note-abort t))
19194 (funcall org-finish-function))))
19196 (defun org-return (&optional indent)
19197 "Goto next table row or insert a newline.
19198 Calls `org-table-next-row' or `newline', depending on context.
19199 See the individual commands for more information."
19200 (interactive)
19201 (let (org-ts-what)
19202 (cond
19203 ((or (bobp) (org-in-src-block-p))
19204 (if indent (newline-and-indent) (newline)))
19205 ((org-at-table-p)
19206 (org-table-justify-field-maybe)
19207 (call-interactively 'org-table-next-row))
19208 ;; when `newline-and-indent' is called within a list, make sure
19209 ;; text moved stays inside the item.
19210 ((and (org-in-item-p) indent)
19211 (if (and (org-at-item-p) (>= (point) (match-end 0)))
19212 (progn
19213 (save-match-data (newline))
19214 (org-indent-line-to (length (match-string 0))))
19215 (let ((ind (org-get-indentation)))
19216 (newline)
19217 (if (org-looking-back org-list-end-re)
19218 (org-indent-line)
19219 (org-indent-line-to ind)))))
19220 ((and org-return-follows-link
19221 (org-at-timestamp-p t)
19222 (not (eq org-ts-what 'after)))
19223 (org-follow-timestamp-link))
19224 ((and org-return-follows-link
19225 (let ((tprop (get-text-property (point) 'face)))
19226 (or (eq tprop 'org-link)
19227 (and (listp tprop) (memq 'org-link tprop)))))
19228 (call-interactively 'org-open-at-point))
19229 ((and (org-at-heading-p)
19230 (looking-at
19232 (org-show-entry)
19233 (end-of-line 1)
19234 (newline))
19235 (t (if indent (newline-and-indent) (newline))))))
19237 (defun org-return-indent ()
19238 "Goto next table row or insert a newline and indent.
19239 Calls `org-table-next-row' or `newline-and-indent', depending on
19240 context. See the individual commands for more information."
19241 (interactive)
19242 (org-return t))
19244 (defun org-ctrl-c-star ()
19245 "Compute table, or change heading status of lines.
19246 Calls `org-table-recalculate' or `org-toggle-heading',
19247 depending on context."
19248 (interactive)
19249 (cond
19250 ((org-at-table-p)
19251 (call-interactively 'org-table-recalculate))
19252 (t
19253 ;; Convert all lines in region to list items
19254 (call-interactively 'org-toggle-heading))))
19256 (defun org-ctrl-c-minus ()
19257 "Insert separator line in table or modify bullet status of line.
19258 Also turns a plain line or a region of lines into list items.
19259 Calls `org-table-insert-hline', `org-toggle-item', or
19260 `org-cycle-list-bullet', depending on context."
19261 (interactive)
19262 (cond
19263 ((org-at-table-p)
19264 (call-interactively 'org-table-insert-hline))
19265 ((org-region-active-p)
19266 (call-interactively 'org-toggle-item))
19267 ((org-in-item-p)
19268 (call-interactively 'org-cycle-list-bullet))
19269 (t
19270 (call-interactively 'org-toggle-item))))
19272 (defun org-toggle-item (arg)
19273 "Convert headings or normal lines to items, items to normal lines.
19274 If there is no active region, only the current line is considered.
19276 If the first non blank line in the region is an headline, convert
19277 all headlines to items, shifting text accordingly.
19279 If it is an item, convert all items to normal lines.
19281 If it is normal text, change region into an item. With a prefix
19282 argument ARG, change each line in region into an item."
19283 (interactive "P")
19284 (let ((shift-text
19285 (function
19286 ;; Shift text in current section to IND, from point to END.
19287 ;; The function leaves point to END line.
19288 (lambda (ind end)
19289 (let ((min-i 1000) (end (copy-marker end)))
19290 ;; First determine the minimum indentation (MIN-I) of
19291 ;; the text.
19292 (save-excursion
19293 (catch 'exit
19294 (while (< (point) end)
19295 (let ((i (org-get-indentation)))
19296 (cond
19297 ;; Skip blank lines and inline tasks.
19299 ((looking-at org-outline-regexp-bol))
19300 ;; We can't find less than 0 indentation.
19301 ((zerop i) (throw 'exit (setq min-i 0)))
19302 ((< i min-i) (setq min-i i))))
19303 (forward-line))))
19304 ;; Then indent each line so that a line indented to
19305 ;; MIN-I becomes indented to IND. Ignore blank lines
19306 ;; and inline tasks in the process.
19307 (let ((delta (- ind min-i)))
19308 (while (< (point) end)
19310 (looking-at org-outline-regexp-bol))
19311 (org-indent-line-to (+ (org-get-indentation) delta)))
19312 (forward-line)))))))
19313 (skip-blanks
19314 (function
19315 ;; Return beginning of first non-blank line, starting from
19316 ;; line at POS.
19317 (lambda (pos)
19318 (save-excursion
19319 (goto-char pos)
19321 (point-at-bol)))))
19322 beg end)
19323 ;; Determine boundaries of changes.
19324 (if (org-region-active-p)
19325 (setq beg (funcall skip-blanks (region-beginning))
19326 end (copy-marker (region-end)))
19327 (setq beg (funcall skip-blanks (point-at-bol))
19328 end (copy-marker (point-at-eol))))
19329 ;; Depending on the starting line, choose an action on the text
19330 ;; between BEG and END.
19331 (org-with-limited-levels
19332 (save-excursion
19333 (goto-char beg)
19334 (cond
19335 ;; Case 1. Start at an item: de-itemize. Note that it only
19336 ;; happens when a region is active: `org-ctrl-c-minus'
19337 ;; would call `org-cycle-list-bullet' otherwise.
19338 ((org-at-item-p)
19339 (while (< (point) end)
19340 (when (org-at-item-p)
19342 (delete-region (point) (match-end 0)))
19343 (forward-line)))
19344 ;; Case 2. Start at an heading: convert to items.
19345 ((org-at-heading-p)
19346 (let* ((bul (org-list-bullet-string "-"))
19347 (bul-len (length bul))
19348 ;; Indentation of the first heading. It should be
19349 ;; relative to the indentation of its parent, if any.
19350 (start-ind (save-excursion
19351 (cond
19352 ((not org-adapt-indentation) 0)
19353 ((not (outline-previous-heading)) 0)
19354 (t (length (match-string 0))))))
19355 ;; Level of first heading. Further headings will be
19356 ;; compared to it to determine hierarchy in the list.
19357 (ref-level (org-reduced-level (org-outline-level))))
19358 (while (< (point) end)
19359 (let* ((level (org-reduced-level (org-outline-level)))
19360 (delta (max 0 (- level ref-level))))
19361 ;; If current headline is less indented than the first
19362 ;; one, set it as reference, in order to preserve
19363 ;; subtrees.
19364 (when (< level ref-level) (setq ref-level level))
19365 (replace-match bul t t)
19366 (org-indent-line-to (+ start-ind (* delta bul-len)))
19367 ;; Ensure all text down to END (or SECTION-END) belongs
19368 ;; to the newly created item.
19369 (let ((section-end (save-excursion
19370 (or (outline-next-heading) (point)))))
19371 (forward-line)
19372 (funcall shift-text
19373 (+ start-ind (* (1+ delta) bul-len))
19374 (min end section-end)))))))
19375 ;; Case 3. Normal line with ARG: turn each non-item line into
19376 ;; an item.
19377 (arg
19378 (while (< (point) end)
19379 (unless (or (org-at-heading-p) (org-at-item-p))
19381 (replace-match
19383 (forward-line)))
19384 ;; Case 4. Normal line without ARG: make the first line of
19385 ;; region an item, and shift indentation of others
19386 ;; lines to set them as item's body.
19387 (t (let* ((bul (org-list-bullet-string "-"))
19388 (bul-len (length bul))
19389 (ref-ind (org-get-indentation)))
19391 (insert bul)
19392 (forward-line)
19393 (while (< (point) end)
19394 ;; Ensure that lines less indented than first one
19395 ;; still get included in item body.
19396 (funcall shift-text
19397 (+ ref-ind bul-len)
19398 (min end (save-excursion (or (outline-next-heading)
19399 (point)))))
19400 (forward-line)))))))))
19402 (defun org-toggle-heading (&optional nstars)
19403 "Convert headings to normal text, or items or text to headings.
19404 If there is no active region, only the current line is considered.
19407 point into heading.
19409 In a region:
19411 - If the first non blank line is an headline, remove the stars
19412 from all headlines in the region.
19414 - If it is a normal line turn each and every normal line (i.e. not an
19415 heading or an item) in the region into a heading.
19417 - If it is a plain list item, turn all plain list items into headings.
19419 When converting a line into a heading, the number of stars is chosen
19420 such that the lines become children of the current entry. However,
19421 when a prefix argument is given, its value determines the number of
19422 stars to add."
19423 (interactive "P")
19424 (let ((skip-blanks
19425 (function
19426 ;; Return beginning of first non-blank line, starting from
19427 ;; line at POS.
19428 (lambda (pos)
19429 (save-excursion
19430 (goto-char pos)
19431 (while (org-at-comment-p) (forward-line))
19433 (point-at-bol)))))
19434 beg end toggled)
19435 ;; Determine boundaries of changes. If a universal prefix has
19436 ;; been given, put the list in a region. If region ends at a bol,
19437 ;; do not consider the last line to be in the region.
19439 (when (and current-prefix-arg (org-at-item-p))
19440 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
19441 (org-mark-element))
19443 (if (org-region-active-p)
19444 (setq beg (funcall skip-blanks (region-beginning))
19445 end (copy-marker (save-excursion
19446 (goto-char (region-end))
19447 (if (bolp) (point) (point-at-eol)))))
19448 (setq beg (funcall skip-blanks (point-at-bol))
19449 end (copy-marker (point-at-eol))))
19450 ;; Ensure inline tasks don't count as headings.
19451 (org-with-limited-levels
19452 (save-excursion
19453 (goto-char beg)
19454 (cond
19455 ;; Case 1. Started at an heading: de-star headings.
19456 ((org-at-heading-p)
19457 (while (< (point) end)
19458 (when (org-at-heading-p t)
19459 (looking-at org-outline-regexp) (replace-match "")
19460 (setq toggled t))
19461 (forward-line)))
19462 ;; Case 2. Started at an item: change items into headlines.
19463 ;; One star will be added by `org-list-to-subtree'.
19464 ((org-at-item-p)
19465 (let* ((stars (make-string
19466 (if nstars
19467 ;; subtract the star that will be added again by
19468 ;; `org-list-to-subtree'
19469 (1- (prefix-numeric-value current-prefix-arg))
19470 (or (org-current-level) 0))
19471 ?*))
19472 (add-stars
19473 (cond (nstars "") ; stars from prefix only
19474 ((equal stars "") "") ; before first heading
19475 (org-odd-levels-only "*") ; inside heading, odd
19476 (t "")))) ; inside heading, oddeven
19477 (while (< (point) end)
19478 (when (org-at-item-p)
19479 ;; Pay attention to cases when region ends before list.
19480 (let* ((struct (org-list-struct))
19481 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
19482 (save-restriction
19483 (narrow-to-region (point) list-end)
19484 (insert
19485 (org-list-to-subtree
19486 (org-list-parse-list t)
19487 '(:istart (concat stars add-stars (funcall get-stars depth))
19488 :icount (concat stars add-stars (funcall get-stars depth)))))))
19489 (setq toggled t))
19490 (forward-line))))
19491 ;; Case 3. Started at normal text: make every line an heading,
19492 ;; skipping headlines and items.
19493 (t (let* ((stars (make-string
19494 (if nstars
19495 (prefix-numeric-value current-prefix-arg)
19496 (or (org-current-level) 0))
19497 ?*))
19498 (add-stars
19499 (cond (nstars "") ; stars from prefix only
19500 ((equal stars "") "*") ; before first heading
19501 (org-odd-levels-only "**") ; inside heading, odd
19502 (t "*"))) ; inside heading, oddeven
19503 (rpl (concat stars add-stars " ")))
19504 (while (< (point) end)
19505 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
19507 (replace-match (concat rpl (match-string 2))) (setq toggled t))
19508 (forward-line)))))))
19509 (unless toggled (message "Cannot toggle heading from here"))))
19511 (defun org-meta-return (&optional arg)
19512 "Insert a new heading or wrap a region in a table.
19513 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
19514 See the individual commands for more information."
19515 (interactive "P")
19516 (cond
19517 ((run-hook-with-args-until-success 'org-metareturn-hook))
19518 ((or (org-at-drawer-p) (org-at-property-p))
19519 (newline-and-indent))
19520 ((org-at-table-p)
19521 (call-interactively 'org-table-wrap-region))
19522 (t (call-interactively 'org-insert-heading))))
19524 ;;; Menu entries
19526 (defsubst org-in-subtree-not-table-p ()
19527 "Are we in a subtree and not in a table?"
19528 (and (not (org-before-first-heading-p))
19529 (not (org-at-table-p))))
19531 ;; Define the Org-mode menus
19532 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
19533 '("Tbl"
19534 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
19535 ["Next Field" org-cycle (org-at-table-p)]
19536 ["Previous Field" org-shifttab (org-at-table-p)]
19537 ["Next Row" org-return (org-at-table-p)]
19538 "--"
19539 ["Blank Field" org-table-blank-field (org-at-table-p)]
19540 ["Edit Field" org-table-edit-field (org-at-table-p)]
19541 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
19542 "--"
19543 ("Column"
19544 ["Move Column Left" org-metaleft (org-at-table-p)]
19545 ["Move Column Right" org-metaright (org-at-table-p)]
19546 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
19547 ["Insert Column" org-shiftmetaright (org-at-table-p)])
19548 ("Row"
19549 ["Move Row Up" org-metaup (org-at-table-p)]
19550 ["Move Row Down" org-metadown (org-at-table-p)]
19551 ["Delete Row" org-shiftmetaup (org-at-table-p)]
19552 ["Insert Row" org-shiftmetadown (org-at-table-p)]
19553 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
19554 "--"
19555 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
19556 ("Rectangle"
19557 ["Copy Rectangle" org-copy-special (org-at-table-p)]
19558 ["Cut Rectangle" org-cut-special (org-at-table-p)]
19559 ["Paste Rectangle" org-paste-special (org-at-table-p)]
19560 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
19561 "--"
19562 ("Calculate"
19563 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
19564 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
19565 ["Edit Formulas" org-edit-special (org-at-table-p)]
19566 "--"
19567 ["Recalculate line" org-table-recalculate (org-at-table-p)]
19568 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
19569 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
19570 "--"
19571 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
19572 "--"
19573 ["Sum Column/Rectangle" org-table-sum
19574 (or (org-at-table-p) (org-region-active-p))]
19575 ["Which Column?" org-table-current-column (org-at-table-p)])
19576 ["Debug Formulas"
19577 org-table-toggle-formula-debugger
19578 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
19579 ["Show Col/Row Numbers"
19580 org-table-toggle-coordinate-overlays
19581 :style toggle
19582 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
19583 "--"
19584 ["Create" org-table-create (and (not (org-at-table-p))
19585 org-enable-table-editor)]
19586 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
19587 ["Import from File" org-table-import (not (org-at-table-p))]
19588 ["Export to File" org-table-export (org-at-table-p)]
19589 "--"
19590 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
19592 (easy-menu-define org-org-menu org-mode-map "Org menu"
19593 '("Org"
19594 ("Show/Hide"
19595 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
19596 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
19597 ["Sparse Tree..." org-sparse-tree t]
19598 ["Reveal Context" org-reveal t]
19599 ["Show All" show-all t]
19600 "--"
19601 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
19602 "--"
19603 ["New Heading" org-insert-heading t]
19604 ("Navigate Headings"
19605 ["Up" outline-up-heading t]
19606 ["Next" outline-next-visible-heading t]
19607 ["Previous" outline-previous-visible-heading t]
19608 ["Next Same Level" outline-forward-same-level t]
19609 ["Previous Same Level" outline-backward-same-level t]
19610 "--"
19611 ["Jump" org-goto t])
19612 ("Edit Structure"
19613 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
19614 "--"
19615 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
19616 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
19617 "--"
19618 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
19619 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
19620 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19621 "--"
19622 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19623 "--"
19624 ["Copy visible text" org-copy-visible t]
19625 "--"
19626 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
19627 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
19628 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
19629 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
19630 "--"
19631 ["Sort Region/Children" org-sort t]
19632 "--"
19633 ["Convert to odd levels" org-convert-to-odd-levels t]
19634 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19635 ("Editing"
19636 ["Emphasis..." org-emphasize t]
19637 ["Edit Source Example" org-edit-special t]
19638 "--"
19639 ["Footnote new/jump" org-footnote-action t]
19640 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19641 ("Archive"
19642 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
19643 "--"
19644 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
19645 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
19646 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
19647 )
19648 "--"
19649 ("Hyperlinks"
19650 ["Store Link (Global)" org-store-link t]
19651 ["Find existing link to here" org-occur-link-in-agenda-files t]
19652 ["Insert Link" org-insert-link t]
19653 ["Follow Link" org-open-at-point t]
19654 "--"
19655 ["Next link" org-next-link t]
19656 ["Previous link" org-previous-link t]
19657 "--"
19658 ["Descriptive Links"
19659 org-toggle-link-display
19660 :style radio
19661 :selected org-descriptive-links
19662 ]
19663 ["Literal Links"
19664 org-toggle-link-display
19665 :style radio
19666 :selected (not org-descriptive-links)])
19667 "--"
19668 ("TODO Lists"
19669 ["TODO/DONE/-" org-todo t]
19670 ("Select keyword"
19671 ["Next keyword" org-shiftright (org-at-heading-p)]
19672 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19673 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19674 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19675 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19676 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19677 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19678 "--"
19679 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19680 :selected org-enforce-todo-dependencies :style toggle :active t]
19681 "Settings for tree at point"
19682 ["Do Children sequentially" org-toggle-ordered-property :style radio
19683 :selected (org-entry-get nil "ORDERED")
19684 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19685 ["Do Children parallel" org-toggle-ordered-property :style radio
19686 :selected (not (org-entry-get nil "ORDERED"))
19687 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19688 "--"
19689 ["Set Priority" org-priority t]
19690 ["Priority Up" org-shiftup t]
19691 ["Priority Down" org-shiftdown t]
19692 "--"
19693 ["Get news from all feeds" org-feed-update-all t]
19694 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19695 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19696 ("TAGS and Properties"
19697 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
19698 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19699 "--"
19700 ["Set property" org-set-property (not (org-before-first-heading-p))]
19701 ["Column view of properties" org-columns t]
19702 ["Insert Column View DBlock" org-insert-columns-dblock t])
19703 ("Dates and Scheduling"
19704 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
19705 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
19706 ("Change Date"
19707 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
19708 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
19709 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
19710 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
19711 ["Compute Time Range" org-evaluate-time-range t]
19712 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
19713 ["Deadline" org-deadline (not (org-before-first-heading-p))]
19714 "--"
19715 ["Custom time format" org-toggle-time-stamp-overlays
19716 :style radio :selected org-display-custom-times]
19717 "--"
19718 ["Goto Calendar" org-goto-calendar t]
19719 ["Date from Calendar" org-date-from-calendar t]
19720 "--"
19721 ["Start/Restart Timer" org-timer-start t]
19722 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19723 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19724 ["Insert Timer String" org-timer t]
19725 ["Insert Timer Item" org-timer-item t])
19726 ("Logging work"
19727 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19728 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19729 ["Clock out" org-clock-out t]
19730 ["Clock cancel" org-clock-cancel t]
19731 "--"
19732 ["Mark as default task" org-clock-mark-default-task t]
19733 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19734 ["Goto running clock" org-clock-goto t]
19735 "--"
19736 ["Display times" org-clock-display t]
19737 ["Create clock table" org-clock-report t]
19738 "--"
19739 ["Record DONE time"
19740 (progn (setq org-log-done (not org-log-done))
19741 (message "Switching to %s will %s record a timestamp"
19742 (car org-done-keywords)
19743 (if org-log-done "automatically" "not")))
19744 :style toggle :selected org-log-done])
19745 "--"
19746 ["Agenda Command..." org-agenda t]
19747 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19748 ("File List for Agenda")
19749 ("Special views current file"
19750 ["TODO Tree" org-show-todo-tree t]
19751 ["Check Deadlines" org-check-deadlines t]
19752 ["Timeline" org-timeline t]
19753 ["Tags/Property tree" org-match-sparse-tree t])
19754 "--"
19755 ["Export/Publish..." org-export t]
19756 ("LaTeX"
19757 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19758 :selected org-cdlatex-mode]
19759 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19760 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19761 ["Modify math symbol" org-cdlatex-math-modify
19762 (org-inside-LaTeX-fragment-p)]
19763 ["Insert citation" org-reftex-citation t]
19764 "--"
19765 ["Template for BEAMER" (progn (require 'org-beamer)
19766 (org-insert-beamer-options-template)) t])
19767 "--"
19768 ("MobileOrg"
19769 ["Push Files and Views" org-mobile-push t]
19770 ["Get Captured and Flagged" org-mobile-pull t]
19771 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19772 "--"
19773 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19774 "--"
19775 ("Documentation"
19776 ["Show Version" org-version t]
19777 ["Info Documentation" org-info t])
19778 ("Customize"
19779 ["Browse Org Group" org-customize t]
19780 "--"
19781 ["Expand This Menu" org-create-customize-menu
19782 (fboundp 'customize-menu-create)])
19783 ["Send bug report" org-submit-bug-report t]
19784 "--"
19785 ("Refresh/Reload"
19786 ["Refresh setup current buffer" org-mode-restart t]
19787 ["Reload Org (after update)" org-reload t]
19788 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19789 ))
19791 (defun org-info (&optional node)
19792 "Read documentation for Org-mode in the info system.
19793 With optional NODE, go directly to that node."
19794 (interactive)
19795 (info (format "(org)%s" (or node ""))))
19797 ;;;###autoload
19798 (defun org-submit-bug-report ()
19799 "Submit a bug report on Org-mode via mail.
19801 Don't hesitate to report any problems or inaccurate documentation.
19803 If you don't have setup sending mail from (X)Emacs, please copy the
19804 output buffer into your mail program, as it gives us important
19805 information about your Org-mode version and configuration."
19806 (interactive)
19807 (require 'reporter)
19808 (org-load-modules-maybe)
19809 (org-require-autoloaded-modules)
19810 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19811 (reporter-submit-bug-report
19812 "emacs-orgmode@gnu.org"
19813 (org-version nil 'full)
19814 (let (list)
19815 (save-window-excursion
19816 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19817 (delete-other-windows)
19818 (erase-buffer)
19819 (insert "You are about to submit a bug report to the Org-mode mailing list.
19821 We would like to add your full Org-mode and Outline configuration to the
19822 bug report. This greatly simplifies the work of the maintainer and
19823 other experts on the mailing list.
19825 HOWEVER, some variables you have customized may contain private
19826 information. The names of customers, colleagues, or friends, might
19827 appear in the form of file names, tags, todo states, or search strings.
19828 If you answer yes to the prompt, you might want to check and remove
19829 such private information before sending the email.")
19830 (add-text-properties (point-min) (point-max) '(face org-warning))
19831 (when (yes-or-no-p "Include your Org-mode configuration ")
19832 (mapatoms
19833 (lambda (v)
19834 (and (boundp v)
19836 (or (and (symbol-value v)
19838 (and
19839 (get v 'custom-type) (get v 'standard-value)
19840 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19841 (push v list)))))
19842 (kill-buffer (get-buffer "*Warn about privacy*"))
19843 list))
19844 nil nil
19845 "Remember to cover the basics, that is, what you expected to happen and
19846 what in fact did happen. You don't know how to make a good report? See
19848 http://orgmode.org/manual/Feedback.html#Feedback
19850 Your bug report will be posted to the Org-mode mailing list.
19851 ------------------------------------------------------------------------")
19852 (save-excursion
19857 (defun org-install-agenda-files-menu ()
19858 (let ((bl (buffer-list)))
19859 (save-excursion
19860 (while bl
19861 (set-buffer (pop bl))
19862 (if (derived-mode-p 'org-mode) (setq bl nil)))
19863 (when (derived-mode-p 'org-mode)
19864 (easy-menu-change
19865 '("Org") "File List for Agenda"
19866 (append
19867 (list
19868 ["Edit File List" (org-edit-agenda-file-list) t]
19869 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19870 ["Remove Current File from List" org-remove-file t]
19871 ["Cycle through agenda files" org-cycle-agenda-files t]
19872 ["Occur in all agenda files" org-occur-in-agenda-files t]
19873 "--")
19874 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19876 ;;;; Documentation
19878 (defun org-require-autoloaded-modules ()
19879 (interactive)
19880 (mapc 'require
19881 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19882 org-docbook org-exp org-html org-icalendar
19883 org-id org-latex
19884 org-publish org-remember org-table
19885 org-timer org-xoxo)))
19887 ;;;###autoload
19888 (defun org-reload (&optional uncompiled)
19889 "Reload all org lisp files.
19890 With prefix arg UNCOMPILED, load the uncompiled versions."
19891 (interactive "P")
19892 (require 'find-func)
19894 (dir-org (file-name-directory (org-find-library-dir "org")))
19895 (dir-org-contrib (ignore-errors
19896 (file-name-directory
19897 (org-find-library-dir "org-contribdir"))))
19898 (babel-files
19899 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19900 (append (list nil "comint" "eval" "exp" "keys"
19901 "lob" "ref" "table" "tangle")
19902 (delq nil
19903 (mapcar
19904 (lambda (lang)
19905 (when (cdr lang) (symbol-name (car lang))))
19906 org-babel-load-languages)))))
19907 (files
19908 (append babel-files
19909 (and dir-org-contrib
19910 (directory-files dir-org-contrib t file-re))
19911 (directory-files dir-org t file-re)))
19912 (remove-re (concat (if (featurep 'xemacs)
19913 "org-colview" "org-colview-xemacs")
19915 (setq files (mapcar 'file-name-sans-extension files))
19916 (setq files (mapcar
19917 (lambda (x) (if (string-match remove-re x) nil x))
19918 files))
19919 (setq files (delq nil files))
19920 (mapc
19921 (lambda (f)
19922 (when (featurep (intern (file-name-nondirectory f)))
19923 (if (and (not uncompiled)
19924 (file-exists-p (concat f ".elc")))
19925 (load (concat f ".elc") nil nil 'nosuffix)
19926 (load (concat f ".el") nil nil 'nosuffix))))
19927 files)
19928 (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
19929 (org-version nil 'full 'message))
19931 ;;;###autoload
19932 (defun org-customize ()
19933 "Call the customize function with org as argument."
19934 (interactive)
19935 (org-load-modules-maybe)
19936 (org-require-autoloaded-modules)
19937 (customize-browse 'org))
19939 (defun org-create-customize-menu ()
19940 "Create a full customization menu for Org-mode, insert it into the menu."
19941 (interactive)
19942 (org-load-modules-maybe)
19943 (org-require-autoloaded-modules)
19944 (if (fboundp 'customize-menu-create)
19945 (progn
19946 (easy-menu-change
19947 '("Org") "Customize"
19948 `(["Browse Org group" org-customize t]
19949 "--"
19950 ,(customize-menu-create 'org)
19951 ["Set" Custom-set t]
19952 ["Save" Custom-save t]
19953 ["Reset to Current" Custom-reset-current t]
19954 ["Reset to Saved" Custom-reset-saved t]
19955 ["Reset to Standard Settings" Custom-reset-standard t]))
19957 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19959 ;;;; Miscellaneous stuff
19961 ;;; Generally useful functions
19963 (defun org-get-at-bol (property)
19964 "Get text property PROPERTY at beginning of line."
19965 (get-text-property (point-at-bol) property))
19967 (defun org-find-text-property-in-string (prop s)
19968 "Return the first non-nil value of property PROP in string S."
19969 (or (get-text-property 0 prop s)
19970 (get-text-property (or (next-single-property-change 0 prop s) 0)
19971 prop s)))
19973 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19974 "Display the given MESSAGE as a warning."
19975 (if (fboundp 'display-warning)
19976 (display-warning 'org message
19977 (if (featurep 'xemacs) 'warning :warning))
19978 (let ((buf (get-buffer-create "*Org warnings*")))
19979 (with-current-buffer buf
19980 (goto-char (point-max))
19981 (insert "Warning (Org): " message)
19982 (unless (bolp)
19983 (newline)))
19984 (display-buffer buf)
19985 (sit-for 0))))
19987 (defun org-eval (form)
19988 "Eval FORM and return result."
19989 (condition-case error
19990 (eval form)
19991 (error (format "%%![Error: %s]" error))))
19993 (defun org-in-clocktable-p ()
19994 "Check if the cursor is in a clocktable."
19995 (let ((pos (point)) start)
19996 (save-excursion
19997 (end-of-line 1)
19999 (setq start (match-beginning 0))
20001 (>= (match-end 0) pos)
20002 start))))
20004 (defun org-in-commented-line ()
20005 "Is point in a line starting with `#'?"
20006 (equal (char-after (point-at-bol)) ?#))
20008 (defun org-in-indented-comment-line ()
20009 "Is point in a line starting with `#' after some white space?"
20010 (save-excursion
20011 (save-match-data
20012 (goto-char (point-at-bol))
20015 (defun org-in-verbatim-emphasis ()
20016 (save-match-data
20017 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
20019 (defun org-goto-marker-or-bmk (marker &optional bookmark)
20020 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
20021 (if (and marker (marker-buffer marker)
20022 (buffer-live-p (marker-buffer marker)))
20023 (progn
20024 (org-pop-to-buffer-same-window (marker-buffer marker))
20025 (if (or (> marker (point-max)) (< marker (point-min)))
20026 (widen))
20027 (goto-char marker)
20028 (org-show-context 'org-goto))
20029 (if bookmark
20030 (bookmark-jump bookmark)
20031 (error "Cannot find location"))))
20033 (defun org-quote-csv-field (s)
20034 "Quote field for inclusion in CSV material."
20037 s))
20039 (defun org-force-self-insert (N)
20040 "Needed to enforce self-insert under remapping."
20041 (interactive "p")
20042 (self-insert-command N))
20044 (defun org-string-width (s)
20045 "Compute width of string, ignoring invisible characters.
20046 This ignores character with invisibility property `org-link', and also
20047 characters with property `org-cwidth', because these will become invisible
20048 upon the next fontification round."
20049 (let (b l)
20050 (when (or (eq t buffer-invisibility-spec)
20051 (assq 'org-link buffer-invisibility-spec))
20052 (while (setq b (text-property-any 0 (length s)
20053 'invisible 'org-link s))
20054 (setq s (concat (substring s 0 b)
20055 (substring s (or (next-single-property-change
20056 b 'invisible s) (length s)))))))
20057 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
20058 (setq s (concat (substring s 0 b)
20059 (substring s (or (next-single-property-change
20060 b 'org-cwidth s) (length s))))))
20061 (setq l (string-width s) b -1)
20062 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
20063 (setq l (- l (get-text-property b 'org-dwidth-n s))))
20064 l))
20066 (defun org-shorten-string (s maxlength)
20067 "Shorten string S so tht it is no longer than MAXLENGTH characters.
20068 If the string is shorter or has length MAXLENGTH, just return the
20069 original string. If it is longer, the functions finds a space in the
20070 string, breaks this string off at that locations and adds three dots
20071 as ellipsis. Including the ellipsis, the string will not be longer
20072 than MAXLENGTH. If finding a good breaking point in the string does
20073 not work, the string is just chopped off in the middle of a word
20074 if necessary."
20075 (if (<= (length s) maxlength)
20076 s
20077 (let* ((n (max (- maxlength 4) 1))
20079 (if (string-match re s)
20080 (concat (match-string 1 s) "...")
20081 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
20083 (defun org-get-indentation (&optional line)
20084 "Get the indentation of the current line, interpreting tabs.
20085 When LINE is given, assume it represents a line and compute its indentation."
20086 (if line
20087 (if (string-match "^ *" (org-remove-tabs line))
20088 (match-end 0))
20089 (save-excursion
20090 (beginning-of-line 1)
20092 (current-column))))
20094 (defun org-get-string-indentation (s)
20095 "What indentation has S due to SPACE and TAB at the beginning of the string?"
20096 (let ((n -1) (i 0) (w tab-width) c)
20097 (catch 'exit
20098 (while (< (setq n (1+ n)) (length s))
20099 (setq c (aref s n))
20100 (cond ((= c ?\ ) (setq i (1+ i)))
20102 (t (throw 'exit t)))))
20103 i))
20105 (defun org-remove-tabs (s &optional width)
20106 "Replace tabulators in S with spaces.
20107 Assumes that s is a single line, starting in column 0."
20108 (setq width (or width tab-width))
20110 (setq s (replace-match
20111 (make-string
20112 (- (* width (/ (+ (match-beginning 0) width) width))
20113 (match-beginning 0)) ?\ )
20114 t t s)))
20115 s)
20117 (defun org-fix-indentation (line ind)
20118 "Fix indentation in LINE.
20119 IND is a cons cell with target and minimum indentation.
20120 If the current indentation in LINE is smaller than the minimum,
20121 leave it alone. If it is larger than ind, set it to the target."
20122 (let* ((l (org-remove-tabs line))
20123 (i (org-get-indentation l))
20124 (i1 (car ind)) (i2 (cdr ind)))
20125 (if (>= i i2) (setq l (substring line i2)))
20126 (if (> i1 0)
20127 (concat (make-string i1 ?\ ) l)
20128 l)))
20130 (defun org-remove-indentation (code &optional n)
20131 "Remove the maximum common indentation from the lines in CODE.
20132 N may optionally be the number of spaces to remove."
20133 (with-temp-buffer
20134 (insert code)
20135 (org-do-remove-indentation n)
20136 (buffer-string)))
20138 (defun org-do-remove-indentation (&optional n)
20139 "Remove the maximum common indentation from the buffer."
20140 (untabify (point-min) (point-max))
20141 (let ((min 10000) re)
20142 (if n
20143 (setq min n)
20144 (goto-char (point-min))
20146 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
20147 (unless (or (= min 0) (= min 10000))
20149 (goto-char (point-min))
20150 (while (re-search-forward re nil t)
20151 (replace-match "")
20152 (end-of-line 1))
20153 min)))
20155 (defun org-fill-template (template alist)
20156 "Find each %key of ALIST in TEMPLATE and replace it."
20157 (let ((case-fold-search nil)
20158 entry key value)
20159 (setq alist (sort (copy-sequence alist)
20160 (lambda (a b) (< (length (car a)) (length (car b))))))
20161 (while (setq entry (pop alist))
20162 (setq template
20163 (replace-regexp-in-string
20164 (concat "%" (regexp-quote (car entry)))
20165 (or (cdr entry) "") template t t)))
20166 template))
20168 (defun org-base-buffer (buffer)
20169 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
20170 (if (not buffer)
20171 buffer
20172 (or (buffer-base-buffer buffer)
20173 buffer)))
20175 (defun org-trim (s)
20176 "Remove whitespace at beginning and end of string."
20179 s)
20181 (defun org-wrap (string &optional width lines)
20182 "Wrap string to either a number of lines, or a width in characters.
20183 If WIDTH is non-nil, the string is wrapped to that width, however many lines
20184 that costs. If there is a word longer than WIDTH, the text is actually
20185 wrapped to the length of that word.
20186 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
20187 many lines, whatever width that takes.
20188 The return value is a list of lines, without newlines at the end."
20190 (maxword (apply 'max (mapcar 'org-string-width words)))
20191 w ll)
20192 (cond (width
20193 (org-do-wrap words (max maxword width)))
20194 (lines
20195 (setq w maxword)
20196 (setq ll (org-do-wrap words maxword))
20197 (if (<= (length ll) lines)
20198 ll
20199 (setq ll words)
20200 (while (> (length ll) lines)
20201 (setq w (1+ w))
20202 (setq ll (org-do-wrap words w)))
20203 ll))
20204 (t (error "Cannot wrap this")))))
20206 (defun org-do-wrap (words width)
20207 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
20208 (let (lines line)
20209 (while words
20210 (setq line (pop words))
20211 (while (and words (< (+ (length line) (length (car words))) width))
20212 (setq line (concat line " " (pop words))))
20213 (setq lines (push line lines)))
20214 (nreverse lines)))
20216 (defun org-split-string (string &optional separators)
20217 "Splits STRING into substrings at SEPARATORS.
20218 No empty strings are returned if there are matches at the beginning
20219 and end of string."
20221 (start 0)
20222 notfirst
20223 (list nil))
20224 (while (and (string-match rexp string
20225 (if (and notfirst
20226 (= start (match-beginning 0))
20227 (< start (length string)))
20228 (1+ start) start))
20229 (< (match-beginning 0) (length string)))
20230 (setq notfirst t)
20231 (or (eq (match-beginning 0) 0)
20232 (and (eq (match-beginning 0) (match-end 0))
20233 (eq (match-beginning 0) start))
20234 (setq list
20235 (cons (substring string start (match-beginning 0))
20236 list)))
20237 (setq start (match-end 0)))
20238 (or (eq start (length string))
20239 (setq list
20240 (cons (substring string start)
20241 list)))
20242 (nreverse list)))
20244 (defun org-quote-vert (s)
20246 (while (string-match "|" s)
20248 s)
20250 (defun org-uuidgen-p (s)
20251 "Is S an ID created by UUIDGEN?"
20252 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
20254 (defun org-in-src-block-p (&optional inside)
20255 "Whether point is in a code source block.
20256 When INSIDE is non-nil, don't consider we are within a src block
20257 when point is at #+BEGIN_SRC or #+END_SRC."
20258 (let ((case-fold-search t) ov)
20259 (or (and (setq ov (overlays-at (point)))
20260 (memq 'org-block-background
20261 (overlay-properties (car ov))))
20262 (and (not inside)
20263 (save-match-data
20264 (save-excursion
20265 (beginning-of-line)
20268 (defun org-context ()
20269 "Return a list of contexts of the current cursor position.
20270 If several contexts apply, all are returned.
20271 Each context entry is a list with a symbol naming the context, and
20272 two positions indicating start and end of the context. Possible
20273 contexts are:
20275 :headline anywhere in a headline
20276 :headline-stars on the leading stars in a headline
20277 :todo-keyword on a TODO keyword (including DONE) in a headline
20278 :tags on the TAGS in a headline
20279 :priority on the priority cookie in a headline
20280 :item on the first line of a plain list item
20281 :item-bullet on the bullet/number of a plain list item
20282 :checkbox on the checkbox in a plain list item
20283 :table in an org-mode table
20284 :table-special on a special filed in a table
20285 :table-table in a table.el table
20286 :clocktable in a clocktable
20287 :src-block in a source block
20288 :link on a hyperlink
20289 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
20290 :target on a <<target>>
20291 :radio-target on a <<<radio-target>>>
20292 :latex-fragment on a LaTeX fragment
20293 :latex-preview on a LaTeX fragment with overlaid preview image
20295 This function expects the position to be visible because it uses font-lock
20296 faces as a help to recognize the following contexts: :table-special, :link,
20297 and :keyword."
20298 (let* ((f (get-text-property (point) 'face))
20299 (faces (if (listp f) f (list f)))
20300 (case-fold-search t)
20301 (p (point)) clist o)
20302 ;; First the large context
20303 (cond
20304 ((org-at-heading-p t)
20305 (push (list :headline (point-at-bol) (point-at-eol)) clist)
20306 (when (progn
20307 (beginning-of-line 1)
20308 (looking-at org-todo-line-tags-regexp))
20309 (push (org-point-in-group p 1 :headline-stars) clist)
20310 (push (org-point-in-group p 2 :todo-keyword) clist)
20311 (push (org-point-in-group p 4 :tags) clist))
20312 (goto-char p)
20315 (push (org-point-in-group p 0 :priority) clist)))
20317 ((org-at-item-p)
20318 (push (org-point-in-group p 2 :item-bullet) clist)
20319 (push (list :item (point-at-bol)
20320 (save-excursion (org-end-of-item) (point)))
20321 clist)
20322 (and (org-at-item-checkbox-p)
20323 (push (org-point-in-group p 0 :checkbox) clist)))
20325 ((org-at-table-p)
20326 (push (list :table (org-table-begin) (org-table-end)) clist)
20327 (if (memq 'org-formula faces)
20328 (push (list :table-special
20329 (previous-single-property-change p 'face)
20330 (next-single-property-change p 'face)) clist)))
20331 ((org-at-table-p 'any)
20332 (push (list :table-table) clist)))
20333 (goto-char p)
20335 (let ((case-fold-search t))
20336 ;; New the "medium" contexts: clocktables, source blocks
20337 (cond ((org-in-clocktable-p)
20338 (push (list :clocktable
20340 (search-backward "#+BEGIN: clocktable" nil t))
20341 (match-beginning 0))
20343 (match-end 0))) clist))
20344 ((org-in-src-block-p)
20345 (push (list :src-block
20347 (search-backward "#+BEGIN_SRC" nil t))
20348 (match-beginning 0))
20349 (and (search-forward "#+END_SRC" nil t)
20350 (match-beginning 0))) clist))))
20351 (goto-char p)
20353 ;; Now the small context
20354 (cond
20355 ((org-at-timestamp-p)
20356 (push (org-point-in-group p 0 :timestamp) clist))
20357 ((memq 'org-link faces)
20358 (push (list :link
20359 (previous-single-property-change p 'face)
20360 (next-single-property-change p 'face)) clist))
20361 ((memq 'org-special-keyword faces)
20362 (push (list :keyword
20363 (previous-single-property-change p 'face)
20364 (next-single-property-change p 'face)) clist))
20365 ((org-at-target-p)
20366 (push (org-point-in-group p 0 :target) clist)
20367 (goto-char (1- (match-beginning 0)))
20368 (if (looking-at org-radio-target-regexp)
20369 (push (org-point-in-group p 0 :radio-target) clist))
20370 (goto-char p))
20371 ((setq o (car (delq nil
20372 (mapcar
20373 (lambda (x)
20374 (if (memq x org-latex-fragment-image-overlays) x))
20375 (overlays-at (point))))))
20376 (push (list :latex-fragment
20377 (overlay-start o) (overlay-end o)) clist)
20378 (push (list :latex-preview
20379 (overlay-start o) (overlay-end o)) clist))
20380 ((org-inside-LaTeX-fragment-p)
20381 ;; FIXME: positions wrong.
20382 (push (list :latex-fragment (point) (point)) clist)))
20384 (setq clist (nreverse (delq nil clist)))
20385 clist))
20387 ;; FIXME: Compare with at-regexp-p Do we need both?
20388 (defun org-in-regexp (re &optional nlines visually)
20389 "Check if point is inside a match of regexp.
20390 Normally only the current line is checked, but you can include NLINES extra
20391 lines both before and after point into the search.
20392 If VISUALLY is set, require that the cursor is not after the match but
20393 really on, so that the block visually is on the match."
20394 (catch 'exit
20395 (let ((pos (point))
20396 (eol (point-at-eol (+ 1 (or nlines 0))))
20397 (inc (if visually 1 0)))
20398 (save-excursion
20399 (beginning-of-line (- 1 (or nlines 0)))
20400 (while (re-search-forward re eol t)
20401 (if (and (<= (match-beginning 0) pos)
20402 (>= (+ inc (match-end 0)) pos))
20403 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
20405 (defun org-at-regexp-p (regexp)
20406 "Is point inside a match of REGEXP in the current line?"
20407 (catch 'exit
20408 (save-excursion
20409 (let ((pos (point)) (end (point-at-eol)))
20410 (beginning-of-line 1)
20411 (while (re-search-forward regexp end t)
20412 (if (and (<= (match-beginning 0) pos)
20413 (>= (match-end 0) pos))
20414 (throw 'exit t)))
20415 nil))))
20417 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
20418 "Non-nil when point is between matches of START-RE and END-RE.
20420 Also return a non-nil value when point is on one of the matches.
20422 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
20423 buffer positions. Default values are the positions of headlines
20424 surrounding the point.
20426 The functions returns a cons cell whose car (resp. cdr) is the
20427 position before START-RE (resp. after END-RE)."
20428 (save-match-data
20429 (let ((pos (point))
20430 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
20431 (limit-down (or lim-down (save-excursion (outline-next-heading))))
20432 beg end)
20433 (save-excursion
20434 ;; Point is on a block when on START-RE or if START-RE can be
20435 ;; found before it...
20436 (and (or (org-at-regexp-p start-re)
20437 (re-search-backward start-re limit-up t))
20438 (setq beg (match-beginning 0))
20439 ;; ... and END-RE after it...
20440 (goto-char (match-end 0))
20441 (re-search-forward end-re limit-down t)
20442 (> (setq end (match-end 0)) pos)
20443 ;; ... without another START-RE in-between.
20444 (goto-char (match-beginning 0))
20445 (not (re-search-backward start-re (1+ beg) t))
20446 ;; Return value.
20447 (cons beg end))))))
20449 (defun org-in-block-p (names)
20450 "Non-nil when point belongs to a block whose name belongs to NAMES.
20452 NAMES is a list of strings containing names of blocks.
20454 Return first block name matched, or nil. Beware that in case of
20455 nested blocks, the returned name may not belong to the closest
20456 block from point."
20457 (save-match-data
20458 (catch 'exit
20459 (let ((case-fold-search t)
20460 (lim-up (save-excursion (outline-previous-heading)))
20461 (lim-down (save-excursion (outline-next-heading))))
20462 (mapc (lambda (name)
20463 (let ((n (regexp-quote name)))
20464 (when (org-between-regexps-p
20467 lim-up lim-down)
20468 (throw 'exit n))))
20469 names))
20470 nil)))
20472 (defun org-occur-in-agenda-files (regexp &optional nlines)
20473 "Call `multi-occur' with buffers for all agenda files."
20475 (let* ((files (org-agenda-files))
20476 (tnames (mapcar 'file-truename files))
20477 (extra org-agenda-text-search-extra-files)
20478 f)
20479 (when (eq (car extra) 'agenda-archives)
20480 (setq extra (cdr extra))
20481 (setq files (org-add-archive-files files)))
20482 (while (setq f (pop extra))
20483 (unless (member (file-truename f) tnames)
20484 (add-to-list 'files f 'append)
20485 (add-to-list 'tnames (file-truename f) 'append)))
20486 (multi-occur
20487 (mapcar (lambda (x)
20488 (with-current-buffer
20489 (or (get-file-buffer x) (find-file-noselect x))
20490 (widen)
20491 (current-buffer)))
20492 files)
20493 regexp)))
20495 (if (boundp 'occur-mode-find-occurrence-hook)
20496 ;; Emacs 23
20497 (add-hook 'occur-mode-find-occurrence-hook
20498 (lambda ()
20499 (when (derived-mode-p 'org-mode)
20500 (org-reveal))))
20501 ;; Emacs 22
20502 (defadvice occur-mode-goto-occurrence
20503 (after org-occur-reveal activate)
20504 (and (derived-mode-p 'org-mode) (org-reveal)))
20505 (defadvice occur-mode-goto-occurrence-other-window
20506 (after org-occur-reveal activate)
20507 (and (derived-mode-p 'org-mode) (org-reveal)))
20508 (defadvice occur-mode-display-occurrence
20509 (after org-occur-reveal activate)
20510 (when (derived-mode-p 'org-mode)
20511 (let ((pos (occur-mode-find-occurrence)))
20512 (with-current-buffer (marker-buffer pos)
20513 (save-excursion
20514 (goto-char pos)
20515 (org-reveal)))))))
20517 (defun org-occur-link-in-agenda-files ()
20518 "Create a link and search for it in the agendas.
20519 The link is not stored in `org-stored-links', it is just created
20520 for the search purpose."
20521 (interactive)
20522 (let ((link (condition-case nil
20523 (org-store-link nil)
20524 (error "Unable to create a link to here"))))
20525 (org-occur-in-agenda-files (regexp-quote link))))
20527 (defun org-uniquify (list)
20528 "Remove duplicate elements from LIST."
20529 (let (res)
20530 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
20531 res))
20533 (defun org-delete-all (elts list)
20534 "Remove all elements in ELTS from LIST."
20535 (while elts
20536 (setq list (delete (pop elts) list)))
20537 list)
20539 (defun org-count (cl-item cl-seq)
20540 "Count the number of occurrences of ITEM in SEQ.
20541 Taken from `count' in cl-seq.el with all keyword arguments removed."
20542 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
20543 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
20544 (while (< cl-start cl-end)
20545 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
20546 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
20547 (setq cl-start (1+ cl-start)))
20548 cl-count))
20550 (defun org-remove-if (predicate seq)
20551 "Remove everything from SEQ that fulfills PREDICATE."
20552 (let (res e)
20553 (while seq
20554 (setq e (pop seq))
20555 (if (not (funcall predicate e)) (push e res)))
20556 (nreverse res)))
20558 (defun org-remove-if-not (predicate seq)
20559 "Remove everything from SEQ that does not fulfill PREDICATE."
20560 (let (res e)
20561 (while seq
20562 (setq e (pop seq))
20563 (if (funcall predicate e) (push e res)))
20564 (nreverse res)))
20566 (defun org-reduce (cl-func cl-seq &rest cl-keys)
20567 "Reduce two-argument FUNCTION across SEQ.
20568 Taken from `reduce' in cl-seq.el with all keyword arguments but
20570 (let ((cl-accum (cond ((memq :initial-value cl-keys)
20571 (cadr (memq :initial-value cl-keys)))
20572 (cl-seq (pop cl-seq))
20573 (t (funcall cl-func)))))
20574 (while cl-seq
20575 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
20576 cl-accum))
20578 (defun org-back-over-empty-lines ()
20579 "Move backwards over whitespace, to the beginning of the first empty line.
20580 Returns the number of empty lines passed."
20581 (let ((pos (point)))
20582 (if (cdr (assoc 'heading org-blank-before-new-entry))
20584 (unless (eobp)
20585 (forward-line -1)))
20586 (beginning-of-line 2)
20587 (goto-char (min (point) pos))
20588 (count-lines (point) pos)))
20590 (defun org-skip-whitespace ()
20593 (defun org-point-in-group (point group &optional context)
20594 "Check if POINT is in match-group GROUP.
20595 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
20596 match. If the match group does not exist or point is not inside it,
20597 return nil."
20598 (and (match-beginning group)
20599 (>= point (match-beginning group))
20600 (<= point (match-end group))
20601 (if context
20602 (list context (match-beginning group) (match-end group))
20603 t)))
20605 (defun org-switch-to-buffer-other-window (&rest args)
20606 "Switch to buffer in a second window on the current frame.
20607 In particular, do not allow pop-up frames.
20608 Returns the newly created buffer."
20609 (org-no-popups
20610 (apply 'switch-to-buffer-other-window args)))
20612 (defun org-combine-plists (&rest plists)
20613 "Create a single property list from all plists in PLISTS.
20614 The process starts by copying the first list, and then setting properties
20615 from the other lists. Settings in the last list are the most significant
20616 ones and overrule settings in the other lists."
20617 (let ((rtn (copy-sequence (pop plists)))
20618 p v ls)
20619 (while plists
20620 (setq ls (pop plists))
20621 (while ls
20622 (setq p (pop ls) v (pop ls))
20623 (setq rtn (plist-put rtn p v))))
20624 rtn))
20626 (defun org-replace-escapes (string table)
20627 "Replace %-escapes in STRING with values in TABLE.
20629 The sequences in STRING may contain normal field width and padding information,
20631 so values can contain further %-escapes if they are define later in TABLE."
20632 (let ((tbl (copy-alist table))
20633 (case-fold-search nil)
20634 (pchg 0)
20635 e re rpl)
20636 (while (setq e (pop tbl))
20637 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20638 (when (and (cdr e) (string-match re (cdr e)))
20639 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20640 (safe "SREF"))
20641 (add-text-properties 0 3 (list 'sref sref) safe)
20642 (setcdr e (replace-match safe t t (cdr e)))))
20643 (while (string-match re string)
20644 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20645 (cdr e)))
20646 (setq string (replace-match rpl t t string))))
20647 (while (setq pchg (next-property-change pchg string))
20648 (let ((sref (get-text-property pchg 'sref string)))
20649 (when (and sref (string-match "SREF" string pchg))
20650 (setq string (replace-match sref t t string)))))
20651 string))
20653 (defun org-sublist (list start end)
20654 "Return a section of LIST, from START to END.
20655 Counting starts at 1."
20656 (let (rtn (c start))
20657 (setq list (nthcdr (1- start) list))
20658 (while (and list (<= c end))
20659 (push (pop list) rtn)
20660 (setq c (1+ c)))
20661 (nreverse rtn)))
20663 (defun org-find-base-buffer-visiting (file)
20664 "Like `find-buffer-visiting' but always return the base buffer and
20665 not an indirect buffer."
20666 (let ((buf (or (get-file-buffer file)
20667 (find-buffer-visiting file))))
20668 (if buf
20669 (or (buffer-base-buffer buf) buf)
20670 nil)))
20672 (defun org-image-file-name-regexp (&optional extensions)
20673 "Return regexp matching the file names of images.
20674 If EXTENSIONS is given, only match these."
20675 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20676 (image-file-name-regexp)
20677 (let ((image-file-name-extensions
20678 (or extensions
20679 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20680 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20682 (regexp-opt (nconc (mapcar 'upcase
20683 image-file-name-extensions)
20684 image-file-name-extensions)
20685 t)
20688 (defun org-file-image-p (file &optional extensions)
20689 "Return non-nil if FILE is an image."
20690 (save-match-data
20691 (string-match (org-image-file-name-regexp extensions) file)))
20693 (defun org-get-cursor-date ()
20694 "Return the date at cursor in as a time.
20695 This works in the calendar and in the agenda, anywhere else it just
20696 returns the current time."
20697 (let (date day defd)
20698 (cond
20699 ((eq major-mode 'calendar-mode)
20700 (setq date (calendar-cursor-to-date)
20701 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20702 ((eq major-mode 'org-agenda-mode)
20703 (setq day (get-text-property (point) 'day))
20704 (if day
20705 (setq date (calendar-gregorian-from-absolute day)
20706 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20707 (nth 2 date))))))
20708 (or defd (current-time))))
20710 (defun org-mark-subtree (&optional up)
20711 "Mark the current subtree.
20712 This puts point at the start of the current subtree, and mark at
20713 the end. If a numeric prefix UP is given, move up into the
20714 hierarchy of headlines by UP levels before marking the subtree."
20715 (interactive "P")
20716 (org-with-limited-levels
20717 (cond ((org-at-heading-p) (beginning-of-line))
20718 ((org-before-first-heading-p) (error "Not in a subtree"))
20719 (t (outline-previous-visible-heading 1))))
20720 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
20721 (if (org-called-interactively-p 'any)
20722 (call-interactively 'org-mark-element)
20723 (org-mark-element)))
20725 ;;; Indentation
20727 (defun org-indent-line ()
20728 "Indent line depending on context."
20729 (interactive)
20730 (let* ((pos (point))
20731 (itemp (org-at-item-p))
20732 (case-fold-search t)
20734 (inline-task-p (and (featurep 'org-inlinetask)
20735 (org-inlinetask-in-task-p)))
20736 (inline-re (and inline-task-p
20737 (org-inlinetask-outline-regexp)))
20738 column)
20739 (if (and orgstruct-is-++ (eq pos (point)))
20740 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
20741 (indent-according-to-mode))
20742 (beginning-of-line 1)
20743 (cond
20744 ;; Headings
20745 ((looking-at org-outline-regexp) (setq column 0))
20746 ;; Included files
20748 ;; Footnote definition
20749 ((looking-at org-footnote-definition-re) (setq column 0))
20750 ;; Literal examples
20752 (setq column (org-get-indentation))) ; do nothing
20753 ;; Lists
20754 ((ignore-errors (goto-char (org-in-item-p)))
20755 (setq column (if itemp
20756 (org-get-indentation)
20757 (org-list-item-body-column (point))))
20758 (goto-char pos))
20759 ;; Drawers
20761 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20762 (save-excursion
20763 (goto-char (1- (match-beginning 1)))
20764 (setq column (current-column))))
20765 ;; Special blocks
20767 (save-excursion
20768 (re-search-backward
20770 (setq column (org-get-indentation (match-string 0))))
20773 (save-excursion
20775 (setq column
20776 (cond ((equal (downcase (match-string 1)) "src")
20777 ;; src blocks: let `org-edit-src-exit' handle them
20778 (org-get-indentation))
20779 ((equal (downcase (match-string 1)) "example")
20780 (max (org-get-indentation)
20781 (org-get-indentation (match-string 0))))
20782 (t
20783 (org-get-indentation (match-string 0))))))
20784 ;; This line has nothing special, look at the previous relevant
20785 ;; line to compute indentation
20786 (t
20787 (beginning-of-line 0)
20788 (while (and (not (bobp))
20789 (not (looking-at org-drawer-regexp))
20790 ;; When point started in an inline task, do not move
20791 ;; above task starting line.
20792 (not (and inline-task-p (looking-at inline-re)))
20793 ;; Skip drawers, blocks, empty lines, verbatim,
20794 ;; comments, tables, footnotes definitions, lists,
20795 ;; inline tasks.
20797 (re-search-backward org-drawer-regexp nil t))
20801 (looking-at org-footnote-definition-re)
20802 (and (ignore-errors (goto-char (org-in-item-p)))
20803 (goto-char
20804 (org-list-get-top-point (org-list-struct))))
20805 (and (not inline-task-p)
20806 (featurep 'org-inlinetask)
20807 (org-inlinetask-in-task-p)
20808 (or (org-inlinetask-goto-beginning) t))))
20809 (beginning-of-line 0))
20810 (cond
20811 ;; There was an heading above.
20813 (if (not org-adapt-indentation)
20814 (setq column 0)
20815 (goto-char (match-end 0))
20816 (setq column (current-column))))
20817 ;; A drawer had started and is unfinished
20818 ((looking-at org-drawer-regexp)
20819 (goto-char (1- (match-beginning 1)))
20820 (setq column (current-column)))
20821 ;; Else, nothing noticeable found: get indentation and go on.
20822 (t (setq column (org-get-indentation))))))
20823 ;; Now apply indentation and move cursor accordingly
20824 (goto-char pos)
20825 (if (<= (current-column) (current-indentation))
20826 (org-indent-line-to column)
20827 (save-excursion (org-indent-line-to column)))
20828 ;; Special polishing for properties, see `org-property-format'
20829 (setq column (current-column))
20830 (beginning-of-line 1)
20831 (if (looking-at
20833 (replace-match (concat (match-string 1)
20834 (format org-property-format
20835 (match-string 2) (match-string 3)))
20836 t t))
20837 (org-move-to-column column))))
20839 (defun org-indent-drawer ()
20840 "Indent the drawer at point."
20841 (interactive)
20842 (let ((p (point))
20843 (e (and (save-excursion (re-search-forward ":END:" nil t))
20844 (match-end 0)))
20845 (folded
20846 (save-excursion
20847 (end-of-line)
20848 (when (overlays-at (point))
20849 (member 'invisible (overlay-properties
20850 (car (overlays-at (point)))))))))
20851 (when folded (org-cycle))
20852 (indent-for-tab-command)
20853 (while (and (move-beginning-of-line 2) (< (point) e))
20854 (indent-for-tab-command))
20855 (goto-char p)
20856 (when folded (org-cycle)))
20857 (message "Drawer at point indented"))
20859 (defun org-indent-block ()
20860 "Indent the block at point."
20861 (interactive)
20862 (let ((p (point))
20863 (case-fold-search t)
20865 (match-end 0)))
20866 (folded
20867 (save-excursion
20868 (end-of-line)
20869 (when (overlays-at (point))
20870 (member 'invisible (overlay-properties
20871 (car (overlays-at (point)))))))))
20872 (when folded (org-cycle))
20873 (indent-for-tab-command)
20874 (while (and (move-beginning-of-line 2) (< (point) e))
20875 (indent-for-tab-command))
20876 (goto-char p)
20877 (when folded (org-cycle)))
20878 (message "Block at point indented"))
20880 (defun org-indent-region (start end)
20881 "Indent region."
20882 (interactive "r")
20883 (save-excursion
20884 (let ((line-end (org-current-line end)))
20885 (goto-char start)
20886 (while (< (org-current-line) line-end)
20887 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
20888 (t (call-interactively 'org-indent-line)))
20889 (move-beginning-of-line 2)))))
20892 ;;; Filling
20894 ;; We use our own fill-paragraph and auto-fill functions.
20896 ;; `org-fill-paragraph' relies on adaptive filling and context
20897 ;; checking. Appropriate `fill-prefix' is computed with
20898 ;; `org-adaptive-fill-function'.
20900 ;; `org-auto-fill-function' takes care of auto-filling. It calls
20901 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
20902 ;; `org-adaptive-fill-function' value. Internally,
20903 ;; `org-comment-line-break-function' breaks the line.
20905 ;; `org-setup-filling' installs filling and auto-filling related
20906 ;; variables during `org-mode' initialization.
20908 (defun org-setup-filling ()
20909 (interactive)
20910 ;; Prevent auto-fill from inserting unwanted new items.
20911 (when (boundp 'fill-nobreak-predicate)
20912 (org-set-local
20913 'fill-nobreak-predicate
20914 (org-uniquify
20915 (append fill-nobreak-predicate
20916 '(org-fill-paragraph-separate-nobreak-p
20917 org-fill-line-break-nobreak-p)))))
20918 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20919 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
20920 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20921 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
20923 (defvar org-element-paragraph-separate) ; org-element.el
20924 (defun org-fill-paragraph-separate-nobreak-p ()
20925 "Non-nil when a line break at point would insert a new item."
20926 (looking-at (substring org-element-paragraph-separate 1)))
20928 (defun org-fill-line-break-nobreak-p ()
20929 "Non-nil when a line break at point would create an Org line break."
20930 (save-excursion
20935 (declare-function message-in-body-p "message" ())
20936 (defvar org-element--affiliated-re) ; From org-element.el
20937 (defun org-adaptive-fill-function ()
20938 "Compute a fill prefix for the current line.
20939 Return fill prefix, as a string, or nil if current line isn't
20940 meant to be filled."
20941 (org-with-wide-buffer
20942 (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
20943 ;; FIXME: This is really the job of orgstruct++-mode
20944 (let* ((p (line-beginning-position))
20945 (element (save-excursion (beginning-of-line)
20946 (org-element-at-point)))
20947 (type (org-element-type element))
20948 (post-affiliated
20949 (save-excursion
20950 (goto-char (org-element-property :begin element))
20951 (while (looking-at org-element--affiliated-re) (forward-line))
20952 (point))))
20953 (unless (< p post-affiliated)
20954 (case type
20956 (footnote-definition "")
20957 ((item plain-list)
20958 (make-string (org-list-item-body-column post-affiliated) ? ))
20959 (paragraph
20960 ;; Fill prefix is usually the same as the current line,
20961 ;; except if the paragraph is at the beginning of an item.
20962 (let ((parent (org-element-property :parent element)))
20963 (cond ((eq (org-element-type parent) 'item)
20964 (make-string (org-list-item-body-column
20965 (org-element-property :begin parent))
20966 ? ))
20968 (match-string 0))
20969 (t ""))))
20970 (comment-block
20971 ;; Only fill contents if P is within block boundaries.
20972 (let* ((cbeg (save-excursion (goto-char post-affiliated)
20973 (forward-line)
20974 (point)))
20975 (cend (save-excursion
20976 (goto-char (org-element-property :end element))
20978 (line-beginning-position))))
20979 (when (and (>= p cbeg) (< p cend))
20981 (match-string 0)
20982 ""))))))))))
20984 (declare-function message-goto-body "message" ())
20985 (defvar message-cite-prefix-regexp) ; From message.el
20986 (defvar org-element-all-objects) ; From org-element.el
20987 (defun org-fill-paragraph (&optional justify)
20988 "Fill element at point, when applicable.
20990 This function only applies to comment blocks, comments, example
20991 blocks and paragraphs. Also, as a special case, re-align table
20992 when point is at one.
20994 If JUSTIFY is non-nil (interactively, with prefix argument),
20995 justify as well. If `sentence-end-double-space' is non-nil, then
20996 period followed by one space does not end a sentence, so don't
20997 break a line there. The variable `fill-column' controls the
20998 width for filling.
21000 For convenience, when point is at a plain list, an item or
21001 a footnote definition, try to fill the first paragraph within."
21002 (interactive)
21003 (if (and (derived-mode-p 'message-mode)
21004 (or (not (message-in-body-p))
21005 (save-excursion (move-beginning-of-line 1)
21006 (looking-at message-cite-prefix-regexp))))
21007 ;; First ensure filling is correct in message-mode.
21008 (let ((fill-paragraph-function
21009 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
21010 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
21011 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
21012 (paragraph-separate
21013 (cadadr (assoc 'paragraph-separate org-fb-vars))))
21014 (fill-paragraph nil))
21015 (save-excursion
21016 ;; Move to end of line in order to get the first paragraph
21017 ;; within a plain list or a footnote definition.
21018 (end-of-line)
21019 (let ((element (org-element-at-point)))
21020 ;; First check if point is in a blank line at the beginning of
21021 ;; the buffer. In that case, ignore filling.
21022 (if (< (point) (org-element-property :begin element)) t
21023 (case (org-element-type element)
21024 ;; Use major mode filling function is src blocks.
21025 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
21026 ;; Align Org tables, leave table.el tables as-is.
21027 (table-row (org-table-align) t)
21028 (table
21029 (when (eq (org-element-property :type element) 'org)
21030 (org-table-align))
21031 t)
21032 (paragraph
21033 ;; Paragraphs may contain `line-break' type objects.
21034 (let ((beg (max (point-min)
21035 (org-element-property :contents-begin element)))
21036 (end (min (point-max)
21037 (org-element-property :contents-end element))))
21038 ;; Do nothing if point is at an affiliated keyword.
21039 (if (< (point) beg) t
21040 (when (derived-mode-p 'message-mode)
21041 ;; In `message-mode', do not fill following
21042 ;; citation in current paragraph nor text before
21043 ;; message body.
21044 (let ((body-start (save-excursion (message-goto-body))))
21045 (when body-start (setq beg (max body-start beg))))
21046 (when (save-excursion
21047 (re-search-forward
21048 (concat "^" message-cite-prefix-regexp) end t))
21049 (setq end (match-beginning 0))))
21050 ;; Fill paragraph, taking line breaks into
21051 ;; consideration. For that, slice the paragraph
21052 ;; using line breaks as separators, and fill the
21053 ;; parts in reverse order to avoid messing with
21054 ;; markers.
21055 (save-excursion
21056 (goto-char end)
21057 (mapc
21058 (lambda (pos)
21059 (fill-region-as-paragraph pos (point) justify)
21060 (goto-char pos))
21061 ;; Find the list of ending positions for line
21062 ;; breaks in the current paragraph. Add paragraph
21063 ;; beginning to include first slice.
21064 (nreverse
21065 (cons
21066 beg
21067 (org-element-map
21068 (org-element--parse-objects
21069 beg end nil org-element-all-objects)
21070 'line-break
21071 (lambda (lb) (org-element-property :end lb)))))))
21072 t)))
21073 ;; Contents of `comment-block' type elements should be
21074 ;; filled as plain text, but only if point is within block
21075 ;; markers.
21076 (comment-block
21077 (let* ((case-fold-search t)
21078 (beg (save-excursion
21079 (goto-char (org-element-property :begin element))
21081 (forward-line)
21082 (point)))
21083 (end (save-excursion
21084 (goto-char (org-element-property :end element))
21086 (line-beginning-position))))
21087 (when (and (>= (point) beg) (< (point) end))
21088 (fill-region-as-paragraph
21089 (save-excursion
21090 (end-of-line)
21092 (line-beginning-position))
21093 (save-excursion
21094 (beginning-of-line)
21096 (line-beginning-position))
21097 justify)))
21098 t)
21099 ;; Fill comments.
21100 (comment (fill-comment-paragraph justify))
21101 ;; Ignore every other element.
21102 (otherwise t)))))))
21104 (defun org-auto-fill-function ()
21105 "Auto-fill function."
21106 ;; Check if auto-filling is meaningful.
21107 (let ((fc (current-fill-column)))
21108 (when (and fc (> (current-column) fc))
21109 (let* ((fill-prefix (org-adaptive-fill-function))
21110 ;; Enforce empty fill prefix, if required. Otherwise, it
21111 ;; will be computed again.
21112 (adaptive-fill-mode (not (equal fill-prefix ""))))
21113 (when fill-prefix (do-auto-fill))))))
21115 (defun org-comment-line-break-function (&optional soft)
21116 "Break line at point and indent, continuing comment if within one.
21117 The inserted newline is marked hard if variable
21118 `use-hard-newlines' is true, unless optional argument SOFT is
21119 non-nil."
21121 (save-excursion (forward-char -1) (delete-horizontal-space))
21122 (delete-horizontal-space)
21123 (indent-to-left-margin)
21124 (insert-before-markers-and-inherit fill-prefix))
21127 ;;; Comments
21129 ;; Org comments syntax is quite complex. It requires the entire line
21130 ;; to be just a comment. Also, even with the right syntax at the
21131 ;; beginning of line, some some elements (i.e. verse-block or
21132 ;; example-block) don't accept comments. Usual Emacs comment commands
21133 ;; cannot cope with those requirements. Therefore, Org replaces them.
21135 ;; Org still relies on `comment-dwim', but cannot trust
21136 ;; `comment-only-p'. So, `comment-region-function' and
21137 ;; `uncomment-region-function' both point
21138 ;; to`org-comment-or-uncomment-region'. Eventually,
21139 ;; `org-insert-comment' takes care of insertion of comments at the
21140 ;; beginning of line.
21142 ;; `org-setup-comments-handling' install comments related variables
21143 ;; during `org-mode' initialization.
21145 (defun org-setup-comments-handling ()
21146 (interactive)
21147 (org-set-local 'comment-use-syntax nil)
21148 (org-set-local 'comment-start "# ")
21150 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
21151 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
21152 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
21154 (defun org-insert-comment ()
21155 "Insert an empty comment above current line.
21156 If the line is empty, insert comment at its beginning."
21157 (beginning-of-line)
21159 (org-indent-line)
21160 (insert "# "))
21162 (defvar comment-empty-lines) ; From newcomment.el.
21163 (defun org-comment-or-uncomment-region (beg end &rest ignore)
21164 "Comment or uncomment each non-blank line in the region.
21165 Uncomment each non-blank line between BEG and END if it only
21166 contains commented lines. Otherwise, comment them."
21167 (save-restriction
21168 ;; Restrict region
21169 (narrow-to-region (save-excursion (goto-char beg)
21171 (line-beginning-position))
21172 (save-excursion (goto-char end)
21174 (line-end-position)))
21175 (let ((uncommentp
21176 ;; UNCOMMENTP is non-nil when every non blank line between
21177 ;; BEG and END is a comment.
21178 (save-excursion
21179 (goto-char (point-min))
21180 (while (and (not (eobp))
21181 (let ((element (org-element-at-point)))
21182 (and (eq (org-element-type element) 'comment)
21183 (goto-char (min (point-max)
21184 (org-element-property
21185 :end element)))))))
21186 (eobp))))
21187 (if uncommentp
21188 ;; Only blank lines and comments in region: uncomment it.
21189 (save-excursion
21190 (goto-char (point-min))
21191 (while (not (eobp))
21193 (replace-match "" nil nil nil 1))
21194 (forward-line)))
21195 ;; Comment each line in region.
21196 (let ((min-indent (point-max)))
21197 ;; First find the minimum indentation across all lines.
21198 (save-excursion
21199 (goto-char (point-min))
21200 (while (and (not (eobp)) (not (zerop min-indent)))
21202 (setq min-indent (min min-indent (current-indentation))))
21203 (forward-line)))
21204 ;; Then loop over all lines.
21205 (save-excursion
21206 (goto-char (point-min))
21207 (while (not (eobp))
21209 (org-move-to-column min-indent t)
21210 (insert comment-start))
21211 (forward-line))))))))
21214 ;;; Other stuff.
21216 (defun org-toggle-fixed-width-section (arg)
21217 "Toggle the fixed-width export.
21218 If there is no active region, the QUOTE keyword at the current headline is
21219 inserted or removed. When present, it causes the text between this headline
21220 and the next to be exported as fixed-width text, and unmodified.
21221 If there is an active region, this command adds or removes a colon as the
21222 first character of this line. If the first character of a line is a colon,
21223 this line is also exported in fixed-width font."
21224 (interactive "P")
21225 (let* ((cc 0)
21226 (regionp (org-region-active-p))
21227 (beg (if regionp (region-beginning) (point)))
21228 (end (if regionp (region-end)))
21229 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
21230 (case-fold-search nil)
21232 off)
21233 (if regionp
21234 (save-excursion
21235 (goto-char beg)
21236 (setq cc (current-column))
21237 (beginning-of-line 1)
21238 (setq off (looking-at re))
21239 (while (> nlines 0)
21240 (setq nlines (1- nlines))
21241 (beginning-of-line 1)
21242 (cond
21243 (arg
21244 (org-move-to-column cc t)
21246 (forward-line -1))
21247 ((and off (looking-at re))
21248 (replace-match "" t t nil 1))
21249 ((not off) (org-move-to-column cc t) (insert ": ")))
21250 (forward-line 1)))
21251 (save-excursion
21252 (org-back-to-heading)
21253 (cond
21254 ((looking-at (format org-heading-keyword-regexp-format
21255 org-quote-string))
21256 (goto-char (match-end 1))
21257 (looking-at (concat " +" org-quote-string))
21258 (replace-match "" t t)
21259 (when (eolp) (insert " ")))
21260 ((looking-at org-outline-regexp)
21261 (goto-char (match-end 0))
21262 (insert org-quote-string " ")))))))
21264 (defun org-reftex-citation ()
21265 "Use reftex-citation to insert a citation into the buffer.
21266 This looks for a line like
21268 #+BIBLIOGRAPHY: foo plain option:-d
21270 and derives from it that foo.bib is the bibliography file relevant
21271 for this document. It then installs the necessary environment for RefTeX
21272 to work in this buffer and calls `reftex-citation' to insert a citation
21273 into the buffer.
21275 Export of such citations to both LaTeX and HTML is handled by the contributed
21276 package org-exp-bibtex by Taru Karttunen."
21277 (interactive)
21278 (let ((reftex-docstruct-symbol 'rds)
21280 rds bib)
21281 (save-excursion
21282 (save-restriction
21283 (widen)
21284 (let ((case-fold-search t)
21286 (if (not (save-excursion
21287 (or (re-search-forward re nil t)
21288 (re-search-backward re nil t))))
21289 (error "No bibliography defined in file")
21290 (setq bib (concat (match-string 1) ".bib")
21291 rds (list (list 'bib bib)))))))
21292 (call-interactively 'reftex-citation)))
21294 ;;;; Functions extending outline functionality
21296 (defun org-beginning-of-line (&optional arg)
21297 "Go to the beginning of the current line. If that is invisible, continue
21298 to a visible line beginning. This makes the function of C-a more intuitive.
21299 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
21300 first attempt, and only move to after the tags when the cursor is already
21301 beyond the end of the headline."
21302 (interactive "P")
21303 (let ((pos (point))
21304 (special (if (consp org-special-ctrl-a/e)
21305 (car org-special-ctrl-a/e)
21306 org-special-ctrl-a/e))
21307 refpos)
21308 (if (org-bound-and-true-p visual-line-mode)
21309 (beginning-of-visual-line 1)
21310 (beginning-of-line 1))
21311 (if (and arg (fboundp 'move-beginning-of-line))
21312 (call-interactively 'move-beginning-of-line)
21313 (if (bobp)
21314 nil
21315 (backward-char 1)
21316 (if (org-truely-invisible-p)
21317 (while (and (not (bobp)) (org-truely-invisible-p))
21318 (backward-char 1)
21319 (beginning-of-line 1))
21320 (forward-char 1))))
21321 (when special
21322 (cond
21323 ((and (looking-at org-complex-heading-regexp)
21324 (= (char-after (match-end 1)) ?\ ))
21325 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
21326 (point-at-eol)))
21327 (goto-char
21328 (if (eq special t)
21329 (cond ((> pos refpos) refpos)
21330 ((= pos (point)) refpos)
21331 (t (point)))
21332 (cond ((> pos (point)) (point))
21333 ((not (eq last-command this-command)) (point))
21334 (t refpos)))))
21335 ((org-at-item-p)
21336 ;; Being at an item and not looking at an the item means point
21337 ;; was previously moved to beginning of a visual line, which
21338 ;; doesn't contain the item. Therefore, do nothing special,
21339 ;; just stay here.
21340 (when (looking-at org-list-full-item-re)
21341 ;; Set special position at first white space character after
21342 ;; bullet, and check-box, if any.
21343 (let ((after-bullet
21344 (let ((box (match-end 3)))
21345 (if (not box) (match-end 1)
21346 (let ((after (char-after box)))
21347 (if (and after (= after ? )) (1+ box) box))))))
21348 ;; Special case: Move point to special position when
21349 ;; currently after it or at beginning of line.
21350 (if (eq special t)
21351 (when (or (> pos after-bullet) (= (point) pos))
21352 (goto-char after-bullet))
21353 ;; Reversed case: Move point to special position when
21354 ;; point was already at beginning of line and command is
21355 ;; repeated.
21356 (when (and (= (point) pos) (eq last-command this-command))
21357 (goto-char after-bullet))))))))
21358 (org-no-warnings
21359 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21361 (defun org-end-of-line (&optional arg)
21362 "Go to the end of the line.
21363 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
21364 tags on the first attempt, and only move to after the tags when
21365 the cursor is already beyond the end of the headline."
21366 (interactive "P")
21367 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
21368 org-special-ctrl-a/e))
21369 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
21370 'end-of-visual-line)
21371 ((fboundp 'move-end-of-line) 'move-end-of-line)
21372 (t 'end-of-line))))
21373 (if (or (not special) arg) (call-interactively move-fun)
21374 (let* ((element (save-excursion (beginning-of-line)
21375 (org-element-at-point)))
21376 (type (org-element-type element)))
21377 (cond
21378 ((memq type '(headline inlinetask))
21379 (let ((pos (point)))
21380 (beginning-of-line 1)
21382 (if (eq special t)
21383 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
21384 (goto-char (match-beginning 1))
21385 (goto-char (match-end 0)))
21386 (if (or (< pos (match-end 0))
21387 (not (eq this-command last-command)))
21388 (goto-char (match-end 0))
21389 (goto-char (match-beginning 1))))
21390 (call-interactively move-fun))))
21391 ((org-element-property :hiddenp element)
21392 ;; If element is hidden, `move-end-of-line' would put point
21393 ;; after it. Use `end-of-line' to stay on current line.
21394 (call-interactively 'end-of-line))
21395 (t (call-interactively move-fun)))))
21396 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21398 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
21399 (define-key org-mode-map "\C-e" 'org-end-of-line)
21401 (defun org-backward-sentence (&optional arg)
21402 "Go to beginning of sentence, or beginning of table field.
21403 This will call `backward-sentence' or `org-table-beginning-of-field',
21404 depending on context."
21405 (interactive "P")
21406 (cond
21407 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
21408 (t (call-interactively 'backward-sentence))))
21410 (defun org-forward-sentence (&optional arg)
21411 "Go to end of sentence, or end of table field.
21412 This will call `forward-sentence' or `org-table-end-of-field',
21413 depending on context."
21414 (interactive "P")
21415 (cond
21416 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
21417 (t (call-interactively 'forward-sentence))))
21419 (define-key org-mode-map "\M-a" 'org-backward-sentence)
21420 (define-key org-mode-map "\M-e" 'org-forward-sentence)
21422 (defun org-kill-line (&optional arg)
21423 "Kill line, to tags or end of line."
21424 (interactive "P")
21425 (cond
21426 ((or (not org-special-ctrl-k)
21427 (bolp)
21428 (not (org-at-heading-p)))
21429 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
21430 org-ctrl-k-protect-subtree)
21431 (if (or (eq org-ctrl-k-protect-subtree 'error)
21432 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
21433 (error "C-k aborted - would kill hidden subtree")))
21434 (call-interactively
21435 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
21437 (kill-region (point) (match-beginning 1))
21438 (org-set-tags nil t))
21439 (t (kill-region (point) (point-at-eol)))))
21441 (define-key org-mode-map "\C-k" 'org-kill-line)
21443 (defun org-yank (&optional arg)
21444 "Yank. If the kill is a subtree, treat it specially.
21445 This command will look at the current kill and check if is a single
21446 subtree, or a series of subtrees[1]. If it passes the test, and if the
21447 cursor is at the beginning of a line or after the stars of a currently
21448 empty headline, then the yank is handled specially. How exactly depends
21449 on the value of the following variables, both set by default.
21451 org-yank-folded-subtrees
21452 When set, the subtree(s) will be folded after insertion, but only
21453 if doing so would now swallow text after the yanked text.
21455 org-yank-adjusted-subtrees
21456 When set, the subtree will be promoted or demoted in order to
21457 fit into the local outline tree structure, which means that the level
21458 will be adjusted so that it becomes the smaller one of the two
21459 *visible* surrounding headings.
21461 Any prefix to this command will cause `yank' to be called directly with
21463 will just
21464 plainly yank the text as it is.
21466 \[1] The test checks if the first non-white line is a heading
21467 and if there are no other headings with fewer stars."
21468 (interactive "P")
21469 (org-yank-generic 'yank arg))
21471 (defun org-yank-generic (command arg)
21472 "Perform some yank-like command.
21474 This function implements the behavior described in the `org-yank'
21475 documentation. However, it has been generalized to work for any
21476 interactive command with similar behavior."
21478 ;; pretend to be command COMMAND
21479 (setq this-command command)
21481 (if arg
21482 (call-interactively command)
21484 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
21485 (and (org-kill-is-subtree-p)
21486 (or (bolp)
21488 (string-match
21490 (buffer-substring (point-at-bol) (point)))))))
21491 swallowp)
21492 (cond
21493 ((and subtreep org-yank-folded-subtrees)
21494 (let ((beg (point))
21495 end)
21496 (if (and subtreep org-yank-adjusted-subtrees)
21497 (org-paste-subtree nil nil 'for-yank)
21498 (call-interactively command))
21500 (setq end (point))
21501 (goto-char beg)
21502 (when (and (bolp) subtreep
21503 (not (setq swallowp
21504 (org-yank-folding-would-swallow-text beg end))))
21505 (org-with-limited-levels
21506 (or (looking-at org-outline-regexp)
21507 (re-search-forward org-outline-regexp-bol end t))
21508 (while (and (< (point) end) (looking-at org-outline-regexp))
21509 (hide-subtree)
21510 (org-cycle-show-empty-lines 'folded)
21511 (condition-case nil
21512 (outline-forward-same-level 1)
21513 (error (goto-char end))))))
21514 (when swallowp
21515 (message
21516 "Inserted text not folded because that would swallow text"))
21518 (goto-char end)
21520 (beginning-of-line 1)
21521 (push-mark beg 'nomsg)))
21522 ((and subtreep org-yank-adjusted-subtrees)
21523 (let ((beg (point-at-bol)))
21524 (org-paste-subtree nil nil 'for-yank)
21525 (push-mark beg 'nomsg)))
21526 (t
21527 (call-interactively command))))))
21529 (defun org-yank-folding-would-swallow-text (beg end)
21530 "Would hide-subtree at BEG swallow any text after END?"
21531 (let (level)
21532 (org-with-limited-levels
21533 (save-excursion
21534 (goto-char beg)
21535 (when (or (looking-at org-outline-regexp)
21536 (re-search-forward org-outline-regexp-bol end t))
21537 (setq level (org-outline-level)))
21538 (goto-char end)
21540 (if (or (eobp)
21541 (and (bolp) (looking-at org-outline-regexp)
21542 (<= (org-outline-level) level)))
21543 nil ; Nothing would be swallowed
21544 t))))) ; something would swallow
21546 (define-key org-mode-map "\C-y" 'org-yank)
21548 (defun org-truely-invisible-p ()
21549 "Check if point is at a character currently not visible.
21550 This version does not only check the character property, but also
21551 `visible-mode'."
21552 ;; Early versions of noutline don't have `outline-invisible-p'.
21553 (if (org-bound-and-true-p visible-mode)
21554 nil
21555 (outline-invisible-p)))
21557 (defun org-invisible-p2 ()
21558 "Check if point is at a character currently not visible."
21559 (save-excursion
21560 (if (and (eolp) (not (bobp))) (backward-char 1))
21561 ;; Early versions of noutline don't have `outline-invisible-p'.
21562 (outline-invisible-p)))
21564 (defun org-back-to-heading (&optional invisible-ok)
21565 "Call `outline-back-to-heading', but provide a better error message."
21566 (condition-case nil
21567 (outline-back-to-heading invisible-ok)
21568 (error (error "Before first headline at position %d in buffer %s"
21569 (point) (current-buffer)))))
21571 (defun org-before-first-heading-p ()
21572 "Before first heading?"
21573 (save-excursion
21574 (end-of-line)
21575 (null (re-search-backward org-outline-regexp-bol nil t))))
21577 (defun org-at-heading-p (&optional ignored)
21578 (outline-on-heading-p t))
21579 ;; Compatibility alias with Org versions < 7.8.03
21580 (defalias 'org-on-heading-p 'org-at-heading-p)
21582 (defun org-at-comment-p nil
21583 "Is cursor in a line starting with a # character?"
21584 (save-excursion
21585 (beginning-of-line)
21586 (looking-at "^#")))
21588 (defun org-at-drawer-p nil
21589 "Is cursor at a drawer keyword?"
21590 (save-excursion
21591 (move-beginning-of-line 1)
21592 (looking-at org-drawer-regexp)))
21594 (defun org-at-block-p nil
21595 "Is cursor at a block keyword?"
21596 (save-excursion
21597 (move-beginning-of-line 1)
21598 (looking-at org-block-regexp)))
21600 (defun org-point-at-end-of-empty-headline ()
21601 "If point is at the end of an empty headline, return t, else nil.
21602 If the heading only contains a TODO keyword, it is still still considered
21603 empty."
21605 (when org-todo-line-regexp
21606 (save-excursion
21607 (beginning-of-line 1)
21608 (let ((case-fold-search nil))
21609 (looking-at org-todo-line-regexp)
21610 (string= (match-string 3) ""))))))
21612 (defun org-at-heading-or-item-p ()
21613 (or (org-at-heading-p) (org-at-item-p)))
21615 (defun org-at-target-p ()
21616 (or (org-in-regexp org-radio-target-regexp)
21617 (org-in-regexp org-target-regexp)))
21618 ;; Compatibility alias with Org versions < 7.8.03
21619 (defalias 'org-on-target-p 'org-at-target-p)
21621 (defun org-up-heading-all (arg)
21622 "Move to the heading line of which the present line is a subheading.
21623 This function considers both visible and invisible heading lines.
21624 With argument, move up ARG levels."
21625 (if (fboundp 'outline-up-heading-all)
21626 (outline-up-heading-all arg) ; emacs 21 version of outline.el
21627 (outline-up-heading arg t))) ; emacs 22 version of outline.el
21629 (defun org-up-heading-safe ()
21630 "Move to the heading line of which the present line is a subheading.
21631 This version will not throw an error. It will return the level of the
21632 headline found, or nil if no higher level is found.
21634 Also, this function will be a lot faster than `outline-up-heading',
21635 because it relies on stars being the outline starters. This can really
21636 make a significant difference in outlines with very many siblings."
21637 (let (start-level re)
21638 (org-back-to-heading t)
21639 (setq start-level (funcall outline-level))
21640 (if (equal start-level 1)
21641 nil
21643 (if (re-search-backward re nil t)
21644 (funcall outline-level)))))
21646 (defun org-first-sibling-p ()
21647 "Is this heading the first child of its parents?"
21648 (interactive)
21649 (let ((re org-outline-regexp-bol)
21650 level l)
21651 (unless (org-at-heading-p t)
21652 (error "Not at a heading"))
21653 (setq level (funcall outline-level))
21654 (save-excursion
21655 (if (not (re-search-backward re nil t))
21656 t
21657 (setq l (funcall outline-level))
21658 (< l level)))))
21660 (defun org-goto-sibling (&optional previous)
21661 "Goto the next sibling, even if it is invisible.
21662 When PREVIOUS is set, go to the previous sibling instead. Returns t
21663 when a sibling was found. When none is found, return nil and don't
21664 move point."
21665 (let ((fun (if previous 're-search-backward 're-search-forward))
21666 (pos (point))
21667 (re org-outline-regexp-bol)
21668 level l)
21669 (when (condition-case nil (org-back-to-heading t) (error nil))
21670 (setq level (funcall outline-level))
21671 (catch 'exit
21672 (or previous (forward-char 1))
21673 (while (funcall fun re nil t)
21674 (setq l (funcall outline-level))
21675 (when (< l level) (goto-char pos) (throw 'exit nil))
21676 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
21677 (goto-char pos)
21678 nil))))
21680 (defun org-show-siblings ()
21681 "Show all siblings of the current headline."
21682 (save-excursion
21683 (while (org-goto-sibling) (org-flag-heading nil)))
21684 (save-excursion
21685 (while (org-goto-sibling 'previous)
21686 (org-flag-heading nil))))
21688 (defun org-goto-first-child ()
21689 "Goto the first child, even if it is invisible.
21690 Return t when a child was found. Otherwise don't move point and
21691 return nil."
21692 (let (level (pos (point)) (re org-outline-regexp-bol))
21693 (when (condition-case nil (org-back-to-heading t) (error nil))
21694 (setq level (outline-level))
21695 (forward-char 1)
21696 (if (and (re-search-forward re nil t) (> (outline-level) level))
21697 (progn (goto-char (match-beginning 0)) t)
21698 (goto-char pos) nil))))
21700 (defun org-show-hidden-entry ()
21701 "Show an entry where even the heading is hidden."
21702 (save-excursion
21703 (org-show-entry)))
21705 (defun org-flag-heading (flag &optional entry)
21706 "Flag the current heading. FLAG non-nil means make invisible.
21707 When ENTRY is non-nil, show the entire entry."
21708 (save-excursion
21709 (org-back-to-heading t)
21710 ;; Check if we should show the entire entry
21711 (if entry
21712 (progn
21713 (org-show-entry)
21714 (save-excursion
21715 (and (outline-next-heading)
21716 (org-flag-heading nil))))
21717 (outline-flag-region (max (point-min) (1- (point)))
21718 (save-excursion (outline-end-of-heading) (point))
21719 flag))))
21721 (defun org-get-next-sibling ()
21722 "Move to next heading of the same level, and return point.
21723 If there is no such heading, return nil.
21724 This is like outline-next-sibling, but invisible headings are ok."
21725 (let ((level (funcall outline-level)))
21726 (outline-next-heading)
21727 (while (and (not (eobp)) (> (funcall outline-level) level))
21728 (outline-next-heading))
21729 (if (or (eobp) (< (funcall outline-level) level))
21730 nil
21731 (point))))
21733 (defun org-get-last-sibling ()
21734 "Move to previous heading of the same level, and return point.
21735 If there is no such heading, return nil."
21736 (let ((opoint (point))
21737 (level (funcall outline-level)))
21738 (outline-previous-heading)
21739 (when (and (/= (point) opoint) (outline-on-heading-p t))
21740 (while (and (> (funcall outline-level) level)
21741 (not (bobp)))
21742 (outline-previous-heading))
21743 (if (< (funcall outline-level) level)
21744 nil
21745 (point)))))
21747 (defun org-end-of-subtree (&optional invisible-ok to-heading)
21748 "Goto to the end of a subtree."
21749 ;; This contains an exact copy of the original function, but it uses
21750 ;; `org-back-to-heading', to make it work also in invisible
21751 ;; trees. And is uses an invisible-ok argument.
21752 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21753 ;; Furthermore, when used inside Org, finding the end of a large subtree
21754 ;; with many children and grandchildren etc, this can be much faster
21755 ;; than the outline version.
21756 (org-back-to-heading invisible-ok)
21757 (let ((first t)
21758 (level (funcall outline-level)))
21759 (if (and (derived-mode-p 'org-mode) (< level 1000))
21760 ;; A true heading (not a plain list item), in Org-mode
21761 ;; This means we can easily find the end by looking
21762 ;; only for the right number of stars. Using a regexp to do
21763 ;; this is so much faster than using a Lisp loop.
21765 (forward-char 1)
21766 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21767 ;; something else, do it the slow way
21768 (while (and (not (eobp))
21769 (or first (> (funcall outline-level) level)))
21770 (setq first nil)
21771 (outline-next-heading)))
21772 (unless to-heading
21774 (progn
21775 ;; Go to end of line before heading
21776 (forward-char -1)
21778 ;; leave blank line before heading
21779 (forward-char -1))))))
21780 (point))
21782 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21783 "Use Org version in org-mode, for dramatic speed-up."
21784 (if (derived-mode-p 'org-mode)
21785 (progn
21786 (org-end-of-subtree nil t)
21787 (unless (eobp) (backward-char 1)))
21788 ad-do-it))
21790 (defun org-end-of-meta-data-and-drawers ()
21791 "Jump to the first text after meta data and drawers in the current entry.
21792 This will move over empty lines, lines with planning time stamps,
21793 clocking lines, and drawers."
21794 (org-back-to-heading t)
21795 (let ((end (save-excursion (outline-next-heading) (point)))
21798 (forward-line 1)
21799 (while (re-search-forward re end t)
21800 (if (not (match-end 1))
21801 ;; empty or planning line
21802 (forward-line 1)
21803 ;; a drawer, find the end
21805 (forward-line 1)))
21807 (point)))
21809 (defun org-forward-heading-same-level (arg &optional invisible-ok)
21810 "Move forward to the arg'th subheading at same level as this one.
21811 Stop at the first and last subheadings of a superior heading.
21812 Normally this only looks at visible headings, but when INVISIBLE-OK is
21813 non-nil it will also look at invisible ones."
21814 (interactive "p")
21815 (org-back-to-heading invisible-ok)
21816 (org-at-heading-p)
21817 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21819 l)
21820 (forward-char 1)
21821 (while (> arg 0)
21822 (while (and (re-search-forward re nil 'move)
21823 (setq l (- (match-end 0) (match-beginning 0) 1))
21824 (= l level)
21825 (not invisible-ok)
21826 (progn (backward-char 1) (outline-invisible-p)))
21827 (if (< l level) (setq arg 1)))
21828 (setq arg (1- arg)))
21829 (beginning-of-line 1)))
21831 (defun org-backward-heading-same-level (arg &optional invisible-ok)
21832 "Move backward to the arg'th subheading at same level as this one.
21833 Stop at the first and last subheadings of a superior heading."
21834 (interactive "p")
21835 (org-back-to-heading)
21836 (org-at-heading-p)
21837 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21839 l)
21840 (while (> arg 0)
21841 (while (and (re-search-backward re nil 'move)
21842 (setq l (- (match-end 0) (match-beginning 0) 1))
21843 (= l level)
21844 (not invisible-ok)
21845 (outline-invisible-p))
21846 (if (< l level) (setq arg 1)))
21847 (setq arg (1- arg)))))
21849 (defun org-forward-element ()
21850 "Move forward by one element.
21851 Move to the next element at the same level, when possible."
21852 (interactive)
21853 (cond ((eobp) (error "Cannot move further down"))
21854 ((org-with-limited-levels (org-at-heading-p))
21855 (let ((origin (point)))
21856 (org-forward-heading-same-level 1)
21857 (unless (org-with-limited-levels (org-at-heading-p))
21858 (goto-char origin)
21859 (error "Cannot move further down"))))
21860 (t
21861 (let* ((elem (org-element-at-point))
21862 (end (org-element-property :end elem))
21863 (parent (org-element-property :parent elem)))
21864 (if (and parent (= (org-element-property :contents-end parent) end))
21865 (goto-char (org-element-property :end parent))
21866 (goto-char end))))))
21868 (defun org-backward-element ()
21869 "Move backward by one element.
21870 Move to the previous element at the same level, when possible."
21871 (interactive)
21872 (cond ((bobp) (error "Cannot move further up"))
21873 ((org-with-limited-levels (org-at-heading-p))
21874 ;; At an headline, move to the previous one, if any, or stay
21875 ;; here.
21876 (let ((origin (point)))
21877 (org-backward-heading-same-level 1)
21878 (unless (org-with-limited-levels (org-at-heading-p))
21879 (goto-char origin)
21880 (error "Cannot move further up"))))
21881 (t
21882 (let* ((trail (org-element-at-point 'keep-trail))
21883 (elem (car trail))
21884 (prev-elem (nth 1 trail))
21885 (beg (org-element-property :begin elem)))
21886 (cond
21887 ;; Move to beginning of current element if point isn't
21888 ;; there already.
21889 ((/= (point) beg) (goto-char beg))
21890 (prev-elem (goto-char (org-element-property :begin prev-elem)))
21891 ((org-before-first-heading-p) (goto-char (point-min)))
21892 (t (org-back-to-heading)))))))
21894 (defun org-up-element ()
21895 "Move to upper element."
21896 (interactive)
21897 (if (org-with-limited-levels (org-at-heading-p))
21898 (unless (org-up-heading-safe) (error "No surrounding element"))
21899 (let* ((elem (org-element-at-point))
21900 (parent (org-element-property :parent elem)))
21901 (if parent (goto-char (org-element-property :begin parent))
21902 (if (org-with-limited-levels (org-before-first-heading-p))
21903 (error "No surrounding element")
21904 (org-with-limited-levels (org-back-to-heading)))))))
21906 (defvar org-element-greater-elements)
21907 (defun org-down-element ()
21908 "Move to inner element."
21909 (interactive)
21910 (let ((element (org-element-at-point)))
21911 (cond
21912 ((memq (org-element-type element) '(plain-list table))
21913 (goto-char (org-element-property :contents-begin element))
21914 (forward-char))
21915 ((memq (org-element-type element) org-element-greater-elements)
21916 ;; If contents are hidden, first disclose them.
21917 (when (org-element-property :hiddenp element) (org-cycle))
21918 (goto-char (or (org-element-property :contents-begin element)
21919 (error "No content for this element"))))
21920 (t (error "No inner element")))))
21922 (defun org-drag-element-backward ()
21923 "Move backward element at point."
21924 (interactive)
21925 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
21926 (let* ((trail (org-element-at-point 'keep-trail))
21927 (elem (car trail))
21928 (prev-elem (nth 1 trail)))
21929 ;; Error out if no previous element or previous element is
21930 ;; a parent of the current one.
21931 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
21932 (error "Cannot drag element backward")
21933 (let ((pos (point)))
21934 (org-element-swap-A-B prev-elem elem)
21935 (goto-char (+ (org-element-property :begin prev-elem)
21936 (- pos (org-element-property :begin elem)))))))))
21938 (defun org-drag-element-forward ()
21939 "Move forward element at point."
21940 (interactive)
21941 (let* ((pos (point))
21942 (elem (org-element-at-point)))
21943 (when (= (point-max) (org-element-property :end elem))
21944 (error "Cannot drag element forward"))
21945 (goto-char (org-element-property :end elem))
21946 (let ((next-elem (org-element-at-point)))
21947 (when (or (org-element-nested-p elem next-elem)
21948 (and (eq (org-element-type next-elem) 'headline)
21949 (not (eq (org-element-type elem) 'headline))))
21950 (goto-char pos)
21951 (error "Cannot drag element forward"))
21952 ;; Compute new position of point: it's shifted by NEXT-ELEM
21953 ;; body's length (without final blanks) and by the length of
21954 ;; blanks between ELEM and NEXT-ELEM.
21955 (let ((size-next (- (save-excursion
21956 (goto-char (org-element-property :end next-elem))
21958 (forward-line)
21959 ;; Small correction if buffer doesn't end
21960 ;; with a newline character.
21961 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
21962 (org-element-property :begin next-elem)))
21963 (size-blank (- (org-element-property :end elem)
21964 (save-excursion
21965 (goto-char (org-element-property :end elem))
21967 (forward-line)
21968 (point)))))
21969 (org-element-swap-A-B elem next-elem)
21970 (goto-char (+ pos size-next size-blank))))))
21972 (defun org-mark-element ()
21973 "Put point at beginning of this element, mark at end.
21975 Interactively, if this command is repeated or (in Transient Mark
21976 mode) if the mark is active, it marks the next element after the
21977 ones already marked."
21978 (interactive)
21979 (let (deactivate-mark)
21980 (if (and (org-called-interactively-p 'any)
21981 (or (and (eq last-command this-command) (mark t))
21982 (and transient-mark-mode mark-active)))
21983 (set-mark
21984 (save-excursion
21985 (goto-char (mark))
21986 (goto-char (org-element-property :end (org-element-at-point)))))
21987 (let ((element (org-element-at-point)))
21988 (end-of-line)
21989 (push-mark (org-element-property :end element) t t)
21990 (goto-char (org-element-property :begin element))))))
21992 (defun org-narrow-to-element ()
21993 "Narrow buffer to current element."
21994 (interactive)
21995 (let ((elem (org-element-at-point)))
21996 (cond
21997 ((eq (car elem) 'headline)
21998 (narrow-to-region
21999 (org-element-property :begin elem)
22000 (org-element-property :end elem)))
22001 ((memq (car elem) org-element-greater-elements)
22002 (narrow-to-region
22003 (org-element-property :contents-begin elem)
22004 (org-element-property :contents-end elem)))
22005 (t
22006 (narrow-to-region
22007 (org-element-property :begin elem)
22008 (org-element-property :end elem))))))
22010 (defun org-transpose-element ()
22011 "Transpose current and previous elements, keeping blank lines between.
22012 Point is moved after both elements."
22013 (interactive)
22014 (org-skip-whitespace)
22015 (let ((end (org-element-property :end (org-element-at-point))))
22016 (org-drag-element-backward)
22017 (goto-char end)))
22019 (defun org-unindent-buffer ()
22020 "Un-indent the visible part of the buffer.
22021 Relative indentation (between items, inside blocks, etc.) isn't
22022 modified."
22023 (interactive)
22024 (unless (eq major-mode 'org-mode)
22025 (error "Cannot un-indent a buffer not in Org mode"))
22026 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
22027 unindent-tree ; For byte-compiler.
22028 (unindent-tree
22029 (function
22030 (lambda (contents)
22031 (mapc
22032 (lambda (element)
22033 (if (memq (org-element-type element) '(headline section))
22034 (funcall unindent-tree (org-element-contents element))
22035 (save-excursion
22036 (save-restriction
22037 (narrow-to-region
22038 (org-element-property :begin element)
22039 (org-element-property :end element))
22040 (org-do-remove-indentation)))))
22041 (reverse contents))))))
22042 (funcall unindent-tree (org-element-contents parse-tree))))
22044 (defun org-show-subtree ()
22045 "Show everything after this heading at deeper levels."
22046 (interactive)
22047 (outline-flag-region
22048 (point)
22049 (save-excursion
22050 (org-end-of-subtree t t))
22051 nil))
22053 (defun org-show-entry ()
22054 "Show the body directly following this heading.
22055 Show the heading too, if it is currently invisible."
22056 (interactive)
22057 (save-excursion
22058 (condition-case nil
22059 (progn
22060 (org-back-to-heading t)
22061 (outline-flag-region
22062 (max (point-min) (1- (point)))
22063 (save-excursion
22064 (if (re-search-forward
22066 (match-beginning 1)
22067 (point-max)))
22068 nil)
22069 (org-cycle-hide-drawers 'children))
22070 (error nil))))
22072 (defun org-make-options-regexp (kwds &optional extra)
22073 "Make a regular expression for keyword lines."
22074 (concat
22080 ;; Make isearch reveal the necessary context
22081 (defun org-isearch-end ()
22082 "Reveal context after isearch exits."
22083 (when isearch-success ; only if search was successful
22084 (if (featurep 'xemacs)
22085 ;; Under XEmacs, the hook is run in the correct place,
22086 ;; we directly show the context.
22087 (org-show-context 'isearch)
22088 ;; In Emacs the hook runs *before* restoring the overlays.
22089 ;; So we have to use a one-time post-command-hook to do this.
22090 ;; (Emacs 22 has a special variable, see function `org-mode')
22091 (unless (and (boundp 'isearch-mode-end-hook-quit)
22092 isearch-mode-end-hook-quit)
22093 ;; Only when the isearch was not quitted.
22094 (org-add-hook 'post-command-hook 'org-isearch-post-command
22095 'append 'local)))))
22097 (defun org-isearch-post-command ()
22098 "Remove self from hook, and show context."
22099 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
22100 (org-show-context 'isearch))
22103 ;;;; Integration with and fixes for other packages
22105 ;;; Imenu support
22107 (defvar org-imenu-markers nil
22108 "All markers currently used by Imenu.")
22109 (make-variable-buffer-local 'org-imenu-markers)
22111 (defun org-imenu-new-marker (&optional pos)
22112 "Return a new marker for use by Imenu, and remember the marker."
22113 (let ((m (make-marker)))
22114 (move-marker m (or pos (point)))
22115 (push m org-imenu-markers)
22116 m))
22118 (defun org-imenu-get-tree ()
22119 "Produce the index for Imenu."
22120 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
22121 (setq org-imenu-markers nil)
22122 (let* ((n org-imenu-depth)
22123 (re (concat "^" (org-get-limited-outline-regexp)))
22124 (subs (make-vector (1+ n) nil))
22125 (last-level 0)
22126 m level head)
22127 (save-excursion
22128 (save-restriction
22129 (widen)
22130 (goto-char (point-max))
22131 (while (re-search-backward re nil t)
22132 (setq level (org-reduced-level (funcall outline-level)))
22133 (when (and (<= level n)
22134 (looking-at org-complex-heading-regexp))
22135 (setq head (org-link-display-format
22136 (org-match-string-no-properties 4))
22137 m (org-imenu-new-marker))
22138 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
22139 (if (>= level last-level)
22140 (push (cons head m) (aref subs level))
22141 (push (cons head (aref subs (1+ level))) (aref subs level))
22142 (loop for i from (1+ level) to n do (aset subs i nil)))
22143 (setq last-level level)))))
22144 (aref subs 1)))
22146 (eval-after-load "imenu"
22147 '(progn
22148 (add-hook 'imenu-after-jump-hook
22149 (lambda ()
22150 (if (derived-mode-p 'org-mode)
22151 (org-show-context 'org-goto))))))
22153 (defun org-link-display-format (link)
22154 "Replace a link with either the description, or the link target
22155 if no description is present"
22156 (save-match-data
22157 (if (string-match org-bracket-link-analytic-regexp link)
22158 (replace-match (if (match-end 5)
22159 (match-string 5 link)
22160 (concat (match-string 1 link)
22161 (match-string 3 link)))
22162 nil t link)
22163 link)))
22165 (defun org-toggle-link-display ()
22166 "Toggle the literal or descriptive display of links."
22167 (interactive)
22168 (if org-descriptive-links
22169 (progn (org-remove-from-invisibility-spec '(org-link))
22170 (org-restart-font-lock)
22171 (setq org-descriptive-links nil))
22172 (progn (add-to-invisibility-spec '(org-link))
22173 (org-restart-font-lock)
22174 (setq org-descriptive-links t))))
22176 ;; Speedbar support
22178 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
22179 "Overlay marking the agenda restriction line in speedbar.")
22180 (overlay-put org-speedbar-restriction-lock-overlay
22181 'face 'org-agenda-restriction-lock)
22182 (overlay-put org-speedbar-restriction-lock-overlay
22183 'help-echo "Agendas are currently limited to this item.")
22184 (org-detach-overlay org-speedbar-restriction-lock-overlay)
22186 (defun org-speedbar-set-agenda-restriction ()
22187 "Restrict future agenda commands to the location at point in speedbar.
22189 (interactive)
22190 (require 'org-agenda)
22191 (let (p m tp np dir txt)
22192 (cond
22193 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22194 'org-imenu t))
22195 (setq m (get-text-property p 'org-imenu-marker))
22196 (with-current-buffer (marker-buffer m)
22197 (goto-char m)
22198 (org-agenda-set-restriction-lock 'subtree)))
22199 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22200 'speedbar-function 'speedbar-find-file))
22201 (setq tp (previous-single-property-change
22202 (1+ p) 'speedbar-function)
22203 np (next-single-property-change
22204 tp 'speedbar-function)
22205 dir (speedbar-line-directory)
22206 txt (buffer-substring-no-properties (or tp (point-min))
22207 (or np (point-max))))
22208 (with-current-buffer (find-file-noselect
22209 (let ((default-directory dir))
22210 (expand-file-name txt)))
22211 (unless (derived-mode-p 'org-mode)
22212 (error "Cannot restrict to non-Org-mode file"))
22213 (org-agenda-set-restriction-lock 'file)))
22214 (t (error "Don't know how to restrict Org-mode's agenda")))
22215 (move-overlay org-speedbar-restriction-lock-overlay
22216 (point-at-bol) (point-at-eol))
22217 (setq current-prefix-arg nil)
22218 (org-agenda-maybe-redo)))
22220 (eval-after-load "speedbar"
22221 '(progn
22222 (speedbar-add-supported-extension ".org")
22223 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
22224 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
22225 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
22226 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
22227 (add-hook 'speedbar-visiting-tag-hook
22228 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
22230 ;;; Fixes and Hacks for problems with other packages
22232 ;; Make flyspell not check words in links, to not mess up our keymap
22233 (defun org-mode-flyspell-verify ()
22234 "Don't let flyspell put overlays at active buttons, or on
22235 {todo,all-time,additional-option-like}-keywords."
22236 (let ((pos (max (1- (point)) (point-min)))
22237 (word (thing-at-point 'word)))
22238 (and (not (get-text-property pos 'keymap))
22239 (not (get-text-property pos 'org-no-flyspell))
22240 (not (member word org-todo-keywords-1))
22241 (not (member word org-all-time-keywords))
22242 (not (member word org-options-keywords))
22243 (not (member word (mapcar 'car org-startup-options)))
22244 (not (member word org-additional-option-like-keywords-for-flyspell)))))
22246 (defun org-remove-flyspell-overlays-in (beg end)
22247 "Remove flyspell overlays in region."
22248 (and (org-bound-and-true-p flyspell-mode)
22249 (fboundp 'flyspell-delete-region-overlays)
22250 (flyspell-delete-region-overlays beg end))
22251 (add-text-properties beg end '(org-no-flyspell t)))
22253 ;; Make `bookmark-jump' shows the jump location if it was hidden.
22254 (eval-after-load "bookmark"
22255 '(if (boundp 'bookmark-after-jump-hook)
22256 ;; We can use the hook
22257 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
22258 ;; Hook not available, use advice
22259 (defadvice bookmark-jump (after org-make-visible activate)
22260 "Make the position visible."
22261 (org-bookmark-jump-unhide))))
22263 ;; Make sure saveplace shows the location if it was hidden
22264 (eval-after-load "saveplace"
22265 '(defadvice save-place-find-file-hook (after org-make-visible activate)
22266 "Make the position visible."
22267 (org-bookmark-jump-unhide)))
22269 ;; Make sure ecb shows the location if it was hidden
22270 (eval-after-load "ecb"
22271 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
22272 "Make hierarchy visible when jumping into location from ECB tree buffer."
22273 (if (derived-mode-p 'org-mode)
22274 (org-show-context))))
22276 (defun org-bookmark-jump-unhide ()
22277 "Unhide the current position, to show the bookmark location."
22278 (and (derived-mode-p 'org-mode)
22279 (or (outline-invisible-p)
22280 (save-excursion (goto-char (max (point-min) (1- (point))))
22281 (outline-invisible-p)))
22282 (org-show-context 'bookmark-jump)))
22284 ;; Make session.el ignore our circular variable
22285 (eval-after-load "session"
22286 '(add-to-list 'session-globals-exclude 'org-mark-ring))
22288 ;;;; Experimental code
22290 (defun org-closed-in-range ()
22291 "Sparse tree of items closed in a certain time range.
22292 Still experimental, may disappear in the future."
22293 (interactive)
22294 ;; Get the time interval from the user.
22295 (let* ((time1 (org-float-time
22296 (org-read-date nil 'to-time nil "Starting date: ")))
22297 (time2 (org-float-time
22298 (org-read-date nil 'to-time nil "End date:")))
22299 ;; callback function
22300 (callback (lambda ()
22301 (let ((time
22302 (org-float-time
22303 (apply 'encode-time
22304 (org-parse-time-string
22305 (match-string 1))))))
22306 ;; check if time in interval
22307 (and (>= time time1) (<= time time2))))))
22308 ;; make tree, check each match with the callback
22311 ;;;; Finish up
22313 (provide 'org)
22315 (run-hooks 'org-load-hook)
22317 ;;; org.el ends here