| blob | a18eed8b9430e35c8f077e27d7d7e00128e6ae5a |
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
81 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
82 ;; some places -- e.g. see the macro org-with-limited-levels.
83 ;;
84 ;; In Org buffers, the value of `outline-regexp' is that of
85 ;; `org-outline-regexp'. The only function still directly relying on
86 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
87 ;; job when `orgstruct-mode' is active.
92 "Regexp to match Org headlines.
93 This is similar to `org-outline-regexp' but additionally makes
97 "Matches an headline, putting stars and text into groups.
100 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
114 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
119 ;; load languages based on value of `org-babel-load-languages'
121 ;;;###autoload
123 "Load the languages defined in `org-babel-load-languages'."
135 org-babel-load-languages))
138 "Languages which can be evaluated in Org-mode buffers.
139 This list can be used to load support for any of the languages
140 below, note that each language will depend on a different set of
141 system executables and/or Emacs modes. When a language is
143 with `org-babel-execute-src-block' bound by default to C-c
144 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
145 be set to remove code block evaluation from the C-c C-c
146 keybinding. By default only Emacs Lisp (which has no
147 requirements) is loaded."
152 :key-type
195 ;;;; Customization variables
197 "Remove ID property of clones of a subtree.
198 When non-nil, clones of a subtree don't inherit the ID property.
199 Otherwise they inherit the ID property with a new unique
200 identifier."
205 ;;; Version
208 ;;;###autoload
210 "Show the org-mode version in the echo area.
211 With prefix argument HERE, insert it at point.
212 When FULL is non-nil, use a verbose version string.
213 When MESSAGE is non-nil, display a message with the version."
224 org-version
225 git-version
228 org-install-dir
237 _version)))
239 ;;; Compatibility constants
241 ;;; The custom variables
244 "Outline-based notes management and organizer."
250 "Mode hook for Org-mode, run after the mode was turned on."
255 "Hook that is run after org.el has been loaded."
260 "Hook that is run after an Org log buffer is created."
270 "Load all extensions listed in `org-modules'."
275 org-modules)
279 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
288 (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)
289 "Modules that should always be loaded together with org.el.
290 If a description starts with <C>, the file is not part of Emacs
291 and loading it will require that you have downloaded and properly installed
292 the org-mode distribution.
294 You can also use this system to load external packages (i.e. neither Org
295 core modules, nor modules from the CONTRIB directory). Just add symbols
296 to the end of the list. If the package is called org-xyz.el, then you need
297 to add the symbol `xyz', and the package must have a call to
299 (provide 'org-xyz)"
302 :type
333 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
342 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
351 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
367 "Non-nil means make shift-cursor commands select text when possible.
369 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
370 start selecting a region, or enlarge regions started in this way.
371 In Org-mode, in special contexts, these same keys are used for
372 other purposes, important enough to compete with shift selection.
373 Org tries to balance these needs by supporting `shift-select-mode'
374 outside these special contexts, under control of this variable.
376 The default of this variable is nil, to avoid confusing behavior. Shifted
377 cursor keys will then execute Org commands in the following contexts:
378 - on a headline, changing TODO state (left/right) and priority (up/down)
379 - on a time stamp, changing the time
380 - in a plain list item, changing the bullet type
381 - in a property definition line, switching between allowed values
382 - in the BEGIN line of a clock table (changing the time block).
383 Outside these contexts, the commands will throw an error.
385 When this variable is t and the cursor is not in a special
386 context, Org-mode will support shift-selection for making and
387 enlarging regions. To make this more effective, the bullet
388 cycling will no longer happen anywhere in an item line, but only
389 if the cursor is exactly on the bullet.
391 If you set this variable to the symbol `always', then the keys
392 will not be special in headlines, property lines, and item lines,
393 to make shift selection work there as well. If this is what you
394 want, you can use the following alternative commands: `C-c C-t'
395 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
396 can be used to switch TODO sets, `C-c -' to cycle item bullet
397 types, and properties can be edited by hand or in column view.
399 However, when the cursor is on a timestamp, shift-cursor commands
400 will still edit the time stamp - this is just too good to give up.
402 XEmacs user should have this variable set to nil, because
403 `shift-select-mode' is in Emacs 23 or later only."
411 "Shall some commands act upon headlines in the active region?
413 When set to `t', some commands will be performed in all headlines
414 within the active region.
416 When set to `start-level', some commands will be performed in all
417 headlines within the active region, provided that these headlines
418 are of the same level than the first one.
420 When set to a string, those commands will be performed on the
421 matching headlines within the active region. Such string must be
422 a tags/property/todo match as it is used in the agenda tags view.
424 The list of commands is: `org-schedule', `org-deadline',
425 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
426 `org-archive-to-archive-sibling'. The archiving commands skip
427 already archived entries."
437 "Options concerning startup of Org-mode."
442 "Non-nil means entering Org-mode will switch to OVERVIEW.
443 This can also be configured on a per-file basis by adding one of
444 the following lines anywhere in the buffer:
446 #+STARTUP: fold (or `overview', this is equivalent)
447 #+STARTUP: nofold (or `showall', this is equivalent)
448 #+STARTUP: content
449 #+STARTUP: showeverything"
458 "Non-nil means entering Org-mode will set `truncate-lines'.
459 This is useful since some lines containing links can be very long and
460 uninteresting. Also tables look terrible when wrapped."
465 "Non-nil means turn on `org-indent-mode' on startup.
466 This can also be configured on a per-file basis by adding one of
467 the following lines anywhere in the buffer:
469 #+STARTUP: indent
470 #+STARTUP: noindent"
478 When this option is turned on, you can use TeX-like syntax for sub- and
480 considered as a single item - so grouping with {} is normally not
481 needed. For example, the following things will be parsed as single
482 sub- or superscripts.
484 10^24 or 10^tau several digits will be considered 1 item.
485 10^-12 or 10^-tau a leading sign with digits or a word
486 x^2-y^3 will be read as x^2 - y^3, because items are
487 terminated by almost any nonword/nondigit char.
488 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
490 Still, ambiguity is possible - so when in doubt use {} to enclose the
491 sub/superscript. If you set this variable to the symbol `{}',
492 the braces are *required* in order to trigger interpretations as
494 frequently in plain text.
496 Not all export backends support this, but HTML does.
512 "Non-nil means turn on `org-beamer-mode' on startup.
513 This can also be configured on a per-file basis by adding one of
514 the following lines anywhere in the buffer:
516 #+STARTUP: beamer"
522 "Non-nil means align all tables when visiting a file.
523 This is useful when the column width in tables is forced with <N> cookies
524 in table fields. Such tables will look correct only after the first re-align.
525 This can also be configured on a per-file basis by adding one of
526 the following lines anywhere in the buffer:
527 #+STARTUP: align
528 #+STARTUP: noalign"
533 "Non-nil means show inline images when loading a new Org file.
534 This can also be configured on a per-file basis by adding one of
535 the following lines anywhere in the buffer:
536 #+STARTUP: inlineimages
537 #+STARTUP: noinlineimages"
543 "Non-nil means insert the first line setting Org-mode in empty files.
544 When the function `org-mode' is called interactively in an empty file, this
545 normally means that the file name does not automatically trigger Org-mode.
546 To ensure that the file will always be in Org-mode in the future, a
547 line enforcing Org-mode will be inserted into the buffer, if this option
548 has been set."
553 "Non-nil means use alternative key bindings for some keys.
554 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
555 These keys are also used by other packages like shift-selection-mode'
556 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
557 If you want to use Org-mode together with one of these other modes,
558 or more generally if you would like to move some Org-mode commands to
559 other keys, set this variable and configure the keys with the variable
560 `org-disputed-keys'.
562 This option is only relevant at load-time of Org-mode, and must be set
563 *before* org.el is loaded. Changing it requires a restart of Emacs to
564 become effective."
569 "Non-nil means use extra key sequence definitions for certain commands.
570 This happens automatically if you run XEmacs or if `window-system'
571 is nil. This variable lets you do the same manually. You must
572 set it before loading org.
574 Example: on Carbon Emacs 22 running graphically, with an external
575 keyboard on a Powerbook, the default way of setting M-left might
576 not work for either Alt or ESC. Setting this variable will make
577 it work for ESC."
591 "Keys for which Org-mode and other modes compete.
592 This is an alist, cars are the default keys, second element specifies
593 the alternative to use when `org-replace-disputed-keys' is t.
595 Keys can be specified in any syntax supported by `define-key'.
596 The value of this option takes effect only at Org-mode's startup,
597 therefore you'll have to restart Emacs to apply it after changing."
602 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
603 Or return the original if not disputed.
604 Also apply the translations defined in `org-xemacs-key-equivalents'."
609 org-disputed-keys)))
613 key)
623 "Define a key, possibly translated, as returned by `org-key'."
627 "The ellipsis to use in the Org-mode outline.
628 When nil, just use the standard three dots. When a string, use that instead,
629 When a face, use the standard 3 dots, but with the specified face.
630 The change affects only Org-mode (which will then use its own display table).
631 Changing this requires executing `M-x org-mode' in a buffer to become
632 effective."
642 "Keywords in Org-mode."
647 "String to mark deadline entries.
648 A deadline is this string, followed by a time stamp. Should be a word,
649 terminated by a colon. You can insert a schedule keyword and
651 Changes become only effective after restarting Emacs."
656 "String to mark scheduled TODO entries.
657 A schedule is this string, followed by a time stamp. Should be a word,
658 terminated by a colon. You can insert a schedule keyword and
660 Changes become only effective after restarting Emacs."
665 "String used as the prefix for timestamps logging closing a TODO entry."
670 "String used as prefix for timestamps clocking work hours on an item."
682 "Entries starting with this keyword will never be exported.
683 An entry can be toggled between COMMENT and normal with
685 Changes become only effective after restarting Emacs."
690 "Entries starting with this keyword will be exported in fixed-width font.
691 Quoting applies only to the text in the entry following the headline, and does
692 not extend beyond the next headline, even if that is lower level.
693 An entry can be toggled between QUOTE and normal with
700 "Regular expression for specifying repeated events.
704 "Options concerning the general structure of Org-mode files."
709 "Options about how to make context of a location visible."
733 "Non-nil means show full hierarchy when revealing a location.
734 Org-mode often shows locations in an org-mode file which might have
735 been invisible before. When this is set, the hierarchy of headings
736 above the exposed location is shown.
737 Turning this off for example for sparse trees makes them very compact.
738 Instead of t, this can also be an alist specifying this option for different
739 contexts. Valid contexts are
740 agenda when exposing an entry from the agenda
741 org-goto when using the command `org-goto' on key C-c C-j
742 occur-tree when using the command `org-occur' on key C-c /
743 tags-tree when constructing a sparse tree based on tags matches
744 link-search when exposing search matches associated with a link
745 mark-goto when exposing the jump goal of a mark
746 bookmark-jump when exposing a bookmark location
747 isearch when exiting from an incremental search
748 default default for all contexts not set explicitly"
753 "Non-nil means show following heading when revealing a location.
754 Org-mode often shows locations in an org-mode file which might have
755 been invisible before. When this is set, the heading following the
756 match is shown.
757 Turning this off for example for sparse trees makes them very compact,
758 but makes it harder to edit the location of the match. In such a case,
760 Instead of t, this can also be an alist specifying this option for different
761 contexts. See `org-show-hierarchy-above' for valid contexts."
766 "Non-nil means show all sibling heading when revealing a location.
767 Org-mode often shows locations in an org-mode file which might have
768 been invisible before. When this is set, the sibling of the current entry
769 heading are all made visible. If `org-show-hierarchy-above' is t,
770 the same happens on each level of the hierarchy above the current entry.
772 By default this is on for the isearch context, off for all other contexts.
773 Turning this off for example for sparse trees makes them very compact,
774 but makes it harder to edit the location of the match. In such a case,
776 Instead of t, this can also be an alist specifying this option for different
777 contexts. See `org-show-hierarchy-above' for valid contexts."
782 "Non-nil means show the entry below a headline when revealing a location.
783 Org-mode often shows locations in an org-mode file which might have
784 been invisible before. When this is set, the text below the headline that is
785 exposed is also shown.
787 By default this is off for all contexts.
788 Instead of t, this can also be an alist specifying this option for different
789 contexts. See `org-show-hierarchy-above' for valid contexts."
794 "How should indirect tree buffers be displayed?
795 This applies to indirect buffers created with the commands
797 Valid values are:
798 current-window Display in the current window
799 other-window Just display in another window.
800 dedicated-frame Create one new frame, and re-use it each time.
801 new-frame Make a new frame each time. Note that in this case
802 previously-made indirect buffers are kept, and you need to
803 kill these buffers yourself."
813 "Non-nil means activate single letter commands at beginning of a headline.
814 This may also be a function to test for appropriate locations where speed
815 commands should be active."
823 "Alist of additional speed commands.
824 This list will be checked before `org-speed-commands-default'
825 when the variable `org-use-speed-commands' is non-nil
826 and when the cursor is at the beginning of a headline.
827 The car if each entry is a string with a single letter, which must
828 be assigned to `self-insert-command' in the global map.
829 The cdr is either a command to be called interactively, a function
830 to be called, or a form to be evaluated.
831 An entry that is just a list with a single string will be interpreted
832 as a descriptive headline that will be added when listing the speed
833 commands in the Help buffer using the `?' speed command."
845 "Options concerning visibility cycling in Org-mode."
850 "Non-nil means skip CHILDREN state in entries that don't have any."
855 "Maximum level which should still be subject to visibility cycling.
856 Levels higher than this will, for cycling, be treated as text, not a headline.
857 When `org-odd-levels-only' is set, a value of N in this variable actually
858 means 2N-1 stars as the limiting headline.
859 When nil, cycle all levels.
860 Note that the limiting level of cycling is also influenced by
861 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
862 `org-inlinetask-min-level' is, cycling will be limited to levels one less
863 than its value."
870 "Names of drawers. Drawers are not opened by cycling on the headline above.
871 Drawers only open with a TAB on the drawer line itself. A drawer looks like
872 this:
873 :DRAWERNAME:
874 .....
875 :END:
877 the property API.
879 Drawers can be defined on the per-file basis with a line like:
881 #+DRAWERS: HIDDEN STATE PROPERTIES"
887 "Non-nil means entering Org-mode will fold all blocks.
888 This can also be set in on a per-file basis with
890 #+STARTUP: hideblocks
891 #+STARTUP: showblocks"
897 "Cycle globally if cursor is at beginning of buffer and not at a headline.
898 This makes it possible to do global cycling without having to use S-TAB or
900 of the buffer
901 must not be a headline - it may be empty or some other text. When used in
902 this way, `org-cycle-hook' is disables temporarily, to make sure the
903 cursor stays at the beginning of the buffer.
904 When this option is nil, don't do anything special at the beginning
905 of the buffer."
910 "Non-nil means cycle entry level or item indentation in new empty entries.
912 When the cursor is at the end of an empty headline, i.e with only stars
913 and maybe a TODO keyword, TAB will then switch the entry to become a child,
914 and then all possible ancestor states, before returning to the original state.
915 This makes data entry extremely fast: M-RET to create a new headline,
916 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
918 When the cursor is at the end of an empty plain list item, one TAB will
919 make it a subitem, two or more tabs will back up to make this an item
920 higher up in the item hierarchy."
925 "Where should `org-cycle' emulate TAB.
926 nil Never
927 white Only in completely white lines
928 whitestart Only at the beginning of lines, before the first non-white char
929 t Everywhere except in headlines
930 exc-hl-bol Everywhere except at the start of a headline
931 If TAB is used in a place where it does not emulate TAB, the current subtree
932 visibility is cycled."
939 ))
942 "Number of empty lines needed to keep an empty line between collapsed trees.
943 If you leave an empty line between the end of a subtree and the following
944 headline, this empty line is hidden when the subtree is folded.
945 Org-mode will leave (exactly) one empty line visible if the number of
946 empty lines is equal or larger to the number given in this variable.
947 So the default 2 means at least 2 empty lines after the end of a subtree
948 are needed to produce free space between a collapsed subtree and the
949 following headline.
951 If the number is negative, and the number of empty lines is at least -N,
952 all empty lines are shown.
954 Special case: when 0, never leave empty lines in collapsed view."
960 "Hook that is run before visibility cycling is happening.
961 The function(s) in this hook must accept a single argument which indicates
962 the new state that will be set right after running this hook. The
963 argument is a symbol. Before a global state change, it can have the values
964 `overview', `content', or `all'. Before a local state change, it can have
965 the values `folded', `children', or `subtree'."
970 org-cycle-hide-drawers
971 org-cycle-show-empty-lines
972 org-optimize-window-after-visibility-change)
973 "Hook that is run after `org-cycle' has changed the buffer visibility.
974 The function(s) in this hook must accept a single argument which indicates
975 the new state that was set by the most recent `org-cycle' command. The
976 argument is a symbol. After a global state change, it can have the values
977 `overview', `content', or `all'. After a local state change, it can have
978 the values `folded', `children', or `subtree'."
983 "Options concerning structure editing in Org-mode."
988 "Non-nil means skip even levels and only use odd levels for the outline.
989 This has the effect that two stars are being added/taken away in
990 promotion/demotion commands. It also influences how levels are
991 handled by the exporters.
992 Changing it requires restart of `font-lock-mode' to become effective
993 for fontification also in regions already fontified.
994 You may also set this on a per-file basis by adding one of the following
995 lines to the buffer:
997 #+STARTUP: odd
998 #+STARTUP: oddeven"
1004 "Non-nil means adapt indentation to outline node level.
1006 When this variable is set, Org assumes that you write outlines by
1007 indenting text in each node to align with the headline (after the stars).
1008 The following issues are influenced by this variable:
1010 - When this is set and the *entire* text in an entry is indented, the
1011 indentation is increased by one space in a demotion command, and
1012 decreased by one in a promotion command. If any line in the entry
1013 body starts with text at column 0, indentation is not changed at all.
1015 - Property drawers and planning information is inserted indented when
1016 this variable s set. When nil, they will not be indented.
1018 - TAB indents a line relative to context. The lines below a headline
1019 will be indented when this variable is set.
1021 Note that this is all about true indentation, by adding and removing
1022 space characters. See also `org-indent.el' which does level-dependent
1023 indentation in a virtual way, i.e. at display time in Emacs."
1028 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1030 When t, `C-a' will bring back the cursor to the beginning of the
1031 headline text, i.e. after the stars and after a possible TODO
1032 keyword. In an item, this will be the position after bullet and
1033 check-box, if any. When the cursor is already at that position,
1034 another `C-a' will bring it to the beginning of the line.
1036 `C-e' will jump to the end of the headline, ignoring the presence
1037 of tags in the headline. A second `C-e' will then jump to the
1038 true end of the line, after any tags. This also means that, when
1039 this variable is non-nil, `C-e' also will never jump beyond the
1040 end of the heading of a folded section, i.e. not after the
1041 ellipses.
1043 When set to the symbol `reversed', the first `C-a' or `C-e' works
1044 normally, going to the true line boundary first. Only a directly
1045 following, identical keypress will bring the cursor to the
1046 special positions.
1048 This may also be a cons cell where the behavior for `C-a' and
1049 `C-e' is set separately."
1068 "Non-nil means `C-k' will behave specially in headlines.
1069 When nil, `C-k' will call the default `kill-line' command.
1070 When t, the following will happen while the cursor is in the headline:
1072 - When the cursor is at the beginning of a headline, kill the entire
1073 line and possible the folded subtree below the line.
1074 - When in the middle of the headline text, kill the headline up to the tags.
1075 - When after the headline text, kill the tags."
1080 "Non-nil means, do not delete a hidden subtree with C-k.
1081 When set to the symbol `error', simply throw an error when C-k is
1082 used to kill (part-of) a headline that has hidden text behind it.
1083 Any other non-nil value will result in a query to the user, if it is
1084 OK to kill that hidden subtree. When nil, kill without remorse."
1093 "Check if in invisible region before inserting or deleting a character.
1094 Valid values are:
1096 nil Do not check, so just do invisible edits.
1097 error Throw an error and do nothing.
1098 show Make point visible, and do the requested edit.
1099 show-and-error Make point visible, then throw an error and abort the edit.
1100 smart Make point visible, and do insertion/deletion if it is
1101 adjacent to visible text and the change feels predictable.
1102 Never delete a previously invisible character or add in the
1103 middle or right after an invisible region. Basically, this
1104 allows insertion and backward-delete right before ellipses.
1105 FIXME: maybe in this case we should not even show?"
1116 "Non-nil means when yanking subtrees, fold them.
1117 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1118 it starts with a heading and all other headings in it are either children
1119 or siblings, then fold all the subtrees. However, do this only if no
1120 text after the yank would be swallowed into a folded tree by this action."
1125 "Non-nil means when yanking subtrees, adjust the level.
1126 With this setting, `org-paste-subtree' is used to insert the subtree, see
1127 this function for details."
1132 "Non-nil means M-RET will split the line at the cursor position.
1133 When nil, it will go to the end of the line before making a
1134 new line.
1135 You may also set this option in a different way for different
1136 contexts. Valid contexts are:
1138 headline when creating a new headline
1139 item when creating a new item
1140 table in a table field
1141 default the value to be used for all contexts not explicitly
1142 customized"
1159 "Non-nil means insert new headings after the current subtree.
1160 When nil, the new heading is created directly after the current line.
1163 for the duration of the command."
1169 "Should `org-insert-heading' leave a blank line before new heading/item?
1170 The value is an alist, with `heading' and `plain-list-item' as CAR,
1171 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1172 which case Org will look at the surrounding headings/items and try to
1173 make an intelligent decision whether to insert a blank line or not.
1175 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1176 set, the setting here is ignored and no empty line is inserted, to avoid
1177 breaking the list structure."
1190 "Hook being run after inserting a new heading."
1196 This currently only means they are never auto-wrapped.
1197 When nil, such lines will be treated like ordinary lines.
1198 See also the QUOTE keyword."
1203 "Non-nil means typing characters in `org-goto' starts incremental search."
1208 "Options concerning sparse trees in Org-mode."
1213 "Non-nil means highlight all matches that define a sparse tree.
1214 The highlights will automatically disappear the next time the buffer is
1215 changed by an edit command."
1220 "Non-nil means any change to the buffer will remove temporary highlights.
1221 Such highlights are created by `org-occur' and `org-clock-display'.
1222 When nil, `C-c C-c needs to be used to get rid of the highlights.
1223 The highlights created by `org-preview-latex-fragment' always need
1224 `C-c C-c' to be removed."
1231 "Hook that is run after `org-occur' has constructed a sparse tree.
1232 This can be used to recenter the window to show as much of the structure
1233 as possible."
1238 "Options concerning imenu and speedbar in Org-mode."
1243 "The maximum level for Imenu access to Org-mode headlines.
1244 This also applied for speedbar access."
1249 "Options concerning tables in Org-mode."
1255 When nil, such lines will be treated like ordinary lines.
1257 When equal to the symbol `optimized', the table editor will be optimized to
1258 do the following:
1259 - Automatic overwrite mode in front of whitespace in table fields.
1260 This makes the structure of the table stay in tact as long as the edited
1261 field does not exceed the column width.
1262 - Minimize the number of realigns. Normally, the table is aligned each time
1263 TAB or RET are pressed to move to another field. With optimization this
1264 happens only if changes to a field might have changed the column width.
1265 Optimization requires replacing the functions `self-insert-command',
1266 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1267 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1268 very good at guessing when a re-align will be necessary, but you can always
1271 If you would like to use the optimized version in Org-mode, but the
1272 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1274 This variable can be used to turn on and off the table editor during a session,
1275 but in order to toggle optimization, a restart is required.
1277 See also the variable `org-table-auto-blank-field'."
1285 "Non-nil means cluster self-insert commands for undo when possible.
1286 If this is set, then, like in the Emacs command loop, 20 consecutive
1287 characters will be undone together.
1288 This is configurable, because there is some impact on typing performance."
1293 "Non-nil means TAB will automatically notice a table.el table.
1294 When it sees such a table, it moves point into it and - if necessary -
1295 calls `table-recognize-table'."
1300 "Options concerning links in Org-mode."
1305 "Buffer-local version of `org-link-abbrev-alist', which see.
1310 "Alist of link abbreviations.
1311 The car of each element is a string, to be replaced at the start of a link.
1313 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1315 [[linkkey:tag][description]]
1317 The 'linkkey' must be a word word, starting with a letter, followed
1318 by letters, numbers, '-' or '_'.
1320 If REPLACE is a string, the tag will simply be appended to create the link.
1323 at that point (see the function `url-hexify-string'). If the string contains
1325 be invoked: this function takes the tag as its only argument and must return
1326 a string.
1328 REPLACE may also be a function that will be called with the tag as the
1329 only argument to create the link, which should be returned as a string.
1331 See the manual for examples."
1341 "Non-nil means Org will display descriptive links.
1342 E.g. [[http://orgmode.org][Org website]] will be displayed as
1344 description. When set to `nil', Org will display the full links
1345 literally.
1347 You can interactively set the value of this variable by calling
1348 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1353 "How the path name in file links should be stored.
1354 Valid values are:
1356 relative Relative to the current directory, i.e. the directory of the file
1357 into which the link is being inserted.
1358 absolute Absolute path, if possible with ~ for home directory.
1359 noabbrev Absolute path, no abbreviation of home directory.
1360 adaptive Use relative path for files in the current directory and sub-
1361 directories of it. For other files, use an absolute path."
1370 "Types of links that should be activated in Org-mode files.
1371 This is a list of symbols, each leading to the activation of a certain link
1372 type. In principle, it does not hurt to turn on most link types - there may
1373 be a small gain when turning off unused link types. The types are:
1375 bracket The recommended [[link][description]] or [[link]] links with hiding.
1376 angle Links in angular brackets that may contain whitespace like
1377 <bbdb:Carsten Dominik>.
1378 plain Plain links in normal text, no whitespace, like http://google.com.
1379 radio Text that is matched by a radio target, see manual for details.
1380 tag Tag settings in a headline (link to tag search).
1381 date Time stamps (link to calendar).
1382 footnote Footnote labels.
1384 Changing this variable requires a restart of Emacs to become effective."
1396 "Function to use to generate link descriptions from links.
1397 If nil the link location will be used. This function must take
1398 two parameters; the first is the link and the second the
1399 description `org-insert-link' has generated, and should return the
1400 description to use."
1405 "Options concerning storing links in Org-mode."
1410 "When non-nil, hexify URL when creating a link."
1412 ;; :version "24.3"
1416 "Format of the description part of a link to an email or usenet message.
1417 The following %-escapes will be replaced by corresponding information:
1425 %s subject
1426 %d date
1427 %m message-id.
1429 You may use normal field width specification between the % and the letter.
1430 This is for example useful to limit the length of the subject.
1444 It should match if the message is from the user him/herself."
1449 "Non-nil means storing a link to an Org file will use entry IDs.
1451 Note that before this variable is even considered, org-id must be loaded,
1452 so please customize `org-modules' and turn it on.
1454 The variable can have the following values:
1456 t Create an ID if needed to make a link to the current entry.
1458 create-if-interactive
1459 If `org-store-link' is called directly (interactively, as a user
1460 command), do create an ID to support the link. But when doing the
1461 job for remember, only use the ID if it already exists. The
1462 purpose of this setting is to avoid proliferation of unwanted
1463 IDs, just because you happen to be in an Org file when you
1464 call `org-capture' that automatically and preemptively creates a
1465 link. If you do want to get an ID link in a remember template to
1466 an entry not having an ID, create it first by explicitly creating
1467 a link to it, using `C-c C-l' first.
1469 create-if-interactive-and-no-custom-id
1470 Like create-if-interactive, but do not create an ID if there is
1471 a CUSTOM_ID property defined in the entry. This is the default.
1473 use-existing
1474 Use existing ID, do not create one.
1476 nil Never use an ID to make a link, instead link using a text search for
1477 the headline text."
1482 create-if-interactive)
1484 create-if-interactive-and-no-custom-id)
1489 "Non-nil means file links from `org-store-link' contain context.
1490 A search string will be added to the file name with :: as separator and
1491 used to find the context when the link is activated by the command
1492 `org-open-at-point'. When this option is t, the entire active region
1493 will be placed in the search string of the file link. If set to a
1494 positive integer, only the first n lines of context will be stored.
1497 negates this setting for the duration of the command."
1502 "Non-nil means keep link in list for entire session.
1504 The command `org-store-link' adds a link pointing to the current
1505 location to an internal list. These links accumulate during a session.
1506 The command `org-insert-link' can be used to insert links into any
1507 Org-mode file (offering completion for all stored links). When this
1509 will be removed from the list, to make completing the unused links
1510 more efficient."
1515 "Options concerning following links in Org-mode."
1520 "Function to translate links with different syntax to Org syntax.
1521 This can be used to translate links created for example by the Planner
1522 or emacs-wiki packages to Org syntax.
1523 The function must accept two parameters, a TYPE containing the link
1525 which is everything after the link protocol. It should return a cons
1526 with possibly modified values of type and path.
1527 Org contains a function for this, so if you set this variable to
1528 `org-translate-link-from-planner', you should be able follow many
1529 links created by planner."
1534 "Hook that is run after a link has been followed."
1539 "Non-nil means on links TAB will follow the link.
1540 Needs to be set before org.el is loaded.
1541 This really should not be used, it does not make sense, and the
1542 implementation is bad."
1547 "Non-nil means on links RET will follow the link."
1553 "Non-nil means mouse-1 on a link will follow the link.
1554 A longer mouse click will still set point. Does not work on XEmacs.
1555 Needs to be set before org.el is loaded."
1560 "Number of different positions to be recorded in the ring.
1561 Changing this requires a restart of Emacs to work correctly."
1566 "Non-nil means internal links in Org files must exactly match a headline.
1567 When nil, the link search tries to match a phrase with all words
1568 in the search text."
1575 query-to-create)))
1583 "Setup the frame configuration for following links.
1584 When following a link with Emacs, it may often be useful to display
1585 this link in another window or frame. This variable can be used to
1586 set this up for the different types of links.
1587 For VM, use any of
1588 `vm-visit-folder'
1589 `vm-visit-folder-other-window'
1590 `vm-visit-folder-other-frame'
1591 For Gnus, use any of
1592 `gnus'
1593 `gnus-other-frame'
1594 `org-gnus-no-new-news'
1595 For FILE, use any of
1596 `find-file'
1597 `find-file-other-window'
1598 `find-file-other-frame'
1599 For Wanderlust use any of
1600 `wl'
1601 `wl-other-frame'
1602 For the calendar, use the variable `calendar-setup'.
1603 For BBDB, it is currently only possible to display the matches in
1604 another window."
1628 "Non-nil means use indirect buffer to display infile links.
1629 Activating internal links (from one location in a file to another location
1630 in the same file) normally just jumps to the location. When the link is
1632 is displayed in
1633 another window. When this option is set, the other window actually displays
1634 an indirect buffer clone of the current buffer, to avoid any visibility
1635 changes to the current buffer."
1640 "Non-nil means `org-open-file' will open non-existing files.
1641 When nil, an error will be generated.
1642 This variable applies only to external applications because they
1643 might choke on non-existing files. If the link is to a file that
1644 will be opened in Emacs, the variable is ignored."
1649 "Non-nil means a link to a directory really means to index.org.
1650 When nil, following a directory link will run dired or open a finder/explorer
1651 window on that directory."
1656 "Function and arguments to call for following mailto links.
1657 This is a list with the first element being a Lisp function, and the
1658 remaining elements being arguments to the function. In string arguments,
1659 %a will be replaced by the address, and %s will be replaced by the subject
1660 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1669 "Non-nil means ask for confirmation before executing shell links.
1670 Shell links can be dangerous: just think about a link
1672 [[shell:rm -rf ~/*][Google Search]]
1675 but really it would remove your entire home directory.
1676 Therefore we advise against setting this variable to nil.
1677 Just change it to `y-or-n-p' if you want to confirm with a
1685 'safe-local-variable
1689 "A regexp to skip confirmation for shell links."
1695 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1696 Elisp links can be dangerous: just think about a link
1701 but really it would remove your entire home directory.
1702 Therefore we advise against setting this variable to nil.
1703 Just change it to `y-or-n-p' if you want to confirm with a
1711 'safe-local-variable
1715 "A regexp to skip confirmation for Elisp links."
1724 "Default file applications on a UNIX or GNU/Linux system.
1735 "Default file applications on a MacOS X system.
1737 for some files for which the OS does not have a good default.
1745 'mswindows-shell-execute
1750 'mswindows-shell-execute
1753 "Default file applications on a Windows NT system.
1758 '(
1763 )
1764 "External applications for opening `file:path' items in a document.
1765 Org-mode uses system defaults for different file types, but
1766 you can use this variable to set the application for a given file
1767 extension. The entries in this list are cons cells where the car identifies
1768 files and the cdr the corresponding command. Possible values for the
1769 file identifier are
1771 ways, depending on its contents:
1773 - Alphanumeric characters only:
1774 Match links with this file extension.
1776 to open PDFs with evince.
1778 - Regular expression: Match links where the
1779 filename matches the regexp. If you want to
1780 use groups here, use shy groups.
1784 to open *.html and *.xhtml with firefox.
1786 - Regular expression which contains (non-shy) groups:
1788 anything after that, matches the regexp.
1789 In a custom command string, %1, %2, etc. are replaced with
1790 the parts of the link that were matched by the groups.
1791 For backwards compatibility, if a command string is given
1792 that does not use any of the group matches, this case is
1793 handled identically to the second one (i.e. match against
1794 file name only).
1795 In a custom lisp form, you can access the group matches with
1796 (match-string n link).
1799 to open [[file:document.pdf::5]] with evince at page 5.
1801 `directory' Matches a directory
1802 `remote' Matches a remote file, accessible through tramp or efs.
1803 Remote files most likely should be visited through Emacs
1804 because external applications cannot handle such paths.
1805 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1806 so all files Emacs knows how to handle. Using this with
1807 command `emacs' will open most files in Emacs. Beware that this
1808 will also open html files inside Emacs, unless you add
1810 t Default for files not matched by any of the other options.
1811 `system' The system command to open files, like `open' on Windows
1812 and Mac OS X, and mailcap under GNU/Linux. This is the command
1813 that will be selected if you call `C-c C-o' with a double
1816 Possible values for the command are:
1817 `emacs' The file will be visited by the current Emacs process.
1818 `default' Use the default application for this file type, which is the
1819 association for t in the list, most likely in the system-specific
1820 part.
1821 This can be used to overrule an unwanted setting in the
1822 system-specific variable.
1824 This command is specified by the entry whose car is `system'.
1825 Most likely, the system-specific version of this variable
1826 does define this command, but you can overrule/replace it
1827 here.
1828 string A command to be executed by a shell; %s will be replaced
1829 by the path to the file.
1830 sexp A Lisp form which will be evaluated. The file path will
1831 be available in the Lisp variable `file'.
1832 For more examples, see the system specific constants
1833 `org-file-apps-defaults-macosx'
1834 `org-file-apps-defaults-windowsnt'
1835 `org-file-apps-defaults-gnu'."
1845 auto-mode))
1854 "The URL of the DOI server."
1856 ;; :version "24.3"
1860 "Options concerning refiling entries in Org-mode."
1865 "Directory with org files.
1866 This is just a default location to look for Org files. There is no need
1867 at all to put your files into this directory. It is only used in the
1868 following situations:
1870 1. When a remember template specifies a target file that is not an
1871 absolute path. The path will then be interpreted relative to
1872 `org-directory'
1873 2. When a remember note is filed away in an interactive way (when exiting the
1874 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1875 with `org-directory' as the default path."
1881 "Default target for storing notes.
1882 Used as a fall back file for org-remember.el and org-capture.el, for
1883 templates that do not specify a target file."
1888 file))
1891 "The default interface to be used for `org-goto'.
1892 Allowed values are:
1893 outline The interface shows an outline of the relevant file
1894 and the correct heading is found by moving through
1895 the outline or by searching with incremental search.
1896 outline-path-completion Headlines in the current buffer are offered via
1897 completion. This is the interface also used by
1898 the refile command."
1905 "Maximum target level when running `org-goto' with refile interface."
1910 "Non-nil means store new notes at the beginning of a file or entry.
1911 When nil, new notes will be filed to the end of a file or entry.
1912 This can also be a list with cons cells of regular expressions that
1913 are matched against file names, and values."
1923 "Information to record when a task is refiled.
1925 Possible values are:
1927 nil Don't add anything
1928 time Add a time stamp to the task
1929 note Prompt for a note and add it with template `org-log-note-headings'
1931 This option can also be set with on a per-file-basis with
1933 #+STARTUP: nologrefile
1934 #+STARTUP: logrefile
1935 #+STARTUP: lognoterefile
1937 You can have local logging settings for a subtree by setting the LOGGING
1938 property to one or more of these keywords.
1940 When bulk-refiling from the agenda, the value `note' is forbidden and
1941 will temporarily be changed to `time'."
1952 This is a list of cons cells. Each cell contains:
1953 - a specification of the files to be considered, either a list of files,
1954 or a symbol whose function or variable value will be used to retrieve
1955 a file name or a list of file names. If you use `org-agenda-files' for
1956 that, all agenda files will be scanned for targets. Nil means consider
1957 headings in the current buffer.
1958 - A specification of how to find candidate refile targets. This may be
1959 any of:
1961 This tag has to be present in all target headlines, inheritance will
1962 not be considered.
1964 todo keyword.
1966 headlines that are refiling targets.
1967 - a cons cell (:level . N). Any headline of level N is considered a target.
1968 Note that, when `org-odd-levels-only' is set, level corresponds to
1969 order in hierarchy, not to the number of stars.
1970 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1971 Note that, when `org-odd-levels-only' is set, level corresponds to
1972 order in hierarchy, not to the number of stars.
1974 Each element of this list generates a set of possible targets.
1975 The union of these sets is presented (with completion) to
1976 the user by `org-refile'.
1978 You can set the variable `org-refile-target-verify-function' to a function
1979 to verify each headline found by the simple criteria above.
1981 When this variable is nil, all top-level headlines in the current buffer
1982 are used, equivalent to the value `((nil . (:level . 1))'."
1998 "Function to verify if the headline at point should be a refile target.
1999 The function will be called without arguments, with point at the
2000 beginning of the headline. It should return t and leave point
2001 where it is if the headline is a valid target for refiling.
2003 If the target should not be selected, the function must return nil.
2004 In addition to this, it may move point to a place from where the search
2005 should be continued. For example, the function may decide that the entire
2006 subtree of the current entry should be excluded and move point to the end
2007 of the subtree."
2012 "Non-nil means cache refile targets to speed up the process.
2013 The cache for a particular file will be updated automatically when
2014 the buffer has been killed, or when any of the marker used for flagging
2015 refile targets no longer points at a live buffer.
2016 If you have added new entries to a buffer that might themselves be targets,
2017 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2018 find that easier, `C-u C-u C-u C-c C-w'."
2024 "Non-nil means provide refile targets as paths.
2025 So a level 3 headline will be available as level1/level2/level3.
2027 When the value is `file', also include the file name (without directory)
2028 into the path. In this case, you can also stop the completion after
2029 the file name, to get entries inserted as top level in the file.
2031 When `full-file-path', include the full file path."
2040 "Non-nil means complete the outline path in hierarchical steps.
2041 When Org-mode uses the refile interface to select an outline path
2042 \(see variable `org-refile-use-outline-path'), the completion of
2043 the path can be done is a single go, or if can be done in steps down
2044 the headline hierarchy. Going in steps is probably the best if you
2045 do not use a special completion package like `ido' or `icicles'.
2046 However, when using these packages, going in one step can be very
2047 fast, while still showing the whole path to the entry."
2052 "Non-nil means allow to create new nodes as refile targets.
2054 of an existing node. When the value of this variable is `confirm',
2055 new node creation must be confirmed by the user (recommended)
2056 When nil, the completion must match an existing entry.
2058 Note that, if the new heading is not seen by the criteria
2059 listed in `org-refile-targets', multiple instances of the same
2060 heading would be created by trying again to file under the new
2061 heading."
2069 "Non-nil means also refile active region within a subtree.
2071 By default `org-refile' doesn't allow refiling regions if they
2072 don't contain a set of subtrees, but it might be convenient to
2073 do so sometimes: in that case, the first line of the region is
2074 converted to a headline before refiling."
2080 "Options concerning TODO items in Org-mode."
2085 "Options concerning Progress logging in Org-mode."
2092 "The available interpretation symbols for customizing `org-todo-keywords'.
2096 "List of TODO entry keyword sequences and their interpretation.
2099 Each sequence starts with a symbol, either `sequence' or `type',
2100 indicating if the keywords should be interpreted as a sequence of
2101 action steps, or as different types of TODO items. The first
2102 keywords are states requiring action - these states will select a headline
2103 for inclusion into the global TODO list Org-mode produces. If one of
2106 the last keyword is treated as the only DONE state of the sequence.
2109 additional state where no keyword is present. For details about this
2110 cycling, see the manual.
2112 TODO keywords and interpretation can also be set on a per-file basis with
2113 the special #+SEQ_TODO and #+TYP_TODO lines.
2115 Each keyword can optionally specify a character for fast state selection
2116 \(in combination with the variable `org-use-fast-todo-selection')
2117 and specifiers for state change logging, using the same syntax that
2120 indicates to record a time stamp each time this state is selected.
2122 Each keyword may also specify if a timestamp or a note should be
2123 recorded when entering or leaving the state, by adding additional
2124 characters in the parenthesis after the keyword. This looks like this:
2126 record only the time of the state change. With X and Y being either
2128 Y when leaving the state if and only if the *target* state does not
2129 define X. You may omit any of the fast-selection key or X or /Y,
2130 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2132 For backward compatibility, this variable may also be just a list
2133 of keywords. In this case the interpretation (sequence or type) will be
2134 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2144 ;;Quick and dirty way to see
2145 ;;`org-todo-interpretations'. This takes the
2146 ;;place of item arguments
2147 :convert-widget
2154 org-todo-interpretation-widgets))
2155 widget))
2186 "Controls how TODO keywords are interpreted.
2187 This variable is in principle obsolete and is only used for
2188 backward compatibility, if the interpretation of todo keywords is
2189 not given already in `org-todo-keywords'. See that variable for
2190 more information."
2197 "Non-nil means use the fast todo selection scheme with C-c C-t.
2198 This variable describes if and under what circumstances the cycling
2199 mechanism for TODO keywords will be replaced by a single-key, direct
2200 selection scheme.
2202 When nil, fast selection is never used.
2204 When the symbol `prefix', it will be used when `org-todo' is called
2205 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2206 `C-u t' in an agenda buffer.
2208 When t, fast selection is used by default. In this case, the prefix
2209 argument forces cycling instead.
2211 In all cases, the special interface is only used if access keys have
2212 actually been assigned by the user, i.e. if keywords in the configuration
2213 are followed by a letter in parenthesis, like TODO(t)."
2221 "Non-nil means update todo statistics after insert and toggle.
2222 ALL-HEADLINES means update todo statistics by including headlines
2223 with no TODO keyword as well, counting them as not done.
2224 A list of TODO keywords means the same, but skip keywords that are
2225 not in this list.
2227 When this is set, todo statistics is updated in the parent of the
2228 current entry each time a todo state is changed."
2238 "Non-nil means TODO statistics covers just direct children.
2239 When nil, all entries in the subtree are considered.
2240 This has only an effect if `org-provide-todo-statistics' is set.
2241 To set this to nil for only a single subtree, use a COOKIE_DATA
2247 "Hook which is run after the state of a TODO item was changed.
2248 The new state (a string with a TODO keyword, or nil) is available in the
2249 Lisp variable `org-state'."
2254 "Hook for functions that are allowed to block a state change.
2256 Each function gets as its single argument a property list, see
2257 `org-trigger-hook' for more information about this list.
2259 If any of the functions in this hook returns nil, the state change
2263 "Hook for functions that are triggered by a state change.
2265 Each function gets as its single argument a property list with at least
2266 the following elements:
2268 (:type type-of-change :position pos-at-entry-start
2269 :from old-state :to new-state)
2271 Depending on the type, more properties may be present.
2273 This mechanism is currently implemented for:
2275 TODO state changes
2276 ------------------
2277 :type todo-state-change
2278 :from previous state (keyword as a string), or nil, or a symbol
2279 'todo' or 'done', to indicate the general type of state.
2283 "Non-nil means undone TODO entries will block switching the parent to DONE.
2284 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2285 be blocked if any prior sibling is not yet done.
2286 Finally, if the parent is blocked because of ordered siblings of its own,
2287 the child will also be blocked."
2299 "Non-nil means unchecked boxes will block switching the parent to DONE.
2300 When this is nil, checkboxes have no influence on switching TODO states.
2301 When non-nil, you first need to check off all check boxes before the TODO
2302 entry can be switched to DONE.
2303 This variable needs to be set before org.el is loaded, and you need to
2304 restart Emacs after a change to make the change effective. The only way
2305 to change is while Emacs is running is through the customize interface."
2317 "Non-nil means inserting a TODO heading is treated as state change.
2319 logging will apply if appropriate. When nil, the new TODO item will
2320 be inserted directly, and no logging will take place."
2325 "Non-nil means switching TODO states with S-cursor counts as state change.
2326 This is the default behavior. However, setting this to nil allows a
2327 convenient way to select a TODO state and bypass any logging associated
2328 with that."
2333 "Tag changes that should be triggered by TODO state changes.
2334 This is a list. Each entry is
2336 (state-change (tag . flag) .......)
2338 State-change can be a string with a state, and empty string to indicate the
2339 state that has no TODO keyword, or it can be one of the symbols `todo'
2340 or `done', meaning any not-done or done state, respectively."
2354 "Information to record when a task moves to the DONE state.
2356 Possible values are:
2358 nil Don't add anything, just change the keyword
2359 time Add a time stamp to the task
2360 note Prompt for a note and add it with template `org-log-note-headings'
2362 This option can also be set with on a per-file-basis with
2364 #+STARTUP: nologdone
2365 #+STARTUP: logdone
2366 #+STARTUP: lognotedone
2368 You can have local logging settings for a subtree by setting the LOGGING
2369 property to one or more of these keywords."
2377 ;; Normalize old uses of org-log-done.
2384 "Information to record when the scheduling date of a tasks is modified.
2386 Possible values are:
2388 nil Don't add anything, just change the date
2389 time Add a time stamp to the task
2390 note Prompt for a note and add it with template `org-log-note-headings'
2392 This option can also be set with on a per-file-basis with
2394 #+STARTUP: nologreschedule
2395 #+STARTUP: logreschedule
2396 #+STARTUP: lognotereschedule"
2405 "Information to record when the deadline date of a tasks is modified.
2407 Possible values are:
2409 nil Don't add anything, just change the date
2410 time Add a time stamp to the task
2411 note Prompt for a note and add it with template `org-log-note-headings'
2413 This option can also be set with on a per-file-basis with
2415 #+STARTUP: nologredeadline
2416 #+STARTUP: logredeadline
2417 #+STARTUP: lognoteredeadline
2419 You can have local logging settings for a subtree by setting the LOGGING
2420 property to one or more of these keywords."
2429 "Non-nil means record a note when clocking out of an item.
2430 This can also be configured on a per-file basis by adding one of
2431 the following lines anywhere in the buffer:
2433 #+STARTUP: lognoteclock-out
2434 #+STARTUP: nolognoteclock-out"
2440 "Non-nil means the CLOSED time stamp will contain date and time.
2441 When nil, only the date will be recorded."
2455 "Headings for notes added to entries.
2456 The value is an alist, with the car being a symbol indicating the note
2457 context, and the cdr is the heading to be used. The heading may also be the
2458 empty string.
2459 %t in the heading will be replaced by a time stamp.
2460 %T will be an active time stamp instead the default inactive one
2461 %d will be replaced by a short-format time stamp.
2462 %D will be replaced by an active short-format time stamp.
2463 %s will be replaced by the new TODO state, in double quotes.
2464 %S will be replaced by the old TODO state, in double quotes.
2465 %u will be replaced by the user name.
2466 %U will be replaced by the full user name.
2468 In fact, it is not a good idea to change the `state' entry, because
2469 agenda log mode depends on the format of these entries."
2475 "Heading when changing todo state (todo sequence only)"
2489 "Non-nil means insert state change notes and time stamps into a drawer.
2490 When nil, state changes notes will be inserted after the headline and
2491 any scheduling and clock lines, but not inside a drawer.
2493 The value of this variable should be the name of the drawer to use.
2494 LOGBOOK is proposed as the default drawer for this purpose, you can
2495 also set this to a string to define the drawer of your choice.
2499 If this variable is set, `org-log-state-notes-insert-after-drawers'
2500 will be ignored.
2502 You can set the property LOG_INTO_DRAWER to overrule this setting for
2503 a subtree."
2515 "Return the value of `org-log-into-drawer', but let properties overrule.
2516 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2517 used instead of the default value."
2525 "Non-nil means insert state change notes after any drawers in entry.
2526 Only the drawers that *immediately* follow the headline and the
2527 deadline/scheduled line are skipped.
2528 When nil, insert notes right after the heading and perhaps the line
2529 with deadline/scheduling if present.
2531 This variable will have no effect if `org-log-into-drawer' is
2532 set."
2538 "Non-nil means the latest state note will be directly after heading.
2539 When nil, the state change notes will be ordered according to time."
2545 "The TODO state to which a repeater should return the repeating task.
2546 By default this is the first task in a TODO sequence, or the previous state
2547 in a TODO_TYP set. But you can specify another task here.
2548 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2555 "Non-nil means record moving through the DONE state when triggering repeat.
2556 An auto-repeating task is immediately switched back to TODO when
2559 record a closing note, there will be no record of the task moving
2560 through DONE. This variable forces taking a note anyway.
2562 nil Don't force a record
2563 time Record a time stamp
2564 note Prompt for a note and add it with template `org-log-note-headings'
2566 This option can also be set with on a per-file-basis with
2568 #+STARTUP: nologrepeat
2569 #+STARTUP: logrepeat
2570 #+STARTUP: lognoterepeat
2572 You can have local logging settings for a subtree by setting the LOGGING
2573 property to one or more of these keywords."
2583 "Priorities in Org-mode."
2588 "Non-nil means priority commands are active.
2589 When nil, these commands will be disabled, so that you never accidentally
2590 set a priority."
2595 "The highest priority of TODO items. A character like ?A, ?B etc.
2596 Must have a smaller ASCII number than `org-lowest-priority'."
2601 "The lowest priority of TODO items. A character like ?A, ?B etc.
2602 Must have a larger ASCII number than `org-highest-priority'."
2607 "The default priority of TODO items.
2608 This is the priority an item gets if no explicit priority is given.
2609 When starting to cycle on an empty priority the first step in the cycle
2610 depends on `org-priority-start-cycle-with-default'. The resulting first
2611 step priority must not exceed the range from `org-highest-priority' to
2612 `org-lowest-priority' which means that `org-default-priority' has to be
2613 in this range exclusive or inclusive the range boundaries. Else the
2614 first step refuses to set the default and the second will fall back
2615 to (depending on the command used) the highest or lowest priority."
2620 "Non-nil means start with default priority when starting to cycle.
2621 When this is nil, the first step in the cycle will be (depending on the
2622 command used) one higher or lower than the default priority.
2623 See also `org-default-priority'."
2628 "Function to extract the priority from a string.
2629 The string is normally the headline. If this is nil Org computes the
2630 priority from the priority cookie like [#A] in the headline. It returns
2631 an integer, increasing by 1000 for each priority level.
2632 The user can set a different function here, which should take a string
2633 as an argument and return the numeric priority."
2639 "Options concerning time stamps and deadlines in Org-mode."
2644 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2645 When nil, these labeled time stamps are forces into the second line of an
2646 entry, just after the headline. When scheduling from the global TODO list,
2647 the time stamp will always be forced into the second line."
2652 "Formats for `format-time-string' which are used for time stamps.
2656 "Number of minutes to round time stamps to.
2657 These are two values, the first applies when first creating a time stamp.
2658 The second applies when changing it with the commands `S-up' and `S-down'.
2659 When changing the time stamp, this means that it will change in steps
2660 of N minutes, as given by the second value.
2662 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2663 numbers should be factors of 60, so for example 5, 10, 15.
2665 When this is larger than 1, you can still force an exact time stamp by using
2666 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2667 and by using a prefix arg to `S-up/down' to specify the exact number
2668 of minutes to shift."
2678 ;; Normalize old customizations of this variable.
2682 org-time-stamp-rounding-minutes)))
2685 "Non-nil means overlay custom formats over all time stamps.
2686 The formats are defined through the variable `org-time-stamp-custom-formats'.
2687 To turn this on on a per-file basis, insert anywhere in the file:
2688 #+STARTUP: customtime"
2696 "Custom formats for time stamps. See `format-time-string' for the syntax.
2697 These are overlaid over the default ISO format if the variable
2698 `org-display-custom-times' is set. Time like %H:%M should be at the
2699 end of the second format. The custom formats are also honored by export
2700 commands, if custom time display is turned on at the time of export."
2705 "Get the right format for a time string."
2710 f)))
2713 "The format string used when creating CLOCKSUM lines.
2714 This is also used when org-mode generates a time duration."
2720 org-mode generates a time duration."
2725 "The format string used when creating CLOCKSUM lines, or when
2726 org-mode generates a time duration."
2731 "No. of days before expiration during which a deadline becomes active.
2732 This variable governs the display in sparse trees and in the agenda.
2733 When 0 or negative, it means use this number (the absolute value of it)
2734 even if a deadline has a different individual lead time specified.
2736 Custom commands can set this variable in the options section."
2742 "Non-nil means assume future for incomplete date input from user.
2743 This affects the following situations:
2744 1. The user gives a month but not a year.
2747 2. The user gives a day, but no month.
2750 it will be considered as *this* month.
2752 If you set this variable to the symbol `time', then also the following
2753 will work:
2755 3. If the user gives a time.
2756 If the time is before now, it will be interpreted as tomorrow.
2758 Currently none of this works for ISO week specifications.
2760 When this option is nil, the current day, month and year will always be
2761 used as defaults.
2763 See also `org-agenda-jump-prefer-future'."
2771 "Should the agenda jump command prefer the future for incomplete dates?
2772 The default is to do the same as configured in `org-read-date-prefer-future'.
2773 But you can also set a deviating value here.
2774 This may t or nil, or the symbol `org-read-date-prefer-future'."
2780 org-read-date-prefer-future)
2785 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2787 Depending on the system Emacs is running on, certain dates cannot
2788 be represented with the type used internally to represent time.
2789 Dates between 1970-1-1 and 2038-1-1 can always be represented
2790 correctly. Some systems allow for earlier dates, some for later,
2791 some for both. One way to find out it to insert any date into an
2792 Org buffer, putting the cursor on the year and hitting S-up and
2793 S-down to test the range.
2795 When this variable is set to t, the date/time prompt will not let
2796 you specify dates outside the 1970-2037 range, so it is certain that
2797 these dates will work in whatever version of Emacs you are
2798 running, and also that you can move a file from one Emacs implementation
2799 to another. WHenever Org is forcing the year for you, it will display
2800 a message and beep.
2802 When this variable is nil, Org will check if the date is
2803 representable in the specific Emacs implementation you are using.
2804 If not, it will force a year, usually the current year, and beep
2805 to remind you. Currently this setting is not recommended because
2806 the likelihood that you will open your Org files in an Emacs that
2807 has limited date range is not negligible.
2809 A workaround for this problem is to use diary sexp dates for time
2810 stamps outside of this range."
2816 "Non-nil means display current interpretation of date prompt live.
2817 This display will be in an overlay, in the minibuffer."
2822 "Non-nil means pop up a calendar when prompting for a date.
2823 In the calendar, the date can be selected with mouse-1. However, the
2824 minibuffer will also be active, and you can simply enter the date as well.
2825 When nil, only the minibuffer will be available."
2833 "Hook to be used to set up keys for the date/time interface.
2834 Add key definitions to `minibuffer-local-map', which will be a temporary
2835 copy."
2840 "The hour when your day really ends. Must be an integer.
2841 This has influence for the following applications:
2843 the time given here, the day recognized as TODAY is actually yesterday.
2844 - When a date is read from the user and it is still before the time given
2845 here, the current date and time will be assumed to be yesterday, 23:59.
2846 Also, timestamps inserted in remember templates follow this rule.
2848 IMPORTANT: This is a feature whose implementation is and likely will
2849 remain incomplete. Really, it is only here because past midnight seems to
2850 be the favorite working time of John Wiegley :-)"
2855 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2856 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2858 23:59 of the previous day."
2864 "Non-nil means S-down will increase the time in a time stamp.
2865 When nil, S-up will increase."
2870 "Non-nil means make the calendar window follow timestamp changes.
2871 When a timestamp is modified and the calendar window is visible, it will be
2872 moved to the new date."
2877 "Options concerning tags in Org-mode."
2882 "List of tags allowed in Org-mode files.
2883 When this list is nil, Org-mode will base TAG input on what is already in the
2884 buffer.
2885 The value of this variable is an alist, the car of each entry must be a
2886 keyword as a string, the cdr may be a character that is used to select
2887 that tag through the fast-tag-selection interface.
2888 See the manual for details."
2903 "List of tags that will always appear in all Org-mode files.
2904 This is in addition to any in buffer settings or customizations
2905 of `org-tag-alist'.
2906 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2907 The value of this variable is an alist, the car of each entry must be a
2908 keyword as a string, the cdr may be a character that is used to select
2909 that tag through the fast-tag-selection interface.
2910 See the manual for details.
2911 To disable these tags on a per-file basis, insert anywhere in the file:
2912 #+STARTUP: noptag"
2923 "If non-nil, always offer completion for all tags of all agenda files.
2924 Instead of customizing this variable directly, you might want to
2925 set it locally for capture buffers, because there no list of
2926 tags in that file can be created dynamically (there are none).
2928 (add-hook 'org-capture-mode-hook
2929 (lambda ()
2930 (set (make-local-variable
2931 'org-complete-tags-always-offer-all-agenda-tags)
2932 t)))"
2938 "List of tags that can be inherited by all entries in the file.
2939 The tags will be inherited if the variable `org-use-tag-inheritance'
2940 says they should be.
2944 "Non-nil means use fast tag selection scheme.
2945 This is a special interface to select and deselect tags with single keys.
2946 When nil, fast selection is never used.
2947 When the symbol `auto', fast selection is used if and only if selection
2948 characters for tags have been configured, either through the variable
2949 `org-tag-alist' or through a #+TAGS line in the buffer.
2950 When t, fast selection is always used and selection keys are assigned
2951 automatically if necessary."
2959 "Non-nil means fast tag selection exits after first change.
2960 When nil, you have to press RET to exit it.
2961 During fast tag selection, you can toggle this flag with `C-c'.
2962 This variable can also have the value `expert'. In this case, the window
2963 displaying the tags menu is not even shown, until you press C-c again."
2971 "Non-nil means fast tags selection interface will also offer TODO states.
2975 "The column to which tags should be indented in a headline.
2976 If this number is positive, it specifies the column. If it is negative,
2977 it means that the tags should be flushright to that column. For example,
2978 -80 works well for a normal 80 character screen.
2979 When 0, place tags directly after headline text, with only one space in
2980 between."
2985 "Non-nil keeps tags aligned when modifying headlines.
2986 Some operations (i.e. demoting) change the length of a headline and
2987 therefore shift the tags around. With this option turned on, after
2988 each such operation the tags are again aligned to `org-tags-column'."
2993 "Non-nil means tags in levels apply also for sublevels.
2994 When nil, only the tags directly given in a specific line apply there.
2995 This may also be a list of tags that should be inherited, or a regexp that
2996 matches tags that should be inherited. Additional control is possible
2997 with the variable `org-tags-exclude-from-inheritance' which gives an
2998 explicit list of tags to be excluded from inheritance., even if the value of
2999 `org-use-tag-inheritance' would select it for inheritance.
3001 If this option is t, a match early-on in a tree can lead to a large
3002 number of matches in the subtree when constructing the agenda or creating
3003 a sparse tree. If you only want to see the first match in a tree during
3004 a search, check out the variable `org-tags-match-list-sublevels'."
3013 "List of tags that should never be inherited.
3014 This is a way to exclude a few tags from inheritance. For way to do
3015 the opposite, to actively allow inheritance for selected tags,
3016 see the variable `org-use-tag-inheritance'."
3021 "Check if TAG is one that should be inherited."
3033 "Non-nil means list also sublevels of headlines matching a search.
3034 This variable applies to tags/property searches, and also to stuck
3035 projects because this search is based on a tags match as well.
3037 When set to the symbol `indented', sublevels are indented with
3038 leading dots.
3040 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3041 the sublevels of a headline matching a tag search often also match
3042 the same search. Listing all of them can create very long lists.
3043 Setting this variable to nil causes subtrees of a match to be skipped.
3045 This variable is semi-obsolete and probably should always be true. It
3046 is better to limit inheritance to certain tags using the variables
3047 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3055 "When set, tags are sorted using this function as a comparator."
3071 "Options concerning properties in Org-mode."
3076 "How property key/value pairs should be formatted by `indent-line'.
3077 When `indent-line' hits a property definition, it will format the line
3078 according to this format, mainly to make sure that the values are
3079 lined-up with respect to each other."
3084 "Alist of properties and functions to adjust inserted values.
3085 Elements of this alist must be of the form
3087 ([string] [function])
3089 where [string] must be a property name and [function] must be a
3090 lambda expression: this lambda expression must take one argument,
3091 the value to adjust, and return the new value as a string.
3095 and the clock summary:
3098 (let ((clocksum (org-clock-sum-current-item))
3099 (effort (org-duration-string-to-minutes
3101 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3108 "Non-nil means properties apply also for sublevels.
3110 This setting is chiefly used during property searches. Turning it on can
3111 cause significant overhead when doing a search, which is why it is not
3112 on by default.
3114 When nil, only the properties directly given in the current entry count.
3115 When t, every property is inherited. The value may also be a list of
3116 properties that should have inheritance, or a regular expression matching
3117 properties that should be inherited.
3119 However, note that some special properties use inheritance under special
3120 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3122 for valid values of a property.
3124 Note for programmers:
3125 When querying an entry with `org-entry-get', you can control if inheritance
3126 should be used. By default, `org-entry-get' looks only at the local
3127 properties. You can request inheritance by setting the inherit argument
3128 to t (to force inheritance) or to `selective' (to respect the setting
3129 in this variable)."
3138 "Check if PROPERTY is one that should be inherited."
3149 "The default column format, if no other format has been defined.
3150 This variable can be set on the per-file basis by inserting a line
3152 #+COLUMNS: %25ITEM ....."
3157 "The ellipses to be used when a field in column view is truncated.
3158 When this is the empty string, as many characters as possible are shown,
3159 but then there will be no visual indication that the field has been truncated.
3160 When this is a string of length N, the last N characters of a truncated
3161 field are replaced by this string. If the column is narrower than the
3162 ellipses string, only part of the ellipses string will be shown."
3167 "Function that modifies values for display in column view.
3168 For example, it can be used to cut out a certain part from a time stamp.
3169 The function must take 2 arguments:
3171 column-title The title of the column (*not* the property name)
3172 value The value that should be modified.
3174 The function should return the value that should be displayed,
3175 or nil if the normal value should be used."
3180 "The property that is being used to keep track of effort estimates.
3181 Effort estimates given in this property need to have the format H:MM."
3189 "List of property/value pairs that can be inherited by any entry.
3191 These are fixed values, for the preset properties. The user variable
3192 that can be used to add to this list is `org-global-properties'.
3194 The entries in this list are cons cells where the car is a property
3195 name and cdr is a string with the value. If the value represents
3200 "List of property/value pairs that can be inherited by any entry.
3202 This list will be combined with the constant `org-global-properties-fixed'.
3204 The entries in this list are cons cells where the car is a property
3205 name and cdr is a string with the value.
3207 You can set buffer-local values for the same purpose in the variable
3208 `org-file-properties' this by adding lines like
3210 #+PROPERTY: NAME VALUE"
3217 "List of property/value pairs that can be inherited by any entry.
3218 Valid for the current buffer.
3223 "Options concerning agenda views in Org-mode."
3228 "Variable used by org files to set a category for agenda display.
3229 Such files should use a file variable to set it, for example
3233 or contain a special line
3235 #+CATEGORY: ELisp
3237 If the file does not specify a category, then file's base name
3243 "The files to be used for agenda display.
3247 If an entry is a directory, all files in that directory that are matched by
3248 `org-agenda-file-regexp' will be part of the file list.
3250 If the value of the variable is not a list but a single file name, then
3251 the list of agenda files is actually stored and maintained in that file, one
3252 agenda file per line. In this file paths can be given relative to
3253 `org-directory'. Tilde expansion and environment variable substitution
3254 are also made."
3261 "Regular expression to match files for `org-agenda-files'.
3262 If any element in the list in that variable contains a directory instead
3263 of a normal file, all files in that directory that are matched by this
3264 regular expression will be included."
3269 "List of extra files to be searched by text search commands.
3270 These files will be search in addition to the agenda files by the
3271 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3272 Note that these files will only be searched for text search commands,
3273 not for the other agenda views like todo lists, tag searches or the weekly
3274 agenda. This variable is intended to list notes and possibly archive files
3275 that should also be searched by these two commands.
3276 In fact, if the first element in the list is the symbol `agenda-archives',
3277 than all archive files of all agenda files will be added to the search
3278 scope."
3289 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3290 A nil value means to remove them, after a query, from the list."
3295 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3296 The command `org-calendar-goto-agenda' will be bound to this key. The
3297 default is the character `c' because then `c' can be used to switch back and
3298 forth between agenda and calendar."
3303 "The key to be installed in `calendar-mode-map' for agenda-action.
3304 The command `org-agenda-action' will be bound to this key. The
3305 default is the character `k' because we use the same key in the agenda."
3310 "The key to be installed in `calendar-mode-map' for adding diary entries.
3311 This option is irrelevant until `org-agenda-diary-file' has been configured
3312 to point to an Org-mode file. When that is the case, the command
3313 `org-agenda-diary-entry' will be bound to the key given here, by default
3314 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3315 if you want to continue doing this, you need to change this to a different
3316 key."
3321 "File to which to add new entries with the `i' key in agenda and calendar.
3322 When this is the symbol `diary-file', the functionality in the Emacs
3323 calendar will be used to add entries to the `diary-file'. But when this
3324 points to a file, `org-agenda-diary-entry' will be used instead."
3340 org-calendar-insert-diary-entry-key
3344 "Options for embedding LaTeX code into Org-mode."
3352 "Options for creating images from LaTeX fragments.
3353 This is a property list with the following properties:
3355 `default' means use the foreground of the default face.
3357 `default' means use the background of the default face.
3358 :scale a scaling factor for the size of the images, to get more pixels
3359 :html-foreground, :html-background, :html-scale
3360 the same numbers for HTML export.
3361 :matchers a list indicating which matchers should be used to
3362 find LaTeX fragments. Valid members of this list are:
3373 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3374 When nil, just push out a message."
3381 Use this to specify additional executable file say a jar file.
3383 When using MathToWeb as the converter, specify the full-path to
3384 your mathtoweb.jar file."
3392 "Command to convert LaTeX fragments to MathML.
3393 Replace format-specifiers in the command as noted below and use
3394 `shell-command' to convert LaTeX to MathML.
3395 %j: Executable file in fully expanded form as specified by
3396 `org-latex-to-mathml-jar-file'.
3397 %I: Input LaTeX file in fully expanded form
3398 %o: Output MathML file
3399 This command is used by `org-create-math-formula'.
3401 When using MathToWeb as the converter, set this to
3410 "Program to convert LaTeX fragments with.
3412 dvipng Process the LaTeX fragments to dvi file, then convert
3413 dvi files to png files using dvipng.
3414 This will also include processing of non-math environments.
3415 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3416 to convert pdf files to png files"
3424 "Path to store latex preview images. A relative path here creates many
3425 directories relative to the processed org files paths. An absolute path
3426 puts all preview images at the same place."
3428 ;; :version "24.3"
3432 "Return t if `org-latex-to-mathml-convert-command' is usable."
3435 org-latex-to-mathml-convert-command)
3437 org-latex-to-mathml-convert-command))))
3442 t))))))
3449 \[PACKAGES]
3450 \[DEFAULT-PACKAGES]
3451 % The settings below are copied from fullpage.sty
3464 "The document header used for processing LaTeX fragments.
3465 It is imperative that this header make sure that no page number
3466 appears on the page. The package defined in the variables
3467 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3469 will be appended."
3476 "Set the packages alist and make sure it has 3 elements per entry."
3480 x))
3481 val)))
3485 "Get the packages alist and make sure it has 3 elements per entry."
3489 x))
3492 ;; The following variables are defined here because is it also used
3493 ;; when formatting latex fragments. Originally it was part of the
3494 ;; LaTeX exporter, which is why the name includes "export".
3511 )
3512 "Alist of default packages to be inserted in the header.
3513 Change this only if one of the packages here causes an incompatibility
3514 with another package you are using.
3515 The packages in this list are needed by one part or another of Org-mode
3516 to function properly.
3518 - inputenc, fontenc: for basic font and character selection
3519 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3520 for interpreting the entities in `org-entities'. You can skip some of these
3521 packages if you don't use any of the symbols in it.
3522 - graphicx: for including images
3523 - float, wrapfig: for figure placement
3524 - longtable: for long tables
3525 - hyperref: for cross references
3527 Therefore you should not modify this variable unless you know what you
3528 are doing. The one reason to change it anyway is that you might be loading
3529 some other package that conflicts with one of the default packages.
3531 If SNIPPET-FLAG is t, the package also needs to be included when
3532 compiling LaTeX snippets into images for inclusion into HTML."
3546 "Alist of packages to be inserted in every LaTeX header.
3547 These will be inserted after `org-export-latex-default-packages-alist'.
3549 SNIPPET-FLAG, when t, indicates that this package is also needed when
3550 turning LaTeX snippets into images for inclusion into HTML.
3551 Make sure that you only list packages here which:
3552 - you want in every file
3553 - do not conflict with the default packages in
3554 `org-export-latex-default-packages-alist'
3555 - do not conflict with the setup in `org-format-latex-header'."
3569 "Settings for Org-mode appearance."
3574 "Non-nil means fontify only the stars in each headline.
3575 When nil, the entire headline is fontified.
3576 Changing it requires restart of `font-lock-mode' to become effective
3577 also in regions already fontified."
3582 "Non-nil means hide the first N-1 stars in a headline.
3583 This works by using the face `org-hide' for these stars. This
3584 face is white for a light background, and black for a dark
3585 background. You may have to customize the face `org-hide' to
3586 make this work.
3587 Changing it requires restart of `font-lock-mode' to become effective
3588 also in regions already fontified.
3589 You may also set this on a per-file basis by adding one of the following
3590 lines to the buffer:
3592 #+STARTUP: hidestars
3593 #+STARTUP: showstars"
3598 "List of symbols corresponding to keywords to be hidden the org buffer.
3599 For example, a value '(title) for this list will make the document's title
3600 appear in the buffer without the initial #+TITLE: keyword."
3609 "List of properties (as strings) with a special meaning.
3610 The default use of these custom properties is to let the user
3611 hide them with `org-toggle-custom-properties-visibility'."
3614 ;; :version "24.3"
3618 "Non-nil means change the face of a headline if it is marked DONE.
3619 Normally, only the TODO/DONE keyword indicates the state of a headline.
3620 When this is non-nil, the headline after the keyword is set to the
3621 `org-headline-done' as an additional indication."
3626 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3627 Changing this variable requires a restart of Emacs to take effect."
3632 "Non-nil means fontify the whole line for headings.
3633 This is useful when setting a background color for the
3634 org-level-* faces."
3639 "Non-nil means fontify what is treated specially by the exporters."
3644 "Non-nil mean font-lock should hide the emphasis marker characters."
3649 "Non-nil means show entities as UTF8 characters.
3656 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3662 "Regular expression for matching emphasis.
3663 After a match, the match groups contain these elements:
3664 0 The match of the full regular expression, including the characters
3665 before and after the proper match
3666 1 The character before the proper match, or empty at beginning of line
3667 2 The proper match, including the leading and trailing markers
3668 3 The leading marker like * or /, indicating the type of highlighting
3669 4 The text between the emphasis markers, not including the markers
3676 "Set variable and compute the emphasis regular expression."
3680 org-emphasis-alist org-emphasis-regexp-components)
3692 ;; make sure special characters appear at the right position in the class
3704 ;; Make the regexp
3712 body1
3724 body1
3732 "Components used to build the regular expression for emphasis.
3733 This is a list with five entries. Terminology: In an emphasis string
3737 specify what is allowed/forbidden in each part:
3739 pre Chars allowed as prematch. Beginning of line will be allowed too.
3740 post Chars allowed as postmatch. End of line will be allowed too.
3741 border The chars *forbidden* as border characters.
3743 non-shy groups here, and don't allow newline here.
3744 newline The maximum number of newlines allowed in an emphasis exp.
3746 Use customize to modify this, or restart Emacs after changing it."
3765 )
3766 "Special syntax for emphasized text.
3767 Text starting and ending with a special character will be emphasized, for
3768 example *bold*, _underlined_ and /italic/. This variable sets the marker
3769 characters, the face to be used by font-lock for highlighting in Org-mode
3770 Emacs buffers, and the HTML tags to be used for this.
3771 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3772 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3773 Use customize to modify this, or restart Emacs after changing it."
3788 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3791 ;;; Miscellaneous options
3794 "Completion in Org-mode."
3799 "Non-nil means use ido completion wherever possible.
3800 Note that `ido-mode' must be active for this variable to be relevant.
3801 If you decide to turn this variable on, you might well want to turn off
3802 `org-outline-path-complete-in-steps'.
3803 See also `org-completion-use-iswitchb'."
3808 "Non-nil means use iswitchb completion wherever possible.
3809 Note that `iswitchb-mode' must be active for this variable to be relevant.
3810 If you decide to turn this variable on, you might well want to turn off
3811 `org-outline-path-complete-in-steps'.
3812 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3818 Normal means, no org-mode-specific context."
3822 ;;; Functions and variables from their packages
3823 ;; Declared here to avoid compiler warnings
3825 ;; XEmacs only
3831 ;; Emacs only
3834 ;; Various packages
3853 org-agenda-format-item "org-agenda"
3884 ;;; Autoload and prepare some org modules
3886 ;; Some table stuff that needs to be defined here, because it is used
3887 ;; by the functions setting up org-mode or checking for table context.
3900 "Detect the first line outside a table when searching from within it.
3903 ;; Autoload the functions in org-table.el that are needed by functions here.
3908 org-table-convert org-table-convert-region org-table-copy-down
3909 org-table-copy-region org-table-create
3910 org-table-create-or-convert-from-region
3911 org-table-create-with-table.el org-table-current-dline
3912 org-table-cut-region org-table-delete-column org-table-edit-field
3913 org-table-edit-formulas org-table-end org-table-eval-formula
3914 org-table-export org-table-field-info
3915 org-table-get-stored-formulas org-table-goto-column
3916 org-table-hline-and-move org-table-import org-table-insert-column
3917 org-table-insert-hline org-table-insert-row org-table-iterate
3918 org-table-justify-field-maybe org-table-kill-row
3919 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3920 org-table-move-column org-table-move-column-left
3921 org-table-move-column-right org-table-move-row
3922 org-table-move-row-down org-table-move-row-up
3923 org-table-next-field org-table-next-row org-table-paste-rectangle
3924 org-table-previous-field org-table-recalculate
3925 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3926 org-table-toggle-coordinate-overlays
3927 org-table-toggle-formula-debugger org-table-wrap-region
3928 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3929 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3930 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3933 "Return t if the cursor is inside an org-type table.
3934 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3939 org-table-line-regexp)))
3940 nil))
3944 "Return t if and only if we are at a table.el table."
3950 "If there is a table.el table nearby, recognize it and move into it."
3956 nil
3966 t
3971 t)
3972 nil)
3973 nil))
3976 "Return t if the cursor is inside a hline in a table."
3981 nil))
3986 "Apply FUNCTION to the start of all tables in the buffer."
3996 ;; Exclude tables in src/example/verbatim/clocktable blocks
4004 ;; Declare and autoload functions from org-exp.el & Co
4012 org-insert-export-options-template
4013 org-table-clean-before-export))
4016 org-export-as-ascii-to-buffer org-replace-region-by-ascii
4017 org-export-region-as-ascii))
4020 org-replace-region-by-latex org-export-region-as-latex
4021 org-export-as-latex org-export-as-pdf
4022 org-export-as-pdf-and-open))
4025 org-export-as-html-batch org-export-as-html-to-buffer
4026 org-replace-region-by-html org-export-region-as-html
4027 org-export-as-html))
4030 org-replace-region-by-docbook org-export-region-as-docbook
4031 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
4032 org-export-as-docbook))
4035 org-export-icalendar-all-agenda-files
4036 org-export-icalendar-combine-agenda-files))
4040 ;; Declare and autoload functions from org-agenda.el
4045 org-todo-list org-tags-view org-agenda-list-stuck-projects
4046 org-diary org-agenda-to-appt
4047 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
4049 ;; Autoload org-remember
4054 org-remember-apply-template org-remember org-remember-handler)))
4059 org-capture-import-remember-templates)))
4061 ;; Autoload org-clock.el
4076 "Return non-nil if clock is currently running.
4077 The return value is actually the clock marker."
4082 "org-clock"
4084 org-clock-goto org-clock-sum org-clock-display
4085 org-clock-remove-overlays org-clock-report
4086 org-clocktable-shift org-dblock-write:clocktable
4087 org-get-clocktable org-resolve-clocks)))
4090 "If this is a CLOCK line, update it and return t.
4091 Otherwise, return nil."
4100 ts te h m s neg)
4103 nil)
4108 ;; The clock is running here
4129 t))))))
4132 "Check if the current buffer contains the running clock.
4133 If yes, offer to stop it and to save the buffer with the changes."
4142 "Check if this line starts a clock table, if yes, shift the time block."
4146 ;; Autoload org-timer.el
4150 "org-timer"
4152 org-timer-change-times-in-region
4153 org-timer-set-timer
4154 org-timer-reset-timers
4155 org-timer-show-remaining-time)))
4157 ;; Autoload org-feed.el
4161 "org-feed"
4165 ;; Autoload org-indent.el
4167 ;; Define the variable already here, to make sure we have it.
4169 "Non-nil if Org-Indent mode is enabled.
4174 "org-indent"
4177 ;; Autoload org-mobile.el
4181 "org-mobile"
4184 ;; Autoload archiving code
4185 ;; The stuff that is needed for cycling and tags has to be defined here.
4188 "Options concerning archiving in Org-mode."
4193 "The location where subtrees should be archived.
4195 The value of this variable is a string, consisting of two parts,
4196 separated by a double-colon. The first part is a filename and
4197 the second part is a headline.
4199 When the filename is omitted, archiving happens in the same file.
4200 %s in the filename will be replaced by the current file
4201 name (without the directory part). Archiving to a different file
4202 is useful to keep archived entries from contributing to the
4203 Org-mode Agenda.
4205 The archived entries will be filed as subtrees of the specified
4206 headline. When the headline is omitted, the subtrees are simply
4207 filed away at the end of the file, as top-level entries. Also in
4208 the heading you can use %s to represent the file name, this can be
4209 useful when using the same archive for a number of different files.
4211 Here are a few examples:
4213 If the current file is Projects.org, archive in file
4214 Projects.org_archive, as top-level trees. This is the default.
4217 Archive in the current file, under the top-level headline
4221 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4224 Archive in file ~/org/archive.org (absolute path), under headlines
4229 items to the datetree. Items are placed in either the CLOSED
4230 date of the item, or the current date if there is no CLOSED date.
4231 The heading will be a subentry to the current date. There doesn't
4232 need to be a heading, but there always needs to be a slash after
4233 datetree. For example, to store archived items directly in the
4237 Archive in file ./basement (relative path), as level 3 trees
4240 You may set this option on a per-file basis by adding to the buffer a
4241 line like
4243 #+ARCHIVE: basement::** Finished Tasks
4245 You may also define it locally for a subtree by setting an ARCHIVE property
4246 in the entry. If such a property is found in an entry, or anywhere up
4247 the hierarchy, it will be used."
4252 "The tag that marks a subtree as archived.
4253 An archived subtree does not open during visibility cycling, and does
4254 not contribute to the agenda listings.
4255 After changing this, font-lock must be restarted in the relevant buffers to
4256 get the proper fontification."
4262 "Non-nil means the agenda will skip any items located in archived trees.
4263 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4264 variable is no longer recommended, you should leave it at the value t.
4265 Instead, use the key `v' to cycle the archives-mode in the agenda."
4271 "Non-nil means ignore archived trees when creating column view."
4277 "Non-nil means `org-cycle' will open archived trees.
4278 An archived tree is a tree marked with the tag ARCHIVE.
4279 When nil, archived trees will stay folded. You can still open them with
4280 normal outline commands like `show-all', but not with the cycling commands."
4286 "Non-nil means sparse tree construction shows matches in archived trees.
4287 When nil, matches in these trees are highlighted, but the trees are kept in
4288 collapsed state."
4294 "The default date type when building a sparse tree.
4295 When this is nil, a date is a scheduled or a deadline timestamp.
4296 Otherwise, these types are allowed:
4298 all: all timestamps
4299 active: only active timestamps (<...>)
4300 inactive: only inactive timestamps (<...)
4301 scheduled: only scheduled timestamps
4302 deadline: only deadline timestamps"
4309 ;; :version "24.3"
4313 "Re-hide all archived subtrees after a visibility state change."
4324 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4327 "Cycle subtree even if it is archived."
4334 "Re-hide all archived subtrees after a visibility state change."
4351 flag)))
4358 org-archive-to-archive-sibling org-toggle-archive-tag
4359 org-archive-subtree-default
4360 org-archive-subtree-default-with-confirmation)))
4362 ;; Autoload Column View Code
4370 org-columns-compute org-agenda-columns org-columns-remove-overlays
4373 ;; Autoload ID code
4381 org-id-get-with-outline-path-completion
4382 org-id-get-with-outline-drilling org-id-store-link
4383 org-id-goto org-id-find org-id-store-link))
4385 ;; Autoload Plotting Code
4390 ;;; Variables for pre-computed regular expressions, all buffer local
4408 "Matches a headline and puts everything into groups:
4409 group 1: the stars
4410 group 2: The todo keyword, maybe
4411 group 3: Priority cookie
4412 group 4: True headline
4416 "Printf format to make regexp to match an exact headline.
4417 This regexp will match the headline of any node which has the
4418 exact headline text that is put into the format, but may have any
4422 "Matches a headline and puts TODO state into group 2 if present.
4468 "Regular expression to match a plain time or time range.
4469 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4470 groups carry important information:
4471 0 the full match
4472 1 the first time, range or not
4480 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4481 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4482 groups carry important information:
4483 0 the full match
4484 7 hours of duration
4493 "Regular expression to match a timestamp time or time range.
4494 After a match, the following groups carry important information:
4495 0 the full match
4496 1 date plus weekday, for back referencing to make sure both times are on the same day
4497 2 the first time, range or not
4552 "Variable associated with STARTUP options for org-mode.
4553 Each element is a list of three items: the startup options (as written
4554 in the #+STARTUP line), the corresponding variable, and the value to set
4555 this variable to if the option is found. An optional forth element PUSH
4559 "Update PROPS with KEY and VAL."
4573 "Printf format for a regexp matching an headline with some keyword.
4574 This regexp will match the headline of any node which has the
4575 exact keyword that is put into the format. The keyword isn't in
4579 "Printf format for a regexp matching an headline, possibly with some keyword.
4580 This regexp can match any headline with the specified keyword, or
4581 without a keyword. The keyword isn't in any group by default,
4585 "Precompute regular expressions for current buffer."
4605 kwds kws0 kwsa key log value cat arch tags const links hw dws
4606 tail sep kws1 prio props ftags drawers beamer-p
4628 ;; general TODO-like setup
4640 links)))
4647 props))))
4652 ftags
4662 l var val)
4692 ;; search for property blocks
4701 props)))))))
4718 ;; Process the TODO keywords
4720 ;; Use the global values as if they had been given locally.
4732 kws)))
4735 kwsa nil
4738 ;; 1 2
4746 kw)
4748 kws0)
4765 ;; Process the constants
4773 ;; Process the tags.
4784 tgs))
4792 ;; Compute the regular expressions and other local variables.
4793 ;; Using `org-outline-regexp-bol' would complicate them much,
4794 ;; because of the fixed white space at the end of that string.
4802 org-drawer-regexp
4806 org-not-done-keywords
4808 org-todo-regexp
4812 org-not-done-regexp
4816 org-not-done-heading-regexp
4818 org-todo-line-regexp
4820 org-complex-heading-regexp
4827 org-complex-heading-regexp-format
4832 ;; Stats cookies can be stuck to body.
4839 org-todo-line-tags-regexp
4846 org-deadline-time-regexp
4848 org-deadline-line-regexp
4850 org-scheduled-regexp
4852 org-scheduled-time-regexp
4854 org-closed-time-regexp
4856 org-keyword-time-regexp
4862 org-keyword-time-not-clock-regexp
4868 org-maybe-keyword-time-regexp
4874 org-all-time-keywords
4877 org-clock-string org-closed-string))
4878 )
4883 "Return the contents of FILE, as a string."
4897 "Extract the log state setting from a TODO keyword string.
4911 "Remove a pair of parenthesis at the end of each string in LIST."
4915 x))
4916 list))
4919 "Assign fast keys to a keyword-key alist.
4920 Respect keys that are already there."
4938 ;;; Some variables used in various places
4945 "Function to be called when `C-c C-c' is used.
4949 ;; FIXME: Occasionally check by commenting these, to make sure
4950 ;; no other functions uses these, forgetting to let-bind them.
4955 ;; Defined somewhere in this file, but used before definition.
4961 ;;;; Define the Org-mode
4963 ;; We use a before-change function to check if a table might need
4964 ;; an update.
4966 "Indicates that a table might need an update.
4967 This variable is set by `org-before-change-function'.
4970 "Every change indicates that a table might need an update."
4985 (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"))
4988 ;; Other stuff we need.
4996 ;; (require 'org-compat) moved higher up in the file before it is first used
5003 ;; babel
5012 ;;;###autoload
5014 "Outline-based notes management and organizer, alias
5017 Org-mode develops organizational tasks around a NOTES file which
5018 contains information about projects as plain text. Org-mode is
5019 implemented on top of outline-mode, which is ideal to keep the content
5020 of large files well structured. It supports ToDo items, deadlines and
5021 time stamps, which magically appear in the diary listing of the Emacs
5022 calendar. Tables are easily created with a built-in table editor.
5023 Plain text URL-like links connect to websites, emails (VM), Usenet
5024 messages (Gnus), BBDB entries, and any files related to the project.
5025 For printing and sharing of notes, an Org-mode file (or a part of it)
5026 can be exported as a structured ASCII or HTML file.
5028 The following commands are available:
5032 ;; Get rid of Outline menus, they are not needed
5033 ;; Need to do this here because define-derived-mode sets up
5034 ;; the keymap so late. Still, it is a waste to call this each time
5035 ;; we switch another buffer into org-mode.
5038 ;; Assume this is Greg's port, it uses easymenu
5064 org-display-table 4
5067 org-ellipsis)))
5072 ;; tag faces set outside customize.... force initialization.
5074 ;; Calc embedded
5080 ;; Activate before-change-function
5084 ;; Check for running clock before killing a buffer
5086 ;; Paragraphs and auto-filling
5091 ;; Comments
5098 ;; Beginning/end of defun
5101 ;; Next error for sparse trees
5103 ;; Make sure dependence stuff works reliably, even for users who set it
5104 ;; too late :-(
5116 ;; Align options lines
5118 'align-mode-rules-list
5123 ;; Imenu
5127 ;; Make isearch reveal context
5130 ;; Emacs 21 and XEmacs make use of the hook
5132 ;; Emacs 22 deals with this through a special variable
5136 ;; Turn on org-beamer-mode?
5139 ;; Setup the pcomplete hooks
5152 ;; If empty file that did not turn on org-mode automatically, make it to.
5177 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5187 "Return today date, considering `org-extend-today-until'."
5192 ;;;; Font-Lock stuff, including the activators
5223 "Regular expression used to analyze links.
5224 Here is what the match groups contain after a match:
5225 1: http:
5226 2: http
5227 3: path
5228 4: [desc]
5236 "Number of stacked braces for sub/superscript matching.
5237 This has to be set before loading org.el to be effective."
5242 "Create a regular expression which will match a balanced sexp.
5243 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5244 as single character strings.
5245 The regexp returned will match the entire expression including the
5246 delimiters. It will also define a single group which contains the
5247 match except for the outermost delimiters. The maximum depth of
5248 stacked delimiters is N. Escaping delimiters is not possible."
5277 "Update the link regular expressions.
5278 This should be called after the variable `org-link-types' has changed."
5282 org-link-re-with-space
5288 org-link-re-with-space2
5294 org-link-re-with-space3
5299 org-angle-link-re
5305 org-plain-link-re
5309 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5310 org-bracket-link-regexp
5312 org-bracket-link-analytic-regexp
5320 org-bracket-link-analytic-regexp++
5328 org-any-link-re
5337 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5340 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5341 "Regular expression matching time strings for analysis.
5342 This one does not require the space after the date, so it can be used
5344 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5360 "Regular expression matching a time stamp or time stamp range.
5366 "Run through the buffer and add overlays to emphasized strings."
5375 'face
5388 rtn))
5391 "Insert or change an emphasis, i.e. a font like bold or italic.
5392 If there is an active region, change that region to a new emphasis.
5393 If there is no region, just insert the marker characters and position
5394 the cursor between them.
5395 CHAR should be either the marker character, or the first character of the
5396 HTML tag associated with that emphasis. If CHAR is a space, the means
5397 to remove the emphasis of the selected region.
5398 If char is not given (for example in an interactive call) it
5399 will be prompted for."
5450 "Run through the buffer and add overlays to links."
5464 nil
5470 t)))))
5478 t)))
5481 "When non-nil, fontify code in code blocks."
5488 "When non-nil, allow promoting a top level subtree.
5489 The leading star of the top level headline will be replaced
5490 by a #."
5501 "Fontify #+ lines and blocks, in the correct ways."
5504 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5505 limit t)
5513 end end1 quoting block-type ovl)
5516 ;; a single line of backend-specific content
5524 ; for backend-specific code
5525 t)
5527 ;; Truly a block
5540 beg end
5548 ;; remove old background overlays
5553 ;; add a background overlay
5568 t))
5588 t)
5594 ;; just any other in-buffer setting, but not indented
5598 t)
5602 "Strip protective commas between BEG and END in the current buffer."
5618 "Run through the buffer and add overlays to links."
5626 t)))
5629 "Run through the buffer and add overlays to footnotes."
5636 'keymap org-mouse-map
5637 'help-echo
5639 "Footnote definition"
5641 'font-lock-fontified t
5642 'font-lock-multiline t
5646 "Run through the buffer and add overlays to bracketed links."
5650 ;; FIXME: above we should remove the escapes.
5651 ;; but that requires another match, protecting match data,
5652 ;; a lot of overhead for font-lock.
5659 ;; We need to remove the invisible property here. Table narrowing
5660 ;; may have made some of this invisible.
5678 t)))
5681 "Run through the buffer and add overlays to dates."
5693 t)))
5702 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5706 "Run through the buffer and add overlays to target matches."
5714 'keymap org-mouse-map
5718 t)))))
5721 "Find all radio targets in this file and update the regular expression."
5736 t)))
5743 ;; This should be with the exporter code, but we also use if for font-locking
5753 "Compute regular expression for stuff treated specially by exporters."
5760 org-latex-regexps)))
5787 org-entities)))
5791 org-latex-entities)
5792 nil))
5794 ))
5795 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5798 org-export-html-special-string-regexps)))
5803 ))))
5805 'org-latex-and-specials-regexp
5810 "Run through the buffer and add overlays to links."
5814 limit t))
5828 rtn)))
5831 "Restart `font-lock-mode', to force refontification."
5837 "Return a list of all targets in this file.
5838 With optional argument RADIO, only find radio targets."
5840 rtn)
5845 rtn)))
5848 "Make regular expression matching all strings in TARGETS.
5849 The regular expression finds the targets also if there is a line break
5850 between words."
5859 x)
5860 targets
5872 t)))
5875 "Compute the outline level of the heading at point.
5876 This function assumes that the cursor is at the beginning of a line matched
5877 by `outline-regexp'. Otherwise it returns garbage.
5878 If this is called at a normal headline, the level is the number of stars.
5879 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5886 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5893 "Functions that can manipulate `org-font-lock-extra-keywords'.
5894 This is called after `org-font-lock-extra-keywords' is defined, but before
5895 it is installed to be used by font lock. This can be useful if something
5906 ;; Call the hook
5908 ;; Headlines
5915 ;; Table lines
5918 ;; Table internals
5923 ;; Drawers
5926 ;; Properties
5930 ;; Links
5940 ;; TODO keyword
5942 org-todo-regexp)
5944 ;; DONE
5952 nil)
5953 ;; Priorities
5955 ;; Tags
5957 ;; Special keywords
5962 ;; Emphasis
5967 ;; Checkboxes
5968 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5973 ;; Description list items
5976 ;; ARCHIVEd headings
5978 org-outline-regexp-bol
5981 ;; Specials
5985 ;; Code
5987 ;; COMMENT
5993 ;; Blocks and meta lines
5995 )))
5998 ;; Now set the full font-lock-keywords
6005 "Toggle the composition display of entities as UTF8 characters."
6021 "Display or hide properties in `org-custom-properties'."
6038 org-custom-properties)))))))
6041 "Find an entity to fontify."
6047 limit t)
6062 nil))))
6065 "Fontify string S like in Org-mode."
6077 "Get the right face for match N in font-lock matching of headlines."
6090 "Get the right face for a TODO keyword KWD.
6091 If KWD is a number, get the corresponding match group."
6099 "Create a face list that inherits INHERIT, but sets the foreground color.
6100 When FACE-OR-COLOR is not a string, just return it."
6104 face-or-color)
6105 face-or-color))
6108 "Add the special tag faces."
6117 "Add the special priority faces."
6125 org-priority-faces)))
6130 "Get the right face for a TODO keyword KWD.
6131 If KWD is a number, get the corresponding match group."
6138 "Remove fontification and activation overlays from links."
6143 deactivate-mark buffer-file-name buffer-file-truename)
6147 invisible t intangible t
6148 org-no-flyspell t org-emphasis t))
6158 "Remove specific display properties that have been added by font lock.
6159 The will remove the raise properties that are used to show superscripts
6160 and subscripts."
6170 "Add raise properties to sub/superscripts."
6174 org-match-substring-regexp
6175 org-match-substring-with-braces-regexp)
6176 limit t)
6186 ;; FIXME: Should we go back one character here, for a_b^c
6187 ;; (goto-char (1- pos)) ;????????????????????
6189 t
6191 'display
6207 t)))))
6209 ;;;; Visibility cycling, including org-goto and indirect buffer
6211 ;;; Cycling
6218 ;;;###autoload
6223 "TAB-action and visibility cycling for Org-mode.
6225 This is the command invoked in Org-mode by the TAB key. Its main purpose
6226 is outline visibility cycling, but it also invokes other actions
6227 in special contexts.
6229 - When this function is called with a prefix argument, rotate the entire
6230 buffer through 3 states (global cycling)
6231 1. OVERVIEW: Show only top-level headlines.
6232 2. CONTENTS: Show all headlines of all levels, but no body text.
6233 3. SHOW ALL: Show everything.
6234 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6235 determined by the variable `org-startup-folded', and by any VISIBILITY
6236 properties in the buffer.
6237 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6238 including any drawers.
6240 - When inside a table, re-align the table and move to the next field.
6242 - When point is at the beginning of a headline, rotate the subtree started
6243 by this line through 3 different states (local cycling)
6244 1. FOLDED: Only the main headline is shown.
6245 2. CHILDREN: The main headline and the direct children are shown.
6246 From this state, you can move to one of the children
6247 and zoom in further.
6248 3. SUBTREE: Show the entire subtree, including body text.
6249 If there is no subtree, switch directly from CHILDREN to FOLDED.
6251 - When point is at the beginning of an empty headline and the variable
6252 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6253 of the headline by demoting and promoting it to likely levels. This
6254 speeds up creation document structure by pressing TAB once or several
6255 times right after creating a new headline.
6257 - When there is a numeric prefix, go up to a heading with level ARG, do
6258 a `show-subtree' and return to the previous cursor position. If ARG
6259 is negative, go up that many levels.
6261 - When point is not at the beginning of a headline, execute the global
6262 binding for TAB, which is re-indenting the line. See the option
6263 `org-cycle-emulate-tab' for details.
6265 - Special case: if point is at the beginning of the buffer and there is
6266 no headline in line 1, this function will act as if called with prefix arg
6267 (C-u TAB, same as S-TAB) also when called without prefix arg.
6268 But only if also the variable `org-cycle-global-at-bob' is t."
6278 org-inlinetask-min-level
6283 limit-level)))
6286 outline-regexp
6294 org-cycle-hook))
6298 ;; special case: use global cycling
6312 ;; Table: enter it or move to the next field.
6323 ;; Global cycling: delegate to `org-cycle-internal-global'.
6326 ;; Drawers: delegate to `org-flag-drawer'.
6334 ;; Show-subtree, ARG levels up from here.
6342 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6350 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6357 ;; From there: TAB emulation and template completion.
6379 t
6388 "Do the global cycling action."
6389 ;; Hack to avoid display of messages for .org attachments in Gnus
6394 ;; We just created the overview - now do table of contents
6395 ;; This can be slow in very large buffers, so indicate action
6405 ;; We just showed the table of contents - now show everything
6413 ;; Default action: go to overview
6421 "Do the local cycling action."
6423 ;; First, determine end of headline (EOH), end of subtree or item
6424 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6448 ;; Determine end invisible part of buffer (EOL)
6450 ;; XEmacs doesn't have `next-single-char-property-change'
6460 ;; Find out what to do next and set `this-command'
6463 ;; Nothing is hidden behind this heading
6475 org-cycle-skip-children-state-if-no-children))))
6476 ;; Entire subtree is hidden in one line: children view
6482 ;; FIXME: This slows down the func way too much.
6483 ;; How keep drawers hidden in subtree anyway?
6484 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6485 ;; (org-cycle-hide-drawers 'subtree))
6487 ;; Fold every list in subtree to top-level items.
6509 ;; We just showed the children, or no children are there,
6510 ;; now show everything.
6517 ;; Default action: hide the subtree.
6524 ;;;###autoload
6526 "Cycle the global visibility. For details see `org-cycle'.
6528 With a numeric prefix, show all headlines up to that level."
6544 "Set the visibility required by startup options and properties."
6559 "Switch subtree visibilities according to :VISIBILITY: property."
6566 nil t)
6590 ;; This function uses outline-regexp instead of the more fundamental
6591 ;; org-outline-regexp so that org-cycle-global works outside of Org
6592 ;; buffers, where outline-regexp is needed.
6594 "Switch to overview mode, showing only top-level headlines.
6595 Really, this shows all headlines with level equal or greater than the level
6596 of the first headline in the buffer. This is important, because if the
6597 first headline is not level one, then (hide-sublevels 1) gives confusing
6598 results."
6609 "Show all headlines in the buffer, like a table of contents.
6610 With numerical argument N, show content up to level N."
6613 ;; Visit all headings and show their offspring
6620 t)
6629 "Adjust the window after a change in outline visibility.
6630 This function is the default value of the hook `org-cycle-hook'."
6640 "Remove outline overlays that do not contain non-white stuff."
6650 "Fix visibility issues after moving a subtree."
6651 ;; First, find a reasonable region to look at:
6652 ;; Start two siblings above, end three below
6670 ;; Properly fold already folded siblings
6681 "Show empty lines above all visible headlines.
6682 The region to be covered depends on STATE when called through
6683 `org-cycle-hook'. Lisp program can use t for STATE to get the
6684 entire buffer covered. Note that an empty line is only shown if there
6685 are at least `org-cycle-separator-lines' empty lines before the headline."
6695 beg end b e)
6719 ;; Never hide empty lines at the end of the file.
6729 "Move to the parent and re-show empty lines before visible headlines."
6735 "Return `org-agenda-files' list, plus all open org-mode files.
6736 This is useful for operations that need to scan all of a user's
6737 open and agenda-wise Org files."
6745 files))
6748 "Return the beginning position of the current entry."
6752 "Return the end position of the current entry."
6756 "Re-hide all drawers after a visibility state change."
6771 "When FLAG is non-nil, hide the drawer we are within.
6772 Otherwise make it visible."
6784 "Is the end of the current subtree visible?"
6789 "Move cursor to the first headline and recenter the headline.
6790 Optional argument N means put the headline into the Nth line of the window."
6796 ;;; Saving and restoring visibility
6799 "Return a list of the locations of all outline overlays.
6800 These are overlays with the `invisible' property value `outline'.
6801 The return value is a list of cons cells, with start and stop
6802 positions for each overlay.
6803 If USE-MARKERS is set, return the positions as markers."
6821 "Create visibility overlays for all positions in DATA.
6822 DATA should have been made by `org-outline-overlay-data'."
6830 data)))))
6832 ;;; Folding of blocks
6839 "Call FUNCTION at the head of all source blocks in the current buffer.
6840 Optional arguments START and END can be used to limit the range."
6852 "Toggle the visibility of all blocks in the current buffer."
6856 "Fold all blocks in the current buffer."
6862 "Unfold all blocks in the current buffer."
6868 "Toggle visibility of block at point."
6879 "Toggle the visibility of the current block."
6886 ov)
6902 ;; make the block accessible to isearch
6904 ov 'isearch-open-invisible
6915 ;; org-tab-after-check-for-cycling-hook
6917 ;; Remove overlays when changing major mode
6922 ;;; Org-goto
6928 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6944 nil)
6945 (org-defkey map "q" 'org-goto-quit)
6946 (org-defkey map "n" 'outline-next-visible-heading)
6947 (org-defkey map "p" 'outline-previous-visible-heading)
6948 (org-defkey map "f" 'outline-forward-same-level)
6949 (org-defkey map "b" 'outline-backward-same-level)
6950 (org-defkey map "u" 'outline-up-heading))
6951 (org-defkey map "/" 'org-occur)
6952 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6953 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6954 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6955 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6956 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6957 map))
6959 (defconst org-goto-help
6960 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6961 RET=jump to location [Q]uit and return to previous location
6962 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6964 (defvar org-goto-start-pos) ; dynamically scoped parameter
6966 ;; FIXME: Docstring does not mention both interfaces
6967 (defun org-goto (&optional alternative-interface)
6968 "Look up a different location in the current file, keeping current visibility.
6970 When you want look-up or go to a different location in a
6971 document, the fastest way is often to fold the entire buffer and
6972 then dive into the tree. This method has the disadvantage, that
6973 the previous location will be folded, which may not be what you
6974 want.
6976 This command works around this by showing a copy of the current
6977 buffer in an indirect buffer, in overview mode. You can dive
6978 into the tree in that copy, use org-occur and incremental search
6979 to find a location. When pressing RET or `Q', the command
6980 returns to the original buffer in which the visibility is still
6981 unchanged. After RET it will also jump to the location selected
6982 in the indirect buffer and expose the headline hierarchy above.
6984 With a prefix argument, use the alternative interface: e.g. if
6985 `org-goto-interface' is 'outline use 'outline-path-completion."
6986 (interactive "P")
6987 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6988 (org-refile-use-outline-path t)
6989 (org-refile-target-verify-function nil)
6990 (interface
6991 (if (not alternative-interface)
6992 org-goto-interface
6993 (if (eq org-goto-interface 'outline)
6994 'outline-path-completion
6995 'outline)))
6996 (org-goto-start-pos (point))
6997 (selected-point
6998 (if (eq interface 'outline)
6999 (car (org-get-location (current-buffer) org-goto-help))
7000 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7001 (org-refile-check-position pa)
7002 (nth 3 pa)))))
7003 (if selected-point
7004 (progn
7005 (org-mark-ring-push org-goto-start-pos)
7006 (goto-char selected-point)
7007 (if (or (outline-invisible-p) (org-invisible-p2))
7008 (org-show-context 'org-goto)))
7009 (message "Quit"))))
7011 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7012 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7013 (defvar org-goto-local-auto-isearch-map) ; defined below
7015 (defun org-get-location (buf help)
7016 "Let the user select a location in the Org-mode buffer BUF.
7017 This function uses a recursive edit. It returns the selected position
7018 or nil."
7019 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7020 (isearch-hide-immediately nil)
7021 (isearch-search-fun-function
7022 (lambda () 'org-goto-local-search-headings))
7023 (org-goto-selected-point org-goto-exit-command)
7024 (pop-up-frames nil)
7025 (special-display-buffer-names nil)
7026 (special-display-regexps nil)
7027 (special-display-function nil))
7028 (save-excursion
7029 (save-window-excursion
7030 (delete-other-windows)
7031 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7032 (org-pop-to-buffer-same-window
7033 (condition-case nil
7034 (make-indirect-buffer (current-buffer) "*org-goto*")
7035 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7036 (with-output-to-temp-buffer "*Help*"
7037 (princ help))
7038 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
7039 (setq buffer-read-only nil)
7040 (let ((org-startup-truncated t)
7041 (org-startup-folded nil)
7042 (org-startup-align-all-tables nil))
7043 (org-mode)
7044 (org-overview))
7045 (setq buffer-read-only t)
7046 (if (and (boundp 'org-goto-start-pos)
7047 (integer-or-marker-p org-goto-start-pos))
7048 (let ((org-show-hierarchy-above t)
7049 (org-show-siblings t)
7050 (org-show-following-heading t))
7051 (goto-char org-goto-start-pos)
7052 (and (outline-invisible-p) (org-show-context)))
7053 (goto-char (point-min)))
7054 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7055 (message "Select location and press RET")
7056 (use-local-map org-goto-map)
7057 (recursive-edit)
7058 ))
7059 (kill-buffer "*org-goto*")
7060 (cons org-goto-selected-point org-goto-exit-command)))
7062 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7063 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7064 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7065 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7067 (defun org-goto-local-search-headings (string bound noerror)
7068 "Search and make sure that any matches are in headlines."
7069 (catch 'return
7070 (while (if isearch-forward
7071 (search-forward string bound noerror)
7072 (search-backward string bound noerror))
7073 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7074 (and (member :headline context)
7075 (not (member :tags context))))
7076 (throw 'return (point))))))
7078 (defun org-goto-local-auto-isearch ()
7079 "Start isearch."
7080 (interactive)
7081 (goto-char (point-min))
7082 (let ((keys (this-command-keys)))
7083 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7084 (isearch-mode t)
7085 (isearch-process-search-char (string-to-char keys)))))
7087 (defun org-goto-ret (&optional arg)
7088 "Finish `org-goto' by going to the new location."
7089 (interactive "P")
7090 (setq org-goto-selected-point (point)
7091 org-goto-exit-command 'return)
7092 (throw 'exit nil))
7094 (defun org-goto-left ()
7095 "Finish `org-goto' by going to the new location."
7096 (interactive)
7097 (if (org-at-heading-p)
7098 (progn
7099 (beginning-of-line 1)
7100 (setq org-goto-selected-point (point)
7101 org-goto-exit-command 'left)
7102 (throw 'exit nil))
7103 (error "Not on a heading")))
7105 (defun org-goto-right ()
7106 "Finish `org-goto' by going to the new location."
7107 (interactive)
7108 (if (org-at-heading-p)
7109 (progn
7110 (setq org-goto-selected-point (point)
7111 org-goto-exit-command 'right)
7112 (throw 'exit nil))
7113 (error "Not on a heading")))
7115 (defun org-goto-quit ()
7116 "Finish `org-goto' without cursor motion."
7117 (interactive)
7118 (setq org-goto-selected-point nil)
7119 (setq org-goto-exit-command 'quit)
7120 (throw 'exit nil))
7122 ;;; Indirect buffer display of subtrees
7124 (defvar org-indirect-dedicated-frame nil
7125 "This is the frame being used for indirect tree display.")
7126 (defvar org-last-indirect-buffer nil)
7128 (defun org-tree-to-indirect-buffer (&optional arg)
7129 "Create indirect buffer and narrow it to current subtree.
7130 With numerical prefix ARG, go up to this level and then take that tree.
7131 If ARG is negative, go up that many levels.
7132 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7133 indirect buffer previously made with this command, to avoid proliferation of
7134 indirect buffers. However, when you call the command with a \
7136 when `org-indirect-buffer-display' is `new-frame', the last buffer
7137 is kept so that you can work with several indirect buffers at the same time.
7138 If `org-indirect-buffer-display' is `dedicated-frame', the \
7140 requests that a new frame be made for the new buffer, so that the dedicated
7141 frame is not changed."
7142 (interactive "P")
7143 (let ((cbuf (current-buffer))
7144 (cwin (selected-window))
7145 (pos (point))
7146 beg end level heading ibuf)
7147 (save-excursion
7148 (org-back-to-heading t)
7149 (when (numberp arg)
7150 (setq level (org-outline-level))
7151 (if (< arg 0) (setq arg (+ level arg)))
7152 (while (> (setq level (org-outline-level)) arg)
7153 (outline-up-heading 1 t)))
7154 (setq beg (point)
7155 heading (org-get-heading))
7156 (org-end-of-subtree t t)
7157 (if (org-at-heading-p) (backward-char 1))
7158 (setq end (point)))
7159 (if (and (buffer-live-p org-last-indirect-buffer)
7160 (not (eq org-indirect-buffer-display 'new-frame))
7161 (not arg))
7162 (kill-buffer org-last-indirect-buffer))
7163 (setq ibuf (org-get-indirect-buffer cbuf)
7164 org-last-indirect-buffer ibuf)
7165 (cond
7166 ((or (eq org-indirect-buffer-display 'new-frame)
7167 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7168 (select-frame (make-frame))
7169 (delete-other-windows)
7170 (org-pop-to-buffer-same-window ibuf)
7171 (org-set-frame-title heading))
7172 ((eq org-indirect-buffer-display 'dedicated-frame)
7173 (raise-frame
7174 (select-frame (or (and org-indirect-dedicated-frame
7175 (frame-live-p org-indirect-dedicated-frame)
7176 org-indirect-dedicated-frame)
7177 (setq org-indirect-dedicated-frame (make-frame)))))
7178 (delete-other-windows)
7179 (org-pop-to-buffer-same-window ibuf)
7180 (org-set-frame-title (concat "Indirect: " heading)))
7181 ((eq org-indirect-buffer-display 'current-window)
7182 (org-pop-to-buffer-same-window ibuf))
7183 ((eq org-indirect-buffer-display 'other-window)
7184 (pop-to-buffer ibuf))
7185 (t (error "Invalid value")))
7186 (if (featurep 'xemacs)
7187 (save-excursion (org-mode) (turn-on-font-lock)))
7188 (narrow-to-region beg end)
7189 (show-all)
7190 (goto-char pos)
7191 (run-hook-with-args 'org-cycle-hook 'all)
7192 (and (window-live-p cwin) (select-window cwin))))
7194 (defun org-get-indirect-buffer (&optional buffer)
7195 (setq buffer (or buffer (current-buffer)))
7196 (let ((n 1) (base (buffer-name buffer)) bname)
7197 (while (buffer-live-p
7198 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7199 (setq n (1+ n)))
7200 (condition-case nil
7201 (make-indirect-buffer buffer bname 'clone)
7202 (error (make-indirect-buffer buffer bname)))))
7204 (defun org-set-frame-title (title)
7205 "Set the title of the current frame to the string TITLE."
7206 ;; FIXME: how to name a single frame in XEmacs???
7207 (unless (featurep 'xemacs)
7208 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7210 ;;;; Structure editing
7212 ;;; Inserting headlines
7214 (defun org-previous-line-empty-p ()
7215 (save-excursion
7216 (and (not (bobp))
7217 (or (beginning-of-line 0) t)
7218 (save-match-data
7221 (defun org-insert-heading (&optional force-heading invisible-ok)
7222 "Insert a new heading or item with same depth at point.
7223 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7224 If point is at the beginning of a headline, insert a sibling before the
7225 current headline. If point is not at the beginning, split the line,
7226 create the new headline with the text in the current line after point
7227 \(but see also the variable `org-M-RET-may-split-line').
7229 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7230 This is important for non-interactive uses of the command."
7231 (interactive "P")
7232 (if (or (= (buffer-size) 0)
7233 (and (not (save-excursion
7234 (and (ignore-errors (org-back-to-heading invisible-ok))
7235 (org-at-heading-p))))
7236 (or force-heading (not (org-in-item-p)))))
7237 (progn
7239 (run-hooks 'org-insert-heading-hook))
7240 (when (or force-heading (not (org-insert-item)))
7241 (let* ((empty-line-p nil)
7242 (level nil)
7243 (on-heading (org-at-heading-p))
7244 (head (save-excursion
7245 (condition-case nil
7246 (progn
7247 (org-back-to-heading invisible-ok)
7248 (when (and (not on-heading)
7249 (featurep 'org-inlinetask)
7250 (integerp org-inlinetask-min-level)
7251 (>= (length (match-string 0))
7252 org-inlinetask-min-level))
7253 ;; Find a heading level before the inline task
7254 (while (and (setq level (org-up-heading-safe))
7255 (>= level org-inlinetask-min-level)))
7256 (if (org-at-heading-p)
7257 (org-back-to-heading invisible-ok)
7258 (error "This should not happen")))
7259 (setq empty-line-p (org-previous-line-empty-p))
7260 (match-string 0))
7261 (error "*"))))
7262 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7263 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7264 pos hide-previous previous-pos)
7265 (cond
7266 ((and (org-at-heading-p) (bolp)
7267 (or (bobp)
7268 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7269 ;; insert before the current line
7270 (open-line (if blank 2 1)))
7271 ((and (bolp)
7272 (not org-insert-heading-respect-content)
7273 (or (bobp)
7274 (save-excursion
7275 (backward-char 1) (not (outline-invisible-p)))))
7276 ;; insert right here
7277 nil)
7278 (t
7279 ;; somewhere in the line
7280 (save-excursion
7281 (setq previous-pos (point-at-bol))
7282 (end-of-line)
7283 (setq hide-previous (outline-invisible-p)))
7284 (and org-insert-heading-respect-content (org-show-subtree))
7285 (let ((split
7286 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7287 (save-excursion
7288 (let ((p (point)))
7289 (goto-char (point-at-bol))
7290 (and (looking-at org-complex-heading-regexp)
7291 (match-beginning 4)
7292 (> p (match-beginning 4)))))))
7293 tags pos)
7294 (cond
7295 (org-insert-heading-respect-content
7296 (org-end-of-subtree nil t)
7297 (when (featurep 'org-inlinetask)
7298 (while (and (not (eobp))
7300 (>= (length (match-string 1))
7301 org-inlinetask-min-level))
7302 (org-end-of-subtree nil t)))
7303 (or (bolp) (newline))
7304 (or (org-previous-line-empty-p)
7305 (and blank (newline)))
7306 (open-line 1))
7307 ((org-at-heading-p)
7308 (when hide-previous
7309 (show-children)
7310 (org-show-entry))
7312 (setq tags (and (match-end 2) (match-string 2)))
7313 (and (match-end 1)
7314 (delete-region (match-beginning 1) (match-end 1)))
7315 (setq pos (point-at-bol))
7316 (or split (end-of-line 1))
7317 (delete-horizontal-space)
7319 (buffer-substring (point-at-bol) (point)))
7320 (insert " "))
7321 (newline (if blank 2 1))
7322 (when tags
7323 (save-excursion
7324 (goto-char pos)
7325 (end-of-line 1)
7326 (insert " " tags)
7327 (org-set-tags nil 'align))))
7328 (t
7329 (or split (end-of-line 1))
7330 (newline (if blank 2 1)))))))
7331 (insert head) (just-one-space)
7332 (setq pos (point))
7333 (end-of-line 1)
7334 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7335 (when (and org-insert-heading-respect-content hide-previous)
7336 (save-excursion
7337 (goto-char previous-pos)
7338 (hide-subtree)))
7339 (run-hooks 'org-insert-heading-hook)))))
7341 (defun org-get-heading (&optional no-tags no-todo)
7342 "Return the heading of the current entry, without the stars.
7343 When NO-TAGS is non-nil, don't include tags.
7344 When NO-TODO is non-nil, don't include TODO keywords."
7345 (save-excursion
7346 (org-back-to-heading t)
7347 (cond
7348 ((and no-tags no-todo)
7349 (looking-at org-complex-heading-regexp)
7350 (match-string 4))
7351 (no-tags
7352 (looking-at (concat org-outline-regexp
7355 (match-string 1))
7356 (no-todo
7357 (looking-at org-todo-line-regexp)
7358 (match-string 3))
7359 (t (looking-at org-heading-regexp)
7360 (match-string 2)))))
7362 (defun org-heading-components ()
7363 "Return the components of the current heading.
7364 This is a list with the following elements:
7365 - the level as an integer
7366 - the reduced level, different if `org-odd-levels-only' is set.
7367 - the TODO keyword, or nil
7368 - the priority character, like ?A, or nil if no priority is given
7369 - the headline text itself, or the tags string if no headline text
7370 - the tags string, or nil."
7371 (save-excursion
7372 (org-back-to-heading t)
7373 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7374 (list (length (match-string 1))
7375 (org-reduced-level (length (match-string 1)))
7376 (org-match-string-no-properties 2)
7377 (and (match-end 3) (aref (match-string 3) 2))
7378 (org-match-string-no-properties 4)
7379 (org-match-string-no-properties 5)))))
7381 (defun org-get-entry ()
7382 "Get the entry text, after heading, entire subtree."
7383 (save-excursion
7384 (org-back-to-heading t)
7385 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7387 (defun org-insert-heading-after-current ()
7388 "Insert a new heading with same level as current, after current subtree."
7389 (interactive)
7390 (org-back-to-heading)
7391 (org-insert-heading)
7392 (org-move-subtree-down)
7393 (end-of-line 1))
7395 (defun org-insert-heading-respect-content ()
7396 (interactive)
7397 (let ((org-insert-heading-respect-content t))
7398 (org-insert-heading t)))
7400 (defun org-insert-todo-heading-respect-content (&optional force-state)
7401 (interactive "P")
7402 (let ((org-insert-heading-respect-content t))
7403 (org-insert-todo-heading force-state t)))
7405 (defun org-insert-todo-heading (arg &optional force-heading)
7406 "Insert a new heading with the same level and TODO state as current heading.
7407 If the heading has no TODO state, or if the state is DONE, use the first
7408 state (TODO by default). Also with prefix arg, force first state."
7409 (interactive "P")
7410 (when (or force-heading (not (org-insert-item 'checkbox)))
7411 (org-insert-heading force-heading)
7412 (save-excursion
7413 (org-back-to-heading)
7414 (outline-previous-heading)
7415 (looking-at org-todo-line-regexp))
7416 (let*
7417 ((new-mark-x
7418 (if (or arg
7419 (not (match-beginning 2))
7420 (member (match-string 2) org-done-keywords))
7421 (car org-todo-keywords-1)
7422 (match-string 2)))
7423 (new-mark
7424 (or
7425 (run-hook-with-args-until-success
7426 'org-todo-get-default-hook new-mark-x nil)
7427 new-mark-x)))
7428 (beginning-of-line 1)
7429 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7430 (if org-treat-insert-todo-heading-as-state-change
7431 (org-todo new-mark)
7432 (insert new-mark " "))))
7433 (when org-provide-todo-statistics
7434 (org-update-parent-todo-statistics))))
7436 (defun org-insert-subheading (arg)
7437 "Insert a new subheading and demote it.
7438 Works for outline headings and for plain lists alike."
7439 (interactive "P")
7440 (org-insert-heading arg)
7441 (cond
7442 ((org-at-heading-p) (org-do-demote))
7443 ((org-at-item-p) (org-indent-item))))
7445 (defun org-insert-todo-subheading (arg)
7446 "Insert a new subheading with TODO keyword or checkbox and demote it.
7447 Works for outline headings and for plain lists alike."
7448 (interactive "P")
7449 (org-insert-todo-heading arg)
7450 (cond
7451 ((org-at-heading-p) (org-do-demote))
7452 ((org-at-item-p) (org-indent-item))))
7454 ;;; Promotion and Demotion
7456 (defvar org-after-demote-entry-hook nil
7457 "Hook run after an entry has been demoted.
7458 The cursor will be at the beginning of the entry.
7459 When a subtree is being demoted, the hook will be called for each node.")
7461 (defvar org-after-promote-entry-hook nil
7462 "Hook run after an entry has been promoted.
7463 The cursor will be at the beginning of the entry.
7464 When a subtree is being promoted, the hook will be called for each node.")
7466 (defun org-promote-subtree ()
7467 "Promote the entire subtree.
7468 See also `org-promote'."
7469 (interactive)
7470 (save-excursion
7471 (org-with-limited-levels (org-map-tree 'org-promote)))
7472 (org-fix-position-after-promote))
7474 (defun org-demote-subtree ()
7475 "Demote the entire subtree. See `org-demote'.
7476 See also `org-promote'."
7477 (interactive)
7478 (save-excursion
7479 (org-with-limited-levels (org-map-tree 'org-demote)))
7480 (org-fix-position-after-promote))
7483 (defun org-do-promote ()
7484 "Promote the current heading higher up the tree.
7485 If the region is active in `transient-mark-mode', promote all headings
7486 in the region."
7487 (interactive)
7488 (save-excursion
7489 (if (org-region-active-p)
7490 (org-map-region 'org-promote (region-beginning) (region-end))
7491 (org-promote)))
7492 (org-fix-position-after-promote))
7494 (defun org-do-demote ()
7495 "Demote the current heading lower down the tree.
7496 If the region is active in `transient-mark-mode', demote all headings
7497 in the region."
7498 (interactive)
7499 (save-excursion
7500 (if (org-region-active-p)
7501 (org-map-region 'org-demote (region-beginning) (region-end))
7502 (org-demote)))
7503 (org-fix-position-after-promote))
7505 (defun org-fix-position-after-promote ()
7506 "Make sure that after pro/demotion cursor position is right."
7507 (let ((pos (point)))
7508 (when (save-excursion
7509 (beginning-of-line 1)
7510 (looking-at org-todo-line-regexp)
7511 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7512 (cond ((eobp) (insert " "))
7513 ((eolp) (insert " "))
7514 ((equal (char-after) ?\ ) (forward-char 1))))))
7516 (defun org-current-level ()
7517 "Return the level of the current entry, or nil if before the first headline.
7518 The level is the number of stars at the beginning of the headline."
7519 (save-excursion
7520 (org-with-limited-levels
7521 (if (ignore-errors (org-back-to-heading t))
7522 (funcall outline-level)))))
7524 (defun org-get-previous-line-level ()
7525 "Return the outline depth of the last headline before the current line.
7526 Returns 0 for the first headline in the buffer, and nil if before the
7527 first headline."
7528 (let ((current-level (org-current-level))
7529 (prev-level (when (> (line-number-at-pos) 1)
7530 (save-excursion
7531 (beginning-of-line 0)
7532 (org-current-level)))))
7533 (cond ((null current-level) nil) ; Before first headline
7534 ((null prev-level) 0) ; At first headline
7535 (prev-level))))
7537 (defun org-reduced-level (l)
7538 "Compute the effective level of a heading.
7539 This takes into account the setting of `org-odd-levels-only'."
7540 (cond
7541 ((zerop l) 0)
7542 (org-odd-levels-only (1+ (floor (/ l 2))))
7543 (t l)))
7545 (defun org-level-increment ()
7546 "Return the number of stars that will be added or removed at a
7547 time to headlines when structure editing, based on the value of
7548 `org-odd-levels-only'."
7549 (if org-odd-levels-only 2 1))
7551 (defun org-get-valid-level (level &optional change)
7552 "Rectify a level change under the influence of `org-odd-levels-only'
7553 LEVEL is a current level, CHANGE is by how much the level should be
7554 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7555 even level numbers will become the next higher odd number."
7556 (if org-odd-levels-only
7557 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7558 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7559 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7560 (max 1 (+ level (or change 0)))))
7562 (if (boundp 'define-obsolete-function-alias)
7563 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7564 (define-obsolete-function-alias 'org-get-legal-level
7565 'org-get-valid-level)
7566 (define-obsolete-function-alias 'org-get-legal-level
7567 'org-get-valid-level "23.1")))
7569 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7570 ;; ̀org-with-limited-levels'
7571 (defun org-promote ()
7572 "Promote the current heading higher up the tree.
7573 If the region is active in `transient-mark-mode', promote all headings
7574 in the region."
7575 (org-back-to-heading t)
7576 (let* ((level (save-match-data (funcall outline-level)))
7577 (after-change-functions (remove 'flyspell-after-change-function
7578 after-change-functions))
7579 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7580 (diff (abs (- level (length up-head) -1))))
7581 (cond ((and (= level 1) org-called-with-limited-levels
7582 org-allow-promoting-top-level-subtree)
7583 (replace-match "# " nil t))
7584 ((= level 1)
7585 (error "Cannot promote to level 0. UNDO to recover if necessary"))
7586 (t (replace-match up-head nil t)))
7587 ;; Fixup tag positioning
7588 (unless (= level 1)
7589 (and org-auto-align-tags (org-set-tags nil t))
7590 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7591 (run-hooks 'org-after-promote-entry-hook)))
7593 (defun org-demote ()
7594 "Demote the current heading lower down the tree.
7595 If the region is active in `transient-mark-mode', demote all headings
7596 in the region."
7597 (org-back-to-heading t)
7598 (let* ((level (save-match-data (funcall outline-level)))
7599 (after-change-functions (remove 'flyspell-after-change-function
7600 after-change-functions))
7601 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7602 (diff (abs (- level (length down-head) -1))))
7603 (replace-match down-head nil t)
7604 ;; Fixup tag positioning
7605 (and org-auto-align-tags (org-set-tags nil t))
7606 (if org-adapt-indentation (org-fixup-indentation diff))
7607 (run-hooks 'org-after-demote-entry-hook)))
7609 (defun org-cycle-level ()
7610 "Cycle the level of an empty headline through possible states.
7611 This goes first to child, then to parent, level, then up the hierarchy.
7612 After top level, it switches back to sibling level."
7613 (interactive)
7614 (let ((org-adapt-indentation nil))
7615 (when (org-point-at-end-of-empty-headline)
7616 (setq this-command 'org-cycle-level) ; Only needed for caching
7617 (let ((cur-level (org-current-level))
7618 (prev-level (org-get-previous-line-level)))
7619 (cond
7620 ;; If first headline in file, promote to top-level.
7621 ((= prev-level 0)
7622 (loop repeat (/ (- cur-level 1) (org-level-increment))
7623 do (org-do-promote)))
7624 ;; If same level as prev, demote one.
7625 ((= prev-level cur-level)
7626 (org-do-demote))
7627 ;; If parent is top-level, promote to top level if not already.
7628 ((= prev-level 1)
7629 (loop repeat (/ (- cur-level 1) (org-level-increment))
7630 do (org-do-promote)))
7631 ;; If top-level, return to prev-level.
7632 ((= cur-level 1)
7633 (loop repeat (/ (- prev-level 1) (org-level-increment))
7634 do (org-do-demote)))
7635 ;; If less than prev-level, promote one.
7636 ((< cur-level prev-level)
7637 (org-do-promote))
7638 ;; If deeper than prev-level, promote until higher than
7639 ;; prev-level.
7640 ((> cur-level prev-level)
7641 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7642 do (org-do-promote))))
7643 t))))
7645 (defun org-map-tree (fun)
7646 "Call FUN for every heading underneath the current one."
7647 (org-back-to-heading)
7648 (let ((level (funcall outline-level)))
7649 (save-excursion
7650 (funcall fun)
7651 (while (and (progn
7652 (outline-next-heading)
7653 (> (funcall outline-level) level))
7654 (not (eobp)))
7655 (funcall fun)))))
7657 (defun org-map-region (fun beg end)
7658 "Call FUN for every heading between BEG and END."
7659 (let ((org-ignore-region t))
7660 (save-excursion
7661 (setq end (copy-marker end))
7662 (goto-char beg)
7663 (if (and (re-search-forward org-outline-regexp-bol nil t)
7664 (< (point) end))
7665 (funcall fun))
7666 (while (and (progn
7667 (outline-next-heading)
7668 (< (point) end))
7669 (not (eobp)))
7670 (funcall fun)))))
7672 (defvar org-property-end-re) ; silence byte-compiler
7673 (defun org-fixup-indentation (diff)
7674 "Change the indentation in the current entry by DIFF.
7675 However, if any line in the current entry has no indentation, or if it
7676 would end up with no indentation after the change, nothing at all is done."
7677 (save-excursion
7678 (let ((end (save-excursion (outline-next-heading)
7679 (point-marker)))
7680 (prohibit (if (> diff 0)
7683 col)
7684 (unless (save-excursion (end-of-line 1)
7685 (re-search-forward prohibit end t))
7686 (while (and (< (point) end)
7688 (goto-char (match-end 0))
7689 (setq col (current-column))
7690 (if (< diff 0) (replace-match ""))
7691 (org-indent-to-column (+ diff col))))
7692 (move-marker end nil))))
7694 (defun org-convert-to-odd-levels ()
7695 "Convert an org-mode file with all levels allowed to one with odd levels.
7696 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7697 level 5 etc."
7698 (interactive)
7699 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7700 (let ((outline-level 'org-outline-level)
7701 (org-odd-levels-only nil) n)
7702 (save-excursion
7703 (goto-char (point-min))
7705 (setq n (- (length (match-string 0)) 2))
7706 (while (>= (setq n (1- n)) 0)
7707 (org-demote))
7708 (end-of-line 1))))))
7710 (defun org-convert-to-oddeven-levels ()
7711 "Convert an org-mode file with only odd levels to one with odd/even levels.
7712 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7713 file contains a section with an even level, conversion would
7714 destroy the structure of the file. An error is signaled in this
7715 case."
7716 (interactive)
7717 (goto-char (point-min))
7718 ;; First check if there are no even levels
7720 (org-show-context t)
7721 (error "Not all levels are odd in this file. Conversion not possible"))
7722 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7723 (let ((outline-regexp org-outline-regexp)
7724 (outline-level 'org-outline-level)
7725 (org-odd-levels-only nil) n)
7726 (save-excursion
7727 (goto-char (point-min))
7729 (setq n (/ (1- (length (match-string 0))) 2))
7730 (while (>= (setq n (1- n)) 0)
7731 (org-promote))
7732 (end-of-line 1))))))
7734 (defun org-tr-level (n)
7735 "Make N odd if required."
7736 (if org-odd-levels-only (1+ (/ n 2)) n))
7738 ;;; Vertical tree motion, cutting and pasting of subtrees
7740 (defun org-move-subtree-up (&optional arg)
7741 "Move the current subtree up past ARG headlines of the same level."
7742 (interactive "p")
7743 (org-move-subtree-down (- (prefix-numeric-value arg))))
7745 (defun org-move-subtree-down (&optional arg)
7746 "Move the current subtree down past ARG headlines of the same level."
7747 (interactive "p")
7748 (setq arg (prefix-numeric-value arg))
7749 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7750 'org-get-last-sibling))
7751 (ins-point (make-marker))
7752 (cnt (abs arg))
7753 (col (current-column))
7754 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7755 ;; Select the tree
7756 (org-back-to-heading)
7757 (setq beg0 (point))
7758 (save-excursion
7759 (setq ne-beg (org-back-over-empty-lines))
7760 (setq beg (point)))
7761 (save-match-data
7762 (save-excursion (outline-end-of-heading)
7763 (setq folded (outline-invisible-p)))
7764 (outline-end-of-subtree))
7765 (outline-next-heading)
7766 (setq ne-end (org-back-over-empty-lines))
7767 (setq end (point))
7768 (goto-char beg0)
7769 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7770 ;; include less whitespace
7771 (save-excursion
7772 (goto-char beg)
7773 (forward-line (- ne-beg ne-end))
7774 (setq beg (point))))
7775 ;; Find insertion point, with error handling
7776 (while (> cnt 0)
7777 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7778 (progn (goto-char beg0)
7779 (error "Cannot move past superior level or buffer limit")))
7780 (setq cnt (1- cnt)))
7781 (if (> arg 0)
7782 ;; Moving forward - still need to move over subtree
7783 (progn (org-end-of-subtree t t)
7784 (save-excursion
7785 (org-back-over-empty-lines)
7786 (or (bolp) (newline)))))
7787 (setq ne-ins (org-back-over-empty-lines))
7788 (move-marker ins-point (point))
7789 (setq txt (buffer-substring beg end))
7790 (org-save-markers-in-region beg end)
7791 (delete-region beg end)
7792 (org-remove-empty-overlays-at beg)
7793 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7794 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7796 (let ((bbb (point)))
7797 (insert-before-markers txt)
7798 (org-reinstall-markers-in-region bbb)
7799 (move-marker ins-point bbb))
7801 (setq ins-end (point))
7802 (goto-char ins-point)
7803 (org-skip-whitespace)
7804 (when (and (< arg 0)
7805 (org-first-sibling-p)
7806 (> ne-ins ne-beg))
7807 ;; Move whitespace back to beginning
7808 (save-excursion
7809 (goto-char ins-end)
7810 (let ((kill-whole-line t))
7811 (kill-line (- ne-ins ne-beg)) (point)))
7813 (move-marker ins-point nil)
7814 (if folded
7815 (hide-subtree)
7816 (org-show-entry)
7817 (show-children)
7818 (org-cycle-hide-drawers 'children))
7819 (org-clean-visibility-after-subtree-move)
7820 ;; move back to the initial column we were at
7821 (move-to-column col)))
7823 (defvar org-subtree-clip ""
7824 "Clipboard for cut and paste of subtrees.
7825 This is actually only a copy of the kill, because we use the normal kill
7826 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7828 (defvar org-subtree-clip-folded nil
7829 "Was the last copied subtree folded?
7830 This is used to fold the tree back after pasting.")
7832 (defun org-cut-subtree (&optional n)
7833 "Cut the current subtree into the clipboard.
7834 With prefix arg N, cut this many sequential subtrees.
7835 This is a short-hand for marking the subtree and then cutting it."
7836 (interactive "p")
7837 (org-copy-subtree n 'cut))
7839 (defun org-copy-subtree (&optional n cut force-store-markers)
7840 "Cut the current subtree into the clipboard.
7841 With prefix arg N, cut this many sequential subtrees.
7842 This is a short-hand for marking the subtree and then copying it.
7843 If CUT is non-nil, actually cut the subtree.
7844 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7845 of some markers in the region, even if CUT is non-nil. This is
7846 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7847 (interactive "p")
7848 (let (beg end folded (beg0 (point)))
7849 (if (org-called-interactively-p 'any)
7850 (org-back-to-heading nil) ; take what looks like a subtree
7851 (org-back-to-heading t)) ; take what is really there
7852 (org-back-over-empty-lines)
7853 (setq beg (point))
7855 (save-match-data
7856 (save-excursion (outline-end-of-heading)
7857 (setq folded (outline-invisible-p)))
7858 (condition-case nil
7859 (org-forward-heading-same-level (1- n) t)
7860 (error nil))
7861 (org-end-of-subtree t t))
7862 (org-back-over-empty-lines)
7863 (setq end (point))
7864 (goto-char beg0)
7865 (when (> end beg)
7866 (setq org-subtree-clip-folded folded)
7867 (when (or cut force-store-markers)
7868 (org-save-markers-in-region beg end))
7869 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7870 (setq org-subtree-clip (current-kill 0))
7871 (message "%s: Subtree(s) with %d characters"
7872 (if cut "Cut" "Copied")
7873 (length org-subtree-clip)))))
7875 (defun org-paste-subtree (&optional level tree for-yank)
7876 "Paste the clipboard as a subtree, with modification of headline level.
7877 The entire subtree is promoted or demoted in order to match a new headline
7878 level.
7880 If the cursor is at the beginning of a headline, the same level as
7881 that headline is used to paste the tree
7883 If not, the new level is derived from the *visible* headings
7884 before and after the insertion point, and taken to be the inferior headline
7885 level of the two. So if the previous visible heading is level 3 and the
7886 next is level 4 (or vice versa), level 4 will be used for insertion.
7887 This makes sure that the subtree remains an independent subtree and does
7888 not swallow low level entries.
7890 You can also force a different level, either by using a numeric prefix
7891 argument, or by inserting the heading marker by hand. For example, if the
7894 If optional TREE is given, use this text instead of the kill ring.
7896 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7897 move back over whitespace before inserting, and move point to the end of
7898 the inserted text when done."
7899 (interactive "P")
7900 (setq tree (or tree (and kill-ring (current-kill 0))))
7901 (unless (org-kill-is-subtree-p tree)
7902 (error "%s"
7903 (substitute-command-keys
7905 (org-with-limited-levels
7906 (let* ((visp (not (outline-invisible-p)))
7907 (txt tree)
7909 (old-level (if (string-match org-outline-regexp-bol txt)
7910 (- (match-end 0) (match-beginning 0) 1)
7911 -1))
7912 (force-level (cond (level (prefix-numeric-value level))
7914 (string-match
7916 (point-at-bol) (point))))
7917 (- (match-end 1) (match-beginning 1)))
7918 ((and (bolp)
7919 (looking-at org-outline-regexp))
7920 (- (match-end 0) (point) 1))))
7921 (previous-level (save-excursion
7922 (condition-case nil
7923 (progn
7924 (outline-previous-visible-heading 1)
7925 (if (looking-at ^re_)
7926 (- (match-end 0) (match-beginning 0) 1)
7927 1))
7928 (error 1))))
7929 (next-level (save-excursion
7930 (condition-case nil
7931 (progn
7932 (or (looking-at org-outline-regexp)
7933 (outline-next-visible-heading 1))
7934 (if (looking-at ^re_)
7935 (- (match-end 0) (match-beginning 0) 1)
7936 1))
7937 (error 1))))
7938 (new-level (or force-level (max previous-level next-level)))
7939 (shift (if (or (= old-level -1)
7940 (= new-level -1)
7941 (= old-level new-level))
7942 0
7943 (- new-level old-level)))
7944 (delta (if (> shift 0) -1 1))
7945 (func (if (> shift 0) 'org-demote 'org-promote))
7946 (org-odd-levels-only nil)
7947 beg end newend)
7948 ;; Remove the forced level indicator
7949 (if force-level
7950 (delete-region (point-at-bol) (point)))
7951 ;; Paste
7952 (beginning-of-line (if (bolp) 1 2))
7953 (unless for-yank (org-back-over-empty-lines))
7954 (setq beg (point))
7955 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7956 (insert-before-markers txt)
7958 (setq newend (point))
7959 (org-reinstall-markers-in-region beg)
7960 (setq end (point))
7961 (goto-char beg)
7963 (setq beg (point))
7964 (if (and (outline-invisible-p) visp)
7965 (save-excursion (outline-show-heading)))
7966 ;; Shift if necessary
7967 (unless (= shift 0)
7968 (save-restriction
7969 (narrow-to-region beg end)
7970 (while (not (= shift 0))
7971 (org-map-region func (point-min) (point-max))
7972 (setq shift (+ delta shift)))
7973 (goto-char (point-min))
7974 (setq newend (point-max))))
7975 (when (or (org-called-interactively-p 'interactive) for-yank)
7976 (message "Clipboard pasted as level %d subtree" new-level))
7977 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7978 kill-ring
7979 (eq org-subtree-clip (current-kill 0))
7980 org-subtree-clip-folded)
7981 ;; The tree was folded before it was killed/copied
7982 (hide-subtree))
7983 (and for-yank (goto-char newend)))))
7985 (defun org-kill-is-subtree-p (&optional txt)
7986 "Check if the current kill is an outline subtree, or a set of trees.
7987 Returns nil if kill does not start with a headline, or if the first
7988 headline level is not the largest headline level in the tree.
7989 So this will actually accept several entries of equal levels as well,
7990 which is OK for `org-paste-subtree'.
7991 If optional TXT is given, check this string instead of the current kill."
7992 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7993 (re (org-get-limited-outline-regexp))
7994 (^re (concat "^" re))
7995 (start-level (and kill
7996 (string-match
7998 kill)
7999 (- (match-end 2) (match-beginning 2) 1)))
8000 (start (1+ (or (match-beginning 2) -1))))
8001 (if (not start-level)
8002 (progn
8003 nil) ;; does not even start with a heading
8004 (catch 'exit
8005 (while (setq start (string-match ^re kill (1+ start)))
8006 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8007 (throw 'exit nil)))
8008 t))))
8010 (defvar org-markers-to-move nil
8011 "Markers that should be moved with a cut-and-paste operation.
8012 Those markers are stored together with their positions relative to
8013 the start of the region.")
8015 (defun org-save-markers-in-region (beg end)
8016 "Check markers in region.
8017 If these markers are between BEG and END, record their position relative
8018 to BEG, so that after moving the block of text, we can put the markers back
8019 into place.
8020 This function gets called just before an entry or tree gets cut from the
8021 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8022 called immediately, to move the markers with the entries."
8023 (setq org-markers-to-move nil)
8024 (when (featurep 'org-clock)
8025 (org-clock-save-markers-for-cut-and-paste beg end))
8026 (when (featurep 'org-agenda)
8027 (org-agenda-save-markers-for-cut-and-paste beg end)))
8029 (defun org-check-and-save-marker (marker beg end)
8030 "Check if MARKER is between BEG and END.
8031 If yes, remember the marker and the distance to BEG."
8032 (when (and (marker-buffer marker)
8033 (equal (marker-buffer marker) (current-buffer)))
8034 (if (and (>= marker beg) (< marker end))
8035 (push (cons marker (- marker beg)) org-markers-to-move))))
8037 (defun org-reinstall-markers-in-region (beg)
8038 "Move all remembered markers to their position relative to BEG."
8039 (mapc (lambda (x)
8040 (move-marker (car x) (+ beg (cdr x))))
8041 org-markers-to-move)
8042 (setq org-markers-to-move nil))
8044 (defun org-narrow-to-subtree ()
8045 "Narrow buffer to the current subtree."
8046 (interactive)
8047 (save-excursion
8048 (save-match-data
8049 (org-with-limited-levels
8050 (narrow-to-region
8051 (progn (org-back-to-heading t) (point))
8052 (progn (org-end-of-subtree t t)
8053 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8054 (point)))))))
8056 (defun org-narrow-to-block ()
8057 "Narrow buffer to the current block."
8058 (interactive)
8059 (let* ((case-fold-search t)
8062 (if blockp
8063 (narrow-to-region (car blockp) (cdr blockp))
8064 (error "Not in a block"))))
8066 (eval-when-compile
8067 (defvar org-property-drawer-re))
8069 (defvar org-property-start-re) ;; defined below
8070 (defun org-clone-subtree-with-time-shift (n &optional shift)
8071 "Clone the task (subtree) at point N times.
8072 The clones will be inserted as siblings.
8074 In interactive use, the user will be prompted for the number of
8075 clones to be produced, and for a time SHIFT, which may be a
8076 repeater as used in time stamps, for example `+3d'.
8078 When a valid repeater is given and the entry contains any time
8079 stamps, the clones will become a sequence in time, with time
8080 stamps in the subtree shifted for each clone produced. If SHIFT
8081 is nil or the empty string, time stamps will be left alone. The
8082 ID property of the original subtree is removed.
8084 If the original subtree did contain time stamps with a repeater,
8085 the following will happen:
8086 - the repeater will be removed in each clone
8087 - an additional clone will be produced, with the current, unshifted
8088 date(s) in the entry.
8089 - the original entry will be placed *after* all the clones, with
8090 repeater intact.
8091 - the start days in the repeater in the original entry will be shifted
8092 to past the last clone.
8093 In this way you can spell out a number of instances of a repeating task,
8094 and still retain the repeater to cover future instances of the task."
8095 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
8096 (let (beg end template task idprop
8097 shift-n shift-what doshift nmin nmax (n-no-remove -1)
8098 (drawer-re org-drawer-regexp))
8099 (if (not (and (integerp n) (> n 0)))
8100 (error "Invalid number of replications %s" n))
8103 shift)))
8104 (error "Invalid shift specification %s" shift))
8105 (when doshift
8106 (setq shift-n (string-to-number (match-string 1 shift))
8107 shift-what (cdr (assoc (match-string 2 shift)
8108 '(("d" . day) ("w" . week)
8109 ("m" . month) ("y" . year))))))
8110 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8111 (setq nmin 1 nmax n)
8112 (org-back-to-heading t)
8113 (setq beg (point))
8114 (setq idprop (org-entry-get nil "ID"))
8115 (org-end-of-subtree t t)
8117 (setq end (point))
8118 (setq template (buffer-substring beg end))
8119 (when (and doshift
8121 (delete-region beg end)
8122 (setq end beg)
8123 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8124 (goto-char end)
8125 (loop for n from nmin to nmax do
8126 ;; prepare clone
8127 (with-temp-buffer
8128 (insert template)
8129 (org-mode)
8130 (goto-char (point-min))
8131 (org-show-subtree)
8132 (and idprop (if org-clone-delete-id
8133 (org-entry-delete nil "ID")
8134 (org-id-get-create t)))
8135 (unless (= n 0)
8137 (kill-whole-line))
8138 (goto-char (point-min))
8139 (while (re-search-forward drawer-re nil t)
8140 (mapc (lambda (d)
8141 (org-remove-empty-drawer-at d (point))) org-drawers)))
8142 (goto-char (point-min))
8143 (when doshift
8144 (while (re-search-forward org-ts-regexp-both nil t)
8145 (org-timestamp-change (* n shift-n) shift-what))
8146 (unless (= n n-no-remove)
8147 (goto-char (point-min))
8148 (while (re-search-forward org-ts-regexp nil t)
8149 (save-excursion
8150 (goto-char (match-beginning 0))
8152 (delete-region (match-beginning 1) (match-end 1)))))))
8153 (setq task (buffer-string)))
8154 (insert task))
8155 (goto-char beg)))
8157 ;;; Outline Sorting
8159 (defun org-sort (with-case)
8160 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8161 Optional argument WITH-CASE means sort case-sensitively."
8162 (interactive "P")
8163 (cond
8164 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8165 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8166 (t
8167 (org-call-with-arg 'org-sort-entries with-case))))
8169 (defun org-sort-remove-invisible (s)
8170 (remove-text-properties 0 (length s) org-rm-props s)
8171 (while (string-match org-bracket-link-regexp s)
8172 (setq s (replace-match (if (match-end 2)
8173 (match-string 3 s)
8174 (match-string 1 s)) t t s)))
8175 s)
8177 (defvar org-priority-regexp) ; defined later in the file
8179 (defvar org-after-sorting-entries-or-items-hook nil
8180 "Hook that is run after a bunch of entries or items have been sorted.
8181 When children are sorted, the cursor is in the parent line when this
8182 hook gets called. When a region or a plain list is sorted, the cursor
8183 will be in the first entry of the sorted region/list.")
8185 (defun org-sort-entries
8186 (&optional with-case sorting-type getkey-func compare-func property)
8187 "Sort entries on a certain level of an outline tree.
8188 If there is an active region, the entries in the region are sorted.
8189 Else, if the cursor is before the first entry, sort the top-level items.
8190 Else, the children of the entry at point are sorted.
8192 Sorting can be alphabetically, numerically, by date/time as given by
8193 a time stamp, by a property or by priority.
8195 The command prompts for the sorting type unless it has been given to the
8196 function through the SORTING-TYPE argument, which needs to be a character,
8197 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8198 precise meaning of each character:
8200 n Numerically, by converting the beginning of the entry/item to a number.
8201 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8202 t By date/time, either the first active time stamp in the entry, or, if
8203 none exist, by the first inactive one.
8204 s By the scheduled date/time.
8205 d By deadline date/time.
8206 c By creation time, which is assumed to be the first inactive time stamp
8207 at the beginning of a line.
8208 p By priority according to the cookie.
8209 r By the value of a property.
8211 Capital letters will reverse the sort order.
8213 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8214 called with point at the beginning of the record. It must return either
8215 a string or a number that should serve as the sorting key for that record.
8217 Comparing entries ignores case by default. However, with an optional argument
8218 WITH-CASE, the sorting considers case as well."
8219 (interactive "P")
8220 (let ((case-func (if with-case 'identity 'downcase))
8221 start beg end stars re re2
8222 txt what tmp)
8223 ;; Find beginning and end of region to sort
8224 (cond
8225 ((org-region-active-p)
8226 ;; we will sort the region
8227 (setq end (region-end)
8228 what "region")
8229 (goto-char (region-beginning))
8230 (if (not (org-at-heading-p)) (outline-next-heading))
8231 (setq start (point)))
8232 ((or (org-at-heading-p)
8233 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8234 ;; we will sort the children of the current headline
8235 (org-back-to-heading)
8236 (setq start (point)
8237 end (progn (org-end-of-subtree t t)
8239 (org-back-over-empty-lines)
8240 (point))
8241 what "children")
8242 (goto-char start)
8243 (show-subtree)
8244 (outline-next-heading))
8245 (t
8246 ;; we will sort the top-level entries in this file
8247 (goto-char (point-min))
8248 (or (org-at-heading-p) (outline-next-heading))
8249 (setq start (point))
8250 (goto-char (point-max))
8251 (beginning-of-line 1)
8253 ;; File ends in a non-white line
8254 (end-of-line 1)
8256 (setq end (point-max))
8257 (setq what "top-level")
8258 (goto-char start)
8259 (show-all)))
8261 (setq beg (point))
8262 (if (>= beg end) (error "Nothing to sort"))
8265 (setq stars (match-string 1)
8266 re (concat "^" (regexp-quote stars) " +")
8268 txt (buffer-substring beg end))
8270 (if (and (not (equal stars "*")) (string-match re2 txt))
8271 (error "Region to sort contains a level above the first entry"))
8273 (unless sorting-type
8274 (message
8275 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8277 A/N/T/S/D/C/P/O/F means reversed:"
8278 what)
8279 (setq sorting-type (read-char-exclusive))
8281 (and (= (downcase sorting-type) ?f)
8282 (setq getkey-func
8283 (org-icompleting-read "Sort using function: "
8284 obarray 'fboundp t nil nil))
8285 (setq getkey-func (intern getkey-func)))
8287 (and (= (downcase sorting-type) ?r)
8288 (setq property
8289 (org-icompleting-read "Property: "
8290 (mapcar 'list (org-buffer-property-keys t))
8291 nil t))))
8293 (message "Sorting entries...")
8295 (save-restriction
8296 (narrow-to-region start end)
8297 (let ((dcst (downcase sorting-type))
8298 (case-fold-search nil)
8299 (now (current-time)))
8300 (sort-subr
8301 (/= dcst sorting-type)
8302 ;; This function moves to the beginning character of the "record" to
8303 ;; be sorted.
8304 (lambda nil
8305 (if (re-search-forward re nil t)
8306 (goto-char (match-beginning 0))
8307 (goto-char (point-max))))
8308 ;; This function moves to the last character of the "record" being
8309 ;; sorted.
8310 (lambda nil
8311 (save-match-data
8312 (condition-case nil
8313 (outline-forward-same-level 1)
8314 (error
8315 (goto-char (point-max))))))
8316 ;; This function returns the value that gets sorted against.
8317 (lambda nil
8318 (cond
8319 ((= dcst ?n)
8320 (if (looking-at org-complex-heading-regexp)
8321 (string-to-number (match-string 4))
8322 nil))
8323 ((= dcst ?a)
8324 (if (looking-at org-complex-heading-regexp)
8325 (funcall case-func (match-string 4))
8326 nil))
8327 ((= dcst ?t)
8328 (let ((end (save-excursion (outline-next-heading) (point))))
8329 (if (or (re-search-forward org-ts-regexp end t)
8330 (re-search-forward org-ts-regexp-both end t))
8331 (org-time-string-to-seconds (match-string 0))
8332 (org-float-time now))))
8333 ((= dcst ?c)
8334 (let ((end (save-excursion (outline-next-heading) (point))))
8335 (if (re-search-forward
8337 end t)
8338 (org-time-string-to-seconds (match-string 0))
8339 (org-float-time now))))
8340 ((= dcst ?s)
8341 (let ((end (save-excursion (outline-next-heading) (point))))
8342 (if (re-search-forward org-scheduled-time-regexp end t)
8343 (org-time-string-to-seconds (match-string 1))
8344 (org-float-time now))))
8345 ((= dcst ?d)
8346 (let ((end (save-excursion (outline-next-heading) (point))))
8347 (if (re-search-forward org-deadline-time-regexp end t)
8348 (org-time-string-to-seconds (match-string 1))
8349 (org-float-time now))))
8350 ((= dcst ?p)
8351 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8352 (string-to-char (match-string 2))
8353 org-default-priority))
8354 ((= dcst ?r)
8355 (or (org-entry-get nil property) ""))
8356 ((= dcst ?o)
8357 (if (looking-at org-complex-heading-regexp)
8358 (- 9999 (length (member (match-string 2)
8359 org-todo-keywords-1)))))
8360 ((= dcst ?f)
8361 (if getkey-func
8362 (progn
8363 (setq tmp (funcall getkey-func))
8364 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8365 tmp)
8366 (error "Invalid key function `%s'" getkey-func)))
8367 (t (error "Invalid sorting type `%c'" sorting-type))))
8368 nil
8369 (cond
8370 ((= dcst ?a) 'string<)
8371 ((= dcst ?f) compare-func)
8372 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8373 (run-hooks 'org-after-sorting-entries-or-items-hook)
8374 (message "Sorting entries...done")))
8376 (defun org-do-sort (table what &optional with-case sorting-type)
8377 "Sort TABLE of WHAT according to SORTING-TYPE.
8378 The user will be prompted for the SORTING-TYPE if the call to this
8379 function does not specify it. WHAT is only for the prompt, to indicate
8380 what is being sorted. The sorting key will be extracted from
8381 the car of the elements of the table.
8382 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8383 (unless sorting-type
8384 (message
8385 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8386 what)
8387 (setq sorting-type (read-char-exclusive)))
8388 (let ((dcst (downcase sorting-type))
8389 extractfun comparefun)
8390 ;; Define the appropriate functions
8391 (cond
8392 ((= dcst ?n)
8393 (setq extractfun 'string-to-number
8394 comparefun (if (= dcst sorting-type) '< '>)))
8395 ((= dcst ?a)
8396 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8397 (lambda(x) (downcase (org-sort-remove-invisible x))))
8398 comparefun (if (= dcst sorting-type)
8399 'string<
8400 (lambda (a b) (and (not (string< a b))
8401 (not (string= a b)))))))
8402 ((= dcst ?t)
8403 (setq extractfun
8404 (lambda (x)
8405 (if (or (string-match org-ts-regexp x)
8406 (string-match org-ts-regexp-both x))
8407 (org-float-time
8408 (org-time-string-to-time (match-string 0 x)))
8409 0))
8410 comparefun (if (= dcst sorting-type) '< '>)))
8411 (t (error "Invalid sorting type `%c'" sorting-type)))
8413 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8414 table)
8415 (lambda (a b) (funcall comparefun (car a) (car b))))))
8418 ;;; The orgstruct minor mode
8420 ;; Define a minor mode which can be used in other modes in order to
8421 ;; integrate the org-mode structure editing commands.
8423 ;; This is really a hack, because the org-mode structure commands use
8424 ;; keys which normally belong to the major mode. Here is how it
8425 ;; works: The minor mode defines all the keys necessary to operate the
8426 ;; structure commands, but wraps the commands into a function which
8427 ;; tests if the cursor is currently at a headline or a plain list
8428 ;; item. If that is the case, the structure command is used,
8429 ;; temporarily setting many Org-mode variables like regular
8430 ;; expressions for filling etc. However, when any of those keys is
8431 ;; used at a different location, function uses `key-binding' to look
8432 ;; up if the key has an associated command in another currently active
8433 ;; keymap (minor modes, major mode, global), and executes that
8434 ;; command. There might be problems if any of the keys is otherwise
8435 ;; used as a prefix key.
8437 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8438 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8439 ;; addresses this by checking explicitly for both bindings.
8441 (defvar orgstruct-mode-map (make-sparse-keymap)
8442 "Keymap for the minor `orgstruct-mode'.")
8444 (defvar org-local-vars nil
8445 "List of local variables, for use by `orgstruct-mode'.")
8447 ;;;###autoload
8448 (define-minor-mode orgstruct-mode
8449 "Toggle the minor mode `orgstruct-mode'.
8450 This mode is for using Org-mode structure commands in other
8451 modes. The following keys behave as if Org-mode were active, if
8452 the cursor is on a headline, or on a plain list item (both as
8453 defined by Org-mode).
8455 M-up Move entry/item up
8456 M-down Move entry/item down
8457 M-left Promote
8458 M-right Demote
8459 M-S-up Move entry/item up
8460 M-S-down Move entry/item down
8461 M-S-left Promote subtree
8462 M-S-right Demote subtree
8463 M-q Fill paragraph and items like in Org-mode
8464 C-c ^ Sort entries
8465 C-c - Cycle list bullet
8466 TAB Cycle item visibility
8467 M-RET Insert new heading/item
8468 S-M-RET Insert new TODO heading / Checkbox item
8469 C-c C-c Set tags / toggle checkbox"
8470 nil " OrgStruct" nil
8471 (org-load-modules-maybe)
8472 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8474 ;;;###autoload
8475 (defun turn-on-orgstruct ()
8476 "Unconditionally turn on `orgstruct-mode'."
8477 (orgstruct-mode 1))
8479 (defvar org-fb-vars nil)
8480 (make-variable-buffer-local 'org-fb-vars)
8481 (defun orgstruct++-mode (&optional arg)
8482 "Toggle `orgstruct-mode', the enhanced version of it.
8483 In addition to setting orgstruct-mode, this also exports all
8484 indentation and autofilling variables from org-mode into the
8485 buffer. It will also recognize item context in multiline items."
8486 (interactive "P")
8487 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8488 (if (< arg 1)
8489 (progn (orgstruct-mode -1)
8490 (mapc (lambda(v)
8491 (org-set-local (car v)
8492 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8493 org-fb-vars))
8494 (orgstruct-mode 1)
8495 (setq org-fb-vars nil)
8496 (let (var val)
8497 (mapc
8498 (lambda (x)
8499 (when (string-match
8501 (symbol-name (car x)))
8502 (setq var (car x) val (nth 1 x))
8503 (push (list var `(quote ,(eval var))) org-fb-vars)
8504 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8505 org-local-vars)
8506 (org-set-local 'orgstruct-is-++ t))))
8508 (defvar orgstruct-is-++ nil
8509 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8510 (make-variable-buffer-local 'orgstruct-is-++)
8512 ;;;###autoload
8513 (defun turn-on-orgstruct++ ()
8514 "Unconditionally turn on `orgstruct++-mode'."
8515 (orgstruct++-mode 1))
8517 (defun orgstruct-error ()
8518 "Error when there is no default binding for a structure key."
8519 (interactive)
8520 (error "This key has no function outside structure elements"))
8522 (defun orgstruct-setup ()
8523 "Setup orgstruct keymaps."
8524 (let ((nfunc 0)
8525 (bindings
8526 (list
8527 '([(meta up)] org-metaup)
8528 '([(meta down)] org-metadown)
8529 '([(meta left)] org-metaleft)
8530 '([(meta right)] org-metaright)
8531 '([(meta shift up)] org-shiftmetaup)
8532 '([(meta shift down)] org-shiftmetadown)
8533 '([(meta shift left)] org-shiftmetaleft)
8534 '([(meta shift right)] org-shiftmetaright)
8535 '([?\e (up)] org-metaup)
8536 '([?\e (down)] org-metadown)
8537 '([?\e (left)] org-metaleft)
8538 '([?\e (right)] org-metaright)
8539 '([?\e (shift up)] org-shiftmetaup)
8540 '([?\e (shift down)] org-shiftmetadown)
8541 '([?\e (shift left)] org-shiftmetaleft)
8542 '([?\e (shift right)] org-shiftmetaright)
8543 '([(shift up)] org-shiftup)
8544 '([(shift down)] org-shiftdown)
8545 '([(shift left)] org-shiftleft)
8546 '([(shift right)] org-shiftright)
8547 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8548 '("\M-q" fill-paragraph)
8549 '("\C-c^" org-sort)
8550 '("\C-c-" org-cycle-list-bullet)))
8551 elt key fun cmd)
8552 (while (setq elt (pop bindings))
8553 (setq nfunc (1+ nfunc))
8554 (setq key (org-key (car elt))
8555 fun (nth 1 elt)
8556 cmd (orgstruct-make-binding fun nfunc key))
8557 (org-defkey orgstruct-mode-map key cmd))
8559 ;; Prevent an error for users who forgot to make autoloads
8560 (require 'org-element)
8562 ;; Special treatment needed for TAB and RET
8563 (org-defkey orgstruct-mode-map [(tab)]
8564 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8565 (org-defkey orgstruct-mode-map "\C-i"
8566 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8568 (org-defkey orgstruct-mode-map "\M-\C-m"
8569 (orgstruct-make-binding 'org-insert-heading 105
8570 "\M-\C-m" [(meta return)]))
8571 (org-defkey orgstruct-mode-map [(meta return)]
8572 (orgstruct-make-binding 'org-insert-heading 106
8573 [(meta return)] "\M-\C-m"))
8575 (org-defkey orgstruct-mode-map [(shift meta return)]
8576 (orgstruct-make-binding 'org-insert-todo-heading 107
8577 [(meta return)] "\M-\C-m"))
8579 (org-defkey orgstruct-mode-map "\e\C-m"
8580 (orgstruct-make-binding 'org-insert-heading 108
8581 "\e\C-m" [?\e (return)]))
8582 (org-defkey orgstruct-mode-map [?\e (return)]
8583 (orgstruct-make-binding 'org-insert-heading 109
8584 [?\e (return)] "\e\C-m"))
8585 (org-defkey orgstruct-mode-map [?\e (shift return)]
8586 (orgstruct-make-binding 'org-insert-todo-heading 110
8587 [?\e (return)] "\e\C-m"))
8589 (unless org-local-vars
8590 (setq org-local-vars (org-get-local-variables)))
8592 t))
8594 (defun orgstruct-make-binding (fun n &rest keys)
8595 "Create a function for binding in the structure minor mode.
8596 FUN is the command to call inside a table. N is used to create a unique
8597 command name. KEYS are keys that should be checked in for a command
8598 to execute outside of tables."
8599 (eval
8600 (list 'defun
8601 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8602 '(arg)
8604 "Outside of structure, run the binding of `"
8605 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8606 "'.")
8607 '(interactive "p")
8608 (list 'if
8609 `(org-context-p 'headline 'item
8610 (and orgstruct-is-++
8611 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8612 'item-body))
8613 (list 'org-run-like-in-org-mode (list 'quote fun))
8614 (list 'let '(orgstruct-mode)
8615 (list 'call-interactively
8616 (append '(or)
8617 (mapcar (lambda (k)
8618 (list 'key-binding k))
8619 keys)
8620 '('orgstruct-error))))))))
8622 (defun org-contextualize-keys (alist contexts)
8623 "Return valid elements in ALIST depending on CONTEXTS.
8625 `org-agenda-custom-commands' or `org-capture-templates' are the
8626 values used for ALIST, and `org-agenda-custom-commands-contexts'
8627 or `org-capture-templates-contexts' are the associated contexts
8628 definitions."
8629 (let ((contexts
8630 ;; normalize contexts
8631 (mapcar
8632 (lambda(c) (cond ((listp (cadr c))
8633 (list (car c) (car c) (cadr c)))
8634 ((string= "" (cadr c))
8635 (list (car c) (car c) (caddr c)))
8636 (t c))) contexts))
8637 (a alist) c r s)
8638 ;; loop over all commands or templates
8639 (while (setq c (pop a))
8640 (let (vrules repl)
8641 (cond
8642 ((not (assoc (car c) contexts))
8643 (push c r))
8644 ((and (assoc (car c) contexts)
8645 (setq vrules (org-contextualize-validate-key
8646 (car c) contexts)))
8647 (mapc (lambda (vr)
8648 (when (not (equal (car vr) (cadr vr)))
8649 (setq repl vr))) vrules)
8650 (if (not repl) (push c r)
8651 (push (cadr repl) s)
8652 (push
8653 (cons (car c)
8654 (cdr (or (assoc (cadr repl) alist)
8655 (error "Undefined key `%s' as contextual replacement for `%s'"
8656 (cadr repl) (car c)))))
8657 r))))))
8658 ;; Return limited ALIST, possibly with keys modified, and deduplicated
8659 (delq
8660 nil
8661 (delete-dups
8662 (mapcar (lambda (x)
8663 (let ((tpl (car x)))
8664 (when (not (delq
8665 nil
8666 (mapcar (lambda(y)
8667 (equal y tpl)) s))) x)))
8668 (reverse r))))))
8670 (defun org-contextualize-validate-key (key contexts)
8671 "Check CONTEXTS for agenda or capture KEY."
8672 (let (r rr res)
8673 (while (setq r (pop contexts))
8674 (mapc
8675 (lambda (rr)
8676 (when
8677 (and (equal key (car r))
8678 (if (functionp rr) (funcall rr)
8679 (or (and (eq (car rr) 'in-file)
8680 (buffer-file-name)
8681 (string-match (cdr rr) (buffer-file-name)))
8682 (and (eq (car rr) 'in-mode)
8683 (string-match (cdr rr) (symbol-name major-mode)))
8684 (when (and (eq (car rr) 'not-in-file)
8685 (buffer-file-name))
8686 (not (string-match (cdr rr) (buffer-file-name))))
8687 (when (eq (car rr) 'not-in-mode)
8688 (not (string-match (cdr rr) (symbol-name major-mode)))))))
8689 (push r res)))
8690 (car (last r))))
8691 (delete-dups (delq nil res))))
8693 (defun org-context-p (&rest contexts)
8694 "Check if local context is any of CONTEXTS.
8695 Possible values in the list of contexts are `table', `headline', and `item'."
8696 (let ((pos (point)))
8697 (goto-char (point-at-bol))
8698 (prog1 (or (and (memq 'table contexts)
8700 (and (memq 'headline contexts)
8701 (looking-at org-outline-regexp))
8702 (and (memq 'item contexts)
8704 (and (memq 'item-body contexts)
8705 (org-in-item-p)))
8706 (goto-char pos))))
8708 (defun org-get-local-variables ()
8709 "Return a list of all local variables in an Org mode buffer."
8710 (let (varlist)
8711 (with-current-buffer (get-buffer-create "*Org tmp*")
8712 (erase-buffer)
8713 (org-mode)
8714 (setq varlist (buffer-local-variables)))
8715 (kill-buffer "*Org tmp*")
8716 (delq nil
8717 (mapcar
8718 (lambda (x)
8719 (setq x
8720 (if (symbolp x)
8721 (list x)
8722 (list (car x) (list 'quote (cdr x)))))
8723 (if (string-match
8724 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
8725 (symbol-name (car x)))
8726 x nil))
8727 varlist))))
8729 (defun org-clone-local-variables (from-buffer &optional regexp)
8730 "Clone local variables from FROM-BUFFER.
8731 Optional argument REGEXP selects variables to clone."
8732 (mapc
8733 (lambda (pair)
8734 (and (symbolp (car pair))
8735 (or (null regexp)
8736 (string-match regexp (symbol-name (car pair))))
8737 (set (make-local-variable (car pair))
8738 (cdr pair))))
8739 (buffer-local-variables from-buffer)))
8741 ;;;###autoload
8742 (defun org-run-like-in-org-mode (cmd)
8743 "Run a command, pretending that the current buffer is in Org-mode.
8744 This will temporarily bind local variables that are typically bound in
8745 Org-mode to the values they have in Org-mode, and then interactively
8746 call CMD."
8747 (org-load-modules-maybe)
8748 (unless org-local-vars
8749 (setq org-local-vars (org-get-local-variables)))
8750 (eval (list 'let org-local-vars
8751 (list 'call-interactively (list 'quote cmd)))))
8753 ;;;; Archiving
8755 (defun org-get-category (&optional pos force-refresh)
8756 "Get the category applying to position POS."
8757 (save-match-data
8758 (if force-refresh (org-refresh-category-properties))
8759 (let ((pos (or pos (point))))
8760 (or (get-text-property pos 'org-category)
8761 (progn (org-refresh-category-properties)
8762 (get-text-property pos 'org-category))))))
8764 (defun org-refresh-category-properties ()
8765 "Refresh category text properties in the buffer."
8766 (let ((case-fold-search t)
8767 (inhibit-read-only t)
8768 (def-cat (cond
8769 ((null org-category)
8770 (if buffer-file-name
8771 (file-name-sans-extension
8772 (file-name-nondirectory buffer-file-name))
8773 "???"))
8774 ((symbolp org-category) (symbol-name org-category))
8775 (t org-category)))
8776 beg end cat pos optionp)
8777 (org-unmodified
8778 (save-excursion
8779 (save-restriction
8780 (widen)
8781 (goto-char (point-min))
8782 (put-text-property (point) (point-max) 'org-category def-cat)
8783 (while (re-search-forward
8785 (setq pos (match-end 0)
8786 optionp (equal (char-after (match-beginning 0)) ?#)
8787 cat (org-trim (match-string 2)))
8788 (if optionp
8789 (setq beg (point-at-bol) end (point-max))
8790 (org-back-to-heading t)
8791 (setq beg (point) end (org-end-of-subtree t t)))
8792 (put-text-property beg end 'org-category cat)
8793 (put-text-property beg end 'org-category-position beg)
8794 (goto-char pos)))))))
8797 ;;;; Link Stuff
8799 ;;; Link abbreviations
8801 (defun org-link-expand-abbrev (link)
8802 "Apply replacements as defined in `org-link-abbrev-alist'."
8804 (let* ((key (match-string 1 link))
8805 (as (or (assoc key org-link-abbrev-alist-local)
8806 (assoc key org-link-abbrev-alist)))
8807 (tag (and (match-end 2) (match-string 3 link)))
8808 rpl)
8809 (if (not as)
8810 link
8811 (setq rpl (cdr as))
8812 (cond
8813 ((symbolp rpl) (funcall rpl tag))
8815 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
8816 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8817 ((string-match "%h" rpl)
8818 (replace-match (url-hexify-string (or tag "")) t t rpl))
8819 (t (concat rpl tag)))))
8820 link))
8822 ;;; Storing and inserting links
8824 (defvar org-insert-link-history nil
8825 "Minibuffer history for links inserted with `org-insert-link'.")
8827 (defvar org-stored-links nil
8828 "Contains the links stored with `org-store-link'.")
8830 (defvar org-store-link-plist nil
8831 "Plist with info about the most recently link created with `org-store-link'.")
8833 (defvar org-link-protocols nil
8834 "Link protocols added to Org-mode using `org-add-link-type'.")
8836 (defvar org-store-link-functions nil
8837 "List of functions that are called to create and store a link.
8838 Each function will be called in turn until one returns a non-nil
8839 value. Each function should check if it is responsible for creating
8840 this link (for example by looking at the major mode).
8841 If not, it must exit and return nil.
8842 If yes, it should return a non-nil value after a calling
8843 `org-store-link-props' with a list of properties and values.
8844 Special properties are:
8848 This is obligatory as well.
8849 :description Optional default description for the second pair
8850 of brackets in an Org-mode link. The user can still change
8851 this when inserting this link into an Org-mode buffer.
8853 In addition to these, any additional properties can be specified
8854 and then used in remember templates.")
8856 (defun org-add-link-type (type &optional follow export)
8857 "Add TYPE to the list of `org-link-types'.
8858 Re-compute all regular expressions depending on `org-link-types'
8860 FOLLOW and EXPORT are two functions.
8862 FOLLOW should take the link path as the single argument and do whatever
8863 is necessary to follow the link, for example find a file or display
8864 a mail message.
8866 EXPORT should format the link path for export to one of the export formats.
8867 It should be a function accepting three arguments:
8870 desc the description of the link, if any, or a description added by
8871 org-export-normalize-links if there is none
8872 format the export format, a symbol like `html' or `latex' or `ascii'..
8874 The function may use the FORMAT information to return different values
8875 depending on the format. The return value will be put literally into
8876 the exported file. If the return value is nil, this means Org should
8877 do what it normally does with links which do not have EXPORT defined.
8879 Org-mode has a built-in default for exporting links. If you are happy with
8880 this default, there is no need to define an export function for the link
8881 type. For a simple example of an export function, see `org-bbdb.el'."
8882 (add-to-list 'org-link-types type t)
8883 (org-make-link-regexps)
8884 (if (assoc type org-link-protocols)
8885 (setcdr (assoc type org-link-protocols) (list follow export))
8886 (push (list type follow export) org-link-protocols)))
8888 (defvar org-agenda-buffer-name)
8890 ;;;###autoload
8891 (defun org-store-link (arg)
8893 This link is added to `org-stored-links' and can later be inserted
8896 For some link types, a prefix arg is interpreted:
8897 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8898 For file links, arg negates `org-context-in-file-links'."
8899 (interactive "P")
8900 (org-load-modules-maybe)
8901 (setq org-store-link-plist nil) ; reset
8902 (org-with-limited-levels
8903 (let (link cpltxt desc description search txt custom-id agenda-link)
8904 (cond
8906 ((run-hook-with-args-until-success 'org-store-link-functions)
8907 (setq link (plist-get org-store-link-plist :link)
8908 desc (or (plist-get org-store-link-plist :description) link)))
8910 ((org-src-edit-buffer-p)
8911 (let (label gc)
8912 (while (or (not label)
8913 (save-excursion
8914 (save-restriction
8915 (widen)
8916 (goto-char (point-min))
8917 (re-search-forward
8918 (regexp-quote (format org-coderef-label-format label))
8919 nil t))))
8920 (when label (message "Label exists already") (sit-for 2))
8921 (setq label (read-string "Code line label: " label)))
8922 (end-of-line 1)
8923 (setq link (format org-coderef-label-format label))
8924 (setq gc (- 79 (length link)))
8925 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8926 (insert link)
8927 (setq link (concat "(" label ")") desc nil)))
8929 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8930 ;; We are in the agenda, link to referenced location
8931 (let ((m (or (get-text-property (point) 'org-hd-marker)
8932 (get-text-property (point) 'org-marker))))
8933 (when m
8934 (org-with-point-at m
8935 (setq agenda-link
8936 (if (org-called-interactively-p 'any)
8937 (call-interactively 'org-store-link)
8938 (org-store-link nil)))))))
8940 ((eq major-mode 'calendar-mode)
8941 (let ((cd (calendar-cursor-to-date)))
8942 (setq link
8943 (format-time-string
8944 (car org-time-stamp-formats)
8945 (apply 'encode-time
8946 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8947 nil nil nil))))
8948 (org-store-link-props :type "calendar" :date cd)))
8950 ((eq major-mode 'help-mode)
8951 (setq link (concat "help:" (save-excursion
8952 (goto-char (point-min))
8953 (looking-at "^[^ ]+")
8954 (match-string 0))))
8955 (org-store-link-props :type "help"))
8957 ((eq major-mode 'w3-mode)
8958 (setq cpltxt (if (and (buffer-name)
8959 (not (string-match "Untitled" (buffer-name))))
8960 (buffer-name)
8961 (url-view-url t))
8962 link (url-view-url t))
8963 (org-store-link-props :type "w3" :url (url-view-url t)))
8965 ((eq major-mode 'w3m-mode)
8966 (setq cpltxt (or w3m-current-title w3m-current-url)
8967 link w3m-current-url)
8968 (org-store-link-props :type "w3m" :url (url-view-url t)))
8970 ((setq search (run-hook-with-args-until-success
8971 'org-create-file-search-functions))
8972 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8973 "::" search))
8974 (setq cpltxt (or description link)))
8976 ((eq major-mode 'image-mode)
8977 (setq cpltxt (concat "file:"
8978 (abbreviate-file-name buffer-file-name))
8979 link cpltxt)
8980 (org-store-link-props :type "image" :file buffer-file-name))
8982 ((eq major-mode 'dired-mode)
8983 ;; link to the file in the current line
8984 (let ((file (dired-get-filename nil t)))
8985 (setq file (if file
8986 (abbreviate-file-name
8987 (expand-file-name (dired-get-filename nil t)))
8988 ;; otherwise, no file so use current directory.
8989 default-directory))
8990 (setq cpltxt (concat "file:" file)
8991 link cpltxt)))
8993 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
8994 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8995 (cond
8997 (setq cpltxt
8998 (concat "file:"
8999 (abbreviate-file-name
9000 (buffer-file-name (buffer-base-buffer)))
9001 "::" (match-string 1))
9002 link cpltxt))
9003 ((and (featurep 'org-id)
9004 (or (eq org-link-to-org-use-id t)
9005 (and (org-called-interactively-p 'any)
9006 (or (eq org-link-to-org-use-id 'create-if-interactive)
9007 (and (eq org-link-to-org-use-id
9008 'create-if-interactive-and-no-custom-id)
9009 (not custom-id))))
9010 (and org-link-to-org-use-id (org-entry-get nil "ID"))))
9011 ;; We can make a link using the ID.
9012 (setq link (condition-case nil
9013 (prog1 (org-id-store-link)
9014 (setq desc (plist-get org-store-link-plist :description)))
9015 (error
9016 ;; probably before first headline, link to file only
9017 (concat "file:"
9018 (abbreviate-file-name
9019 (buffer-file-name (buffer-base-buffer))))))))
9020 (t
9021 ;; Just link to current headline
9022 (setq cpltxt (concat "file:"
9023 (abbreviate-file-name
9024 (buffer-file-name (buffer-base-buffer)))))
9025 ;; Add a context search string
9026 (when (org-xor org-context-in-file-links arg)
9027 (setq txt (cond
9028 ((org-at-heading-p) nil)
9029 ((org-region-active-p)
9030 (buffer-substring (region-beginning) (region-end)))))
9032 (setq cpltxt
9033 (concat cpltxt "::"
9034 (condition-case nil
9035 (org-make-org-heading-search-string txt)
9036 (error "")))
9037 desc (or (nth 4 (ignore-errors
9038 (org-heading-components))) "NONE"))))
9040 (setq cpltxt (substring cpltxt 0 -2)))
9041 (setq link cpltxt))))
9043 ((buffer-file-name (buffer-base-buffer))
9044 ;; Just link to this file here.
9045 (setq cpltxt (concat "file:"
9046 (abbreviate-file-name
9047 (buffer-file-name (buffer-base-buffer)))))
9048 ;; Add a context string
9049 (when (org-xor org-context-in-file-links arg)
9050 (setq txt (if (org-region-active-p)
9051 (buffer-substring (region-beginning) (region-end))
9052 (buffer-substring (point-at-bol) (point-at-eol))))
9053 ;; Only use search option if there is some text.
9055 (setq cpltxt
9056 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9057 desc "NONE")))
9058 (setq link cpltxt))
9060 ((org-called-interactively-p 'interactive)
9061 (error "Cannot link to a buffer which is not visiting a file"))
9063 (t (setq link nil)))
9065 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9066 (setq link (or link cpltxt)
9067 desc (or desc cpltxt))
9068 (if (equal desc "NONE") (setq desc nil))
9070 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
9071 (progn
9072 (setq org-stored-links
9073 (cons (list link desc) org-stored-links))
9074 (message "Stored: %s" (or desc link))
9075 (when custom-id
9076 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
9077 "::#" custom-id))
9078 (setq org-stored-links
9079 (cons (list link desc) org-stored-links))))
9080 (or agenda-link (and link (org-make-link-string link desc)))))))
9082 (defun org-store-link-props (&rest plist)
9083 "Store link properties, extract names and addresses."
9084 (let (x adr)
9085 (when (setq x (plist-get plist :from))
9086 (setq adr (mail-extract-address-components x))
9087 (setq plist (plist-put plist :fromname (car adr)))
9088 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9089 (when (setq x (plist-get plist :to))
9090 (setq adr (mail-extract-address-components x))
9091 (setq plist (plist-put plist :toname (car adr)))
9092 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9093 (let ((from (plist-get plist :from))
9094 (to (plist-get plist :to)))
9095 (when (and from to org-from-is-user-regexp)
9096 (setq plist
9097 (plist-put plist :fromto
9098 (if (string-match org-from-is-user-regexp from)
9099 (concat "to %t")
9100 (concat "from %f"))))))
9101 (setq org-store-link-plist plist))
9103 (defun org-add-link-props (&rest plist)
9104 "Add these properties to the link property list."
9105 (let (key value)
9106 (while plist
9107 (setq key (pop plist) value (pop plist))
9108 (setq org-store-link-plist
9109 (plist-put org-store-link-plist key value)))))
9111 (defun org-email-link-description (&optional fmt)
9112 "Return the description part of an email link.
9113 This takes information from `org-store-link-plist' and formats it
9114 according to FMT (default from `org-email-link-description-format')."
9115 (setq fmt (or fmt org-email-link-description-format))
9116 (let* ((p org-store-link-plist)
9117 (to (plist-get p :toaddress))
9118 (from (plist-get p :fromaddress))
9119 (table
9120 (list
9121 (cons "%c" (plist-get p :fromto))
9122 (cons "%F" (plist-get p :from))
9123 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9124 (cons "%T" (plist-get p :to))
9125 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9126 (cons "%s" (plist-get p :subject))
9127 (cons "%d" (plist-get p :date))
9128 (cons "%m" (plist-get p :message-id)))))
9129 (when (string-match "%c" fmt)
9130 ;; Check if the user wrote this message
9131 (if (and org-from-is-user-regexp from to
9132 (save-match-data (string-match org-from-is-user-regexp from)))
9133 (setq fmt (replace-match "to %t" t t fmt))
9134 (setq fmt (replace-match "from %f" t t fmt))))
9135 (org-replace-escapes fmt table)))
9137 (defun org-make-org-heading-search-string (&optional string heading)
9138 "Make search string for STRING or current headline."
9139 (interactive)
9140 (let ((s (or string (org-get-heading)))
9141 (lines org-context-in-file-links))
9142 (unless (and string (not heading))
9143 ;; We are using a headline, clean up garbage in there.
9144 (if (string-match org-todo-regexp s)
9145 (setq s (replace-match "" t t s)))
9147 (setq s (replace-match "" t t s)))
9148 (setq s (org-trim s))
9151 (setq s (replace-match "" t t s)))
9152 (while (string-match org-ts-regexp s)
9153 (setq s (replace-match "" t t s))))
9154 (or string (setq s (concat "*" s))) ; Add * for headlines
9155 (when (and string (integerp lines) (> lines 0))
9157 (when (< lines (length slines))
9158 (setq s (mapconcat
9159 'identity
9160 (reverse (nthcdr (- (length slines) lines)
9164 (defun org-make-link-string (link &optional description)
9165 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9167 (error "Empty link"))
9168 (when (and description
9169 (stringp description)
9171 (setq description nil))
9172 (when (stringp description)
9173 ;; Remove brackets from the description, they are fatal.
9175 (setq description (replace-match "{" t t description)))
9177 (setq description (replace-match "}" t t description))))
9178 (when (equal link description)
9179 ;; No description needed, it is identical
9180 (setq description nil))
9181 (when (and (not description)
9182 (not (string-match (org-image-file-name-regexp) link))
9183 (not (equal link (org-link-escape link))))
9184 (setq description (org-extract-attributes link)))
9185 (setq link
9186 (cond ((string-match (org-image-file-name-regexp) link) link)
9187 ((string-match org-link-types-re link)
9188 (concat (match-string 1 link)
9189 (org-link-escape (substring link (match-end 1)))))
9190 (t (org-link-escape link))))
9191 (concat "[[" link "]"
9192 (if description (concat "[" description "]") "")
9193 "]"))
9195 (defconst org-link-escape-chars
9196 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9197 "List of characters that should be escaped in link.
9198 This is the list that is used for internal purposes.")
9200 (defconst org-link-escape-chars-browser
9201 '(?\ )
9202 "List of escapes for characters that are problematic in links.
9203 This is the list that is used before handing over to the browser.")
9205 (defun org-link-escape (text &optional table merge)
9206 "Return percent escaped representation of TEXT.
9207 TEXT is a string with the text to escape.
9208 Optional argument TABLE is a list with characters that should be
9209 escaped. When nil, `org-link-escape-chars' is used.
9210 If optional argument MERGE is set, merge TABLE into
9211 `org-link-escape-chars'."
9212 (cond
9213 ((and table merge)
9214 (mapc (lambda (defchr)
9215 (unless (member defchr table)
9216 (setq table (cons defchr table)))) org-link-escape-chars))
9217 ((null table)
9218 (setq table org-link-escape-chars)))
9219 (mapconcat
9220 (lambda (char)
9221 (if (or (member char table)
9222 (and (or (< char 32) (= char 37) (> char 126))
9223 org-url-hexify-p))
9224 (mapconcat (lambda (sequence-element)
9225 (format "%%%.2X" sequence-element))
9226 (or (encode-coding-char char 'utf-8)
9227 (error "Unable to percent escape character: %s"
9228 (char-to-string char))) "")
9229 (char-to-string char))) text ""))
9231 (defun org-link-unescape (str)
9232 "Unhex hexified Unicode strings as returned from the JavaScript function
9233 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
9234 (unless (and (null str) (string= "" str))
9235 (let ((pos 0) (case-fold-search t) unhexed)
9237 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9238 (setq str (replace-match unhexed t t str))
9239 (setq pos (+ pos (length unhexed))))))
9240 str)
9242 (defun org-link-unescape-compound (hex)
9243 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
9244 Note: this function also decodes single byte encodings like
9246 (save-match-data
9247 (let* ((bytes (cdr (split-string hex "%")))
9248 (ret "")
9249 (eat 0)
9250 (sum 0))
9251 (while bytes
9252 (let* ((val (string-to-number (pop bytes) 16))
9253 (shift-xor
9254 (if (= 0 eat)
9255 (cond
9256 ((>= val 252) (cons 6 252))
9257 ((>= val 248) (cons 5 248))
9258 ((>= val 240) (cons 4 240))
9259 ((>= val 224) (cons 3 224))
9260 ((>= val 192) (cons 2 192))
9261 (t (cons 0 0)))
9262 (cons 6 128))))
9263 (if (>= val 192) (setq eat (car shift-xor)))
9264 (setq val (logxor val (cdr shift-xor)))
9265 (setq sum (+ (lsh sum (car shift-xor)) val))
9266 (if (> eat 0) (setq eat (- eat 1)))
9267 (cond
9268 ((= 0 eat) ;multi byte
9269 (setq ret (concat ret (org-char-to-string sum)))
9270 (setq sum 0))
9271 ((not bytes) ; single byte(s)
9272 (setq ret (org-link-unescape-single-byte-sequence hex))))
9273 )) ;; end (while bytes
9274 ret )))
9276 (defun org-link-unescape-single-byte-sequence (hex)
9277 "Unhexify hex-encoded single byte character sequences."
9278 (mapconcat (lambda (byte)
9279 (char-to-string (string-to-number byte 16)))
9280 (cdr (split-string hex "%")) ""))
9282 (defun org-xor (a b)
9283 "Exclusive or."
9284 (if a (not b) b))
9286 (defun org-fixup-message-id-for-http (s)
9287 "Replace special characters in a message id, so it can be used in an http query."
9288 (when (string-match "%" s)
9289 (setq s (mapconcat (lambda (c)
9290 (if (eq c ?%)
9291 "%25"
9292 (char-to-string c)))
9293 s "")))
9294 (while (string-match "<" s)
9295 (setq s (replace-match "%3C" t t s)))
9296 (while (string-match ">" s)
9297 (setq s (replace-match "%3E" t t s)))
9298 (while (string-match "@" s)
9299 (setq s (replace-match "%40" t t s)))
9300 s)
9302 (defun org-link-prettify (link)
9303 "Return a human-readable representation of LINK.
9304 The car of LINK must be a raw link the cdr of LINK must be either
9305 a link description or nil."
9306 (let ((desc (or (cadr link) "<no description>")))
9307 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9308 "<" (car link) ">")))
9310 ;;;###autoload
9311 (defun org-insert-link-global ()
9312 "Insert a link like Org-mode does.
9313 This command can be called in any mode to insert a link in Org-mode syntax."
9314 (interactive)
9315 (org-load-modules-maybe)
9316 (org-run-like-in-org-mode 'org-insert-link))
9318 (defun org-insert-all-links (&optional keep)
9319 "Insert all links in `org-stored-links'."
9320 (interactive "P")
9321 (let ((links (copy-sequence org-stored-links)) l)
9322 (while (setq l (if keep (pop links) (pop org-stored-links)))
9323 (insert "- ")
9324 (org-insert-link nil (car l) (cadr l))
9327 (defun org-link-fontify-links-to-this-file ()
9328 "Fontify links to the current file in `org-stored-links'."
9329 (let ((f (buffer-file-name)) a b)
9330 (setq a (mapcar (lambda(l)
9331 (let ((ll (car l)))
9333 (equal f (expand-file-name (match-string 1 ll))))
9334 ll)))
9335 org-stored-links))
9336 (when (featurep 'org-id)
9337 (setq b (mapcar (lambda(l)
9338 (let ((ll (car l)))
9340 (equal f (expand-file-name
9341 (or (org-id-find-id-file
9342 (match-string 1 ll)) ""))))
9343 ll)))
9344 org-stored-links)))
9345 (mapcar (lambda(l)
9346 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9347 (delq nil (append a b)))))
9349 (defvar org-link-links-in-this-file nil)
9350 (defun org-insert-link (&optional complete-file link-location default-description)
9351 "Insert a link. At the prompt, enter the link.
9353 Completion can be used to insert any of the link protocol prefixes like
9354 http or ftp in use.
9356 The history can be used to select a link previously stored with
9357 `org-store-link'. When the empty string is entered (i.e. if you just
9358 press RET at the prompt), the link defaults to the most recently
9359 stored link. As SPC triggers completion in the minibuffer, you need to
9360 use M-SPC or C-q SPC to force the insertion of a space character.
9362 You will also be prompted for a description, and if one is given, it will
9363 be displayed in the buffer instead of the link.
9365 If there is already a link at point, this command will allow you to edit link
9366 and description parts.
9369 be selected using completion. The path to the file will be relative to the
9370 current directory if the file is in the current directory or a subdirectory.
9371 Otherwise, the link will be the absolute path as completed in the minibuffer
9372 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9373 option `org-link-file-path-type'.
9376 the current directory or below.
9379 `org-keep-stored-link-after-insertion'.
9381 If `org-make-link-description-function' is non-nil, this function will be
9382 called with the link target, and the result will be the default
9383 link description.
9385 If the LINK-LOCATION parameter is non-nil, this value will be
9386 used as the link location instead of reading one interactively.
9388 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9389 be used as the default description."
9390 (interactive "P")
9391 (let* ((wcf (current-window-configuration))
9392 (region (if (org-region-active-p)
9393 (buffer-substring (region-beginning) (region-end))))
9394 (remove (and region (list (region-beginning) (region-end))))
9395 (desc region)
9396 tmphist ; byte-compile incorrectly complains about this
9397 (link link-location)
9398 (abbrevs org-link-abbrev-alist-local)
9399 entry file all-prefixes auto-desc)
9400 (cond
9401 (link-location) ; specified by arg, just use it.
9402 ((org-in-regexp org-bracket-link-regexp 1)
9403 ;; We do have a link at point, and we are going to edit it.
9404 (setq remove (list (match-beginning 0) (match-end 0)))
9405 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9406 (setq link (read-string "Link: "
9407 (org-link-unescape
9408 (org-match-string-no-properties 1)))))
9409 ((or (org-in-regexp org-angle-link-re)
9410 (org-in-regexp org-plain-link-re))
9411 ;; Convert to bracket link
9412 (setq remove (list (match-beginning 0) (match-end 0))
9413 link (read-string "Link: "
9414 (org-remove-angle-brackets (match-string 0)))))
9415 ((member complete-file '((4) (16)))
9416 ;; Completing read for file names.
9417 (setq link (org-file-complete-link complete-file)))
9418 (t
9419 ;; Read link, with completion for stored links.
9420 (org-link-fontify-links-to-this-file)
9421 (org-switch-to-buffer-other-window "*Org Links*")
9422 (with-current-buffer "*Org Links*"
9423 (erase-buffer)
9424 (insert "Insert a link.
9426 (when org-stored-links
9428 (insert (mapconcat 'org-link-prettify
9430 (goto-char (point-min)))
9431 (let ((cw (selected-window)))
9432 (select-window (get-buffer-window "*Org Links*" 'visible))
9433 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9434 (unless (pos-visible-in-window-p (point-max))
9435 (org-fit-window-to-buffer))
9436 (and (window-live-p cw) (select-window cw)))
9437 ;; Fake a link history, containing the stored links.
9438 (setq tmphist (append (mapcar 'car org-stored-links)
9439 org-insert-link-history))
9440 (setq all-prefixes (append (mapcar 'car abbrevs)
9441 (mapcar 'car org-link-abbrev-alist)
9442 org-link-types))
9443 (unwind-protect
9444 (progn
9445 (setq link
9446 (let ((org-completion-use-ido nil)
9447 (org-completion-use-iswitchb nil))
9448 (org-completing-read
9449 "Link: "
9450 (append
9451 (mapcar (lambda (x) (list (concat x ":")))
9452 all-prefixes)
9453 (mapcar 'car org-stored-links)
9454 (mapcar 'cadr org-stored-links))
9455 nil nil nil
9456 'tmphist
9457 (caar org-stored-links))))
9459 (error "No link selected"))
9460 (mapc (lambda(l)
9461 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9462 org-stored-links)
9463 (if (or (member link all-prefixes)
9464 (and (equal ":" (substring link -1))
9465 (member (substring link 0 -1) all-prefixes)
9466 (setq link (substring link 0 -1))))
9467 (setq link (org-link-try-special-completion link))))
9468 (set-window-configuration wcf)
9469 (kill-buffer "*Org Links*"))
9470 (setq entry (assoc link org-stored-links))
9471 (or entry (push link org-insert-link-history))
9472 (setq desc (or desc (nth 1 entry)))))
9474 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9475 (not org-keep-stored-link-after-insertion))
9476 (setq org-stored-links (delq (assoc link org-stored-links)
9477 org-stored-links)))
9479 (if (string-match org-plain-link-re link)
9480 ;; URL-like link, normalize the use of angular brackets.
9481 (setq link (org-remove-angle-brackets link)))
9483 ;; Check if we are linking to the current file with a search option
9484 ;; If yes, simplify the link by using only the search option.
9485 (when (and buffer-file-name
9487 (let* ((path (match-string 1 link))
9488 (case-fold-search nil)
9489 (search (match-string 2 link)))
9490 (save-match-data
9491 (if (equal (file-truename buffer-file-name) (file-truename path))
9492 ;; We are linking to this same file, with a search option
9493 (setq link search)))))
9495 ;; Check if we can/should use a relative path. If yes, simplify the link
9497 (let* ((type (match-string 1 link))
9498 (path (match-string 2 link))
9499 (origpath path)
9500 (case-fold-search nil))
9501 (cond
9502 ((or (eq org-link-file-path-type 'absolute)
9503 (equal complete-file '(16)))
9504 (setq path (abbreviate-file-name (expand-file-name path))))
9505 ((eq org-link-file-path-type 'noabbrev)
9506 (setq path (expand-file-name path)))
9507 ((eq org-link-file-path-type 'relative)
9508 (setq path (file-relative-name path)))
9509 (t
9510 (save-match-data
9511 (if (string-match (concat "^" (regexp-quote
9512 (expand-file-name
9513 (file-name-as-directory
9514 default-directory))))
9515 (expand-file-name path))
9516 ;; We are linking a file with relative path name.
9517 (setq path (substring (expand-file-name path)
9518 (match-end 0)))
9519 (setq path (abbreviate-file-name (expand-file-name path)))))))
9520 (setq link (concat type path))
9521 (if (equal desc origpath)
9522 (setq desc path))))
9524 (if org-make-link-description-function
9525 (setq desc (funcall org-make-link-description-function link desc))
9526 (if default-description (setq desc default-description)
9527 (setq desc (or (and auto-desc desc)
9528 (read-string "Description: " desc)))))
9531 (if remove (apply 'delete-region remove))
9532 (insert (org-make-link-string link desc))))
9534 (defun org-link-try-special-completion (type)
9535 "If there is completion support for link type TYPE, offer it."
9536 (let ((fun (intern (concat "org-" type "-complete-link"))))
9537 (if (functionp fun)
9538 (funcall fun)
9539 (read-string "Link (no completion support): " (concat type ":")))))
9541 (defun org-file-complete-link (&optional arg)
9542 "Create a file link using completion."
9543 (let (file link)
9544 (setq file (read-file-name "File: "))
9545 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9546 (pwd1 (file-name-as-directory (abbreviate-file-name
9547 (expand-file-name ".")))))
9548 (cond
9549 ((equal arg '(16))
9550 (setq link (concat
9551 "file:"
9552 (abbreviate-file-name (expand-file-name file)))))
9554 (setq link (concat "file:" (match-string 1 file))))
9556 (expand-file-name file))
9557 (setq link (concat
9558 "file:" (match-string 1 (expand-file-name file)))))
9559 (t (setq link (concat "file:" file)))))
9560 link))
9562 (defun org-completing-read (&rest args)
9563 "Completing-read with SPACE being a normal character."
9564 (let ((enable-recursive-minibuffers t)
9565 (minibuffer-local-completion-map
9566 (copy-keymap minibuffer-local-completion-map)))
9567 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9568 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9569 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9570 (apply 'org-icompleting-read args)))
9572 (defun org-completing-read-no-i (&rest args)
9573 (let (org-completion-use-ido org-completion-use-iswitchb)
9574 (apply 'org-completing-read args)))
9576 (defun org-iswitchb-completing-read (prompt choices &rest args)
9577 "Use iswitch as a completing-read replacement to choose from choices.
9578 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9579 from."
9580 (let* ((iswitchb-use-virtual-buffers nil)
9581 (iswitchb-make-buflist-hook
9582 (lambda ()
9583 (setq iswitchb-temp-buflist choices))))
9584 (iswitchb-read-buffer prompt)))
9586 (defun org-icompleting-read (&rest args)
9587 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9588 (org-without-partial-completion
9589 (if (and org-completion-use-ido
9590 (fboundp 'ido-completing-read)
9591 (boundp 'ido-mode) ido-mode
9592 (listp (second args)))
9593 (let ((ido-enter-matching-directory nil))
9594 (apply 'ido-completing-read (concat (car args))
9595 (if (consp (car (nth 1 args)))
9596 (mapcar 'car (nth 1 args))
9597 (nth 1 args))
9598 (cddr args)))
9599 (if (and org-completion-use-iswitchb
9600 (boundp 'iswitchb-mode) iswitchb-mode
9601 (listp (second args)))
9602 (apply 'org-iswitchb-completing-read (concat (car args))
9603 (if (consp (car (nth 1 args)))
9604 (mapcar 'car (nth 1 args))
9605 (nth 1 args))
9606 (cddr args))
9607 (apply 'completing-read args)))))
9609 (defun org-extract-attributes (s)
9610 "Extract the attributes cookie from a string and set as text property."
9611 (let (a attr (start 0) key value)
9612 (save-match-data
9614 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9616 (setq key (match-string 1 a) value (match-string 2 a)
9617 start (match-end 0)
9618 attr (plist-put attr (intern key) value))))
9619 (org-add-props s nil 'org-attr attr))
9620 s))
9622 (defun org-extract-attributes-from-string (tag)
9623 (let (key value attr)
9625 (setq key (match-string 1 tag) value (match-string 2 tag)
9626 tag (replace-match "" t t tag)
9627 attr (plist-put attr (intern key) value)))
9628 (cons tag attr)))
9630 (defun org-attributes-to-string (plist)
9631 "Format a property list into an HTML attribute list."
9632 (let ((s "") key value)
9633 (while plist
9634 (setq key (pop plist) value (pop plist))
9635 (and value
9637 s))
9639 ;;; Opening/following a link
9641 (defvar org-link-search-failed nil)
9643 (defvar org-open-link-functions nil
9644 "Hook for functions finding a plain text link.
9645 These functions must take a single argument, the link content.
9646 They will be called for links that look like [[link text][description]]
9650 These functions will be called *before* Org attempts to resolve the
9651 link by doing text searches in the current buffer - so if you want a
9653 handle this as a special case.
9655 When the function does handle the link, it must return a non-nil value.
9656 If it decides that it is not responsible for this link, it must return
9657 nil to indicate that that Org-mode can continue with other options
9658 like exact and fuzzy text search.")
9660 (defun org-next-link ()
9661 "Move forward to the next link.
9662 If the link is in hidden text, expose it."
9663 (interactive)
9664 (when (and org-link-search-failed (eq this-command last-command))
9665 (goto-char (point-min))
9666 (message "Link search wrapped back to beginning of buffer"))
9667 (setq org-link-search-failed nil)
9668 (let* ((pos (point))
9669 (ct (org-context))
9670 (a (assoc :link ct)))
9671 (if a (goto-char (nth 2 a)))
9672 (if (re-search-forward org-any-link-re nil t)
9673 (progn
9674 (goto-char (match-beginning 0))
9675 (if (outline-invisible-p) (org-show-context)))
9676 (goto-char pos)
9677 (setq org-link-search-failed t)
9678 (error "No further link found"))))
9680 (defun org-previous-link ()
9681 "Move backward to the previous link.
9682 If the link is in hidden text, expose it."
9683 (interactive)
9684 (when (and org-link-search-failed (eq this-command last-command))
9685 (goto-char (point-max))
9686 (message "Link search wrapped back to end of buffer"))
9687 (setq org-link-search-failed nil)
9688 (let* ((pos (point))
9689 (ct (org-context))
9690 (a (assoc :link ct)))
9691 (if a (goto-char (nth 1 a)))
9692 (if (re-search-backward org-any-link-re nil t)
9693 (progn
9694 (goto-char (match-beginning 0))
9695 (if (outline-invisible-p) (org-show-context)))
9696 (goto-char pos)
9697 (setq org-link-search-failed t)
9698 (error "No further link found"))))
9700 (defun org-translate-link (s)
9701 "Translate a link string if a translation function has been defined."
9702 (if (and org-link-translation-function
9703 (fboundp org-link-translation-function)
9705 (progn
9706 (setq s (funcall org-link-translation-function
9707 (match-string 1 s) (match-string 2 s)))
9708 (concat (car s) ":" (cdr s)))
9709 s))
9711 (defun org-translate-link-from-planner (type path)
9712 "Translate a link from Emacs Planner syntax so that Org can follow it.
9713 This is still an experimental function, your mileage may vary."
9714 (cond
9715 ((member type '("http" "https" "news" "ftp"))
9716 ;; standard Internet links are the same.
9717 nil)
9718 ((and (equal type "irc") (string-match "^//" path))
9719 ;; Planner has two / at the beginning of an irc link, we have 1.
9720 ;; We should have zero, actually....
9721 (setq path (substring path 1)))
9722 ((and (equal type "lisp") (string-match "^/" path))
9723 ;; Planner has a slash, we do not.
9724 (setq type "elisp" path (substring path 1)))
9726 ;; A typical message link. Planner has the id after the final slash,
9727 ;; we separate it with a hash mark
9728 (setq path (concat (match-string 1 path) "#"
9729 (org-remove-angle-brackets (match-string 2 path)))))
9730 )
9731 (cons type path))
9733 (defun org-find-file-at-mouse (ev)
9734 "Open file link or URL at mouse."
9735 (interactive "e")
9736 (mouse-set-point ev)
9737 (org-open-at-point 'in-emacs))
9739 (defun org-open-at-mouse (ev)
9740 "Open file link or URL at mouse.
9741 See the docstring of `org-open-file' for details."
9742 (interactive "e")
9743 (mouse-set-point ev)
9744 (if (eq major-mode 'org-agenda-mode)
9745 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9746 (org-open-at-point))
9748 (defvar org-window-config-before-follow-link nil
9749 "The window configuration before following a link.
9750 This is saved in case the need arises to restore it.")
9752 (defvar org-open-link-marker (make-marker)
9753 "Marker pointing to the location where `org-open-at-point; was called.")
9755 ;;;###autoload
9756 (defun org-open-at-point-global ()
9757 "Follow a link like Org-mode does.
9758 This command can be called in any mode to follow a link that has
9759 Org-mode syntax."
9760 (interactive)
9761 (org-run-like-in-org-mode 'org-open-at-point))
9763 ;;;###autoload
9764 (defun org-open-link-from-string (s &optional arg reference-buffer)
9765 "Open a link in the string S, as if it was in Org-mode."
9767 (let ((reference-buffer (or reference-buffer (current-buffer))))
9768 (with-temp-buffer
9769 (let ((org-inhibit-startup (not reference-buffer)))
9770 (org-mode)
9771 (insert s)
9772 (goto-char (point-min))
9773 (when reference-buffer
9774 (setq org-link-abbrev-alist-local
9775 (with-current-buffer reference-buffer
9776 org-link-abbrev-alist-local)))
9777 (org-open-at-point arg reference-buffer)))))
9779 (defvar org-open-at-point-functions nil
9780 "Hook that is run when following a link at point.
9782 Functions in this hook must return t if they identify and follow
9783 a link at point. If they don't find anything interesting at point,
9784 they must return nil.")
9786 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
9787 (defun org-open-at-point (&optional arg reference-buffer)
9788 "Open link at or after point.
9789 If there is no link at point, this function will search forward up to
9790 the end of the current line.
9791 Normally, files will be opened by an appropriate application. If the
9792 optional prefix argument ARG is non-nil, Emacs will visit the file.
9793 With a double prefix argument, try to open outside of Emacs, in the
9794 application the system uses for this file type."
9795 (interactive "P")
9796 ;; if in a code block, then open the block's results
9797 (unless (call-interactively #'org-babel-open-src-block-result)
9798 (org-load-modules-maybe)
9799 (move-marker org-open-link-marker (point))
9800 (setq org-window-config-before-follow-link (current-window-configuration))
9801 (org-remove-occur-highlights nil nil t)
9802 (cond
9803 ((and (org-at-heading-p)
9804 (not (org-at-timestamp-p t))
9805 (not (org-in-regexp
9810 (not (get-text-property (point) 'org-linked-text)))
9811 (or (org-offer-links-in-entry arg)
9812 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9813 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9814 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9815 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9816 (not (org-in-regexp org-bracket-link-regexp)))
9817 (org-footnote-action))
9818 (t
9819 (let (type path link line search (pos (point)))
9820 (catch 'match
9821 (save-excursion
9823 (when (org-in-regexp org-bracket-link-regexp 1)
9824 (setq link (org-extract-attributes
9825 (org-link-unescape (org-match-string-no-properties 1))))
9827 (setq link (replace-match " " t t link)))
9828 (setq link (org-link-expand-abbrev link))
9829 (cond
9830 ((or (file-name-absolute-p link)
9832 (setq type "file" path link))
9833 ((string-match org-link-re-with-space3 link)
9834 (setq type (match-string 1 link) path (match-string 2 link)))
9836 (setq type "help" path (match-string 1 link)))
9837 (t (setq type "thisfile" path link)))
9838 (throw 'match t)))
9840 (when (get-text-property (point) 'org-linked-text)
9841 (setq type "thisfile"
9842 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9843 (1+ (point)) (point))
9844 path (buffer-substring
9845 (or (previous-single-property-change pos 'org-linked-text)
9846 (point-min))
9847 (or (next-single-property-change pos 'org-linked-text)
9848 (point-max))))
9849 (throw 'match t))
9851 (save-excursion
9852 (when (or (org-in-regexp org-angle-link-re)
9853 (and (goto-char (car (org-in-regexp org-plain-link-re)))
9855 (setq type (match-string 1)
9856 path (org-link-unescape (match-string 2)))
9857 (throw 'match t)))
9858 (save-excursion
9860 (setq type "tags"
9861 path (match-string 1))
9862 (while (string-match ":" path)
9863 (setq path (replace-match "+" t t path)))
9864 (throw 'match t)))
9866 (setq type "tree-match"
9867 path (match-string 1))
9868 (throw 'match t)))
9869 (unless path
9870 (error "No link found"))
9872 ;; switch back to reference buffer
9873 ;; needed when if called in a temporary buffer through
9874 ;; org-open-link-from-string
9875 (with-current-buffer (or reference-buffer (current-buffer))
9877 ;; Remove any trailing spaces in path
9879 (setq path (replace-match "" t t path)))
9880 (if (and org-link-translation-function
9881 (fboundp org-link-translation-function))
9882 ;; Check if we need to translate the link
9883 (let ((tmp (funcall org-link-translation-function type path)))
9884 (setq type (car tmp) path (cdr tmp))))
9886 (cond
9888 ((assoc type org-link-protocols)
9889 (funcall (nth 1 (assoc type org-link-protocols)) path))
9891 ((equal type "help")
9892 (let ((f-or-v (intern path)))
9893 (cond ((fboundp f-or-v)
9894 (describe-function f-or-v))
9895 ((boundp f-or-v)
9896 (describe-variable f-or-v))
9897 (t (error "Not a known function or variable")))))
9899 ((equal type "mailto")
9900 (let ((cmd (car org-link-mailto-program))
9901 (args (cdr org-link-mailto-program)) args1
9902 (address path) (subject "") a)
9904 (setq address (match-string 1 path)
9905 subject (org-link-escape (match-string 2 path))))
9906 (while args
9907 (cond
9908 ((not (stringp (car args))) (push (pop args) args1))
9909 (t (setq a (pop args))
9910 (if (string-match "%a" a)
9911 (setq a (replace-match address t t a)))
9912 (if (string-match "%s" a)
9913 (setq a (replace-match subject t t a)))
9914 (push a args1))))
9915 (apply cmd (nreverse args1))))
9917 ((member type '("http" "https" "ftp" "news"))
9918 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9919 (org-link-escape
9920 path org-link-escape-chars-browser)
9921 path))))
9923 ((string= type "doi")
9924 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
9925 (org-link-escape
9926 path org-link-escape-chars-browser)
9927 path))))
9929 ((member type '("message"))
9930 (browse-url (concat type ":" path)))
9932 ((string= type "tags")
9933 (org-tags-view arg path))
9935 ((string= type "tree-match")
9938 ((string= type "file")
9940 (setq line (string-to-number (match-string 1 path))
9941 path (substring path 0 (match-beginning 0)))
9943 (setq search (match-string 1 path)
9944 path (substring path 0 (match-beginning 0)))))
9945 (if (string-match "[*?{]" (file-name-nondirectory path))
9946 (dired path)
9947 (org-open-file path arg line search)))
9949 ((string= type "shell")
9950 (let ((buf (generate-new-buffer "*Org Shell Output"))
9951 (cmd path))
9952 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9953 (string-match org-confirm-shell-link-not-regexp cmd))
9954 (not org-confirm-shell-link-function)
9955 (funcall org-confirm-shell-link-function
9957 (org-add-props cmd nil
9958 'face 'org-warning))))
9959 (progn
9960 (message "Executing %s" cmd)
9961 (shell-command cmd buf)
9962 (if (featurep 'midnight)
9963 (setq clean-buffer-list-kill-buffer-names
9964 (cons buf clean-buffer-list-kill-buffer-names))))
9965 (error "Abort"))))
9967 ((string= type "elisp")
9968 (let ((cmd path))
9969 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9970 (string-match org-confirm-elisp-link-not-regexp cmd))
9971 (not org-confirm-elisp-link-function)
9972 (funcall org-confirm-elisp-link-function
9974 (org-add-props cmd nil
9975 'face 'org-warning))))
9976 (message "%s => %s" cmd
9977 (if (equal (string-to-char cmd) ?\()
9978 (eval (read cmd))
9979 (call-interactively (read cmd))))
9980 (error "Abort"))))
9982 ((and (string= type "thisfile")
9983 (run-hook-with-args-until-success
9984 'org-open-link-functions path)))
9986 ((string= type "thisfile")
9987 (if arg
9988 (switch-to-buffer-other-window
9989 (org-get-buffer-for-internal-link (current-buffer)))
9990 (org-mark-ring-push))
9991 (let ((cmd `(org-link-search
9992 ,path
9993 ,(cond ((equal arg '(4)) ''occur)
9994 ((equal arg '(16)) ''org-occur))
9995 ,pos)))
9996 (condition-case nil (let ((org-link-search-inhibit-query t))
9997 (eval cmd))
9998 (error (progn (widen) (eval cmd))))))
10000 (t (browse-url-at-point)))))))
10001 (move-marker org-open-link-marker nil)
10002 (run-hook-with-args 'org-follow-link-hook)))
10004 (defun org-offer-links-in-entry (&optional nth zero)
10005 "Offer links in the current entry and follow the selected link.
10006 If there is only one link, follow it immediately as well.
10007 If NTH is an integer, immediately pick the NTH link found.
10008 If ZERO is a string, check also this string for a link, and if
10009 there is one, offer it as link number zero."
10013 (cnt ?0)
10014 (in-emacs (if (integerp nth) nil nth))
10015 have-zero end links link c)
10016 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10017 (push (match-string 0 zero) links)
10018 (setq cnt (1- cnt) have-zero t))
10019 (save-excursion
10020 (org-back-to-heading t)
10021 (setq end (save-excursion (outline-next-heading) (point)))
10022 (while (re-search-forward re end t)
10023 (push (match-string 0) links))
10024 (setq links (org-uniquify (reverse links))))
10026 (cond
10027 ((null links)
10028 (message "No links"))
10029 ((equal (length links) 1)
10030 (setq link (list (car links))))
10031 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10032 (setq link (list (nth (if have-zero nth (1- nth)) links))))
10033 (t ; we have to select a link
10034 (save-excursion
10035 (save-window-excursion
10036 (delete-other-windows)
10037 (with-output-to-temp-buffer "*Select Link*"
10038 (mapc (lambda (l)
10039 (if (not (string-match org-bracket-link-regexp l))
10041 (org-remove-angle-brackets l)))
10042 (if (match-end 3)
10044 (match-string 3 l) (match-string 1 l)))
10046 (match-string 1 l))))))
10047 links))
10048 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10049 (message "Select link to open, RET to open all:")
10050 (setq c (read-char-exclusive))
10051 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10052 (when (equal c ?q) (error "Abort"))
10053 (if (equal c ?\C-m)
10054 (setq link links)
10055 (setq nth (- c ?0))
10056 (if have-zero (setq nth (1+ nth)))
10057 (unless (and (integerp nth) (>= (length links) nth))
10058 (error "Invalid link selection"))
10059 (setq link (list (nth (1- nth) links))))))
10060 (if link
10061 (let ((buf (current-buffer)))
10062 (dolist (l link)
10063 (org-open-link-from-string l in-emacs buf))
10064 t)
10065 nil)))
10067 ;; Add special file links that specify the way of opening
10069 (org-add-link-type "file+sys" 'org-open-file-with-system)
10070 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10071 (defun org-open-file-with-system (path)
10072 "Open file at PATH using the system way of opening it."
10073 (org-open-file path 'system))
10074 (defun org-open-file-with-emacs (path)
10075 "Open file at PATH in Emacs."
10076 (org-open-file path 'emacs))
10077 (defun org-remove-file-link-modifiers ()
10078 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
10079 (goto-char (point-min))
10081 (org-if-unprotected
10082 (replace-match "file:" t t))))
10083 (eval-after-load "org-exp"
10084 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
10085 'org-remove-file-link-modifiers))
10087 ;;;; Time estimates
10089 (defun org-get-effort (&optional pom)
10090 "Get the effort estimate for the current entry."
10091 (org-entry-get pom org-effort-property))
10093 ;;; File search
10095 (defvar org-create-file-search-functions nil
10096 "List of functions to construct the right search string for a file link.
10097 These functions are called in turn with point at the location to
10098 which the link should point.
10100 A function in the hook should first test if it would like to
10101 handle this file type, for example by checking the `major-mode'
10102 or the file extension. If it decides not to handle this file, it
10103 should just return nil to give other functions a chance. If it
10104 does handle the file, it must return the search string to be used
10105 when following the link. The search string will be part of the
10106 file link, given after a double colon, and `org-open-at-point'
10107 will automatically search for it. If special measures must be
10108 taken to make the search successful, another function should be
10109 added to the companion hook `org-execute-file-search-functions',
10110 which see.
10112 A function in this hook may also use `setq' to set the variable
10113 `description' to provide a suggestion for the descriptive text to
10114 be used for this link when it gets inserted into an Org-mode
10117 (defvar org-execute-file-search-functions nil
10118 "List of functions to execute a file search triggered by a link.
10120 Functions added to this hook must accept a single argument, the
10121 search string that was part of the file link, the part after the
10122 double colon. The function must first check if it would like to
10123 handle this search, for example by checking the `major-mode' or
10124 the file extension. If it decides not to handle this search, it
10125 should just return nil to give other functions a chance. If it
10126 does handle the search, it must return a non-nil value to keep
10127 other functions from trying.
10129 Each function can access the current prefix argument through the
10130 variable `current-prefix-argument'. Note that a single prefix is
10131 used to force opening a link in Emacs, so it may be good to only
10132 use a numeric or double prefix to guide the search function.
10134 In case this is needed, a function in this hook can also restore
10135 the window configuration before `org-open-at-point' was called using:
10137 (set-window-configuration org-window-config-before-follow-link)")
10139 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10140 (defun org-link-search (s &optional type avoid-pos stealth)
10141 "Search for a link search option.
10142 If S is surrounded by forward slashes, it is interpreted as a
10143 regular expression. In org-mode files, this will create an `org-occur'
10144 sparse tree. In ordinary files, `occur' will be used to list matches.
10145 If the current buffer is in `dired-mode', grep will be used to search
10146 in all files. If AVOID-POS is given, ignore matches near that position.
10148 When optional argument STEALTH is non-nil, do not modify
10149 visibility around point, thus ignoring
10150 `org-show-hierarchy-above', `org-show-following-heading' and
10151 `org-show-siblings' variables."
10152 (let ((case-fold-search t)
10156 org-emphasis-alist)
10158 (pos (point))
10159 (pre nil) (post nil)
10160 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10161 (cond
10162 ;; First check if there are any special search functions
10163 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10164 ;; Now try the builtin stuff
10165 ((and (equal (string-to-char s0) ?#)
10166 (> (length s0) 1)
10167 (save-excursion
10168 (goto-char (point-min))
10169 (and
10170 (re-search-forward
10172 (setq type 'dedicated
10173 pos (match-beginning 0))))
10174 ;; There is an exact target for this
10175 (goto-char pos)
10176 (org-back-to-heading t)))
10177 ((save-excursion
10178 (goto-char (point-min))
10179 (and
10180 (re-search-forward
10181 (concat "<<" (regexp-quote s0) ">>") nil t)
10182 (setq type 'dedicated
10183 pos (match-beginning 0))))
10184 ;; There is an exact target for this
10185 (goto-char pos))
10186 ((save-excursion
10187 (goto-char (point-min))
10188 (and
10189 (re-search-forward
10191 (setq type 'dedicated pos (match-beginning 0))))
10192 ;; Found an invisible target.
10193 (goto-char pos))
10194 ((save-excursion
10195 (goto-char (point-min))
10196 (and
10197 (re-search-forward
10199 (setq type 'dedicated pos (match-beginning 0))))
10200 ;; Found an element with a matching #+name affiliated keyword.
10201 (goto-char pos))
10203 (save-excursion
10204 (goto-char (point-min))
10205 (and
10206 (re-search-forward
10207 (concat "[^[]" (regexp-quote
10208 (format org-coderef-label-format
10209 (match-string 1 s0))))
10210 nil t)
10211 (setq type 'dedicated
10212 pos (1+ (match-beginning 0))))))
10213 ;; There is a coderef target for this
10214 (goto-char pos))
10216 ;; A regular expression
10217 (cond
10218 ((derived-mode-p 'org-mode)
10219 (org-occur (match-string 1 s)))
10220 ;;((eq major-mode 'dired-mode)
10221 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
10222 (t (org-do-occur (match-string 1 s)))))
10223 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10224 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10225 (goto-char (point-min))
10226 (cond
10227 ((let (case-fold-search)
10228 (re-search-forward (format org-complex-heading-regexp-format
10229 (regexp-quote s))
10230 nil t))
10231 ;; OK, found a match
10232 (setq type 'dedicated)
10233 (goto-char (match-beginning 0)))
10234 ((and (not org-link-search-inhibit-query)
10235 (eq org-link-search-must-match-exact-headline 'query-to-create)
10236 (y-or-n-p "No match - create this as a new heading? "))
10237 (goto-char (point-max))
10238 (or (bolp) (newline))
10240 (beginning-of-line 0))
10241 (t
10242 (goto-char pos)
10243 (error "No match"))))
10244 (t
10245 ;; A normal search string
10246 (when (equal (string-to-char s) ?*)
10247 ;; Anchor on headlines, post may include tags.
10250 s (substring s 1)))
10251 (remove-text-properties
10252 0 (length s)
10253 '(face nil mouse-face nil keymap nil fontified nil) s)
10254 ;; Make a series of regular expressions to find a match
10263 re4 (concat "[^a-zA-Z_]" re4_)
10265 re1 (concat pre re2 post)
10266 re3 (concat pre (if pre re4_ re4) post)
10267 re5 (concat pre ".*" re4)
10268 re2 (concat pre re2)
10269 re2a (concat pre (if pre re2a_ re2a))
10270 re4 (concat pre (if pre re4_ re4))
10274 ))
10275 (cond
10276 ((eq type 'org-occur) (org-occur reall))
10277 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10278 (t (goto-char (point-min))
10279 (setq type 'fuzzy)
10280 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10281 (org-search-not-self 1 re1 nil t)
10282 (org-search-not-self 1 re2 nil t)
10283 (org-search-not-self 1 re2a nil t)
10284 (org-search-not-self 1 re3 nil t)
10285 (org-search-not-self 1 re4 nil t)
10286 (org-search-not-self 1 re5 nil t)
10287 )
10288 (goto-char (match-beginning 1))
10289 (goto-char pos)
10290 (error "No match"))))))
10291 (and (derived-mode-p 'org-mode)
10292 (not stealth)
10293 (org-show-context 'link-search))
10294 type))
10296 (defun org-search-not-self (group &rest args)
10297 "Execute `re-search-forward', but only accept matches that do not
10298 enclose the position of `org-open-link-marker'."
10299 (let ((m org-open-link-marker))
10300 (catch 'exit
10301 (while (apply 're-search-forward args)
10302 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10303 (goto-char (match-end group))
10304 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10305 (> (match-beginning 0) (marker-position m))
10306 (< (match-end 0) (marker-position m)))
10307 (save-match-data
10308 (or (not (org-in-regexp
10309 org-bracket-link-analytic-regexp 1))
10310 (not (match-end 4)) ; no description
10311 (and (<= (match-beginning 4) (point))
10312 (>= (match-end 4) (point))))))
10313 (throw 'exit (point))))))))
10315 (defun org-get-buffer-for-internal-link (buffer)
10316 "Return a buffer to be used for displaying the link target of internal links."
10317 (cond
10318 ((not org-display-internal-link-with-indirect-buffer)
10319 buffer)
10320 ((string-match "(Clone)$" (buffer-name buffer))
10321 (message "Buffer is already a clone, not making another one")
10322 ;; we also do not modify visibility in this case
10323 buffer)
10324 (t ; make a new indirect buffer for displaying the link
10325 (let* ((bn (buffer-name buffer))
10326 (ibn (concat bn "(Clone)"))
10327 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10328 (with-current-buffer ib (org-overview))
10329 ib))))
10331 (defun org-do-occur (regexp &optional cleanup)
10332 "Call the Emacs command `occur'.
10333 If CLEANUP is non-nil, remove the printout of the regular expression
10334 in the *Occur* buffer. This is useful if the regex is long and not useful
10335 to read."
10336 (occur regexp)
10337 (when cleanup
10338 (let ((cwin (selected-window)) win beg end)
10339 (when (setq win (get-buffer-window "*Occur*"))
10340 (select-window win))
10341 (goto-char (point-min))
10342 (when (re-search-forward "match[a-z]+" nil t)
10343 (setq beg (match-end 0))
10345 (setq end (1- (match-beginning 0)))))
10346 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10347 (goto-char (point-min))
10348 (select-window cwin))))
10350 ;;; The mark ring for links jumps
10352 (defvar org-mark-ring nil
10353 "Mark ring for positions before jumps in Org-mode.")
10354 (defvar org-mark-ring-last-goto nil
10355 "Last position in the mark ring used to go back.")
10356 ;; Fill and close the ring
10357 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10358 (loop for i from 1 to org-mark-ring-length do
10359 (push (make-marker) org-mark-ring))
10360 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10361 org-mark-ring)
10363 (defun org-mark-ring-push (&optional pos buffer)
10364 "Put the current position or POS into the mark ring and rotate it."
10365 (interactive)
10366 (setq pos (or pos (point)))
10367 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10368 (move-marker (car org-mark-ring)
10369 (or pos (point))
10370 (or buffer (current-buffer)))
10371 (message "%s"
10372 (substitute-command-keys
10375 (defun org-mark-ring-goto (&optional n)
10376 "Jump to the previous position in the mark ring.
10377 With prefix arg N, jump back that many stored positions. When
10378 called several times in succession, walk through the entire ring.
10379 Org-mode commands jumping to a different position in the current file,
10380 or to another Org-mode file, automatically push the old position
10381 onto the ring."
10382 (interactive "p")
10383 (let (p m)
10384 (if (eq last-command this-command)
10385 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10386 (setq p org-mark-ring))
10387 (setq org-mark-ring-last-goto p)
10388 (setq m (car p))
10389 (org-pop-to-buffer-same-window (marker-buffer m))
10390 (goto-char m)
10391 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10393 (defun org-remove-angle-brackets (s)
10394 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10395 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10396 s)
10397 (defun org-add-angle-brackets (s)
10398 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10399 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10400 s)
10401 (defun org-remove-double-quotes (s)
10404 s)
10406 ;;; Following specific links
10408 (defun org-follow-timestamp-link ()
10409 (cond
10410 ((org-at-date-range-p t)
10411 (let ((org-agenda-start-on-weekday)
10412 (t1 (match-string 1))
10413 (t2 (match-string 2)))
10414 (setq t1 (time-to-days (org-time-string-to-time t1))
10415 t2 (time-to-days (org-time-string-to-time t2)))
10416 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10417 ((org-at-timestamp-p t)
10418 (org-agenda-list nil (time-to-days (org-time-string-to-time
10419 (substring (match-string 1) 0 10)))
10420 1))
10421 (t (error "This should not happen"))))
10424 ;;; Following file links
10425 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10426 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10427 (declare-function mailcap-mime-info
10428 "mailcap" (string &optional request no-decode))
10429 (defvar org-wait nil)
10430 (defun org-open-file (path &optional in-emacs line search)
10431 "Open the file at PATH.
10432 First, this expands any special file name abbreviations. Then the
10433 configuration variable `org-file-apps' is checked if it contains an
10434 entry for this file type, and if yes, the corresponding command is launched.
10436 If no application is found, Emacs simply visits the file.
10438 With optional prefix argument IN-EMACS, Emacs will visit the file.
10440 prefix arg, Org tries to avoid opening in Emacs
10441 and to use an external application to visit the file.
10443 Optional LINE specifies a line to go to, optional SEARCH a string
10444 to search for. If LINE or SEARCH is given, the file will be
10445 opened in Emacs, unless an entry from org-file-apps that makes
10446 use of groups in a regexp matches.
10448 If you want to change the way frames are used when following a
10449 link, please customize `org-link-frame-setup'.
10451 If the file does not exist, an error is thrown."
10452 (let* ((file (if (equal path "")
10453 buffer-file-name
10454 (substitute-in-file-name (expand-file-name path))))
10455 (file-apps (append org-file-apps (org-default-apps)))
10456 (apps (org-remove-if
10457 'org-file-apps-entry-match-against-dlink-p file-apps))
10458 (apps-dlink (org-remove-if-not
10459 'org-file-apps-entry-match-against-dlink-p file-apps))
10460 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10461 (dirp (if remp nil (file-directory-p file)))
10462 (file (if (and dirp org-open-directory-means-index-dot-org)
10463 (concat (file-name-as-directory file) "index.org")
10464 file))
10465 (a-m-a-p (assq 'auto-mode apps))
10466 (dfile (downcase file))
10467 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10468 (link (cond ((and (eq line nil)
10469 (eq search nil))
10470 file)
10471 (line
10472 (concat file "::" (number-to-string line)))
10473 (search
10474 (concat file "::" search))))
10475 (dlink (downcase link))
10476 (old-buffer (current-buffer))
10477 (old-pos (point))
10478 (old-mode major-mode)
10479 ext cmd link-match-data)
10481 (setq ext (match-string 1 dfile))
10483 (setq ext (match-string 1 dfile))))
10484 (cond
10485 ((member in-emacs '((16) system))
10486 (setq cmd (cdr (assoc 'system apps))))
10487 (in-emacs (setq cmd 'emacs))
10488 (t
10489 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10490 (and dirp (cdr (assoc 'directory apps)))
10491 ; first, try matching against apps-dlink
10492 ; if we get a match here, store the match data for later
10493 (let ((match (assoc-default dlink apps-dlink
10494 'string-match)))
10495 (if match
10496 (progn (setq link-match-data (match-data))
10497 match)
10498 (progn (setq in-emacs (or in-emacs line search))
10499 nil))) ; if we have no match in apps-dlink,
10500 ; always open the file in emacs if line or search
10501 ; is given (for backwards compatibility)
10502 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10503 'string-match)
10504 (cdr (assoc ext apps))
10505 (cdr (assoc t apps))))))
10506 (when (eq cmd 'system)
10507 (setq cmd (cdr (assoc 'system apps))))
10508 (when (eq cmd 'default)
10509 (setq cmd (cdr (assoc t apps))))
10510 (when (eq cmd 'mailcap)
10511 (require 'mailcap)
10512 (mailcap-parse-mailcaps)
10513 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10514 (command (mailcap-mime-info mime-type)))
10515 (if (stringp command)
10516 (setq cmd command)
10517 (setq cmd 'emacs))))
10518 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10519 (not (file-exists-p file))
10520 (not org-open-non-existing-files))
10521 (error "No such file: %s" file))
10522 (cond
10524 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10526 (setq cmd (replace-match "%s" t t cmd)))
10527 (while (string-match "%s" cmd)
10528 (setq cmd (replace-match
10529 (save-match-data
10530 (shell-quote-argument
10531 (convert-standard-filename file)))
10532 t t cmd)))
10534 ;; Replace "%1", "%2" etc. in command with group matches from regex
10535 (save-match-data
10536 (let ((match-index 1)
10537 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10538 (set-match-data link-match-data)
10539 (while (<= match-index number-of-groups)
10540 (let ((regex (concat "%" (number-to-string match-index)))
10541 (replace-with (match-string match-index dlink)))
10542 (while (string-match regex cmd)
10543 (setq cmd (replace-match replace-with t t cmd))))
10544 (setq match-index (+ match-index 1)))))
10546 (save-window-excursion
10547 (start-process-shell-command cmd nil cmd)
10548 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10549 ))
10550 ((or (stringp cmd)
10551 (eq cmd 'emacs))
10552 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10553 (widen)
10554 (if line (org-goto-line line)
10555 (if search (org-link-search search))))
10556 ((consp cmd)
10557 (let ((file (convert-standard-filename file)))
10558 (save-match-data
10559 (set-match-data link-match-data)
10560 (eval cmd))))
10561 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10562 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10563 (or (not (equal old-buffer (current-buffer)))
10564 (not (equal old-pos (point))))
10565 (org-mark-ring-push old-pos old-buffer))))
10567 (defun org-file-apps-entry-match-against-dlink-p (entry)
10568 "This function returns non-nil if `entry' uses a regular
10569 expression which should be matched against the whole link by
10570 org-open-file.
10572 It assumes that is the case when the entry uses a regular
10573 expression which has at least one grouping construct and the
10574 action is either a lisp form or a command string containing
10575 '%1', i.e. using at least one subexpression match as a
10576 parameter."
10577 (let ((selector (car entry))
10578 (action (cdr entry)))
10579 (if (stringp selector)
10580 (and (> (regexp-opt-depth selector) 0)
10581 (or (and (stringp action)
10582 (string-match "%[0-9]" action))
10583 (consp action)))
10584 nil)))
10586 (defun org-default-apps ()
10587 "Return the default applications for this operating system."
10588 (cond
10589 ((eq system-type 'darwin)
10590 org-file-apps-defaults-macosx)
10591 ((eq system-type 'windows-nt)
10592 org-file-apps-defaults-windowsnt)
10593 (t org-file-apps-defaults-gnu)))
10595 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10596 "Convert extensions to regular expressions in the cars of LIST.
10597 Also, weed out any non-string entries, because the return value is used
10598 only for regexp matching.
10599 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10600 point to the symbol `emacs', indicating that the file should
10601 be opened in Emacs."
10602 (append
10603 (delq nil
10604 (mapcar (lambda (x)
10605 (if (not (stringp (car x)))
10606 nil
10608 x
10610 list))
10611 (if add-auto-mode
10612 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10614 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10615 (defun org-file-remote-p (file)
10616 "Test whether FILE specifies a location on a remote system.
10617 Return non-nil if the location is indeed remote.
10621 (cond ((fboundp 'file-remote-p)
10622 (file-remote-p file))
10623 ((fboundp 'tramp-handle-file-remote-p)
10624 (tramp-handle-file-remote-p file))
10625 ((and (boundp 'ange-ftp-name-format)
10626 (string-match (car ange-ftp-name-format) file))
10627 t)))
10630 ;;;; Refiling
10632 (defun org-get-org-file ()
10633 "Read a filename, with default directory `org-directory'."
10634 (let ((default (or org-default-notes-file remember-data-file)))
10635 (read-file-name (format "File name [%s]: " default)
10636 (file-name-as-directory org-directory)
10637 default)))
10639 (defun org-notes-order-reversed-p ()
10640 "Check if the current file should receive notes in reversed order."
10641 (cond
10642 ((not org-reverse-note-order) nil)
10643 ((eq t org-reverse-note-order) t)
10644 ((not (listp org-reverse-note-order)) nil)
10645 (t (catch 'exit
10646 (let ((all org-reverse-note-order)
10647 entry)
10648 (while (setq entry (pop all))
10649 (if (string-match (car entry) buffer-file-name)
10650 (throw 'exit (cdr entry))))
10651 nil)))))
10653 (defvar org-refile-target-table nil
10654 "The list of refile targets, created by `org-refile'.")
10656 (defvar org-agenda-new-buffers nil
10657 "Buffers created to visit agenda files.")
10659 (defvar org-refile-cache nil
10660 "Cache for refile targets.")
10662 (defvar org-refile-markers nil
10663 "All the markers used for caching refile locations.")
10665 (defun org-refile-marker (pos)
10666 "Get a new refile marker, but only if caching is in use."
10667 (if (not org-refile-use-cache)
10668 pos
10669 (let ((m (make-marker)))
10670 (move-marker m pos)
10671 (push m org-refile-markers)
10672 m)))
10674 (defun org-refile-cache-clear ()
10675 "Clear the refile cache and disable all the markers."
10676 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10677 (setq org-refile-markers nil)
10678 (setq org-refile-cache nil)
10679 (message "Refile cache has been cleared"))
10681 (defun org-refile-cache-check-set (set)
10682 "Check if all the markers in the cache still have live buffers."
10683 (let (marker)
10684 (catch 'exit
10685 (while (and set (setq marker (nth 3 (pop set))))
10686 ;; if org-refile-use-outline-path is 'file, marker may be nil
10687 (when (and marker (null (marker-buffer marker)))
10688 (message "not found") (sit-for 3)
10689 (throw 'exit nil)))
10690 t)))
10692 (defun org-refile-cache-put (set &rest identifiers)
10693 "Push the refile targets SET into the cache, under IDENTIFIERS."
10694 (let* ((key (sha1 (prin1-to-string identifiers)))
10695 (entry (assoc key org-refile-cache)))
10696 (if entry
10697 (setcdr entry set)
10698 (push (cons key set) org-refile-cache))))
10700 (defun org-refile-cache-get (&rest identifiers)
10701 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10702 (cond
10703 ((not org-refile-cache) nil)
10704 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10705 (t
10706 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10707 org-refile-cache))))
10708 (and set (org-refile-cache-check-set set) set)))))
10710 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10711 "Produce a table with refile targets."
10712 (let ((case-fold-search nil)
10713 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10714 (entries (or org-refile-targets '((nil . (:level . 1)))))
10715 targets tgs txt re files f desc descre fast-path-p level pos0)
10716 (message "Getting targets...")
10717 (with-current-buffer (or default-buffer (current-buffer))
10718 (while (setq entry (pop entries))
10719 (setq files (car entry) desc (cdr entry))
10720 (setq fast-path-p nil)
10721 (cond
10722 ((null files) (setq files (list (current-buffer))))
10723 ((eq files 'org-agenda-files)
10724 (setq files (org-agenda-files 'unrestricted)))
10725 ((and (symbolp files) (fboundp files))
10726 (setq files (funcall files)))
10727 ((and (symbolp files) (boundp files))
10728 (setq files (symbol-value files))))
10729 (if (stringp files) (setq files (list files)))
10730 (cond
10731 ((eq (car desc) :tag)
10733 ((eq (car desc) :todo)
10735 ((eq (car desc) :regexp)
10736 (setq descre (cdr desc)))
10737 ((eq (car desc) :level)
10739 (if org-odd-levels-only
10740 (1- (* 2 (cdr desc)))
10741 (cdr desc)))
10743 ((eq (car desc) :maxlevel)
10744 (setq fast-path-p t)
10746 (if org-odd-levels-only
10747 (1- (* 2 (cdr desc)))
10748 (cdr desc)))
10750 (t (error "Bad refiling target description %s" desc)))
10751 (while (setq f (pop files))
10752 (with-current-buffer
10753 (if (bufferp f) f (org-get-agenda-file-buffer f))
10754 (or
10755 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10756 (progn
10757 (if (bufferp f) (setq f (buffer-file-name
10758 (buffer-base-buffer f))))
10759 (setq f (and f (expand-file-name f)))
10760 (if (eq org-refile-use-outline-path 'file)
10761 (push (list (file-name-nondirectory f) f nil nil) tgs))
10762 (save-excursion
10763 (save-restriction
10764 (widen)
10765 (goto-char (point-min))
10766 (while (re-search-forward descre nil t)
10767 (goto-char (setq pos0 (point-at-bol)))
10768 (catch 'next
10769 (when org-refile-target-verify-function
10770 (save-match-data
10771 (or (funcall org-refile-target-verify-function)
10772 (throw 'next t))))
10773 (when (and (looking-at org-complex-heading-regexp)
10774 (not (member (match-string 4) excluded-entries))
10775 (match-string 4))
10776 (setq level (org-reduced-level
10777 (- (match-end 1) (match-beginning 1)))
10778 txt (org-link-display-format (match-string 4))
10780 re (format org-complex-heading-regexp-format
10781 (regexp-quote (match-string 4))))
10782 (when org-refile-use-outline-path
10783 (setq txt (mapconcat
10784 'org-protect-slash
10785 (append
10786 (if (eq org-refile-use-outline-path
10787 'file)
10788 (list (file-name-nondirectory
10789 (buffer-file-name
10790 (buffer-base-buffer))))
10791 (if (eq org-refile-use-outline-path
10792 'full-file-path)
10793 (list (buffer-file-name
10794 (buffer-base-buffer)))))
10795 (org-get-outline-path fast-path-p
10796 level txt)
10797 (list txt))
10798 "/")))
10799 (push (list txt f re (org-refile-marker (point)))
10800 tgs)))
10801 (when (= (point) pos0)
10802 ;; verification function has not moved point
10803 (goto-char (point-at-eol))))))))
10804 (when org-refile-use-cache
10805 (org-refile-cache-put tgs (buffer-file-name) descre))
10806 (setq targets (append tgs targets))
10807 ))))
10808 (message "Getting targets...done")
10809 (nreverse targets)))
10811 (defun org-protect-slash (s)
10812 (while (string-match "/" s)
10814 s)
10816 (defvar org-olpa (make-vector 20 nil))
10818 (defun org-get-outline-path (&optional fastp level heading)
10819 "Return the outline path to the current entry, as a list.
10821 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10822 routine which makes outline path derivations for an entire file,
10823 avoiding backtracing. Refile target collection makes use of that."
10824 (if fastp
10825 (progn
10826 (if (> level 19)
10827 (error "Outline path failure, more than 19 levels"))
10828 (loop for i from level upto 19 do
10829 (aset org-olpa i nil))
10830 (prog1
10831 (delq nil (append org-olpa nil))
10832 (aset org-olpa level heading)))
10833 (let (rtn case-fold-search)
10834 (save-excursion
10835 (save-restriction
10836 (widen)
10837 (while (org-up-heading-safe)
10838 (when (looking-at org-complex-heading-regexp)
10839 (push (org-match-string-no-properties 4) rtn)))
10840 rtn)))))
10842 (defun org-format-outline-path (path &optional width prefix)
10843 "Format the outline path PATH for display.
10844 Width is the maximum number of characters that is available.
10845 Prefix is a prefix to be included in the returned string,
10846 such as the file name."
10847 (setq width (or width 79))
10848 (if prefix (setq width (- width (length prefix))))
10849 (if (not path)
10850 (or prefix "")
10851 (let* ((nsteps (length path))
10852 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10853 (maxwidth (if (<= total-width width)
10854 10000 ;; everything fits
10855 ;; we need to shorten the level headings
10856 (/ (- width nsteps) nsteps)))
10857 (org-odd-levels-only nil)
10858 (n 0)
10859 (total (1+ (length prefix))))
10860 (setq maxwidth (max maxwidth 10))
10861 (concat prefix
10862 (mapconcat
10863 (lambda (h)
10864 (setq n (1+ n))
10865 (if (and (= n nsteps) (< maxwidth 10000))
10866 (setq maxwidth (- total-width total)))
10867 (if (< (length h) maxwidth)
10868 (progn (setq total (+ total (length h) 1)) h)
10869 (setq h (substring h 0 (- maxwidth 2))
10870 total (+ total maxwidth 1))
10872 (setq h (substring h 0 (match-beginning 0))))
10873 (setq h (concat h "..")))
10874 (org-add-props h nil 'face
10875 (nth (% (1- n) org-n-level-faces)
10876 org-level-faces))
10877 h)
10878 path "/")))))
10880 (defun org-display-outline-path (&optional file current)
10881 "Display the current outline path in the echo area."
10882 (interactive "P")
10883 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10884 (case-fold-search nil)
10885 (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
10886 (if current (setq path (append path
10887 (save-excursion
10888 (org-back-to-heading t)
10889 (if (looking-at org-complex-heading-regexp)
10890 (list (match-string 4)))))))
10891 (message "%s"
10892 (org-format-outline-path
10893 path
10894 (1- (frame-width))
10895 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10897 (defvar org-refile-history nil
10898 "History for refiling operations.")
10900 (defvar org-after-refile-insert-hook nil
10901 "Hook run after `org-refile' has inserted its stuff at the new location.
10902 Note that this is still *before* the stuff will be removed from
10903 the *old* location.")
10905 (defvar org-capture-last-stored-marker)
10906 (defun org-refile (&optional goto default-buffer rfloc)
10907 "Move the entry or entries at point to another heading.
10908 The list of target headings is compiled using the information in
10909 `org-refile-targets', which see.
10911 At the target location, the entry is filed as a subitem of the target
10912 heading. Depending on `org-reverse-note-order', the new subitem will
10913 either be the first or the last subitem.
10915 If there is an active region, all entries in that region will be moved.
10916 However, the region must fulfill the requirement that the first heading
10917 is the first one sets the top-level of the moved text - at most siblings
10918 below it are allowed.
10920 With prefix arg GOTO, the command will only visit the target location
10921 and not actually move anything.
10924 go to the location where the last refiling operation has put the subtree.
10925 With a prefix argument of `2', refile to the running clock.
10927 RFLOC can be a refile location obtained in a different way.
10929 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10931 If you are using target caching (see `org-refile-use-cache'),
10932 you have to clear the target cache in order to find new targets.
10933 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10934 prefix argument (`C-u C-u C-u C-c C-w')."
10936 (interactive "P")
10937 (if (member goto '(0 (64)))
10938 (org-refile-cache-clear)
10939 (let* ((cbuf (current-buffer))
10940 (regionp (org-region-active-p))
10941 (region-start (and regionp (region-beginning)))
10942 (region-end (and regionp (region-end)))
10943 (region-length (and regionp (- region-end region-start)))
10944 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10945 pos it nbuf file re level reversed)
10946 (setq last-command nil)
10947 (when regionp
10948 (goto-char region-start)
10949 (or (bolp) (goto-char (point-at-bol)))
10950 (setq region-start (point))
10951 (unless (or (org-kill-is-subtree-p
10952 (buffer-substring region-start region-end))
10953 (prog1 org-refile-active-region-within-subtree
10954 (org-toggle-heading)))
10955 (error "The region is not a (sequence of) subtree(s)")))
10956 (if (equal goto '(16))
10957 (org-refile-goto-last-stored)
10958 (when (or
10959 (and (equal goto 2)
10960 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10961 (prog1
10962 (setq it (list (or org-clock-heading "running clock")
10963 (buffer-file-name
10964 (marker-buffer org-clock-hd-marker))
10965 ""
10966 (marker-position org-clock-hd-marker)))
10967 (setq goto nil)))
10968 (setq it (or rfloc
10969 (let (heading-text)
10970 (save-excursion
10971 (unless goto
10972 (org-back-to-heading t)
10973 (setq heading-text
10974 (nth 4 (org-heading-components))))
10975 (org-refile-get-location
10976 (cond (goto "Goto")
10977 (regionp "Refile region to")
10980 default-buffer
10981 (and (not (equal '(4) goto))
10982 org-refile-allow-creating-parent-nodes)
10983 goto))))))
10984 (setq file (nth 1 it)
10985 re (nth 2 it)
10986 pos (nth 3 it))
10987 (if (and (not goto)
10988 pos
10989 (equal (buffer-file-name) file)
10990 (if regionp
10991 (and (>= pos region-start)
10992 (<= pos region-end))
10993 (and (>= pos (point))
10994 (< pos (save-excursion
10995 (org-end-of-subtree t t))))))
10996 (error "Cannot refile to position inside the tree or region"))
10998 (setq nbuf (or (find-buffer-visiting file)
10999 (find-file-noselect file)))
11000 (if goto
11001 (progn
11002 (org-pop-to-buffer-same-window nbuf)
11003 (goto-char pos)
11004 (org-show-context 'org-goto))
11005 (if regionp
11006 (progn
11007 (org-kill-new (buffer-substring region-start region-end))
11008 (org-save-markers-in-region region-start region-end))
11009 (org-copy-subtree 1 nil t))
11010 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11011 (find-file-noselect file)))
11012 (setq reversed (org-notes-order-reversed-p))
11013 (save-excursion
11014 (save-restriction
11015 (widen)
11016 (if pos
11017 (progn
11018 (goto-char pos)
11019 (looking-at org-outline-regexp)
11020 (setq level (org-get-valid-level (funcall outline-level) 1))
11021 (goto-char
11022 (if reversed
11023 (or (outline-next-heading) (point-max))
11024 (or (save-excursion (org-get-next-sibling))
11025 (org-end-of-subtree t t)
11026 (point-max)))))
11027 (setq level 1)
11028 (if (not reversed)
11029 (goto-char (point-max))
11030 (goto-char (point-min))
11031 (or (outline-next-heading) (goto-char (point-max)))))
11032 (if (not (bolp)) (newline))
11033 (org-paste-subtree level)
11034 (when org-log-refile
11035 (org-add-log-setup 'refile nil nil 'findpos
11036 org-log-refile)
11037 (unless (eq org-log-refile 'note)
11038 (save-excursion (org-add-log-note))))
11039 (and org-auto-align-tags
11040 (let ((org-loop-over-headlines-in-active-region nil))
11041 (org-set-tags nil t)))
11042 (bookmark-set "org-refile-last-stored")
11043 ;; If we are refiling for capture, make sure that the
11044 ;; last-capture pointers point here
11045 (when (org-bound-and-true-p org-refile-for-capture)
11046 (bookmark-set "org-capture-last-stored-marker")
11047 (move-marker org-capture-last-stored-marker (point)))
11048 (if (fboundp 'deactivate-mark) (deactivate-mark))
11049 (run-hooks 'org-after-refile-insert-hook))))
11050 (if regionp
11051 (delete-region (point) (+ (point) region-length))
11052 (org-cut-subtree))
11053 (when (featurep 'org-inlinetask)
11054 (org-inlinetask-remove-END-maybe))
11055 (setq org-markers-to-move nil)
11058 (defun org-refile-goto-last-stored ()
11059 "Go to the location where the last refile was stored."
11060 (interactive)
11061 (bookmark-jump "org-refile-last-stored")
11062 (message "This is the location of the last refile"))
11064 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11065 no-exclude)
11066 "Prompt the user for a refile location, using PROMPT.
11067 PROMPT should not be suffixed with a colon and a space, because
11068 this function appends the default value from
11069 `org-refile-history' automatically, if that is not empty.
11070 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11071 this is used for the GOTO interface."
11072 (let ((org-refile-targets org-refile-targets)
11073 (org-refile-use-outline-path org-refile-use-outline-path)
11074 excluded-entries)
11075 (when (and (derived-mode-p 'org-mode)
11076 (not org-refile-use-cache)
11077 (not no-exclude))
11078 (org-map-tree
11079 (lambda()
11080 (setq excluded-entries
11081 (append excluded-entries (list (org-get-heading t t)))))))
11082 (setq org-refile-target-table
11083 (org-refile-get-targets default-buffer excluded-entries)))
11084 (unless org-refile-target-table
11085 (error "No refile targets"))
11086 (let* ((prompt (concat prompt
11087 (and (car org-refile-history)
11088 (concat " (default " (car org-refile-history) ")"))
11089 ": "))
11090 (cbuf (current-buffer))
11091 (partial-completion-mode nil)
11092 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11093 (cfunc (if (and org-refile-use-outline-path
11094 org-outline-path-complete-in-steps)
11095 'org-olpath-completing-read
11096 'org-icompleting-read))
11097 (extra (if org-refile-use-outline-path "/" ""))
11098 (filename (and cfn (expand-file-name cfn)))
11099 (tbl (mapcar
11100 (lambda (x)
11101 (if (and (not (member org-refile-use-outline-path
11102 '(file full-file-path)))
11103 (not (equal filename (nth 1 x))))
11104 (cons (concat (car x) extra " ("
11105 (file-name-nondirectory (nth 1 x)) ")")
11106 (cdr x))
11107 (cons (concat (car x) extra) (cdr x))))
11108 org-refile-target-table))
11109 (completion-ignore-case t)
11110 pa answ parent-target child parent old-hist)
11111 (setq old-hist org-refile-history)
11112 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11113 nil 'org-refile-history (car org-refile-history)))
11114 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11115 (org-refile-check-position pa)
11116 (if pa
11117 (progn
11118 (when (or (not org-refile-history)
11119 (not (eq old-hist org-refile-history))
11120 (not (equal (car pa) (car org-refile-history))))
11121 (setq org-refile-history
11122 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11123 org-refile-history
11124 (cdr org-refile-history))))
11125 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11126 (pop org-refile-history)))
11127 pa)
11129 (progn
11130 (setq parent (match-string 1 answ)
11131 child (match-string 2 answ))
11132 (setq parent-target (or (assoc parent tbl)
11133 (assoc (concat parent "/") tbl)))
11134 (when (and parent-target
11135 (or (eq new-nodes t)
11136 (and (eq new-nodes 'confirm)
11138 child)))))
11139 (org-refile-new-child parent-target child)))
11140 (error "Invalid target location")))))
11142 (declare-function org-string-nw-p "org-macs.el" (s))
11143 (defun org-refile-check-position (refile-pointer)
11144 "Check if the refile pointer matches the readline to which it points."
11145 (let* ((file (nth 1 refile-pointer))
11146 (re (nth 2 refile-pointer))
11147 (pos (nth 3 refile-pointer))
11148 buffer)
11149 (when (org-string-nw-p re)
11150 (setq buffer (if (markerp pos)
11151 (marker-buffer pos)
11152 (or (find-buffer-visiting file)
11153 (find-file-noselect file))))
11154 (with-current-buffer buffer
11155 (save-excursion
11156 (save-restriction
11157 (widen)
11158 (goto-char pos)
11159 (beginning-of-line 1)
11160 (unless (org-looking-at-p re)
11161 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
11163 (defun org-refile-new-child (parent-target child)
11164 "Use refile target PARENT-TARGET to add new CHILD below it."
11165 (unless parent-target
11166 (error "Cannot find parent for new node"))
11167 (let ((file (nth 1 parent-target))
11168 (pos (nth 3 parent-target))
11169 level)
11170 (with-current-buffer (or (find-buffer-visiting file)
11171 (find-file-noselect file))
11172 (save-excursion
11173 (save-restriction
11174 (widen)
11175 (if pos
11176 (goto-char pos)
11177 (goto-char (point-max))
11178 (if (not (bolp)) (newline)))
11179 (when (looking-at org-outline-regexp)
11180 (setq level (funcall outline-level))
11181 (org-end-of-subtree t t))
11182 (org-back-over-empty-lines)
11184 (if pos (org-get-valid-level level 1) 1) ?*)
11186 (beginning-of-line 0)
11187 (list (concat (car parent-target) "/" child) file "" (point)))))))
11189 (defun org-olpath-completing-read (prompt collection &rest args)
11190 "Read an outline path like a file name."
11191 (let ((thetable collection)
11192 (org-completion-use-ido nil) ; does not work with ido.
11193 (org-completion-use-iswitchb nil)) ; or iswitchb
11194 (apply
11195 'org-icompleting-read prompt
11196 (lambda (string predicate &optional flag)
11197 (let (rtn r f (l (length string)))
11198 (cond
11199 ((eq flag nil)
11200 ;; try completion
11201 (try-completion string thetable))
11202 ((eq flag t)
11203 ;; all-completions
11204 (setq rtn (all-completions string thetable predicate))
11205 (mapcar
11206 (lambda (x)
11207 (setq r (substring x l))
11208 (if (string-match " ([^)]*)$" x)
11209 (setq f (match-string 0 x))
11210 (setq f ""))
11211 (if (string-match "/" r)
11212 (concat string (substring r 0 (match-end 0)) f)
11213 x))
11214 rtn))
11215 ((eq flag 'lambda)
11216 ;; exact match?
11217 (assoc string thetable)))))
11218 args)))
11220 ;;;; Dynamic blocks
11222 (defun org-find-dblock (name)
11223 "Find the first dynamic block with name NAME in the buffer.
11224 If not found, stay at current position and return nil."
11225 (let ((case-fold-search t) pos)
11226 (save-excursion
11227 (goto-char (point-min))
11228 (setq pos (and (re-search-forward
11230 (match-beginning 0))))
11231 (if pos (goto-char pos))
11232 pos))
11234 (defconst org-dblock-start-re
11236 "Matches the start line of a dynamic block, with parameters.")
11239 "Matches the end of a dynamic block.")
11241 (defun org-create-dblock (plist)
11242 "Create a dynamic block section, with parameters taken from PLIST.
11243 PLIST must contain a :name entry which is used as name of the block."
11245 (end-of-line 1)
11246 (newline))
11247 (let ((col (current-column))
11248 (name (plist-get plist :name)))
11249 (insert "#+BEGIN: " name)
11250 (while plist
11251 (if (eq (car plist) :name)
11252 (setq plist (cddr plist))
11253 (insert " " (prin1-to-string (pop plist)))))
11255 (beginning-of-line -2)))
11257 (defun org-prepare-dblock ()
11258 "Prepare dynamic block for refresh.
11259 This empties the block, puts the cursor at the insert position and returns
11260 the property list including an extra property :name with the block name."
11261 (unless (looking-at org-dblock-start-re)
11262 (error "Not at a dynamic block"))
11263 (let* ((begdel (1+ (match-end 0)))
11264 (name (org-no-properties (match-string 1)))
11265 (params (append (list :name name)
11266 (read (concat "(" (match-string 3) ")")))))
11267 (save-excursion
11268 (beginning-of-line 1)
11270 (setq params (plist-put params :indentation-column (current-column))))
11271 (unless (re-search-forward org-dblock-end-re nil t)
11272 (error "Dynamic block not terminated"))
11273 (setq params
11274 (append params
11275 (list :content (buffer-substring
11276 begdel (match-beginning 0)))))
11277 (delete-region begdel (match-beginning 0))
11278 (goto-char begdel)
11279 (open-line 1)
11280 params))
11282 (defun org-map-dblocks (&optional command)
11283 "Apply COMMAND to all dynamic blocks in the current buffer.
11284 If COMMAND is not given, use `org-update-dblock'."
11285 (let ((cmd (or command 'org-update-dblock)))
11286 (save-excursion
11287 (goto-char (point-min))
11288 (while (re-search-forward org-dblock-start-re nil t)
11289 (goto-char (match-beginning 0))
11290 (save-excursion
11291 (condition-case nil
11292 (funcall cmd)
11293 (error (message "Error during update of dynamic block"))))
11294 (unless (re-search-forward org-dblock-end-re nil t)
11295 (error "Dynamic block not terminated"))))))
11297 (defun org-dblock-update (&optional arg)
11298 "User command for updating dynamic blocks.
11299 Update the dynamic block at point. With prefix ARG, update all dynamic
11300 blocks in the buffer."
11301 (interactive "P")
11302 (if arg
11303 (org-update-all-dblocks)
11304 (or (looking-at org-dblock-start-re)
11305 (org-beginning-of-dblock))
11306 (org-update-dblock)))
11308 (defun org-update-dblock ()
11309 "Update the dynamic block at point.
11310 This means to empty the block, parse for parameters and then call
11311 the correct writing function."
11312 (interactive)
11313 (save-window-excursion
11314 (let* ((pos (point))
11315 (line (org-current-line))
11316 (params (org-prepare-dblock))
11317 (name (plist-get params :name))
11318 (indent (plist-get params :indentation-column))
11319 (cmd (intern (concat "org-dblock-write:" name))))
11320 (message "Updating dynamic block `%s' at line %d..." name line)
11321 (funcall cmd params)
11322 (message "Updating dynamic block `%s' at line %d...done" name line)
11323 (goto-char pos)
11324 (when (and indent (> indent 0))
11325 (setq indent (make-string indent ?\ ))
11326 (save-excursion
11327 (org-beginning-of-dblock)
11328 (forward-line 1)
11329 (while (not (looking-at org-dblock-end-re))
11330 (insert indent)
11331 (beginning-of-line 2))
11332 (when (looking-at org-dblock-end-re)
11334 (replace-match ""))
11335 (insert indent)))))))
11337 (defun org-beginning-of-dblock ()
11338 "Find the beginning of the dynamic block at point.
11339 Error if there is no such block at point."
11340 (let ((pos (point))
11341 beg)
11342 (end-of-line 1)
11343 (if (and (re-search-backward org-dblock-start-re nil t)
11344 (setq beg (match-beginning 0))
11345 (re-search-forward org-dblock-end-re nil t)
11346 (> (match-end 0) pos))
11347 (goto-char beg)
11348 (goto-char pos)
11349 (error "Not in a dynamic block"))))
11351 ;;;###autoload
11352 (defun org-update-all-dblocks ()
11353 "Update all dynamic blocks in the buffer.
11354 This function can be used in a hook."
11355 (interactive)
11356 (when (derived-mode-p 'org-mode)
11357 (org-map-dblocks 'org-update-dblock)))
11360 ;;;; Completion
11362 (defconst org-additional-option-like-keywords
11363 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11364 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11365 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11366 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11367 "BEGIN:" "END:"
11368 "ORGTBL" "TBLFM:" "TBLNAME:"
11369 "BEGIN_EXAMPLE" "END_EXAMPLE"
11370 "BEGIN_VERBATIM" "END_VERBATIM"
11371 "BEGIN_QUOTE" "END_QUOTE"
11372 "BEGIN_VERSE" "END_VERSE"
11373 "BEGIN_CENTER" "END_CENTER"
11374 "BEGIN_SRC" "END_SRC"
11375 "BEGIN_RESULT" "END_RESULT"
11376 "BEGIN_lstlisting" "END_lstlisting"
11377 "NAME:" "RESULTS:"
11378 "HEADER:" "HEADERS:"
11379 "COLUMNS:" "PROPERTY:"
11380 "CAPTION:" "LABEL:"
11381 "SETUPFILE:"
11382 "INCLUDE:"
11383 "BIND:"
11384 "MACRO:"))
11386 (defconst org-options-keywords
11387 '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
11388 "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
11389 "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
11390 "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
11391 "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
11392 "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:"
11393 "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
11395 (defconst org-additional-option-like-keywords-for-flyspell
11396 (delete-dups
11397 (split-string
11398 (mapconcat (lambda(k)
11399 (replace-regexp-in-string
11401 (concat k " " (downcase k) " " (upcase k))))
11402 (append org-options-keywords org-additional-option-like-keywords)
11403 " ")
11404 " +" t)))
11406 (defcustom org-structure-template-alist
11407 '(
11420 ("L" "#+LaTeX: "
11424 ("H" "#+HTML: "
11427 ("A" "#+ASCII: ")
11428 ("i" "#+INDEX: ?"
11429 "#+INDEX: ?")
11430 ("I" "#+INCLUDE %file ?"
11432 )
11433 "Structure completion elements.
11434 This is a list of abbreviation keys and values. The value gets inserted
11435 if you type `<' followed by the key and then press the completion key,
11436 usually `M-TAB'. %file will be replaced by a file name after prompting
11437 for the file using completion. The cursor will be placed at the position
11438 of the `?` in the template.
11439 There are two templates for each key, the first uses the original Org syntax,
11440 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11441 the default when the /org-mtags.el/ module has been loaded. See also the
11442 variable `org-mtags-prefer-muse-templates'."
11443 :group 'org-completion
11444 :type '(repeat
11445 (string :tag "Key")
11446 (string :tag "Template")
11447 (string :tag "Muse Template")))
11449 (defun org-try-structure-completion ()
11450 "Try to complete a structure template before point.
11452 expands them."
11453 (let ((l (buffer-substring (point-at-bol) (point)))
11454 a)
11457 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11458 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11459 (match-beginning 1)) a)
11460 t)))
11462 (defun org-complete-expand-structure-template (start cell)
11463 "Expand a structure template."
11464 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11465 (rpl (nth (if musep 2 1) cell))
11466 (ind ""))
11467 (delete-region start (point))
11469 (cond
11470 ((bolp))
11472 (setq ind (buffer-substring (point-at-bol) (point))))
11473 (t (newline))))
11474 (setq start (point))
11475 (if (string-match "%file" rpl)
11476 (setq rpl (replace-match
11477 (concat
11479 (save-match-data
11480 (abbreviate-file-name (read-file-name "Include file: ")))
11482 t t rpl)))
11485 (insert rpl)
11488 ;;;; TODO, DEADLINE, Comments
11490 (defun org-toggle-comment ()
11491 "Change the COMMENT state of an entry."
11492 (interactive)
11493 (save-excursion
11494 (org-back-to-heading)
11495 (let (case-fold-search)
11496 (cond
11497 ((looking-at (format org-heading-keyword-regexp-format
11498 org-comment-string))
11499 (goto-char (match-end 1))
11500 (looking-at (concat " +" org-comment-string))
11501 (replace-match "" t t)
11502 (when (eolp) (insert " ")))
11503 ((looking-at org-outline-regexp)
11504 (goto-char (match-end 0))
11505 (insert org-comment-string " "))))))
11507 (defvar org-last-todo-state-is-todo nil
11508 "This is non-nil when the last TODO state change led to a TODO state.
11509 If the last change removed the TODO tag or switched to DONE, then
11510 this is nil.")
11512 (defvar org-setting-tags nil) ; dynamically skipped
11514 (defvar org-todo-setup-filter-hook nil
11515 "Hook for functions that pre-filter todo specs.
11516 Each function takes a todo spec and returns either nil or the spec
11517 transformed into canonical form." )
11519 (defvar org-todo-get-default-hook nil
11520 "Hook for functions that get a default item for todo.
11521 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11522 nil or a string to be used for the todo mark." )
11524 (defvar org-agenda-headline-snapshot-before-repeat)
11526 (defun org-current-effective-time ()
11527 "Return current time adjusted for `org-extend-today-until' variable."
11528 (let* ((ct (org-current-time))
11529 (dct (decode-time ct))
11530 (ct1
11531 (if (and org-use-effective-time
11532 (< (nth 2 dct) org-extend-today-until))
11533 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11534 ct)))
11535 ct1))
11537 (defun org-todo-yesterday (&optional arg)
11538 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11539 (interactive "P")
11540 (if (eq major-mode 'org-agenda-mode)
11541 (apply 'org-agenda-todo-yesterday arg)
11542 (let* ((hour (third (decode-time
11543 (org-current-time))))
11544 (org-extend-today-until (1+ hour)))
11545 (org-todo arg))))
11547 (defun org-todo (&optional arg)
11548 "Change the TODO state of an item.
11549 The state of an item is given by a keyword at the start of the heading,
11550 like
11551 *** TODO Write paper
11552 *** DONE Call mom
11554 The different keywords are specified in the variable `org-todo-keywords'.
11556 So for this example: when the item starts with TODO, it is changed to DONE.
11557 When it starts with DONE, the DONE is removed. And when neither TODO nor
11558 DONE are present, add TODO at the beginning of the heading.
11561 state.
11562 With numeric prefix arg, switch to that state.
11564 keywords (nextset).
11566 With a numeric prefix arg of 0, inhibit note taking for the change.
11568 For calling through lisp, arg is also interpreted in the following way:
11569 'none -> empty state
11571 'done -> switch to DONE
11572 'nextset -> switch to the next set of keywords
11573 'previousset -> switch to the previous set of keywords
11575 really is a member of `org-todo-keywords'."
11576 (interactive "P")
11577 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11578 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11579 'region-start-level 'region))
11580 org-loop-over-headlines-in-active-region)
11581 (org-map-entries
11582 `(org-todo ,arg)
11583 org-loop-over-headlines-in-active-region
11584 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11585 (if (equal arg '(16)) (setq arg 'nextset))
11586 (let ((org-blocker-hook org-blocker-hook)
11587 (case-fold-search nil))
11588 (when (equal arg '(64))
11589 (setq arg nil org-blocker-hook nil))
11590 (when (and org-blocker-hook
11591 (or org-inhibit-blocking
11592 (org-entry-get nil "NOBLOCKING")))
11593 (setq org-blocker-hook nil))
11594 (save-excursion
11595 (catch 'exit
11596 (org-back-to-heading t)
11597 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11600 (let* ((match-data (match-data))
11601 (startpos (point-at-bol))
11602 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11603 (org-log-done org-log-done)
11604 (org-log-repeat org-log-repeat)
11605 (org-todo-log-states org-todo-log-states)
11606 (org-inhibit-logging
11607 (if (equal arg 0)
11608 (progn (setq arg nil) 'note) org-inhibit-logging))
11609 (this (match-string 1))
11610 (hl-pos (match-beginning 0))
11611 (head (org-get-todo-sequence-head this))
11612 (ass (assoc head org-todo-kwd-alist))
11613 (interpret (nth 1 ass))
11614 (done-word (nth 3 ass))
11615 (final-done-word (nth 4 ass))
11616 (org-last-state (or this ""))
11617 (completion-ignore-case t)
11618 (member (member this org-todo-keywords-1))
11619 (tail (cdr member))
11620 (org-state (cond
11621 ((and org-todo-key-trigger
11622 (or (and (equal arg '(4))
11623 (eq org-use-fast-todo-selection 'prefix))
11624 (and (not arg) org-use-fast-todo-selection
11625 (not (eq org-use-fast-todo-selection
11626 'prefix)))))
11627 ;; Use fast selection
11628 (org-fast-todo-selection))
11629 ((and (equal arg '(4))
11630 (or (not org-use-fast-todo-selection)
11631 (not org-todo-key-trigger)))
11632 ;; Read a state with completion
11633 (org-icompleting-read
11634 "State: " (mapcar (lambda(x) (list x))
11635 org-todo-keywords-1)
11636 nil t))
11637 ((eq arg 'right)
11638 (if this
11639 (if tail (car tail) nil)
11640 (car org-todo-keywords-1)))
11641 ((eq arg 'left)
11642 (if (equal member org-todo-keywords-1)
11643 nil
11644 (if this
11645 (nth (- (length org-todo-keywords-1)
11646 (length tail) 2)
11647 org-todo-keywords-1)
11648 (org-last org-todo-keywords-1))))
11649 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11650 (setq arg nil))) ; hack to fall back to cycling
11651 (arg
11652 ;; user or caller requests a specific state
11653 (cond
11654 ((equal arg "") nil)
11655 ((eq arg 'none) nil)
11656 ((eq arg 'done) (or done-word (car org-done-keywords)))
11657 ((eq arg 'nextset)
11658 (or (car (cdr (member head org-todo-heads)))
11659 (car org-todo-heads)))
11660 ((eq arg 'previousset)
11661 (let ((org-todo-heads (reverse org-todo-heads)))
11662 (or (car (cdr (member head org-todo-heads)))
11663 (car org-todo-heads))))
11664 ((car (member arg org-todo-keywords-1)))
11665 ((stringp arg)
11666 (error "State `%s' not valid in this file" arg))
11667 ((nth (1- (prefix-numeric-value arg))
11668 org-todo-keywords-1))))
11669 ((null member) (or head (car org-todo-keywords-1)))
11670 ((equal this final-done-word) nil) ;; -> make empty
11671 ((null tail) nil) ;; -> first entry
11672 ((memq interpret '(type priority))
11673 (if (eq this-command last-command)
11674 (car tail)
11675 (if (> (length tail) 0)
11676 (or done-word (car org-done-keywords))
11677 nil)))
11678 (t
11679 (car tail))))
11680 (org-state (or
11681 (run-hook-with-args-until-success
11682 'org-todo-get-default-hook org-state org-last-state)
11683 org-state))
11684 (next (if org-state (concat " " org-state " ") " "))
11685 (change-plist (list :type 'todo-state-change :from this :to org-state
11686 :position startpos))
11687 dolog now-done-p)
11688 (when org-blocker-hook
11689 (setq org-last-todo-state-is-todo
11690 (not (member this org-done-keywords)))
11691 (unless (save-excursion
11692 (save-match-data
11693 (org-with-wide-buffer
11694 (run-hook-with-args-until-failure
11695 'org-blocker-hook change-plist))))
11696 (if (org-called-interactively-p 'interactive)
11697 (error "TODO state change from %s to %s blocked" this org-state)
11698 ;; fail silently
11699 (message "TODO state change from %s to %s blocked" this org-state)
11700 (throw 'exit nil))))
11701 (store-match-data match-data)
11702 (replace-match next t t)
11703 (unless (pos-visible-in-window-p hl-pos)
11704 (message "TODO state changed to %s" (org-trim next)))
11705 (unless head
11706 (setq head (org-get-todo-sequence-head org-state)
11707 ass (assoc head org-todo-kwd-alist)
11708 interpret (nth 1 ass)
11709 done-word (nth 3 ass)
11710 final-done-word (nth 4 ass)))
11711 (when (memq arg '(nextset previousset))
11712 (message "Keyword-Set %d/%d: %s"
11713 (- (length org-todo-sets) -1
11714 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11715 (length org-todo-sets)
11716 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11717 (setq org-last-todo-state-is-todo
11718 (not (member org-state org-done-keywords)))
11719 (setq now-done-p (and (member org-state org-done-keywords)
11720 (not (member this org-done-keywords))))
11721 (and logging (org-local-logging logging))
11722 (when (and (or org-todo-log-states org-log-done)
11723 (not (eq org-inhibit-logging t))
11724 (not (memq arg '(nextset previousset))))
11725 ;; we need to look at recording a time and note
11726 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11727 (nth 2 (assoc this org-todo-log-states))))
11728 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11729 (setq dolog 'time))
11730 (when (and org-state
11731 (member org-state org-not-done-keywords)
11732 (not (member this org-not-done-keywords)))
11733 ;; This is now a todo state and was not one before
11734 ;; If there was a CLOSED time stamp, get rid of it.
11735 (org-add-planning-info nil nil 'closed))
11736 (when (and now-done-p org-log-done)
11737 ;; It is now done, and it was not done before
11738 (org-add-planning-info 'closed (org-current-effective-time))
11739 (if (and (not dolog) (eq 'note org-log-done))
11740 (org-add-log-setup 'done org-state this 'findpos 'note)))
11741 (when (and org-state dolog)
11742 ;; This is a non-nil state, and we need to log it
11743 (org-add-log-setup 'state org-state this 'findpos dolog)))
11744 ;; Fixup tag positioning
11745 (org-todo-trigger-tag-changes org-state)
11746 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11747 (when org-provide-todo-statistics
11748 (org-update-parent-todo-statistics))
11749 (run-hooks 'org-after-todo-state-change-hook)
11750 (if (and arg (not (member org-state org-done-keywords)))
11751 (setq head (org-get-todo-sequence-head org-state)))
11752 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11753 ;; Do we need to trigger a repeat?
11754 (when now-done-p
11755 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11756 ;; This is for the agenda, take a snapshot of the headline.
11757 (save-match-data
11758 (setq org-agenda-headline-snapshot-before-repeat
11759 (org-get-heading))))
11760 (org-auto-repeat-maybe org-state))
11761 ;; Fixup cursor location if close to the keyword
11762 (if (and (outline-on-heading-p)
11763 (not (bolp))
11764 (save-excursion (beginning-of-line 1)
11765 (looking-at org-todo-line-regexp))
11766 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11767 (progn
11768 (goto-char (or (match-end 2) (match-end 1)))
11769 (and (looking-at " ") (just-one-space))))
11770 (when org-trigger-hook
11771 (save-excursion
11772 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11774 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11775 "Block turning an entry into a TODO, using the hierarchy.
11776 This checks whether the current task should be blocked from state
11777 changes. Such blocking occurs when:
11779 1. The task has children which are not all in a completed state.
11781 2. A task has a parent with the property :ORDERED:, and there
11782 are siblings prior to the current task with incomplete
11783 status.
11785 3. The parent of the task is blocked because it has siblings that should
11786 be done first, or is child of a block grandparent TODO entry."
11788 (if (not org-enforce-todo-dependencies)
11789 t ; if locally turned off don't block
11790 (catch 'dont-block
11791 ;; If this is not a todo state change, or if this entry is already DONE,
11792 ;; do not block
11793 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11794 (member (plist-get change-plist :from)
11795 (cons 'done org-done-keywords))
11796 (member (plist-get change-plist :to)
11797 (cons 'todo org-not-done-keywords))
11798 (not (plist-get change-plist :to)))
11799 (throw 'dont-block t))
11800 ;; If this task has children, and any are undone, it's blocked
11801 (save-excursion
11802 (org-back-to-heading t)
11803 (let ((this-level (funcall outline-level)))
11804 (outline-next-heading)
11805 (let ((child-level (funcall outline-level)))
11806 (while (and (not (eobp))
11807 (> child-level this-level))
11808 ;; this todo has children, check whether they are all
11809 ;; completed
11810 (if (and (not (org-entry-is-done-p))
11811 (org-entry-is-todo-p))
11812 (throw 'dont-block nil))
11813 (outline-next-heading)
11814 (setq child-level (funcall outline-level))))))
11815 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11816 ;; any previous siblings are undone, it's blocked
11817 (save-excursion
11818 (org-back-to-heading t)
11819 (let* ((pos (point))
11820 (parent-pos (and (org-up-heading-safe) (point))))
11821 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11822 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11823 (forward-line 1)
11824 (re-search-forward org-not-done-heading-regexp pos t))
11825 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11826 ;; Search further up the hierarchy, to see if an ancestor is blocked
11827 (while t
11828 (goto-char parent-pos)
11829 (if (not (looking-at org-not-done-heading-regexp))
11830 (throw 'dont-block t)) ; do not block, parent is not a TODO
11831 (setq pos (point))
11832 (setq parent-pos (and (org-up-heading-safe) (point)))
11833 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11834 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11835 (forward-line 1)
11836 (re-search-forward org-not-done-heading-regexp pos t))
11837 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11839 (defcustom org-track-ordered-property-with-tag nil
11840 "Should the ORDERED property also be shown as a tag?
11841 The ORDERED property decides if an entry should require subtasks to be
11842 completed in sequence. Since a property is not very visible, setting
11843 this option means that toggling the ORDERED property with the command
11844 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11845 not relevant for the behavior, but it makes things more visible.
11847 Note that toggling the tag with tags commands will not change the property
11848 and therefore not influence behavior!
11850 This can be t, meaning the tag ORDERED should be used, It can also be a
11851 string to select a different tag for this task."
11852 :group 'org-todo
11853 :type '(choice
11854 (const :tag "No tracking" nil)
11855 (const :tag "Track with ORDERED tag" t)
11856 (string :tag "Use other tag")))
11858 (defun org-toggle-ordered-property ()
11859 "Toggle the ORDERED property of the current entry.
11860 For better visibility, you can track the value of this property with a tag.
11861 See variable `org-track-ordered-property-with-tag'."
11862 (interactive)
11863 (let* ((t1 org-track-ordered-property-with-tag)
11864 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11865 (save-excursion
11866 (org-back-to-heading)
11867 (if (org-entry-get nil "ORDERED")
11868 (progn
11869 (org-delete-property "ORDERED")
11870 (and tag (org-toggle-tag tag 'off))
11871 (message "Subtasks can be completed in arbitrary order"))
11872 (org-entry-put nil "ORDERED" "t")
11873 (and tag (org-toggle-tag tag 'on))
11874 (message "Subtasks must be completed in sequence")))))
11876 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11877 (defun org-block-todo-from-checkboxes (change-plist)
11878 "Block turning an entry into a TODO, using checkboxes.
11879 This checks whether the current task should be blocked from state
11880 changes because there are unchecked boxes in this entry."
11881 (if (not org-enforce-todo-checkbox-dependencies)
11882 t ; if locally turned off don't block
11883 (catch 'dont-block
11884 ;; If this is not a todo state change, or if this entry is already DONE,
11885 ;; do not block
11886 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11887 (member (plist-get change-plist :from)
11888 (cons 'done org-done-keywords))
11889 (member (plist-get change-plist :to)
11890 (cons 'todo org-not-done-keywords))
11891 (not (plist-get change-plist :to)))
11892 (throw 'dont-block t))
11893 ;; If this task has checkboxes that are not checked, it's blocked
11894 (save-excursion
11895 (org-back-to-heading t)
11896 (let ((beg (point)) end)
11897 (outline-next-heading)
11898 (setq end (point))
11899 (goto-char beg)
11900 (if (org-list-search-forward
11901 (concat (org-item-beginning-re)
11904 end t)
11905 (progn
11906 (if (boundp 'org-blocked-by-checkboxes)
11907 (setq org-blocked-by-checkboxes t))
11908 (throw 'dont-block nil)))))
11909 t))) ; do not block
11911 (defun org-entry-blocked-p ()
11912 "Is the current entry blocked?"
11913 (if (org-entry-get nil "NOBLOCKING")
11914 nil ;; Never block this entry
11915 (not
11916 (run-hook-with-args-until-failure
11917 'org-blocker-hook
11918 (list :type 'todo-state-change
11919 :position (point)
11920 :from 'todo
11921 :to 'done)))))
11923 (defun org-update-statistics-cookies (all)
11924 "Update the statistics cookie, either from TODO or from checkboxes.
11925 This should be called with the cursor in a line with a statistics cookie."
11926 (interactive "P")
11927 (if all
11928 (progn
11929 (org-update-checkbox-count 'all)
11930 (org-map-entries 'org-update-parent-todo-statistics))
11931 (if (not (org-at-heading-p))
11932 (org-update-checkbox-count)
11933 (let ((pos (move-marker (make-marker) (point)))
11934 end l1 l2)
11935 (ignore-errors (org-back-to-heading t))
11936 (if (not (org-at-heading-p))
11937 (org-update-checkbox-count)
11938 (setq l1 (org-outline-level))
11939 (setq end (save-excursion
11940 (outline-next-heading)
11941 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11942 (point)))
11943 (if (and (save-excursion
11944 (re-search-forward
11946 (not (save-excursion (re-search-forward
11948 (org-update-checkbox-count)
11949 (if (and l2 (> l2 l1))
11950 (progn
11951 (goto-char end)
11952 (org-update-parent-todo-statistics))
11953 (goto-char pos)
11954 (beginning-of-line 1)
11955 (while (re-search-forward
11957 (point-at-eol) t)
11958 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11959 (goto-char pos)
11960 (move-marker pos nil)))))
11962 (defvar org-entry-property-inherited-from) ;; defined below
11963 (defun org-update-parent-todo-statistics ()
11964 "Update any statistics cookie in the parent of the current headline.
11965 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11966 the entire subtree and this will travel up the hierarchy and update
11967 statistics everywhere."
11968 (let* ((prop (save-excursion (org-up-heading-safe)
11969 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11970 (recursive (or (not org-hierarchical-todo-statistics)
11972 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11973 0))
11974 (first t)
11976 level ltoggle l1 new ndel
11977 (cnt-all 0) (cnt-done 0) is-percent kwd
11978 checkbox-beg ov ovs ove cookie-present)
11979 (catch 'exit
11980 (save-excursion
11981 (beginning-of-line 1)
11982 (setq ltoggle (funcall outline-level))
11983 ;; Three situations are to consider:
11985 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11986 ;; to the top-level ancestor on the headline;
11988 ;; 2. If parent has "recursive" property, repeat up to the
11989 ;; headline setting that property, taking inheritance into
11990 ;; account;
11992 ;; 3. Else, move up to direct parent and proceed only once.
11993 (while (and (setq level (org-up-heading-safe))
11994 (or recursive first)
11995 (>= (point) lim))
11996 (setq first nil cookie-present nil)
11997 (unless (and level
11998 (not (string-match
12000 (downcase (or (org-entry-get nil "COOKIE_DATA")
12001 "")))))
12002 (throw 'exit nil))
12003 (while (re-search-forward box-re (point-at-eol) t)
12004 (setq cnt-all 0 cnt-done 0 cookie-present t)
12005 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12006 (save-match-data
12007 (unless (outline-next-heading) (throw 'exit nil))
12008 (while (and (looking-at org-complex-heading-regexp)
12009 (> (setq l1 (length (match-string 1))) level))
12010 (setq kwd (and (or recursive (= l1 ltoggle))
12011 (match-string 2)))
12012 (if (or (eq org-provide-todo-statistics 'all-headlines)
12013 (and (listp org-provide-todo-statistics)
12014 (or (member kwd org-provide-todo-statistics)
12015 (member kwd org-done-keywords))))
12016 (setq cnt-all (1+ cnt-all))
12017 (if (eq org-provide-todo-statistics t)
12018 (and kwd (setq cnt-all (1+ cnt-all)))))
12019 (and (member kwd org-done-keywords)
12020 (setq cnt-done (1+ cnt-done)))
12021 (outline-next-heading)))
12022 (setq new
12023 (if is-percent
12024 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12025 (format "[%d/%d]" cnt-done cnt-all))
12026 ndel (- (match-end 0) checkbox-beg))
12027 ;; handle overlays when updating cookie from column view
12028 (when (setq ov (car (overlays-at checkbox-beg)))
12029 (setq ovs (overlay-start ov) ove (overlay-end ov))
12030 (delete-overlay ov))
12031 (goto-char checkbox-beg)
12032 (insert new)
12033 (delete-region (point) (+ (point) ndel))
12034 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12035 (when ov (move-overlay ov ovs ove)))
12036 (when cookie-present
12037 (run-hook-with-args 'org-after-todo-statistics-hook
12038 cnt-done (- cnt-all cnt-done))))))
12039 (run-hooks 'org-todo-statistics-hook)))
12041 (defvar org-after-todo-statistics-hook nil
12042 "Hook that is called after a TODO statistics cookie has been updated.
12043 Each function is called with two arguments: the number of not-done entries
12044 and the number of done entries.
12046 For example, the following function, when added to this hook, will switch
12047 an entry to DONE when all children are done, and back to TODO when new
12048 entries are set to a TODO status. Note that this hook is only called
12049 when there is a statistics cookie in the headline!
12051 (defun org-summary-todo (n-done n-not-done)
12053 (let (org-log-done org-log-states) ; turn off logging
12055 ")
12057 (defvar org-todo-statistics-hook nil
12058 "Hook that is run whenever Org thinks TODO statistics should be updated.
12059 This hook runs even if there is no statistics cookie present, in which case
12060 `org-after-todo-statistics-hook' would not run.")
12062 (defun org-todo-trigger-tag-changes (state)
12063 "Apply the changes defined in `org-todo-state-tags-triggers'."
12064 (let ((l org-todo-state-tags-triggers)
12065 changes)
12066 (when (or (not state) (equal state ""))
12067 (setq changes (append changes (cdr (assoc "" l)))))
12068 (when (and (stringp state) (> (length state) 0))
12069 (setq changes (append changes (cdr (assoc state l)))))
12070 (when (member state org-not-done-keywords)
12071 (setq changes (append changes (cdr (assoc 'todo l)))))
12072 (when (member state org-done-keywords)
12073 (setq changes (append changes (cdr (assoc 'done l)))))
12074 (dolist (c changes)
12075 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12077 (defun org-local-logging (value)
12078 "Get logging settings from a property VALUE."
12079 (let* (words w a)
12080 ;; directly set the variables, they are already local.
12081 (setq org-log-done nil
12082 org-log-repeat nil
12083 org-todo-log-states nil)
12084 (setq words (org-split-string value))
12085 (while (setq w (pop words))
12086 (cond
12087 ((setq a (assoc w org-startup-options))
12088 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12089 (set (nth 1 a) (nth 2 a))))
12090 ((setq a (org-extract-log-state-settings w))
12091 (and (member (car a) org-todo-keywords-1)
12092 (push a org-todo-log-states)))))))
12094 (defun org-get-todo-sequence-head (kwd)
12095 "Return the head of the TODO sequence to which KWD belongs.
12096 If KWD is not set, check if there is a text property remembering the
12097 right sequence."
12098 (let (p)
12099 (cond
12100 ((not kwd)
12101 (or (get-text-property (point-at-bol) 'org-todo-head)
12102 (progn
12103 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12104 nil (point-at-eol)))
12105 (get-text-property p 'org-todo-head))))
12106 ((not (member kwd org-todo-keywords-1))
12107 (car org-todo-keywords-1))
12108 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12110 (defun org-fast-todo-selection ()
12111 "Fast TODO keyword selection with single keys.
12112 Returns the new TODO keyword, or nil if no state change should occur."
12113 (let* ((fulltable org-todo-key-alist)
12114 (done-keywords org-done-keywords) ;; needed for the faces.
12115 (maxlen (apply 'max (mapcar
12116 (lambda (x)
12117 (if (stringp (car x)) (string-width (car x)) 0))
12118 fulltable)))
12119 (expert nil)
12120 (fwidth (+ maxlen 3 1 3))
12121 (ncol (/ (- (window-width) 4) fwidth))
12122 tg cnt e c tbl
12123 groups ingroup)
12124 (save-excursion
12125 (save-window-excursion
12126 (if expert
12127 (set-buffer (get-buffer-create " *Org todo*"))
12128 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12129 (erase-buffer)
12130 (org-set-local 'org-done-keywords done-keywords)
12131 (setq tbl fulltable cnt 0)
12132 (while (setq e (pop tbl))
12133 (cond
12134 ((equal e '(:startgroup))
12135 (push '() groups) (setq ingroup t)
12136 (when (not (= cnt 0))
12137 (setq cnt 0)
12139 (insert "{ "))
12140 ((equal e '(:endgroup))
12141 (setq ingroup nil cnt 0)
12143 ((equal e '(:newline))
12144 (when (not (= cnt 0))
12145 (setq cnt 0)
12147 (setq e (car tbl))
12148 (while (equal (car tbl) '(:newline))
12150 (setq tbl (cdr tbl)))))
12151 (t
12152 (setq tg (car e) c (cdr e))
12153 (if ingroup (push tg (car groups)))
12154 (setq tg (org-add-props tg nil 'face
12155 (org-get-todo-face tg)))
12156 (if (and (= cnt 0) (not ingroup)) (insert " "))
12157 (insert "[" c "] " tg (make-string
12158 (- fwidth 4 (length tg)) ?\ ))
12159 (when (= (setq cnt (1+ cnt)) ncol)
12161 (if ingroup (insert " "))
12162 (setq cnt 0)))))
12164 (goto-char (point-min))
12165 (if (not expert) (org-fit-window-to-buffer))
12166 (message "[a-z..]:Set [SPC]:clear")
12167 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12168 (cond
12169 ((or (= c ?\C-g)
12170 (and (= c ?q) (not (rassoc c fulltable))))
12171 (setq quit-flag t))
12172 ((= c ?\ ) nil)
12173 ((setq e (rassoc c fulltable) tg (car e))
12174 tg)
12175 (t (setq quit-flag t)))))))
12177 (defun org-entry-is-todo-p ()
12178 (member (org-get-todo-state) org-not-done-keywords))
12180 (defun org-entry-is-done-p ()
12181 (member (org-get-todo-state) org-done-keywords))
12183 (defun org-get-todo-state ()
12184 (save-excursion
12185 (org-back-to-heading t)
12186 (and (looking-at org-todo-line-regexp)
12187 (match-end 2)
12188 (match-string 2))))
12190 (defun org-at-date-range-p (&optional inactive-ok)
12191 "Is the cursor inside a date range?"
12192 (interactive)
12193 (save-excursion
12194 (catch 'exit
12195 (let ((pos (point)))
12197 (skip-chars-backward "<[")
12198 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12199 (>= (match-end 0) pos)
12200 (throw 'exit t))
12202 (skip-chars-backward "<[")
12203 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12204 (>= (match-end 0) pos)
12205 (throw 'exit t)))
12206 nil)))
12208 (defun org-get-repeat (&optional tagline)
12209 "Check if there is a deadline/schedule with repeater in this entry."
12210 (save-match-data
12211 (save-excursion
12212 (org-back-to-heading t)
12213 (and (re-search-forward (if tagline
12215 org-repeat-re)
12216 (org-entry-end-position) t)
12217 (match-string-no-properties 1)))))
12219 (defvar org-last-changed-timestamp)
12220 (defvar org-last-inserted-timestamp)
12221 (defvar org-log-post-message)
12222 (defvar org-log-note-purpose)
12223 (defvar org-log-note-how)
12224 (defvar org-log-note-extra)
12225 (defun org-auto-repeat-maybe (done-word)
12226 "Check if the current headline contains a repeated deadline/schedule.
12227 If yes, set TODO state back to what it was and change the base date
12228 of repeating deadline/scheduled time stamps to new date.
12229 This function is run automatically after each state change to a DONE state."
12230 ;; last-state is dynamically scoped into this function
12231 (let* ((repeat (org-get-repeat))
12232 (aa (assoc org-last-state org-todo-kwd-alist))
12233 (interpret (nth 1 aa))
12234 (head (nth 2 aa))
12235 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12236 (msg "Entry repeats: ")
12237 (org-log-done nil)
12238 (org-todo-log-states nil)
12239 re type n what ts time to-state)
12240 (when repeat
12241 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12242 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12243 org-todo-repeat-to-state))
12244 (unless (and to-state (member to-state org-todo-keywords-1))
12245 (setq to-state (if (eq interpret 'type) org-last-state head)))
12246 (org-todo to-state)
12247 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12248 (org-entry-put nil "LAST_REPEAT" (format-time-string
12249 (org-time-stamp-format t t))))
12250 (when org-log-repeat
12251 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12252 (memq 'org-add-log-note post-command-hook))
12253 ;; OK, we are already setup for some record
12254 (if (eq org-log-repeat 'note)
12255 ;; make sure we take a note, not only a time stamp
12256 (setq org-log-note-how 'note))
12257 ;; Set up for taking a record
12258 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12259 org-last-state
12260 'findpos org-log-repeat)))
12261 (org-back-to-heading t)
12262 (org-add-planning-info nil nil 'closed)
12266 (while (re-search-forward
12267 re (save-excursion (outline-next-heading) (point)) t)
12268 (setq type (if (match-end 1) org-scheduled-string
12269 (if (match-end 3) org-deadline-string "Plain:"))
12270 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12272 (setq n (string-to-number (match-string 2 ts))
12273 what (match-string 3 ts))
12274 (if (equal what "w") (setq n (* n 7) what "d"))
12276 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12277 ;; Preparation, see if we need to modify the start date for the change
12278 (when (match-end 1)
12279 (setq time (save-match-data (org-time-string-to-time ts)))
12280 (cond
12281 ((equal (match-string 1 ts) ".")
12282 ;; Shift starting date to today
12283 (org-timestamp-change
12284 (- (org-today) (time-to-days time))
12285 'day))
12286 ((equal (match-string 1 ts) "+")
12287 (let ((nshiftmax 10) (nshift 0))
12288 (while (or (= nshift 0)
12289 (<= (time-to-days time)
12290 (time-to-days (current-time))))
12291 (when (= (incf nshift) nshiftmax)
12292 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12293 (error "Abort")))
12294 (org-timestamp-change n (cdr (assoc what whata)))
12295 (org-at-timestamp-p t)
12296 (setq ts (match-string 1))
12297 (setq time (save-match-data (org-time-string-to-time ts)))))
12298 (org-timestamp-change (- n) (cdr (assoc what whata)))
12299 ;; rematch, so that we have everything in place for the real shift
12300 (org-at-timestamp-p t)
12301 (setq ts (match-string 1))
12303 (org-timestamp-change n (cdr (assoc what whata)))
12304 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12305 (setq org-log-post-message msg)
12306 (message "%s" msg))))
12308 (defun org-show-todo-tree (arg)
12309 "Make a compact tree which shows all headlines marked with TODO.
12310 The tree will show the lines where the regexp matches, and all higher
12311 headlines above the match.
12313 With a numeric prefix N, construct a sparse tree for the Nth element
12314 of `org-todo-keywords-1'."
12315 (interactive "P")
12316 (let ((case-fold-search nil)
12317 (kwd-re
12318 (cond ((null arg) org-not-done-regexp)
12319 ((equal arg '(4))
12320 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12321 (mapcar 'list org-todo-keywords-1))))
12325 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12326 (regexp-quote (nth (1- (prefix-numeric-value arg))
12327 org-todo-keywords-1)))
12328 (t (error "Invalid prefix argument: %s" arg)))))
12329 (message "%d TODO entries found"
12330 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12332 (defun org-deadline (&optional remove time)
12334 With argument REMOVE, remove any deadline from the item.
12335 With argument TIME, set the deadline at the corresponding date. TIME
12337 (interactive "P")
12338 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12339 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12340 'region-start-level 'region))
12341 org-loop-over-headlines-in-active-region)
12342 (org-map-entries
12343 `(org-deadline ',remove ,time)
12344 org-loop-over-headlines-in-active-region
12345 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12346 (let* ((old-date (org-entry-get nil "DEADLINE"))
12347 (repeater (and old-date
12348 (string-match
12350 old-date)
12351 (match-string 1 old-date))))
12352 (if remove
12353 (progn
12354 (when (and old-date org-log-redeadline)
12355 (org-add-log-setup 'deldeadline nil old-date 'findpos
12356 org-log-redeadline))
12357 (org-remove-timestamp-with-keyword org-deadline-string)
12358 (message "Item no longer has a deadline."))
12359 (org-add-planning-info 'deadline time 'closed)
12360 (when (and old-date org-log-redeadline
12361 (not (equal old-date
12362 (substring org-last-inserted-timestamp 1 -1))))
12363 (org-add-log-setup 'redeadline nil old-date 'findpos
12364 org-log-redeadline))
12365 (when repeater
12366 (save-excursion
12367 (org-back-to-heading t)
12368 (when (re-search-forward (concat org-deadline-string " "
12369 org-last-inserted-timestamp)
12370 (save-excursion
12371 (outline-next-heading) (point)) t)
12372 (goto-char (1- (match-end 0)))
12373 (insert " " repeater)
12374 (setq org-last-inserted-timestamp
12375 (concat (substring org-last-inserted-timestamp 0 -1)
12376 " " repeater
12377 (substring org-last-inserted-timestamp -1))))))
12378 (message "Deadline on %s" org-last-inserted-timestamp)))))
12380 (defun org-schedule (&optional remove time)
12381 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12382 With argument REMOVE, remove any scheduling date from the item.
12383 With argument TIME, scheduled at the corresponding date. TIME can
12385 (interactive "P")
12386 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12387 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12388 'region-start-level 'region))
12389 org-loop-over-headlines-in-active-region)
12390 (org-map-entries
12391 `(org-schedule ',remove ,time)
12392 org-loop-over-headlines-in-active-region
12393 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12394 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12395 (repeater (and old-date
12396 (string-match
12398 old-date)
12399 (match-string 1 old-date))))
12400 (if remove
12401 (progn
12402 (when (and old-date org-log-reschedule)
12403 (org-add-log-setup 'delschedule nil old-date 'findpos
12404 org-log-reschedule))
12405 (org-remove-timestamp-with-keyword org-scheduled-string)
12406 (message "Item is no longer scheduled."))
12407 (org-add-planning-info 'scheduled time 'closed)
12408 (when (and old-date org-log-reschedule
12409 (not (equal old-date
12410 (substring org-last-inserted-timestamp 1 -1))))
12411 (org-add-log-setup 'reschedule nil old-date 'findpos
12412 org-log-reschedule))
12413 (when repeater
12414 (save-excursion
12415 (org-back-to-heading t)
12416 (when (re-search-forward (concat org-scheduled-string " "
12417 org-last-inserted-timestamp)
12418 (save-excursion
12419 (outline-next-heading) (point)) t)
12420 (goto-char (1- (match-end 0)))
12421 (insert " " repeater)
12422 (setq org-last-inserted-timestamp
12423 (concat (substring org-last-inserted-timestamp 0 -1)
12424 " " repeater
12425 (substring org-last-inserted-timestamp -1))))))
12426 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12428 (defun org-get-scheduled-time (pom &optional inherit)
12429 "Get the scheduled time as a time tuple, of a format suitable
12430 for calling org-schedule with, or if there is no scheduling,
12431 returns nil."
12432 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12433 (when time
12434 (apply 'encode-time (org-parse-time-string time)))))
12436 (defun org-get-deadline-time (pom &optional inherit)
12437 "Get the deadline as a time tuple, of a format suitable for
12438 calling org-deadline with, or if there is no scheduling, returns
12439 nil."
12440 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12441 (when time
12442 (apply 'encode-time (org-parse-time-string time)))))
12444 (defun org-remove-timestamp-with-keyword (keyword)
12445 "Remove all time stamps with KEYWORD in the current entry."
12447 beg)
12448 (save-excursion
12449 (org-back-to-heading t)
12450 (setq beg (point))
12451 (outline-next-heading)
12452 (while (re-search-backward re beg t)
12453 (replace-match "")
12455 (equal (char-before) ?\ ))
12456 (backward-delete-char 1)
12458 (point-at-bol) (point-at-eol)))
12459 (delete-region (point-at-bol)
12460 (min (point-max) (1+ (point-at-eol))))))))))
12462 (defun org-add-planning-info (what &optional time &rest remove)
12463 "Insert new timestamp with keyword in the line directly after the headline.
12464 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12465 If non is given, the user is prompted for a date.
12466 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12467 be removed."
12468 (interactive)
12469 (let (org-time-was-given org-end-time-was-given ts
12470 end default-time default-input)
12472 (catch 'exit
12473 (when (and (memq what '(scheduled deadline))
12474 (or (not time)
12475 (and (stringp time)
12476 (string-match "^[-+]+[0-9]" time))))
12477 ;; Try to get a default date/time from existing timestamp
12478 (save-excursion
12479 (org-back-to-heading t)
12480 (setq end (save-excursion (outline-next-heading) (point)))
12481 (when (re-search-forward (if (eq what 'scheduled)
12482 org-scheduled-time-regexp
12483 org-deadline-time-regexp)
12484 end t)
12485 (setq ts (match-string 1)
12486 default-time
12487 (apply 'encode-time (org-parse-time-string ts))
12488 default-input (and ts (org-get-compact-tod ts))))))
12489 (when what
12490 (setq time
12491 (if (stringp time)
12492 ;; This is a string (relative or absolute), set proper date
12493 (apply 'encode-time
12494 (org-read-date-analyze
12495 time default-time (decode-time default-time)))
12496 ;; If necessary, get the time from the user
12497 (or time (org-read-date nil 'to-time nil nil
12498 default-time default-input)))))
12500 (when (and org-insert-labeled-timestamps-at-point
12501 (member what '(scheduled deadline)))
12502 (insert
12503 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12504 (org-insert-time-stamp time org-time-was-given
12505 nil nil nil (list org-end-time-was-given))
12506 (setq what nil))
12507 (save-excursion
12508 (save-restriction
12509 (let (col list elt ts buffer-invisibility-spec)
12510 (org-back-to-heading t)
12512 (goto-char (match-end 1))
12513 (setq col (current-column))
12514 (goto-char (match-end 0))
12516 (when (and (not what)
12517 (not (looking-at
12519 org-keyword-time-not-clock-regexp))))
12520 ;; Nothing to add, nothing to remove...... :-)
12521 (throw 'exit nil))
12522 (if (and (not (looking-at org-outline-regexp))
12525 (not (equal (match-string 1) org-clock-string)))
12526 (narrow-to-region (match-beginning 0) (match-end 0))
12528 (backward-char 1)
12529 (narrow-to-region (point) (point))
12530 (and org-adapt-indentation (org-indent-to-column col)))
12531 ;; Check if we have to remove something.
12532 (setq list (cons what remove))
12533 (while list
12534 (setq elt (pop list))
12535 (when (or (and (eq elt 'scheduled)
12536 (re-search-forward org-scheduled-time-regexp nil t))
12537 (and (eq elt 'deadline)
12538 (re-search-forward org-deadline-time-regexp nil t))
12539 (and (eq elt 'closed)
12540 (re-search-forward org-closed-time-regexp nil t)))
12541 (replace-match "")
12542 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12544 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12545 (when what
12546 (insert
12547 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12548 (cond ((eq what 'scheduled) org-scheduled-string)
12549 ((eq what 'deadline) org-deadline-string)
12550 ((eq what 'closed) org-closed-string))
12551 " ")
12552 (setq ts (org-insert-time-stamp
12553 time
12554 (or org-time-was-given
12555 (and (eq what 'closed) org-log-done-with-time))
12556 (eq what 'closed)
12557 nil nil (list org-end-time-was-given)))
12558 (insert
12559 (if (not (or (bolp) (eq (char-before) ?\ )
12560 (memq (char-after) '(32 10))
12561 (eobp))) " " ""))
12562 (end-of-line 1))
12563 (goto-char (point-min))
12564 (widen)
12567 (delete-region (1- (point)) (point-at-eol)))
12568 ts))))))
12570 (defvar org-log-note-marker (make-marker))
12571 (defvar org-log-note-purpose nil)
12572 (defvar org-log-note-state nil)
12573 (defvar org-log-note-previous-state nil)
12574 (defvar org-log-note-how nil)
12575 (defvar org-log-note-extra nil)
12576 (defvar org-log-note-window-configuration nil)
12577 (defvar org-log-note-return-to (make-marker))
12578 (defvar org-log-note-effective-time nil
12579 "Remembered current time so that dynamically scoped
12580 `org-extend-today-until' affects tha timestamps in state change
12581 log")
12583 (defvar org-log-post-message nil
12584 "Message to be displayed after a log note has been stored.
12585 The auto-repeater uses this.")
12587 (defun org-add-note ()
12588 "Add a note to the current entry.
12589 This is done in the same way as adding a state change note."
12590 (interactive)
12591 (org-add-log-setup 'note nil nil 'findpos nil))
12593 (defvar org-property-end-re)
12594 (defun org-add-log-setup (&optional purpose state prev-state
12595 findpos how extra)
12596 "Set up the post command hook to take a note.
12597 If this is about to TODO state change, the new state is expected in STATE.
12598 When FINDPOS is non-nil, find the correct position for the note in
12599 the current entry. If not, assume that it can be inserted at point.
12600 HOW is an indicator what kind of note should be created.
12601 EXTRA is additional text that will be inserted into the notes buffer."
12602 (let* ((org-log-into-drawer (org-log-into-drawer))
12603 (drawer (cond ((stringp org-log-into-drawer)
12604 org-log-into-drawer)
12605 (org-log-into-drawer "LOGBOOK"))))
12606 (save-restriction
12607 (save-excursion
12608 (when findpos
12609 (org-back-to-heading t)
12610 (narrow-to-region (point) (save-excursion
12611 (outline-next-heading) (point)))
12615 (goto-char (match-end 0))
12616 (cond
12617 (drawer
12619 nil t)
12620 (progn
12621 (goto-char (match-end 0))
12622 (or org-log-states-order-reversed
12623 (and (re-search-forward org-property-end-re nil t)
12624 (goto-char (1- (match-beginning 0))))))
12626 (beginning-of-line 0)
12627 (org-indent-line)
12628 (beginning-of-line 2)
12629 (org-indent-line)
12630 (end-of-line 0)))
12631 ((and org-log-state-notes-insert-after-drawers
12632 (save-excursion
12633 (forward-line) (looking-at org-drawer-regexp)))
12634 (forward-line)
12635 (while (looking-at org-drawer-regexp)
12636 (goto-char (match-end 0))
12637 (re-search-forward org-property-end-re (point-max) t)
12638 (forward-line))
12639 (forward-line -1)))
12640 (unless org-log-states-order-reversed
12642 (org-skip-over-state-notes)
12644 (move-marker org-log-note-marker (point))
12645 (setq org-log-note-purpose purpose
12646 org-log-note-state state
12647 org-log-note-previous-state prev-state
12648 org-log-note-how how
12649 org-log-note-extra extra
12650 org-log-note-effective-time (org-current-effective-time))
12651 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12653 (defun org-skip-over-state-notes ()
12654 "Skip past the list of State notes in an entry."
12656 (when (ignore-errors (goto-char (org-in-item-p)))
12657 (let* ((struct (org-list-struct))
12658 (prevs (org-list-prevs-alist struct)))
12660 (goto-char (or (org-list-get-next-item (point) struct prevs)
12661 (org-list-get-item-end (point) struct)))))))
12663 (defun org-add-log-note (&optional purpose)
12664 "Pop up a window for taking a note, and add this note later at point."
12665 (remove-hook 'post-command-hook 'org-add-log-note)
12666 (setq org-log-note-window-configuration (current-window-configuration))
12667 (delete-other-windows)
12668 (move-marker org-log-note-return-to (point))
12669 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12670 (goto-char org-log-note-marker)
12671 (org-switch-to-buffer-other-window "*Org Note*")
12672 (erase-buffer)
12673 (if (memq org-log-note-how '(time state))
12674 (let (current-prefix-arg) (org-store-log-note))
12675 (let ((org-inhibit-startup t)) (org-mode))
12676 (insert (format "# Insert note for %s.
12678 (cond
12679 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12680 ((eq org-log-note-purpose 'done) "closed todo item")
12681 ((eq org-log-note-purpose 'state)
12683 (or org-log-note-previous-state "")
12684 (or org-log-note-state "")))
12685 ((eq org-log-note-purpose 'reschedule)
12686 "rescheduling")
12687 ((eq org-log-note-purpose 'delschedule)
12688 "no longer scheduled")
12689 ((eq org-log-note-purpose 'redeadline)
12690 "changing deadline")
12691 ((eq org-log-note-purpose 'deldeadline)
12692 "removing deadline")
12693 ((eq org-log-note-purpose 'refile)
12694 "refiling")
12695 ((eq org-log-note-purpose 'note)
12696 "this entry")
12697 (t (error "This should not happen")))))
12698 (if org-log-note-extra (insert org-log-note-extra))
12699 (org-set-local 'org-finish-function 'org-store-log-note)
12700 (run-hooks 'org-log-buffer-setup-hook)))
12702 (defvar org-note-abort nil) ; dynamically scoped
12703 (defun org-store-log-note ()
12704 "Finish taking a log note, and insert it to where it belongs."
12705 (let ((txt (buffer-string))
12706 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12707 lines ind bul)
12708 (kill-buffer (current-buffer))
12710 (setq txt (replace-match "" t t txt)))
12712 (setq txt (replace-match "" t t txt)))
12715 (setq note
12716 (org-replace-escapes
12717 note
12718 (list (cons "%u" (user-login-name))
12719 (cons "%U" user-full-name)
12720 (cons "%t" (format-time-string
12721 (org-time-stamp-format 'long 'inactive)
12722 org-log-note-effective-time))
12723 (cons "%T" (format-time-string
12724 (org-time-stamp-format 'long nil)
12725 org-log-note-effective-time))
12726 (cons "%d" (format-time-string
12727 (org-time-stamp-format nil 'inactive)
12728 org-log-note-effective-time))
12729 (cons "%D" (format-time-string
12730 (org-time-stamp-format nil nil)
12731 org-log-note-effective-time))
12732 (cons "%s" (if org-log-note-state
12734 ""))
12735 (cons "%S" (if org-log-note-previous-state
12739 (push note lines))
12740 (when (or current-prefix-arg org-note-abort)
12741 (when org-log-into-drawer
12742 (org-remove-empty-drawer-at
12743 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12744 org-log-note-marker))
12745 (setq lines nil))
12746 (when lines
12747 (with-current-buffer (marker-buffer org-log-note-marker)
12748 (save-excursion
12749 (goto-char org-log-note-marker)
12750 (move-marker org-log-note-marker nil)
12751 (end-of-line 1)
12753 (setq ind (save-excursion
12754 (if (ignore-errors (goto-char (org-in-item-p)))
12755 (let ((struct (org-list-struct)))
12756 (org-list-get-ind
12757 (org-list-get-top-point struct) struct))
12759 (cond
12760 ((and (org-at-heading-p)
12761 org-adapt-indentation)
12762 (1+ (org-current-level)))
12763 ((org-at-heading-p) 0)
12764 (t (org-get-indentation))))))
12765 (setq bul (org-list-bullet-string "-"))
12766 (org-indent-line-to ind)
12767 (insert bul (pop lines))
12768 (let ((ind-body (+ (length bul) ind)))
12769 (while lines
12771 (org-indent-line-to ind-body)
12772 (insert (pop lines))))
12773 (message "Note stored")
12774 (org-back-to-heading t)
12775 (org-cycle-hide-drawers 'children)))))
12776 (set-window-configuration org-log-note-window-configuration)
12777 (with-current-buffer (marker-buffer org-log-note-return-to)
12778 (goto-char org-log-note-return-to))
12779 (move-marker org-log-note-return-to nil)
12780 (and org-log-post-message (message "%s" org-log-post-message)))
12782 (defun org-remove-empty-drawer-at (drawer pos)
12783 "Remove an empty drawer DRAWER at position POS.
12784 POS may also be a marker."
12785 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12786 (save-excursion
12787 (save-restriction
12788 (widen)
12789 (goto-char pos)
12790 (if (org-in-regexp
12792 (replace-match ""))))))
12794 (defvar org-ts-type nil)
12795 (defun org-sparse-tree (&optional arg type)
12796 "Create a sparse tree, prompt for the details.
12797 This command can create sparse trees. You first need to select the type
12798 of match used to create the tree:
12800 t Show all TODO entries.
12801 T Show entries with a specific TODO keyword.
12802 m Show entries selected by a tags/property match.
12803 p Enter a property name and its value (both with completion on existing
12804 names/values) and show entries with that property.
12805 r Show entries matching a regular expression (`/' can be used as well).
12806 b Show deadlines and scheduled items before a date.
12807 a Show deadlines and scheduled items after a date.
12808 d Show deadlines due within `org-deadline-warning-days'.
12809 D Show deadlines and scheduled items between a date range."
12810 (interactive "P")
12811 (let (ans kwd value ts-type)
12812 (setq type (or type org-sparse-tree-default-date-type))
12813 (setq org-ts-type type)
12814 (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"
12815 (cond ((eq type 'all) "all timestamps")
12816 ((eq type 'scheduled) "only scheduled")
12817 ((eq type 'deadline) "only deadline")
12818 ((eq type 'active) "only active timestamps")
12819 ((eq type 'inactive) "only inactive timestamps")
12820 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
12821 (t "scheduled/deadline")))
12822 (setq ans (read-char-exclusive))
12823 (cond
12824 ((equal ans ?c)
12825 (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
12826 ((equal ans ?d)
12827 (call-interactively 'org-check-deadlines))
12828 ((equal ans ?b)
12829 (call-interactively 'org-check-before-date))
12830 ((equal ans ?a)
12831 (call-interactively 'org-check-after-date))
12832 ((equal ans ?D)
12833 (call-interactively 'org-check-dates-range))
12834 ((equal ans ?t)
12835 (org-show-todo-tree nil))
12836 ((equal ans ?T)
12837 (org-show-todo-tree '(4)))
12838 ((member ans '(?T ?m))
12839 (call-interactively 'org-match-sparse-tree))
12840 ((member ans '(?p ?P))
12841 (setq kwd (org-icompleting-read "Property: "
12842 (mapcar 'list (org-buffer-property-keys))))
12843 (setq value (org-icompleting-read "Value: "
12844 (mapcar 'list (org-property-values kwd))))
12847 (org-match-sparse-tree arg (concat kwd "=" value)))
12848 ((member ans '(?r ?R ?/))
12849 (call-interactively 'org-occur))
12852 (defvar org-occur-highlights nil
12853 "List of overlays used for occur matches.")
12854 (make-variable-buffer-local 'org-occur-highlights)
12855 (defvar org-occur-parameters nil
12856 "Parameters of the active org-occur calls.
12857 This is a list, each call to org-occur pushes as cons cell,
12858 containing the regular expression and the callback, onto the list.
12859 The list can contain several entries if `org-occur' has been called
12860 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12861 will only contain one set of parameters. When the highlights are
12862 removed (for example with `C-c C-c', or with the next edit (depending
12863 on `org-remove-highlights-with-change'), this variable is emptied
12864 as well.")
12865 (make-variable-buffer-local 'org-occur-parameters)
12867 (defun org-occur (regexp &optional keep-previous callback)
12868 "Make a compact tree which shows all matches of REGEXP.
12869 The tree will show the lines where the regexp matches, and all higher
12870 headlines above the match. It will also show the heading after the match,
12871 to make sure editing the matching entry is easy.
12872 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12873 call to `org-occur' will be kept, to allow stacking of calls to this
12874 command.
12875 If CALLBACK is non-nil, it is a function which is called to confirm
12876 that the match should indeed be shown."
12878 (when (equal regexp "")
12879 (error "Regexp cannot be empty"))
12880 (unless keep-previous
12881 (org-remove-occur-highlights nil nil t))
12882 (push (cons regexp callback) org-occur-parameters)
12883 (let ((cnt 0))
12884 (save-excursion
12885 (goto-char (point-min))
12886 (if (or (not keep-previous) ; do not want to keep
12887 (not org-occur-highlights)) ; no previous matches
12888 ;; hide everything
12889 (org-overview))
12890 (while (re-search-forward regexp nil t)
12891 (when (or (not callback)
12892 (save-match-data (funcall callback)))
12893 (setq cnt (1+ cnt))
12894 (when org-highlight-sparse-tree-matches
12895 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12896 (org-show-context 'occur-tree))))
12897 (when org-remove-highlights-with-change
12898 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12899 nil 'local))
12900 (unless org-sparse-tree-open-archived-trees
12901 (org-hide-archived-subtrees (point-min) (point-max)))
12902 (run-hooks 'org-occur-hook)
12903 (if (org-called-interactively-p 'interactive)
12904 (message "%d match(es) for regexp %s" cnt regexp))
12905 cnt))
12907 (defun org-occur-next-match (&optional n reset)
12908 "Function for `next-error-function' to find sparse tree matches.
12909 N is the number of matches to move, when negative move backwards.
12910 RESET is entirely ignored - this function always goes back to the
12911 starting point when no match is found."
12912 (let* ((limit (if (< n 0) (point-min) (point-max)))
12913 (search-func (if (< n 0)
12914 'previous-single-char-property-change
12915 'next-single-char-property-change))
12916 (n (abs n))
12917 (pos (point))
12918 p1)
12919 (catch 'exit
12920 (while (setq p1 (funcall search-func (point) 'org-type))
12921 (when (equal p1 limit)
12922 (goto-char pos)
12923 (error "No more matches"))
12924 (when (equal (get-char-property p1 'org-type) 'org-occur)
12925 (setq n (1- n))
12926 (when (= n 0)
12927 (goto-char p1)
12928 (throw 'exit (point))))
12929 (goto-char p1))
12930 (goto-char p1)
12931 (error "No more matches"))))
12933 (defun org-show-context (&optional key)
12934 "Make sure point and context are visible.
12935 How much context is shown depends upon the variables
12936 `org-show-hierarchy-above', `org-show-following-heading',
12937 `org-show-entry-below' and `org-show-siblings'."
12938 (let ((heading-p (org-at-heading-p t))
12939 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12940 (following-p (org-get-alist-option org-show-following-heading key))
12941 (entry-p (org-get-alist-option org-show-entry-below key))
12942 (siblings-p (org-get-alist-option org-show-siblings key)))
12943 (catch 'exit
12944 ;; Show heading or entry text
12945 (if (and heading-p (not entry-p))
12946 (org-flag-heading nil) ; only show the heading
12947 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12948 (org-show-hidden-entry))) ; show entire entry
12949 (when following-p
12950 ;; Show next sibling, or heading below text
12951 (save-excursion
12952 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12953 (org-flag-heading nil))))
12954 (when siblings-p (org-show-siblings))
12955 (when hierarchy-p
12956 ;; show all higher headings, possibly with siblings
12957 (save-excursion
12958 (while (and (condition-case nil
12959 (progn (org-up-heading-all 1) t)
12960 (error nil))
12961 (not (bobp)))
12962 (org-flag-heading nil)
12963 (when siblings-p (org-show-siblings))))))))
12965 (defvar org-reveal-start-hook nil
12966 "Hook run before revealing a location.")
12968 (defun org-reveal (&optional siblings)
12969 "Show current entry, hierarchy above it, and the following headline.
12970 This can be used to show a consistent set of context around locations
12971 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12972 not t for the search context.
12974 With optional argument SIBLINGS, on each level of the hierarchy all
12975 siblings are shown. This repairs the tree structure to what it would
12976 look like when opened with hierarchical calls to `org-cycle'.
12978 go to the parent and show the
12979 entire tree."
12980 (interactive "P")
12981 (run-hooks 'org-reveal-start-hook)
12982 (let ((org-show-hierarchy-above t)
12983 (org-show-following-heading t)
12984 (org-show-siblings (if siblings t org-show-siblings)))
12985 (org-show-context nil))
12986 (when (equal siblings '(16))
12987 (save-excursion
12988 (when (org-up-heading-safe)
12989 (org-show-subtree)
12990 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12992 (defun org-highlight-new-match (beg end)
12993 "Highlight from BEG to END and mark the highlight is an occur headline."
12994 (let ((ov (make-overlay beg end)))
12995 (overlay-put ov 'face 'secondary-selection)
12996 (overlay-put ov 'org-type 'org-occur)
12997 (push ov org-occur-highlights)))
12999 (defun org-remove-occur-highlights (&optional beg end noremove)
13000 "Remove the occur highlights from the buffer.
13001 BEG and END are ignored. If NOREMOVE is nil, remove this function
13002 from the `before-change-functions' in the current buffer."
13003 (interactive)
13004 (unless org-inhibit-highlight-removal
13005 (mapc 'delete-overlay org-occur-highlights)
13006 (setq org-occur-highlights nil)
13007 (setq org-occur-parameters nil)
13008 (unless noremove
13009 (remove-hook 'before-change-functions
13010 'org-remove-occur-highlights 'local))))
13012 ;;;; Priorities
13015 "Regular expression matching the priority indicator.")
13017 (defvar org-remove-priority-next-time nil)
13019 (defun org-priority-up ()
13020 "Increase the priority of the current item."
13021 (interactive)
13022 (org-priority 'up))
13024 (defun org-priority-down ()
13025 "Decrease the priority of the current item."
13026 (interactive)
13027 (org-priority 'down))
13029 (defun org-priority (&optional action)
13030 "Change the priority of an item.
13031 ACTION can be `set', `up', `down', or a character."
13032 (interactive)
13033 (unless org-enable-priority-commands
13034 (error "Priority commands are disabled"))
13035 (setq action (or action 'set))
13036 (let (current new news have remove)
13037 (save-excursion
13038 (org-back-to-heading t)
13039 (if (looking-at org-priority-regexp)
13040 (setq current (string-to-char (match-string 2))
13041 have t))
13042 (cond
13043 ((eq action 'remove)
13044 (setq remove t new ?\ ))
13045 ((or (eq action 'set)
13046 (if (featurep 'xemacs) (characterp action) (integerp action)))
13047 (if (not (eq action 'set))
13048 (setq new action)
13049 (message "Priority %c-%c, SPC to remove: "
13050 org-highest-priority org-lowest-priority)
13051 (save-match-data
13052 (setq new (read-char-exclusive))))
13053 (if (and (= (upcase org-highest-priority) org-highest-priority)
13054 (= (upcase org-lowest-priority) org-lowest-priority))
13055 (setq new (upcase new)))
13056 (cond ((equal new ?\ ) (setq remove t))
13057 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13058 (error "Priority must be between `%c' and `%c'"
13059 org-highest-priority org-lowest-priority))))
13060 ((eq action 'up)
13061 (setq new (if have
13062 (1- current) ; normal cycling
13063 ;; last priority was empty
13064 (if (eq last-command this-command)
13065 org-lowest-priority ; wrap around empty to lowest
13066 ;; default
13067 (if org-priority-start-cycle-with-default
13068 org-default-priority
13069 (1- org-default-priority))))))
13070 ((eq action 'down)
13071 (setq new (if have
13072 (1+ current) ; normal cycling
13073 ;; last priority was empty
13074 (if (eq last-command this-command)
13075 org-highest-priority ; wrap around empty to highest
13076 ;; default
13077 (if org-priority-start-cycle-with-default
13078 org-default-priority
13079 (1+ org-default-priority))))))
13080 (t (error "Invalid action")))
13081 (if (or (< (upcase new) org-highest-priority)
13082 (> (upcase new) org-lowest-priority))
13083 (if (and (memq action '(up down))
13084 (not have) (not (eq last-command this-command)))
13085 ;; `new' is from default priority
13086 (error
13087 "The default can not be set, see `org-default-priority' why")
13088 ;; normal cycling: `new' is beyond highest/lowest priority
13089 ;; and is wrapped around to the empty priority
13090 (setq remove t)))
13091 (setq news (format "%c" new))
13092 (if have
13093 (if remove
13094 (replace-match "" t t nil 1)
13095 (replace-match news t t nil 2))
13096 (if remove
13097 (error "No priority cookie found in line")
13098 (let ((case-fold-search nil))
13099 (looking-at org-todo-line-regexp))
13100 (if (match-end 2)
13101 (progn
13102 (goto-char (match-end 2))
13103 (insert " [#" news "]"))
13104 (goto-char (match-beginning 3))
13105 (insert "[#" news "] "))))
13106 (org-preserve-lc (org-set-tags nil 'align)))
13107 (if remove
13108 (message "Priority removed")
13109 (message "Priority of current item set to %s" news))))
13111 (defun org-get-priority (s)
13112 "Find priority cookie and return priority."
13113 (if (functionp org-get-priority-function)
13114 (funcall org-get-priority-function)
13115 (save-match-data
13116 (if (not (string-match org-priority-regexp s))
13117 (* 1000 (- org-lowest-priority org-default-priority))
13118 (* 1000 (- org-lowest-priority
13119 (string-to-char (match-string 2 s))))))))
13121 ;;;; Tags
13123 (defvar org-agenda-archives-mode)
13124 (defvar org-map-continue-from nil
13125 "Position from where mapping should continue.
13126 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13128 (defvar org-scanner-tags nil
13129 "The current tag list while the tags scanner is running.")
13130 (defvar org-trust-scanner-tags nil
13131 "Should `org-get-tags-at' use the tags for the scanner.
13132 This is for internal dynamical scoping only.
13133 When this is non-nil, the function `org-get-tags-at' will return the value
13134 of `org-scanner-tags' instead of building the list by itself. This
13135 can lead to large speed-ups when the tags scanner is used in a file with
13136 many entries, and when the list of tags is retrieved, for example to
13137 obtain a list of properties. Building the tags list for each entry in such
13138 a file becomes an N^2 operation - but with this variable set, it scales
13139 as N.")
13141 (defun org-scan-tags (action matcher todo-only &optional start-level)
13142 "Scan headline tags with inheritance and produce output ACTION.
13144 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13145 or `agenda' to produce an entry list for an agenda view. It can also be
13146 a Lisp form or a function that should be called at each matched headline, in
13147 this case the return value is a list of all return values from these calls.
13149 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13150 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13151 only lines with a not-done TODO keyword are included in the output.
13152 This should be the same variable that was scoped into
13153 and set by `org-make-tags-matcher' when it constructed MATCHER.
13155 START-LEVEL can be a string with asterisks, reducing the scope to
13156 headlines matching this string."
13157 (require 'org-agenda)
13158 (let* ((re (concat "^"
13159 (if start-level
13160 ;; Get the correct level to match
13162 org-outline-regexp)
13166 (props (list 'face 'default
13167 'done-face 'org-agenda-done
13168 'undone-face 'default
13169 'mouse-face 'highlight
13170 'org-not-done-regexp org-not-done-regexp
13171 'org-todo-regexp org-todo-regexp
13172 'org-complex-heading-regexp org-complex-heading-regexp
13173 'help-echo
13174 (format "mouse-2 or RET jump to org file %s"
13175 (abbreviate-file-name
13176 (or (buffer-file-name (buffer-base-buffer))
13177 (buffer-name (buffer-base-buffer)))))))
13178 (case-fold-search nil)
13179 (org-map-continue-from nil)
13180 lspos tags tags-list
13181 (tags-alist (list (cons 0 org-file-tags)))
13182 (llast 0) rtn rtn1 level category i txt
13183 todo marker entry priority)
13184 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13185 (setq action (list 'lambda nil action)))
13186 (save-excursion
13187 (goto-char (point-min))
13188 (when (eq action 'sparse-tree)
13189 (org-overview)
13190 (org-remove-occur-highlights))
13191 (while (re-search-forward re nil t)
13192 (setq org-map-continue-from nil)
13193 (catch :skip
13194 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13195 tags (if (match-end 4) (org-match-string-no-properties 4)))
13196 (goto-char (setq lspos (match-beginning 0)))
13197 (setq level (org-reduced-level (funcall outline-level))
13198 category (org-get-category))
13199 (setq i llast llast level)
13200 ;; remove tag lists from same and sublevels
13201 (while (>= i level)
13202 (when (setq entry (assoc i tags-alist))
13203 (setq tags-alist (delete entry tags-alist)))
13204 (setq i (1- i)))
13205 ;; add the next tags
13206 (when tags
13207 (setq tags (org-split-string tags ":")
13208 tags-alist
13209 (cons (cons level tags) tags-alist)))
13210 ;; compile tags for current headline
13211 (setq tags-list
13212 (if org-use-tag-inheritance
13213 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13214 tags)
13215 org-scanner-tags tags-list)
13216 (when org-use-tag-inheritance
13217 (setcdr (car tags-alist)
13218 (mapcar (lambda (x)
13219 (setq x (copy-sequence x))
13220 (org-add-prop-inherited x))
13221 (cdar tags-alist))))
13222 (when (and tags org-use-tag-inheritance
13223 (or (not (eq t org-use-tag-inheritance))
13224 org-tags-exclude-from-inheritance))
13225 ;; selective inheritance, remove uninherited ones
13226 (setcdr (car tags-alist)
13227 (org-remove-uninherited-tags (cdar tags-alist))))
13228 (when (and
13230 ;; eval matcher only when the todo condition is OK
13231 (and (or (not todo-only) (member todo org-not-done-keywords))
13232 (let ((case-fold-search t) (org-trust-scanner-tags t))
13233 (eval matcher)))
13235 ;; Call the skipper, but return t if it does not skip,
13236 ;; so that the `and' form continues evaluating
13237 (progn
13238 (unless (eq action 'sparse-tree) (org-agenda-skip))
13239 t)
13241 ;; Check if timestamps are deselecting this entry
13242 (or (not todo-only)
13243 (and (member todo org-not-done-keywords)
13244 (or (not org-agenda-tags-todo-honor-ignore-options)
13245 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
13247 ;; Extra check for the archive tag
13248 ;; FIXME: Does the skipper already do this????
13249 (or
13250 (not (member org-archive-tag tags-list))
13251 ;; we have an archive tag, should we use this anyway?
13252 (or (not org-agenda-skip-archived-trees)
13253 (and (eq action 'agenda) org-agenda-archives-mode))))
13255 ;; select this headline
13257 (cond
13258 ((eq action 'sparse-tree)
13259 (and org-highlight-sparse-tree-matches
13260 (org-get-heading) (match-end 0)
13261 (org-highlight-new-match
13262 (match-beginning 1) (match-end 1)))
13263 (org-show-context 'tags-tree))
13264 ((eq action 'agenda)
13265 (setq txt (org-agenda-format-item
13266 ""
13267 (concat
13268 (if (eq org-tags-match-list-sublevels 'indented)
13269 (make-string (1- level) ?.) "")
13270 (org-get-heading))
13271 category
13272 tags-list)
13273 priority (org-get-priority txt))
13274 (goto-char lspos)
13275 (setq marker (org-agenda-new-marker))
13276 (org-add-props txt props
13277 'org-marker marker 'org-hd-marker marker 'org-category category
13278 'todo-state todo
13279 'priority priority 'type "tagsmatch")
13280 (push txt rtn))
13281 ((functionp action)
13282 (setq org-map-continue-from nil)
13283 (save-excursion
13284 (setq rtn1 (funcall action))
13285 (push rtn1 rtn)))
13286 (t (error "Invalid action")))
13288 ;; if we are to skip sublevels, jump to end of subtree
13289 (unless org-tags-match-list-sublevels
13290 (org-end-of-subtree t)
13291 (backward-char 1))))
13292 ;; Get the correct position from where to continue
13293 (if org-map-continue-from
13294 (goto-char org-map-continue-from)
13295 (and (= (point) lspos) (end-of-line 1)))))
13296 (when (and (eq action 'sparse-tree)
13297 (not org-sparse-tree-open-archived-trees))
13298 (org-hide-archived-subtrees (point-min) (point-max)))
13299 (nreverse rtn)))
13301 (defun org-remove-uninherited-tags (tags)
13302 "Remove all tags that are not inherited from the list TAGS."
13303 (cond
13304 ((eq org-use-tag-inheritance t)
13305 (if org-tags-exclude-from-inheritance
13306 (org-delete-all org-tags-exclude-from-inheritance tags)
13307 tags))
13308 ((not org-use-tag-inheritance) nil)
13309 ((stringp org-use-tag-inheritance)
13310 (delq nil (mapcar
13311 (lambda (x)
13312 (if (and (string-match org-use-tag-inheritance x)
13313 (not (member x org-tags-exclude-from-inheritance)))
13314 x nil))
13315 tags)))
13316 ((listp org-use-tag-inheritance)
13317 (delq nil (mapcar
13318 (lambda (x)
13319 (if (member x org-use-tag-inheritance) x nil))
13320 tags)))))
13322 (defun org-match-sparse-tree (&optional todo-only match)
13323 "Create a sparse tree according to tags string MATCH.
13324 MATCH can contain positive and negative selection of tags, like
13326 If optional argument TODO-ONLY is non-nil, only select lines that are
13327 also TODO lines."
13328 (interactive "P")
13329 (org-prepare-agenda-buffers (list (current-buffer)))
13330 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13332 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13334 (defvar org-cached-props nil)
13335 (defun org-cached-entry-get (pom property)
13336 (if (or (eq t org-use-property-inheritance)
13337 (and (stringp org-use-property-inheritance)
13338 (string-match org-use-property-inheritance property))
13339 (and (listp org-use-property-inheritance)
13340 (member property org-use-property-inheritance)))
13341 ;; Caching is not possible, check it directly
13342 (org-entry-get pom property 'inherit)
13343 ;; Get all properties, so that we can do complicated checks easily
13344 (cdr (assoc property (or org-cached-props
13345 (setq org-cached-props
13346 (org-entry-properties pom)))))))
13348 (defun org-global-tags-completion-table (&optional files)
13349 "Return the list of all tags in all agenda buffer/files.
13350 Optional FILES argument is a list of files which can be used
13351 instead of the agenda files."
13352 (save-excursion
13353 (org-uniquify
13354 (delq nil
13355 (apply 'append
13356 (mapcar
13357 (lambda (file)
13358 (set-buffer (find-file-noselect file))
13359 (append (org-get-buffer-tags)
13360 (mapcar (lambda (x) (if (stringp (car-safe x))
13361 (list (car-safe x)) nil))
13362 org-tag-alist)))
13363 (if (and files (car files))
13364 files
13365 (org-agenda-files))))))))
13367 (defun org-make-tags-matcher (match)
13368 "Create the TAGS/TODO matcher form for the selection string MATCH.
13370 The variable `todo-only' is scoped dynamically into this function.
13371 It will be set to t if the matcher restricts matching to TODO entries,
13372 otherwise will not be touched.
13374 Returns a cons of the selection string MATCH and the constructed
13375 lisp form implementing the matcher. The matcher is to be evaluated
13376 at an Org entry, with point on the headline, and returns t if the
13377 entry matches the selection string MATCH. The returned lisp form
13378 references two variables with information about the entry, which
13379 must be bound around the form's evaluation: todo, the TODO keyword
13380 at the entry (or nil of none); and tags-list, the list of all tags
13381 at the entry including inherited ones. Additionally, the category
13382 of the entry (if any) must be specified as the text property
13383 'org-category on the headline.
13385 See also `org-scan-tags'.
13386 "
13387 (declare (special todo-only))
13388 (unless (boundp 'todo-only)
13389 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13390 (unless match
13391 ;; Get a new match request, with completion
13392 (let ((org-last-tags-completion-table
13393 (org-global-tags-completion-table)))
13394 (setq match (org-completing-read-no-i
13395 "Match: " 'org-tags-completion-function nil nil nil
13396 'org-tags-history))))
13398 ;; Parse the string and create a lisp form
13399 (let ((match0 match)
13400 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13401 minus tag mm
13402 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13403 orterms term orlist re-p str-p level-p level-op time-p
13404 prop-p pn pv po gv rest)
13405 (if (string-match "/+" match)
13406 ;; match contains also a todo-matching request
13407 (progn
13408 (setq tagsmatch (substring match 0 (match-beginning 0))
13409 todomatch (substring match (match-end 0)))
13410 (if (string-match "^!" todomatch)
13411 (setq todo-only t todomatch (substring todomatch 1)))
13413 (setq todomatch nil)))
13414 ;; only matching tags
13415 (setq tagsmatch match todomatch nil))
13417 ;; Make the tags matcher
13419 (setq tagsmatcher t)
13420 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13421 (while (setq term (pop orterms))
13423 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13424 (while (string-match re term)
13425 (setq rest (substring term (match-end 0))
13426 minus (and (match-end 1)
13427 (equal (match-string 1 term) "-"))
13428 tag (save-match-data (replace-regexp-in-string
13430 (match-string 2 term)))
13431 re-p (equal (string-to-char tag) ?{)
13432 level-p (match-end 4)
13433 prop-p (match-end 5)
13434 mm (cond
13435 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13436 (level-p
13437 (setq level-op (org-op-to-function (match-string 3 term)))
13438 `(,level-op level ,(string-to-number
13439 (match-string 4 term))))
13440 (prop-p
13441 (setq pn (match-string 5 term)
13442 po (match-string 6 term)
13443 pv (match-string 7 term)
13444 re-p (equal (string-to-char pv) ?{)
13446 time-p (save-match-data
13448 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13449 (if time-p (setq pv (org-matcher-time pv)))
13450 (setq po (org-op-to-function po (if time-p 'time str-p)))
13451 (cond
13452 ((equal pn "CATEGORY")
13453 (setq gv '(get-text-property (point) 'org-category)))
13454 ((equal pn "TODO")
13455 (setq gv 'todo))
13456 (t
13457 (setq gv `(org-cached-entry-get nil ,pn))))
13458 (if re-p
13459 (if (eq po 'org<>)
13460 `(not (string-match ,pv (or ,gv "")))
13461 `(string-match ,pv (or ,gv "")))
13462 (if str-p
13463 `(,po (or ,gv "") ,pv)
13464 `(,po (string-to-number (or ,gv ""))
13465 ,(string-to-number pv) ))))
13466 (t `(member ,tag tags-list)))
13467 mm (if minus (list 'not mm) mm)
13468 term rest)
13469 (push mm tagsmatcher))
13470 (push (if (> (length tagsmatcher) 1)
13471 (cons 'and tagsmatcher)
13472 (car tagsmatcher))
13473 orlist)
13474 (setq tagsmatcher nil))
13475 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13476 (setq tagsmatcher
13477 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13478 ;; Make the todo matcher
13480 (setq todomatcher t)
13481 (setq orterms (org-split-string todomatch "|") orlist nil)
13482 (while (setq term (pop orterms))
13483 (while (string-match re term)
13484 (setq minus (and (match-end 1)
13485 (equal (match-string 1 term) "-"))
13486 kwd (match-string 2 term)
13487 re-p (equal (string-to-char kwd) ?{)
13488 term (substring term (match-end 0))
13489 mm (if re-p
13490 `(string-match ,(substring kwd 1 -1) todo)
13491 (list 'equal 'todo kwd))
13492 mm (if minus (list 'not mm) mm))
13493 (push mm todomatcher))
13494 (push (if (> (length todomatcher) 1)
13495 (cons 'and todomatcher)
13496 (car todomatcher))
13497 orlist)
13498 (setq todomatcher nil))
13499 (setq todomatcher (if (> (length orlist) 1)
13500 (cons 'or orlist) (car orlist))))
13502 ;; Return the string and lisp forms of the matcher
13503 (setq matcher (if todomatcher
13504 (list 'and tagsmatcher todomatcher)
13505 tagsmatcher))
13506 (when todo-only
13507 (setq matcher (list 'and '(member todo org-not-done-keywords)
13508 matcher)))
13509 (cons match0 matcher)))
13511 (defun org-op-to-function (op &optional stringp)
13512 "Turn an operator into the appropriate function."
13513 (setq op
13514 (cond
13515 ((equal op "<" ) '(< string< org-time<))
13516 ((equal op ">" ) '(> org-string> org-time>))
13517 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13518 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13519 ((member op '("=" "==")) '(= string= org-time=))
13520 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13521 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13523 (defun org<> (a b) (not (= a b)))
13524 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13525 (defun org-string>= (a b) (not (string< a b)))
13526 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13527 (defun org-string<> (a b) (not (string= a b)))
13528 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13529 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13530 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13531 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13532 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13533 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13534 (defun org-2ft (s)
13535 "Convert S to a floating point time.
13536 If S is already a number, just return it. If it is a string, parse
13537 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13538 (cond
13539 ((numberp s) s)
13540 ((stringp s)
13541 (condition-case nil
13542 (float-time (apply 'encode-time (org-parse-time-string s)))
13543 (error 0.)))
13544 (t 0.)))
13546 (defun org-time-today ()
13547 "Time in seconds today at 0:00.
13548 Returns the float number of seconds since the beginning of the
13549 epoch to the beginning of today (00:00)."
13550 (float-time (apply 'encode-time
13551 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13553 (defun org-matcher-time (s)
13554 "Interpret a time comparison value."
13555 (save-match-data
13556 (cond
13557 ((string= s "<now>") (float-time))
13558 ((string= s "<today>") (org-time-today))
13559 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13560 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13562 (+ (org-time-today)
13563 (* (string-to-number (match-string 1 s))
13564 (cdr (assoc (match-string 2 s)
13565 '(("d" . 86400.0) ("w" . 604800.0)
13566 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13567 (t (org-2ft s)))))
13569 (defun org-match-any-p (re list)
13570 "Does re match any element of list?"
13571 (setq list (mapcar (lambda (x) (string-match re x)) list))
13572 (delq nil list))
13574 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13575 (defvar org-tags-overlay (make-overlay 1 1))
13576 (org-detach-overlay org-tags-overlay)
13578 (defun org-get-local-tags-at (&optional pos)
13579 "Get a list of tags defined in the current headline."
13580 (org-get-tags-at pos 'local))
13582 (defun org-get-local-tags ()
13583 "Get a list of tags defined in the current headline."
13584 (org-get-tags-at nil 'local))
13586 (defun org-get-tags-at (&optional pos local)
13587 "Get a list of all headline tags applicable at POS.
13588 POS defaults to point. If tags are inherited, the list contains
13589 the targets in the same sequence as the headlines appear, i.e.
13590 the tags of the current headline come last.
13591 When LOCAL is non-nil, only return tags from the current headline,
13592 ignore inherited ones."
13593 (interactive)
13594 (if (and org-trust-scanner-tags
13595 (or (not pos) (equal pos (point)))
13596 (not local))
13597 org-scanner-tags
13598 (let (tags ltags lastpos parent)
13599 (save-excursion
13600 (save-restriction
13601 (widen)
13602 (goto-char (or pos (point)))
13603 (save-match-data
13604 (catch 'done
13605 (condition-case nil
13606 (progn
13607 (org-back-to-heading t)
13608 (while (not (equal lastpos (point)))
13609 (setq lastpos (point))
13610 (when (looking-at
13612 (setq ltags (org-split-string
13613 (org-match-string-no-properties 1) ":"))
13614 (when parent
13615 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13616 (setq tags (append
13617 (if parent
13618 (org-remove-uninherited-tags ltags)
13619 ltags)
13620 tags)))
13621 (or org-use-tag-inheritance (throw 'done t))
13622 (if local (throw 'done t))
13623 (or (org-up-heading-safe) (error nil))
13624 (setq parent t)))
13625 (error nil)))))
13626 (if local
13627 tags
13628 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13630 (defun org-add-prop-inherited (s)
13631 (add-text-properties 0 (length s) '(inherited t) s)
13632 s)
13634 (defun org-toggle-tag (tag &optional onoff)
13635 "Toggle the tag TAG for the current line.
13636 If ONOFF is `on' or `off', don't toggle but set to this state."
13637 (let (res current)
13638 (save-excursion
13639 (org-back-to-heading t)
13641 (point-at-eol) t)
13642 (progn
13643 (setq current (match-string 1))
13644 (replace-match ""))
13645 (setq current ""))
13646 (setq current (nreverse (org-split-string current ":")))
13647 (cond
13648 ((eq onoff 'on)
13649 (setq res t)
13650 (or (member tag current) (push tag current)))
13651 ((eq onoff 'off)
13652 (or (not (member tag current)) (setq current (delete tag current))))
13653 (t (if (member tag current)
13654 (setq current (delete tag current))
13655 (setq res t)
13656 (push tag current))))
13657 (end-of-line 1)
13658 (if current
13659 (progn
13660 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13661 (org-set-tags nil t))
13662 (delete-horizontal-space))
13663 (run-hooks 'org-after-tags-change-hook))
13664 res))
13666 (defun org-align-tags-here (to-col)
13667 ;; Assumes that this is a headline
13668 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13669 (beginning-of-line 1)
13671 (< pos (match-beginning 2)))
13672 (progn
13673 (setq tags-l (- (match-end 2) (match-beginning 2)))
13674 (goto-char (match-beginning 1))
13675 (insert " ")
13676 (delete-region (point) (1+ (match-beginning 2)))
13677 (setq ncol (max (current-column)
13678 (1+ col)
13679 (if (> to-col 0)
13680 to-col
13681 (- (abs to-col) tags-l))))
13682 (setq p (point))
13683 (insert (make-string (- ncol (current-column)) ?\ ))
13684 (setq ncol (current-column))
13685 (when indent-tabs-mode (tabify p (point-at-eol)))
13686 (org-move-to-column (min ncol col) t))
13687 (goto-char pos))))
13689 (defun org-set-tags-command (&optional arg just-align)
13690 "Call the set-tags command for the current entry."
13691 (interactive "P")
13692 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13693 (org-set-tags arg just-align)
13694 (save-excursion
13695 (org-back-to-heading t)
13696 (org-set-tags arg just-align))))
13698 (defun org-set-tags-to (data)
13699 "Set the tags of the current entry to DATA, replacing the current tags.
13700 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13701 If DATA is nil or the empty string, any tags will be removed."
13702 (interactive "sTags: ")
13703 (setq data
13704 (cond
13705 ((eq data nil) "")
13706 ((equal data "") "")
13707 ((stringp data)
13708 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13709 ":"))
13710 ((listp data)
13711 (concat ":" (mapconcat 'identity data ":") ":"))))
13712 (when data
13713 (save-excursion
13714 (org-back-to-heading t)
13715 (when (looking-at org-complex-heading-regexp)
13716 (if (match-end 5)
13717 (progn
13718 (goto-char (match-beginning 5))
13719 (insert data)
13720 (delete-region (point) (point-at-eol))
13721 (org-set-tags nil 'align))
13722 (goto-char (point-at-eol))
13723 (insert " " data)
13724 (org-set-tags nil 'align)))
13725 (beginning-of-line 1)
13727 (delete-region (match-beginning 1) (match-end 1))))))
13729 (defun org-align-all-tags ()
13730 "Align the tags i all headings."
13731 (interactive)
13732 (save-excursion
13733 (or (ignore-errors (org-back-to-heading t))
13734 (outline-next-heading))
13735 (if (org-at-heading-p)
13736 (org-set-tags t)
13737 (message "No headings"))))
13739 (defvar org-indent-indentation-per-level)
13740 (defun org-set-tags (&optional arg just-align)
13741 "Set the tags for the current headline.
13742 With prefix ARG, realign all tags in headings in the current buffer."
13743 (interactive "P")
13744 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13745 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13746 'region-start-level 'region))
13747 org-loop-over-headlines-in-active-region)
13748 (org-map-entries
13749 ;; We don't use ARG and JUST-ALIGN here these args are not
13750 ;; useful when looping over headlines
13751 `(org-set-tags)
13752 org-loop-over-headlines-in-active-region
13753 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13754 (let* ((re org-outline-regexp-bol)
13755 (current (unless arg (org-get-tags-string)))
13756 (col (current-column))
13757 (org-setting-tags t)
13758 table current-tags inherited-tags ; computed below when needed
13759 tags p0 c0 c1 rpl di tc level)
13760 (if arg
13761 (save-excursion
13762 (goto-char (point-min))
13763 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13764 (while (re-search-forward re nil t)
13765 (org-set-tags nil t)
13766 (end-of-line 1)))
13767 (message "All tags realigned to column %d" org-tags-column))
13768 (if just-align
13769 (setq tags current)
13770 ;; Get a new set of tags from the user
13771 (save-excursion
13772 (setq table (append org-tag-persistent-alist
13773 (or org-tag-alist (org-get-buffer-tags))
13774 (and
13775 org-complete-tags-always-offer-all-agenda-tags
13776 (org-global-tags-completion-table
13777 (org-agenda-files))))
13778 org-last-tags-completion-table table
13779 current-tags (org-split-string current ":")
13780 inherited-tags (nreverse
13781 (nthcdr (length current-tags)
13782 (nreverse (org-get-tags-at))))
13783 tags
13784 (if (or (eq t org-use-fast-tag-selection)
13785 (and org-use-fast-tag-selection
13786 (delq nil (mapcar 'cdr table))))
13787 (org-fast-tag-selection
13788 current-tags inherited-tags table
13789 (if org-fast-tag-selection-include-todo
13790 org-todo-key-alist))
13791 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13792 (org-trim
13793 (org-icompleting-read "Tags: "
13794 'org-tags-completion-function
13795 nil nil current 'org-tags-history))))))
13796 (while (string-match "[-+&]+" tags)
13797 ;; No boolean logic, just a list
13798 (setq tags (replace-match ":" t t tags))))
13800 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13802 (if org-tags-sort-function
13803 (setq tags (mapconcat 'identity
13804 (sort (org-split-string
13805 tags (org-re "[^[:alnum:]_@#%]+"))
13806 org-tags-sort-function) ":")))
13809 (setq tags "")
13810 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13811 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13813 ;; Insert new tags at the correct column
13814 (beginning-of-line 1)
13815 (setq level (or (and (looking-at org-outline-regexp)
13816 (- (match-end 0) (point) 1))
13817 1))
13818 (cond
13819 ((and (equal current "") (equal tags "")))
13820 ((re-search-forward
13822 (point-at-eol) t)
13823 (if (equal tags "")
13824 (setq rpl "")
13825 (goto-char (match-beginning 0))
13826 (setq c0 (current-column)
13827 ;; compute offset for the case of org-indent-mode active
13828 di (if org-indent-mode
13829 (* (1- org-indent-indentation-per-level) (1- level))
13830 0)
13831 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13832 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13833 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13834 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13835 (replace-match rpl t t)
13836 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13837 tags)
13838 (t (error "Tags alignment failed")))
13839 (org-move-to-column col)
13840 (unless just-align
13841 (run-hooks 'org-after-tags-change-hook))))))
13843 (defun org-change-tag-in-region (beg end tag off)
13844 "Add or remove TAG for each entry in the region.
13845 This works in the agenda, and also in an org-mode buffer."
13846 (interactive
13847 (list (region-beginning) (region-end)
13848 (let ((org-last-tags-completion-table
13849 (if (derived-mode-p 'org-mode)
13850 (org-get-buffer-tags)
13851 (org-global-tags-completion-table))))
13852 (org-icompleting-read
13853 "Tag: " 'org-tags-completion-function nil nil nil
13854 'org-tags-history))
13855 (progn
13857 (equal (read-char-exclusive) ?r))))
13858 (if (fboundp 'deactivate-mark) (deactivate-mark))
13859 (let ((agendap (equal major-mode 'org-agenda-mode))
13860 l1 l2 m buf pos newhead (cnt 0))
13861 (goto-char end)
13862 (setq l2 (1- (org-current-line)))
13863 (goto-char beg)
13864 (setq l1 (org-current-line))
13865 (loop for l from l1 to l2 do
13866 (org-goto-line l)
13867 (setq m (get-text-property (point) 'org-hd-marker))
13868 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
13869 (and agendap m))
13870 (setq buf (if agendap (marker-buffer m) (current-buffer))
13871 pos (if agendap m (point)))
13872 (with-current-buffer buf
13873 (save-excursion
13874 (save-restriction
13875 (goto-char pos)
13876 (setq cnt (1+ cnt))
13877 (org-toggle-tag tag (if off 'off 'on))
13878 (setq newhead (org-get-heading)))))
13879 (and agendap (org-agenda-change-all-lines newhead m))))
13880 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13882 (defun org-tags-completion-function (string predicate &optional flag)
13883 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13884 (confirm (lambda (x) (stringp (car x)))))
13886 (setq s1 (match-string 1 string)
13887 s2 (match-string 2 string))
13888 (setq s1 "" s2 string))
13889 (cond
13890 ((eq flag nil)
13891 ;; try completion
13892 (setq rtn (try-completion s2 ctable confirm))
13893 (if (stringp rtn)
13894 (setq rtn
13895 (concat s1 s2 (substring rtn (length s2))
13896 (if (and org-add-colon-after-tag-completion
13897 (assoc rtn ctable))
13898 ":" ""))))
13899 rtn)
13900 ((eq flag t)
13901 ;; all-completions
13902 (all-completions s2 ctable confirm)
13903 )
13904 ((eq flag 'lambda)
13905 ;; exact match?
13906 (assoc s2 ctable)))
13907 ))
13909 (defun org-fast-tag-insert (kwd tags face &optional end)
13910 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13911 (insert (format "%-12s" (concat kwd ":"))
13912 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13913 (or end "")))
13915 (defun org-fast-tag-show-exit (flag)
13916 (save-excursion
13917 (org-goto-line 3)
13919 (replace-match ""))
13920 (when flag
13921 (end-of-line 1)
13922 (org-move-to-column (- (window-width) 19) t)
13923 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13925 (defun org-set-current-tags-overlay (current prefix)
13926 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13927 (if (featurep 'xemacs)
13928 (org-overlay-display org-tags-overlay (concat prefix s)
13929 'secondary-selection)
13930 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13931 (org-overlay-display org-tags-overlay (concat prefix s)))))
13933 (defvar org-last-tag-selection-key nil)
13934 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13935 "Fast tag selection with single keys.
13936 CURRENT is the current list of tags in the headline, INHERITED is the
13937 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13938 possibly with grouping information. TODO-TABLE is a similar table with
13939 TODO keywords, should these have keys assigned to them.
13940 If the keys are nil, a-z are automatically assigned.
13941 Returns the new tags string, or nil to not change the current settings."
13942 (let* ((fulltable (append table todo-table))
13943 (maxlen (apply 'max (mapcar
13944 (lambda (x)
13945 (if (stringp (car x)) (string-width (car x)) 0))
13946 fulltable)))
13947 (buf (current-buffer))
13948 (expert (eq org-fast-tag-selection-single-key 'expert))
13949 (buffer-tags nil)
13950 (fwidth (+ maxlen 3 1 3))
13951 (ncol (/ (- (window-width) 4) fwidth))
13952 (i-face 'org-done)
13953 (c-face 'org-todo)
13954 tg cnt e c char c1 c2 ntable tbl rtn
13955 ov-start ov-end ov-prefix
13956 (exit-after-next org-fast-tag-selection-single-key)
13957 (done-keywords org-done-keywords)
13958 groups ingroup)
13959 (save-excursion
13960 (beginning-of-line 1)
13961 (if (looking-at
13963 (setq ov-start (match-beginning 1)
13964 ov-end (match-end 1)
13965 ov-prefix "")
13966 (setq ov-start (1- (point-at-eol))
13967 ov-end (1+ ov-start))
13969 (setq ov-prefix
13970 (concat
13971 (buffer-substring (1- (point)) (point))
13972 (if (> (current-column) org-tags-column)
13973 " "
13974 (make-string (- org-tags-column (current-column)) ?\ ))))))
13975 (move-overlay org-tags-overlay ov-start ov-end)
13976 (save-window-excursion
13977 (if expert
13978 (set-buffer (get-buffer-create " *Org tags*"))
13979 (delete-other-windows)
13980 (split-window-vertically)
13981 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13982 (erase-buffer)
13983 (org-set-local 'org-done-keywords done-keywords)
13986 (org-fast-tag-show-exit exit-after-next)
13987 (org-set-current-tags-overlay current ov-prefix)
13988 (setq tbl fulltable char ?a cnt 0)
13989 (while (setq e (pop tbl))
13990 (cond
13991 ((equal (car e) :startgroup)
13992 (push '() groups) (setq ingroup t)
13993 (when (not (= cnt 0))
13994 (setq cnt 0)
13996 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13997 ((equal (car e) :endgroup)
13998 (setq ingroup nil cnt 0)
14000 ((equal e '(:newline))
14001 (when (not (= cnt 0))
14002 (setq cnt 0)
14004 (setq e (car tbl))
14005 (while (equal (car tbl) '(:newline))
14007 (setq tbl (cdr tbl)))))
14008 (t
14009 (setq tg (copy-sequence (car e)) c2 nil)
14010 (if (cdr e)
14011 (setq c (cdr e))
14012 ;; automatically assign a character.
14013 (setq c1 (string-to-char
14014 (downcase (substring
14015 tg (if (= (string-to-char tg) ?@) 1 0)))))
14016 (if (or (rassoc c1 ntable) (rassoc c1 table))
14017 (while (or (rassoc char ntable) (rassoc char table))
14018 (setq char (1+ char)))
14019 (setq c2 c1))
14020 (setq c (or c2 char)))
14021 (if ingroup (push tg (car groups)))
14022 (setq tg (org-add-props tg nil 'face
14023 (cond
14024 ((not (assoc tg table))
14025 (org-get-todo-face tg))
14026 ((member tg current) c-face)
14027 ((member tg inherited) i-face))))
14028 (if (and (= cnt 0) (not ingroup)) (insert " "))
14029 (insert "[" c "] " tg (make-string
14030 (- fwidth 4 (length tg)) ?\ ))
14031 (push (cons tg c) ntable)
14032 (when (= (setq cnt (1+ cnt)) ncol)
14034 (if ingroup (insert " "))
14035 (setq cnt 0)))))
14036 (setq ntable (nreverse ntable))
14038 (goto-char (point-min))
14039 (if (not expert) (org-fit-window-to-buffer))
14040 (setq rtn
14041 (catch 'exit
14042 (while t
14043 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14044 (if (not groups) "no " "")
14045 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14046 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14047 (setq org-last-tag-selection-key c)
14048 (cond
14050 ((= c ?!)
14051 (setq groups (not groups))
14052 (goto-char (point-min))
14053 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14054 ((= c ?\C-c)
14055 (if (not expert)
14056 (org-fast-tag-show-exit
14057 (setq exit-after-next (not exit-after-next)))
14058 (setq expert nil)
14059 (delete-other-windows)
14060 (set-window-buffer (split-window-vertically) " *Org tags*")
14061 (org-switch-to-buffer-other-window " *Org tags*")
14062 (org-fit-window-to-buffer)))
14063 ((or (= c ?\C-g)
14064 (and (= c ?q) (not (rassoc c ntable))))
14065 (org-detach-overlay org-tags-overlay)
14066 (setq quit-flag t))
14067 ((= c ?\ )
14068 (setq current nil)
14069 (if exit-after-next (setq exit-after-next 'now)))
14071 (condition-case nil
14072 (setq tg (org-icompleting-read
14073 "Tag: "
14074 (or buffer-tags
14075 (with-current-buffer buf
14076 (org-get-buffer-tags)))))
14077 (quit (setq tg "")))
14079 (add-to-list 'buffer-tags (list tg))
14080 (if (member tg current)
14081 (setq current (delete tg current))
14082 (push tg current)))
14083 (if exit-after-next (setq exit-after-next 'now)))
14084 ((setq e (rassoc c todo-table) tg (car e))
14085 (with-current-buffer buf
14086 (save-excursion (org-todo tg)))
14087 (if exit-after-next (setq exit-after-next 'now)))
14088 ((setq e (rassoc c ntable) tg (car e))
14089 (if (member tg current)
14090 (setq current (delete tg current))
14091 (loop for g in groups do
14092 (if (member tg g)
14093 (mapc (lambda (x)
14094 (setq current (delete x current)))
14095 g)))
14096 (push tg current))
14097 (if exit-after-next (setq exit-after-next 'now))))
14099 ;; Create a sorted list
14100 (setq current
14101 (sort current
14102 (lambda (a b)
14103 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14104 (if (eq exit-after-next 'now) (throw 'exit t))
14105 (goto-char (point-min))
14106 (beginning-of-line 2)
14107 (delete-region (point) (point-at-eol))
14108 (org-fast-tag-insert "Current" current c-face)
14109 (org-set-current-tags-overlay current ov-prefix)
14110 (while (re-search-forward
14112 (setq tg (match-string 1))
14113 (add-text-properties
14114 (match-beginning 1) (match-end 1)
14115 (list 'face
14116 (cond
14117 ((member tg current) c-face)
14118 ((member tg inherited) i-face)
14119 (t (get-text-property (match-beginning 1) 'face))))))
14120 (goto-char (point-min)))))
14121 (org-detach-overlay org-tags-overlay)
14122 (if rtn
14123 (mapconcat 'identity current ":")
14124 nil))))
14126 (defun org-get-tags-string ()
14127 "Get the TAGS string in the current headline."
14128 (unless (org-at-heading-p t)
14129 (error "Not on a heading"))
14130 (save-excursion
14131 (beginning-of-line 1)
14133 (org-match-string-no-properties 1)
14134 "")))
14136 (defun org-get-tags ()
14137 "Get the list of tags specified in the current headline."
14138 (org-split-string (org-get-tags-string) ":"))
14140 (defun org-get-buffer-tags ()
14141 "Get a table of all tags used in the buffer, for completion."
14142 (let (tags)
14143 (save-excursion
14144 (goto-char (point-min))
14145 (while (re-search-forward
14147 (when (equal (char-after (point-at-bol 0)) ?*)
14148 (mapc (lambda (x) (add-to-list 'tags x))
14149 (org-split-string (org-match-string-no-properties 1) ":")))))
14150 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14151 (mapcar 'list tags)))
14153 ;;;; The mapping API
14155 ;;;###autoload
14156 (defun org-map-entries (func &optional match scope &rest skip)
14157 "Call FUNC at each headline selected by MATCH in SCOPE.
14159 FUNC is a function or a lisp form. The function will be called without
14160 arguments, with the cursor positioned at the beginning of the headline.
14161 The return values of all calls to the function will be collected and
14162 returned as a list.
14164 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14165 does not need to preserve point. After evaluation, the cursor will be
14166 moved to the end of the line (presumably of the headline of the
14167 processed entry) and search continues from there. Under some
14168 circumstances, this may not produce the wanted results. For example,
14169 if you have removed (e.g. archived) the current (sub)tree it could
14170 mean that the next entry will be skipped entirely. In such cases, you
14171 can specify the position from where search should continue by making
14172 FUNC set the variable `org-map-continue-from' to the desired buffer
14173 position.
14175 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14176 Only headlines that are matched by this query will be considered during
14177 the iteration. When MATCH is nil or t, all headlines will be
14178 visited by the iteration.
14180 SCOPE determines the scope of this command. It can be any of:
14182 nil The current buffer, respecting the restriction if any
14183 tree The subtree started with the entry at point
14184 region The entries within the active region, if any
14185 region-start-level
14186 The entries within the active region, but only those at
14187 the same level than the first one.
14188 file The current buffer, without restriction
14189 file-with-archives
14190 The current buffer, and any archives associated with it
14191 agenda All agenda files
14192 agenda-with-archives
14193 All agenda files with any archive files associated with them
14194 \(file1 file2 ...)
14195 If this is a list, all files in the list will be scanned
14197 The remaining args are treated as settings for the skipping facilities of
14198 the scanner. The following items can be given here:
14200 archive skip trees with the archive tag.
14201 comment skip trees with the COMMENT keyword
14202 function or Emacs Lisp form:
14203 will be used as value for `org-agenda-skip-function', so whenever
14204 the function returns t, FUNC will not be called for that
14205 entry and search will continue from the point where the
14206 function leaves it.
14208 If your function needs to retrieve the tags including inherited tags
14209 at the *current* entry, you can use the value of the variable
14210 `org-scanner-tags' which will be much faster than getting the value
14211 with `org-get-tags-at'. If your function gets properties with
14212 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14213 to t around the call to `org-entry-properties' to get the same speedup.
14214 Note that if your function moves around to retrieve tags and properties at
14215 a *different* entry, you cannot use these techniques."
14216 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14217 (not (org-region-active-p)))
14218 (let* ((org-agenda-archives-mode nil) ; just to make sure
14219 (org-agenda-skip-archived-trees (memq 'archive skip))
14220 (org-agenda-skip-comment-trees (memq 'comment skip))
14221 (org-agenda-skip-function
14222 (car (org-delete-all '(comment archive) skip)))
14223 (org-tags-match-list-sublevels t)
14224 (start-level (eq scope 'region-start-level))
14225 matcher file res
14226 org-todo-keywords-for-agenda
14227 org-done-keywords-for-agenda
14228 org-todo-keyword-alist-for-agenda
14229 org-drawers-for-agenda
14230 org-tag-alist-for-agenda
14231 todo-only)
14233 (cond
14234 ((eq match t) (setq matcher t))
14235 ((eq match nil) (setq matcher t))
14236 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14238 (save-excursion
14239 (save-restriction
14240 (cond ((eq scope 'tree)
14241 (org-back-to-heading t)
14242 (org-narrow-to-subtree)
14243 (setq scope nil))
14244 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14245 (org-region-active-p))
14246 ;; If needed, set start-level to a string like "2"
14247 (when start-level
14248 (save-excursion
14249 (goto-char (region-beginning))
14250 (unless (org-at-heading-p) (outline-next-heading))
14251 (setq start-level (org-current-level))))
14252 (narrow-to-region (region-beginning)
14253 (save-excursion
14254 (goto-char (region-end))
14255 (unless (and (bolp) (org-at-heading-p))
14256 (outline-next-heading))
14257 (point)))
14258 (setq scope nil)))
14260 (if (not scope)
14261 (progn
14262 (org-prepare-agenda-buffers
14263 (list (buffer-file-name (current-buffer))))
14264 (setq res (org-scan-tags func matcher todo-only start-level)))
14265 ;; Get the right scope
14266 (cond
14267 ((and scope (listp scope) (symbolp (car scope)))
14268 (setq scope (eval scope)))
14269 ((eq scope 'agenda)
14270 (setq scope (org-agenda-files t)))
14271 ((eq scope 'agenda-with-archives)
14272 (setq scope (org-agenda-files t))
14273 (setq scope (org-add-archive-files scope)))
14274 ((eq scope 'file)
14275 (setq scope (list (buffer-file-name))))
14276 ((eq scope 'file-with-archives)
14277 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14278 (org-prepare-agenda-buffers scope)
14279 (while (setq file (pop scope))
14280 (with-current-buffer (org-find-base-buffer-visiting file)
14281 (save-excursion
14282 (save-restriction
14283 (widen)
14284 (goto-char (point-min))
14285 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14286 res)))
14288 ;;;; Properties
14290 ;;; Setting and retrieving properties
14292 (defconst org-special-properties
14293 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14294 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14295 "The special properties valid in Org-mode.
14297 These are properties that are not defined in the property drawer,
14298 but in some other way.")
14300 (defconst org-default-properties
14301 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14302 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14303 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14304 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14305 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14306 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14307 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14308 "Some properties that are used by Org-mode for various purposes.
14309 Being in this list makes sure that they are offered for completion.")
14312 "Regular expression matching the first line of a property drawer.")
14315 "Regular expression matching the last line of a property drawer.")
14318 "Regular expression matching the first line of a property drawer.")
14321 "Regular expression matching the first line of a property drawer.")
14323 (defconst org-property-drawer-re
14326 "Matches an entire property drawer.")
14328 (defconst org-clock-drawer-re
14331 "Matches an entire clock drawer.")
14333 (defsubst org-re-property (property)
14334 "Return a regexp matching a PROPERTY line.
14335 Match group 1 will be set to the value."
14338 (defsubst org-re-property-keyword (property)
14339 "Return a regexp matching a PROPERTY line, possibly with no
14340 value for the property."
14343 (defun org-property-action ()
14344 "Do an action on properties."
14345 (interactive)
14346 (let (c)
14347 (org-at-property-p)
14348 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14349 (setq c (read-char-exclusive))
14350 (cond
14351 ((equal c ?s)
14352 (call-interactively 'org-set-property))
14353 ((equal c ?d)
14354 (call-interactively 'org-delete-property))
14355 ((equal c ?D)
14356 (call-interactively 'org-delete-property-globally))
14357 ((equal c ?c)
14358 (call-interactively 'org-compute-property-at-point))
14359 (t (error "No such property action %c" c)))))
14361 (defun org-inc-effort ()
14362 "Increment the value of the effort property in the current entry."
14363 (interactive)
14364 (org-set-effort nil t))
14366 (defun org-set-effort (&optional value increment)
14367 "Set the effort property of the current entry.
14368 With numerical prefix arg, use the nth allowed value, 0 stands for the
14369 10th allowed value.
14371 When INCREMENT is non-nil, set the property to the next allowed value."
14372 (interactive "P")
14373 (if (equal value 0) (setq value 10))
14374 (let* ((completion-ignore-case t)
14375 (prop org-effort-property)
14376 (cur (org-entry-get nil prop))
14377 (allowed (org-property-get-allowed-values nil prop 'table))
14378 (existing (mapcar 'list (org-property-values prop)))
14379 rpl
14380 (val (cond
14381 ((stringp value) value)
14382 ((and allowed (integerp value))
14383 (or (car (nth (1- value) allowed))
14384 (car (org-last allowed))))
14385 ((and allowed increment)
14386 (or (caadr (member (list cur) allowed))
14387 (error "Allowed effort values are not set")))
14388 (allowed
14389 (message "Select 1-9,0, [RET%s]: %s"
14390 (if cur (concat "=" cur) "")
14391 (mapconcat 'car allowed " "))
14392 (setq rpl (read-char-exclusive))
14394 cur
14395 (setq rpl (- rpl ?0))
14396 (if (equal rpl 0) (setq rpl 10))
14397 (if (and (> rpl 0) (<= rpl (length allowed)))
14398 (car (nth (1- rpl) allowed))
14399 (org-completing-read "Effort: " allowed nil))))
14400 (t
14401 (let (org-completion-use-ido org-completion-use-iswitchb)
14402 (org-completing-read
14404 (concat "[" cur "]") "")
14405 ": ")
14406 existing nil nil "" nil cur))))))
14407 (unless (equal (org-entry-get nil prop) val)
14408 (org-entry-put nil prop val))
14409 (message "%s is now %s" prop val)))
14411 (defun org-at-property-p ()
14412 "Is cursor inside a property drawer?"
14413 (save-excursion
14414 (beginning-of-line 1)
14416 (save-match-data ;; Used by calling procedures
14417 (let ((p (point))
14418 (range (unless (org-before-first-heading-p)
14419 (org-get-property-block))))
14420 (and range (<= (car range) p) (< p (cdr range))))))))
14422 (defun org-get-property-block (&optional beg end force)
14423 "Return the (beg . end) range of the body of the property drawer.
14424 BEG and END are the beginning and end of the current subtree, or of
14425 the part before the first headline. If they are not given, they will
14426 be found. If the drawer does not exist and FORCE is non-nil, create
14427 the drawer."
14428 (catch 'exit
14429 (save-excursion
14430 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
14431 (progn (org-back-to-heading t) (point))))
14432 (end (or end (and (not (outline-next-heading)) (point-max))
14433 (point))))
14434 (goto-char beg)
14435 (if (re-search-forward org-property-start-re end t)
14436 (setq beg (1+ (match-end 0)))
14437 (if force
14438 (save-excursion
14439 (org-insert-property-drawer)
14440 (setq end (progn (outline-next-heading) (point))))
14441 (throw 'exit nil))
14442 (goto-char beg)
14443 (if (re-search-forward org-property-start-re end t)
14444 (setq beg (1+ (match-end 0)))))
14445 (if (re-search-forward org-property-end-re end t)
14446 (setq end (match-beginning 0))
14447 (or force (throw 'exit nil))
14448 (goto-char beg)
14449 (setq end beg)
14450 (org-indent-line)
14452 (cons beg end)))))
14454 (defun org-entry-properties (&optional pom which specific)
14455 "Get all properties of the entry at point-or-marker POM.
14456 This includes the TODO keyword, the tags, time strings for deadline,
14457 scheduled, and clocking, and any additional properties defined in the
14458 entry. The return value is an alist, keys may occur multiple times
14459 if the property key was used several times.
14460 POM may also be nil, in which case the current entry is used.
14461 If WHICH is nil or `all', get all properties. If WHICH is
14462 `special' or `standard', only get that subclass. If WHICH
14463 is a string only get exactly this property. SPECIFIC can be a string, the
14464 specific property we are interested in. Specifying it can speed
14465 things up because then unnecessary parsing is avoided."
14466 (setq which (or which 'all))
14467 (org-with-point-at pom
14468 (let ((clockstr (substring org-clock-string 0 -1))
14469 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14470 (case-fold-search nil)
14471 beg end range props sum-props key key1 value string clocksum clocksumt)
14472 (save-excursion
14473 (when (condition-case nil
14474 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14475 (error nil))
14476 (setq beg (point))
14477 (setq sum-props (get-text-property (point) 'org-summaries))
14478 (setq clocksum (get-text-property (point) :org-clock-minutes)
14479 clocksumt (get-text-property (point) :org-clock-minutes-today))
14480 (outline-next-heading)
14481 (setq end (point))
14482 (when (memq which '(all special))
14483 ;; Get the special properties, like TODO and tags
14484 (goto-char beg)
14485 (when (and (or (not specific) (string= specific "TODO"))
14486 (looking-at org-todo-line-regexp) (match-end 2))
14487 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14488 (when (and (or (not specific) (string= specific "PRIORITY"))
14489 (looking-at org-priority-regexp))
14490 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14491 (when (or (not specific) (string= specific "FILE"))
14492 (push (cons "FILE" buffer-file-name) props))
14493 (when (and (or (not specific) (string= specific "TAGS"))
14494 (setq value (org-get-tags-string))
14496 (push (cons "TAGS" value) props))
14497 (when (and (or (not specific) (string= specific "ALLTAGS"))
14498 (setq value (org-get-tags-at)))
14499 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14500 ":"))
14501 props))
14502 (when (or (not specific) (string= specific "BLOCKED"))
14503 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14504 (when (or (not specific)
14505 (member specific
14506 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14507 "TIMESTAMP" "TIMESTAMP_IA")))
14508 (catch 'match
14509 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14510 (setq key (if (match-end 1)
14511 (substring (org-match-string-no-properties 1)
14512 0 -1))
14513 string (if (equal key clockstr)
14514 (org-trim
14515 (buffer-substring-no-properties
14516 (match-beginning 3) (goto-char
14517 (point-at-eol))))
14518 (substring (org-match-string-no-properties 3)
14519 1 -1)))
14520 ;; Get the correct property name from the key. This is
14521 ;; necessary if the user has configured time keywords.
14522 (setq key1 (concat key ":"))
14523 (cond
14524 ((not key)
14525 (setq key
14526 (if (= (char-after (match-beginning 3)) ?\[)
14527 "TIMESTAMP_IA" "TIMESTAMP")))
14528 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14529 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14530 ((equal key1 org-closed-string) (setq key "CLOSED"))
14531 ((equal key1 org-clock-string) (setq key "CLOCK")))
14532 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14533 (progn
14534 (push (cons key string) props)
14535 ;; no need to search further if match is found
14536 (throw 'match t))
14537 (when (or (equal key "CLOCK") (not (assoc key props)))
14538 (push (cons key string) props)))))))
14540 (when (memq which '(all standard))
14541 ;; Get the standard properties, like :PROP: ...
14542 (setq range (org-get-property-block beg end))
14543 (when range
14544 (goto-char (car range))
14545 (while (re-search-forward
14547 (cdr range) t)
14548 (setq key (org-match-string-no-properties 1)
14549 value (org-trim (or (org-match-string-no-properties 2) "")))
14550 (unless (member key excluded)
14551 (push (cons key (or value "")) props)))))
14552 (if clocksum
14553 (push (cons "CLOCKSUM"
14554 (org-columns-number-to-string (/ (float clocksum) 60.)
14555 'add_times))
14556 props))
14557 (if clocksumt
14558 (push (cons "CLOCKSUM_T"
14559 (org-columns-number-to-string (/ (float clocksumt) 60.)
14560 'add_times))
14561 props))
14562 (unless (assoc "CATEGORY" props)
14563 (push (cons "CATEGORY" (org-get-category)) props))
14564 (append sum-props (nreverse props)))))))
14566 (defun org-entry-get (pom property &optional inherit literal-nil)
14567 "Get value of PROPERTY for entry or content at point-or-marker POM.
14568 If INHERIT is non-nil and the entry does not have the property,
14569 then also check higher levels of the hierarchy.
14570 If INHERIT is the symbol `selective', use inheritance only if the setting
14571 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14572 If the property is present but empty, the return value is the empty string.
14573 If the property is not present at all, nil is returned.
14576 do not interpret it as the list atom nil. This is used for inheritance
14578 (org-with-point-at pom
14579 (if (and inherit (if (eq inherit 'selective)
14580 (org-property-inherit-p property)
14581 t))
14582 (org-entry-get-with-inheritance property literal-nil)
14583 (if (member property org-special-properties)
14584 ;; We need a special property. Use `org-entry-properties' to
14585 ;; retrieve it, but specify the wanted property
14586 (cdr (assoc property (org-entry-properties nil 'special property)))
14587 (let* ((range (org-get-property-block))
14588 (props (list (or (assoc property org-file-properties)
14589 (assoc property org-global-properties)
14590 (assoc property org-global-properties-fixed))))
14591 (ap (lambda (key)
14592 (when (re-search-forward
14593 (org-re-property key) (cdr range) t)
14594 (setq props
14595 (org-update-property-plist
14596 key
14597 (if (match-end 1)
14598 (org-match-string-no-properties 1) "")
14599 props)))))
14600 val)
14601 (when (and range (goto-char (car range)))
14602 (funcall ap property)
14603 (goto-char (car range))
14604 (while (funcall ap (concat property "+")))
14605 (setq val (cdr (assoc property props)))
14606 (when val (if literal-nil val (org-not-nil val)))))))))
14608 (defun org-property-or-variable-value (var &optional inherit)
14609 "Check if there is a property fixing the value of VAR.
14610 If yes, return this value. If not, return the current value of the variable."
14611 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14613 (read prop)
14614 (symbol-value var))))
14616 (defun org-entry-delete (pom property)
14617 "Delete the property PROPERTY from entry at point-or-marker POM."
14618 (org-with-point-at pom
14619 (if (member property org-special-properties)
14620 nil ; cannot delete these properties.
14621 (let ((range (org-get-property-block)))
14622 (if (and range
14623 (goto-char (car range))
14624 (re-search-forward
14625 (org-re-property property)
14626 (cdr range) t))
14627 (progn
14628 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14629 t)
14630 nil)))))
14632 ;; Multi-values properties are properties that contain multiple values
14633 ;; These values are assumed to be single words, separated by whitespace.
14634 (defun org-entry-add-to-multivalued-property (pom property value)
14635 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14636 (let* ((old (org-entry-get pom property))
14638 (setq value (org-entry-protect-space value))
14639 (unless (member value values)
14640 (setq values (cons value values))
14641 (org-entry-put pom property
14642 (mapconcat 'identity values " ")))))
14644 (defun org-entry-remove-from-multivalued-property (pom property value)
14645 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14646 (let* ((old (org-entry-get pom property))
14648 (setq value (org-entry-protect-space value))
14649 (when (member value values)
14650 (setq values (delete value values))
14651 (org-entry-put pom property
14652 (mapconcat 'identity values " ")))))
14654 (defun org-entry-member-in-multivalued-property (pom property value)
14655 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14656 (let* ((old (org-entry-get pom property))
14658 (setq value (org-entry-protect-space value))
14659 (member value values)))
14661 (defun org-entry-get-multivalued-property (pom property)
14662 "Return a list of values in a multivalued property."
14663 (let* ((value (org-entry-get pom property))
14665 (mapcar 'org-entry-restore-space values)))
14667 (defun org-entry-put-multivalued-property (pom property &rest values)
14668 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14669 VALUES should be a list of strings. Spaces will be protected."
14670 (org-entry-put pom property
14671 (mapconcat 'org-entry-protect-space values " "))
14672 (let* ((value (org-entry-get pom property))
14674 (mapcar 'org-entry-restore-space values)))
14676 (defun org-entry-protect-space (s)
14677 "Protect spaces and newline in string S."
14678 (while (string-match " " s)
14679 (setq s (replace-match "%20" t t s)))
14681 (setq s (replace-match "%0A" t t s)))
14682 s)
14684 (defun org-entry-restore-space (s)
14685 "Restore spaces and newline in string S."
14686 (while (string-match "%20" s)
14687 (setq s (replace-match " " t t s)))
14688 (while (string-match "%0A" s)
14690 s)
14692 (defvar org-entry-property-inherited-from (make-marker)
14693 "Marker pointing to the entry from where a property was inherited.
14694 Each call to `org-entry-get-with-inheritance' will set this marker to the
14695 location of the entry where the inheritance search matched. If there was
14696 no match, the marker will point nowhere.
14697 Note that also `org-entry-get' calls this function, if the INHERIT flag
14698 is set.")
14700 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14701 "Get PROPERTY of entry or content at point, search higher levels if needed.
14702 The search will stop at the first ancestor which has the property defined.
14704 should be considered as undefined (this is the meaning of nil here).
14706 (move-marker org-entry-property-inherited-from nil)
14707 (let (tmp)
14708 (save-excursion
14709 (save-restriction
14710 (widen)
14711 (catch 'ex
14712 (while t
14713 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14714 (or (ignore-errors (org-back-to-heading t))
14715 (goto-char (point-min)))
14716 (move-marker org-entry-property-inherited-from (point))
14717 (throw 'ex tmp))
14718 (or (ignore-errors (org-up-heading-safe))
14719 (throw 'ex nil))))))
14720 (setq tmp (or tmp
14721 (cdr (assoc property org-file-properties))
14722 (cdr (assoc property org-global-properties))
14723 (cdr (assoc property org-global-properties-fixed))))
14724 (if literal-nil tmp (org-not-nil tmp))))
14726 (defvar org-property-changed-functions nil
14727 "Hook called when the value of a property has changed.
14728 Each hook function should accept two arguments, the name of the property
14729 and the new value.")
14731 (defun org-entry-put (pom property value)
14732 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14733 (org-with-point-at pom
14734 (org-back-to-heading t)
14735 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14736 range)
14737 (cond
14738 ((equal property "TODO")
14740 (not (member value org-todo-keywords-1)))
14742 (if (or (not value)
14744 (setq value 'none))
14745 (org-todo value)
14746 (org-set-tags nil 'align))
14747 ((equal property "PRIORITY")
14749 (string-to-char value) ?\ ))
14750 (org-set-tags nil 'align))
14751 ((equal property "SCHEDULED")
14752 (if (re-search-forward org-scheduled-time-regexp end t)
14753 (cond
14754 ((eq value 'earlier) (org-timestamp-change -1 'day))
14755 ((eq value 'later) (org-timestamp-change 1 'day))
14756 (t (call-interactively 'org-schedule)))
14757 (call-interactively 'org-schedule)))
14758 ((equal property "DEADLINE")
14759 (if (re-search-forward org-deadline-time-regexp end t)
14760 (cond
14761 ((eq value 'earlier) (org-timestamp-change -1 'day))
14762 ((eq value 'later) (org-timestamp-change 1 'day))
14763 (t (call-interactively 'org-deadline)))
14764 (call-interactively 'org-deadline)))
14765 ((member property org-special-properties)
14766 (error "The %s property can not yet be set with `org-entry-put'"
14767 property))
14768 (t ; a non-special property
14769 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14770 (setq range (org-get-property-block beg end 'force))
14771 (goto-char (car range))
14772 (if (re-search-forward
14773 (org-re-property-keyword property) (cdr range) t)
14774 (progn
14775 (delete-region (match-beginning 0) (match-end 0))
14776 (goto-char (match-beginning 0)))
14777 (goto-char (cdr range))
14779 (backward-char 1)
14780 (org-indent-line))
14781 (insert ":" property ":")
14782 (and value (insert " " value))
14783 (org-indent-line)))))
14784 (run-hook-with-args 'org-property-changed-functions property value)))
14786 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14787 "Get all property keys in the current buffer.
14788 With INCLUDE-SPECIALS, also list the special properties that reflect things
14789 like tags and TODO state.
14790 With INCLUDE-DEFAULTS, also include properties that has special meaning
14791 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14792 and others.
14793 With INCLUDE-COLUMNS, also include property names given in COLUMN
14794 formats in the current buffer."
14795 (let (rtn range cfmt s p)
14796 (save-excursion
14797 (save-restriction
14798 (widen)
14799 (goto-char (point-min))
14800 (while (re-search-forward org-property-start-re nil t)
14801 (setq range (org-get-property-block))
14802 (goto-char (car range))
14803 (while (re-search-forward
14805 (cdr range) t)
14806 (add-to-list 'rtn (org-match-string-no-properties 1)))
14807 (outline-next-heading))))
14809 (when include-specials
14810 (setq rtn (append org-special-properties rtn)))
14812 (when include-defaults
14813 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14814 (add-to-list 'rtn org-effort-property))
14816 (when include-columns
14817 (save-excursion
14818 (save-restriction
14819 (widen)
14820 (goto-char (point-min))
14821 (while (re-search-forward
14823 nil t)
14824 (setq cfmt (match-string 2) s 0)
14826 cfmt s)
14827 (setq s (match-end 0)
14828 p (match-string 1 cfmt))
14829 (unless (or (equal p "ITEM")
14830 (member p org-special-properties))
14831 (add-to-list 'rtn (match-string 1 cfmt))))))))
14833 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14835 (defun org-property-values (key)
14836 "Return a list of all values of property KEY in the current buffer."
14837 (save-excursion
14838 (save-restriction
14839 (widen)
14840 (goto-char (point-min))
14841 (let ((re (org-re-property key))
14842 values)
14843 (while (re-search-forward re nil t)
14844 (add-to-list 'values (org-trim (match-string 1))))
14845 (delete "" values)))))
14847 (defun org-insert-property-drawer ()
14848 "Insert a property drawer into the current entry."
14849 (org-back-to-heading t)
14850 (looking-at org-outline-regexp)
14851 (let ((indent (if org-adapt-indentation
14852 (- (match-end 0) (match-beginning 0))
14853 0))
14854 (beg (point))
14856 end hiddenp)
14857 (outline-next-heading)
14858 (setq end (point))
14859 (goto-char beg)
14860 (while (re-search-forward re end t))
14861 (setq hiddenp (outline-invisible-p))
14862 (end-of-line 1)
14865 (if (member (match-string 1) '("CLOCK:" ":END:"))
14866 ;; just skip this line
14867 (beginning-of-line 2)
14868 ;; Drawer start, find the end
14870 (beginning-of-line 1)))
14871 (org-skip-over-state-notes)
14873 (if (eq (char-before) ?*) (forward-char 1))
14875 (beginning-of-line 0)
14876 (org-indent-to-column indent)
14877 (beginning-of-line 2)
14878 (org-indent-to-column indent)
14879 (beginning-of-line 0)
14880 (if hiddenp
14881 (save-excursion
14882 (org-back-to-heading t)
14883 (hide-entry))
14884 (org-flag-drawer t))))
14886 (defun org-insert-drawer (&optional arg drawer)
14887 "Insert a drawer at point.
14889 Optional argument DRAWER, when non-nil, is a string representing
14890 drawer's name. Otherwise, the user is prompted for a name.
14892 If a region is active, insert the drawer around that region
14893 instead.
14895 Point is left between drawer's boundaries."
14896 (interactive "P")
14897 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14898 "LOGBOOK"))
14899 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14900 ;; internally by Org. They are meant to be inserted
14901 ;; automatically.
14902 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14903 ;; Remove system drawers from list. Note: For some reason,
14904 ;; `org-completing-read' ignores the predicate while
14905 ;; `completing-read' handles it fine.
14906 (drawer (if arg "PROPERTIES"
14907 (or drawer
14908 (completing-read
14909 "Drawer: " org-drawers
14910 (lambda (d) (not (member d system-drawers))))))))
14911 (cond
14912 ;; With C-u, fall back on `org-insert-property-drawer'
14913 (arg (org-insert-property-drawer))
14914 ;; With an active region, insert a drawer at point.
14915 ((not (org-region-active-p))
14916 (progn
14919 (forward-line -2)))
14920 ;; Otherwise, insert the drawer at point
14921 (t
14922 (let ((rbeg (region-beginning))
14923 (rend (copy-marker (region-end))))
14924 (unwind-protect
14925 (progn
14926 (goto-char rbeg)
14927 (beginning-of-line)
14928 (when (save-excursion
14929 (re-search-forward org-outline-regexp-bol rend t))
14930 (error "Drawers cannot contain headlines"))
14931 ;; Position point at the beginning of the first
14932 ;; non-blank line in region. Insert drawer's opening
14933 ;; there, then indent it.
14934 (org-skip-whitespace)
14935 (beginning-of-line)
14937 (forward-line -1)
14938 (indent-for-tab-command)
14939 ;; Move point to the beginning of the first blank line
14940 ;; after the last non-blank line in region. Insert
14941 ;; drawer's closing, then indent it.
14942 (goto-char rend)
14945 (indent-for-tab-command)
14947 ;; Clear marker, whatever the outcome of insertion is.
14948 (set-marker rend nil)))))))
14950 (defvar org-property-set-functions-alist nil
14951 "Property set function alist.
14952 Each entry should have the following format:
14954 (PROPERTY . READ-FUNCTION)
14956 The read function will be called with the same argument as
14957 `org-completing-read'.")
14959 (defun org-set-property-function (property)
14960 "Get the function that should be used to set PROPERTY.
14961 This is computed according to `org-property-set-functions-alist'."
14962 (or (cdr (assoc property org-property-set-functions-alist))
14963 'org-completing-read))
14965 (defun org-read-property-value (property)
14966 "Read PROPERTY value from user."
14967 (let* ((completion-ignore-case t)
14968 (allowed (org-property-get-allowed-values nil property 'table))
14969 (cur (org-entry-get nil property))
14970 (prompt (concat property " value"
14972 (concat " [" cur "]") "") ": "))
14973 (set-function (org-set-property-function property))
14974 (val (if allowed
14975 (funcall set-function prompt allowed nil
14976 (not (get-text-property 0 'org-unrestricted
14977 (caar allowed))))
14978 (let (org-completion-use-ido org-completion-use-iswitchb)
14979 (funcall set-function prompt
14980 (mapcar 'list (org-property-values property))
14981 nil nil "" nil cur)))))
14982 (if (equal val "")
14983 cur
14984 val)))
14986 (defvar org-last-set-property nil)
14987 (defun org-read-property-name ()
14988 "Read a property name."
14989 (let* ((completion-ignore-case t)
14990 (keys (org-buffer-property-keys nil t t))
14991 (default-prop (or (save-excursion
14992 (save-match-data
14993 (beginning-of-line)
14995 (null (string= (match-string 1) "END"))
14996 (match-string 1))))
14997 org-last-set-property))
14998 (property (org-icompleting-read
14999 (concat "Property"
15000 (if default-prop (concat " [" default-prop "]") "")
15001 ": ")
15002 (mapcar 'list keys)
15003 nil nil nil nil
15004 default-prop
15005 )))
15006 (if (member property keys)
15007 property
15008 (or (cdr (assoc (downcase property)
15009 (mapcar (lambda (x) (cons (downcase x) x))
15010 keys)))
15011 property))))
15013 (defun org-set-property (property value)
15014 "In the current entry, set PROPERTY to VALUE.
15015 When called interactively, this will prompt for a property name, offering
15016 completion on existing and default properties. And then it will prompt
15017 for a value, offering completion either on allowed values (via an inherited
15018 xxx_ALL property) or on existing values in other instances of this property
15019 in the current file."
15020 (interactive (list nil nil))
15021 (let* ((property (or property (org-read-property-name)))
15022 (value (or value (org-read-property-value property)))
15023 (fn (cdr (assoc property org-properties-postprocess-alist))))
15024 (setq org-last-set-property property)
15025 ;; Possibly postprocess the inserted value:
15026 (when fn (setq value (funcall fn value)))
15027 (unless (equal (org-entry-get nil property) value)
15028 (org-entry-put nil property value))))
15030 (defun org-delete-property (property)
15031 "In the current entry, delete PROPERTY."
15032 (interactive
15033 (let* ((completion-ignore-case t)
15034 (prop (org-icompleting-read "Property: "
15035 (org-entry-properties nil 'standard))))
15036 (list prop)))
15037 (message "Property %s %s" property
15038 (if (org-entry-delete nil property)
15039 "deleted"
15040 "was not present in the entry")))
15042 (defun org-delete-property-globally (property)
15043 "Remove PROPERTY globally, from all entries."
15044 (interactive
15045 (let* ((completion-ignore-case t)
15046 (prop (org-icompleting-read
15047 "Globally remove property: "
15048 (mapcar 'list (org-buffer-property-keys)))))
15049 (list prop)))
15050 (save-excursion
15051 (save-restriction
15052 (widen)
15053 (goto-char (point-min))
15054 (let ((cnt 0))
15055 (while (re-search-forward
15056 (org-re-property property)
15057 nil t)
15058 (setq cnt (1+ cnt))
15059 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15062 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15064 (defun org-compute-property-at-point ()
15065 "Compute the property at point.
15066 This looks for an enclosing column format, extracts the operator and
15067 then applies it to the property in the column format's scope."
15068 (interactive)
15069 (unless (org-at-property-p)
15070 (error "Not at a property"))
15071 (let ((prop (org-match-string-no-properties 2)))
15072 (org-columns-get-format-and-top-level)
15073 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15074 (error "No operator defined for property %s" prop))
15075 (org-columns-compute prop)))
15077 (defvar org-property-allowed-value-functions nil
15078 "Hook for functions supplying allowed values for a specific property.
15079 The functions must take a single argument, the name of the property, and
15081 the values, this means that these values are intended as defaults for
15082 completion, but that other values should be allowed too.
15083 The functions must return nil if they are not responsible for this
15084 property.")
15086 (defun org-property-get-allowed-values (pom property &optional table)
15087 "Get allowed values for the property PROPERTY.
15088 When TABLE is non-nil, return an alist that can directly be used for
15089 completion."
15090 (let (vals)
15091 (cond
15092 ((equal property "TODO")
15093 (setq vals (org-with-point-at pom
15094 (append org-todo-keywords-1 '("")))))
15095 ((equal property "PRIORITY")
15096 (let ((n org-lowest-priority))
15097 (while (>= n org-highest-priority)
15098 (push (char-to-string n) vals)
15099 (setq n (1- n)))))
15100 ((member property org-special-properties))
15101 ((setq vals (run-hook-with-args-until-success
15102 'org-property-allowed-value-functions property)))
15103 (t
15104 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15106 (setq vals (car (read-from-string (concat "(" vals ")"))))
15107 (setq vals (mapcar (lambda (x)
15108 (cond ((stringp x) x)
15109 ((numberp x) (number-to-string x))
15110 ((symbolp x) (symbol-name x))
15111 (t "???")))
15112 vals)))))
15113 (when (member ":ETC" vals)
15114 (setq vals (remove ":ETC" vals))
15115 (org-add-props (car vals) '(org-unrestricted t)))
15116 (if table (mapcar 'list vals) vals)))
15118 (defun org-property-previous-allowed-value (&optional previous)
15119 "Switch to the next allowed value for this property."
15120 (interactive)
15121 (org-property-next-allowed-value t))
15123 (defun org-property-next-allowed-value (&optional previous)
15124 "Switch to the next allowed value for this property."
15125 (interactive)
15126 (unless (org-at-property-p)
15127 (error "Not at a property"))
15128 (let* ((key (match-string 2))
15129 (value (match-string 3))
15130 (allowed (or (org-property-get-allowed-values (point) key)
15131 (and (member value '("[ ]" "[-]" "[X]"))
15132 '("[ ]" "[X]"))))
15133 nval)
15134 (unless allowed
15135 (error "Allowed values for this property have not been defined"))
15136 (if previous (setq allowed (reverse allowed)))
15137 (if (member value allowed)
15138 (setq nval (car (cdr (member value allowed)))))
15139 (setq nval (or nval (car allowed)))
15140 (if (equal nval value)
15141 (error "Only one allowed value for this property"))
15142 (org-at-property-p)
15143 (replace-match (concat " :" key ": " nval) t t)
15144 (org-indent-line)
15145 (beginning-of-line 1)
15147 (run-hook-with-args 'org-property-changed-functions key nval)))
15149 (defun org-find-olp (path &optional this-buffer)
15150 "Return a marker pointing to the entry at outline path OLP.
15151 If anything goes wrong, throw an error.
15152 You can wrap this call to catch the error like this:
15154 (condition-case msg
15155 (org-mobile-locate-entry (match-string 4))
15156 (error (nth 1 msg)))
15158 The return value will then be either a string with the error message,
15159 or a marker if everything is OK.
15161 If THIS-BUFFER is set, the outline path does not contain a file,
15162 only headings."
15163 (let* ((file (if this-buffer buffer-file-name (pop path)))
15164 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15165 (level 1)
15166 (lmin 1)
15167 (lmax 1)
15168 limit re end found pos heading cnt flevel)
15169 (unless buffer (error "File not found :%s" file))
15170 (with-current-buffer buffer
15171 (save-excursion
15172 (save-restriction
15173 (widen)
15174 (setq limit (point-max))
15175 (goto-char (point-min))
15176 (while (setq heading (pop path))
15177 (setq re (format org-complex-heading-regexp-format
15178 (regexp-quote heading)))
15179 (setq cnt 0 pos (point))
15180 (while (re-search-forward re end t)
15181 (setq level (- (match-end 1) (match-beginning 1)))
15182 (if (and (>= level lmin) (<= level lmax))
15183 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15184 (when (= cnt 0) (error "Heading not found on level %d: %s"
15185 lmax heading))
15186 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15187 lmax heading))
15188 (goto-char found)
15189 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15190 (setq end (save-excursion (org-end-of-subtree t t))))
15191 (when (org-at-heading-p)
15192 (move-marker (make-marker) (point))))))))
15194 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15195 "Find node HEADING in BUFFER.
15196 Return a marker to the heading if it was found, or nil if not.
15197 If POS-ONLY is set, return just the position instead of a marker.
15199 The heading text must match exact, but it may have a TODO keyword,
15200 a priority cookie and tags in the standard locations."
15201 (with-current-buffer (or buffer (current-buffer))
15202 (save-excursion
15203 (save-restriction
15204 (widen)
15205 (goto-char (point-min))
15206 (let (case-fold-search)
15207 (if (re-search-forward
15208 (format org-complex-heading-regexp-format
15209 (regexp-quote heading)) nil t)
15210 (if pos-only
15211 (match-beginning 0)
15212 (move-marker (make-marker) (match-beginning 0)))))))))
15214 (defun org-find-exact-heading-in-directory (heading &optional dir)
15215 "Find Org node headline HEADING in all .org files in directory DIR.
15216 When the target headline is found, return a marker to this location."
15217 (let ((files (directory-files (or dir default-directory)
15219 file visiting m buffer)
15220 (catch 'found
15221 (while (setq file (pop files))
15222 (message "trying %s" file)
15223 (setq visiting (org-find-base-buffer-visiting file))
15224 (setq buffer (or visiting (find-file-noselect file)))
15225 (setq m (org-find-exact-headline-in-buffer
15226 heading buffer))
15227 (when (and (not m) (not visiting)) (kill-buffer buffer))
15228 (and m (throw 'found m))))))
15230 (defun org-find-entry-with-id (ident)
15231 "Locate the entry that contains the ID property with exact value IDENT.
15232 IDENT can be a string, a symbol or a number, this function will search for
15233 the string representation of it.
15234 Return the position where this entry starts, or nil if there is no such entry."
15235 (interactive "sID: ")
15236 (let ((id (cond
15237 ((stringp ident) ident)
15238 ((symbol-name ident) (symbol-name ident))
15239 ((numberp ident) (number-to-string ident))
15240 (t (error "IDENT %s must be a string, symbol or number" ident))))
15241 (case-fold-search nil))
15242 (save-excursion
15243 (save-restriction
15244 (widen)
15245 (goto-char (point-min))
15246 (when (re-search-forward
15248 nil t)
15249 (org-back-to-heading t)
15250 (point))))))
15252 ;;;; Timestamps
15254 (defvar org-last-changed-timestamp nil)
15255 (defvar org-last-inserted-timestamp nil
15256 "The last time stamp inserted with `org-insert-time-stamp'.")
15257 (defvar org-time-was-given) ; dynamically scoped parameter
15258 (defvar org-end-time-was-given) ; dynamically scoped parameter
15259 (defvar org-ts-what) ; dynamically scoped parameter
15261 (defun org-time-stamp (arg &optional inactive)
15262 "Prompt for a date/time and insert a time stamp.
15263 If the user specifies a time like HH:MM or if this command is
15264 called with at least one prefix argument, the time stamp contains
15265 the date and the time. Otherwise, only the date is be included.
15267 All parts of a date not specified by the user is filled in from
15268 the current date/time. So if you just press return without
15269 typing anything, the time stamp will represent the current
15270 date/time.
15272 If there is already a timestamp at the cursor, it will be
15273 modified.
15275 With two universal prefix arguments, insert an active timestamp
15276 with the current time without prompting the user."
15277 (interactive "P")
15278 (let* ((ts nil)
15279 (default-time
15280 ;; Default time is either today, or, when entering a range,
15281 ;; the range start.
15282 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15283 (save-excursion
15284 (re-search-backward
15286 (- (point) 20) t)))
15287 (apply 'encode-time (org-parse-time-string (match-string 1)))
15288 (current-time)))
15289 (default-input (and ts (org-get-compact-tod ts)))
15290 (repeater (save-excursion
15291 (save-match-data
15292 (beginning-of-line)
15293 (when (re-search-forward
15295 (save-excursion (progn (end-of-line) (point))) t)
15296 (match-string 0)))))
15297 org-time-was-given org-end-time-was-given time)
15298 (cond
15299 ((and (org-at-timestamp-p t)
15300 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15301 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15302 (insert "--")
15303 (setq time (let ((this-command this-command))
15304 (org-read-date arg 'totime nil nil
15305 default-time default-input inactive)))
15306 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15307 ((org-at-timestamp-p t)
15308 (setq time (let ((this-command this-command))
15309 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15310 (when (org-at-timestamp-p t) ; just to get the match data
15311 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15312 (replace-match "")
15313 (setq org-last-changed-timestamp
15314 (org-insert-time-stamp
15315 time (or org-time-was-given arg)
15316 inactive nil nil (list org-end-time-was-given)))
15317 (when repeater (goto-char (1- (point))) (insert " " repeater)
15318 (setq org-last-changed-timestamp
15319 (concat (substring org-last-inserted-timestamp 0 -1)
15320 " " repeater ">"))))
15321 (message "Timestamp updated"))
15322 ((equal arg '(16))
15323 (org-insert-time-stamp (current-time) t))
15324 (t
15325 (setq time (let ((this-command this-command))
15326 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15327 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15328 nil nil (list org-end-time-was-given))))))
15330 ;; FIXME: can we use this for something else, like computing time differences?
15331 (defun org-get-compact-tod (s)
15332 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15333 (let* ((t1 (match-string 1 s))
15334 (h1 (string-to-number (match-string 2 s)))
15335 (m1 (string-to-number (match-string 3 s)))
15336 (t2 (and (match-end 4) (match-string 5 s)))
15337 (h2 (and t2 (string-to-number (match-string 6 s))))
15338 (m2 (and t2 (string-to-number (match-string 7 s))))
15339 dh dm)
15340 (if (not t2)
15341 t1
15342 (setq dh (- h2 h1) dm (- m2 m1))
15343 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15344 (concat t1 "+" (number-to-string dh)
15345 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15347 (defun org-time-stamp-inactive (&optional arg)
15348 "Insert an inactive time stamp.
15349 An inactive time stamp is enclosed in square brackets instead of angle
15350 brackets. It is inactive in the sense that it does not trigger agenda entries,
15351 does not link to the calendar and cannot be changed with the S-cursor keys.
15352 So these are more for recording a certain time/date."
15353 (interactive "P")
15354 (org-time-stamp arg 'inactive))
15356 (defvar org-date-ovl (make-overlay 1 1))
15357 (overlay-put org-date-ovl 'face 'org-date-selected)
15358 (org-detach-overlay org-date-ovl)
15360 (defvar org-ans1) ; dynamically scoped parameter
15361 (defvar org-ans2) ; dynamically scoped parameter
15363 (defvar org-plain-time-of-day-regexp) ; defined below
15365 (defvar org-overriding-default-time nil) ; dynamically scoped
15366 (defvar org-read-date-overlay nil)
15367 (defvar org-dcst nil) ; dynamically scoped
15368 (defvar org-read-date-history nil)
15369 (defvar org-read-date-final-answer nil)
15370 (defvar org-read-date-analyze-futurep nil)
15371 (defvar org-read-date-analyze-forced-year nil)
15372 (defvar org-read-date-inactive)
15374 (defun org-read-date (&optional org-with-time to-time from-string prompt
15375 default-time default-input inactive)
15376 "Read a date, possibly a time, and make things smooth for the user.
15377 The prompt will suggest to enter an ISO date, but you can also enter anything
15378 which will at least partially be understood by `parse-time-string'.
15379 Unrecognized parts of the date will default to the current day, month, year,
15380 hour and minute. If this command is called to replace a timestamp at point,
15381 or to enter the second timestamp of a range, the default time is taken
15382 from the existing stamp. Furthermore, the command prefers the future,
15383 so if you are giving a date where the year is not given, and the day-month
15384 combination is already past in the current year, it will assume you
15385 mean next year. For details, see the manual. A few examples:
15387 3-2-5 --> 2003-02-05
15388 feb 15 --> currentyear-02-15
15389 2/15 --> currentyear-02-15
15390 sep 12 9 --> 2009-09-12
15391 12:45 --> today 12:45
15392 22 sept 0:34 --> currentyear-09-22 0:34
15393 12 --> currentyear-currentmonth-12
15394 Fri --> nearest Friday (today or later)
15395 etc.
15397 Furthermore you can specify a relative date by giving, as the *first* thing
15398 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15399 change in days weeks, months, years.
15400 With a single plus or minus, the date is relative to today. With a double
15401 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15402 +4d --> four days from today
15403 +4 --> same as above
15404 +2w --> two weeks from today
15405 ++5 --> five days from default date
15407 The function understands only English month and weekday abbreviations.
15409 While prompting, a calendar is popped up - you can also select the
15410 date with the mouse (button 1). The calendar shows a period of three
15411 months. To scroll it to other months, use the keys `>' and `<'.
15412 If you don't like the calendar, turn it off with
15413 \(setq org-read-date-popup-calendar nil)
15415 With optional argument TO-TIME, the date will immediately be converted
15416 to an internal time.
15417 With an optional argument WITH-TIME, the prompt will suggest to also
15418 insert a time. Note that when WITH-TIME is not set, you can still
15419 enter a time, and this function will inform the calling routine about
15420 this change. The calling routine may then choose to change the format
15421 used to insert the time stamp into the buffer to include the time.
15422 With optional argument FROM-STRING, read from this string instead from
15423 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15424 the time/date that is used for everything that is not specified by the
15425 user."
15426 (require 'parse-time)
15427 (let* ((org-time-stamp-rounding-minutes
15428 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15429 (org-dcst org-display-custom-times)
15430 (ct (org-current-time))
15431 (org-def (or org-overriding-default-time default-time ct))
15432 (org-defdecode (decode-time org-def))
15433 (dummy (progn
15434 (when (< (nth 2 org-defdecode) org-extend-today-until)
15435 (setcar (nthcdr 2 org-defdecode) -1)
15436 (setcar (nthcdr 1 org-defdecode) 59)
15437 (setq org-def (apply 'encode-time org-defdecode)
15438 org-defdecode (decode-time org-def)))))
15439 (calendar-frame-setup nil)
15440 (calendar-setup nil)
15441 (calendar-move-hook nil)
15442 (calendar-view-diary-initially-flag nil)
15443 (calendar-view-holidays-initially-flag nil)
15444 (timestr (format-time-string
15445 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15446 (prompt (concat (if prompt (concat prompt " ") "")
15447 (format "Date+time [%s]: " timestr)))
15448 ans (org-ans0 "") org-ans1 org-ans2 final)
15450 (cond
15451 (from-string (setq ans from-string))
15452 (org-read-date-popup-calendar
15453 (save-excursion
15454 (save-window-excursion
15455 (calendar)
15456 (org-eval-in-calendar '(setq cursor-type nil) t)
15457 (unwind-protect
15458 (progn
15459 (calendar-forward-day (- (time-to-days org-def)
15460 (calendar-absolute-from-gregorian
15461 (calendar-current-date))))
15462 (org-eval-in-calendar nil t)
15463 (let* ((old-map (current-local-map))
15464 (map (copy-keymap calendar-mode-map))
15465 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15466 (org-defkey map (kbd "RET") 'org-calendar-select)
15467 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15468 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15469 (org-defkey minibuffer-local-map [(meta shift left)]
15470 (lambda () (interactive)
15471 (org-eval-in-calendar '(calendar-backward-month 1))))
15472 (org-defkey minibuffer-local-map [(meta shift right)]
15473 (lambda () (interactive)
15474 (org-eval-in-calendar '(calendar-forward-month 1))))
15475 (org-defkey minibuffer-local-map [(meta shift up)]
15476 (lambda () (interactive)
15477 (org-eval-in-calendar '(calendar-backward-year 1))))
15478 (org-defkey minibuffer-local-map [(meta shift down)]
15479 (lambda () (interactive)
15480 (org-eval-in-calendar '(calendar-forward-year 1))))
15481 (org-defkey minibuffer-local-map [?\e (shift left)]
15482 (lambda () (interactive)
15483 (org-eval-in-calendar '(calendar-backward-month 1))))
15484 (org-defkey minibuffer-local-map [?\e (shift right)]
15485 (lambda () (interactive)
15486 (org-eval-in-calendar '(calendar-forward-month 1))))
15487 (org-defkey minibuffer-local-map [?\e (shift up)]
15488 (lambda () (interactive)
15489 (org-eval-in-calendar '(calendar-backward-year 1))))
15490 (org-defkey minibuffer-local-map [?\e (shift down)]
15491 (lambda () (interactive)
15492 (org-eval-in-calendar '(calendar-forward-year 1))))
15493 (org-defkey minibuffer-local-map [(shift up)]
15494 (lambda () (interactive)
15495 (org-eval-in-calendar '(calendar-backward-week 1))))
15496 (org-defkey minibuffer-local-map [(shift down)]
15497 (lambda () (interactive)
15498 (org-eval-in-calendar '(calendar-forward-week 1))))
15499 (org-defkey minibuffer-local-map [(shift left)]
15500 (lambda () (interactive)
15501 (org-eval-in-calendar '(calendar-backward-day 1))))
15502 (org-defkey minibuffer-local-map [(shift right)]
15503 (lambda () (interactive)
15504 (org-eval-in-calendar '(calendar-forward-day 1))))
15505 (org-defkey minibuffer-local-map ">"
15506 (lambda () (interactive)
15507 (org-eval-in-calendar '(scroll-calendar-left 1))))
15508 (org-defkey minibuffer-local-map "<"
15509 (lambda () (interactive)
15510 (org-eval-in-calendar '(scroll-calendar-right 1))))
15511 (org-defkey minibuffer-local-map "\C-v"
15512 (lambda () (interactive)
15513 (org-eval-in-calendar
15514 '(calendar-scroll-left-three-months 1))))
15515 (org-defkey minibuffer-local-map "\M-v"
15516 (lambda () (interactive)
15517 (org-eval-in-calendar
15518 '(calendar-scroll-right-three-months 1))))
15519 (run-hooks 'org-read-date-minibuffer-setup-hook)
15520 (unwind-protect
15521 (progn
15522 (use-local-map map)
15523 (setq org-read-date-inactive inactive)
15524 (add-hook 'post-command-hook 'org-read-date-display)
15525 (setq org-ans0 (read-string prompt default-input
15526 'org-read-date-history nil))
15527 ;; org-ans0: from prompt
15528 ;; org-ans1: from mouse click
15529 ;; org-ans2: from calendar motion
15530 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15531 (remove-hook 'post-command-hook 'org-read-date-display)
15532 (use-local-map old-map)
15533 (when org-read-date-overlay
15534 (delete-overlay org-read-date-overlay)
15535 (setq org-read-date-overlay nil)))))
15536 (bury-buffer "*Calendar*")))))
15538 (t ; Naked prompt only
15539 (unwind-protect
15540 (setq ans (read-string prompt default-input
15541 'org-read-date-history timestr))
15542 (when org-read-date-overlay
15543 (delete-overlay org-read-date-overlay)
15544 (setq org-read-date-overlay nil)))))
15546 (setq final (org-read-date-analyze ans org-def org-defdecode))
15548 (when org-read-date-analyze-forced-year
15549 (message "Year was forced into %s"
15550 (if org-read-date-force-compatible-dates
15551 "compatible range (1970-2037)"
15552 "range representable on this machine"))
15553 (ding))
15555 ;; One round trip to get rid of 34th of August and stuff like that....
15556 (setq final (decode-time (apply 'encode-time final)))
15558 (setq org-read-date-final-answer ans)
15560 (if to-time
15561 (apply 'encode-time final)
15562 (if (and (boundp 'org-time-was-given) org-time-was-given)
15563 (format "%04d-%02d-%02d %02d:%02d"
15564 (nth 5 final) (nth 4 final) (nth 3 final)
15565 (nth 2 final) (nth 1 final))
15566 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15568 (defvar org-def)
15569 (defvar org-defdecode)
15570 (defvar org-with-time)
15571 (defun org-read-date-display ()
15572 "Display the current date prompt interpretation in the minibuffer."
15573 (when org-read-date-display-live
15574 (when org-read-date-overlay
15575 (delete-overlay org-read-date-overlay))
15576 (when (minibufferp (current-buffer))
15577 (save-excursion
15578 (end-of-line 1)
15579 (while (not (equal (buffer-substring
15580 (max (point-min) (- (point) 4)) (point))
15581 " "))
15582 (insert " ")))
15583 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15584 " " (or org-ans1 org-ans2)))
15585 (org-end-time-was-given nil)
15586 (f (org-read-date-analyze ans org-def org-defdecode))
15587 (fmts (if org-dcst
15588 org-time-stamp-custom-formats
15589 org-time-stamp-formats))
15590 (fmt (if (or org-with-time
15591 (and (boundp 'org-time-was-given) org-time-was-given))
15592 (cdr fmts)
15593 (car fmts)))
15594 (txt (format-time-string fmt (apply 'encode-time f)))
15595 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15596 (txt (concat "=> " txt)))
15597 (when (and org-end-time-was-given
15598 (string-match org-plain-time-of-day-regexp txt))
15599 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15600 org-end-time-was-given
15601 (substring txt (match-end 0)))))
15602 (when org-read-date-analyze-futurep
15603 (setq txt (concat txt " (=>F)")))
15604 (setq org-read-date-overlay
15605 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15606 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
15608 (defun org-read-date-analyze (ans org-def org-defdecode)
15609 "Analyze the combined answer of the date prompt."
15610 ;; FIXME: cleanup and comment
15611 (let ((nowdecode (decode-time (current-time)))
15612 delta deltan deltaw deltadef year month day
15613 hour minute second wday pm h2 m2 tl wday1
15614 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15615 (setq org-read-date-analyze-futurep nil
15616 org-read-date-analyze-forced-year nil)
15618 (setq ans "+0"))
15620 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15621 (unless (save-match-data (string-match org-plain-time-of-day-regexp ans))
15622 (setq ans (replace-match "" t t ans)
15623 deltan (car delta)
15624 deltaw (nth 1 delta)
15625 deltadef (nth 2 delta))))
15627 ;; Check if there is an iso week date in there
15628 ;; If yes, store the info and postpone interpreting it until the rest
15629 ;; of the parsing is done
15630 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15631 (setq iso-year (if (match-end 1)
15632 (org-small-year-to-year
15633 (string-to-number (match-string 1 ans))))
15634 iso-weekday (if (match-end 3)
15635 (string-to-number (match-string 3 ans)))
15636 iso-week (string-to-number (match-string 2 ans)))
15637 (setq ans (replace-match "" t t ans)))
15639 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15640 (when (string-match
15642 (setq year (if (match-end 2)
15643 (string-to-number (match-string 2 ans))
15644 (progn (setq kill-year t)
15645 (string-to-number (format-time-string "%Y"))))
15646 month (string-to-number (match-string 3 ans))
15647 day (string-to-number (match-string 4 ans)))
15648 (if (< year 100) (setq year (+ 2000 year)))
15650 t nil ans)))
15652 ;; Help matching dotted european dates
15653 (when (string-match
15654 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15655 (setq year (if (match-end 3)
15656 (string-to-number (match-string 3 ans))
15657 (progn (setq kill-year t)
15658 (string-to-number (format-time-string "%Y"))))
15659 day (string-to-number (match-string 1 ans))
15660 month (string-to-number (match-string 2 ans))
15662 t nil ans)))
15664 ;; Help matching american dates, like 5/30 or 5/30/7
15665 (when (string-match
15666 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15667 (setq year (if (match-end 4)
15668 (string-to-number (match-string 4 ans))
15669 (progn (setq kill-year t)
15670 (string-to-number (format-time-string "%Y"))))
15671 month (string-to-number (match-string 1 ans))
15672 day (string-to-number (match-string 2 ans)))
15673 (if (< year 100) (setq year (+ 2000 year)))
15675 t nil ans)))
15676 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15677 ;; If there is a time with am/pm, and *no* time without it, we convert
15678 ;; so that matching will be successful.
15679 (loop for i from 1 to 2 do ; twice, for end time as well
15682 (setq hour (string-to-number (match-string 1 ans))
15683 minute (if (match-end 3)
15684 (string-to-number (match-string 3 ans))
15685 0)
15686 pm (equal ?p
15687 (string-to-char (downcase (match-string 4 ans)))))
15688 (if (and (= hour 12) (not pm))
15689 (setq hour 0)
15690 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15691 (setq ans (replace-match (format "%02d:%02d" hour minute)
15692 t t ans))))
15694 ;; Check if a time range is given as a duration
15695 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15696 (setq hour (string-to-number (match-string 1 ans))
15697 h2 (+ hour (string-to-number (match-string 3 ans)))
15698 minute (string-to-number (match-string 2 ans))
15699 m2 (+ minute (if (match-end 5) (string-to-number
15700 (match-string 5 ans))0)))
15701 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15702 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15703 t t ans)))
15705 ;; Check if there is a time range
15706 (when (boundp 'org-end-time-was-given)
15707 (setq org-time-was-given nil)
15708 (when (and (string-match org-plain-time-of-day-regexp ans)
15709 (match-end 8))
15710 (setq org-end-time-was-given (match-string 8 ans))
15711 (setq ans (concat (substring ans 0 (match-beginning 7))
15712 (substring ans (match-end 7))))))
15714 (setq tl (parse-time-string ans)
15715 day (or (nth 3 tl) (nth 3 org-defdecode))
15716 month (or (nth 4 tl)
15717 (if (and org-read-date-prefer-future
15718 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15719 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15720 (nth 4 org-defdecode)))
15721 year (or (and (not kill-year) (nth 5 tl))
15722 (if (and org-read-date-prefer-future
15723 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15724 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15725 (nth 5 org-defdecode)))
15726 hour (or (nth 2 tl) (nth 2 org-defdecode))
15727 minute (or (nth 1 tl) (nth 1 org-defdecode))
15728 second (or (nth 0 tl) 0)
15729 wday (nth 6 tl))
15731 (when (and (eq org-read-date-prefer-future 'time)
15732 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15733 (equal day (nth 3 nowdecode))
15734 (equal month (nth 4 nowdecode))
15735 (equal year (nth 5 nowdecode))
15736 (nth 2 tl)
15737 (or (< (nth 2 tl) (nth 2 nowdecode))
15738 (and (= (nth 2 tl) (nth 2 nowdecode))
15739 (nth 1 tl)
15740 (< (nth 1 tl) (nth 1 nowdecode)))))
15741 (setq day (1+ day)
15742 futurep t))
15744 ;; Special date definitions below
15745 (cond
15746 (iso-week
15747 ;; There was an iso week
15748 (require 'cal-iso)
15749 (setq futurep nil)
15750 (setq year (or iso-year year)
15751 day (or iso-weekday wday 1)
15752 wday nil ; to make sure that the trigger below does not match
15753 iso-date (calendar-gregorian-from-absolute
15754 (calendar-absolute-from-iso
15755 (list iso-week day year))))
15756 ; FIXME: Should we also push ISO weeks into the future?
15757 ; (when (and org-read-date-prefer-future
15758 ; (not iso-year)
15759 ; (< (calendar-absolute-from-gregorian iso-date)
15760 ; (time-to-days (current-time))))
15761 ; (setq year (1+ year)
15762 ; iso-date (calendar-gregorian-from-absolute
15763 ; (calendar-absolute-from-iso
15764 ; (list iso-week day year)))))
15765 (setq month (car iso-date)
15766 year (nth 2 iso-date)
15767 day (nth 1 iso-date)))
15768 (deltan
15769 (setq futurep nil)
15770 (unless deltadef
15771 (let ((now (decode-time (current-time))))
15772 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15773 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15774 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15775 ((equal deltaw "m") (setq month (+ month deltan)))
15776 ((equal deltaw "y") (setq year (+ year deltan)))))
15777 ((and wday (not (nth 3 tl)))
15778 ;; Weekday was given, but no day, so pick that day in the week
15779 ;; on or after the derived date.
15780 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15781 (unless (equal wday wday1)
15782 (setq day (+ day (% (- wday wday1 -7) 7))))))
15783 (if (and (boundp 'org-time-was-given)
15784 (nth 2 tl))
15785 (setq org-time-was-given t))
15786 (if (< year 100) (setq year (+ 2000 year)))
15787 ;; Check of the date is representable
15788 (if org-read-date-force-compatible-dates
15789 (progn
15790 (if (< year 1970)
15791 (setq year 1970 org-read-date-analyze-forced-year t))
15792 (if (> year 2037)
15793 (setq year 2037 org-read-date-analyze-forced-year t)))
15794 (condition-case nil
15795 (ignore (encode-time second minute hour day month year))
15796 (error
15797 (setq year (nth 5 org-defdecode))
15798 (setq org-read-date-analyze-forced-year t))))
15799 (setq org-read-date-analyze-futurep futurep)
15800 (list second minute hour day month year)))
15802 (defvar parse-time-weekdays)
15803 (defun org-read-date-get-relative (s today default)
15804 "Check string S for special relative date string.
15805 TODAY and DEFAULT are internal times, for today and for a default.
15806 Return shift list (N what def-flag)
15808 N is the number of WHATs to shift.
15809 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15810 the DEFAULT date rather than TODAY."
15811 (require 'parse-time)
15812 (when (and
15813 (string-match
15814 (concat
15819 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15820 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15821 (string-to-char (substring (match-string 1 s) -1))
15822 ?+))
15823 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15824 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15825 (what (if (match-end 3) (match-string 3 s) "d"))
15826 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15827 (date (if rel default today))
15828 (wday (nth 6 (decode-time date)))
15829 delta)
15830 (if wday1
15831 (progn
15832 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15833 (if (= dir ?-) (setq delta (- delta 7)))
15834 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15835 (list delta "d" rel))
15836 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15838 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15839 "Turn a user-specified date into the internal representation.
15840 The internal representation needed by the calendar is (month day year).
15841 This is a wrapper to handle the brain-dead convention in calendar that
15842 user function argument order change dependent on argument order."
15843 (if (boundp 'calendar-date-style)
15844 (cond
15845 ((eq calendar-date-style 'american)
15846 (list arg1 arg2 arg3))
15847 ((eq calendar-date-style 'european)
15848 (list arg2 arg1 arg3))
15849 ((eq calendar-date-style 'iso)
15850 (list arg2 arg3 arg1)))
15851 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15852 (if (org-bound-and-true-p european-calendar-style)
15853 (list arg2 arg1 arg3)
15854 (list arg1 arg2 arg3)))))
15856 (defun org-eval-in-calendar (form &optional keepdate)
15857 "Eval FORM in the calendar window and return to current window.
15858 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
15859 otherwise stick to the current value of `org-ans2'."
15860 (let ((sf (selected-frame))
15861 (sw (selected-window)))
15862 (select-window (get-buffer-window "*Calendar*" t))
15863 (eval form)
15864 (when (and (not keepdate) (calendar-cursor-to-date))
15865 (let* ((date (calendar-cursor-to-date))
15866 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15867 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15868 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15869 (select-window sw)
15870 (org-select-frame-set-input-focus sf)))
15872 (defun org-calendar-select ()
15873 "Return to `org-read-date' with the date currently selected.
15874 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15875 (interactive)
15876 (when (calendar-cursor-to-date)
15877 (let* ((date (calendar-cursor-to-date))
15878 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15879 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15880 (if (active-minibuffer-window) (exit-minibuffer))))
15882 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15883 "Insert a date stamp for the date given by the internal TIME.
15884 WITH-HM means use the stamp format that includes the time of the day.
15885 INACTIVE means use square brackets instead of angular ones, so that the
15886 stamp will not contribute to the agenda.
15887 PRE and POST are optional strings to be inserted before and after the
15888 stamp.
15889 The command returns the inserted time stamp."
15890 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15891 stamp)
15892 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15893 (insert-before-markers (or pre ""))
15894 (when (listp extra)
15895 (setq extra (car extra))
15896 (if (and (stringp extra)
15898 (setq extra (format "-%02d:%02d"
15899 (string-to-number (match-string 1 extra))
15900 (string-to-number (match-string 2 extra))))
15901 (setq extra nil)))
15902 (when extra
15903 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15904 (insert-before-markers (setq stamp (format-time-string fmt time)))
15905 (insert-before-markers (or post ""))
15906 (setq org-last-inserted-timestamp stamp)))
15908 (defun org-toggle-time-stamp-overlays ()
15909 "Toggle the use of custom time stamp formats."
15910 (interactive)
15911 (setq org-display-custom-times (not org-display-custom-times))
15912 (unless org-display-custom-times
15913 (let ((p (point-min)) (bmp (buffer-modified-p)))
15914 (while (setq p (next-single-property-change p 'display))
15915 (if (and (get-text-property p 'display)
15916 (eq (get-text-property p 'face) 'org-date))
15917 (remove-text-properties
15918 p (setq p (next-single-property-change p 'display))
15919 '(display t))))
15920 (set-buffer-modified-p bmp)))
15921 (if (featurep 'xemacs)
15922 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15923 (org-restart-font-lock)
15924 (setq org-table-may-need-update t)
15925 (if org-display-custom-times
15926 (message "Time stamps are overlaid with custom format")
15927 (message "Time stamp overlays removed")))
15929 (defun org-display-custom-time (beg end)
15930 "Overlay modified time stamp format over timestamp between BEG and END."
15931 (let* ((ts (buffer-substring beg end))
15932 t1 w1 with-hm tf time str w2 (off 0))
15933 (save-match-data
15934 (setq t1 (org-parse-time-string ts t))
15935 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
15936 (setq off (- (match-end 0) (match-beginning 0)))))
15937 (setq end (- end off))
15938 (setq w1 (- end beg)
15939 with-hm (and (nth 1 t1) (nth 2 t1))
15940 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15941 time (org-fix-decoded-time t1)
15942 str (org-add-props
15943 (format-time-string
15944 (substring tf 1 -1) (apply 'encode-time time))
15945 nil 'mouse-face 'highlight)
15946 w2 (length str))
15947 (if (not (= w2 w1))
15948 (add-text-properties (1+ beg) (+ 2 beg)
15949 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15950 (if (featurep 'xemacs)
15951 (progn
15952 (put-text-property beg end 'invisible t)
15953 (put-text-property beg end 'end-glyph (make-glyph str)))
15954 (put-text-property beg end 'display str))))
15956 (defun org-translate-time (string)
15957 "Translate all timestamps in STRING to custom format.
15958 But do this only if the variable `org-display-custom-times' is set."
15959 (when org-display-custom-times
15960 (save-match-data
15961 (let* ((start 0)
15962 (re org-ts-regexp-both)
15963 t1 with-hm inactive tf time str beg end)
15964 (while (setq start (string-match re string start))
15965 (setq beg (match-beginning 0)
15966 end (match-end 0)
15967 t1 (save-match-data
15968 (org-parse-time-string (substring string beg end) t))
15969 with-hm (and (nth 1 t1) (nth 2 t1))
15970 inactive (equal (substring string beg (1+ beg)) "[")
15971 tf (funcall (if with-hm 'cdr 'car)
15972 org-time-stamp-custom-formats)
15973 time (org-fix-decoded-time t1)
15974 str (format-time-string
15975 (concat
15976 (if inactive "[" "<") (substring tf 1 -1)
15977 (if inactive "]" ">"))
15978 (apply 'encode-time time))
15979 string (replace-match str t t string)
15980 start (+ start (length str)))))))
15981 string)
15983 (defun org-fix-decoded-time (time)
15984 "Set 0 instead of nil for the first 6 elements of time.
15985 Don't touch the rest."
15986 (let ((n 0))
15987 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15989 (defun org-days-to-time (timestamp-string)
15990 "Difference between TIMESTAMP-STRING and now in days."
15991 (- (time-to-days (org-time-string-to-time timestamp-string))
15992 (time-to-days (current-time))))
15994 (defun org-deadline-close (timestamp-string &optional ndays)
15995 "Is the time in TIMESTAMP-STRING close to the current date?"
15996 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15997 (and (< (org-days-to-time timestamp-string) ndays)
15998 (not (org-entry-is-done-p))))
16000 (defun org-get-wdays (ts)
16001 "Get the deadline lead time appropriate for timestring TS."
16002 (cond
16003 ((<= org-deadline-warning-days 0)
16004 ;; 0 or negative, enforce this value no matter what
16005 (- org-deadline-warning-days))
16007 ;; lead time is specified.
16008 (floor (* (string-to-number (match-string 1 ts))
16009 (cdr (assoc (match-string 2 ts)
16010 '(("d" . 1) ("w" . 7)
16011 ("m" . 30.4) ("y" . 365.25)))))))
16012 ;; go for the default.
16013 (t org-deadline-warning-days)))
16015 (defun org-calendar-select-mouse (ev)
16016 "Return to `org-read-date' with the date currently selected.
16017 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16018 (interactive "e")
16019 (mouse-set-point ev)
16020 (when (calendar-cursor-to-date)
16021 (let* ((date (calendar-cursor-to-date))
16022 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16023 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16024 (if (active-minibuffer-window) (exit-minibuffer))))
16026 (defun org-check-deadlines (ndays)
16027 "Check if there are any deadlines due or past due.
16028 A deadline is considered due if it happens within `org-deadline-warning-days'
16029 days from today's date. If the deadline appears in an entry marked DONE,
16030 it is not shown. The prefix arg NDAYS can be used to test that many
16032 (interactive "P")
16033 (let* ((org-warn-days
16034 (cond
16035 ((equal ndays '(4)) 100000)
16036 (ndays (prefix-numeric-value ndays))
16037 (t (abs org-deadline-warning-days))))
16038 (case-fold-search nil)
16040 (callback
16041 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16043 (message "%d deadlines past-due or due within %d days"
16044 (org-occur regexp nil callback)
16045 org-warn-days)))
16047 (defsubst org-re-timestamp (type)
16048 "Return a regexp for timestamp TYPE.
16049 Allowed values for TYPE are:
16051 all: all timestamps
16052 active: only active timestamps (<...>)
16053 inactive: only inactive timestamps ([...])
16054 scheduled: only scheduled timestamps
16055 deadline: only deadline timestamps
16057 When TYPE is nil, fall back on returning a regexp that matches
16058 both scheduled and deadline timestamps."
16059 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16060 ((eq type 'active) org-ts-regexp)
16064 ((eq type 'scheduled-or-deadline)
16067 (defun org-check-before-date (date)
16068 "Check if there are deadlines or scheduled entries before DATE."
16069 (interactive (list (org-read-date)))
16070 (let ((case-fold-search nil)
16071 (regexp (org-re-timestamp org-ts-type))
16072 (callback
16073 (lambda () (time-less-p
16074 (org-time-string-to-time (match-string 1))
16075 (org-time-string-to-time date)))))
16076 (message "%d entries before %s"
16077 (org-occur regexp nil callback) date)))
16079 (defun org-check-after-date (date)
16080 "Check if there are deadlines or scheduled entries after DATE."
16081 (interactive (list (org-read-date)))
16082 (let ((case-fold-search nil)
16083 (regexp (org-re-timestamp org-ts-type))
16084 (callback
16085 (lambda () (not
16086 (time-less-p
16087 (org-time-string-to-time (match-string 1))
16088 (org-time-string-to-time date))))))
16089 (message "%d entries after %s"
16090 (org-occur regexp nil callback) date)))
16092 (defun org-check-dates-range (start-date end-date)
16093 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16094 (interactive (list (org-read-date nil nil nil "Range starts")
16095 (org-read-date nil nil nil "Range end")))
16096 (let ((case-fold-search nil)
16097 (regexp (org-re-timestamp org-ts-type))
16098 (callback
16099 (lambda ()
16100 (let ((match (match-string 1)))
16101 (and
16102 (not (time-less-p
16103 (org-time-string-to-time match)
16104 (org-time-string-to-time start-date)))
16105 (time-less-p
16106 (org-time-string-to-time match)
16107 (org-time-string-to-time end-date)))))))
16108 (message "%d entries between %s and %s"
16109 (org-occur regexp nil callback) start-date end-date)))
16111 (defun org-evaluate-time-range (&optional to-buffer)
16112 "Evaluate a time range by computing the difference between start and end.
16113 Normally the result is just printed in the echo area, but with prefix arg
16114 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16115 If the time range is actually in a table, the result is inserted into the
16116 next column.
16117 For time difference computation, a year is assumed to be exactly 365
16118 days in order to avoid rounding problems."
16119 (interactive "P")
16120 (or
16121 (org-clock-update-time-maybe)
16122 (save-excursion
16123 (unless (org-at-date-range-p t)
16124 (goto-char (point-at-bol))
16125 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16126 (if (not (org-at-date-range-p t))
16127 (error "Not at a time-stamp range, and none found in current line")))
16128 (let* ((ts1 (match-string 1))
16129 (ts2 (match-string 2))
16130 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16131 (match-end (match-end 0))
16132 (time1 (org-time-string-to-time ts1))
16133 (time2 (org-time-string-to-time ts2))
16134 (t1 (org-float-time time1))
16135 (t2 (org-float-time time2))
16136 (diff (abs (- t2 t1)))
16137 (negative (< (- t2 t1) 0))
16138 ;; (ys (floor (* 365 24 60 60)))
16139 (ds (* 24 60 60))
16140 (hs (* 60 60))
16141 (fy "%dy %dd %02d:%02d")
16142 (fy1 "%dy %dd")
16143 (fd "%dd %02d:%02d")
16144 (fd1 "%dd")
16145 (fh "%02d:%02d")
16146 y d h m align)
16147 (if havetime
16148 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16149 y 0
16150 d (floor (/ diff ds)) diff (mod diff ds)
16151 h (floor (/ diff hs)) diff (mod diff hs)
16152 m (floor (/ diff 60)))
16153 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16154 y 0
16155 d (floor (+ (/ diff ds) 0.5))
16156 h 0 m 0))
16157 (if (not to-buffer)
16158 (message "%s" (org-make-tdiff-string y d h m))
16159 (if (org-at-table-p)
16160 (progn
16161 (goto-char match-end)
16162 (setq align t)
16163 (and (looking-at " *|") (goto-char (match-end 0))))
16164 (goto-char match-end))
16165 (if (looking-at
16167 (replace-match ""))
16168 (if negative (insert " -"))
16169 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16170 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16171 (insert " " (format fh h m))))
16172 (if align (org-table-align))
16173 (message "Time difference inserted")))))
16175 (defun org-make-tdiff-string (y d h m)
16176 (let ((fmt "")
16177 (l nil))
16178 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16179 l (push y l)))
16180 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16181 l (push d l)))
16182 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16183 l (push h l)))
16184 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16185 l (push m l)))
16186 (apply 'format fmt (nreverse l))))
16188 (defun org-time-string-to-time (s &optional buffer pos)
16189 (condition-case errdata
16190 (apply 'encode-time (org-parse-time-string s))
16192 s (if (not (and buffer pos))
16193 ""
16194 (format " at %d in buffer `%s'" pos buffer))
16195 (cdr errdata)))))
16197 (defun org-time-string-to-seconds (s)
16198 (org-float-time (org-time-string-to-time s)))
16200 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16201 "Convert a time stamp to an absolute day number.
16202 If there is a specifier for a cyclic time stamp, get the closest date to
16203 DAYNR.
16204 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16205 The variable date is bound by the calendar when this is called."
16206 (cond
16208 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16209 daynr
16210 (+ daynr 1000)))
16212 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16213 (time-to-days (current-time))) (match-string 0 s)
16214 prefer show-all))
16215 (t (time-to-days
16216 (condition-case errdata
16217 (apply 'encode-time (org-parse-time-string s))
16219 s (if (not (and buffer pos))
16220 ""
16221 (format " at %d in buffer `%s'" pos buffer))
16222 (cdr errdata))))))))
16224 (defun org-days-to-iso-week (days)
16225 "Return the iso week number."
16226 (require 'cal-iso)
16227 (car (calendar-iso-from-absolute days)))
16229 (defun org-small-year-to-year (year)
16230 "Convert 2-digit years into 4-digit years.
16231 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16232 The year 2000 cannot be abbreviated. Any year larger than 99
16233 is returned unchanged."
16234 (if (< year 38)
16235 (setq year (+ 2000 year))
16236 (if (< year 100)
16237 (setq year (+ 1900 year))))
16238 year)
16240 (defun org-time-from-absolute (d)
16241 "Return the time corresponding to date D.
16242 D may be an absolute day number, or a calendar-type list (month day year)."
16243 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16244 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16246 (defun org-calendar-holiday ()
16247 "List of holidays, for Diary display in Org-mode."
16248 (require 'holidays)
16249 (let ((hl (funcall
16250 (if (fboundp 'calendar-check-holidays)
16251 'calendar-check-holidays 'check-calendar-holidays) date)))
16252 (if hl (mapconcat 'identity hl "; "))))
16254 (defun org-diary-sexp-entry (sexp entry date)
16255 "Process a SEXP diary ENTRY for DATE."
16256 (require 'diary-lib)
16257 (let ((result (if calendar-debug-sexp
16258 (let ((stack-trace-on-error t))
16259 (eval (car (read-from-string sexp))))
16260 (condition-case nil
16261 (eval (car (read-from-string sexp)))
16262 (error
16263 (beep)
16264 (message "Bad sexp at line %d in %s: %s"
16265 (org-current-line)
16266 (buffer-file-name) sexp)
16267 (sleep-for 2))))))
16268 (cond ((stringp result) (split-string result "; "))
16269 ((and (consp result)
16270 (not (consp (cdr result)))
16271 (stringp (cdr result))) (cdr result))
16272 ((and (consp result)
16273 (stringp (car result))) result)
16274 (result entry))))
16276 (defun org-diary-to-ical-string (frombuf)
16277 "Get iCalendar entries from diary entries in buffer FROMBUF.
16278 This uses the icalendar.el library."
16279 (let* ((tmpdir (if (featurep 'xemacs)
16280 (temp-directory)
16281 temporary-file-directory))
16282 (tmpfile (make-temp-name
16283 (expand-file-name "orgics" tmpdir)))
16284 buf rtn b e)
16285 (with-current-buffer frombuf
16286 (icalendar-export-region (point-min) (point-max) tmpfile)
16287 (setq buf (find-buffer-visiting tmpfile))
16288 (set-buffer buf)
16289 (goto-char (point-min))
16290 (if (re-search-forward "^BEGIN:VEVENT" nil t)
16291 (setq b (match-beginning 0)))
16292 (goto-char (point-max))
16293 (if (re-search-backward "^END:VEVENT" nil t)
16294 (setq e (match-end 0)))
16296 (kill-buffer buf)
16297 (delete-file tmpfile)
16298 rtn))
16300 (defun org-closest-date (start current change prefer show-all)
16301 "Find the date closest to CURRENT that is consistent with START and CHANGE.
16302 When PREFER is `past', return a date that is either CURRENT or past.
16303 When PREFER is `future', return a date that is either CURRENT or future.
16304 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
16305 ;; Make the proper lists from the dates
16306 (catch 'exit
16307 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
16308 dn dw sday cday n1 n2 n0
16309 d m y y1 y2 date1 date2 nmonths nm ny m2)
16311 (setq start (org-date-to-gregorian start)
16312 current (org-date-to-gregorian
16313 (if show-all
16314 current
16315 (time-to-days (current-time))))
16316 sday (calendar-absolute-from-gregorian start)
16317 cday (calendar-absolute-from-gregorian current))
16319 (if (<= cday sday) (throw 'exit sday))
16322 (setq dn (string-to-number (match-string 1 change))
16323 dw (cdr (assoc (match-string 2 change) a1)))
16324 (error "Invalid change specifier: %s" change))
16325 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16326 (cond
16327 ((eq dw 'day)
16328 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16329 n2 (+ n1 dn)))
16330 ((eq dw 'year)
16331 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16332 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16333 (setq date1 (list m d y1)
16334 n1 (calendar-absolute-from-gregorian date1)
16335 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16336 n2 (calendar-absolute-from-gregorian date2)))
16337 ((eq dw 'month)
16338 ;; approx number of month between the two dates
16339 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16340 ;; How often does dn fit in there?
16341 (setq d (nth 1 start) m (car start) y (nth 2 start)
16342 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16343 m (+ m nm)
16344 ny (floor (/ m 12))
16345 y (+ y ny)
16346 m (- m (* ny 12)))
16347 (while (> m 12) (setq m (- m 12) y (1+ y)))
16348 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16349 (setq m2 (+ m dn) y2 y)
16350 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16351 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16352 (while (<= n2 cday)
16353 (setq n1 n2 m m2 y y2)
16354 (setq m2 (+ m dn) y2 y)
16355 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16356 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
16357 ;; Make sure n1 is the earlier date
16358 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16359 (if show-all
16360 (cond
16361 ((eq prefer 'past) (if (= cday n2) n2 n1))
16362 ((eq prefer 'future) (if (= cday n1) n1 n2))
16363 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16364 (cond
16365 ((eq prefer 'past) (if (= cday n2) n2 n1))
16366 ((eq prefer 'future) (if (= cday n1) n1 n2))
16367 (t (if (= cday n1) n1 n2)))))))
16369 (defun org-date-to-gregorian (date)
16370 "Turn any specification of DATE into a Gregorian date for the calendar."
16371 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16372 ((and (listp date) (= (length date) 3)) date)
16373 ((stringp date)
16374 (setq date (org-parse-time-string date))
16375 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16376 ((listp date)
16377 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16379 (defun org-parse-time-string (s &optional nodefault)
16380 "Parse the standard Org-mode time string.
16381 This should be a lot faster than the normal `parse-time-string'.
16382 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16383 hour and minute fields will be nil if not given."
16384 (if (string-match org-ts-regexp0 s)
16385 (list 0
16386 (if (or (match-beginning 8) (not nodefault))
16387 (string-to-number (or (match-string 8 s) "0")))
16388 (if (or (match-beginning 7) (not nodefault))
16389 (string-to-number (or (match-string 7 s) "0")))
16390 (string-to-number (match-string 4 s))
16391 (string-to-number (match-string 3 s))
16392 (string-to-number (match-string 2 s))
16393 nil nil nil)
16394 (error "Not a standard Org-mode time string: %s" s)))
16396 (defun org-timestamp-up (&optional arg)
16397 "Increase the date item at the cursor by one.
16398 If the cursor is on the year, change the year. If it is on the month,
16399 the day or the time, change that.
16400 With prefix ARG, change by that many units."
16401 (interactive "p")
16402 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16404 (defun org-timestamp-down (&optional arg)
16405 "Decrease the date item at the cursor by one.
16406 If the cursor is on the year, change the year. If it is on the month,
16407 the day or the time, change that.
16408 With prefix ARG, change by that many units."
16409 (interactive "p")
16410 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16412 (defun org-timestamp-up-day (&optional arg)
16413 "Increase the date in the time stamp by one day.
16414 With prefix ARG, change that many days."
16415 (interactive "p")
16416 (if (and (not (org-at-timestamp-p t))
16417 (org-at-heading-p))
16418 (org-todo 'up)
16419 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16421 (defun org-timestamp-down-day (&optional arg)
16422 "Decrease the date in the time stamp by one day.
16423 With prefix ARG, change that many days."
16424 (interactive "p")
16425 (if (and (not (org-at-timestamp-p t))
16426 (org-at-heading-p))
16427 (org-todo 'down)
16428 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16430 (defun org-at-timestamp-p (&optional inactive-ok)
16431 "Determine if the cursor is in or at a timestamp."
16432 (interactive)
16433 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16434 (pos (point))
16435 (ans (or (looking-at tsr)
16436 (save-excursion
16438 (if (> (point) (point-min)) (backward-char 1))
16439 (and (looking-at tsr)
16440 (> (- (match-end 0) pos) -1))))))
16441 (and ans
16442 (boundp 'org-ts-what)
16443 (setq org-ts-what
16444 (cond
16445 ((= pos (match-beginning 0)) 'bracket)
16446 ;; Point is considered to be "on the bracket" whether
16447 ;; it's really on it or right after it.
16448 ((= pos (1- (match-end 0))) 'bracket)
16449 ((= pos (match-end 0)) 'after)
16450 ((org-pos-in-match-range pos 2) 'year)
16451 ((org-pos-in-match-range pos 3) 'month)
16452 ((org-pos-in-match-range pos 7) 'hour)
16453 ((org-pos-in-match-range pos 8) 'minute)
16454 ((or (org-pos-in-match-range pos 4)
16455 (org-pos-in-match-range pos 5)) 'day)
16456 ((and (> pos (or (match-end 8) (match-end 5)))
16457 (< pos (match-end 0)))
16458 (- pos (or (match-end 8) (match-end 5))))
16459 (t 'day))))
16460 ans))
16462 (defun org-toggle-timestamp-type ()
16463 "Toggle the type (<active> or [inactive]) of a time stamp."
16464 (interactive)
16465 (when (org-at-timestamp-p t)
16466 (let ((beg (match-beginning 0)) (end (match-end 0))
16467 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16468 (save-excursion
16469 (goto-char beg)
16470 (while (re-search-forward "[][<>]" end t)
16471 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16472 t t)))
16473 (message "Timestamp is now %sactive"
16474 (if (equal (char-after beg) ?<) "" "in")))))
16476 (defvar org-clock-history) ; defined in org-clock.el
16477 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
16478 (defun org-timestamp-change (n &optional what updown)
16479 "Change the date in the time stamp at point.
16480 The date will be changed by N times WHAT. WHAT can be `day', `month',
16481 `year', `minute', `second'. If WHAT is not given, the cursor position
16482 in the timestamp determines what will be changed."
16483 (let ((origin (point)) origin-cat
16484 with-hm inactive
16485 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16486 org-ts-what
16487 extra rem
16488 ts time time0 fixnext clrgx)
16489 (if (not (org-at-timestamp-p t))
16490 (error "Not at a timestamp"))
16491 (if (and (not what) (eq org-ts-what 'bracket))
16492 (org-toggle-timestamp-type)
16493 ;; Point isn't on brackets. Remember the part of the time-stamp
16494 ;; the point was in. Indeed, size of time-stamps may change,
16495 ;; but point must be kept in the same category nonetheless.
16496 (setq origin-cat org-ts-what)
16497 (if (and (not what) (not (eq org-ts-what 'day))
16498 org-display-custom-times
16499 (get-text-property (point) 'display)
16500 (not (get-text-property (1- (point)) 'display)))
16501 (setq org-ts-what 'day))
16502 (setq org-ts-what (or what org-ts-what)
16503 inactive (= (char-after (match-beginning 0)) ?\[)
16504 ts (match-string 0))
16505 (replace-match "")
16506 (if (string-match
16508 ts)
16509 (setq extra (match-string 1 ts)))
16511 (setq with-hm t))
16512 (setq time0 (org-parse-time-string ts))
16513 (when (and updown
16514 (eq org-ts-what 'minute)
16515 (not current-prefix-arg))
16516 ;; This looks like s-up and s-down. Change by one rounding step.
16517 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16518 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16519 (setcar (cdr time0) (+ (nth 1 time0)
16520 (if (> n 0) (- rem) (- dm rem))))))
16521 (setq time
16522 (encode-time (or (car time0) 0)
16523 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16524 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16525 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16526 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16527 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16528 (nthcdr 6 time0)))
16529 (when (and (member org-ts-what '(hour minute))
16530 extra
16532 (setq extra (org-modify-ts-extra
16533 extra
16534 (if (eq org-ts-what 'hour) 2 5)
16535 n dm)))
16536 (when (integerp org-ts-what)
16537 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16538 (if (eq what 'calendar)
16539 (let ((cal-date (org-get-date-from-calendar)))
16540 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16541 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16542 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16543 (setcar time0 (or (car time0) 0))
16544 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16545 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16546 (setq time (apply 'encode-time time0))))
16547 ;; Insert the new time-stamp, and ensure point stays in the same
16548 ;; category as before (i.e. not after the last position in that
16549 ;; category).
16550 (let ((pos (point)))
16551 ;; Stay before inserted string. `save-excursion' is of no use.
16552 (setq org-last-changed-timestamp
16553 (org-insert-time-stamp time with-hm inactive nil nil extra))
16554 (goto-char pos))
16555 (save-match-data
16556 (looking-at org-ts-regexp3)
16557 (goto-char (cond
16558 ;; `day' category ends before `hour' if any, or at
16559 ;; the end of the day name.
16560 ((eq origin-cat 'day)
16561 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16562 ((eq origin-cat 'hour) (min (match-end 7) origin))
16563 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16564 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16565 ;; `year' and `month' have both fixed size: point
16566 ;; couldn't have moved into another part.
16567 (t origin))))
16568 ;; Update clock if on a CLOCK line.
16569 (org-clock-update-time-maybe)
16570 ;; Maybe adjust the closest clock in `org-clock-history'
16571 (when org-clock-adjust-closest
16572 (if (not (and (org-at-clock-log-p)
16573 (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
16574 org-clock-history))))))
16575 (message "No clock to adjust")
16576 (cond ((save-excursion ; fix previous clock?
16577 (re-search-backward org-ts-regexp0 nil t)
16580 ((save-excursion ; fix next clock?
16581 (re-search-backward org-ts-regexp0 nil t)
16584 (save-window-excursion
16585 ;; Find closest clock to point, adjust the previous/next one in history
16586 (let* ((p (save-excursion (org-back-to-heading t)))
16587 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
16588 (clfixnth
16589 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
16590 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
16591 (if (not clfixpos)
16592 (message "No clock to adjust")
16593 (save-excursion
16594 (org-goto-marker-or-bmk clfixpos)
16595 (org-show-subtree)
16596 (when (re-search-forward clrgx nil t)
16597 (goto-char (match-beginning 1))
16598 (let (org-clock-adjust-closest)
16599 (org-timestamp-change n org-ts-what updown))
16600 (message "Clock adjusted in %s for heading: %s"
16601 (file-name-nondirectory (buffer-file-name))
16602 (org-get-heading t t)))))))))
16603 ;; Try to recenter the calendar window, if any.
16604 (if (and org-calendar-follow-timestamp-change
16605 (get-buffer-window "*Calendar*" t)
16606 (memq org-ts-what '(day month year)))
16607 (org-recenter-calendar (time-to-days time))))))
16609 (defun org-modify-ts-extra (s pos n dm)
16610 "Change the different parts of the lead-time and repeat fields in timestamp."
16611 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16612 ng h m new rem)
16613 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16614 (cond
16615 ((or (org-pos-in-match-range pos 2)
16616 (org-pos-in-match-range pos 3))
16617 (setq m (string-to-number (match-string 3 s))
16618 h (string-to-number (match-string 2 s)))
16619 (if (org-pos-in-match-range pos 2)
16620 (setq h (+ h n))
16621 (setq n (* dm (org-no-warnings (signum n))))
16622 (when (not (= 0 (setq rem (% m dm))))
16623 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16624 (setq m (+ m n)))
16625 (if (< m 0) (setq m (+ m 60) h (1- h)))
16626 (if (> m 59) (setq m (- m 60) h (1+ h)))
16627 (setq h (min 24 (max 0 h)))
16628 (setq ng 1 new (format "-%02d:%02d" h m)))
16629 ((org-pos-in-match-range pos 6)
16630 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16631 ((org-pos-in-match-range pos 5)
16632 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16634 ((org-pos-in-match-range pos 9)
16635 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16636 ((org-pos-in-match-range pos 8)
16637 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16639 (when ng
16640 (setq s (concat
16641 (substring s 0 (match-beginning ng))
16642 new
16643 (substring s (match-end ng))))))
16644 s))
16646 (defun org-recenter-calendar (date)
16647 "If the calendar is visible, recenter it to DATE."
16648 (let ((cwin (get-buffer-window "*Calendar*" t)))
16649 (when cwin
16650 (let ((calendar-move-hook nil))
16651 (with-selected-window cwin
16652 (calendar-goto-date (if (listp date) date
16653 (calendar-gregorian-from-absolute date))))))))
16655 (defun org-goto-calendar (&optional arg)
16656 "Go to the Emacs calendar at the current date.
16657 If there is a time stamp in the current line, go to that date.
16658 A prefix ARG can be used to force the current date."
16659 (interactive "P")
16660 (let ((tsr org-ts-regexp) diff
16661 (calendar-move-hook nil)
16662 (calendar-view-holidays-initially-flag nil)
16663 (calendar-view-diary-initially-flag nil))
16664 (if (or (org-at-timestamp-p)
16665 (save-excursion
16666 (beginning-of-line 1)
16667 (looking-at (concat ".*" tsr))))
16668 (let ((d1 (time-to-days (current-time)))
16669 (d2 (time-to-days
16670 (org-time-string-to-time (match-string 1)))))
16671 (setq diff (- d2 d1))))
16672 (calendar)
16673 (calendar-goto-today)
16674 (if (and diff (not arg)) (calendar-forward-day diff))))
16676 (defun org-get-date-from-calendar ()
16677 "Return a list (month day year) of date at point in calendar."
16678 (with-current-buffer "*Calendar*"
16679 (save-match-data
16680 (calendar-cursor-to-date))))
16682 (defun org-date-from-calendar ()
16683 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16684 If there is already a time stamp at the cursor position, update it."
16685 (interactive)
16686 (if (org-at-timestamp-p t)
16687 (org-timestamp-change 0 'calendar)
16688 (let ((cal-date (org-get-date-from-calendar)))
16689 (org-insert-time-stamp
16690 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16692 (defun org-minutes-to-hh:mm-string (m)
16693 "Compute H:MM from a number of minutes."
16694 (let ((h (/ m 60)))
16695 (setq m (- m (* 60 h)))
16696 (format org-time-clocksum-format h m)))
16698 (defun org-hh:mm-string-to-minutes (s)
16699 "Convert a string H:MM to a number of minutes.
16700 If the string is just a number, interpret it as minutes.
16701 In fact, the first hh:mm or number in the string will be taken,
16702 there can be extra stuff in the string.
16703 If no number is found, the return value is 0."
16704 (cond
16705 ((integerp s) s)
16707 (+ (* (string-to-number (match-string 1 s)) 60)
16708 (string-to-number (match-string 2 s))))
16710 (string-to-number (match-string 1 s)))
16711 (t 0)))
16713 (defcustom org-effort-durations
16714 `(("h" . 60)
16715 ("d" . ,(* 60 8))
16716 ("w" . ,(* 60 8 5))
16717 ("m" . ,(* 60 8 5 4))
16718 ("y" . ,(* 60 8 5 40)))
16719 "Conversion factor to minutes for an effort modifier.
16721 Each entry has the form (MODIFIER . MINUTES).
16723 In an effort string, a number followed by MODIFIER is multiplied
16724 by the specified number of MINUTES to obtain an effort in
16725 minutes.
16729 :group 'org-agenda
16730 :version "24.1"
16731 :type '(alist :key-type (string :tag "Modifier")
16732 :value-type (number :tag "Minutes")))
16734 (defun org-duration-string-to-minutes (s &optional output-to-string)
16735 "Convert a duration string S to minutes.
16737 A bare number is interpreted as minutes, modifiers can be set by
16738 customizing `org-effort-durations' (which see).
16740 Entries containing a colon are interpreted as H:MM by
16741 `org-hh:mm-string-to-minutes'."
16742 (let ((result 0)
16744 (regexp-opt (mapcar 'car org-effort-durations))
16746 (while (string-match re s)
16747 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16748 (string-to-number (match-string 1 s))))
16749 (setq s (replace-match "" nil t s)))
16750 (setq result (floor result))
16751 (incf result (org-hh:mm-string-to-minutes s))
16752 (if output-to-string (number-to-string result) result)))
16754 ;;;; Files
16756 (defun org-save-all-org-buffers ()
16757 "Save all Org-mode buffers without user confirmation."
16758 (interactive)
16759 (message "Saving all Org-mode buffers...")
16760 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
16761 (when (featurep 'org-id) (org-id-locations-save))
16762 (message "Saving all Org-mode buffers... done"))
16764 (defun org-revert-all-org-buffers ()
16765 "Revert all Org-mode buffers.
16766 Prompt for confirmation when there are unsaved changes.
16767 Be sure you know what you are doing before letting this function
16768 overwrite your changes.
16770 This function is useful in a setup where one tracks org files
16771 with a version control system, to revert on one machine after pulling
16772 changes from another. I believe the procedure must be like this:
16774 1. M-x org-save-all-org-buffers
16775 2. Pull changes from the other machine, resolve conflicts
16776 3. M-x org-revert-all-org-buffers"
16777 (interactive)
16778 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16779 (error "Abort"))
16780 (save-excursion
16781 (save-window-excursion
16782 (mapc
16783 (lambda (b)
16784 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
16785 (with-current-buffer b buffer-file-name))
16786 (org-pop-to-buffer-same-window b)
16787 (revert-buffer t 'no-confirm)))
16788 (buffer-list))
16789 (when (and (featurep 'org-id) org-id-track-globally)
16790 (org-id-locations-load)))))
16792 ;;;; Agenda files
16794 ;;;###autoload
16795 (defun org-switchb (&optional arg)
16796 "Switch between Org buffers.
16797 With one prefix argument, restrict available buffers to files.
16798 With two prefix arguments, restrict available buffers to agenda files.
16800 Defaults to `iswitchb' for buffer name completion.
16801 Set `org-completion-use-ido' to make it use ido instead."
16802 (interactive "P")
16803 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16804 ((equal arg '(16)) (org-buffer-list 'agenda))
16805 (t (org-buffer-list))))
16806 (org-completion-use-iswitchb org-completion-use-iswitchb)
16807 (org-completion-use-ido org-completion-use-ido))
16808 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16809 (setq org-completion-use-iswitchb t))
16810 (org-pop-to-buffer-same-window
16811 (org-icompleting-read "Org buffer: "
16812 (mapcar 'list (mapcar 'buffer-name blist))
16813 nil t))))
16815 ;;; Define some older names previously used for this functionality
16816 ;;;###autoload
16817 (defalias 'org-ido-switchb 'org-switchb)
16818 ;;;###autoload
16819 (defalias 'org-iswitchb 'org-switchb)
16821 (defun org-buffer-list (&optional predicate exclude-tmp)
16822 "Return a list of Org buffers.
16823 PREDICATE can be `export', `files' or `agenda'.
16825 export restrict the list to Export buffers.
16826 files restrict the list to buffers visiting Org files.
16827 agenda restrict the list to buffers visiting agenda files.
16829 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16830 (let* ((bfn nil)
16831 (agenda-files (and (eq predicate 'agenda)
16832 (mapcar 'file-truename (org-agenda-files t))))
16833 (filter
16834 (cond
16835 ((eq predicate 'files)
16836 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
16837 ((eq predicate 'export)
16838 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16839 ((eq predicate 'agenda)
16840 (lambda (b)
16841 (with-current-buffer b
16842 (and (derived-mode-p 'org-mode)
16843 (setq bfn (buffer-file-name b))
16844 (member (file-truename bfn) agenda-files)))))
16845 (t (lambda (b) (with-current-buffer b
16846 (or (derived-mode-p 'org-mode)
16847 (string-match "\*Org .*Export"
16848 (buffer-name b)))))))))
16849 (delq nil
16850 (mapcar
16851 (lambda(b)
16852 (if (and (funcall filter b)
16853 (or (not exclude-tmp)
16854 (not (string-match "tmp" (buffer-name b)))))
16855 b
16856 nil))
16857 (buffer-list)))))
16859 (defun org-agenda-files (&optional unrestricted archives)
16860 "Get the list of agenda files.
16861 Optional UNRESTRICTED means return the full list even if a restriction
16862 is currently in place.
16863 When ARCHIVES is t, include all archive files that are really being
16864 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16865 `org-agenda-archives-mode' is t."
16866 (let ((files
16867 (cond
16868 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16869 ((stringp org-agenda-files) (org-read-agenda-file-list))
16870 ((listp org-agenda-files) org-agenda-files)
16871 (t (error "Invalid value of `org-agenda-files'")))))
16872 (setq files (apply 'append
16873 (mapcar (lambda (f)
16874 (if (file-directory-p f)
16875 (directory-files
16876 f t org-agenda-file-regexp)
16877 (list f)))
16878 files)))
16879 (when org-agenda-skip-unavailable-files
16880 (setq files (delq nil
16881 (mapcar (function
16882 (lambda (file)
16883 (and (file-readable-p file) file)))
16884 files))))
16885 (when (or (eq archives t)
16886 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16887 (setq files (org-add-archive-files files)))
16888 files))
16890 (defun org-agenda-file-p (&optional file)
16891 "Return non-nil, if FILE is an agenda file.
16892 If FILE is omitted, use the file associated with the current
16893 buffer."
16894 (member (or file (buffer-file-name))
16895 (org-agenda-files t)))
16897 (defun org-edit-agenda-file-list ()
16898 "Edit the list of agenda files.
16899 Depending on setup, this either uses customize to edit the variable
16900 `org-agenda-files', or it visits the file that is holding the list. In the
16901 latter case, the buffer is set up in a way that saving it automatically kills
16902 the buffer and restores the previous window configuration."
16903 (interactive)
16904 (if (stringp org-agenda-files)
16905 (let ((cw (current-window-configuration)))
16906 (find-file org-agenda-files)
16907 (org-set-local 'org-window-configuration cw)
16908 (org-add-hook 'after-save-hook
16909 (lambda ()
16910 (set-window-configuration
16911 (prog1 org-window-configuration
16912 (kill-buffer (current-buffer))))
16913 (org-install-agenda-files-menu)
16914 (message "New agenda file list installed"))
16915 nil 'local)
16916 (message "%s" (substitute-command-keys
16918 (customize-variable 'org-agenda-files)))
16920 (defun org-store-new-agenda-file-list (list)
16921 "Set new value for the agenda file list and save it correctly."
16922 (if (stringp org-agenda-files)
16923 (let ((fe (org-read-agenda-file-list t)) b u)
16924 (while (setq b (find-buffer-visiting org-agenda-files))
16925 (kill-buffer b))
16926 (with-temp-file org-agenda-files
16927 (insert
16928 (mapconcat
16929 (lambda (f) ;; Keep un-expanded entries.
16930 (if (setq u (assoc f fe))
16931 (cdr u)
16932 f))
16935 (let ((org-mode-hook nil) (org-inhibit-startup t)
16936 (org-insert-mode-line-in-empty-file nil))
16937 (setq org-agenda-files list)
16938 (customize-save-variable 'org-agenda-files org-agenda-files))))
16940 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16941 "Read the list of agenda files from a file.
16942 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16943 filenames, used by `org-store-new-agenda-file-list' to write back
16944 un-expanded file names."
16945 (when (file-directory-p org-agenda-files)
16946 (error "`org-agenda-files' cannot be a single directory"))
16947 (when (stringp org-agenda-files)
16948 (with-temp-buffer
16949 (insert-file-contents org-agenda-files)
16950 (mapcar
16951 (lambda (f)
16952 (let ((e (expand-file-name (substitute-in-file-name f)
16953 org-directory)))
16954 (if pair-with-expansion
16955 (cons e f)
16956 e)))
16959 ;;;###autoload
16960 (defun org-cycle-agenda-files ()
16961 "Cycle through the files in `org-agenda-files'.
16962 If the current buffer visits an agenda file, find the next one in the list.
16963 If the current buffer does not, find the first agenda file."
16964 (interactive)
16965 (let* ((fs (org-agenda-files t))
16966 (files (append fs (list (car fs))))
16967 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16968 file)
16969 (unless files (error "No agenda files"))
16970 (catch 'exit
16971 (while (setq file (pop files))
16972 (if (equal (file-truename file) tcf)
16973 (when (car files)
16974 (find-file (car files))
16975 (throw 'exit t))))
16976 (find-file (car fs)))
16977 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16979 (defun org-agenda-file-to-front (&optional to-end)
16980 "Move/add the current file to the top of the agenda file list.
16981 If the file is not present in the list, it is added to the front. If it is
16982 present, it is moved there. With optional argument TO-END, add/move to the
16983 end of the list."
16984 (interactive "P")
16985 (let ((org-agenda-skip-unavailable-files nil)
16986 (file-alist (mapcar (lambda (x)
16987 (cons (file-truename x) x))
16988 (org-agenda-files t)))
16989 (ctf (file-truename buffer-file-name))
16990 x had)
16991 (setq x (assoc ctf file-alist) had x)
16993 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16994 (if to-end
16995 (setq file-alist (append (delq x file-alist) (list x)))
16996 (setq file-alist (cons x (delq x file-alist))))
16997 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16998 (org-install-agenda-files-menu)
16999 (message "File %s to %s of agenda file list"
17000 (if had "moved" "added") (if to-end "end" "front"))))
17002 (defun org-remove-file (&optional file)
17003 "Remove current file from the list of files in variable `org-agenda-files'.
17004 These are the files which are being checked for agenda entries.
17005 Optional argument FILE means use this file instead of the current."
17006 (interactive)
17007 (let* ((org-agenda-skip-unavailable-files nil)
17008 (file (or file buffer-file-name))
17009 (true-file (file-truename file))
17010 (afile (abbreviate-file-name file))
17011 (files (delq nil (mapcar
17012 (lambda (x)
17013 (if (equal true-file
17014 (file-truename x))
17015 nil x))
17016 (org-agenda-files t)))))
17017 (if (not (= (length files) (length (org-agenda-files t))))
17018 (progn
17019 (org-store-new-agenda-file-list files)
17020 (org-install-agenda-files-menu)
17021 (message "Removed file: %s" afile))
17022 (message "File was not in list: %s (not removed)" afile))))
17024 (defun org-file-menu-entry (file)
17025 (vector file (list 'find-file file) t))
17027 (defun org-check-agenda-file (file)
17028 "Make sure FILE exists. If not, ask user what to do."
17029 (when (not (file-exists-p file))
17030 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
17031 (abbreviate-file-name file))
17032 (let ((r (downcase (read-char-exclusive))))
17033 (cond
17034 ((equal r ?r)
17035 (org-remove-file file)
17036 (throw 'nextfile t))
17037 (t (error "Abort"))))))
17039 (defun org-get-agenda-file-buffer (file)
17040 "Get a buffer visiting FILE. If the buffer needs to be created, add
17041 it to the list of buffers which might be released later."
17042 (let ((buf (org-find-base-buffer-visiting file)))
17043 (if buf
17044 buf ; just return it
17045 ;; Make a new buffer and remember it
17046 (setq buf (find-file-noselect file))
17047 (if buf (push buf org-agenda-new-buffers))
17048 buf)))
17050 (defun org-release-buffers (blist)
17051 "Release all buffers in list, asking the user for confirmation when needed.
17052 When a buffer is unmodified, it is just killed. When modified, it is saved
17053 \(if the user agrees) and then killed."
17054 (let (buf file)
17055 (while (setq buf (pop blist))
17056 (setq file (buffer-file-name buf))
17057 (when (and (buffer-modified-p buf)
17058 file
17059 (y-or-n-p (format "Save file %s? " file)))
17060 (with-current-buffer buf (save-buffer)))
17061 (kill-buffer buf))))
17063 (defun org-prepare-agenda-buffers (files)
17064 "Create buffers for all agenda files, protect archived trees and comments."
17065 (interactive)
17066 (let ((pa '(:org-archived t))
17067 (pc '(:org-comment t))
17068 (pall '(:org-archived t :org-comment t))
17069 (inhibit-read-only t)
17070 (rea (concat ":" org-archive-tag ":"))
17071 bmp file re)
17072 (save-excursion
17073 (save-restriction
17074 (while (setq file (pop files))
17075 (catch 'nextfile
17076 (if (bufferp file)
17077 (set-buffer file)
17078 (org-check-agenda-file file)
17079 (set-buffer (org-get-agenda-file-buffer file)))
17080 (widen)
17081 (setq bmp (buffer-modified-p))
17082 (org-refresh-category-properties)
17083 (setq org-todo-keywords-for-agenda
17084 (append org-todo-keywords-for-agenda org-todo-keywords-1))
17085 (setq org-done-keywords-for-agenda
17086 (append org-done-keywords-for-agenda org-done-keywords))
17087 (setq org-todo-keyword-alist-for-agenda
17088 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
17089 (setq org-drawers-for-agenda
17090 (append org-drawers-for-agenda org-drawers))
17091 (setq org-tag-alist-for-agenda
17092 (append org-tag-alist-for-agenda org-tag-alist))
17094 (save-excursion
17095 (remove-text-properties (point-min) (point-max) pall)
17096 (when org-agenda-skip-archived-trees
17097 (goto-char (point-min))
17098 (while (re-search-forward rea nil t)
17099 (if (org-at-heading-p t)
17100 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
17101 (goto-char (point-min))
17102 (setq re (format org-heading-keyword-regexp-format
17103 org-comment-string))
17104 (while (re-search-forward re nil t)
17105 (add-text-properties
17106 (match-beginning 0) (org-end-of-subtree t) pc)))
17107 (set-buffer-modified-p bmp)))))
17108 (setq org-todo-keywords-for-agenda
17109 (org-uniquify org-todo-keywords-for-agenda))
17110 (setq org-todo-keyword-alist-for-agenda
17111 (org-uniquify org-todo-keyword-alist-for-agenda)
17112 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
17114 ;;;; Embedded LaTeX
17116 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17117 "Keymap for the minor `org-cdlatex-mode'.")
17119 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
17120 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
17121 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
17122 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
17123 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
17125 (defvar org-cdlatex-texmathp-advice-is-done nil
17126 "Flag remembering if we have applied the advice to texmathp already.")
17128 (define-minor-mode org-cdlatex-mode
17129 "Toggle the minor `org-cdlatex-mode'.
17130 This mode supports entering LaTeX environment and math in LaTeX fragments
17131 in Org-mode.
17133 nil " OCDL" nil
17134 (when org-cdlatex-mode
17135 (require 'cdlatex)
17136 (run-hooks 'cdlatex-mode-hook)
17137 (cdlatex-compute-tables))
17138 (unless org-cdlatex-texmathp-advice-is-done
17139 (setq org-cdlatex-texmathp-advice-is-done t)
17140 (defadvice texmathp (around org-math-always-on activate)
17141 "Always return t in org-mode buffers.
17142 This is because we want to insert math symbols without dollars even outside
17143 the LaTeX math segments. If Orgmode thinks that point is actually inside
17144 an embedded LaTeX fragment, let texmathp do its job.
17146 (interactive)
17147 (let (p)
17148 (cond
17149 ((not (derived-mode-p 'org-mode)) ad-do-it)
17150 ((eq this-command 'cdlatex-math-symbol)
17151 (setq ad-return-value t
17152 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
17153 (t
17154 (let ((p (org-inside-LaTeX-fragment-p)))
17155 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
17156 (setq ad-return-value t
17157 texmathp-why '("Org-mode embedded math" . 0))
17158 (if p ad-do-it)))))))))
17160 (defun turn-on-org-cdlatex ()
17161 "Unconditionally turn on `org-cdlatex-mode'."
17162 (org-cdlatex-mode 1))
17164 (defun org-inside-LaTeX-fragment-p ()
17165 "Test if point is inside a LaTeX fragment.
17167 sequence appearing also before point.
17168 Even though the matchers for math are configurable, this function assumes
17170 delimiters are skipped when they have been removed by customization.
17171 The return value is nil, or a cons cell with the delimiter and the
17172 position of this delimiter.
17174 This function does a reasonably good job, but can locally be fooled by
17175 for example currency specifications. For example it will assume being in
17177 fragments that are properly closed, but during editing, we have to live
17178 with the uncertainty caused by missing closing delimiters. This function
17179 looks only before point, not after."
17180 (catch 'exit
17181 (let ((pos (point))
17182 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
17183 (lim (progn
17185 (point)))
17186 dd-on str (start 0) m re)
17187 (goto-char pos)
17188 (when dodollar
17190 re (nth 1 (assoc "$" org-latex-regexps)))
17191 (while (string-match re str start)
17192 (cond
17193 ((= (match-end 0) (length str))
17194 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
17195 ((= (match-end 0) (- (length str) 5))
17196 (throw 'exit nil))
17197 (t (setq start (match-end 0))))))
17198 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17199 (goto-char pos)
17200 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
17201 (and (match-beginning 2) (throw 'exit nil))
17202 ;; count $$
17204 (setq dd-on (not dd-on)))
17205 (goto-char pos)
17206 (if dd-on (cons "$$" m))))))
17208 (defun org-inside-latex-macro-p ()
17209 "Is point inside a LaTeX macro or its arguments?"
17210 (save-match-data
17211 (org-in-regexp
17214 (defun org-try-cdlatex-tab ()
17215 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17216 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17217 - inside a LaTeX fragment, or
17218 - after the first word in a line, where an abbreviation expansion could
17219 insert a LaTeX environment."
17220 (when org-cdlatex-mode
17221 (cond
17222 ;; Before any word on the line: No expansion possible.
17224 ;; Just after first word on the line: Expand it. Make sure it
17225 ;; cannot happen on headlines, though.
17226 ((save-excursion
17227 (skip-chars-backward "a-zA-Z0-9*")
17229 (and (bolp) (not (org-at-heading-p))))
17230 (cdlatex-tab) t)
17231 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
17233 (defun org-cdlatex-underscore-caret (&optional arg)
17234 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17235 Revert to the normal definition outside of these fragments."
17236 (interactive "P")
17237 (if (org-inside-LaTeX-fragment-p)
17238 (call-interactively 'cdlatex-sub-superscript)
17239 (let (org-cdlatex-mode)
17240 (call-interactively (key-binding (vector last-input-event))))))
17242 (defun org-cdlatex-math-modify (&optional arg)
17243 "Execute `cdlatex-math-modify' in LaTeX fragments.
17244 Revert to the normal definition outside of these fragments."
17245 (interactive "P")
17246 (if (org-inside-LaTeX-fragment-p)
17247 (call-interactively 'cdlatex-math-modify)
17248 (let (org-cdlatex-mode)
17249 (call-interactively (key-binding (vector last-input-event))))))
17251 (defvar org-latex-fragment-image-overlays nil
17252 "List of overlays carrying the images of latex fragments.")
17253 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
17255 (defun org-remove-latex-fragment-image-overlays ()
17256 "Remove all overlays with LaTeX fragment images in current buffer."
17257 (mapc 'delete-overlay org-latex-fragment-image-overlays)
17258 (setq org-latex-fragment-image-overlays nil))
17260 (defun org-preview-latex-fragment (&optional subtree)
17261 "Preview the LaTeX fragment at point, or all locally or globally.
17262 If the cursor is in a LaTeX fragment, create the image and overlay
17263 it over the source code. If there is no fragment at point, display
17264 all fragments in the current text, from one headline to the next. With
17265 prefix SUBTREE, display all fragments in the current subtree. With a
17267 the cursor is before the first headline,
17268 display all fragments in the buffer.
17270 (interactive "P")
17271 (unless buffer-file-name
17272 (error "Can't preview LaTeX fragment in a non-file buffer"))
17273 (org-remove-latex-fragment-image-overlays)
17274 (save-excursion
17275 (save-restriction
17276 (let (beg end at msg)
17277 (cond
17278 ((or (equal subtree '(16))
17279 (not (save-excursion
17280 (re-search-backward org-outline-regexp-bol nil t))))
17281 (setq beg (point-min) end (point-max)
17282 msg "Creating images for buffer...%s"))
17283 ((equal subtree '(4))
17284 (org-back-to-heading)
17285 (setq beg (point) end (org-end-of-subtree t)
17286 msg "Creating images for subtree...%s"))
17287 (t
17288 (if (setq at (org-inside-LaTeX-fragment-p))
17289 (goto-char (max (point-min) (- (cdr at) 2)))
17290 (org-back-to-heading))
17291 (setq beg (point) end (progn (outline-next-heading) (point))
17292 msg (if at "Creating image...%s"
17293 "Creating images for entry...%s"))))
17294 (message msg "")
17295 (narrow-to-region beg end)
17296 (goto-char beg)
17297 (org-format-latex
17298 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
17299 (file-name-nondirectory
17300 buffer-file-name)))
17301 default-directory 'overlays msg at 'forbuffer
17302 org-latex-create-formula-image-program)
17303 (message msg "done. Use `C-c C-c' to remove images.")))))
17305 (defvar org-latex-regexps
17307 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17310 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
17314 "Regular expressions for matching embedded LaTeX.")
17316 (defvar org-export-have-math nil) ;; dynamic scoping
17317 (defun org-format-latex (prefix &optional dir overlays msg at
17318 forbuffer processing-type)
17319 "Replace LaTeX fragments with links to an image, and produce images.
17320 Some of the options can be changed using the variable
17321 `org-format-latex-options'."
17322 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
17323 (let* ((prefixnodir (file-name-nondirectory prefix))
17324 (absprefix (expand-file-name prefix dir))
17325 (todir (file-name-directory absprefix))
17326 (opt org-format-latex-options)
17327 (matchers (plist-get opt :matchers))
17328 (re-list org-latex-regexps)
17329 (org-format-latex-header-extra
17330 (plist-get (org-infile-export-plist) :latex-header-extra))
17331 (cnt 0) txt hash link beg end re e checkdir
17332 executables-checked string
17333 m n block-type block linkfile movefile ov)
17334 ;; Check the different regular expressions
17335 (while (setq e (pop re-list))
17336 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
17338 (when (member m matchers)
17339 (goto-char (point-min))
17340 (while (re-search-forward re nil t)
17341 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
17342 (not (get-text-property (match-beginning n)
17343 'org-protected))
17344 (or (not overlays)
17345 (not (eq (get-char-property (match-beginning n)
17346 'org-overlay-type)
17347 'org-latex-overlay))))
17348 (setq org-export-have-math t)
17349 (cond
17350 ((eq processing-type 'verbatim)
17351 ;; Leave the text verbatim, just protect it
17352 (add-text-properties (match-beginning n) (match-end n)
17353 '(org-protected t)))
17354 ((eq processing-type 'mathjax)
17355 ;; Prepare for MathJax processing
17356 (setq string (match-string n))
17357 (if (member m '("$" "$1"))
17358 (save-excursion
17359 (delete-region (match-beginning n) (match-end n))
17360 (goto-char (match-beginning n))
17363 '(org-protected t))))
17364 (add-text-properties (match-beginning n) (match-end n)
17365 '(org-protected t))))
17366 ((or (eq processing-type 'dvipng)
17367 (eq processing-type 'imagemagick))
17368 ;; Process to an image
17369 (setq txt (match-string n)
17370 beg (match-beginning n) end (match-end n)
17371 cnt (1+ cnt))
17372 (let (print-length print-level) ; make sure full list is printed
17373 (setq hash (sha1 (prin1-to-string
17374 (list org-format-latex-header
17375 org-format-latex-header-extra
17376 org-export-latex-default-packages-alist
17377 org-export-latex-packages-alist
17378 org-format-latex-options
17379 forbuffer txt)))
17380 linkfile (format "%s_%s.png" prefix hash)
17381 movefile (format "%s_%s.png" absprefix hash)))
17382 (setq link (concat block "[[file:" linkfile "]]" block))
17383 (if msg (message msg cnt))
17384 (goto-char beg)
17385 (unless checkdir ; make sure the directory exists
17386 (setq checkdir t)
17387 (or (file-directory-p todir) (make-directory todir t)))
17388 (cond
17389 ((eq processing-type 'dvipng)
17390 (unless executables-checked
17391 (org-check-external-command
17392 "latex" "needed to convert LaTeX fragments to images")
17393 (org-check-external-command
17394 "dvipng" "needed to convert LaTeX fragments to images")
17395 (setq executables-checked t))
17396 (unless (file-exists-p movefile)
17397 (org-create-formula-image-with-dvipng
17398 txt movefile opt forbuffer)))
17399 ((eq processing-type 'imagemagick)
17400 (unless executables-checked
17401 (org-check-external-command
17402 "convert" "you need to install imagemagick")
17403 (setq executables-checked t))
17404 (unless (file-exists-p movefile)
17405 (org-create-formula-image-with-imagemagick
17406 txt movefile opt forbuffer))))
17407 (if overlays
17408 (progn
17409 (mapc (lambda (o)
17410 (if (eq (overlay-get o 'org-overlay-type)
17411 'org-latex-overlay)
17412 (delete-overlay o)))
17413 (overlays-in beg end))
17414 (setq ov (make-overlay beg end))
17415 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17416 (if (featurep 'xemacs)
17417 (progn
17418 (overlay-put ov 'invisible t)
17419 (overlay-put
17420 ov 'end-glyph
17421 (make-glyph (vector 'png :file movefile))))
17422 (overlay-put
17423 ov 'display
17424 (list 'image :type 'png :file movefile :ascent 'center)))
17425 (push ov org-latex-fragment-image-overlays)
17426 (goto-char end))
17427 (delete-region beg end)
17428 (insert (org-add-props link
17429 (list 'org-latex-src
17430 (replace-regexp-in-string
17432 'org-latex-src-embed-type
17433 (if block-type 'paragraph 'character))))))
17434 ((eq processing-type 'mathml)
17435 ;; Process to MathML
17436 (unless executables-checked
17437 (unless (save-match-data (org-format-latex-mathml-available-p))
17438 (error "LaTeX to MathML converter not configured"))
17439 (setq executables-checked t))
17440 (setq txt (match-string n)
17441 beg (match-beginning n) end (match-end n)
17442 cnt (1+ cnt))
17443 (if msg (message msg cnt))
17444 (goto-char beg)
17445 (delete-region beg end)
17446 (insert (org-format-latex-as-mathml
17447 txt block-type prefix dir)))
17448 (t
17449 (error "Unknown conversion type %s for latex fragments"
17450 processing-type)))))))))
17452 (defun org-create-math-formula (latex-frag &optional mathml-file)
17453 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17454 Use `org-latex-to-mathml-convert-command'. If the conversion is
17456 elements otherwise return nil. When MATHML-FILE is specified,
17457 write the results in to that file. When invoked as an
17458 interactive command, prompt for LATEX-FRAG, with initial value
17459 set to the current active region and echo the results for user
17460 inspection."
17461 (interactive (list (let ((frag (when (org-region-active-p)
17462 (buffer-substring-no-properties
17463 (region-beginning) (region-end)))))
17464 (read-string "LaTeX Fragment: " frag nil frag))))
17465 (unless latex-frag (error "Invalid latex-frag"))
17466 (let* ((tmp-in-file (file-relative-name
17467 (make-temp-name (expand-file-name "ltxmathml-in"))))
17468 (ignore (write-region latex-frag nil tmp-in-file))
17469 (tmp-out-file (file-relative-name
17470 (make-temp-name (expand-file-name "ltxmathml-out"))))
17471 (cmd (format-spec
17472 org-latex-to-mathml-convert-command
17473 `((?j . ,(shell-quote-argument
17474 (expand-file-name org-latex-to-mathml-jar-file)))
17475 (?I . ,(shell-quote-argument tmp-in-file))
17476 (?o . ,(shell-quote-argument tmp-out-file)))))
17477 mathml shell-command-output)
17478 (when (org-called-interactively-p 'any)
17479 (unless (org-format-latex-mathml-available-p)
17480 (error "LaTeX to MathML converter not configured")))
17481 (message "Running %s" cmd)
17482 (setq shell-command-output (shell-command-to-string cmd))
17483 (setq mathml
17484 (when (file-readable-p tmp-out-file)
17485 (with-current-buffer (find-file-noselect tmp-out-file t)
17486 (goto-char (point-min))
17487 (when (re-search-forward
17488 (concat
17489 (regexp-quote
17492 (regexp-quote "</math>")) nil t)
17493 (prog1 (match-string 0) (kill-buffer))))))
17494 (cond
17495 (mathml
17496 (setq mathml
17498 (when mathml-file
17499 (write-region mathml nil mathml-file))
17500 (when (org-called-interactively-p 'any)
17501 (message mathml)))
17502 ((message "LaTeX to MathML conversion failed")
17503 (message shell-command-output)))
17504 (delete-file tmp-in-file)
17505 (when (file-exists-p tmp-out-file)
17506 (delete-file tmp-out-file))
17507 mathml))
17509 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17510 prefix &optional dir)
17511 "Use `org-create-math-formula' but check local cache first."
17512 (let* ((absprefix (expand-file-name prefix dir))
17513 (print-length nil) (print-level nil)
17514 (formula-id (concat
17515 "formula-"
17516 (sha1
17517 (prin1-to-string
17518 (list latex-frag
17519 org-latex-to-mathml-convert-command)))))
17520 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17521 (formula-cache-dir (file-name-directory formula-cache)))
17523 (unless (file-directory-p formula-cache-dir)
17524 (make-directory formula-cache-dir t))
17526 (unless (file-exists-p formula-cache)
17527 (org-create-math-formula latex-frag formula-cache))
17529 (if (file-exists-p formula-cache)
17530 ;; Successful conversion. Return the link to MathML file.
17531 (org-add-props
17532 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17534 'org-latex-src-embed-type (if latex-frag-type
17535 'paragraph 'character)))
17536 ;; Failed conversion. Return the LaTeX fragment verbatim
17537 (add-text-properties
17538 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17539 latex-frag)))
17541 ;; This function borrows from Ganesh Swami's latex2png.el
17542 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
17543 "This calls dvipng."
17544 (require 'org-latex)
17545 (let* ((tmpdir (if (featurep 'xemacs)
17546 (temp-directory)
17547 temporary-file-directory))
17548 (texfilebase (make-temp-name
17549 (expand-file-name "orgtex" tmpdir)))
17550 (texfile (concat texfilebase ".tex"))
17551 (dvifile (concat texfilebase ".dvi"))
17552 (pngfile (concat texfilebase ".png"))
17553 (fnh (if (featurep 'xemacs)
17554 (font-height (face-font 'default))
17555 (face-attribute 'default :height nil)))
17556 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17557 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17558 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17559 "Black"))
17560 (bg (or (plist-get options (if buffer :background :html-background))
17561 "Transparent")))
17562 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17563 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17564 (with-temp-file texfile
17565 (insert (org-splice-latex-header
17566 org-format-latex-header
17567 org-export-latex-default-packages-alist
17568 org-export-latex-packages-alist t
17569 org-format-latex-header-extra))
17571 (require 'org-latex)
17572 (org-export-latex-fix-inputenc))
17573 (let ((dir default-directory))
17574 (condition-case nil
17575 (progn
17576 (cd tmpdir)
17577 (call-process "latex" nil nil nil texfile))
17578 (error nil))
17579 (cd dir))
17580 (if (not (file-exists-p dvifile))
17581 (progn (message "Failed to create dvi file from %s" texfile) nil)
17582 (condition-case nil
17583 (if (featurep 'xemacs)
17584 (call-process "dvipng" nil nil nil
17585 "-fg" fg "-bg" bg
17586 "-T" "tight"
17587 "-o" pngfile
17588 dvifile)
17589 (call-process "dvipng" nil nil nil
17590 "-fg" fg "-bg" bg
17591 "-D" dpi
17592 ;;"-x" scale "-y" scale
17593 "-T" "tight"
17594 "-o" pngfile
17595 dvifile))
17596 (error nil))
17597 (if (not (file-exists-p pngfile))
17598 (if org-format-latex-signal-error
17599 (error "Failed to create png file from %s" texfile)
17600 (message "Failed to create png file from %s" texfile)
17601 nil)
17602 ;; Use the requested file name and clean up
17603 (copy-file pngfile tofile 'replace)
17604 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
17605 (if (file-exists-p (concat texfilebase e))
17606 (delete-file (concat texfilebase e))))
17607 pngfile))))
17609 (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
17610 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
17611 "This calls convert, which is included into imagemagick."
17612 (require 'org-latex)
17613 (let* ((tmpdir (if (featurep 'xemacs)
17614 (temp-directory)
17615 temporary-file-directory))
17616 (texfilebase (make-temp-name
17617 (expand-file-name "orgtex" tmpdir)))
17618 (texfile (concat texfilebase ".tex"))
17619 (pdffile (concat texfilebase ".pdf"))
17620 (pngfile (concat texfilebase ".png"))
17621 (fnh (if (featurep 'xemacs)
17622 (font-height (face-font 'default))
17623 (face-attribute 'default :height nil)))
17624 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17625 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17626 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17627 "black"))
17628 (bg (or (plist-get options (if buffer :background :html-background))
17629 "white")))
17630 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
17631 (setq fg (org-latex-color-format fg)))
17632 (if (eq bg 'default) (setq bg (org-latex-color :background))
17633 (setq bg (org-latex-color-format
17634 (if (string= bg "Transparent")(setq bg "white")))))
17635 (with-temp-file texfile
17636 (insert (org-splice-latex-header
17637 org-format-latex-header
17638 org-export-latex-default-packages-alist
17639 org-export-latex-packages-alist t
17640 org-format-latex-header-extra))
17646 string
17649 (require 'org-latex)
17650 (org-export-latex-fix-inputenc))
17651 (let ((dir default-directory) cmd cmds latex-frags-cmds)
17652 (condition-case nil
17653 (progn
17654 (cd tmpdir)
17655 (setq cmds org-latex-to-pdf-process)
17656 (while cmds
17657 (setq latex-frags-cmds (pop cmds))
17658 (if (listp latex-frags-cmds)
17659 (setq cmds nil)
17660 (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
17661 (while latex-frags-cmds
17662 (setq cmd (pop latex-frags-cmds))
17663 (while (string-match "%b" cmd)
17664 (setq cmd (replace-match
17665 (save-match-data
17666 (shell-quote-argument texfile))
17667 t t cmd)))
17668 (while (string-match "%f" cmd)
17669 (setq cmd (replace-match
17670 (save-match-data
17671 (shell-quote-argument (file-name-nondirectory texfile)))
17672 t t cmd)))
17673 (while (string-match "%o" cmd)
17674 (setq cmd (replace-match
17675 (save-match-data
17676 (shell-quote-argument (file-name-directory texfile)))
17677 t t cmd)))
17678 (setq cmd (split-string cmd))
17679 (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
17680 (error nil))
17681 (cd dir))
17682 (if (not (file-exists-p pdffile))
17683 (progn (message "Failed to create pdf file from %s" texfile) nil)
17684 (condition-case nil
17685 (if (featurep 'xemacs)
17686 (call-process "convert" nil nil nil
17687 "-density" "96"
17688 "-trim"
17689 "-antialias"
17690 pdffile
17691 "-quality" "100"
17692 ;; "-sharpen" "0x1.0"
17693 pngfile)
17694 (call-process "convert" nil nil nil
17695 "-density" dpi
17696 "-trim"
17697 "-antialias"
17698 pdffile
17699 "-quality" "100"
17700 ; "-sharpen" "0x1.0"
17701 pngfile))
17702 (error nil))
17703 (if (not (file-exists-p pngfile))
17704 (if org-format-latex-signal-error
17705 (error "Failed to create png file from %s" texfile)
17706 (message "Failed to create png file from %s" texfile)
17707 nil)
17708 ;; Use the requested file name and clean up
17709 (copy-file pngfile tofile 'replace)
17710 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
17711 (if (file-exists-p (concat texfilebase e))
17712 (delete-file (concat texfilebase e))))
17713 pngfile))))
17715 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17716 "Fill a LaTeX header template TPL.
17717 In the template, the following place holders will be recognized:
17720 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17722 [NO-PACKAGES] do not include PKG
17723 [EXTRA] the string EXTRA
17724 [NO-EXTRA] do not include EXTRA
17726 For backward compatibility, if both the positive and the negative place
17728 assumed to be present at the end of the template.
17729 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17730 EXTRA is a string.
17731 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17732 (let (rpl (end ""))
17734 (setq rpl (if (or (match-end 1) (not def-pkg))
17735 "" (org-latex-packages-to-string def-pkg snippets-p t))
17736 tpl (replace-match rpl t t tpl))
17737 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17740 (setq rpl (if (or (match-end 1) (not pkg))
17741 "" (org-latex-packages-to-string pkg snippets-p t))
17742 tpl (replace-match rpl t t tpl))
17743 (if pkg (setq end
17745 (org-latex-packages-to-string pkg snippets-p)))))
17748 (setq rpl (if (or (match-end 1) (not extra))
17750 tpl (replace-match rpl t t tpl))
17756 tpl)))
17758 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17760 (setq pkg (mapconcat (lambda(p)
17761 (cond
17762 ((stringp p) p)
17763 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17764 (format "%% Package %s omitted" (cadr p)))
17765 ((equal "" (car p))
17767 (t
17769 (car p) (cadr p)))))
17770 pkg
17774 (defun org-dvipng-color (attr)
17775 "Return a RGB color specification for dvipng."
17776 (apply 'format "rgb %s %s %s"
17777 (mapcar 'org-normalize-color
17778 (if (featurep 'xemacs)
17779 (color-rgb-components
17780 (face-property 'default
17781 (cond ((eq attr :foreground) 'foreground)
17782 ((eq attr :background) 'background))))
17783 (color-values (face-attribute 'default attr nil))))))
17785 (defun org-latex-color (attr)
17786 "Return a RGB color for the LaTeX color package."
17787 (apply 'format "%s,%s,%s"
17788 (mapcar 'org-normalize-color
17789 (if (featurep 'xemacs)
17790 (color-rgb-components
17791 (face-property 'default
17792 (cond ((eq attr :foreground) 'foreground)
17793 ((eq attr :background) 'background))))
17794 (color-values (face-attribute 'default attr nil))))))
17796 (defun org-latex-color-format (color-name)
17797 "Convert COLOR-NAME to a RGB color value."
17798 (apply 'format "%s,%s,%s"
17799 (mapcar 'org-normalize-color
17800 (color-values color-name))))
17802 (defun org-normalize-color (value)
17803 "Return string to be used as color value for an RGB component."
17804 (format "%g" (/ value 65535.0)))
17806 ;; Image display
17809 (defvar org-inline-image-overlays nil)
17810 (make-variable-buffer-local 'org-inline-image-overlays)
17812 (defun org-toggle-inline-images (&optional include-linked)
17813 "Toggle the display of inline images.
17814 INCLUDE-LINKED is passed to `org-display-inline-images'."
17815 (interactive "P")
17816 (if org-inline-image-overlays
17817 (progn
17818 (org-remove-inline-images)
17819 (message "Inline image display turned off"))
17820 (org-display-inline-images include-linked)
17821 (if org-inline-image-overlays
17822 (message "%d images displayed inline"
17823 (length org-inline-image-overlays))
17824 (message "No images to display inline"))))
17826 (defun org-redisplay-inline-images ()
17827 "Refresh the display of inline images."
17828 (interactive)
17829 (if (not org-inline-image-overlays)
17830 (org-toggle-inline-images)
17831 (org-toggle-inline-images)
17832 (org-toggle-inline-images)))
17834 (defun org-display-inline-images (&optional include-linked refresh beg end)
17835 "Display inline images.
17836 Normally only links without a description part are inlined, because this
17837 is how it will work for export. When INCLUDE-LINKED is set, also links
17838 with a description part will be inlined. This can be nice for a quick
17839 look at those images, but it does not reflect what exported files will look
17840 like.
17841 When REFRESH is set, refresh existing images between BEG and END.
17842 This will create new image displays only if necessary.
17843 BEG and END default to the buffer boundaries."
17844 (interactive "P")
17845 (unless refresh
17846 (org-remove-inline-images)
17847 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17848 (save-excursion
17849 (save-restriction
17850 (widen)
17851 (setq beg (or beg (point-min)) end (or end (point-max)))
17852 (goto-char beg)
17854 (substring (org-image-file-name-regexp) 0 -2)
17856 old file ov img)
17857 (while (re-search-forward re end t)
17858 (setq old (get-char-property-and-overlay (match-beginning 1)
17859 'org-image-overlay))
17860 (setq file (expand-file-name
17861 (concat (or (match-string 3) "") (match-string 4))))
17862 (when (file-exists-p file)
17863 (if (and (car-safe old) refresh)
17864 (image-refresh (overlay-get (cdr old) 'display))
17865 (setq img (save-match-data (create-image file)))
17866 (when img
17867 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17868 (overlay-put ov 'display img)
17869 (overlay-put ov 'face 'default)
17870 (overlay-put ov 'org-image-overlay t)
17871 (overlay-put ov 'modification-hooks
17872 (list 'org-display-inline-modification-hook))
17873 (push ov org-inline-image-overlays)))))))))
17875 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17876 "Remove inline-display overlay if a corresponding region is modified."
17877 (let ((inhibit-modification-hooks t))
17878 (when (and ov after)
17879 (delete ov org-inline-image-overlays)
17880 (delete-overlay ov))))
17882 (defun org-remove-inline-images ()
17883 "Remove inline display of images."
17884 (interactive)
17885 (mapc 'delete-overlay org-inline-image-overlays)
17886 (setq org-inline-image-overlays nil))
17888 ;;;; Key bindings
17890 ;; Outline functions from `outline-mode-prefix-map'
17891 ;; that can be remapped in Org:
17892 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17893 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17894 (define-key org-mode-map [remap outline-forward-same-level]
17895 'org-forward-heading-same-level)
17896 (define-key org-mode-map [remap outline-backward-same-level]
17897 'org-backward-heading-same-level)
17898 (define-key org-mode-map [remap show-branches]
17899 'org-kill-note-or-show-branches)
17900 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17901 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17902 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17904 ;; Outline functions from `outline-mode-prefix-map' that can not
17905 ;; be remapped in Org:
17906 ;;
17907 ;; - the column "key binding" shows whether the Outline function is still
17908 ;; available in Org mode on the same key that it has been bound to in
17909 ;; Outline mode:
17910 ;; - "overridden": key used for a different functionality in Org mode
17911 ;; - else: key still bound to the same Outline function in Org mode
17912 ;;
17913 ;; | Outline function | key binding | Org replacement |
17914 ;; |------------------------------------+-------------+-----------------------|
17915 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17916 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17917 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17918 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
17919 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17920 ;; | `show-entry' | overridden | no replacement |
17921 ;; | `show-children' | `C-c C-i' | visibility cycling |
17922 ;; | `show-branches' | `C-c C-k' | still same function |
17923 ;; | `show-subtree' | overridden | visibility cycling |
17924 ;; | `show-all' | overridden | no replacement |
17925 ;; | `hide-subtree' | overridden | visibility cycling |
17926 ;; | `hide-body' | overridden | no replacement |
17927 ;; | `hide-entry' | overridden | visibility cycling |
17928 ;; | `hide-leaves' | overridden | no replacement |
17929 ;; | `hide-sublevels' | overridden | no replacement |
17930 ;; | `hide-other' | overridden | no replacement |
17932 ;; Make `C-c C-x' a prefix key
17933 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17935 ;; TAB key with modifiers
17936 (org-defkey org-mode-map "\C-i" 'org-cycle)
17937 (org-defkey org-mode-map [(tab)] 'org-cycle)
17938 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17940 ;; The following line is necessary under Suse GNU/Linux
17941 (unless (featurep 'xemacs)
17942 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17943 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17944 (define-key org-mode-map [backtab] 'org-shifttab)
17946 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17947 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17948 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17950 ;; Cursor keys with modifiers
17951 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17952 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17953 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17954 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17956 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17957 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17958 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17959 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17961 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17962 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17963 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17964 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17966 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17967 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17968 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17969 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17971 ;; Babel keys
17972 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17973 (mapc (lambda (pair)
17974 (define-key org-babel-map (car pair) (cdr pair)))
17975 org-babel-key-bindings)
17977 ;;; Extra keys for tty access.
17978 ;; We only set them when really needed because otherwise the
17979 ;; menus don't show the simple keys
17981 (when (or org-use-extra-keys
17982 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17983 (not window-system))
17984 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17985 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17986 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17987 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17988 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17989 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17990 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17991 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17992 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17993 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17994 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17995 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17996 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17997 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17998 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17999 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18000 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18001 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18002 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18003 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18004 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18005 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18006 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18007 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18008 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18009 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18010 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18011 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18013 ;; All the other keys
18015 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18016 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18017 (if (boundp 'narrow-map)
18018 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18019 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18020 (if (boundp 'narrow-map)
18021 (org-defkey narrow-map "b" 'org-narrow-to-block)
18022 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18023 (if (boundp 'narrow-map)
18024 (org-defkey narrow-map "e" 'org-narrow-to-element)
18025 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18026 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18027 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18028 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18029 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18030 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18031 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18032 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18033 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
18034 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
18035 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
18036 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
18037 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
18038 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
18039 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
18040 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
18041 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
18042 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
18043 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
18044 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
18045 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
18046 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
18047 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
18049 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
18050 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
18051 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
18052 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
18053 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
18054 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
18055 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
18056 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
18057 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
18058 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
18059 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
18060 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
18061 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
18062 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
18063 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
18064 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
18065 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
18066 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
18067 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
18068 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
18069 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
18071 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
18072 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
18073 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
18074 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18075 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
18076 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
18077 (org-defkey org-mode-map "\C-c^" 'org-sort)
18078 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
18079 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
18080 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
18081 (org-defkey org-mode-map "\C-m" 'org-return)
18082 (org-defkey org-mode-map "\C-j" 'org-return-indent)
18083 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
18084 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
18085 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
18086 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
18087 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
18088 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
18089 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
18090 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
18091 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
18092 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
18093 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
18094 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
18095 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
18096 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
18097 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
18098 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
18099 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
18100 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
18101 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
18102 (org-defkey org-mode-map "\M-h" 'org-mark-element)
18103 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
18104 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
18106 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
18107 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
18108 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
18109 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
18111 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
18112 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
18113 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
18114 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
18115 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
18116 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
18117 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
18118 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
18119 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
18120 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
18121 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
18122 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
18123 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
18125 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
18126 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
18127 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
18128 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
18129 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
18130 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
18131 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
18132 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
18134 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
18135 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
18136 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
18137 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
18138 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
18140 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
18142 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
18144 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
18145 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
18147 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
18150 (when (featurep 'xemacs)
18151 (org-defkey org-mode-map 'button3 'popup-mode-menu))
18154 (defconst org-speed-commands-default
18155 '(
18156 ("Outline Navigation")
18157 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
18158 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
18159 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
18160 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
18161 ("u" . (org-speed-move-safe 'outline-up-heading))
18162 ("j" . org-goto)
18163 ("g" . (org-refile t))
18164 ("Outline Visibility")
18165 ("c" . org-cycle)
18166 ("C" . org-shifttab)
18167 (" " . org-display-outline-path)
18168 (":" . org-columns)
18169 ("Outline Structure Editing")
18170 ("U" . org-shiftmetaup)
18171 ("D" . org-shiftmetadown)
18172 ("r" . org-metaright)
18173 ("l" . org-metaleft)
18174 ("R" . org-shiftmetaright)
18175 ("L" . org-shiftmetaleft)
18176 ("i" . (progn (forward-char 1) (call-interactively
18177 'org-insert-heading-respect-content)))
18178 ("^" . org-sort)
18179 ("w" . org-refile)
18180 ("a" . org-archive-subtree-default-with-confirmation)
18181 ("." . org-mark-subtree)
18182 ("#" . org-toggle-comment)
18183 ("Clock Commands")
18184 ("I" . org-clock-in)
18185 ("O" . org-clock-out)
18186 ("Meta Data Editing")
18187 ("t" . org-todo)
18188 ("0" . (org-priority ?\ ))
18189 ("1" . (org-priority ?A))
18190 ("2" . (org-priority ?B))
18191 ("3" . (org-priority ?C))
18192 (";" . org-set-tags-command)
18193 ("e" . org-set-effort)
18194 ("E" . org-inc-effort)
18195 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
18196 (org-entry-put (point) "APPT_WARNTIME" m)))
18197 ("Agenda Views etc")
18198 ("v" . org-agenda)
18199 ("/" . org-sparse-tree)
18200 ("Misc")
18201 ("o" . org-open-at-point)
18202 ("?" . org-speed-command-help)
18203 ("<" . (org-agenda-set-restriction-lock 'subtree))
18204 (">" . (org-agenda-remove-restriction-lock))
18205 )
18206 "The default speed commands.")
18208 (defun org-print-speed-command (e)
18209 (if (> (length (car e)) 1)
18210 (progn
18212 (princ (car e))
18214 (princ (make-string (length (car e)) ?-))
18216 (princ (car e))
18217 (princ " ")
18218 (if (symbolp (cdr e))
18219 (princ (symbol-name (cdr e)))
18220 (prin1 (cdr e)))
18223 (defun org-speed-command-help ()
18224 "Show the available speed commands."
18225 (interactive)
18226 (if (not org-use-speed-commands)
18227 (error "Speed commands are not activated, customize `org-use-speed-commands'")
18228 (with-output-to-temp-buffer "*Help*"
18230 (mapc 'org-print-speed-command org-speed-commands-user)
18233 (mapc 'org-print-speed-command org-speed-commands-default))
18234 (with-current-buffer "*Help*"
18235 (setq truncate-lines t))))
18237 (defun org-speed-move-safe (cmd)
18238 "Execute CMD, but make sure that the cursor always ends up in a headline.
18239 If not, return to the original position and throw an error."
18240 (interactive)
18241 (let ((pos (point)))
18242 (call-interactively cmd)
18243 (unless (and (bolp) (org-at-heading-p))
18244 (goto-char pos)
18245 (error "Boundary reached while executing %s" cmd))))
18247 (defvar org-self-insert-command-undo-counter 0)
18249 (defvar org-table-auto-blank-field) ; defined in org-table.el
18250 (defvar org-speed-command nil)
18252 (defun org-speed-command-default-hook (keys)
18253 "Hook for activating single-letter speed commands.
18254 `org-speed-commands-default' specifies a minimal command set.
18255 Use `org-speed-commands-user' for further customization."
18256 (when (or (and (bolp) (looking-at org-outline-regexp))
18257 (and (functionp org-use-speed-commands)
18258 (funcall org-use-speed-commands)))
18259 (cdr (assoc keys (append org-speed-commands-user
18260 org-speed-commands-default)))))
18262 (defun org-babel-speed-command-hook (keys)
18263 "Hook for activating single-letter code block commands."
18264 (when (and (bolp) (looking-at org-babel-src-block-regexp))
18265 (cdr (assoc keys org-babel-key-bindings))))
18267 (defcustom org-speed-command-hook
18268 '(org-speed-command-default-hook org-babel-speed-command-hook)
18269 "Hook for activating speed commands at strategic locations.
18270 Hook functions are called in sequence until a valid handler is
18271 found.
18273 Each hook takes a single argument, a user-pressed command key
18274 which is also a `self-insert-command' from the global map.
18276 Within the hook, examine the cursor position and the command key
18277 and return nil or a valid handler as appropriate. Handler could
18278 be one of an interactive command, a function, or a form.
18280 Set `org-use-speed-commands' to non-nil value to enable this
18281 hook. The default setting is `org-speed-command-default-hook'."
18282 :group 'org-structure
18283 :version "24.1"
18284 :type 'hook)
18286 (defun org-self-insert-command (N)
18287 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18288 If the cursor is in a table looking at whitespace, the whitespace is
18289 overwritten, and the table is not marked as requiring realignment."
18290 (interactive "p")
18291 (org-check-before-invisible-edit 'insert)
18292 (cond
18293 ((and org-use-speed-commands
18294 (setq org-speed-command
18295 (run-hook-with-args-until-success
18296 'org-speed-command-hook (this-command-keys))))
18297 (cond
18298 ((commandp org-speed-command)
18299 (setq this-command org-speed-command)
18300 (call-interactively org-speed-command))
18301 ((functionp org-speed-command)
18302 (funcall org-speed-command))
18303 ((and org-speed-command (listp org-speed-command))
18304 (eval org-speed-command))
18305 (t (let (org-use-speed-commands)
18306 (call-interactively 'org-self-insert-command)))))
18307 ((and
18308 (org-table-p)
18309 (progn
18310 ;; check if we blank the field, and if that triggers align
18311 (and (featurep 'org-table) org-table-auto-blank-field
18312 (member last-command
18313 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
18315 ;; got extra space, this field does not determine column width
18316 (let (org-table-may-need-update) (org-table-blank-field))
18317 ;; no extra space, this field may determine column width
18318 (org-table-blank-field)))
18319 t)
18320 (eq N 1)
18322 (let (org-table-may-need-update)
18323 (goto-char (1- (match-end 0)))
18324 (backward-delete-char 1)
18325 (goto-char (match-beginning 0))
18326 (self-insert-command N)))
18327 (t
18328 (setq org-table-may-need-update t)
18329 (self-insert-command N)
18330 (org-fix-tags-on-the-fly)
18331 (if org-self-insert-cluster-for-undo
18332 (if (not (eq last-command 'org-self-insert-command))
18333 (setq org-self-insert-command-undo-counter 1)
18334 (if (>= org-self-insert-command-undo-counter 20)
18335 (setq org-self-insert-command-undo-counter 1)
18336 (and (> org-self-insert-command-undo-counter 0)
18337 buffer-undo-list (listp buffer-undo-list)
18338 (not (cadr buffer-undo-list)) ; remove nil entry
18339 (setcdr buffer-undo-list (cddr buffer-undo-list)))
18340 (setq org-self-insert-command-undo-counter
18341 (1+ org-self-insert-command-undo-counter))))))))
18343 (defun org-check-before-invisible-edit (kind)
18344 "Check is editing if kind KIND would be dangerous with invisible text around.
18345 The detailed reaction depends on the user option `org-catch-invisible-edits'."
18346 ;; First, try to get out of here as quickly as possible, to reduce overhead
18347 (if (and org-catch-invisible-edits
18348 (or (not (boundp 'visible-mode)) (not visible-mode))
18349 (or (get-char-property (point) 'invisible)
18350 (get-char-property (max (point-min) (1- (point))) 'invisible)))
18351 ;; OK, we need to take a closer look
18352 (let* ((invisible-at-point (get-char-property (point) 'invisible))
18353 (invisible-before-point (if (bobp) nil (get-char-property
18354 (1- (point)) 'invisible)))
18355 (border-and-ok-direction
18356 (or
18357 ;; Check if we are acting predictably before invisible text
18358 (and invisible-at-point (not invisible-before-point)
18359 (memq kind '(insert delete-backward)))
18360 ;; Check if we are acting predictably after invisible text
18361 ;; This works not well, and I have turned it off. It seems
18362 ;; better to always show and stop after invisible text.
18363 ;; (and (not invisible-at-point) invisible-before-point
18364 ;; (memq kind '(insert delete)))
18365 )))
18366 (when (or (memq invisible-at-point '(outline org-hide-block t))
18367 (memq invisible-before-point '(outline org-hide-block t)))
18368 (if (eq org-catch-invisible-edits 'error)
18369 (error "Editing in invisible areas is prohibited - make visible first"))
18370 (if (and org-custom-properties-overlays
18371 (y-or-n-p "Display invisible properties in this buffer? "))
18372 (org-toggle-custom-properties-visibility)
18373 ;; Make the area visible
18374 (save-excursion
18375 (if invisible-before-point
18376 (goto-char (previous-single-char-property-change
18377 (point) 'invisible)))
18378 (org-cycle))
18379 (cond
18380 ((eq org-catch-invisible-edits 'show)
18381 ;; That's it, we do the edit after showing
18382 (message
18383 "Unfolding invisible region around point before editing")
18384 (sit-for 1))
18385 ((and (eq org-catch-invisible-edits 'smart)
18386 border-and-ok-direction)
18387 (message "Unfolding invisible region around point before editing"))
18388 (t
18389 ;; Don't do the edit, make the user repeat it in full visibility
18390 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
18392 (defun org-fix-tags-on-the-fly ()
18393 (when (and (equal (char-after (point-at-bol)) ?*)
18394 (org-at-heading-p))
18395 (org-align-tags-here org-tags-column)))
18397 (defun org-delete-backward-char (N)
18398 "Like `delete-backward-char', insert whitespace at field end in tables.
18399 When deleting backwards, in tables this function will insert whitespace in
18401 still be marked for re-alignment if the field did fill the entire column,
18402 because, in this case the deletion might narrow the column."
18403 (interactive "p")
18404 (org-check-before-invisible-edit 'delete-backward)
18405 (if (and (org-table-p)
18406 (eq N 1)
18407 (string-match "|" (buffer-substring (point-at-bol) (point)))
18408 (looking-at ".*?|"))
18409 (let ((pos (point))
18411 (c org-table-may-need-update))
18412 (backward-delete-char N)
18413 (if (not overwrite-mode)
18414 (progn
18415 (skip-chars-forward "^|")
18416 (insert " ")
18417 (goto-char (1- pos))))
18418 ;; noalign: if there were two spaces at the end, this field
18419 ;; does not determine the width of the column.
18420 (if noalign (setq org-table-may-need-update c)))
18421 (backward-delete-char N)
18422 (org-fix-tags-on-the-fly)))
18424 (defun org-delete-char (N)
18425 "Like `delete-char', but insert whitespace at field end in tables.
18426 When deleting characters, in tables this function will insert whitespace in
18428 still be marked for re-alignment if the field did fill the entire column,
18429 because, in this case the deletion might narrow the column."
18430 (interactive "p")
18431 (org-check-before-invisible-edit 'delete)
18432 (if (and (org-table-p)
18433 (not (bolp))
18434 (not (= (char-after) ?|))
18435 (eq N 1))
18436 (if (looking-at ".*?|")
18437 (let ((pos (point))
18439 (c org-table-may-need-update))
18440 (replace-match (concat
18441 (substring (match-string 0) 1 -1)
18442 " |"))
18443 (goto-char pos)
18444 ;; noalign: if there were two spaces at the end, this field
18445 ;; does not determine the width of the column.
18446 (if noalign (setq org-table-may-need-update c)))
18447 (delete-char N))
18448 (delete-char N)
18449 (org-fix-tags-on-the-fly)))
18451 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
18452 (put 'org-self-insert-command 'delete-selection t)
18453 (put 'orgtbl-self-insert-command 'delete-selection t)
18454 (put 'org-delete-char 'delete-selection 'supersede)
18455 (put 'org-delete-backward-char 'delete-selection 'supersede)
18456 (put 'org-yank 'delete-selection 'yank)
18458 ;; Make `flyspell-mode' delay after some commands
18459 (put 'org-self-insert-command 'flyspell-delayed t)
18460 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
18461 (put 'org-delete-char 'flyspell-delayed t)
18462 (put 'org-delete-backward-char 'flyspell-delayed t)
18464 ;; Make pabbrev-mode expand after org-mode commands
18465 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
18466 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
18468 ;; How to do this: Measure non-white length of current string
18469 ;; If equal to column width, we should realign.
18471 (defun org-remap (map &rest commands)
18472 "In MAP, remap the functions given in COMMANDS.
18473 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
18474 (let (new old)
18475 (while commands
18476 (setq old (pop commands) new (pop commands))
18477 (if (fboundp 'command-remapping)
18478 (org-defkey map (vector 'remap old) new)
18479 (substitute-key-definition old new map global-map)))))
18481 (when (eq org-enable-table-editor 'optimized)
18482 ;; If the user wants maximum table support, we need to hijack
18483 ;; some standard editing functions
18484 (org-remap org-mode-map
18485 'self-insert-command 'org-self-insert-command
18486 'delete-char 'org-delete-char
18487 'delete-backward-char 'org-delete-backward-char)
18488 (org-defkey org-mode-map "|" 'org-force-self-insert))
18490 (defvar org-ctrl-c-ctrl-c-hook nil
18491 "Hook for functions attaching themselves to `C-c C-c'.
18493 This can be used to add additional functionality to the C-c C-c
18494 key which executes context-dependent commands. This hook is run
18495 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
18496 run after the last test.
18498 Each function will be called with no arguments. The function
18499 must check if the context is appropriate for it to act. If yes,
18500 it should do its thing and then return a non-nil value. If the
18501 context is wrong, just do nothing and return nil.")
18503 (defvar org-ctrl-c-ctrl-c-final-hook nil
18504 "Hook for functions attaching themselves to `C-c C-c'.
18506 This can be used to add additional functionality to the C-c C-c
18507 key which executes context-dependent commands. This hook is run
18508 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
18509 before the first test.
18511 Each function will be called with no arguments. The function
18512 must check if the context is appropriate for it to act. If yes,
18513 it should do its thing and then return a non-nil value. If the
18514 context is wrong, just do nothing and return nil.")
18516 (defvar org-tab-first-hook nil
18517 "Hook for functions to attach themselves to TAB.
18518 See `org-ctrl-c-ctrl-c-hook' for more information.
18519 This hook runs as the first action when TAB is pressed, even before
18520 `org-cycle' messes around with the `outline-regexp' to cater for
18521 inline tasks and plain list item folding.
18522 If any function in this hook returns t, any other actions that
18523 would have been caused by TAB (such as table field motion or visibility
18524 cycling) will not occur.")
18526 (defvar org-tab-after-check-for-table-hook nil
18527 "Hook for functions to attach themselves to TAB.
18528 See `org-ctrl-c-ctrl-c-hook' for more information.
18529 This hook runs after it has been established that the cursor is not in a
18530 table, but before checking if the cursor is in a headline or if global cycling
18531 should be done.
18532 If any function in this hook returns t, not other actions like visibility
18533 cycling will be done.")
18535 (defvar org-tab-after-check-for-cycling-hook nil
18536 "Hook for functions to attach themselves to TAB.
18537 See `org-ctrl-c-ctrl-c-hook' for more information.
18538 This hook runs after it has been established that not table field motion and
18539 not visibility should be done because of current context. This is probably
18540 the place where a package like yasnippets can hook in.")
18542 (defvar org-tab-before-tab-emulation-hook nil
18543 "Hook for functions to attach themselves to TAB.
18544 See `org-ctrl-c-ctrl-c-hook' for more information.
18545 This hook runs after every other options for TAB have been exhausted, but
18548 (defvar org-metaleft-hook nil
18549 "Hook for functions attaching themselves to `M-left'.
18550 See `org-ctrl-c-ctrl-c-hook' for more information.")
18551 (defvar org-metaright-hook nil
18552 "Hook for functions attaching themselves to `M-right'.
18553 See `org-ctrl-c-ctrl-c-hook' for more information.")
18554 (defvar org-metaup-hook nil
18555 "Hook for functions attaching themselves to `M-up'.
18556 See `org-ctrl-c-ctrl-c-hook' for more information.")
18557 (defvar org-metadown-hook nil
18558 "Hook for functions attaching themselves to `M-down'.
18559 See `org-ctrl-c-ctrl-c-hook' for more information.")
18560 (defvar org-shiftmetaleft-hook nil
18561 "Hook for functions attaching themselves to `M-S-left'.
18562 See `org-ctrl-c-ctrl-c-hook' for more information.")
18563 (defvar org-shiftmetaright-hook nil
18564 "Hook for functions attaching themselves to `M-S-right'.
18565 See `org-ctrl-c-ctrl-c-hook' for more information.")
18566 (defvar org-shiftmetaup-hook nil
18567 "Hook for functions attaching themselves to `M-S-up'.
18568 See `org-ctrl-c-ctrl-c-hook' for more information.")
18569 (defvar org-shiftmetadown-hook nil
18570 "Hook for functions attaching themselves to `M-S-down'.
18571 See `org-ctrl-c-ctrl-c-hook' for more information.")
18572 (defvar org-metareturn-hook nil
18573 "Hook for functions attaching themselves to `M-RET'.
18574 See `org-ctrl-c-ctrl-c-hook' for more information.")
18575 (defvar org-shiftup-hook nil
18576 "Hook for functions attaching themselves to `S-up'.
18577 See `org-ctrl-c-ctrl-c-hook' for more information.")
18578 (defvar org-shiftup-final-hook nil
18579 "Hook for functions attaching themselves to `S-up'.
18580 This one runs after all other options except shift-select have been excluded.
18581 See `org-ctrl-c-ctrl-c-hook' for more information.")
18582 (defvar org-shiftdown-hook nil
18583 "Hook for functions attaching themselves to `S-down'.
18584 See `org-ctrl-c-ctrl-c-hook' for more information.")
18585 (defvar org-shiftdown-final-hook nil
18586 "Hook for functions attaching themselves to `S-down'.
18587 This one runs after all other options except shift-select have been excluded.
18588 See `org-ctrl-c-ctrl-c-hook' for more information.")
18589 (defvar org-shiftleft-hook nil
18590 "Hook for functions attaching themselves to `S-left'.
18591 See `org-ctrl-c-ctrl-c-hook' for more information.")
18592 (defvar org-shiftleft-final-hook nil
18593 "Hook for functions attaching themselves to `S-left'.
18594 This one runs after all other options except shift-select have been excluded.
18595 See `org-ctrl-c-ctrl-c-hook' for more information.")
18596 (defvar org-shiftright-hook nil
18597 "Hook for functions attaching themselves to `S-right'.
18598 See `org-ctrl-c-ctrl-c-hook' for more information.")
18599 (defvar org-shiftright-final-hook nil
18600 "Hook for functions attaching themselves to `S-right'.
18601 This one runs after all other options except shift-select have been excluded.
18602 See `org-ctrl-c-ctrl-c-hook' for more information.")
18604 (defun org-modifier-cursor-error ()
18605 "Throw an error, a modified cursor command was applied in wrong context."
18606 (error "This command is active in special context like tables, headlines or items"))
18608 (defun org-shiftselect-error ()
18609 "Throw an error because Shift-Cursor command was applied in wrong context."
18610 (if (and (boundp 'shift-select-mode) shift-select-mode)
18611 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
18612 (error "This command works only in special context like headlines or timestamps")))
18614 (defun org-call-for-shift-select (cmd)
18615 (let ((this-command-keys-shift-translated t))
18616 (call-interactively cmd)))
18618 (defun org-shifttab (&optional arg)
18619 "Global visibility cycling or move to previous table field.
18620 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
18621 on context.
18622 See the individual commands for more information."
18623 (interactive "P")
18624 (cond
18625 ((org-at-table-p) (call-interactively 'org-table-previous-field))
18626 ((integerp arg)
18627 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18628 (message "Content view to level: %d" arg)
18629 (org-content (prefix-numeric-value arg2))
18630 (setq org-cycle-global-status 'overview)))
18631 (t (call-interactively 'org-global-cycle))))
18633 (defun org-shiftmetaleft ()
18634 "Promote subtree or delete table column.
18635 Calls `org-promote-subtree', `org-outdent-item-tree', or
18636 `org-table-delete-column', depending on context. See the
18637 individual commands for more information."
18638 (interactive)
18639 (cond
18640 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18641 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18642 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18643 ((if (not (org-region-active-p)) (org-at-item-p)
18644 (save-excursion (goto-char (region-beginning))
18645 (org-at-item-p)))
18646 (call-interactively 'org-outdent-item-tree))
18647 (t (org-modifier-cursor-error))))
18649 (defun org-shiftmetaright ()
18650 "Demote subtree or insert table column.
18651 Calls `org-demote-subtree', `org-indent-item-tree', or
18652 `org-table-insert-column', depending on context. See the
18653 individual commands for more information."
18654 (interactive)
18655 (cond
18656 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18657 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18658 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18659 ((if (not (org-region-active-p)) (org-at-item-p)
18660 (save-excursion (goto-char (region-beginning))
18661 (org-at-item-p)))
18662 (call-interactively 'org-indent-item-tree))
18663 (t (org-modifier-cursor-error))))
18665 (defun org-shiftmetaup (&optional arg)
18666 "Move subtree up or kill table row.
18667 Calls `org-move-subtree-up' or `org-table-kill-row' or
18668 `org-move-item-up' or `org-timestamp-up', depending on context.
18669 See the individual commands for more information."
18670 (interactive "P")
18671 (cond
18672 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18673 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18674 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18675 ((org-at-item-p) (call-interactively 'org-move-item-up))
18676 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18677 (call-interactively 'org-timestamp-up)))
18678 (t (org-modifier-cursor-error))))
18680 (defun org-shiftmetadown (&optional arg)
18681 "Move subtree down or insert table row.
18682 Calls `org-move-subtree-down' or `org-table-insert-row' or
18683 `org-move-item-down' or `org-timestamp-up', depending on context.
18684 See the individual commands for more information."
18685 (interactive "P")
18686 (cond
18687 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18688 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18689 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18690 ((org-at-item-p) (call-interactively 'org-move-item-down))
18691 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
18692 (call-interactively 'org-timestamp-down)))
18693 (t (org-modifier-cursor-error))))
18695 (defsubst org-hidden-tree-error ()
18696 (error
18697 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18699 (defun org-metaleft (&optional arg)
18700 "Promote heading or move table column to left.
18701 Calls `org-do-promote' or `org-table-move-column', depending on context.
18702 With no specific context, calls the Emacs default `backward-word'.
18703 See the individual commands for more information."
18704 (interactive "P")
18705 (cond
18706 ((run-hook-with-args-until-success 'org-metaleft-hook))
18707 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18708 ((org-with-limited-levels
18709 (or (org-at-heading-p)
18710 (and (org-region-active-p)
18711 (save-excursion
18712 (goto-char (region-beginning))
18713 (org-at-heading-p)))))
18714 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18715 (call-interactively 'org-do-promote))
18716 ;; At an inline task.
18717 ((org-at-heading-p)
18718 (call-interactively 'org-inlinetask-promote))
18719 ((or (org-at-item-p)
18720 (and (org-region-active-p)
18721 (save-excursion
18722 (goto-char (region-beginning))
18723 (org-at-item-p))))
18724 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18725 (call-interactively 'org-outdent-item))
18726 (t (call-interactively 'backward-word))))
18728 (defun org-metaright (&optional arg)
18729 "Demote a subtree, a list item or move table column to right.
18730 In front of a drawer or a block keyword, indent it correctly.
18731 With no specific context, calls the Emacs default `forward-word'.
18732 See the individual commands for more information."
18733 (interactive "P")
18734 (cond
18735 ((run-hook-with-args-until-success 'org-metaright-hook))
18736 ((org-at-table-p) (call-interactively 'org-table-move-column))
18737 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18738 ((org-at-block-p) (call-interactively 'org-indent-block))
18739 ((org-with-limited-levels
18740 (or (org-at-heading-p)
18741 (and (org-region-active-p)
18742 (save-excursion
18743 (goto-char (region-beginning))
18744 (org-at-heading-p)))))
18745 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18746 (call-interactively 'org-do-demote))
18747 ;; At an inline task.
18748 ((org-at-heading-p)
18749 (call-interactively 'org-inlinetask-demote))
18750 ((or (org-at-item-p)
18751 (and (org-region-active-p)
18752 (save-excursion
18753 (goto-char (region-beginning))
18754 (org-at-item-p))))
18755 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18756 (call-interactively 'org-indent-item))
18757 (t (call-interactively 'forward-word))))
18759 (defun org-check-for-hidden (what)
18760 "Check if there are hidden headlines/items in the current visual line.
18761 WHAT can be either `headlines' or `items'. If the current line is
18762 an outline or item heading and it has a folded subtree below it,
18763 this function returns t, nil otherwise."
18764 (let ((re (cond
18765 ((eq what 'headlines) org-outline-regexp-bol)
18766 ((eq what 'items) (org-item-beginning-re))
18767 (t (error "This should not happen"))))
18768 beg end)
18769 (save-excursion
18770 (catch 'exit
18771 (unless (org-region-active-p)
18772 (setq beg (point-at-bol))
18773 (beginning-of-line 2)
18774 (while (and (not (eobp)) ;; this is like `next-line'
18775 (get-char-property (1- (point)) 'invisible))
18776 (beginning-of-line 2))
18777 (setq end (point))
18778 (goto-char beg)
18779 (goto-char (point-at-eol))
18780 (setq end (max end (point)))
18781 (while (re-search-forward re end t)
18782 (if (get-char-property (match-beginning 0) 'invisible)
18783 (throw 'exit t))))
18784 nil))))
18786 (autoload 'org-element-at-point "org-element")
18788 (declare-function org-element-at-point "org-element" (&optional keep-trail))
18789 (declare-function org-element-type "org-element" (element))
18790 (declare-function org-element-contents "org-element" (element))
18791 (declare-function org-element-property "org-element" (property element))
18792 (declare-function org-element-paragraph-parser "org-element" (limit))
18793 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
18794 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
18795 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
18796 (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
18797 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
18799 (defun org-metaup (&optional arg)
18800 "Move subtree up or move table row up.
18801 Calls `org-move-subtree-up' or `org-table-move-row' or
18802 `org-move-item-up', depending on context. See the individual commands
18803 for more information."
18804 (interactive "P")
18805 (cond
18806 ((run-hook-with-args-until-success 'org-metaup-hook))
18807 ((org-region-active-p)
18808 (let* ((a (min (region-beginning) (region-end)))
18809 (b (1- (max (region-beginning) (region-end))))
18810 (c (save-excursion (goto-char a)
18811 (move-beginning-of-line 0)))
18812 (d (save-excursion (goto-char a)
18813 (move-end-of-line 0) (point))))
18814 (transpose-regions a b c d)
18815 (goto-char c)))
18816 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18817 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18818 ((org-at-item-p) (call-interactively 'org-move-item-up))
18819 (t (org-drag-element-backward))))
18821 (defun org-metadown (&optional arg)
18822 "Move subtree down or move table row down.
18823 Calls `org-move-subtree-down' or `org-table-move-row' or
18824 `org-move-item-down', depending on context. See the individual
18825 commands for more information."
18826 (interactive "P")
18827 (cond
18828 ((run-hook-with-args-until-success 'org-metadown-hook))
18829 ((org-region-active-p)
18830 (let* ((a (min (region-beginning) (region-end)))
18831 (b (max (region-beginning) (region-end)))
18832 (c (save-excursion (goto-char b)
18833 (move-beginning-of-line 1)))
18834 (d (save-excursion (goto-char b)
18835 (move-end-of-line 1) (1+ (point)))))
18836 (transpose-regions a b c d)
18837 (goto-char d)))
18838 ((org-at-table-p) (call-interactively 'org-table-move-row))
18839 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18840 ((org-at-item-p) (call-interactively 'org-move-item-down))
18841 (t (org-drag-element-forward))))
18843 (defun org-shiftup (&optional arg)
18844 "Increase item in timestamp or increase priority of current headline.
18845 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18846 depending on context. See the individual commands for more information."
18847 (interactive "P")
18848 (cond
18849 ((run-hook-with-args-until-success 'org-shiftup-hook))
18850 ((and org-support-shift-select (org-region-active-p))
18851 (org-call-for-shift-select 'previous-line))
18852 ((org-at-timestamp-p t)
18853 (call-interactively (if org-edit-timestamp-down-means-later
18854 'org-timestamp-down 'org-timestamp-up)))
18855 ((and (not (eq org-support-shift-select 'always))
18856 org-enable-priority-commands
18857 (org-at-heading-p))
18858 (call-interactively 'org-priority-up))
18859 ((and (not org-support-shift-select) (org-at-item-p))
18860 (call-interactively 'org-previous-item))
18861 ((org-clocktable-try-shift 'up arg))
18862 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18863 (org-support-shift-select
18864 (org-call-for-shift-select 'previous-line))
18865 (t (org-shiftselect-error))))
18867 (defun org-shiftdown (&optional arg)
18868 "Decrease item in timestamp or decrease priority of current headline.
18869 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18870 depending on context. See the individual commands for more information."
18871 (interactive "P")
18872 (cond
18873 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18874 ((and org-support-shift-select (org-region-active-p))
18875 (org-call-for-shift-select 'next-line))
18876 ((org-at-timestamp-p t)
18877 (call-interactively (if org-edit-timestamp-down-means-later
18878 'org-timestamp-up 'org-timestamp-down)))
18879 ((and (not (eq org-support-shift-select 'always))
18880 org-enable-priority-commands
18881 (org-at-heading-p))
18882 (call-interactively 'org-priority-down))
18883 ((and (not org-support-shift-select) (org-at-item-p))
18884 (call-interactively 'org-next-item))
18885 ((org-clocktable-try-shift 'down arg))
18886 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18887 (org-support-shift-select
18888 (org-call-for-shift-select 'next-line))
18889 (t (org-shiftselect-error))))
18891 (defun org-shiftright (&optional arg)
18892 "Cycle the thing at point or in the current line, depending on context.
18893 Depending on context, this does one of the following:
18895 - switch a timestamp at point one day into the future
18896 - on a headline, switch to the next TODO keyword.
18897 - on an item, switch entire list to the next bullet type
18898 - on a property line, switch to the next allowed value
18899 - on a clocktable definition line, move time block into the future"
18900 (interactive "P")
18901 (cond
18902 ((run-hook-with-args-until-success 'org-shiftright-hook))
18903 ((and org-support-shift-select (org-region-active-p))
18904 (org-call-for-shift-select 'forward-char))
18905 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18906 ((and (not (eq org-support-shift-select 'always))
18907 (org-at-heading-p))
18908 (let ((org-inhibit-logging
18909 (not org-treat-S-cursor-todo-selection-as-state-change))
18910 (org-inhibit-blocking
18911 (not org-treat-S-cursor-todo-selection-as-state-change)))
18912 (org-call-with-arg 'org-todo 'right)))
18913 ((or (and org-support-shift-select
18914 (not (eq org-support-shift-select 'always))
18915 (org-at-item-bullet-p))
18916 (and (not org-support-shift-select) (org-at-item-p)))
18917 (org-call-with-arg 'org-cycle-list-bullet nil))
18918 ((and (not (eq org-support-shift-select 'always))
18919 (org-at-property-p))
18920 (call-interactively 'org-property-next-allowed-value))
18921 ((org-clocktable-try-shift 'right arg))
18922 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18923 (org-support-shift-select
18924 (org-call-for-shift-select 'forward-char))
18925 (t (org-shiftselect-error))))
18927 (defun org-shiftleft (&optional arg)
18928 "Cycle the thing at point or in the current line, depending on context.
18929 Depending on context, this does one of the following:
18931 - switch a timestamp at point one day into the past
18932 - on a headline, switch to the previous TODO keyword.
18933 - on an item, switch entire list to the previous bullet type
18934 - on a property line, switch to the previous allowed value
18935 - on a clocktable definition line, move time block into the past"
18936 (interactive "P")
18937 (cond
18938 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18939 ((and org-support-shift-select (org-region-active-p))
18940 (org-call-for-shift-select 'backward-char))
18941 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18942 ((and (not (eq org-support-shift-select 'always))
18943 (org-at-heading-p))
18944 (let ((org-inhibit-logging
18945 (not org-treat-S-cursor-todo-selection-as-state-change))
18946 (org-inhibit-blocking
18947 (not org-treat-S-cursor-todo-selection-as-state-change)))
18948 (org-call-with-arg 'org-todo 'left)))
18949 ((or (and org-support-shift-select
18950 (not (eq org-support-shift-select 'always))
18951 (org-at-item-bullet-p))
18952 (and (not org-support-shift-select) (org-at-item-p)))
18953 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18954 ((and (not (eq org-support-shift-select 'always))
18955 (org-at-property-p))
18956 (call-interactively 'org-property-previous-allowed-value))
18957 ((org-clocktable-try-shift 'left arg))
18958 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18959 (org-support-shift-select
18960 (org-call-for-shift-select 'backward-char))
18961 (t (org-shiftselect-error))))
18963 (defun org-shiftcontrolright ()
18964 "Switch to next TODO set."
18965 (interactive)
18966 (cond
18967 ((and org-support-shift-select (org-region-active-p))
18968 (org-call-for-shift-select 'forward-word))
18969 ((and (not (eq org-support-shift-select 'always))
18970 (org-at-heading-p))
18971 (org-call-with-arg 'org-todo 'nextset))
18972 (org-support-shift-select
18973 (org-call-for-shift-select 'forward-word))
18974 (t (org-shiftselect-error))))
18976 (defun org-shiftcontrolleft ()
18977 "Switch to previous TODO set."
18978 (interactive)
18979 (cond
18980 ((and org-support-shift-select (org-region-active-p))
18981 (org-call-for-shift-select 'backward-word))
18982 ((and (not (eq org-support-shift-select 'always))
18983 (org-at-heading-p))
18984 (org-call-with-arg 'org-todo 'previousset))
18985 (org-support-shift-select
18986 (org-call-for-shift-select 'backward-word))
18987 (t (org-shiftselect-error))))
18989 (defun org-shiftcontrolup ()
18990 "Change timestamps synchronously up in CLOCK log lines."
18991 (interactive)
18992 (cond ((and (not org-support-shift-select)
18993 (org-at-clock-log-p)
18994 (org-at-timestamp-p t))
18995 (org-clock-timestamps-up))
18996 (t (org-shiftselect-error))))
18998 (defun org-shiftcontroldown ()
18999 "Change timestamps synchronously down in CLOCK log lines."
19000 (interactive)
19001 (cond ((and (not org-support-shift-select)
19002 (org-at-clock-log-p)
19003 (org-at-timestamp-p t))
19004 (org-clock-timestamps-down))
19005 (t (org-shiftselect-error))))
19007 (defun org-ctrl-c-ret ()
19008 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19009 (interactive)
19010 (cond
19011 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19012 (t (call-interactively 'org-insert-heading))))
19014 (defun org-find-visible ()
19015 (let ((s (point)))
19016 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19017 (get-char-property s 'invisible)))
19018 s))
19019 (defun org-find-invisible ()
19020 (let ((s (point)))
19021 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19022 (not (get-char-property s 'invisible))))
19023 s))
19025 (defun org-copy-visible (beg end)
19026 "Copy the visible parts of the region."
19027 (interactive "r")
19028 (let (snippets s)
19029 (save-excursion
19030 (save-restriction
19031 (narrow-to-region beg end)
19032 (setq s (goto-char (point-min)))
19033 (while (not (= (point) (point-max)))
19034 (goto-char (org-find-invisible))
19035 (push (buffer-substring s (point)) snippets)
19036 (setq s (goto-char (org-find-visible))))))
19037 (kill-new (apply 'concat (nreverse snippets)))))
19039 (defun org-copy-special ()
19040 "Copy region in table or copy current subtree.
19041 Calls `org-table-copy' or `org-copy-subtree', depending on context.
19042 See the individual commands for more information."
19043 (interactive)
19044 (call-interactively
19045 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
19047 (defun org-cut-special ()
19048 "Cut region in table or cut current subtree.
19049 Calls `org-table-copy' or `org-cut-subtree', depending on context.
19050 See the individual commands for more information."
19051 (interactive)
19052 (call-interactively
19053 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
19055 (defun org-paste-special (arg)
19056 "Paste rectangular region into table, or past subtree relative to level.
19057 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
19058 See the individual commands for more information."
19059 (interactive "P")
19060 (if (org-at-table-p)
19061 (org-table-paste-rectangle)
19062 (org-paste-subtree arg)))
19064 (defun org-edit-special (&optional arg)
19065 "Call a special editor for the stuff at point.
19066 When at a table, call the formula editor with `org-table-edit-formulas'.
19067 When at the first line of an src example, call `org-edit-src-code'.
19068 When in an #+include line, visit the include file. Otherwise call
19069 `ffap' to visit the file at point."
19070 (interactive)
19071 ;; possibly prep session before editing source
19072 (when arg
19073 (let* ((info (org-babel-get-src-block-info))
19074 (lang (nth 0 info))
19075 (params (nth 2 info))
19076 (session (cdr (assoc :session params))))
19077 (when (and info session) ;; we are in a source-code block with a session
19078 (funcall
19079 (intern (concat "org-babel-prep-session:" lang)) session params))))
19080 (cond ;; proceed with `org-edit-special'
19081 ((save-excursion
19082 (beginning-of-line 1)
19083 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
19084 (find-file (org-trim (match-string 1))))
19085 ((org-edit-src-code))
19086 ((org-edit-fixed-width-region))
19087 ((org-at-table.el-p)
19088 (org-edit-src-code))
19089 ((or (org-at-table-p)
19090 (save-excursion
19091 (beginning-of-line 1)
19093 (call-interactively 'org-table-edit-formulas))
19094 (t (call-interactively 'ffap))))
19096 (defvar org-table-coordinate-overlays) ; defined in org-table.el
19097 (defun org-ctrl-c-ctrl-c (&optional arg)
19098 "Set tags in headline, or update according to changed information at point.
19100 This command does many different things, depending on context:
19102 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
19103 this is what we do.
19105 - If the cursor is on a statistics cookie, update it.
19107 - If the cursor is in a headline, prompt for tags and insert them
19108 into the current line, aligned to `org-tags-column'. When called
19109 with prefix arg, realign all tags in the current buffer.
19111 - If the cursor is in one of the special #+KEYWORD lines, this
19112 triggers scanning the buffer for these lines and updating the
19113 information.
19115 - If the cursor is inside a table, realign the table. This command
19116 works even if the automatic table editor has been turned off.
19118 - If the cursor is on a #+TBLFM line, re-apply the formulas to
19119 the entire table.
19121 - If the cursor is at a footnote reference or definition, jump to
19122 the corresponding definition or references, respectively.
19124 - If the cursor is a the beginning of a dynamic block, update it.
19126 - If the current buffer is a capture buffer, close note and file it.
19128 - If the cursor is on a <<<target>>>, update radio targets and
19129 corresponding links in this buffer.
19131 - If the cursor is on a numbered item in a plain list, renumber the
19132 ordered list.
19134 - If the cursor is on a checkbox, toggle it.
19136 - If the cursor is on a code block, evaluate it. The variable
19137 `org-confirm-babel-evaluate' can be used to control prompting
19138 before code block evaluation, by default every code block
19139 evaluation requires confirmation. Code block evaluation can be
19140 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
19141 (interactive "P")
19142 (let ((org-enable-table-editor t))
19143 (cond
19144 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
19145 org-occur-highlights
19146 org-latex-fragment-image-overlays)
19147 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
19148 (org-remove-occur-highlights)
19149 (org-remove-latex-fragment-image-overlays)
19150 (message "Temporary highlights/overlays removed from current buffer"))
19151 ((and (local-variable-p 'org-finish-function (current-buffer))
19152 (fboundp org-finish-function))
19153 (funcall org-finish-function))
19154 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
19155 ((org-in-regexp org-ts-regexp-both)
19156 (org-timestamp-change 0 'day))
19157 ((or (looking-at org-property-start-re)
19158 (org-at-property-p))
19159 (call-interactively 'org-property-action))
19160 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
19162 (or (org-at-heading-p) (org-at-item-p)))
19163 (call-interactively 'org-update-statistics-cookies))
19164 ((org-at-heading-p) (call-interactively 'org-set-tags))
19165 ((org-at-table.el-p)
19166 (message "Use C-c ' to edit table.el tables"))
19167 ((org-at-table-p)
19168 (org-table-maybe-eval-formula)
19169 (if arg
19170 (call-interactively 'org-table-recalculate)
19171 (org-table-maybe-recalculate-line))
19172 (call-interactively 'org-table-align)
19173 (orgtbl-send-table 'maybe))
19174 ((or (org-footnote-at-reference-p)
19175 (org-footnote-at-definition-p))
19176 (call-interactively 'org-footnote-action))
19177 ((org-at-item-checkbox-p)
19178 ;; Cursor at a checkbox: repair list and update checkboxes. Send
19179 ;; list only if at top item.
19180 (let* ((cbox (match-string 1))
19181 (struct (org-list-struct))
19182 (old-struct (copy-tree struct))
19183 (parents (org-list-parents-alist struct))
19184 (orderedp (org-entry-get nil "ORDERED"))
19185 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19186 block-item)
19187 ;; Use a light version of `org-toggle-checkbox' to avoid
19188 ;; computing list structure twice.
19189 (let ((new-box (cond
19190 ((equal arg '(16)) "[-]")
19191 ((equal arg '(4)) nil)
19192 ((equal "[X]" cbox) "[ ]")
19193 (t "[X]"))))
19194 (if (and firstp arg)
19195 ;; If at first item of sub-list, remove check-box from
19196 ;; every item at the same level.
19197 (mapc
19198 (lambda (pos) (org-list-set-checkbox pos struct new-box))
19199 (org-list-get-all-items
19200 (point-at-bol) struct (org-list-prevs-alist struct)))
19201 (org-list-set-checkbox (point-at-bol) struct new-box)))
19202 ;; Replicate `org-list-write-struct', while grabbing a return
19203 ;; value from `org-list-struct-fix-box'.
19204 (org-list-struct-fix-ind struct parents 2)
19205 (org-list-struct-fix-item-end struct)
19206 (let ((prevs (org-list-prevs-alist struct)))
19207 (org-list-struct-fix-bul struct prevs)
19208 (org-list-struct-fix-ind struct parents)
19209 (setq block-item
19210 (org-list-struct-fix-box struct parents prevs orderedp)))
19211 (org-list-struct-apply-struct struct old-struct)
19212 (org-update-checkbox-count-maybe)
19213 (when block-item
19214 (message
19215 "Checkboxes were removed due to unchecked box at line %d"
19216 (org-current-line block-item)))
19217 (when firstp (org-list-send-list 'maybe))))
19218 ((org-at-item-p)
19219 ;; Cursor at an item: repair list. Do checkbox related actions
19220 ;; only if function was called with an argument. Send list only
19221 ;; if at top item.
19222 (let* ((struct (org-list-struct))
19223 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
19224 old-struct)
19225 (when arg
19226 (setq old-struct (copy-tree struct))
19227 (if firstp
19228 ;; If at first item of sub-list, add check-box to every
19229 ;; item at the same level.
19230 (mapc
19231 (lambda (pos)
19232 (unless (org-list-get-checkbox pos struct)
19233 (org-list-set-checkbox pos struct "[ ]")))
19234 (org-list-get-all-items
19235 (point-at-bol) struct (org-list-prevs-alist struct)))
19236 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
19237 (org-list-write-struct
19238 struct (org-list-parents-alist struct) old-struct)
19239 (when arg (org-update-checkbox-count-maybe))
19240 (when firstp (org-list-send-list 'maybe))))
19241 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
19242 ;; Dynamic block
19243 (beginning-of-line 1)
19244 (save-excursion (org-update-dblock)))
19245 ((save-excursion
19246 (let ((case-fold-search t))
19247 (beginning-of-line 1)
19249 (cond
19250 ((or (equal (match-string 1) "TBLFM")
19251 (equal (match-string 1) "tblfm"))
19252 ;; Recalculate the table before this line
19253 (save-excursion
19254 (beginning-of-line 1)
19256 (if (org-at-table-p)
19257 (org-call-with-arg 'org-table-recalculate (or arg t)))))
19258 (t
19259 (let ((org-inhibit-startup-visibility-stuff t)
19260 (org-startup-align-all-tables nil))
19261 (when (boundp 'org-table-coordinate-overlays)
19262 (mapc 'delete-overlay org-table-coordinate-overlays)
19263 (setq org-table-coordinate-overlays nil))
19264 (org-save-outline-visibility 'use-markers (org-mode-restart)))
19265 (message "Local setup has been refreshed"))))
19266 ((org-clock-update-time-maybe))
19267 (t
19268 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19269 (error "C-c C-c can do nothing useful at this location"))))))
19271 (defun org-mode-restart ()
19272 "Restart Org-mode, to scan again for special lines.
19273 Also updates the keyword regular expressions."
19274 (interactive)
19275 (org-mode)
19276 (message "Org-mode restarted"))
19278 (defun org-kill-note-or-show-branches ()
19279 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
19280 (interactive)
19281 (if (not org-finish-function)
19282 (progn
19283 (hide-subtree)
19284 (call-interactively 'show-branches))
19285 (let ((org-note-abort t))
19286 (funcall org-finish-function))))
19288 (defun org-return (&optional indent)
19289 "Goto next table row or insert a newline.
19290 Calls `org-table-next-row' or `newline', depending on context.
19291 See the individual commands for more information."
19292 (interactive)
19293 (let (org-ts-what)
19294 (cond
19295 ((or (bobp) (org-in-src-block-p))
19296 (if indent (newline-and-indent) (newline)))
19297 ((org-at-table-p)
19298 (org-table-justify-field-maybe)
19299 (call-interactively 'org-table-next-row))
19300 ;; when `newline-and-indent' is called within a list, make sure
19301 ;; text moved stays inside the item.
19302 ((and (org-in-item-p) indent)
19303 (if (and (org-at-item-p) (>= (point) (match-end 0)))
19304 (progn
19305 (save-match-data (newline))
19306 (org-indent-line-to (length (match-string 0))))
19307 (let ((ind (org-get-indentation)))
19308 (newline)
19309 (if (org-looking-back org-list-end-re)
19310 (org-indent-line)
19311 (org-indent-line-to ind)))))
19312 ((and org-return-follows-link
19313 (org-at-timestamp-p t)
19314 (not (eq org-ts-what 'after)))
19315 (org-follow-timestamp-link))
19316 ((and org-return-follows-link
19317 (let ((tprop (get-text-property (point) 'face)))
19318 (or (eq tprop 'org-link)
19319 (and (listp tprop) (memq 'org-link tprop)))))
19320 (call-interactively 'org-open-at-point))
19321 ((and (org-at-heading-p)
19322 (looking-at
19324 (org-show-entry)
19325 (end-of-line 1)
19326 (newline))
19327 (t (if indent (newline-and-indent) (newline))))))
19329 (defun org-return-indent ()
19330 "Goto next table row or insert a newline and indent.
19331 Calls `org-table-next-row' or `newline-and-indent', depending on
19332 context. See the individual commands for more information."
19333 (interactive)
19334 (org-return t))
19336 (defun org-ctrl-c-star ()
19337 "Compute table, or change heading status of lines.
19338 Calls `org-table-recalculate' or `org-toggle-heading',
19339 depending on context."
19340 (interactive)
19341 (cond
19342 ((org-at-table-p)
19343 (call-interactively 'org-table-recalculate))
19344 (t
19345 ;; Convert all lines in region to list items
19346 (call-interactively 'org-toggle-heading))))
19348 (defun org-ctrl-c-minus ()
19349 "Insert separator line in table or modify bullet status of line.
19350 Also turns a plain line or a region of lines into list items.
19351 Calls `org-table-insert-hline', `org-toggle-item', or
19352 `org-cycle-list-bullet', depending on context."
19353 (interactive)
19354 (cond
19355 ((org-at-table-p)
19356 (call-interactively 'org-table-insert-hline))
19357 ((org-region-active-p)
19358 (call-interactively 'org-toggle-item))
19359 ((org-in-item-p)
19360 (call-interactively 'org-cycle-list-bullet))
19361 (t
19362 (call-interactively 'org-toggle-item))))
19364 (defun org-toggle-item (arg)
19365 "Convert headings or normal lines to items, items to normal lines.
19366 If there is no active region, only the current line is considered.
19368 If the first non blank line in the region is an headline, convert
19369 all headlines to items, shifting text accordingly.
19371 If it is an item, convert all items to normal lines.
19373 If it is normal text, change region into an item. With a prefix
19374 argument ARG, change each line in region into an item."
19375 (interactive "P")
19376 (let ((shift-text
19377 (function
19378 ;; Shift text in current section to IND, from point to END.
19379 ;; The function leaves point to END line.
19380 (lambda (ind end)
19381 (let ((min-i 1000) (end (copy-marker end)))
19382 ;; First determine the minimum indentation (MIN-I) of
19383 ;; the text.
19384 (save-excursion
19385 (catch 'exit
19386 (while (< (point) end)
19387 (let ((i (org-get-indentation)))
19388 (cond
19389 ;; Skip blank lines and inline tasks.
19391 ((looking-at org-outline-regexp-bol))
19392 ;; We can't find less than 0 indentation.
19393 ((zerop i) (throw 'exit (setq min-i 0)))
19394 ((< i min-i) (setq min-i i))))
19395 (forward-line))))
19396 ;; Then indent each line so that a line indented to
19397 ;; MIN-I becomes indented to IND. Ignore blank lines
19398 ;; and inline tasks in the process.
19399 (let ((delta (- ind min-i)))
19400 (while (< (point) end)
19402 (looking-at org-outline-regexp-bol))
19403 (org-indent-line-to (+ (org-get-indentation) delta)))
19404 (forward-line)))))))
19405 (skip-blanks
19406 (function
19407 ;; Return beginning of first non-blank line, starting from
19408 ;; line at POS.
19409 (lambda (pos)
19410 (save-excursion
19411 (goto-char pos)
19413 (point-at-bol)))))
19414 beg end)
19415 ;; Determine boundaries of changes.
19416 (if (org-region-active-p)
19417 (setq beg (funcall skip-blanks (region-beginning))
19418 end (copy-marker (region-end)))
19419 (setq beg (funcall skip-blanks (point-at-bol))
19420 end (copy-marker (point-at-eol))))
19421 ;; Depending on the starting line, choose an action on the text
19422 ;; between BEG and END.
19423 (org-with-limited-levels
19424 (save-excursion
19425 (goto-char beg)
19426 (cond
19427 ;; Case 1. Start at an item: de-itemize. Note that it only
19428 ;; happens when a region is active: `org-ctrl-c-minus'
19429 ;; would call `org-cycle-list-bullet' otherwise.
19430 ((org-at-item-p)
19431 (while (< (point) end)
19432 (when (org-at-item-p)
19434 (delete-region (point) (match-end 0)))
19435 (forward-line)))
19436 ;; Case 2. Start at an heading: convert to items.
19437 ((org-at-heading-p)
19438 (let* ((bul (org-list-bullet-string "-"))
19439 (bul-len (length bul))
19440 ;; Indentation of the first heading. It should be
19441 ;; relative to the indentation of its parent, if any.
19442 (start-ind (save-excursion
19443 (cond
19444 ((not org-adapt-indentation) 0)
19445 ((not (outline-previous-heading)) 0)
19446 (t (length (match-string 0))))))
19447 ;; Level of first heading. Further headings will be
19448 ;; compared to it to determine hierarchy in the list.
19449 (ref-level (org-reduced-level (org-outline-level))))
19450 (while (< (point) end)
19451 (let* ((level (org-reduced-level (org-outline-level)))
19452 (delta (max 0 (- level ref-level))))
19453 ;; If current headline is less indented than the first
19454 ;; one, set it as reference, in order to preserve
19455 ;; subtrees.
19456 (when (< level ref-level) (setq ref-level level))
19457 (replace-match bul t t)
19458 (org-indent-line-to (+ start-ind (* delta bul-len)))
19459 ;; Ensure all text down to END (or SECTION-END) belongs
19460 ;; to the newly created item.
19461 (let ((section-end (save-excursion
19462 (or (outline-next-heading) (point)))))
19463 (forward-line)
19464 (funcall shift-text
19465 (+ start-ind (* (1+ delta) bul-len))
19466 (min end section-end)))))))
19467 ;; Case 3. Normal line with ARG: turn each non-item line into
19468 ;; an item.
19469 (arg
19470 (while (< (point) end)
19471 (unless (or (org-at-heading-p) (org-at-item-p))
19473 (replace-match
19475 (forward-line)))
19476 ;; Case 4. Normal line without ARG: make the first line of
19477 ;; region an item, and shift indentation of others
19478 ;; lines to set them as item's body.
19479 (t (let* ((bul (org-list-bullet-string "-"))
19480 (bul-len (length bul))
19481 (ref-ind (org-get-indentation)))
19483 (insert bul)
19484 (forward-line)
19485 (while (< (point) end)
19486 ;; Ensure that lines less indented than first one
19487 ;; still get included in item body.
19488 (funcall shift-text
19489 (+ ref-ind bul-len)
19490 (min end (save-excursion (or (outline-next-heading)
19491 (point)))))
19492 (forward-line)))))))))
19494 (defun org-toggle-heading (&optional nstars)
19495 "Convert headings to normal text, or items or text to headings.
19496 If there is no active region, only the current line is considered.
19499 point into heading.
19501 In a region:
19503 - If the first non blank line is an headline, remove the stars
19504 from all headlines in the region.
19506 - If it is a normal line turn each and every normal line (i.e. not an
19507 heading or an item) in the region into a heading.
19509 - If it is a plain list item, turn all plain list items into headings.
19511 When converting a line into a heading, the number of stars is chosen
19512 such that the lines become children of the current entry. However,
19513 when a prefix argument is given, its value determines the number of
19514 stars to add."
19515 (interactive "P")
19516 (let ((skip-blanks
19517 (function
19518 ;; Return beginning of first non-blank line, starting from
19519 ;; line at POS.
19520 (lambda (pos)
19521 (save-excursion
19522 (goto-char pos)
19523 (while (org-at-comment-p) (forward-line))
19525 (point-at-bol)))))
19526 beg end toggled)
19527 ;; Determine boundaries of changes. If a universal prefix has
19528 ;; been given, put the list in a region. If region ends at a bol,
19529 ;; do not consider the last line to be in the region.
19531 (when (and current-prefix-arg (org-at-item-p))
19532 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
19533 (org-mark-element))
19535 (if (org-region-active-p)
19536 (setq beg (funcall skip-blanks (region-beginning))
19537 end (copy-marker (save-excursion
19538 (goto-char (region-end))
19539 (if (bolp) (point) (point-at-eol)))))
19540 (setq beg (funcall skip-blanks (point-at-bol))
19541 end (copy-marker (point-at-eol))))
19542 ;; Ensure inline tasks don't count as headings.
19543 (org-with-limited-levels
19544 (save-excursion
19545 (goto-char beg)
19546 (cond
19547 ;; Case 1. Started at an heading: de-star headings.
19548 ((org-at-heading-p)
19549 (while (< (point) end)
19550 (when (org-at-heading-p t)
19551 (looking-at org-outline-regexp) (replace-match "")
19552 (setq toggled t))
19553 (forward-line)))
19554 ;; Case 2. Started at an item: change items into headlines.
19555 ;; One star will be added by `org-list-to-subtree'.
19556 ((org-at-item-p)
19557 (let* ((stars (make-string
19558 (if nstars
19559 ;; subtract the star that will be added again by
19560 ;; `org-list-to-subtree'
19561 (1- (prefix-numeric-value current-prefix-arg))
19562 (or (org-current-level) 0))
19563 ?*))
19564 (add-stars
19565 (cond (nstars "") ; stars from prefix only
19566 ((equal stars "") "") ; before first heading
19567 (org-odd-levels-only "*") ; inside heading, odd
19568 (t "")))) ; inside heading, oddeven
19569 (while (< (point) end)
19570 (when (org-at-item-p)
19571 ;; Pay attention to cases when region ends before list.
19572 (let* ((struct (org-list-struct))
19573 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
19574 (save-restriction
19575 (narrow-to-region (point) list-end)
19576 (insert
19577 (org-list-to-subtree
19578 (org-list-parse-list t)
19579 '(:istart (concat stars add-stars (funcall get-stars depth))
19580 :icount (concat stars add-stars (funcall get-stars depth)))))))
19581 (setq toggled t))
19582 (forward-line))))
19583 ;; Case 3. Started at normal text: make every line an heading,
19584 ;; skipping headlines and items.
19585 (t (let* ((stars (make-string
19586 (if nstars
19587 (prefix-numeric-value current-prefix-arg)
19588 (or (org-current-level) 0))
19589 ?*))
19590 (add-stars
19591 (cond (nstars "") ; stars from prefix only
19592 ((equal stars "") "*") ; before first heading
19593 (org-odd-levels-only "**") ; inside heading, odd
19594 (t "*"))) ; inside heading, oddeven
19595 (rpl (concat stars add-stars " ")))
19596 (while (< (point) end)
19597 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
19599 (replace-match (concat rpl (match-string 2))) (setq toggled t))
19600 (forward-line)))))))
19601 (unless toggled (message "Cannot toggle heading from here"))))
19603 (defun org-meta-return (&optional arg)
19604 "Insert a new heading or wrap a region in a table.
19605 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
19606 See the individual commands for more information."
19607 (interactive "P")
19608 (cond
19609 ((run-hook-with-args-until-success 'org-metareturn-hook))
19610 ((or (org-at-drawer-p) (org-at-property-p))
19611 (newline-and-indent))
19612 ((org-at-table-p)
19613 (call-interactively 'org-table-wrap-region))
19614 (t (call-interactively 'org-insert-heading))))
19616 ;;; Menu entries
19618 ;; Define the Org-mode menus
19619 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
19620 '("Tbl"
19621 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
19622 ["Next Field" org-cycle (org-at-table-p)]
19623 ["Previous Field" org-shifttab (org-at-table-p)]
19624 ["Next Row" org-return (org-at-table-p)]
19625 "--"
19626 ["Blank Field" org-table-blank-field (org-at-table-p)]
19627 ["Edit Field" org-table-edit-field (org-at-table-p)]
19628 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
19629 "--"
19630 ("Column"
19631 ["Move Column Left" org-metaleft (org-at-table-p)]
19632 ["Move Column Right" org-metaright (org-at-table-p)]
19633 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
19634 ["Insert Column" org-shiftmetaright (org-at-table-p)])
19635 ("Row"
19636 ["Move Row Up" org-metaup (org-at-table-p)]
19637 ["Move Row Down" org-metadown (org-at-table-p)]
19638 ["Delete Row" org-shiftmetaup (org-at-table-p)]
19639 ["Insert Row" org-shiftmetadown (org-at-table-p)]
19640 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
19641 "--"
19642 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
19643 ("Rectangle"
19644 ["Copy Rectangle" org-copy-special (org-at-table-p)]
19645 ["Cut Rectangle" org-cut-special (org-at-table-p)]
19646 ["Paste Rectangle" org-paste-special (org-at-table-p)]
19647 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
19648 "--"
19649 ("Calculate"
19650 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
19651 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
19652 ["Edit Formulas" org-edit-special (org-at-table-p)]
19653 "--"
19654 ["Recalculate line" org-table-recalculate (org-at-table-p)]
19655 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
19656 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
19657 "--"
19658 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
19659 "--"
19660 ["Sum Column/Rectangle" org-table-sum
19661 (or (org-at-table-p) (org-region-active-p))]
19662 ["Which Column?" org-table-current-column (org-at-table-p)])
19663 ["Debug Formulas"
19664 org-table-toggle-formula-debugger
19665 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
19666 ["Show Col/Row Numbers"
19667 org-table-toggle-coordinate-overlays
19668 :style toggle
19669 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
19670 "--"
19671 ["Create" org-table-create (and (not (org-at-table-p))
19672 org-enable-table-editor)]
19673 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
19674 ["Import from File" org-table-import (not (org-at-table-p))]
19675 ["Export to File" org-table-export (org-at-table-p)]
19676 "--"
19677 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
19679 (easy-menu-define org-org-menu org-mode-map "Org menu"
19680 '("Org"
19681 ("Show/Hide"
19682 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
19683 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
19684 ["Sparse Tree..." org-sparse-tree t]
19685 ["Reveal Context" org-reveal t]
19686 ["Show All" show-all t]
19687 "--"
19688 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
19689 "--"
19690 ["New Heading" org-insert-heading t]
19691 ("Navigate Headings"
19692 ["Up" outline-up-heading t]
19693 ["Next" outline-next-visible-heading t]
19694 ["Previous" outline-previous-visible-heading t]
19695 ["Next Same Level" outline-forward-same-level t]
19696 ["Previous Same Level" outline-backward-same-level t]
19697 "--"
19698 ["Jump" org-goto t])
19699 ("Edit Structure"
19700 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
19701 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
19702 "--"
19703 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
19704 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
19705 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19706 "--"
19707 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19708 "--"
19709 ["Copy visible text" org-copy-visible t]
19710 "--"
19711 ["Promote Heading" org-metaleft (not (org-at-table-p))]
19712 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
19713 ["Demote Heading" org-metaright (not (org-at-table-p))]
19714 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
19715 "--"
19716 ["Sort Region/Children" org-sort (not (org-at-table-p))]
19717 "--"
19718 ["Convert to odd levels" org-convert-to-odd-levels t]
19719 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19720 ("Editing"
19721 ["Emphasis..." org-emphasize t]
19722 ["Edit Source Example" org-edit-special t]
19723 "--"
19724 ["Footnote new/jump" org-footnote-action t]
19725 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19726 ("Archive"
19727 ["Archive (default method)" org-archive-subtree-default t]
19728 "--"
19729 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
19730 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
19731 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
19732 )
19733 "--"
19734 ("Hyperlinks"
19735 ["Store Link (Global)" org-store-link t]
19736 ["Find existing link to here" org-occur-link-in-agenda-files t]
19737 ["Insert Link" org-insert-link t]
19738 ["Follow Link" org-open-at-point t]
19739 "--"
19740 ["Next link" org-next-link t]
19741 ["Previous link" org-previous-link t]
19742 "--"
19743 ["Descriptive Links"
19744 org-toggle-link-display
19745 :style radio
19746 :selected org-descriptive-links
19747 ]
19748 ["Literal Links"
19749 org-toggle-link-display
19750 :style radio
19751 :selected (not org-descriptive-links)])
19752 "--"
19753 ("TODO Lists"
19754 ["TODO/DONE/-" org-todo t]
19755 ("Select keyword"
19756 ["Next keyword" org-shiftright (org-at-heading-p)]
19757 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19758 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19759 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19760 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19761 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19762 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19763 "--"
19764 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19765 :selected org-enforce-todo-dependencies :style toggle :active t]
19766 "Settings for tree at point"
19767 ["Do Children sequentially" org-toggle-ordered-property :style radio
19768 :selected (org-entry-get nil "ORDERED")
19769 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19770 ["Do Children parallel" org-toggle-ordered-property :style radio
19771 :selected (not (org-entry-get nil "ORDERED"))
19772 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19773 "--"
19774 ["Set Priority" org-priority t]
19775 ["Priority Up" org-shiftup t]
19776 ["Priority Down" org-shiftdown t]
19777 "--"
19778 ["Get news from all feeds" org-feed-update-all t]
19779 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19780 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19781 ("TAGS and Properties"
19782 ["Set Tags" org-set-tags-command t]
19783 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19784 "--"
19785 ["Set property" org-set-property t]
19786 ["Column view of properties" org-columns t]
19787 ["Insert Column View DBlock" org-insert-columns-dblock t])
19788 ("Dates and Scheduling"
19789 ["Timestamp" org-time-stamp t]
19790 ["Timestamp (inactive)" org-time-stamp-inactive t]
19791 ("Change Date"
19792 ["1 Day Later" org-shiftright t]
19793 ["1 Day Earlier" org-shiftleft t]
19794 ["1 ... Later" org-shiftup t]
19795 ["1 ... Earlier" org-shiftdown t])
19796 ["Compute Time Range" org-evaluate-time-range t]
19797 ["Schedule Item" org-schedule t]
19798 ["Deadline" org-deadline t]
19799 "--"
19800 ["Custom time format" org-toggle-time-stamp-overlays
19801 :style radio :selected org-display-custom-times]
19802 "--"
19803 ["Goto Calendar" org-goto-calendar t]
19804 ["Date from Calendar" org-date-from-calendar t]
19805 "--"
19806 ["Start/Restart Timer" org-timer-start t]
19807 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19808 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19809 ["Insert Timer String" org-timer t]
19810 ["Insert Timer Item" org-timer-item t])
19811 ("Logging work"
19812 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19813 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19814 ["Clock out" org-clock-out t]
19815 ["Clock cancel" org-clock-cancel t]
19816 "--"
19817 ["Mark as default task" org-clock-mark-default-task t]
19818 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19819 ["Goto running clock" org-clock-goto t]
19820 "--"
19821 ["Display times" org-clock-display t]
19822 ["Create clock table" org-clock-report t]
19823 "--"
19824 ["Record DONE time"
19825 (progn (setq org-log-done (not org-log-done))
19826 (message "Switching to %s will %s record a timestamp"
19827 (car org-done-keywords)
19828 (if org-log-done "automatically" "not")))
19829 :style toggle :selected org-log-done])
19830 "--"
19831 ["Agenda Command..." org-agenda t]
19832 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19833 ("File List for Agenda")
19834 ("Special views current file"
19835 ["TODO Tree" org-show-todo-tree t]
19836 ["Check Deadlines" org-check-deadlines t]
19837 ["Timeline" org-timeline t]
19838 ["Tags/Property tree" org-match-sparse-tree t])
19839 "--"
19840 ["Export/Publish..." org-export t]
19841 ("LaTeX"
19842 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19843 :selected org-cdlatex-mode]
19844 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19845 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19846 ["Modify math symbol" org-cdlatex-math-modify
19847 (org-inside-LaTeX-fragment-p)]
19848 ["Insert citation" org-reftex-citation t]
19849 "--"
19850 ["Template for BEAMER" (progn (require 'org-beamer)
19851 (org-insert-beamer-options-template)) t])
19852 "--"
19853 ("MobileOrg"
19854 ["Push Files and Views" org-mobile-push t]
19855 ["Get Captured and Flagged" org-mobile-pull t]
19856 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19857 "--"
19858 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19859 "--"
19860 ("Documentation"
19861 ["Show Version" org-version t]
19862 ["Info Documentation" org-info t])
19863 ("Customize"
19864 ["Browse Org Group" org-customize t]
19865 "--"
19866 ["Expand This Menu" org-create-customize-menu
19867 (fboundp 'customize-menu-create)])
19868 ["Send bug report" org-submit-bug-report t]
19869 "--"
19870 ("Refresh/Reload"
19871 ["Refresh setup current buffer" org-mode-restart t]
19872 ["Reload Org (after update)" org-reload t]
19873 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19874 ))
19876 (defun org-info (&optional node)
19877 "Read documentation for Org-mode in the info system.
19878 With optional NODE, go directly to that node."
19879 (interactive)
19880 (info (format "(org)%s" (or node ""))))
19882 ;;;###autoload
19883 (defun org-submit-bug-report ()
19884 "Submit a bug report on Org-mode via mail.
19886 Don't hesitate to report any problems or inaccurate documentation.
19888 If you don't have setup sending mail from (X)Emacs, please copy the
19889 output buffer into your mail program, as it gives us important
19890 information about your Org-mode version and configuration."
19891 (interactive)
19892 (require 'reporter)
19893 (org-load-modules-maybe)
19894 (org-require-autoloaded-modules)
19895 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19896 (reporter-submit-bug-report
19897 "emacs-orgmode@gnu.org"
19898 (org-version nil 'full)
19899 (let (list)
19900 (save-window-excursion
19901 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19902 (delete-other-windows)
19903 (erase-buffer)
19904 (insert "You are about to submit a bug report to the Org-mode mailing list.
19906 We would like to add your full Org-mode and Outline configuration to the
19907 bug report. This greatly simplifies the work of the maintainer and
19908 other experts on the mailing list.
19910 HOWEVER, some variables you have customized may contain private
19911 information. The names of customers, colleagues, or friends, might
19912 appear in the form of file names, tags, todo states, or search strings.
19913 If you answer yes to the prompt, you might want to check and remove
19914 such private information before sending the email.")
19915 (add-text-properties (point-min) (point-max) '(face org-warning))
19916 (when (yes-or-no-p "Include your Org-mode configuration ")
19917 (mapatoms
19918 (lambda (v)
19919 (and (boundp v)
19921 (or (and (symbol-value v)
19923 (and
19924 (get v 'custom-type) (get v 'standard-value)
19925 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19926 (push v list)))))
19927 (kill-buffer (get-buffer "*Warn about privacy*"))
19928 list))
19929 nil nil
19930 "Remember to cover the basics, that is, what you expected to happen and
19931 what in fact did happen. You don't know how to make a good report? See
19933 http://orgmode.org/manual/Feedback.html#Feedback
19935 Your bug report will be posted to the Org-mode mailing list.
19936 ------------------------------------------------------------------------")
19937 (save-excursion
19942 (defun org-install-agenda-files-menu ()
19943 (let ((bl (buffer-list)))
19944 (save-excursion
19945 (while bl
19946 (set-buffer (pop bl))
19947 (if (derived-mode-p 'org-mode) (setq bl nil)))
19948 (when (derived-mode-p 'org-mode)
19949 (easy-menu-change
19950 '("Org") "File List for Agenda"
19951 (append
19952 (list
19953 ["Edit File List" (org-edit-agenda-file-list) t]
19954 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19955 ["Remove Current File from List" org-remove-file t]
19956 ["Cycle through agenda files" org-cycle-agenda-files t]
19957 ["Occur in all agenda files" org-occur-in-agenda-files t]
19958 "--")
19959 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19961 ;;;; Documentation
19963 ;;;###autoload
19964 (defun org-require-autoloaded-modules ()
19965 (interactive)
19966 (mapc 'require
19967 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19968 org-docbook org-exp org-html org-icalendar
19969 org-id org-latex
19970 org-publish org-remember org-table
19971 org-timer org-xoxo)))
19973 ;;;###autoload
19974 (defun org-reload (&optional uncompiled)
19975 "Reload all org lisp files.
19976 With prefix arg UNCOMPILED, load the uncompiled versions."
19977 (interactive "P")
19978 (require 'find-func)
19980 (dir-org (file-name-directory (org-find-library-dir "org")))
19981 (dir-org-contrib (ignore-errors
19982 (file-name-directory
19983 (org-find-library-dir "org-contribdir"))))
19984 (babel-files
19985 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19986 (append (list nil "comint" "eval" "exp" "keys"
19987 "lob" "ref" "table" "tangle")
19988 (delq nil
19989 (mapcar
19990 (lambda (lang)
19991 (when (cdr lang) (symbol-name (car lang))))
19992 org-babel-load-languages)))))
19993 (files
19994 (append babel-files
19995 (and dir-org-contrib
19996 (directory-files dir-org-contrib t file-re))
19997 (directory-files dir-org t file-re)))
19998 (remove-re (concat (if (featurep 'xemacs)
19999 "org-colview" "org-colview-xemacs")
20001 (setq files (mapcar 'file-name-sans-extension files))
20002 (setq files (mapcar
20003 (lambda (x) (if (string-match remove-re x) nil x))
20004 files))
20005 (setq files (delq nil files))
20006 (mapc
20007 (lambda (f)
20008 (when (featurep (intern (file-name-nondirectory f)))
20009 (if (and (not uncompiled)
20010 (file-exists-p (concat f ".elc")))
20011 (load (concat f ".elc") nil nil 'nosuffix)
20012 (load (concat f ".el") nil nil 'nosuffix))))
20013 files)
20014 (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
20015 (org-version nil 'full 'message))
20017 ;;;###autoload
20018 (defun org-customize ()
20019 "Call the customize function with org as argument."
20020 (interactive)
20021 (org-load-modules-maybe)
20022 (org-require-autoloaded-modules)
20023 (customize-browse 'org))
20025 (defun org-create-customize-menu ()
20026 "Create a full customization menu for Org-mode, insert it into the menu."
20027 (interactive)
20028 (org-load-modules-maybe)
20029 (org-require-autoloaded-modules)
20030 (if (fboundp 'customize-menu-create)
20031 (progn
20032 (easy-menu-change
20033 '("Org") "Customize"
20034 `(["Browse Org group" org-customize t]
20035 "--"
20036 ,(customize-menu-create 'org)
20037 ["Set" Custom-set t]
20038 ["Save" Custom-save t]
20039 ["Reset to Current" Custom-reset-current t]
20040 ["Reset to Saved" Custom-reset-saved t]
20041 ["Reset to Standard Settings" Custom-reset-standard t]))
20043 (error "Cannot expand menu (outdated version of cus-edit.el)")))
20045 ;;;; Miscellaneous stuff
20047 ;;; Generally useful functions
20049 (defun org-get-at-bol (property)
20050 "Get text property PROPERTY at beginning of line."
20051 (get-text-property (point-at-bol) property))
20053 (defun org-find-text-property-in-string (prop s)
20054 "Return the first non-nil value of property PROP in string S."
20055 (or (get-text-property 0 prop s)
20056 (get-text-property (or (next-single-property-change 0 prop s) 0)
20057 prop s)))
20059 (defun org-display-warning (message) ;; Copied from Emacs-Muse
20060 "Display the given MESSAGE as a warning."
20061 (if (fboundp 'display-warning)
20062 (display-warning 'org message
20063 (if (featurep 'xemacs) 'warning :warning))
20064 (let ((buf (get-buffer-create "*Org warnings*")))
20065 (with-current-buffer buf
20066 (goto-char (point-max))
20067 (insert "Warning (Org): " message)
20068 (unless (bolp)
20069 (newline)))
20070 (display-buffer buf)
20071 (sit-for 0))))
20073 (defun org-eval (form)
20074 "Eval FORM and return result."
20075 (condition-case error
20076 (eval form)
20077 (error (format "%%![Error: %s]" error))))
20079 (defun org-in-clocktable-p ()
20080 "Check if the cursor is in a clocktable."
20081 (let ((pos (point)) start)
20082 (save-excursion
20083 (end-of-line 1)
20085 (setq start (match-beginning 0))
20087 (>= (match-end 0) pos)
20088 start))))
20090 (defun org-in-commented-line ()
20091 "Is point in a line starting with `#'?"
20092 (equal (char-after (point-at-bol)) ?#))
20094 (defun org-in-indented-comment-line ()
20095 "Is point in a line starting with `#' after some white space?"
20096 (save-excursion
20097 (save-match-data
20098 (goto-char (point-at-bol))
20101 (defun org-in-verbatim-emphasis ()
20102 (save-match-data
20103 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
20105 (defun org-goto-marker-or-bmk (marker &optional bookmark)
20106 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
20107 (if (and marker (marker-buffer marker)
20108 (buffer-live-p (marker-buffer marker)))
20109 (progn
20110 (org-pop-to-buffer-same-window (marker-buffer marker))
20111 (if (or (> marker (point-max)) (< marker (point-min)))
20112 (widen))
20113 (goto-char marker)
20114 (org-show-context 'org-goto))
20115 (if bookmark
20116 (bookmark-jump bookmark)
20117 (error "Cannot find location"))))
20119 (defun org-quote-csv-field (s)
20120 "Quote field for inclusion in CSV material."
20123 s))
20125 (defun org-force-self-insert (N)
20126 "Needed to enforce self-insert under remapping."
20127 (interactive "p")
20128 (self-insert-command N))
20130 (defun org-string-width (s)
20131 "Compute width of string, ignoring invisible characters.
20132 This ignores character with invisibility property `org-link', and also
20133 characters with property `org-cwidth', because these will become invisible
20134 upon the next fontification round."
20135 (let (b l)
20136 (when (or (eq t buffer-invisibility-spec)
20137 (assq 'org-link buffer-invisibility-spec))
20138 (while (setq b (text-property-any 0 (length s)
20139 'invisible 'org-link s))
20140 (setq s (concat (substring s 0 b)
20141 (substring s (or (next-single-property-change
20142 b 'invisible s) (length s)))))))
20143 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
20144 (setq s (concat (substring s 0 b)
20145 (substring s (or (next-single-property-change
20146 b 'org-cwidth s) (length s))))))
20147 (setq l (string-width s) b -1)
20148 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
20149 (setq l (- l (get-text-property b 'org-dwidth-n s))))
20150 l))
20152 (defun org-shorten-string (s maxlength)
20153 "Shorten string S so tht it is no longer than MAXLENGTH characters.
20154 If the string is shorter or has length MAXLENGTH, just return the
20155 original string. If it is longer, the functions finds a space in the
20156 string, breaks this string off at that locations and adds three dots
20157 as ellipsis. Including the ellipsis, the string will not be longer
20158 than MAXLENGTH. If finding a good breaking point in the string does
20159 not work, the string is just chopped off in the middle of a word
20160 if necessary."
20161 (if (<= (length s) maxlength)
20162 s
20163 (let* ((n (max (- maxlength 4) 1))
20165 (if (string-match re s)
20166 (concat (match-string 1 s) "...")
20167 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
20169 (defun org-get-indentation (&optional line)
20170 "Get the indentation of the current line, interpreting tabs.
20171 When LINE is given, assume it represents a line and compute its indentation."
20172 (if line
20173 (if (string-match "^ *" (org-remove-tabs line))
20174 (match-end 0))
20175 (save-excursion
20176 (beginning-of-line 1)
20178 (current-column))))
20180 (defun org-get-string-indentation (s)
20181 "What indentation has S due to SPACE and TAB at the beginning of the string?"
20182 (let ((n -1) (i 0) (w tab-width) c)
20183 (catch 'exit
20184 (while (< (setq n (1+ n)) (length s))
20185 (setq c (aref s n))
20186 (cond ((= c ?\ ) (setq i (1+ i)))
20188 (t (throw 'exit t)))))
20189 i))
20191 (defun org-remove-tabs (s &optional width)
20192 "Replace tabulators in S with spaces.
20193 Assumes that s is a single line, starting in column 0."
20194 (setq width (or width tab-width))
20196 (setq s (replace-match
20197 (make-string
20198 (- (* width (/ (+ (match-beginning 0) width) width))
20199 (match-beginning 0)) ?\ )
20200 t t s)))
20201 s)
20203 (defun org-fix-indentation (line ind)
20204 "Fix indentation in LINE.
20205 IND is a cons cell with target and minimum indentation.
20206 If the current indentation in LINE is smaller than the minimum,
20207 leave it alone. If it is larger than ind, set it to the target."
20208 (let* ((l (org-remove-tabs line))
20209 (i (org-get-indentation l))
20210 (i1 (car ind)) (i2 (cdr ind)))
20211 (if (>= i i2) (setq l (substring line i2)))
20212 (if (> i1 0)
20213 (concat (make-string i1 ?\ ) l)
20214 l)))
20216 (defun org-remove-indentation (code &optional n)
20217 "Remove the maximum common indentation from the lines in CODE.
20218 N may optionally be the number of spaces to remove."
20219 (with-temp-buffer
20220 (insert code)
20221 (org-do-remove-indentation n)
20222 (buffer-string)))
20224 (defun org-do-remove-indentation (&optional n)
20225 "Remove the maximum common indentation from the buffer."
20226 (untabify (point-min) (point-max))
20227 (let ((min 10000) re)
20228 (if n
20229 (setq min n)
20230 (goto-char (point-min))
20232 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
20233 (unless (or (= min 0) (= min 10000))
20235 (goto-char (point-min))
20236 (while (re-search-forward re nil t)
20237 (replace-match "")
20238 (end-of-line 1))
20239 min)))
20241 (defun org-fill-template (template alist)
20242 "Find each %key of ALIST in TEMPLATE and replace it."
20243 (let ((case-fold-search nil)
20244 entry key value)
20245 (setq alist (sort (copy-sequence alist)
20246 (lambda (a b) (< (length (car a)) (length (car b))))))
20247 (while (setq entry (pop alist))
20248 (setq template
20249 (replace-regexp-in-string
20250 (concat "%" (regexp-quote (car entry)))
20251 (or (cdr entry) "") template t t)))
20252 template))
20254 (defun org-base-buffer (buffer)
20255 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
20256 (if (not buffer)
20257 buffer
20258 (or (buffer-base-buffer buffer)
20259 buffer)))
20261 (defun org-trim (s)
20262 "Remove whitespace at beginning and end of string."
20265 s)
20267 (defun org-wrap (string &optional width lines)
20268 "Wrap string to either a number of lines, or a width in characters.
20269 If WIDTH is non-nil, the string is wrapped to that width, however many lines
20270 that costs. If there is a word longer than WIDTH, the text is actually
20271 wrapped to the length of that word.
20272 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
20273 many lines, whatever width that takes.
20274 The return value is a list of lines, without newlines at the end."
20276 (maxword (apply 'max (mapcar 'org-string-width words)))
20277 w ll)
20278 (cond (width
20279 (org-do-wrap words (max maxword width)))
20280 (lines
20281 (setq w maxword)
20282 (setq ll (org-do-wrap words maxword))
20283 (if (<= (length ll) lines)
20284 ll
20285 (setq ll words)
20286 (while (> (length ll) lines)
20287 (setq w (1+ w))
20288 (setq ll (org-do-wrap words w)))
20289 ll))
20290 (t (error "Cannot wrap this")))))
20292 (defun org-do-wrap (words width)
20293 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
20294 (let (lines line)
20295 (while words
20296 (setq line (pop words))
20297 (while (and words (< (+ (length line) (length (car words))) width))
20298 (setq line (concat line " " (pop words))))
20299 (setq lines (push line lines)))
20300 (nreverse lines)))
20302 (defun org-split-string (string &optional separators)
20303 "Splits STRING into substrings at SEPARATORS.
20304 No empty strings are returned if there are matches at the beginning
20305 and end of string."
20307 (start 0)
20308 notfirst
20309 (list nil))
20310 (while (and (string-match rexp string
20311 (if (and notfirst
20312 (= start (match-beginning 0))
20313 (< start (length string)))
20314 (1+ start) start))
20315 (< (match-beginning 0) (length string)))
20316 (setq notfirst t)
20317 (or (eq (match-beginning 0) 0)
20318 (and (eq (match-beginning 0) (match-end 0))
20319 (eq (match-beginning 0) start))
20320 (setq list
20321 (cons (substring string start (match-beginning 0))
20322 list)))
20323 (setq start (match-end 0)))
20324 (or (eq start (length string))
20325 (setq list
20326 (cons (substring string start)
20327 list)))
20328 (nreverse list)))
20330 (defun org-quote-vert (s)
20332 (while (string-match "|" s)
20334 s)
20336 (defun org-uuidgen-p (s)
20337 "Is S an ID created by UUIDGEN?"
20338 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
20340 (defun org-in-src-block-p nil
20341 "Whether point is in a code source block."
20342 (let (ov)
20343 (when (setq ov (overlays-at (point)))
20344 (memq 'org-block-background
20345 (overlay-properties
20346 (car ov))))))
20348 (defun org-context ()
20349 "Return a list of contexts of the current cursor position.
20350 If several contexts apply, all are returned.
20351 Each context entry is a list with a symbol naming the context, and
20352 two positions indicating start and end of the context. Possible
20353 contexts are:
20355 :headline anywhere in a headline
20356 :headline-stars on the leading stars in a headline
20357 :todo-keyword on a TODO keyword (including DONE) in a headline
20358 :tags on the TAGS in a headline
20359 :priority on the priority cookie in a headline
20360 :item on the first line of a plain list item
20361 :item-bullet on the bullet/number of a plain list item
20362 :checkbox on the checkbox in a plain list item
20363 :table in an org-mode table
20364 :table-special on a special filed in a table
20365 :table-table in a table.el table
20366 :clocktable in a clocktable
20367 :src-block in a source block
20368 :link on a hyperlink
20369 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
20370 :target on a <<target>>
20371 :radio-target on a <<<radio-target>>>
20372 :latex-fragment on a LaTeX fragment
20373 :latex-preview on a LaTeX fragment with overlaid preview image
20375 This function expects the position to be visible because it uses font-lock
20376 faces as a help to recognize the following contexts: :table-special, :link,
20377 and :keyword."
20378 (let* ((f (get-text-property (point) 'face))
20379 (faces (if (listp f) f (list f)))
20380 (case-fold-search t)
20381 (p (point)) clist o)
20382 ;; First the large context
20383 (cond
20384 ((org-at-heading-p t)
20385 (push (list :headline (point-at-bol) (point-at-eol)) clist)
20386 (when (progn
20387 (beginning-of-line 1)
20388 (looking-at org-todo-line-tags-regexp))
20389 (push (org-point-in-group p 1 :headline-stars) clist)
20390 (push (org-point-in-group p 2 :todo-keyword) clist)
20391 (push (org-point-in-group p 4 :tags) clist))
20392 (goto-char p)
20395 (push (org-point-in-group p 0 :priority) clist)))
20397 ((org-at-item-p)
20398 (push (org-point-in-group p 2 :item-bullet) clist)
20399 (push (list :item (point-at-bol)
20400 (save-excursion (org-end-of-item) (point)))
20401 clist)
20402 (and (org-at-item-checkbox-p)
20403 (push (org-point-in-group p 0 :checkbox) clist)))
20405 ((org-at-table-p)
20406 (push (list :table (org-table-begin) (org-table-end)) clist)
20407 (if (memq 'org-formula faces)
20408 (push (list :table-special
20409 (previous-single-property-change p 'face)
20410 (next-single-property-change p 'face)) clist)))
20411 ((org-at-table-p 'any)
20412 (push (list :table-table) clist)))
20413 (goto-char p)
20415 (let ((case-fold-search t))
20416 ;; New the "medium" contexts: clocktables, source blocks
20417 (cond ((org-in-clocktable-p)
20418 (push (list :clocktable
20420 (search-backward "#+BEGIN: clocktable" nil t))
20421 (match-beginning 0))
20423 (match-end 0))) clist))
20424 ((org-in-src-block-p)
20425 (push (list :src-block
20427 (search-backward "#+BEGIN_SRC" nil t))
20428 (match-beginning 0))
20429 (and (search-forward "#+END_SRC" nil t)
20430 (match-beginning 0))) clist))))
20431 (goto-char p)
20433 ;; Now the small context
20434 (cond
20435 ((org-at-timestamp-p)
20436 (push (org-point-in-group p 0 :timestamp) clist))
20437 ((memq 'org-link faces)
20438 (push (list :link
20439 (previous-single-property-change p 'face)
20440 (next-single-property-change p 'face)) clist))
20441 ((memq 'org-special-keyword faces)
20442 (push (list :keyword
20443 (previous-single-property-change p 'face)
20444 (next-single-property-change p 'face)) clist))
20445 ((org-at-target-p)
20446 (push (org-point-in-group p 0 :target) clist)
20447 (goto-char (1- (match-beginning 0)))
20448 (if (looking-at org-radio-target-regexp)
20449 (push (org-point-in-group p 0 :radio-target) clist))
20450 (goto-char p))
20451 ((setq o (car (delq nil
20452 (mapcar
20453 (lambda (x)
20454 (if (memq x org-latex-fragment-image-overlays) x))
20455 (overlays-at (point))))))
20456 (push (list :latex-fragment
20457 (overlay-start o) (overlay-end o)) clist)
20458 (push (list :latex-preview
20459 (overlay-start o) (overlay-end o)) clist))
20460 ((org-inside-LaTeX-fragment-p)
20461 ;; FIXME: positions wrong.
20462 (push (list :latex-fragment (point) (point)) clist)))
20464 (setq clist (nreverse (delq nil clist)))
20465 clist))
20467 ;; FIXME: Compare with at-regexp-p Do we need both?
20468 (defun org-in-regexp (re &optional nlines visually)
20469 "Check if point is inside a match of regexp.
20470 Normally only the current line is checked, but you can include NLINES extra
20471 lines both before and after point into the search.
20472 If VISUALLY is set, require that the cursor is not after the match but
20473 really on, so that the block visually is on the match."
20474 (catch 'exit
20475 (let ((pos (point))
20476 (eol (point-at-eol (+ 1 (or nlines 0))))
20477 (inc (if visually 1 0)))
20478 (save-excursion
20479 (beginning-of-line (- 1 (or nlines 0)))
20480 (while (re-search-forward re eol t)
20481 (if (and (<= (match-beginning 0) pos)
20482 (>= (+ inc (match-end 0)) pos))
20483 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
20485 (defun org-at-regexp-p (regexp)
20486 "Is point inside a match of REGEXP in the current line?"
20487 (catch 'exit
20488 (save-excursion
20489 (let ((pos (point)) (end (point-at-eol)))
20490 (beginning-of-line 1)
20491 (while (re-search-forward regexp end t)
20492 (if (and (<= (match-beginning 0) pos)
20493 (>= (match-end 0) pos))
20494 (throw 'exit t)))
20495 nil))))
20497 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
20498 "Non-nil when point is between matches of START-RE and END-RE.
20500 Also return a non-nil value when point is on one of the matches.
20502 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
20503 buffer positions. Default values are the positions of headlines
20504 surrounding the point.
20506 The functions returns a cons cell whose car (resp. cdr) is the
20507 position before START-RE (resp. after END-RE)."
20508 (save-match-data
20509 (let ((pos (point))
20510 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
20511 (limit-down (or lim-down (save-excursion (outline-next-heading))))
20512 beg end)
20513 (save-excursion
20514 ;; Point is on a block when on START-RE or if START-RE can be
20515 ;; found before it...
20516 (and (or (org-at-regexp-p start-re)
20517 (re-search-backward start-re limit-up t))
20518 (setq beg (match-beginning 0))
20519 ;; ... and END-RE after it...
20520 (goto-char (match-end 0))
20521 (re-search-forward end-re limit-down t)
20522 (> (setq end (match-end 0)) pos)
20523 ;; ... without another START-RE in-between.
20524 (goto-char (match-beginning 0))
20525 (not (re-search-backward start-re (1+ beg) t))
20526 ;; Return value.
20527 (cons beg end))))))
20529 (defun org-in-block-p (names)
20530 "Non-nil when point belongs to a block whose name belongs to NAMES.
20532 NAMES is a list of strings containing names of blocks.
20534 Return first block name matched, or nil. Beware that in case of
20535 nested blocks, the returned name may not belong to the closest
20536 block from point."
20537 (save-match-data
20538 (catch 'exit
20539 (let ((case-fold-search t)
20540 (lim-up (save-excursion (outline-previous-heading)))
20541 (lim-down (save-excursion (outline-next-heading))))
20542 (mapc (lambda (name)
20543 (let ((n (regexp-quote name)))
20544 (when (org-between-regexps-p
20547 lim-up lim-down)
20548 (throw 'exit n))))
20549 names))
20550 nil)))
20552 (defun org-occur-in-agenda-files (regexp &optional nlines)
20553 "Call `multi-occur' with buffers for all agenda files."
20555 (let* ((files (org-agenda-files))
20556 (tnames (mapcar 'file-truename files))
20557 (extra org-agenda-text-search-extra-files)
20558 f)
20559 (when (eq (car extra) 'agenda-archives)
20560 (setq extra (cdr extra))
20561 (setq files (org-add-archive-files files)))
20562 (while (setq f (pop extra))
20563 (unless (member (file-truename f) tnames)
20564 (add-to-list 'files f 'append)
20565 (add-to-list 'tnames (file-truename f) 'append)))
20566 (multi-occur
20567 (mapcar (lambda (x)
20568 (with-current-buffer
20569 (or (get-file-buffer x) (find-file-noselect x))
20570 (widen)
20571 (current-buffer)))
20572 files)
20573 regexp)))
20575 (if (boundp 'occur-mode-find-occurrence-hook)
20576 ;; Emacs 23
20577 (add-hook 'occur-mode-find-occurrence-hook
20578 (lambda ()
20579 (when (derived-mode-p 'org-mode)
20580 (org-reveal))))
20581 ;; Emacs 22
20582 (defadvice occur-mode-goto-occurrence
20583 (after org-occur-reveal activate)
20584 (and (derived-mode-p 'org-mode) (org-reveal)))
20585 (defadvice occur-mode-goto-occurrence-other-window
20586 (after org-occur-reveal activate)
20587 (and (derived-mode-p 'org-mode) (org-reveal)))
20588 (defadvice occur-mode-display-occurrence
20589 (after org-occur-reveal activate)
20590 (when (derived-mode-p 'org-mode)
20591 (let ((pos (occur-mode-find-occurrence)))
20592 (with-current-buffer (marker-buffer pos)
20593 (save-excursion
20594 (goto-char pos)
20595 (org-reveal)))))))
20597 (defun org-occur-link-in-agenda-files ()
20598 "Create a link and search for it in the agendas.
20599 The link is not stored in `org-stored-links', it is just created
20600 for the search purpose."
20601 (interactive)
20602 (let ((link (condition-case nil
20603 (org-store-link nil)
20604 (error "Unable to create a link to here"))))
20605 (org-occur-in-agenda-files (regexp-quote link))))
20607 (defun org-uniquify (list)
20608 "Remove duplicate elements from LIST."
20609 (let (res)
20610 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
20611 res))
20613 (defun org-delete-all (elts list)
20614 "Remove all elements in ELTS from LIST."
20615 (while elts
20616 (setq list (delete (pop elts) list)))
20617 list)
20619 (defun org-count (cl-item cl-seq)
20620 "Count the number of occurrences of ITEM in SEQ.
20621 Taken from `count' in cl-seq.el with all keyword arguments removed."
20622 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
20623 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
20624 (while (< cl-start cl-end)
20625 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
20626 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
20627 (setq cl-start (1+ cl-start)))
20628 cl-count))
20630 (defun org-remove-if (predicate seq)
20631 "Remove everything from SEQ that fulfills PREDICATE."
20632 (let (res e)
20633 (while seq
20634 (setq e (pop seq))
20635 (if (not (funcall predicate e)) (push e res)))
20636 (nreverse res)))
20638 (defun org-remove-if-not (predicate seq)
20639 "Remove everything from SEQ that does not fulfill PREDICATE."
20640 (let (res e)
20641 (while seq
20642 (setq e (pop seq))
20643 (if (funcall predicate e) (push e res)))
20644 (nreverse res)))
20646 (defun org-reduce (cl-func cl-seq &rest cl-keys)
20647 "Reduce two-argument FUNCTION across SEQ.
20648 Taken from `reduce' in cl-seq.el with all keyword arguments but
20650 (let ((cl-accum (cond ((memq :initial-value cl-keys)
20651 (cadr (memq :initial-value cl-keys)))
20652 (cl-seq (pop cl-seq))
20653 (t (funcall cl-func)))))
20654 (while cl-seq
20655 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
20656 cl-accum))
20658 (defun org-back-over-empty-lines ()
20659 "Move backwards over whitespace, to the beginning of the first empty line.
20660 Returns the number of empty lines passed."
20661 (let ((pos (point)))
20662 (if (cdr (assoc 'heading org-blank-before-new-entry))
20664 (unless (eobp)
20665 (forward-line -1)))
20666 (beginning-of-line 2)
20667 (goto-char (min (point) pos))
20668 (count-lines (point) pos)))
20670 (defun org-skip-whitespace ()
20673 (defun org-point-in-group (point group &optional context)
20674 "Check if POINT is in match-group GROUP.
20675 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
20676 match. If the match group does not exist or point is not inside it,
20677 return nil."
20678 (and (match-beginning group)
20679 (>= point (match-beginning group))
20680 (<= point (match-end group))
20681 (if context
20682 (list context (match-beginning group) (match-end group))
20683 t)))
20685 (defun org-switch-to-buffer-other-window (&rest args)
20686 "Switch to buffer in a second window on the current frame.
20687 In particular, do not allow pop-up frames.
20688 Returns the newly created buffer."
20689 (let (pop-up-frames special-display-buffer-names special-display-regexps
20690 special-display-function)
20691 (apply 'switch-to-buffer-other-window args)))
20693 (defun org-combine-plists (&rest plists)
20694 "Create a single property list from all plists in PLISTS.
20695 The process starts by copying the first list, and then setting properties
20696 from the other lists. Settings in the last list are the most significant
20697 ones and overrule settings in the other lists."
20698 (let ((rtn (copy-sequence (pop plists)))
20699 p v ls)
20700 (while plists
20701 (setq ls (pop plists))
20702 (while ls
20703 (setq p (pop ls) v (pop ls))
20704 (setq rtn (plist-put rtn p v))))
20705 rtn))
20707 (defun org-replace-escapes (string table)
20708 "Replace %-escapes in STRING with values in TABLE.
20710 The sequences in STRING may contain normal field width and padding information,
20712 so values can contain further %-escapes if they are define later in TABLE."
20713 (let ((tbl (copy-alist table))
20714 (case-fold-search nil)
20715 (pchg 0)
20716 e re rpl)
20717 (while (setq e (pop tbl))
20718 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20719 (when (and (cdr e) (string-match re (cdr e)))
20720 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20721 (safe "SREF"))
20722 (add-text-properties 0 3 (list 'sref sref) safe)
20723 (setcdr e (replace-match safe t t (cdr e)))))
20724 (while (string-match re string)
20725 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20726 (cdr e)))
20727 (setq string (replace-match rpl t t string))))
20728 (while (setq pchg (next-property-change pchg string))
20729 (let ((sref (get-text-property pchg 'sref string)))
20730 (when (and sref (string-match "SREF" string pchg))
20731 (setq string (replace-match sref t t string)))))
20732 string))
20734 (defun org-sublist (list start end)
20735 "Return a section of LIST, from START to END.
20736 Counting starts at 1."
20737 (let (rtn (c start))
20738 (setq list (nthcdr (1- start) list))
20739 (while (and list (<= c end))
20740 (push (pop list) rtn)
20741 (setq c (1+ c)))
20742 (nreverse rtn)))
20744 (defun org-find-base-buffer-visiting (file)
20745 "Like `find-buffer-visiting' but always return the base buffer and
20746 not an indirect buffer."
20747 (let ((buf (or (get-file-buffer file)
20748 (find-buffer-visiting file))))
20749 (if buf
20750 (or (buffer-base-buffer buf) buf)
20751 nil)))
20753 (defun org-image-file-name-regexp (&optional extensions)
20754 "Return regexp matching the file names of images.
20755 If EXTENSIONS is given, only match these."
20756 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20757 (image-file-name-regexp)
20758 (let ((image-file-name-extensions
20759 (or extensions
20760 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20761 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20763 (regexp-opt (nconc (mapcar 'upcase
20764 image-file-name-extensions)
20765 image-file-name-extensions)
20766 t)
20769 (defun org-file-image-p (file &optional extensions)
20770 "Return non-nil if FILE is an image."
20771 (save-match-data
20772 (string-match (org-image-file-name-regexp extensions) file)))
20774 (defun org-get-cursor-date ()
20775 "Return the date at cursor in as a time.
20776 This works in the calendar and in the agenda, anywhere else it just
20777 returns the current time."
20778 (let (date day defd)
20779 (cond
20780 ((eq major-mode 'calendar-mode)
20781 (setq date (calendar-cursor-to-date)
20782 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20783 ((eq major-mode 'org-agenda-mode)
20784 (setq day (get-text-property (point) 'day))
20785 (if day
20786 (setq date (calendar-gregorian-from-absolute day)
20787 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20788 (nth 2 date))))))
20789 (or defd (current-time))))
20791 (defvar org-agenda-action-marker (make-marker)
20792 "Marker pointing to the entry for the next agenda action.")
20794 (defun org-mark-entry-for-agenda-action ()
20795 "Mark the current entry as target of an agenda action.
20796 Agenda actions are actions executed from the agenda with the key `k',
20797 which make use of the date at the cursor."
20798 (interactive)
20799 (move-marker org-agenda-action-marker
20800 (save-excursion (org-back-to-heading t) (point))
20801 (current-buffer))
20802 (message
20803 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20805 (defun org-mark-subtree (&optional up)
20806 "Mark the current subtree.
20807 This puts point at the start of the current subtree, and mark at
20808 the end. If a numeric prefix UP is given, move up into the
20809 hierarchy of headlines by UP levels before marking the subtree."
20810 (interactive "P")
20811 (org-with-limited-levels
20812 (cond ((org-at-heading-p) (beginning-of-line))
20813 ((org-before-first-heading-p) (error "Not in a subtree"))
20814 (t (outline-previous-visible-heading 1))))
20815 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
20816 (if (org-called-interactively-p 'any)
20817 (call-interactively 'org-mark-element)
20818 (org-mark-element)))
20820 ;;; Indentation
20822 (defun org-indent-line ()
20823 "Indent line depending on context."
20824 (interactive)
20825 (let* ((pos (point))
20826 (itemp (org-at-item-p))
20827 (case-fold-search t)
20829 (inline-task-p (and (featurep 'org-inlinetask)
20830 (org-inlinetask-in-task-p)))
20831 (inline-re (and inline-task-p
20832 (org-inlinetask-outline-regexp)))
20833 column)
20834 (if (and orgstruct-is-++ (eq pos (point)))
20835 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
20836 (indent-according-to-mode))
20837 (beginning-of-line 1)
20838 (cond
20839 ;; Headings
20840 ((looking-at org-outline-regexp) (setq column 0))
20841 ;; Included files
20843 ;; Footnote definition
20844 ((looking-at org-footnote-definition-re) (setq column 0))
20845 ;; Literal examples
20847 (setq column (org-get-indentation))) ; do nothing
20848 ;; Lists
20849 ((ignore-errors (goto-char (org-in-item-p)))
20850 (setq column (if itemp
20851 (org-get-indentation)
20852 (org-list-item-body-column (point))))
20853 (goto-char pos))
20854 ;; Drawers
20856 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20857 (save-excursion
20858 (goto-char (1- (match-beginning 1)))
20859 (setq column (current-column))))
20860 ;; Special blocks
20862 (save-excursion
20863 (re-search-backward
20865 (setq column (org-get-indentation (match-string 0))))
20868 (save-excursion
20870 (setq column
20871 (cond ((equal (downcase (match-string 1)) "src")
20872 ;; src blocks: let `org-edit-src-exit' handle them
20873 (org-get-indentation))
20874 ((equal (downcase (match-string 1)) "example")
20875 (max (org-get-indentation)
20876 (org-get-indentation (match-string 0))))
20877 (t
20878 (org-get-indentation (match-string 0))))))
20879 ;; This line has nothing special, look at the previous relevant
20880 ;; line to compute indentation
20881 (t
20882 (beginning-of-line 0)
20883 (while (and (not (bobp))
20884 (not (looking-at org-drawer-regexp))
20885 ;; When point started in an inline task, do not move
20886 ;; above task starting line.
20887 (not (and inline-task-p (looking-at inline-re)))
20888 ;; Skip drawers, blocks, empty lines, verbatim,
20889 ;; comments, tables, footnotes definitions, lists,
20890 ;; inline tasks.
20892 (re-search-backward org-drawer-regexp nil t))
20896 (looking-at org-footnote-definition-re)
20897 (and (ignore-errors (goto-char (org-in-item-p)))
20898 (goto-char
20899 (org-list-get-top-point (org-list-struct))))
20900 (and (not inline-task-p)
20901 (featurep 'org-inlinetask)
20902 (org-inlinetask-in-task-p)
20903 (or (org-inlinetask-goto-beginning) t))))
20904 (beginning-of-line 0))
20905 (cond
20906 ;; There was an heading above.
20908 (if (not org-adapt-indentation)
20909 (setq column 0)
20910 (goto-char (match-end 0))
20911 (setq column (current-column))))
20912 ;; A drawer had started and is unfinished
20913 ((looking-at org-drawer-regexp)
20914 (goto-char (1- (match-beginning 1)))
20915 (setq column (current-column)))
20916 ;; Else, nothing noticeable found: get indentation and go on.
20917 (t (setq column (org-get-indentation))))))
20918 ;; Now apply indentation and move cursor accordingly
20919 (goto-char pos)
20920 (if (<= (current-column) (current-indentation))
20921 (org-indent-line-to column)
20922 (save-excursion (org-indent-line-to column)))
20923 ;; Special polishing for properties, see `org-property-format'
20924 (setq column (current-column))
20925 (beginning-of-line 1)
20926 (if (looking-at
20928 (replace-match (concat (match-string 1)
20929 (format org-property-format
20930 (match-string 2) (match-string 3)))
20931 t t))
20932 (org-move-to-column column))))
20934 (defun org-indent-drawer ()
20935 "Indent the drawer at point."
20936 (interactive)
20937 (let ((p (point))
20938 (e (and (save-excursion (re-search-forward ":END:" nil t))
20939 (match-end 0)))
20940 (folded
20941 (save-excursion
20942 (end-of-line)
20943 (when (overlays-at (point))
20944 (member 'invisible (overlay-properties
20945 (car (overlays-at (point)))))))))
20946 (when folded (org-cycle))
20947 (indent-for-tab-command)
20948 (while (and (move-beginning-of-line 2) (< (point) e))
20949 (indent-for-tab-command))
20950 (goto-char p)
20951 (when folded (org-cycle)))
20952 (message "Drawer at point indented"))
20954 (defun org-indent-block ()
20955 "Indent the block at point."
20956 (interactive)
20957 (let ((p (point))
20958 (case-fold-search t)
20960 (match-end 0)))
20961 (folded
20962 (save-excursion
20963 (end-of-line)
20964 (when (overlays-at (point))
20965 (member 'invisible (overlay-properties
20966 (car (overlays-at (point)))))))))
20967 (when folded (org-cycle))
20968 (indent-for-tab-command)
20969 (while (and (move-beginning-of-line 2) (< (point) e))
20970 (indent-for-tab-command))
20971 (goto-char p)
20972 (when folded (org-cycle)))
20973 (message "Block at point indented"))
20975 (defun org-indent-region (start end)
20976 "Indent region."
20977 (interactive "r")
20978 (save-excursion
20979 (let ((line-end (org-current-line end)))
20980 (goto-char start)
20981 (while (< (org-current-line) line-end)
20982 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
20983 (t (call-interactively 'org-indent-line)))
20984 (move-beginning-of-line 2)))))
20987 ;;; Filling
20989 ;; We use our own fill-paragraph and auto-fill functions. These
20990 ;; functions will shadow `fill-prefix' (computed internally with
20991 ;; `org-fill-context-prefix') and pass through to
20992 ;; `fill-region-as-paragraph' and `do-auto-fill' as appropriate.
20994 (defun org-set-autofill-regexps ()
20995 (interactive)
20996 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20997 ;; Prevent auto-fill from inserting unwanted new items.
20998 (when (boundp 'fill-nobreak-predicate)
20999 (org-set-local
21000 'fill-nobreak-predicate
21001 (org-uniquify
21002 (append fill-nobreak-predicate
21003 '(org-fill-paragraph-separate-nobreak-p
21004 org-fill-line-break-nobreak-p)))))
21005 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
21006 (org-set-local 'align-mode-rules-list
21007 '((org-in-buffer-settings
21009 (modes . '(org-mode))))))
21011 (defun org-fill-paragraph-separate-nobreak-p ()
21012 "Non-nil when a line break at point would insert a new item."
21013 (looking-at (substring org-element-paragraph-separate 1)))
21015 (defun org-fill-line-break-nobreak-p ()
21016 "Non-nil when a line break at point would create an Org line break."
21017 (save-excursion
21022 (declare-function message-in-body-p "message" ())
21023 (defvar org-element--affiliated-re) ; From org-element.el
21024 (defun org-fill-context-prefix (p)
21025 "Compute a fill prefix for the line at point P.
21026 Return fill prefix, as a string, or nil if current line isn't
21027 meant to be filled."
21028 (org-with-wide-buffer
21029 (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
21030 ;; FIXME: This is really the job of orgstruct++-mode
21031 (goto-char p)
21032 (beginning-of-line)
21033 (let* ((element (org-element-at-point))
21034 (type (org-element-type element))
21035 (post-affiliated
21036 (progn
21037 (goto-char (org-element-property :begin element))
21038 (while (looking-at org-element--affiliated-re) (forward-line))
21039 (point))))
21040 (unless (< p post-affiliated)
21041 (case type
21043 (footnote-definition "")
21044 ((item plain-list)
21045 (make-string (org-list-item-body-column
21046 (org-element-property :begin element))
21047 ? ))
21048 (paragraph
21049 ;; Fill prefix is usually the same as the current line,
21050 ;; except if the paragraph is at the beginning of an item.
21051 (let ((parent (org-element-property :parent element)))
21052 (cond ((eq (org-element-type parent) 'item)
21053 (make-string (org-list-item-body-column
21054 (org-element-property :begin parent))
21055 ? ))
21057 (t ""))))
21058 (comment-block
21059 ;; Only fill contents if P is within block boundaries.
21060 (let* ((cbeg (save-excursion (goto-char post-affiliated)
21061 (forward-line)
21062 (point)))
21063 (cend (save-excursion
21064 (goto-char (org-element-property :end element))
21066 (line-beginning-position))))
21067 (when (and (>= p cbeg) (< p cend))
21070 (declare-function message-goto-body "message" ())
21071 (defvar message-cite-prefix-regexp) ; From message.el
21072 (defvar org-element-all-objects) ; From org-element.el
21073 (defun org-fill-paragraph (&optional justify)
21074 "Fill element at point, when applicable.
21076 This function only applies to comment blocks, comments, example
21077 blocks and paragraphs. Also, as a special case, re-align table
21078 when point is at one.
21080 If JUSTIFY is non-nil (interactively, with prefix argument),
21081 justify as well. If `sentence-end-double-space' is non-nil, then
21082 period followed by one space does not end a sentence, so don't
21083 break a line there. The variable `fill-column' controls the
21084 width for filling.
21086 For convenience, when point is at a plain list, an item or
21087 a footnote definition, try to fill the first paragraph within."
21088 ;; Falls back on message-fill-paragraph when necessary
21089 (interactive)
21090 (if (and (derived-mode-p 'message-mode)
21091 (or (not (message-in-body-p))
21092 (save-excursion (move-beginning-of-line 1)
21093 (looking-at message-cite-prefix-regexp))))
21094 (let ((fill-paragraph-function
21095 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
21096 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
21097 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
21098 (paragraph-separate
21099 (cadadr (assoc 'paragraph-separate org-fb-vars))))
21100 (fill-paragraph))
21101 (save-excursion
21102 ;; Move to end of line in order to get the first paragraph within
21103 ;; a plain list or a footnote definition.
21104 (end-of-line)
21105 (let ((element (org-element-at-point)))
21106 ;; First check if point is in a blank line at the beginning of the
21107 ;; buffer. In that case, ignore filling.
21108 (if (< (point) (org-element-property :begin element)) t
21109 (case (org-element-type element)
21110 ;; Align Org tables, leave table.el tables as-is.
21111 (table-row (org-table-align) t)
21112 (table
21113 (when (eq (org-element-property :type element) 'org)
21114 (org-table-align))
21115 t)
21116 ;; Elements that may contain `line-break' type objects.
21117 (paragraph
21118 (let ((beg (max (point-min)
21119 (org-element-property :contents-begin element)))
21120 (end (min (point-max)
21121 (org-element-property :contents-end element)))
21122 (type (org-element-type element)))
21123 ;; Do nothing if point is at an affiliated keyword.
21124 (if (< (point) beg) t
21125 (when (derived-mode-p 'message-mode)
21126 ;; In `message-mode', do not fill following
21127 ;; citation in current paragraph nor text before
21128 ;; message body.
21129 (let ((body-start (save-excursion (message-goto-body))))
21130 (when body-start (setq beg (max body-start beg))))
21131 (when (save-excursion
21132 (re-search-forward
21133 (concat "^" message-cite-prefix-regexp) end t))
21134 (setq end (match-beginning 0))))
21135 ;; Fill paragraph, taking line breaks into consideration.
21136 ;; For that, slice the paragraph using line breaks as
21137 ;; separators, and fill the parts in reverse order to
21138 ;; avoid messing with markers.
21139 (save-excursion
21140 (goto-char end)
21141 (mapc
21142 (lambda (pos)
21143 (let ((fill-prefix (org-fill-context-prefix pos)))
21144 (fill-region-as-paragraph pos (point) justify))
21145 (goto-char pos))
21146 ;; Find the list of ending positions for line breaks
21147 ;; in the current paragraph. Add paragraph beginning
21148 ;; to include first slice.
21149 (nreverse
21150 (cons
21151 beg
21152 (org-element-map
21153 (org-element--parse-objects
21154 beg end nil org-element-all-objects)
21155 'line-break
21156 (lambda (lb) (org-element-property :end lb)))))))
21157 t)))
21158 ;; Contents of `comment-block' type elements should be filled as
21159 ;; plain text.
21160 (comment-block
21161 (let ((fill-prefix (org-fill-context-prefix (point))))
21162 (save-excursion
21163 (fill-region-as-paragraph
21164 (progn
21165 (goto-char (org-element-property :begin element))
21166 (while (looking-at org-element--affiliated-re)
21167 (forward-line))
21168 (forward-line)
21169 (point))
21170 (progn
21171 (goto-char (org-element-property :end element))
21173 (line-beginning-position))
21174 justify))) t)
21175 ;; Fill comments, indented or not.
21176 (comment
21177 (let ((fill-prefix (org-fill-context-prefix (point))))
21178 (save-excursion
21179 (fill-region-as-paragraph
21180 (progn
21181 (goto-char (org-element-property :begin element))
21182 (while (looking-at org-element--affiliated-re)
21183 (forward-line))
21184 (point))
21185 (progn
21186 (goto-char (org-element-property :end element))
21188 (line-end-position))))))
21189 ;; Ignore every other element.
21190 (otherwise t)))))))
21192 (defun org-auto-fill-function ()
21193 "Auto-fill function."
21194 ;; Check if auto-filling is meaningful before computing fill prefix.
21195 (let ((fc (current-fill-column)))
21196 (when (and fc (> (current-column) fc))
21197 (let ((fill-prefix (org-fill-context-prefix (point))))
21198 (when fill-prefix (do-auto-fill))))))
21201 ;;; Comments
21203 ;; Since difference between comments and keywords is subtle, we cannot
21204 ;; trust `comment-only-p' when applying `comment-dwim'. Hence, both
21205 ;; `comment-region-function' and `uncomment-region-function' point to
21206 ;; `org-comment-or-uncomment-region', which can tell when region only
21207 ;; contains comments or not.
21209 (defun org-insert-comment ()
21210 "Insert an empty comment above current line.
21211 If the line is empty, insert comment at its beginning."
21212 (beginning-of-line)
21214 (org-indent-line)
21215 (insert "# "))
21217 (defun org-comment-or-uncomment-region (beg end &rest ignore)
21218 "Comment or uncomment each non-blank line in the region.
21219 Uncomment each non-blank line between BEG and END if it only
21220 contains commented lines. Otherwise, comment them."
21221 (save-excursion
21222 (goto-char beg)
21224 (beginning-of-line)
21225 (let ((uncommentp
21226 ;; UNCOMMENTP is non-nil when every non blank line between
21227 ;; BEG and END is a comment.
21228 (save-excursion
21229 (while (progn (and (not (eobp))
21230 (let ((element (org-element-at-point)))
21231 (and (eq (org-element-type element) 'comment)
21232 (goto-char (org-element-property
21233 :end element)))))))
21234 (>= (point) end)))
21235 ;; Remove or adding comment markers is going to change end
21236 ;; position so make it a marker.
21237 (end (copy-marker end)))
21238 (while (< (point) end)
21240 (if (not uncommentp) (progn (back-to-indentation) (insert "# "))
21241 ;; Only comments and blank lines in region: uncomment it.
21243 (replace-match "" nil nil nil 1)))
21244 (forward-line))
21245 (set-marker end nil))))
21248 ;;; Other stuff.
21250 (defun org-toggle-fixed-width-section (arg)
21251 "Toggle the fixed-width export.
21252 If there is no active region, the QUOTE keyword at the current headline is
21253 inserted or removed. When present, it causes the text between this headline
21254 and the next to be exported as fixed-width text, and unmodified.
21255 If there is an active region, this command adds or removes a colon as the
21256 first character of this line. If the first character of a line is a colon,
21257 this line is also exported in fixed-width font."
21258 (interactive "P")
21259 (let* ((cc 0)
21260 (regionp (org-region-active-p))
21261 (beg (if regionp (region-beginning) (point)))
21262 (end (if regionp (region-end)))
21263 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
21264 (case-fold-search nil)
21266 off)
21267 (if regionp
21268 (save-excursion
21269 (goto-char beg)
21270 (setq cc (current-column))
21271 (beginning-of-line 1)
21272 (setq off (looking-at re))
21273 (while (> nlines 0)
21274 (setq nlines (1- nlines))
21275 (beginning-of-line 1)
21276 (cond
21277 (arg
21278 (org-move-to-column cc t)
21280 (forward-line -1))
21281 ((and off (looking-at re))
21282 (replace-match "" t t nil 1))
21283 ((not off) (org-move-to-column cc t) (insert ": ")))
21284 (forward-line 1)))
21285 (save-excursion
21286 (org-back-to-heading)
21287 (cond
21288 ((looking-at (format org-heading-keyword-regexp-format
21289 org-quote-string))
21290 (goto-char (match-end 1))
21291 (looking-at (concat " +" org-quote-string))
21292 (replace-match "" t t)
21293 (when (eolp) (insert " ")))
21294 ((looking-at org-outline-regexp)
21295 (goto-char (match-end 0))
21296 (insert org-quote-string " ")))))))
21298 (defun org-reftex-citation ()
21299 "Use reftex-citation to insert a citation into the buffer.
21300 This looks for a line like
21302 #+BIBLIOGRAPHY: foo plain option:-d
21304 and derives from it that foo.bib is the bibliography file relevant
21305 for this document. It then installs the necessary environment for RefTeX
21306 to work in this buffer and calls `reftex-citation' to insert a citation
21307 into the buffer.
21309 Export of such citations to both LaTeX and HTML is handled by the contributed
21310 package org-exp-bibtex by Taru Karttunen."
21311 (interactive)
21312 (let ((reftex-docstruct-symbol 'rds)
21314 rds bib)
21315 (save-excursion
21316 (save-restriction
21317 (widen)
21318 (let ((case-fold-search t)
21320 (if (not (save-excursion
21321 (or (re-search-forward re nil t)
21322 (re-search-backward re nil t))))
21323 (error "No bibliography defined in file")
21324 (setq bib (concat (match-string 1) ".bib")
21325 rds (list (list 'bib bib)))))))
21326 (call-interactively 'reftex-citation)))
21328 ;;;; Functions extending outline functionality
21330 (defun org-beginning-of-line (&optional arg)
21331 "Go to the beginning of the current line. If that is invisible, continue
21332 to a visible line beginning. This makes the function of C-a more intuitive.
21333 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
21334 first attempt, and only move to after the tags when the cursor is already
21335 beyond the end of the headline."
21336 (interactive "P")
21337 (let ((pos (point))
21338 (special (if (consp org-special-ctrl-a/e)
21339 (car org-special-ctrl-a/e)
21340 org-special-ctrl-a/e))
21341 refpos)
21342 (if (org-bound-and-true-p line-move-visual)
21343 (beginning-of-visual-line 1)
21344 (beginning-of-line 1))
21345 (if (and arg (fboundp 'move-beginning-of-line))
21346 (call-interactively 'move-beginning-of-line)
21347 (if (bobp)
21348 nil
21349 (backward-char 1)
21350 (if (org-truely-invisible-p)
21351 (while (and (not (bobp)) (org-truely-invisible-p))
21352 (backward-char 1)
21353 (beginning-of-line 1))
21354 (forward-char 1))))
21355 (when special
21356 (cond
21357 ((and (looking-at org-complex-heading-regexp)
21358 (= (char-after (match-end 1)) ?\ ))
21359 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
21360 (point-at-eol)))
21361 (goto-char
21362 (if (eq special t)
21363 (cond ((> pos refpos) refpos)
21364 ((= pos (point)) refpos)
21365 (t (point)))
21366 (cond ((> pos (point)) (point))
21367 ((not (eq last-command this-command)) (point))
21368 (t refpos)))))
21369 ((org-at-item-p)
21370 ;; Being at an item and not looking at an the item means point
21371 ;; was previously moved to beginning of a visual line, which
21372 ;; doesn't contain the item. Therefore, do nothing special,
21373 ;; just stay here.
21374 (when (looking-at org-list-full-item-re)
21375 ;; Set special position at first white space character after
21376 ;; bullet, and check-box, if any.
21377 (let ((after-bullet
21378 (let ((box (match-end 3)))
21379 (if (not box) (match-end 1)
21380 (let ((after (char-after box)))
21381 (if (and after (= after ? )) (1+ box) box))))))
21382 ;; Special case: Move point to special position when
21383 ;; currently after it or at beginning of line.
21384 (if (eq special t)
21385 (when (or (> pos after-bullet) (= (point) pos))
21386 (goto-char after-bullet))
21387 ;; Reversed case: Move point to special position when
21388 ;; point was already at beginning of line and command is
21389 ;; repeated.
21390 (when (and (= (point) pos) (eq last-command this-command))
21391 (goto-char after-bullet))))))))
21392 (org-no-warnings
21393 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21395 (defun org-end-of-line (&optional arg)
21396 "Go to the end of the line.
21397 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
21398 first attempt, and only move to after the tags when the cursor is already
21399 beyond the end of the headline."
21400 (interactive "P")
21401 (let ((special (if (consp org-special-ctrl-a/e)
21402 (cdr org-special-ctrl-a/e)
21403 org-special-ctrl-a/e)))
21404 (cond
21405 ((or (not special) arg
21406 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
21407 (call-interactively
21408 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
21409 ((fboundp 'move-end-of-line) 'move-end-of-line)
21410 (t 'end-of-line))))
21411 ((org-at-heading-p)
21412 (let ((pos (point)))
21413 (beginning-of-line 1)
21415 (if (eq special t)
21416 (if (or (< pos (match-beginning 1))
21417 (= pos (match-end 0)))
21418 (goto-char (match-beginning 1))
21419 (goto-char (match-end 0)))
21420 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
21421 (goto-char (match-end 0))
21422 (goto-char (match-beginning 1))))
21423 (call-interactively (if (fboundp 'move-end-of-line)
21424 'move-end-of-line
21425 'end-of-line)))))
21426 ((org-at-drawer-p)
21427 (move-end-of-line 1)
21428 (when (overlays-at (1- (point))) (backward-char 1)))
21429 ;; At an item: Move before any hidden text.
21430 (t (call-interactively
21431 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
21432 ((fboundp 'move-end-of-line) 'move-end-of-line)
21433 (t 'end-of-line)))))
21434 (org-no-warnings
21435 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
21437 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
21438 (define-key org-mode-map "\C-e" 'org-end-of-line)
21440 (defun org-backward-sentence (&optional arg)
21441 "Go to beginning of sentence, or beginning of table field.
21442 This will call `backward-sentence' or `org-table-beginning-of-field',
21443 depending on context."
21444 (interactive "P")
21445 (cond
21446 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
21447 (t (call-interactively 'backward-sentence))))
21449 (defun org-forward-sentence (&optional arg)
21450 "Go to end of sentence, or end of table field.
21451 This will call `forward-sentence' or `org-table-end-of-field',
21452 depending on context."
21453 (interactive "P")
21454 (cond
21455 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
21456 (t (call-interactively 'forward-sentence))))
21458 (define-key org-mode-map "\M-a" 'org-backward-sentence)
21459 (define-key org-mode-map "\M-e" 'org-forward-sentence)
21461 (defun org-kill-line (&optional arg)
21462 "Kill line, to tags or end of line."
21463 (interactive "P")
21464 (cond
21465 ((or (not org-special-ctrl-k)
21466 (bolp)
21467 (not (org-at-heading-p)))
21468 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
21469 org-ctrl-k-protect-subtree)
21470 (if (or (eq org-ctrl-k-protect-subtree 'error)
21471 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
21472 (error "C-k aborted - would kill hidden subtree")))
21473 (call-interactively
21474 (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
21476 (kill-region (point) (match-beginning 1))
21477 (org-set-tags nil t))
21478 (t (kill-region (point) (point-at-eol)))))
21480 (define-key org-mode-map "\C-k" 'org-kill-line)
21482 (defun org-yank (&optional arg)
21483 "Yank. If the kill is a subtree, treat it specially.
21484 This command will look at the current kill and check if is a single
21485 subtree, or a series of subtrees[1]. If it passes the test, and if the
21486 cursor is at the beginning of a line or after the stars of a currently
21487 empty headline, then the yank is handled specially. How exactly depends
21488 on the value of the following variables, both set by default.
21490 org-yank-folded-subtrees
21491 When set, the subtree(s) will be folded after insertion, but only
21492 if doing so would now swallow text after the yanked text.
21494 org-yank-adjusted-subtrees
21495 When set, the subtree will be promoted or demoted in order to
21496 fit into the local outline tree structure, which means that the level
21497 will be adjusted so that it becomes the smaller one of the two
21498 *visible* surrounding headings.
21500 Any prefix to this command will cause `yank' to be called directly with
21502 will just
21503 plainly yank the text as it is.
21505 \[1] The test checks if the first non-white line is a heading
21506 and if there are no other headings with fewer stars."
21507 (interactive "P")
21508 (org-yank-generic 'yank arg))
21510 (defun org-yank-generic (command arg)
21511 "Perform some yank-like command.
21513 This function implements the behavior described in the `org-yank'
21514 documentation. However, it has been generalized to work for any
21515 interactive command with similar behavior."
21517 ;; pretend to be command COMMAND
21518 (setq this-command command)
21520 (if arg
21521 (call-interactively command)
21523 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
21524 (and (org-kill-is-subtree-p)
21525 (or (bolp)
21527 (string-match
21529 (buffer-substring (point-at-bol) (point)))))))
21530 swallowp)
21531 (cond
21532 ((and subtreep org-yank-folded-subtrees)
21533 (let ((beg (point))
21534 end)
21535 (if (and subtreep org-yank-adjusted-subtrees)
21536 (org-paste-subtree nil nil 'for-yank)
21537 (call-interactively command))
21539 (setq end (point))
21540 (goto-char beg)
21541 (when (and (bolp) subtreep
21542 (not (setq swallowp
21543 (org-yank-folding-would-swallow-text beg end))))
21544 (org-with-limited-levels
21545 (or (looking-at org-outline-regexp)
21546 (re-search-forward org-outline-regexp-bol end t))
21547 (while (and (< (point) end) (looking-at org-outline-regexp))
21548 (hide-subtree)
21549 (org-cycle-show-empty-lines 'folded)
21550 (condition-case nil
21551 (outline-forward-same-level 1)
21552 (error (goto-char end))))))
21553 (when swallowp
21554 (message
21555 "Inserted text not folded because that would swallow text"))
21557 (goto-char end)
21559 (beginning-of-line 1)
21560 (push-mark beg 'nomsg)))
21561 ((and subtreep org-yank-adjusted-subtrees)
21562 (let ((beg (point-at-bol)))
21563 (org-paste-subtree nil nil 'for-yank)
21564 (push-mark beg 'nomsg)))
21565 (t
21566 (call-interactively command))))))
21568 (defun org-yank-folding-would-swallow-text (beg end)
21569 "Would hide-subtree at BEG swallow any text after END?"
21570 (let (level)
21571 (org-with-limited-levels
21572 (save-excursion
21573 (goto-char beg)
21574 (when (or (looking-at org-outline-regexp)
21575 (re-search-forward org-outline-regexp-bol end t))
21576 (setq level (org-outline-level)))
21577 (goto-char end)
21579 (if (or (eobp)
21580 (and (bolp) (looking-at org-outline-regexp)
21581 (<= (org-outline-level) level)))
21582 nil ; Nothing would be swallowed
21583 t))))) ; something would swallow
21585 (define-key org-mode-map "\C-y" 'org-yank)
21587 (defun org-truely-invisible-p ()
21588 "Check if point is at a character currently not visible.
21589 This version does not only check the character property, but also
21590 `visible-mode'."
21591 ;; Early versions of noutline don't have `outline-invisible-p'.
21592 (if (org-bound-and-true-p visible-mode)
21593 nil
21594 (outline-invisible-p)))
21596 (defun org-invisible-p2 ()
21597 "Check if point is at a character currently not visible."
21598 (save-excursion
21599 (if (and (eolp) (not (bobp))) (backward-char 1))
21600 ;; Early versions of noutline don't have `outline-invisible-p'.
21601 (outline-invisible-p)))
21603 (defun org-back-to-heading (&optional invisible-ok)
21604 "Call `outline-back-to-heading', but provide a better error message."
21605 (condition-case nil
21606 (outline-back-to-heading invisible-ok)
21607 (error (error "Before first headline at position %d in buffer %s"
21608 (point) (current-buffer)))))
21610 (defun org-before-first-heading-p ()
21611 "Before first heading?"
21612 (save-excursion
21613 (end-of-line)
21614 (null (re-search-backward org-outline-regexp-bol nil t))))
21616 (defun org-at-heading-p (&optional ignored)
21617 (outline-on-heading-p t))
21618 ;; Compatibility alias with Org versions < 7.8.03
21619 (defalias 'org-on-heading-p 'org-at-heading-p)
21621 (defun org-at-comment-p nil
21622 "Is cursor in a line starting with a # character?"
21623 (save-excursion
21624 (beginning-of-line)
21625 (looking-at "^#")))
21627 (defun org-at-drawer-p nil
21628 "Is cursor at a drawer keyword?"
21629 (save-excursion
21630 (move-beginning-of-line 1)
21631 (looking-at org-drawer-regexp)))
21633 (defun org-at-block-p nil
21634 "Is cursor at a block keyword?"
21635 (save-excursion
21636 (move-beginning-of-line 1)
21637 (looking-at org-block-regexp)))
21639 (defun org-point-at-end-of-empty-headline ()
21640 "If point is at the end of an empty headline, return t, else nil.
21641 If the heading only contains a TODO keyword, it is still still considered
21642 empty."
21644 (when org-todo-line-regexp
21645 (save-excursion
21646 (beginning-of-line 1)
21647 (let ((case-fold-search nil))
21648 (looking-at org-todo-line-regexp)
21649 (string= (match-string 3) ""))))))
21651 (defun org-at-heading-or-item-p ()
21652 (or (org-at-heading-p) (org-at-item-p)))
21654 (defun org-at-target-p ()
21655 (or (org-in-regexp org-radio-target-regexp)
21656 (org-in-regexp org-target-regexp)))
21657 ;; Compatibility alias with Org versions < 7.8.03
21658 (defalias 'org-on-target-p 'org-at-target-p)
21660 (defun org-up-heading-all (arg)
21661 "Move to the heading line of which the present line is a subheading.
21662 This function considers both visible and invisible heading lines.
21663 With argument, move up ARG levels."
21664 (if (fboundp 'outline-up-heading-all)
21665 (outline-up-heading-all arg) ; emacs 21 version of outline.el
21666 (outline-up-heading arg t))) ; emacs 22 version of outline.el
21668 (defun org-up-heading-safe ()
21669 "Move to the heading line of which the present line is a subheading.
21670 This version will not throw an error. It will return the level of the
21671 headline found, or nil if no higher level is found.
21673 Also, this function will be a lot faster than `outline-up-heading',
21674 because it relies on stars being the outline starters. This can really
21675 make a significant difference in outlines with very many siblings."
21676 (let (start-level re)
21677 (org-back-to-heading t)
21678 (setq start-level (funcall outline-level))
21679 (if (equal start-level 1)
21680 nil
21682 (if (re-search-backward re nil t)
21683 (funcall outline-level)))))
21685 (defun org-first-sibling-p ()
21686 "Is this heading the first child of its parents?"
21687 (interactive)
21688 (let ((re org-outline-regexp-bol)
21689 level l)
21690 (unless (org-at-heading-p t)
21691 (error "Not at a heading"))
21692 (setq level (funcall outline-level))
21693 (save-excursion
21694 (if (not (re-search-backward re nil t))
21695 t
21696 (setq l (funcall outline-level))
21697 (< l level)))))
21699 (defun org-goto-sibling (&optional previous)
21700 "Goto the next sibling, even if it is invisible.
21701 When PREVIOUS is set, go to the previous sibling instead. Returns t
21702 when a sibling was found. When none is found, return nil and don't
21703 move point."
21704 (let ((fun (if previous 're-search-backward 're-search-forward))
21705 (pos (point))
21706 (re org-outline-regexp-bol)
21707 level l)
21708 (when (condition-case nil (org-back-to-heading t) (error nil))
21709 (setq level (funcall outline-level))
21710 (catch 'exit
21711 (or previous (forward-char 1))
21712 (while (funcall fun re nil t)
21713 (setq l (funcall outline-level))
21714 (when (< l level) (goto-char pos) (throw 'exit nil))
21715 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
21716 (goto-char pos)
21717 nil))))
21719 (defun org-show-siblings ()
21720 "Show all siblings of the current headline."
21721 (save-excursion
21722 (while (org-goto-sibling) (org-flag-heading nil)))
21723 (save-excursion
21724 (while (org-goto-sibling 'previous)
21725 (org-flag-heading nil))))
21727 (defun org-goto-first-child ()
21728 "Goto the first child, even if it is invisible.
21729 Return t when a child was found. Otherwise don't move point and
21730 return nil."
21731 (let (level (pos (point)) (re org-outline-regexp-bol))
21732 (when (condition-case nil (org-back-to-heading t) (error nil))
21733 (setq level (outline-level))
21734 (forward-char 1)
21735 (if (and (re-search-forward re nil t) (> (outline-level) level))
21736 (progn (goto-char (match-beginning 0)) t)
21737 (goto-char pos) nil))))
21739 (defun org-show-hidden-entry ()
21740 "Show an entry where even the heading is hidden."
21741 (save-excursion
21742 (org-show-entry)))
21744 (defun org-flag-heading (flag &optional entry)
21745 "Flag the current heading. FLAG non-nil means make invisible.
21746 When ENTRY is non-nil, show the entire entry."
21747 (save-excursion
21748 (org-back-to-heading t)
21749 ;; Check if we should show the entire entry
21750 (if entry
21751 (progn
21752 (org-show-entry)
21753 (save-excursion
21754 (and (outline-next-heading)
21755 (org-flag-heading nil))))
21756 (outline-flag-region (max (point-min) (1- (point)))
21757 (save-excursion (outline-end-of-heading) (point))
21758 flag))))
21760 (defun org-get-next-sibling ()
21761 "Move to next heading of the same level, and return point.
21762 If there is no such heading, return nil.
21763 This is like outline-next-sibling, but invisible headings are ok."
21764 (let ((level (funcall outline-level)))
21765 (outline-next-heading)
21766 (while (and (not (eobp)) (> (funcall outline-level) level))
21767 (outline-next-heading))
21768 (if (or (eobp) (< (funcall outline-level) level))
21769 nil
21770 (point))))
21772 (defun org-get-last-sibling ()
21773 "Move to previous heading of the same level, and return point.
21774 If there is no such heading, return nil."
21775 (let ((opoint (point))
21776 (level (funcall outline-level)))
21777 (outline-previous-heading)
21778 (when (and (/= (point) opoint) (outline-on-heading-p t))
21779 (while (and (> (funcall outline-level) level)
21780 (not (bobp)))
21781 (outline-previous-heading))
21782 (if (< (funcall outline-level) level)
21783 nil
21784 (point)))))
21786 (defun org-end-of-subtree (&optional invisible-OK to-heading)
21787 ;; This contains an exact copy of the original function, but it uses
21788 ;; `org-back-to-heading', to make it work also in invisible
21789 ;; trees. And is uses an invisible-OK argument.
21790 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21791 ;; Furthermore, when used inside Org, finding the end of a large subtree
21792 ;; with many children and grandchildren etc, this can be much faster
21793 ;; than the outline version.
21794 (org-back-to-heading invisible-OK)
21795 (let ((first t)
21796 (level (funcall outline-level)))
21797 (if (and (derived-mode-p 'org-mode) (< level 1000))
21798 ;; A true heading (not a plain list item), in Org-mode
21799 ;; This means we can easily find the end by looking
21800 ;; only for the right number of stars. Using a regexp to do
21801 ;; this is so much faster than using a Lisp loop.
21803 (forward-char 1)
21804 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21805 ;; something else, do it the slow way
21806 (while (and (not (eobp))
21807 (or first (> (funcall outline-level) level)))
21808 (setq first nil)
21809 (outline-next-heading)))
21810 (unless to-heading
21812 (progn
21813 ;; Go to end of line before heading
21814 (forward-char -1)
21816 ;; leave blank line before heading
21817 (forward-char -1))))))
21818 (point))
21820 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21821 "Use Org version in org-mode, for dramatic speed-up."
21822 (if (derived-mode-p 'org-mode)
21823 (progn
21824 (org-end-of-subtree nil t)
21825 (unless (eobp) (backward-char 1)))
21826 ad-do-it))
21828 (defun org-end-of-meta-data-and-drawers ()
21829 "Jump to the first text after meta data and drawers in the current entry.
21830 This will move over empty lines, lines with planning time stamps,
21831 clocking lines, and drawers."
21832 (org-back-to-heading t)
21833 (let ((end (save-excursion (outline-next-heading) (point)))
21836 (forward-line 1)
21837 (while (re-search-forward re end t)
21838 (if (not (match-end 1))
21839 ;; empty or planning line
21840 (forward-line 1)
21841 ;; a drawer, find the end
21843 (forward-line 1)))
21845 (point)))
21847 (defun org-forward-heading-same-level (arg &optional invisible-ok)
21848 "Move forward to the arg'th subheading at same level as this one.
21849 Stop at the first and last subheadings of a superior heading.
21850 Normally this only looks at visible headings, but when INVISIBLE-OK is
21851 non-nil it will also look at invisible ones."
21852 (interactive "p")
21853 (org-back-to-heading invisible-ok)
21854 (org-at-heading-p)
21855 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21857 l)
21858 (forward-char 1)
21859 (while (> arg 0)
21860 (while (and (re-search-forward re nil 'move)
21861 (setq l (- (match-end 0) (match-beginning 0) 1))
21862 (= l level)
21863 (not invisible-ok)
21864 (progn (backward-char 1) (outline-invisible-p)))
21865 (if (< l level) (setq arg 1)))
21866 (setq arg (1- arg)))
21867 (beginning-of-line 1)))
21869 (defun org-backward-heading-same-level (arg &optional invisible-ok)
21870 "Move backward to the arg'th subheading at same level as this one.
21871 Stop at the first and last subheadings of a superior heading."
21872 (interactive "p")
21873 (org-back-to-heading)
21874 (org-at-heading-p)
21875 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21877 l)
21878 (while (> arg 0)
21879 (while (and (re-search-backward re nil 'move)
21880 (setq l (- (match-end 0) (match-beginning 0) 1))
21881 (= l level)
21882 (not invisible-ok)
21883 (outline-invisible-p))
21884 (if (< l level) (setq arg 1)))
21885 (setq arg (1- arg)))))
21887 ;;;###autoload
21888 (defun org-forward-element ()
21889 "Move forward by one element.
21890 Move to the next element at the same level, when possible."
21891 (interactive)
21892 (cond ((eobp) (error "Cannot move further down"))
21893 ((org-with-limited-levels (org-at-heading-p))
21894 (let ((origin (point)))
21895 (org-forward-heading-same-level 1)
21896 (unless (org-with-limited-levels (org-at-heading-p))
21897 (goto-char origin)
21898 (error "Cannot move further down"))))
21899 (t
21900 (let* ((elem (org-element-at-point))
21901 (end (org-element-property :end elem))
21902 (parent (org-element-property :parent elem)))
21903 (if (and parent (= (org-element-property :contents-end parent) end))
21904 (goto-char (org-element-property :end parent))
21905 (goto-char end))))))
21907 ;;;###autoload
21908 (defun org-backward-element ()
21909 "Move backward by one element.
21910 Move to the previous element at the same level, when possible."
21911 (interactive)
21912 (if (org-with-limited-levels (org-at-heading-p))
21913 ;; At an headline, move to the previous one, if any, or stay
21914 ;; here.
21915 (let ((origin (point)))
21916 (org-backward-heading-same-level 1)
21917 (unless (org-with-limited-levels (org-at-heading-p))
21918 (goto-char origin)
21919 (error "Cannot move further up")))
21920 (let* ((trail (org-element-at-point 'keep-trail))
21921 (elem (car trail))
21922 (prev-elem (nth 1 trail))
21923 (beg (org-element-property :begin elem)))
21924 (cond
21925 ;; Move to beginning of current element if point isn't there
21926 ;; already.
21927 ((/= (point) beg) (goto-char beg))
21928 ((not prev-elem) (error "Cannot move further up"))
21929 (t (goto-char (org-element-property :begin prev-elem)))))))
21931 ;;;###autoload
21932 (defun org-up-element ()
21933 "Move to upper element."
21934 (interactive)
21935 (if (org-with-limited-levels (org-at-heading-p))
21936 (unless (org-up-heading-safe) (error "No surrounding element"))
21937 (let* ((elem (org-element-at-point))
21938 (parent (org-element-property :parent elem)))
21939 (if parent (goto-char (org-element-property :begin parent))
21940 (if (org-with-limited-levels (org-before-first-heading-p))
21941 (error "No surrounding element")
21942 (org-with-limited-levels (org-back-to-heading)))))))
21944 ;;;###autoload
21945 (defvar org-element-greater-elements)
21946 (defun org-down-element ()
21947 "Move to inner element."
21948 (interactive)
21949 (let ((element (org-element-at-point)))
21950 (cond
21951 ((memq (org-element-type element) '(plain-list table))
21952 (goto-char (org-element-property :contents-begin element))
21953 (forward-char))
21954 ((memq (org-element-type element) org-element-greater-elements)
21955 ;; If contents are hidden, first disclose them.
21956 (when (org-element-property :hiddenp element) (org-cycle))
21957 (goto-char (or (org-element-property :contents-begin element)
21958 (error "No content for this element"))))
21959 (t (error "No inner element")))))
21961 ;;;###autoload
21962 (defun org-drag-element-backward ()
21963 "Move backward element at point."
21964 (interactive)
21965 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
21966 (let* ((trail (org-element-at-point 'keep-trail))
21967 (elem (car trail))
21968 (prev-elem (nth 1 trail)))
21969 ;; Error out if no previous element or previous element is
21970 ;; a parent of the current one.
21971 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
21972 (error "Cannot drag element backward")
21973 (let ((pos (point)))
21974 (org-element-swap-A-B prev-elem elem)
21975 (goto-char (+ (org-element-property :begin prev-elem)
21976 (- pos (org-element-property :begin elem)))))))))
21978 ;;;###autoload
21979 (defun org-drag-element-forward ()
21980 "Move forward element at point."
21981 (interactive)
21982 (let* ((pos (point))
21983 (elem (org-element-at-point)))
21984 (when (= (point-max) (org-element-property :end elem))
21985 (error "Cannot drag element forward"))
21986 (goto-char (org-element-property :end elem))
21987 (let ((next-elem (org-element-at-point)))
21988 (when (or (org-element-nested-p elem next-elem)
21989 (and (eq (org-element-type next-elem) 'headline)
21990 (not (eq (org-element-type elem) 'headline))))
21991 (goto-char pos)
21992 (error "Cannot drag element forward"))
21993 ;; Compute new position of point: it's shifted by NEXT-ELEM
21994 ;; body's length (without final blanks) and by the length of
21995 ;; blanks between ELEM and NEXT-ELEM.
21996 (let ((size-next (- (save-excursion
21997 (goto-char (org-element-property :end next-elem))
21999 (forward-line)
22000 ;; Small correction if buffer doesn't end
22001 ;; with a newline character.
22002 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
22003 (org-element-property :begin next-elem)))
22004 (size-blank (- (org-element-property :end elem)
22005 (save-excursion
22006 (goto-char (org-element-property :end elem))
22008 (forward-line)
22009 (point)))))
22010 (org-element-swap-A-B elem next-elem)
22011 (goto-char (+ pos size-next size-blank))))))
22013 ;;;###autoload
22014 (defun org-mark-element ()
22015 "Put point at beginning of this element, mark at end.
22017 Interactively, if this command is repeated or (in Transient Mark
22018 mode) if the mark is active, it marks the next element after the
22019 ones already marked."
22020 (interactive)
22021 (let (deactivate-mark)
22022 (if (and (org-called-interactively-p 'any)
22023 (or (and (eq last-command this-command) (mark t))
22024 (and transient-mark-mode mark-active)))
22025 (set-mark
22026 (save-excursion
22027 (goto-char (mark))
22028 (goto-char (org-element-property :end (org-element-at-point)))))
22029 (let ((element (org-element-at-point)))
22030 (end-of-line)
22031 (push-mark (org-element-property :end element) t t)
22032 (goto-char (org-element-property :begin element))))))
22034 ;;;###autoload
22035 (defun org-narrow-to-element ()
22036 "Narrow buffer to current element."
22037 (interactive)
22038 (let ((elem (org-element-at-point)))
22039 (cond
22040 ((eq (car elem) 'headline)
22041 (narrow-to-region
22042 (org-element-property :begin elem)
22043 (org-element-property :end elem)))
22044 ((memq (car elem) org-element-greater-elements)
22045 (narrow-to-region
22046 (org-element-property :contents-begin elem)
22047 (org-element-property :contents-end elem)))
22048 (t
22049 (narrow-to-region
22050 (org-element-property :begin elem)
22051 (org-element-property :end elem))))))
22053 ;;;###autoload
22054 (defun org-transpose-element ()
22055 "Transpose current and previous elements, keeping blank lines between.
22056 Point is moved after both elements."
22057 (interactive)
22058 (org-skip-whitespace)
22059 (let ((end (org-element-property :end (org-element-at-point))))
22060 (org-drag-element-backward)
22061 (goto-char end)))
22063 ;;;###autoload
22064 (defun org-unindent-buffer ()
22065 "Un-indent the visible part of the buffer.
22066 Relative indentation (between items, inside blocks, etc.) isn't
22067 modified."
22068 (interactive)
22069 (unless (eq major-mode 'org-mode)
22070 (error "Cannot un-indent a buffer not in Org mode"))
22071 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
22072 unindent-tree ; For byte-compiler.
22073 (unindent-tree
22074 (function
22075 (lambda (contents)
22076 (mapc
22077 (lambda (element)
22078 (if (memq (org-element-type element) '(headline section))
22079 (funcall unindent-tree (org-element-contents element))
22080 (save-excursion
22081 (save-restriction
22082 (narrow-to-region
22083 (org-element-property :begin element)
22084 (org-element-property :end element))
22085 (org-do-remove-indentation)))))
22086 (reverse contents))))))
22087 (funcall unindent-tree (org-element-contents parse-tree))))
22089 (defun org-show-subtree ()
22090 "Show everything after this heading at deeper levels."
22091 (interactive)
22092 (outline-flag-region
22093 (point)
22094 (save-excursion
22095 (org-end-of-subtree t t))
22096 nil))
22098 (defun org-show-entry ()
22099 "Show the body directly following this heading.
22100 Show the heading too, if it is currently invisible."
22101 (interactive)
22102 (save-excursion
22103 (condition-case nil
22104 (progn
22105 (org-back-to-heading t)
22106 (outline-flag-region
22107 (max (point-min) (1- (point)))
22108 (save-excursion
22109 (if (re-search-forward
22111 (match-beginning 1)
22112 (point-max)))
22113 nil)
22114 (org-cycle-hide-drawers 'children))
22115 (error nil))))
22117 (defun org-make-options-regexp (kwds &optional extra)
22118 "Make a regular expression for keyword lines."
22119 (concat
22125 ;; Make isearch reveal the necessary context
22126 (defun org-isearch-end ()
22127 "Reveal context after isearch exits."
22128 (when isearch-success ; only if search was successful
22129 (if (featurep 'xemacs)
22130 ;; Under XEmacs, the hook is run in the correct place,
22131 ;; we directly show the context.
22132 (org-show-context 'isearch)
22133 ;; In Emacs the hook runs *before* restoring the overlays.
22134 ;; So we have to use a one-time post-command-hook to do this.
22135 ;; (Emacs 22 has a special variable, see function `org-mode')
22136 (unless (and (boundp 'isearch-mode-end-hook-quit)
22137 isearch-mode-end-hook-quit)
22138 ;; Only when the isearch was not quitted.
22139 (org-add-hook 'post-command-hook 'org-isearch-post-command
22140 'append 'local)))))
22142 (defun org-isearch-post-command ()
22143 "Remove self from hook, and show context."
22144 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
22145 (org-show-context 'isearch))
22148 ;;;; Integration with and fixes for other packages
22150 ;;; Imenu support
22152 (defvar org-imenu-markers nil
22153 "All markers currently used by Imenu.")
22154 (make-variable-buffer-local 'org-imenu-markers)
22156 (defun org-imenu-new-marker (&optional pos)
22157 "Return a new marker for use by Imenu, and remember the marker."
22158 (let ((m (make-marker)))
22159 (move-marker m (or pos (point)))
22160 (push m org-imenu-markers)
22161 m))
22163 (defun org-imenu-get-tree ()
22164 "Produce the index for Imenu."
22165 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
22166 (setq org-imenu-markers nil)
22167 (let* ((n org-imenu-depth)
22168 (re (concat "^" (org-get-limited-outline-regexp)))
22169 (subs (make-vector (1+ n) nil))
22170 (last-level 0)
22171 m level head)
22172 (save-excursion
22173 (save-restriction
22174 (widen)
22175 (goto-char (point-max))
22176 (while (re-search-backward re nil t)
22177 (setq level (org-reduced-level (funcall outline-level)))
22178 (when (and (<= level n)
22179 (looking-at org-complex-heading-regexp))
22180 (setq head (org-link-display-format
22181 (org-match-string-no-properties 4))
22182 m (org-imenu-new-marker))
22183 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
22184 (if (>= level last-level)
22185 (push (cons head m) (aref subs level))
22186 (push (cons head (aref subs (1+ level))) (aref subs level))
22187 (loop for i from (1+ level) to n do (aset subs i nil)))
22188 (setq last-level level)))))
22189 (aref subs 1)))
22191 (eval-after-load "imenu"
22192 '(progn
22193 (add-hook 'imenu-after-jump-hook
22194 (lambda ()
22195 (if (derived-mode-p 'org-mode)
22196 (org-show-context 'org-goto))))))
22198 (defun org-link-display-format (link)
22199 "Replace a link with either the description, or the link target
22200 if no description is present"
22201 (save-match-data
22202 (if (string-match org-bracket-link-analytic-regexp link)
22203 (replace-match (if (match-end 5)
22204 (match-string 5 link)
22205 (concat (match-string 1 link)
22206 (match-string 3 link)))
22207 nil t link)
22208 link)))
22210 (defun org-toggle-link-display ()
22211 "Toggle the literal or descriptive display of links."
22212 (interactive)
22213 (if org-descriptive-links
22214 (progn (org-remove-from-invisibility-spec '(org-link))
22215 (org-restart-font-lock)
22216 (setq org-descriptive-links nil))
22217 (progn (add-to-invisibility-spec '(org-link))
22218 (org-restart-font-lock)
22219 (setq org-descriptive-links t))))
22221 ;; Speedbar support
22223 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
22224 "Overlay marking the agenda restriction line in speedbar.")
22225 (overlay-put org-speedbar-restriction-lock-overlay
22226 'face 'org-agenda-restriction-lock)
22227 (overlay-put org-speedbar-restriction-lock-overlay
22228 'help-echo "Agendas are currently limited to this item.")
22229 (org-detach-overlay org-speedbar-restriction-lock-overlay)
22231 (defun org-speedbar-set-agenda-restriction ()
22232 "Restrict future agenda commands to the location at point in speedbar.
22234 (interactive)
22235 (require 'org-agenda)
22236 (let (p m tp np dir txt)
22237 (cond
22238 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22239 'org-imenu t))
22240 (setq m (get-text-property p 'org-imenu-marker))
22241 (with-current-buffer (marker-buffer m)
22242 (goto-char m)
22243 (org-agenda-set-restriction-lock 'subtree)))
22244 ((setq p (text-property-any (point-at-bol) (point-at-eol)
22245 'speedbar-function 'speedbar-find-file))
22246 (setq tp (previous-single-property-change
22247 (1+ p) 'speedbar-function)
22248 np (next-single-property-change
22249 tp 'speedbar-function)
22250 dir (speedbar-line-directory)
22251 txt (buffer-substring-no-properties (or tp (point-min))
22252 (or np (point-max))))
22253 (with-current-buffer (find-file-noselect
22254 (let ((default-directory dir))
22255 (expand-file-name txt)))
22256 (unless (derived-mode-p 'org-mode)
22257 (error "Cannot restrict to non-Org-mode file"))
22258 (org-agenda-set-restriction-lock 'file)))
22259 (t (error "Don't know how to restrict Org-mode's agenda")))
22260 (move-overlay org-speedbar-restriction-lock-overlay
22261 (point-at-bol) (point-at-eol))
22262 (setq current-prefix-arg nil)
22263 (org-agenda-maybe-redo)))
22265 (eval-after-load "speedbar"
22266 '(progn
22267 (speedbar-add-supported-extension ".org")
22268 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
22269 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
22270 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
22271 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
22272 (add-hook 'speedbar-visiting-tag-hook
22273 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
22275 ;;; Fixes and Hacks for problems with other packages
22277 ;; Make flyspell not check words in links, to not mess up our keymap
22278 (defun org-mode-flyspell-verify ()
22279 "Don't let flyspell put overlays at active buttons, or on
22280 {todo,all-time,additional-option-like}-keywords."
22281 (let ((pos (max (1- (point)) (point-min)))
22282 (word (thing-at-point 'word)))
22283 (and (not (get-text-property pos 'keymap))
22284 (not (get-text-property pos 'org-no-flyspell))
22285 (not (member word org-todo-keywords-1))
22286 (not (member word org-all-time-keywords))
22287 (not (member word org-options-keywords))
22288 (not (member word (mapcar 'car org-startup-options)))
22289 (not (member word org-additional-option-like-keywords-for-flyspell)))))
22291 (defun org-remove-flyspell-overlays-in (beg end)
22292 "Remove flyspell overlays in region."
22293 (and (org-bound-and-true-p flyspell-mode)
22294 (fboundp 'flyspell-delete-region-overlays)
22295 (flyspell-delete-region-overlays beg end))
22296 (add-text-properties beg end '(org-no-flyspell t)))
22298 ;; Make `bookmark-jump' shows the jump location if it was hidden.
22299 (eval-after-load "bookmark"
22300 '(if (boundp 'bookmark-after-jump-hook)
22301 ;; We can use the hook
22302 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
22303 ;; Hook not available, use advice
22304 (defadvice bookmark-jump (after org-make-visible activate)
22305 "Make the position visible."
22306 (org-bookmark-jump-unhide))))
22308 ;; Make sure saveplace shows the location if it was hidden
22309 (eval-after-load "saveplace"
22310 '(defadvice save-place-find-file-hook (after org-make-visible activate)
22311 "Make the position visible."
22312 (org-bookmark-jump-unhide)))
22314 ;; Make sure ecb shows the location if it was hidden
22315 (eval-after-load "ecb"
22316 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
22317 "Make hierarchy visible when jumping into location from ECB tree buffer."
22318 (if (derived-mode-p 'org-mode)
22319 (org-show-context))))
22321 (defun org-bookmark-jump-unhide ()
22322 "Unhide the current position, to show the bookmark location."
22323 (and (derived-mode-p 'org-mode)
22324 (or (outline-invisible-p)
22325 (save-excursion (goto-char (max (point-min) (1- (point))))
22326 (outline-invisible-p)))
22327 (org-show-context 'bookmark-jump)))
22329 ;; Make session.el ignore our circular variable
22330 (eval-after-load "session"
22331 '(add-to-list 'session-globals-exclude 'org-mark-ring))
22333 ;;;; Experimental code
22335 (defun org-closed-in-range ()
22336 "Sparse tree of items closed in a certain time range.
22337 Still experimental, may disappear in the future."
22338 (interactive)
22339 ;; Get the time interval from the user.
22340 (let* ((time1 (org-float-time
22341 (org-read-date nil 'to-time nil "Starting date: ")))
22342 (time2 (org-float-time
22343 (org-read-date nil 'to-time nil "End date:")))
22344 ;; callback function
22345 (callback (lambda ()
22346 (let ((time
22347 (org-float-time
22348 (apply 'encode-time
22349 (org-parse-time-string
22350 (match-string 1))))))
22351 ;; check if time in interval
22352 (and (>= time time1) (<= time time2))))))
22353 ;; make tree, check each match with the callback
22356 ;;;; Finish up
22358 (provide 'org)
22360 (run-hooks 'org-load-hook)
22362 ;;; org.el ends here