| blob | f36b11014745d201ce6896690636f9ec2a5490b6 |
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 ;; Version: 7.8.03
11 ;;
12 ;; This file is part of GNU Emacs.
13 ;;
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://orgmode.org/org.html#Installation
53 ;;
54 ;; Documentation
55 ;; -------------
56 ;; The documentation of Org-mode can be found in the TeXInfo file. The
57 ;; distribution also contains a PDF version of it. At the homepage of
58 ;; Org-mode, you can read the same text online as HTML. There is also an
59 ;; excellent reference card made by Philip Rooke. This card can be found
60 ;; in the etc/ directory of Emacs 22.
61 ;;
62 ;; A list of recent changes can be found at
63 ;; http://orgmode.org/Changes.html
64 ;;
65 ;;; Code:
72 ;;;; Require other packages
80 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
92 ;; Other stuff we need.
110 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
115 ;; babel
124 ;; load languages based on value of `org-babel-load-languages'
126 ;;;###autoload
128 "Load the languages defined in `org-babel-load-languages'."
140 org-babel-load-languages))
143 "Languages which can be evaluated in Org-mode buffers.
144 This list can be used to load support for any of the languages
145 below, note that each language will depend on a different set of
146 system executables and/or Emacs modes. When a language is
148 with `org-babel-execute-src-block' bound by default to C-c
149 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
150 be set to remove code block evaluation from the C-c C-c
151 keybinding. By default only Emacs Lisp (which has no
152 requirements) is loaded."
157 :key-type
199 ;;;; Customization variables
201 "Remove ID property of clones of a subtree.
202 When non-nil, clones of a subtree don't inherit the ID property.
203 Otherwise they inherit the ID property with a new unique
204 identifier."
209 ;;; Version
215 "Show the org-mode version in the echo area.
216 With prefix arg HERE, insert it at point."
242 ;;; Compatibility constants
244 ;;; The custom variables
247 "Outline-based notes management and organizer."
253 "Mode hook for Org-mode, run after the mode was turned on."
258 "Hook that is run after org.el has been loaded."
263 "Hook that is run after an Org log buffer is created."
273 "Load all extensions listed in `org-modules'."
278 org-modules)
282 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
291 (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)
292 "Modules that should always be loaded together with org.el.
293 If a description starts with <C>, the file is not part of Emacs
294 and loading it will require that you have downloaded and properly installed
295 the org-mode distribution.
297 You can also use this system to load external packages (i.e. neither Org
298 core modules, nor modules from the CONTRIB directory). Just add symbols
299 to the end of the list. If the package is called org-xyz.el, then you need
300 to add the symbol `xyz', and the package must have a call to
302 (provide 'org-xyz)"
305 :type
336 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
345 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
354 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
370 "Non-nil means make shift-cursor commands select text when possible.
372 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
373 start selecting a region, or enlarge regions started in this way.
374 In Org-mode, in special contexts, these same keys are used for
375 other purposes, important enough to compete with shift selection.
376 Org tries to balance these needs by supporting `shift-select-mode'
377 outside these special contexts, under control of this variable.
379 The default of this variable is nil, to avoid confusing behavior. Shifted
380 cursor keys will then execute Org commands in the following contexts:
381 - on a headline, changing TODO state (left/right) and priority (up/down)
382 - on a time stamp, changing the time
383 - in a plain list item, changing the bullet type
384 - in a property definition line, switching between allowed values
385 - in the BEGIN line of a clock table (changing the time block).
386 Outside these contexts, the commands will throw an error.
388 When this variable is t and the cursor is not in a special
389 context, Org-mode will support shift-selection for making and
390 enlarging regions. To make this more effective, the bullet
391 cycling will no longer happen anywhere in an item line, but only
392 if the cursor is exactly on the bullet.
394 If you set this variable to the symbol `always', then the keys
395 will not be special in headlines, property lines, and item lines,
396 to make shift selection work there as well. If this is what you
397 want, you can use the following alternative commands: `C-c C-t'
398 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
399 can be used to switch TODO sets, `C-c -' to cycle item bullet
400 types, and properties can be edited by hand or in column view.
402 However, when the cursor is on a timestamp, shift-cursor commands
403 will still edit the time stamp - this is just too good to give up.
405 XEmacs user should have this variable set to nil, because
406 `shift-select-mode' is in Emacs 23 or later only."
414 "Shall some commands act upon headlines in the active region?
416 When set to `t', some commands will be performed in all headlines
417 within the active region.
419 When set to `start-level', some commands will be performed in all
420 headlines within the active region, provided that these headlines
421 are of the same level than the first one.
423 When set to a string, those commands will be performed on the
424 matching headlines within the active region. Such string must be
425 a tags/property/todo match as it is used in the agenda tags view.
427 The list of commands is: `org-schedule', `org-deadline',
428 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
429 `org-archive-to-archive-sibling'. The archiving commands skip
430 already archived entries."
440 "Options concerning startup of Org-mode."
445 "Non-nil means entering Org-mode will switch to OVERVIEW.
446 This can also be configured on a per-file basis by adding one of
447 the following lines anywhere in the buffer:
449 #+STARTUP: fold (or `overview', this is equivalent)
450 #+STARTUP: nofold (or `showall', this is equivalent)
451 #+STARTUP: content
452 #+STARTUP: showeverything"
461 "Non-nil means entering Org-mode will set `truncate-lines'.
462 This is useful since some lines containing links can be very long and
463 uninteresting. Also tables look terrible when wrapped."
468 "Non-nil means turn on `org-indent-mode' on startup.
469 This can also be configured on a per-file basis by adding one of
470 the following lines anywhere in the buffer:
472 #+STARTUP: indent
473 #+STARTUP: noindent"
481 When this option is turned on, you can use TeX-like syntax for sub- and
483 considered as a single item - so grouping with {} is normally not
484 needed. For example, the following things will be parsed as single
485 sub- or superscripts.
487 10^24 or 10^tau several digits will be considered 1 item.
488 10^-12 or 10^-tau a leading sign with digits or a word
489 x^2-y^3 will be read as x^2 - y^3, because items are
490 terminated by almost any nonword/nondigit char.
491 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
493 Still, ambiguity is possible - so when in doubt use {} to enclose the
494 sub/superscript. If you set this variable to the symbol `{}',
495 the braces are *required* in order to trigger interpretations as
497 frequently in plain text.
499 Not all export backends support this, but HTML does.
515 "Non-nil means turn on `org-beamer-mode' on startup.
516 This can also be configured on a per-file basis by adding one of
517 the following lines anywhere in the buffer:
519 #+STARTUP: beamer"
525 "Non-nil means align all tables when visiting a file.
526 This is useful when the column width in tables is forced with <N> cookies
527 in table fields. Such tables will look correct only after the first re-align.
528 This can also be configured on a per-file basis by adding one of
529 the following lines anywhere in the buffer:
530 #+STARTUP: align
531 #+STARTUP: noalign"
536 "Non-nil means show inline images when loading a new Org file.
537 This can also be configured on a per-file basis by adding one of
538 the following lines anywhere in the buffer:
539 #+STARTUP: inlineimages
540 #+STARTUP: noinlineimages"
546 "Non-nil means insert the first line setting Org-mode in empty files.
547 When the function `org-mode' is called interactively in an empty file, this
548 normally means that the file name does not automatically trigger Org-mode.
549 To ensure that the file will always be in Org-mode in the future, a
550 line enforcing Org-mode will be inserted into the buffer, if this option
551 has been set."
556 "Non-nil means use alternative key bindings for some keys.
557 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
558 These keys are also used by other packages like shift-selection-mode'
559 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
560 If you want to use Org-mode together with one of these other modes,
561 or more generally if you would like to move some Org-mode commands to
562 other keys, set this variable and configure the keys with the variable
563 `org-disputed-keys'.
565 This option is only relevant at load-time of Org-mode, and must be set
566 *before* org.el is loaded. Changing it requires a restart of Emacs to
567 become effective."
572 "Non-nil means use extra key sequence definitions for certain commands.
573 This happens automatically if you run XEmacs or if `window-system'
574 is nil. This variable lets you do the same manually. You must
575 set it before loading org.
577 Example: on Carbon Emacs 22 running graphically, with an external
578 keyboard on a Powerbook, the default way of setting M-left might
579 not work for either Alt or ESC. Setting this variable will make
580 it work for ESC."
594 "Keys for which Org-mode and other modes compete.
595 This is an alist, cars are the default keys, second element specifies
596 the alternative to use when `org-replace-disputed-keys' is t.
598 Keys can be specified in any syntax supported by `define-key'.
599 The value of this option takes effect only at Org-mode's startup,
600 therefore you'll have to restart Emacs to apply it after changing."
605 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
606 Or return the original if not disputed.
607 Also apply the translations defined in `org-xemacs-key-equivalents'."
612 org-disputed-keys)))
616 key)
626 "Define a key, possibly translated, as returned by `org-key'."
630 "The ellipsis to use in the Org-mode outline.
631 When nil, just use the standard three dots. When a string, use that instead,
632 When a face, use the standard 3 dots, but with the specified face.
633 The change affects only Org-mode (which will then use its own display table).
634 Changing this requires executing `M-x org-mode' in a buffer to become
635 effective."
645 "Keywords in Org-mode."
650 "String to mark deadline entries.
651 A deadline is this string, followed by a time stamp. Should be a word,
652 terminated by a colon. You can insert a schedule keyword and
654 Changes become only effective after restarting Emacs."
659 "String to mark scheduled TODO entries.
660 A schedule is this string, followed by a time stamp. Should be a word,
661 terminated by a colon. You can insert a schedule keyword and
663 Changes become only effective after restarting Emacs."
668 "String used as the prefix for timestamps logging closing a TODO entry."
673 "String used as prefix for timestamps clocking work hours on an item."
678 "Entries starting with this keyword will never be exported.
679 An entry can be toggled between COMMENT and normal with
681 Changes become only effective after restarting Emacs."
686 "Entries starting with this keyword will be exported in fixed-width font.
687 Quoting applies only to the text in the entry following the headline, and does
688 not extend beyond the next headline, even if that is lower level.
689 An entry can be toggled between QUOTE and normal with
696 "Regular expression for specifying repeated events.
700 "Options concerning the general structure of Org-mode files."
705 "Options about how to make context of a location visible."
729 "Non-nil means show full hierarchy when revealing a location.
730 Org-mode often shows locations in an org-mode file which might have
731 been invisible before. When this is set, the hierarchy of headings
732 above the exposed location is shown.
733 Turning this off for example for sparse trees makes them very compact.
734 Instead of t, this can also be an alist specifying this option for different
735 contexts. Valid contexts are
736 agenda when exposing an entry from the agenda
737 org-goto when using the command `org-goto' on key C-c C-j
738 occur-tree when using the command `org-occur' on key C-c /
739 tags-tree when constructing a sparse tree based on tags matches
740 link-search when exposing search matches associated with a link
741 mark-goto when exposing the jump goal of a mark
742 bookmark-jump when exposing a bookmark location
743 isearch when exiting from an incremental search
744 default default for all contexts not set explicitly"
749 "Non-nil means show following heading when revealing a location.
750 Org-mode often shows locations in an org-mode file which might have
751 been invisible before. When this is set, the heading following the
752 match is shown.
753 Turning this off for example for sparse trees makes them very compact,
754 but makes it harder to edit the location of the match. In such a case,
756 Instead of t, this can also be an alist specifying this option for different
757 contexts. See `org-show-hierarchy-above' for valid contexts."
762 "Non-nil means show all sibling heading when revealing a location.
763 Org-mode often shows locations in an org-mode file which might have
764 been invisible before. When this is set, the sibling of the current entry
765 heading are all made visible. If `org-show-hierarchy-above' is t,
766 the same happens on each level of the hierarchy above the current entry.
768 By default this is on for the isearch context, off for all other contexts.
769 Turning this off for example for sparse trees makes them very compact,
770 but makes it harder to edit the location of the match. In such a case,
772 Instead of t, this can also be an alist specifying this option for different
773 contexts. See `org-show-hierarchy-above' for valid contexts."
778 "Non-nil means show the entry below a headline when revealing a location.
779 Org-mode often shows locations in an org-mode file which might have
780 been invisible before. When this is set, the text below the headline that is
781 exposed is also shown.
783 By default this is off for all contexts.
784 Instead of t, this can also be an alist specifying this option for different
785 contexts. See `org-show-hierarchy-above' for valid contexts."
790 "How should indirect tree buffers be displayed?
791 This applies to indirect buffers created with the commands
793 Valid values are:
794 current-window Display in the current window
795 other-window Just display in another window.
796 dedicated-frame Create one new frame, and re-use it each time.
797 new-frame Make a new frame each time. Note that in this case
798 previously-made indirect buffers are kept, and you need to
799 kill these buffers yourself."
809 "Non-nil means activate single letter commands at beginning of a headline.
810 This may also be a function to test for appropriate locations where speed
811 commands should be active."
819 "Alist of additional speed commands.
820 This list will be checked before `org-speed-commands-default'
821 when the variable `org-use-speed-commands' is non-nil
822 and when the cursor is at the beginning of a headline.
823 The car if each entry is a string with a single letter, which must
824 be assigned to `self-insert-command' in the global map.
825 The cdr is either a command to be called interactively, a function
826 to be called, or a form to be evaluated.
827 An entry that is just a list with a single string will be interpreted
828 as a descriptive headline that will be added when listing the speed
829 commands in the Help buffer using the `?' speed command."
841 "Options concerning visibility cycling in Org-mode."
846 "Non-nil means skip CHILDREN state in entries that don't have any."
851 "Maximum level which should still be subject to visibility cycling.
852 Levels higher than this will, for cycling, be treated as text, not a headline.
853 When `org-odd-levels-only' is set, a value of N in this variable actually
854 means 2N-1 stars as the limiting headline.
855 When nil, cycle all levels.
856 Note that the limiting level of cycling is also influenced by
857 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
858 `org-inlinetask-min-level' is, cycling will be limited to levels one less
859 than its value."
866 "Names of drawers. Drawers are not opened by cycling on the headline above.
867 Drawers only open with a TAB on the drawer line itself. A drawer looks like
868 this:
869 :DRAWERNAME:
870 .....
871 :END:
873 the property API.
875 Drawers can be defined on the per-file basis with a line like:
877 #+DRAWERS: HIDDEN STATE PROPERTIES"
883 "Non-nil means entering Org-mode will fold all blocks.
884 This can also be set in on a per-file basis with
886 #+STARTUP: hideblocks
887 #+STARTUP: showblocks"
893 "Cycle globally if cursor is at beginning of buffer and not at a headline.
894 This makes it possible to do global cycling without having to use S-TAB or
896 of the buffer
897 must not be a headline - it may be empty or some other text. When used in
898 this way, `org-cycle-hook' is disables temporarily, to make sure the
899 cursor stays at the beginning of the buffer.
900 When this option is nil, don't do anything special at the beginning
901 of the buffer."
906 "Non-nil means cycle entry level or item indentation in new empty entries.
908 When the cursor is at the end of an empty headline, i.e with only stars
909 and maybe a TODO keyword, TAB will then switch the entry to become a child,
910 and then all possible ancestor states, before returning to the original state.
911 This makes data entry extremely fast: M-RET to create a new headline,
912 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
914 When the cursor is at the end of an empty plain list item, one TAB will
915 make it a subitem, two or more tabs will back up to make this an item
916 higher up in the item hierarchy."
921 "Where should `org-cycle' emulate TAB.
922 nil Never
923 white Only in completely white lines
924 whitestart Only at the beginning of lines, before the first non-white char
925 t Everywhere except in headlines
926 exc-hl-bol Everywhere except at the start of a headline
927 If TAB is used in a place where it does not emulate TAB, the current subtree
928 visibility is cycled."
935 ))
938 "Number of empty lines needed to keep an empty line between collapsed trees.
939 If you leave an empty line between the end of a subtree and the following
940 headline, this empty line is hidden when the subtree is folded.
941 Org-mode will leave (exactly) one empty line visible if the number of
942 empty lines is equal or larger to the number given in this variable.
943 So the default 2 means at least 2 empty lines after the end of a subtree
944 are needed to produce free space between a collapsed subtree and the
945 following headline.
947 If the number is negative, and the number of empty lines is at least -N,
948 all empty lines are shown.
950 Special case: when 0, never leave empty lines in collapsed view."
956 "Hook that is run before visibility cycling is happening.
957 The function(s) in this hook must accept a single argument which indicates
958 the new state that will be set right after running this hook. The
959 argument is a symbol. Before a global state change, it can have the values
960 `overview', `content', or `all'. Before a local state change, it can have
961 the values `folded', `children', or `subtree'."
966 org-cycle-hide-drawers
967 org-cycle-show-empty-lines
968 org-optimize-window-after-visibility-change)
969 "Hook that is run after `org-cycle' has changed the buffer visibility.
970 The function(s) in this hook must accept a single argument which indicates
971 the new state that was set by the most recent `org-cycle' command. The
972 argument is a symbol. After a global state change, it can have the values
973 `overview', `content', or `all'. After a local state change, it can have
974 the values `folded', `children', or `subtree'."
979 "Options concerning structure editing in Org-mode."
984 "Non-nil means skip even levels and only use odd levels for the outline.
985 This has the effect that two stars are being added/taken away in
986 promotion/demotion commands. It also influences how levels are
987 handled by the exporters.
988 Changing it requires restart of `font-lock-mode' to become effective
989 for fontification also in regions already fontified.
990 You may also set this on a per-file basis by adding one of the following
991 lines to the buffer:
993 #+STARTUP: odd
994 #+STARTUP: oddeven"
1000 "Non-nil means adapt indentation to outline node level.
1002 When this variable is set, Org assumes that you write outlines by
1003 indenting text in each node to align with the headline (after the stars).
1004 The following issues are influenced by this variable:
1006 - When this is set and the *entire* text in an entry is indented, the
1007 indentation is increased by one space in a demotion command, and
1008 decreased by one in a promotion command. If any line in the entry
1009 body starts with text at column 0, indentation is not changed at all.
1011 - Property drawers and planning information is inserted indented when
1012 this variable s set. When nil, they will not be indented.
1014 - TAB indents a line relative to context. The lines below a headline
1015 will be indented when this variable is set.
1017 Note that this is all about true indentation, by adding and removing
1018 space characters. See also `org-indent.el' which does level-dependent
1019 indentation in a virtual way, i.e. at display time in Emacs."
1024 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1026 When t, `C-a' will bring back the cursor to the beginning of the
1027 headline text, i.e. after the stars and after a possible TODO
1028 keyword. In an item, this will be the position after bullet and
1029 check-box, if any. When the cursor is already at that position,
1030 another `C-a' will bring it to the beginning of the line.
1032 `C-e' will jump to the end of the headline, ignoring the presence
1033 of tags in the headline. A second `C-e' will then jump to the
1034 true end of the line, after any tags. This also means that, when
1035 this variable is non-nil, `C-e' also will never jump beyond the
1036 end of the heading of a folded section, i.e. not after the
1037 ellipses.
1039 When set to the symbol `reversed', the first `C-a' or `C-e' works
1040 normally, going to the true line boundary first. Only a directly
1041 following, identical keypress will bring the cursor to the
1042 special positions.
1044 This may also be a cons cell where the behavior for `C-a' and
1045 `C-e' is set separately."
1064 "Non-nil means `C-k' will behave specially in headlines.
1065 When nil, `C-k' will call the default `kill-line' command.
1066 When t, the following will happen while the cursor is in the headline:
1068 - When the cursor is at the beginning of a headline, kill the entire
1069 line and possible the folded subtree below the line.
1070 - When in the middle of the headline text, kill the headline up to the tags.
1071 - When after the headline text, kill the tags."
1076 "Non-nil means, do not delete a hidden subtree with C-k.
1077 When set to the symbol `error', simply throw an error when C-k is
1078 used to kill (part-of) a headline that has hidden text behind it.
1079 Any other non-nil value will result in a query to the user, if it is
1080 OK to kill that hidden subtree. When nil, kill without remorse."
1089 "Check if in invisible region before inserting or deleting a character.
1090 Valid values are:
1092 nil Do not check, so just do invisible edits.
1093 error Throw an error and do nothing.
1094 show Make point visible, and do the requested edit.
1095 show-and-error Make point visible, then throw an error and abort the edit.
1096 smart Make point visible, and do insertion/deletion if it is
1097 adjacent to visible text and the change feels predictable.
1098 Never delete a previously invisible character or add in the
1099 middle or right after an invisible region. Basically, this
1100 allows insertion and backward-delete right before ellipses.
1101 FIXME: maybe in this case we should not even show?"
1112 "Non-nil means when yanking subtrees, fold them.
1113 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1114 it starts with a heading and all other headings in it are either children
1115 or siblings, then fold all the subtrees. However, do this only if no
1116 text after the yank would be swallowed into a folded tree by this action."
1121 "Non-nil means when yanking subtrees, adjust the level.
1122 With this setting, `org-paste-subtree' is used to insert the subtree, see
1123 this function for details."
1128 "Non-nil means M-RET will split the line at the cursor position.
1129 When nil, it will go to the end of the line before making a
1130 new line.
1131 You may also set this option in a different way for different
1132 contexts. Valid contexts are:
1134 headline when creating a new headline
1135 item when creating a new item
1136 table in a table field
1137 default the value to be used for all contexts not explicitly
1138 customized"
1155 "Non-nil means insert new headings after the current subtree.
1156 When nil, the new heading is created directly after the current line.
1159 for the duration of the command."
1165 "Should `org-insert-heading' leave a blank line before new heading/item?
1166 The value is an alist, with `heading' and `plain-list-item' as CAR,
1167 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1168 which case Org will look at the surrounding headings/items and try to
1169 make an intelligent decision whether to insert a blank line or not.
1171 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1172 set, the setting here is ignored and no empty line is inserted, to avoid
1173 breaking the list structure."
1186 "Hook being run after inserting a new heading."
1192 This currently only means they are never auto-wrapped.
1193 When nil, such lines will be treated like ordinary lines.
1194 See also the QUOTE keyword."
1199 "Non-nil means typing characters in `org-goto' starts incremental search."
1204 "Options concerning sparse trees in Org-mode."
1209 "Non-nil means highlight all matches that define a sparse tree.
1210 The highlights will automatically disappear the next time the buffer is
1211 changed by an edit command."
1216 "Non-nil means any change to the buffer will remove temporary highlights.
1217 Such highlights are created by `org-occur' and `org-clock-display'.
1218 When nil, `C-c C-c needs to be used to get rid of the highlights.
1219 The highlights created by `org-preview-latex-fragment' always need
1220 `C-c C-c' to be removed."
1227 "Hook that is run after `org-occur' has constructed a sparse tree.
1228 This can be used to recenter the window to show as much of the structure
1229 as possible."
1234 "Options concerning imenu and speedbar in Org-mode."
1239 "The maximum level for Imenu access to Org-mode headlines.
1240 This also applied for speedbar access."
1245 "Options concerning tables in Org-mode."
1251 When nil, such lines will be treated like ordinary lines.
1253 When equal to the symbol `optimized', the table editor will be optimized to
1254 do the following:
1255 - Automatic overwrite mode in front of whitespace in table fields.
1256 This makes the structure of the table stay in tact as long as the edited
1257 field does not exceed the column width.
1258 - Minimize the number of realigns. Normally, the table is aligned each time
1259 TAB or RET are pressed to move to another field. With optimization this
1260 happens only if changes to a field might have changed the column width.
1261 Optimization requires replacing the functions `self-insert-command',
1262 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1263 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1264 very good at guessing when a re-align will be necessary, but you can always
1267 If you would like to use the optimized version in Org-mode, but the
1268 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1270 This variable can be used to turn on and off the table editor during a session,
1271 but in order to toggle optimization, a restart is required.
1273 See also the variable `org-table-auto-blank-field'."
1281 "Non-nil means cluster self-insert commands for undo when possible.
1282 If this is set, then, like in the Emacs command loop, 20 consecutive
1283 characters will be undone together.
1284 This is configurable, because there is some impact on typing performance."
1289 "Non-nil means TAB will automatically notice a table.el table.
1290 When it sees such a table, it moves point into it and - if necessary -
1291 calls `table-recognize-table'."
1296 "Options concerning links in Org-mode."
1301 "Buffer-local version of `org-link-abbrev-alist', which see.
1306 "Alist of link abbreviations.
1307 The car of each element is a string, to be replaced at the start of a link.
1309 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1311 [[linkkey:tag][description]]
1313 The 'linkkey' must be a word word, starting with a letter, followed
1314 by letters, numbers, '-' or '_'.
1316 If REPLACE is a string, the tag will simply be appended to create the link.
1319 be inserted at that point (see the function `url-hexify-string').
1321 REPLACE may also be a function that will be called with the tag as the
1322 only argument to create the link, which should be returned as a string.
1324 See the manual for examples."
1334 "Non-nil means Org will display descriptive links.
1335 E.g. [[http://orgmode.org][Org website]] will be displayed as
1337 description. When set to `nil', Org will display the full links
1338 literally.
1340 You can interactively set the value of this variable by calling
1341 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1346 "How the path name in file links should be stored.
1347 Valid values are:
1349 relative Relative to the current directory, i.e. the directory of the file
1350 into which the link is being inserted.
1351 absolute Absolute path, if possible with ~ for home directory.
1352 noabbrev Absolute path, no abbreviation of home directory.
1353 adaptive Use relative path for files in the current directory and sub-
1354 directories of it. For other files, use an absolute path."
1363 "Types of links that should be activated in Org-mode files.
1364 This is a list of symbols, each leading to the activation of a certain link
1365 type. In principle, it does not hurt to turn on most link types - there may
1366 be a small gain when turning off unused link types. The types are:
1368 bracket The recommended [[link][description]] or [[link]] links with hiding.
1369 angle Links in angular brackets that may contain whitespace like
1370 <bbdb:Carsten Dominik>.
1371 plain Plain links in normal text, no whitespace, like http://google.com.
1372 radio Text that is matched by a radio target, see manual for details.
1373 tag Tag settings in a headline (link to tag search).
1374 date Time stamps (link to calendar).
1375 footnote Footnote labels.
1377 Changing this variable requires a restart of Emacs to become effective."
1389 "Function to use to generate link descriptions from links.
1390 If nil the link location will be used. This function must take
1391 two parameters; the first is the link and the second the
1392 description `org-insert-link' has generated, and should return the
1393 description to use."
1398 "Options concerning storing links in Org-mode."
1403 "Format of the description part of a link to an email or usenet message.
1404 The following %-escapes will be replaced by corresponding information:
1412 %s subject
1413 %d date
1414 %m message-id.
1416 You may use normal field width specification between the % and the letter.
1417 This is for example useful to limit the length of the subject.
1431 It should match if the message is from the user him/herself."
1436 "Non-nil means storing a link to an Org file will use entry IDs.
1438 Note that before this variable is even considered, org-id must be loaded,
1439 so please customize `org-modules' and turn it on.
1441 The variable can have the following values:
1443 t Create an ID if needed to make a link to the current entry.
1445 create-if-interactive
1446 If `org-store-link' is called directly (interactively, as a user
1447 command), do create an ID to support the link. But when doing the
1448 job for remember, only use the ID if it already exists. The
1449 purpose of this setting is to avoid proliferation of unwanted
1450 IDs, just because you happen to be in an Org file when you
1451 call `org-remember' that automatically and preemptively
1452 creates a link. If you do want to get an ID link in a remember
1453 template to an entry not having an ID, create it first by
1454 explicitly creating a link to it, using `C-c C-l' first.
1456 create-if-interactive-and-no-custom-id
1457 Like create-if-interactive, but do not create an ID if there is
1458 a CUSTOM_ID property defined in the entry. This is the default.
1460 use-existing
1461 Use existing ID, do not create one.
1463 nil Never use an ID to make a link, instead link using a text search for
1464 the headline text."
1469 create-if-interactive)
1471 create-if-interactive-and-no-custom-id)
1476 "Non-nil means file links from `org-store-link' contain context.
1477 A search string will be added to the file name with :: as separator and
1478 used to find the context when the link is activated by the command
1479 `org-open-at-point'. When this option is t, the entire active region
1480 will be placed in the search string of the file link. If set to a
1481 positive integer, only the first n lines of context will be stored.
1484 negates this setting for the duration of the command."
1489 "Non-nil means keep link in list for entire session.
1491 The command `org-store-link' adds a link pointing to the current
1492 location to an internal list. These links accumulate during a session.
1493 The command `org-insert-link' can be used to insert links into any
1494 Org-mode file (offering completion for all stored links). When this
1496 will be removed from the list, to make completing the unused links
1497 more efficient."
1502 "Options concerning following links in Org-mode."
1507 "Function to translate links with different syntax to Org syntax.
1508 This can be used to translate links created for example by the Planner
1509 or emacs-wiki packages to Org syntax.
1510 The function must accept two parameters, a TYPE containing the link
1512 which is everything after the link protocol. It should return a cons
1513 with possibly modified values of type and path.
1514 Org contains a function for this, so if you set this variable to
1515 `org-translate-link-from-planner', you should be able follow many
1516 links created by planner."
1521 "Hook that is run after a link has been followed."
1526 "Non-nil means on links TAB will follow the link.
1527 Needs to be set before org.el is loaded.
1528 This really should not be used, it does not make sense, and the
1529 implementation is bad."
1534 "Non-nil means on links RET will follow the link."
1540 "Non-nil means mouse-1 on a link will follow the link.
1541 A longer mouse click will still set point. Does not work on XEmacs.
1542 Needs to be set before org.el is loaded."
1547 "Number of different positions to be recorded in the ring.
1548 Changing this requires a restart of Emacs to work correctly."
1553 "Non-nil means internal links in Org files must exactly match a headline.
1554 When nil, the link search tries to match a phrase with all words
1555 in the search text."
1562 query-to-create)))
1570 "Setup the frame configuration for following links.
1571 When following a link with Emacs, it may often be useful to display
1572 this link in another window or frame. This variable can be used to
1573 set this up for the different types of links.
1574 For VM, use any of
1575 `vm-visit-folder'
1576 `vm-visit-folder-other-window'
1577 `vm-visit-folder-other-frame'
1578 For Gnus, use any of
1579 `gnus'
1580 `gnus-other-frame'
1581 `org-gnus-no-new-news'
1582 For FILE, use any of
1583 `find-file'
1584 `find-file-other-window'
1585 `find-file-other-frame'
1586 For Wanderlust use any of
1587 `wl'
1588 `wl-other-frame'
1589 For the calendar, use the variable `calendar-setup'.
1590 For BBDB, it is currently only possible to display the matches in
1591 another window."
1615 "Non-nil means use indirect buffer to display infile links.
1616 Activating internal links (from one location in a file to another location
1617 in the same file) normally just jumps to the location. When the link is
1619 is displayed in
1620 another window. When this option is set, the other window actually displays
1621 an indirect buffer clone of the current buffer, to avoid any visibility
1622 changes to the current buffer."
1627 "Non-nil means `org-open-file' will open non-existing files.
1628 When nil, an error will be generated.
1629 This variable applies only to external applications because they
1630 might choke on non-existing files. If the link is to a file that
1631 will be opened in Emacs, the variable is ignored."
1636 "Non-nil means a link to a directory really means to index.org.
1637 When nil, following a directory link will run dired or open a finder/explorer
1638 window on that directory."
1643 "Function and arguments to call for following mailto links.
1644 This is a list with the first element being a Lisp function, and the
1645 remaining elements being arguments to the function. In string arguments,
1646 %a will be replaced by the address, and %s will be replaced by the subject
1647 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1656 "Non-nil means ask for confirmation before executing shell links.
1657 Shell links can be dangerous: just think about a link
1659 [[shell:rm -rf ~/*][Google Search]]
1662 but really it would remove your entire home directory.
1663 Therefore we advise against setting this variable to nil.
1664 Just change it to `y-or-n-p' if you want to confirm with a
1672 'safe-local-variable
1676 "A regexp to skip confirmation for shell links."
1682 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1683 Elisp links can be dangerous: just think about a link
1688 but really it would remove your entire home directory.
1689 Therefore we advise against setting this variable to nil.
1690 Just change it to `y-or-n-p' if you want to confirm with a
1698 'safe-local-variable
1702 "A regexp to skip confirmation for Elisp links."
1711 "Default file applications on a UNIX or GNU/Linux system.
1722 "Default file applications on a MacOS X system.
1724 for some files for which the OS does not have a good default.
1732 'mswindows-shell-execute
1737 'mswindows-shell-execute
1740 "Default file applications on a Windows NT system.
1745 '(
1750 )
1751 "External applications for opening `file:path' items in a document.
1752 Org-mode uses system defaults for different file types, but
1753 you can use this variable to set the application for a given file
1754 extension. The entries in this list are cons cells where the car identifies
1755 files and the cdr the corresponding command. Possible values for the
1756 file identifier are
1758 ways, depending on its contents:
1760 - Alphanumeric characters only:
1761 Match links with this file extension.
1763 to open PDFs with evince.
1765 - Regular expression: Match links where the
1766 filename matches the regexp. If you want to
1767 use groups here, use shy groups.
1771 to open *.html and *.xhtml with firefox.
1773 - Regular expression which contains (non-shy) groups:
1775 anything after that, matches the regexp.
1776 In a custom command string, %1, %2, etc. are replaced with
1777 the parts of the link that were matched by the groups.
1778 For backwards compatibility, if a command string is given
1779 that does not use any of the group matches, this case is
1780 handled identically to the second one (i.e. match against
1781 file name only).
1782 In a custom lisp form, you can access the group matches with
1783 (match-string n link).
1786 to open [[file:document.pdf::5]] with evince at page 5.
1788 `directory' Matches a directory
1789 `remote' Matches a remote file, accessible through tramp or efs.
1790 Remote files most likely should be visited through Emacs
1791 because external applications cannot handle such paths.
1792 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1793 so all files Emacs knows how to handle. Using this with
1794 command `emacs' will open most files in Emacs. Beware that this
1795 will also open html files inside Emacs, unless you add
1797 t Default for files not matched by any of the other options.
1798 `system' The system command to open files, like `open' on Windows
1799 and Mac OS X, and mailcap under GNU/Linux. This is the command
1800 that will be selected if you call `C-c C-o' with a double
1803 Possible values for the command are:
1804 `emacs' The file will be visited by the current Emacs process.
1805 `default' Use the default application for this file type, which is the
1806 association for t in the list, most likely in the system-specific
1807 part.
1808 This can be used to overrule an unwanted setting in the
1809 system-specific variable.
1811 This command is specified by the entry whose car is `system'.
1812 Most likely, the system-specific version of this variable
1813 does define this command, but you can overrule/replace it
1814 here.
1815 string A command to be executed by a shell; %s will be replaced
1816 by the path to the file.
1817 sexp A Lisp form which will be evaluated. The file path will
1818 be available in the Lisp variable `file'.
1819 For more examples, see the system specific constants
1820 `org-file-apps-defaults-macosx'
1821 `org-file-apps-defaults-windowsnt'
1822 `org-file-apps-defaults-gnu'."
1832 auto-mode))
1843 "Options concerning refiling entries in Org-mode."
1848 "Directory with org files.
1849 This is just a default location to look for Org files. There is no need
1850 at all to put your files into this directory. It is only used in the
1851 following situations:
1853 1. When a remember template specifies a target file that is not an
1854 absolute path. The path will then be interpreted relative to
1855 `org-directory'
1856 2. When a remember note is filed away in an interactive way (when exiting the
1857 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1858 with `org-directory' as the default path."
1864 "Default target for storing notes.
1865 Used as a fall back file for org-remember.el and org-capture.el, for
1866 templates that do not specify a target file."
1871 file))
1874 "The default interface to be used for `org-goto'.
1875 Allowed values are:
1876 outline The interface shows an outline of the relevant file
1877 and the correct heading is found by moving through
1878 the outline or by searching with incremental search.
1879 outline-path-completion Headlines in the current buffer are offered via
1880 completion. This is the interface also used by
1881 the refile command."
1888 "Maximum target level when running `org-goto' with refile interface."
1893 "Non-nil means store new notes at the beginning of a file or entry.
1894 When nil, new notes will be filed to the end of a file or entry.
1895 This can also be a list with cons cells of regular expressions that
1896 are matched against file names, and values."
1906 "Information to record when a task is refiled.
1908 Possible values are:
1910 nil Don't add anything
1911 time Add a time stamp to the task
1912 note Prompt for a note and add it with template `org-log-note-headings'
1914 This option can also be set with on a per-file-basis with
1916 #+STARTUP: nologrefile
1917 #+STARTUP: logrefile
1918 #+STARTUP: lognoterefile
1920 You can have local logging settings for a subtree by setting the LOGGING
1921 property to one or more of these keywords.
1923 When bulk-refiling from the agenda, the value `note' is forbidden and
1924 will temporarily be changed to `time'."
1935 This is a list of cons cells. Each cell contains:
1936 - a specification of the files to be considered, either a list of files,
1937 or a symbol whose function or variable value will be used to retrieve
1938 a file name or a list of file names. If you use `org-agenda-files' for
1939 that, all agenda files will be scanned for targets. Nil means consider
1940 headings in the current buffer.
1941 - A specification of how to find candidate refile targets. This may be
1942 any of:
1944 This tag has to be present in all target headlines, inheritance will
1945 not be considered.
1947 todo keyword.
1949 headlines that are refiling targets.
1950 - a cons cell (:level . N). Any headline of level N is considered a target.
1951 Note that, when `org-odd-levels-only' is set, level corresponds to
1952 order in hierarchy, not to the number of stars.
1953 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1954 Note that, when `org-odd-levels-only' is set, level corresponds to
1955 order in hierarchy, not to the number of stars.
1957 Each element of this list generates a set of possible targets.
1958 The union of these sets is presented (with completion) to
1959 the user by `org-refile'.
1961 You can set the variable `org-refile-target-verify-function' to a function
1962 to verify each headline found by the simple criteria above.
1964 When this variable is nil, all top-level headlines in the current buffer
1965 are used, equivalent to the value `((nil . (:level . 1))'."
1981 "Function to verify if the headline at point should be a refile target.
1982 The function will be called without arguments, with point at the
1983 beginning of the headline. It should return t and leave point
1984 where it is if the headline is a valid target for refiling.
1986 If the target should not be selected, the function must return nil.
1987 In addition to this, it may move point to a place from where the search
1988 should be continued. For example, the function may decide that the entire
1989 subtree of the current entry should be excluded and move point to the end
1990 of the subtree."
1995 "Non-nil means cache refile targets to speed up the process.
1996 The cache for a particular file will be updated automatically when
1997 the buffer has been killed, or when any of the marker used for flagging
1998 refile targets no longer points at a live buffer.
1999 If you have added new entries to a buffer that might themselves be targets,
2000 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2001 find that easier, `C-u C-u C-u C-c C-w'."
2007 "Non-nil means provide refile targets as paths.
2008 So a level 3 headline will be available as level1/level2/level3.
2010 When the value is `file', also include the file name (without directory)
2011 into the path. In this case, you can also stop the completion after
2012 the file name, to get entries inserted as top level in the file.
2014 When `full-file-path', include the full file path."
2023 "Non-nil means complete the outline path in hierarchical steps.
2024 When Org-mode uses the refile interface to select an outline path
2025 \(see variable `org-refile-use-outline-path'), the completion of
2026 the path can be done is a single go, or if can be done in steps down
2027 the headline hierarchy. Going in steps is probably the best if you
2028 do not use a special completion package like `ido' or `icicles'.
2029 However, when using these packages, going in one step can be very
2030 fast, while still showing the whole path to the entry."
2035 "Non-nil means allow to create new nodes as refile targets.
2037 of an existing node. When the value of this variable is `confirm',
2038 new node creation must be confirmed by the user (recommended)
2039 When nil, the completion must match an existing entry.
2041 Note that, if the new heading is not seen by the criteria
2042 listed in `org-refile-targets', multiple instances of the same
2043 heading would be created by trying again to file under the new
2044 heading."
2052 "Non-nil means also refile active region within a subtree.
2054 By default `org-refile' doesn't allow refiling regions if they
2055 don't contain a set of subtrees, but it might be convenient to
2056 do so sometimes: in that case, the first line of the region is
2057 converted to a headline before refiling."
2063 "Options concerning TODO items in Org-mode."
2068 "Options concerning Progress logging in Org-mode."
2075 "The available interpretation symbols for customizing `org-todo-keywords'.
2079 "List of TODO entry keyword sequences and their interpretation.
2082 Each sequence starts with a symbol, either `sequence' or `type',
2083 indicating if the keywords should be interpreted as a sequence of
2084 action steps, or as different types of TODO items. The first
2085 keywords are states requiring action - these states will select a headline
2086 for inclusion into the global TODO list Org-mode produces. If one of
2089 the last keyword is treated as the only DONE state of the sequence.
2092 additional state where no keyword is present. For details about this
2093 cycling, see the manual.
2095 TODO keywords and interpretation can also be set on a per-file basis with
2096 the special #+SEQ_TODO and #+TYP_TODO lines.
2098 Each keyword can optionally specify a character for fast state selection
2099 \(in combination with the variable `org-use-fast-todo-selection')
2100 and specifiers for state change logging, using the same syntax
2103 indicates to record a time stamp each time this state is selected.
2105 Each keyword may also specify if a timestamp or a note should be
2106 recorded when entering or leaving the state, by adding additional
2107 characters in the parenthesis after the keyword. This looks like this:
2109 record only the time of the state change. With X and Y being either
2111 Y when leaving the state if and only if the *target* state does not
2112 define X. You may omit any of the fast-selection key or X or /Y,
2113 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2115 For backward compatibility, this variable may also be just a list
2116 of keywords - in this case the interpretation (sequence or type) will be
2117 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2127 ;;Quick and dirty way to see
2128 ;;`org-todo-interpretations'. This takes the
2129 ;;place of item arguments
2130 :convert-widget
2137 org-todo-interpretation-widgets))
2138 widget))
2169 "Controls how TODO keywords are interpreted.
2170 This variable is in principle obsolete and is only used for
2171 backward compatibility, if the interpretation of todo keywords is
2172 not given already in `org-todo-keywords'. See that variable for
2173 more information."
2180 "Non-nil means use the fast todo selection scheme with C-c C-t.
2181 This variable describes if and under what circumstances the cycling
2182 mechanism for TODO keywords will be replaced by a single-key, direct
2183 selection scheme.
2185 When nil, fast selection is never used.
2187 When the symbol `prefix', it will be used when `org-todo' is called with
2188 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2189 in an agenda buffer.
2191 When t, fast selection is used by default. In this case, the prefix
2192 argument forces cycling instead.
2194 In all cases, the special interface is only used if access keys have actually
2195 been assigned by the user, i.e. if keywords in the configuration are followed
2196 by a letter in parenthesis, like TODO(t)."
2204 "Non-nil means update todo statistics after insert and toggle.
2205 ALL-HEADLINES means update todo statistics by including headlines
2206 with no TODO keyword as well, counting them as not done.
2207 A list of TODO keywords means the same, but skip keywords that are
2208 not in this list.
2210 When this is set, todo statistics is updated in the parent of the
2211 current entry each time a todo state is changed."
2221 "Non-nil means TODO statistics covers just direct children.
2222 When nil, all entries in the subtree are considered.
2223 This has only an effect if `org-provide-todo-statistics' is set.
2224 To set this to nil for only a single subtree, use a COOKIE_DATA
2230 "Hook which is run after the state of a TODO item was changed.
2231 The new state (a string with a TODO keyword, or nil) is available in the
2232 Lisp variable `state'."
2237 "Hook for functions that are allowed to block a state change.
2239 Each function gets as its single argument a property list, see
2240 `org-trigger-hook' for more information about this list.
2242 If any of the functions in this hook returns nil, the state change
2246 "Hook for functions that are triggered by a state change.
2248 Each function gets as its single argument a property list with at least
2249 the following elements:
2251 (:type type-of-change :position pos-at-entry-start
2252 :from old-state :to new-state)
2254 Depending on the type, more properties may be present.
2256 This mechanism is currently implemented for:
2258 TODO state changes
2259 ------------------
2260 :type todo-state-change
2261 :from previous state (keyword as a string), or nil, or a symbol
2262 'todo' or 'done', to indicate the general type of state.
2266 "Non-nil means undone TODO entries will block switching the parent to DONE.
2267 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2268 be blocked if any prior sibling is not yet done.
2269 Finally, if the parent is blocked because of ordered siblings of its own,
2270 the child will also be blocked.
2271 This variable needs to be set before org.el is loaded, and you need to
2272 restart Emacs after a change to make the change effective. The only way
2273 to change is while Emacs is running is through the customize interface."
2285 "Non-nil means unchecked boxes will block switching the parent to DONE.
2286 When this is nil, checkboxes have no influence on switching TODO states.
2287 When non-nil, you first need to check off all check boxes before the TODO
2288 entry can be switched to DONE.
2289 This variable needs to be set before org.el is loaded, and you need to
2290 restart Emacs after a change to make the change effective. The only way
2291 to change is while Emacs is running is through the customize interface."
2303 "Non-nil means inserting a TODO heading is treated as state change.
2305 logging will apply if appropriate. When nil, the new TODO item will
2306 be inserted directly, and no logging will take place."
2311 "Non-nil means switching TODO states with S-cursor counts as state change.
2312 This is the default behavior. However, setting this to nil allows a
2313 convenient way to select a TODO state and bypass any logging associated
2314 with that."
2319 "Tag changes that should be triggered by TODO state changes.
2320 This is a list. Each entry is
2322 (state-change (tag . flag) .......)
2324 State-change can be a string with a state, and empty string to indicate the
2325 state that has no TODO keyword, or it can be one of the symbols `todo'
2326 or `done', meaning any not-done or done state, respectively."
2340 "Information to record when a task moves to the DONE state.
2342 Possible values are:
2344 nil Don't add anything, just change the keyword
2345 time Add a time stamp to the task
2346 note Prompt for a note and add it with template `org-log-note-headings'
2348 This option can also be set with on a per-file-basis with
2350 #+STARTUP: nologdone
2351 #+STARTUP: logdone
2352 #+STARTUP: lognotedone
2354 You can have local logging settings for a subtree by setting the LOGGING
2355 property to one or more of these keywords."
2363 ;; Normalize old uses of org-log-done.
2370 "Information to record when the scheduling date of a tasks is modified.
2372 Possible values are:
2374 nil Don't add anything, just change the date
2375 time Add a time stamp to the task
2376 note Prompt for a note and add it with template `org-log-note-headings'
2378 This option can also be set with on a per-file-basis with
2380 #+STARTUP: nologreschedule
2381 #+STARTUP: logreschedule
2382 #+STARTUP: lognotereschedule"
2391 "Information to record when the deadline date of a tasks is modified.
2393 Possible values are:
2395 nil Don't add anything, just change the date
2396 time Add a time stamp to the task
2397 note Prompt for a note and add it with template `org-log-note-headings'
2399 This option can also be set with on a per-file-basis with
2401 #+STARTUP: nologredeadline
2402 #+STARTUP: logredeadline
2403 #+STARTUP: lognoteredeadline
2405 You can have local logging settings for a subtree by setting the LOGGING
2406 property to one or more of these keywords."
2415 "Non-nil means record a note when clocking out of an item.
2416 This can also be configured on a per-file basis by adding one of
2417 the following lines anywhere in the buffer:
2419 #+STARTUP: lognoteclock-out
2420 #+STARTUP: nolognoteclock-out"
2426 "Non-nil means the CLOSED time stamp will contain date and time.
2427 When nil, only the date will be recorded."
2441 "Headings for notes added to entries.
2442 The value is an alist, with the car being a symbol indicating the note
2443 context, and the cdr is the heading to be used. The heading may also be the
2444 empty string.
2445 %t in the heading will be replaced by a time stamp.
2446 %T will be an active time stamp instead the default inactive one
2447 %d will be replaced by a short-format time stamp.
2448 %D will be replaced by an active short-format time stamp.
2449 %s will be replaced by the new TODO state, in double quotes.
2450 %S will be replaced by the old TODO state, in double quotes.
2451 %u will be replaced by the user name.
2452 %U will be replaced by the full user name.
2454 In fact, it is not a good idea to change the `state' entry, because
2455 agenda log mode depends on the format of these entries."
2461 "Heading when changing todo state (todo sequence only)"
2475 "Non-nil means insert state change notes and time stamps into a drawer.
2476 When nil, state changes notes will be inserted after the headline and
2477 any scheduling and clock lines, but not inside a drawer.
2479 The value of this variable should be the name of the drawer to use.
2480 LOGBOOK is proposed as the default drawer for this purpose, you can
2481 also set this to a string to define the drawer of your choice.
2485 If this variable is set, `org-log-state-notes-insert-after-drawers'
2486 will be ignored.
2488 You can set the property LOG_INTO_DRAWER to overrule this setting for
2489 a subtree."
2501 "Return the value of `org-log-into-drawer', but let properties overrule.
2502 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2503 used instead of the default value."
2511 "Non-nil means insert state change notes after any drawers in entry.
2512 Only the drawers that *immediately* follow the headline and the
2513 deadline/scheduled line are skipped.
2514 When nil, insert notes right after the heading and perhaps the line
2515 with deadline/scheduling if present.
2517 This variable will have no effect if `org-log-into-drawer' is
2518 set."
2524 "Non-nil means the latest state note will be directly after heading.
2525 When nil, the state change notes will be ordered according to time."
2531 "The TODO state to which a repeater should return the repeating task.
2532 By default this is the first task in a TODO sequence, or the previous state
2533 in a TODO_TYP set. But you can specify another task here.
2534 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2541 "Non-nil means record moving through the DONE state when triggering repeat.
2542 An auto-repeating task is immediately switched back to TODO when
2545 record a closing note, there will be no record of the task moving
2546 through DONE. This variable forces taking a note anyway.
2548 nil Don't force a record
2549 time Record a time stamp
2550 note Record a note
2552 This option can also be set with on a per-file-basis with
2554 #+STARTUP: logrepeat
2555 #+STARTUP: lognoterepeat
2556 #+STARTUP: nologrepeat
2558 You can have local logging settings for a subtree by setting the LOGGING
2559 property to one or more of these keywords."
2569 "Priorities in Org-mode."
2574 "Non-nil means priority commands are active.
2575 When nil, these commands will be disabled, so that you never accidentally
2576 set a priority."
2581 "The highest priority of TODO items. A character like ?A, ?B etc.
2582 Must have a smaller ASCII number than `org-lowest-priority'."
2587 "The lowest priority of TODO items. A character like ?A, ?B etc.
2588 Must have a larger ASCII number than `org-highest-priority'."
2593 "The default priority of TODO items.
2594 This is the priority an item gets if no explicit priority is given.
2595 When starting to cycle on an empty priority the first step in the cycle
2596 depends on `org-priority-start-cycle-with-default'. The resulting first
2597 step priority must not exceed the range from `org-highest-priority' to
2598 `org-lowest-priority' which means that `org-default-priority' has to be
2599 in this range exclusive or inclusive the range boundaries. Else the
2600 first step refuses to set the default and the second will fall back
2601 to (depending on the command used) the highest or lowest priority."
2606 "Non-nil means start with default priority when starting to cycle.
2607 When this is nil, the first step in the cycle will be (depending on the
2608 command used) one higher or lower than the default priority.
2609 See also `org-default-priority'."
2614 "Function to extract the priority from a string.
2615 The string is normally the headline. If this is nil Org computes the
2616 priority from the priority cookie like [#A] in the headline. It returns
2617 an integer, increasing by 1000 for each priority level.
2618 The user can set a different function here, which should take a string
2619 as an argument and return the numeric priority."
2625 "Options concerning time stamps and deadlines in Org-mode."
2630 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2631 When nil, these labeled time stamps are forces into the second line of an
2632 entry, just after the headline. When scheduling from the global TODO list,
2633 the time stamp will always be forced into the second line."
2638 "Formats for `format-time-string' which are used for time stamps.
2642 "Number of minutes to round time stamps to.
2643 These are two values, the first applies when first creating a time stamp.
2644 The second applies when changing it with the commands `S-up' and `S-down'.
2645 When changing the time stamp, this means that it will change in steps
2646 of N minutes, as given by the second value.
2648 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2649 numbers should be factors of 60, so for example 5, 10, 15.
2651 When this is larger than 1, you can still force an exact time stamp by using
2652 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2653 and by using a prefix arg to `S-up/down' to specify the exact number
2654 of minutes to shift."
2664 ;; Normalize old customizations of this variable.
2668 org-time-stamp-rounding-minutes)))
2671 "Non-nil means overlay custom formats over all time stamps.
2672 The formats are defined through the variable `org-time-stamp-custom-formats'.
2673 To turn this on on a per-file basis, insert anywhere in the file:
2674 #+STARTUP: customtime"
2682 "Custom formats for time stamps. See `format-time-string' for the syntax.
2683 These are overlaid over the default ISO format if the variable
2684 `org-display-custom-times' is set. Time like %H:%M should be at the
2685 end of the second format. The custom formats are also honored by export
2686 commands, if custom time display is turned on at the time of export."
2691 "Get the right format for a time string."
2696 f)))
2699 "The format string used when creating CLOCKSUM lines.
2700 This is also used when org-mode generates a time duration."
2706 org-mode generates a time duration."
2711 "The format string used when creating CLOCKSUM lines, or when
2712 org-mode generates a time duration."
2717 "No. of days before expiration during which a deadline becomes active.
2718 This variable governs the display in sparse trees and in the agenda.
2719 When 0 or negative, it means use this number (the absolute value of it)
2720 even if a deadline has a different individual lead time specified.
2722 Custom commands can set this variable in the options section."
2728 "Non-nil means assume future for incomplete date input from user.
2729 This affects the following situations:
2730 1. The user gives a month but not a year.
2733 2. The user gives a day, but no month.
2736 it will be considered as *this* month.
2738 If you set this variable to the symbol `time', then also the following
2739 will work:
2741 3. If the user gives a time, but no day. If the time is before now,
2742 to will be interpreted as tomorrow.
2744 Currently none of this works for ISO week specifications.
2746 When this option is nil, the current day, month and year will always be
2747 used as defaults.
2749 See also `org-agenda-jump-prefer-future'."
2757 "Should the agenda jump command prefer the future for incomplete dates?
2758 The default is to do the same as configured in `org-read-date-prefer-future'.
2759 But you can also set a deviating value here.
2760 This may t or nil, or the symbol `org-read-date-prefer-future'."
2766 org-read-date-prefer-future)
2771 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2773 Depending on the system Emacs is running on, certain dates cannot
2774 be represented with the type used internally to represent time.
2775 Dates between 1970-1-1 and 2038-1-1 can always be represented
2776 correctly. Some systems allow for earlier dates, some for later,
2777 some for both. One way to find out it to insert any date into an
2778 Org buffer, putting the cursor on the year and hitting S-up and
2779 S-down to test the range.
2781 When this variable is set to t, the date/time prompt will not let
2782 you specify dates outside the 1970-2037 range, so it is certain that
2783 these dates will work in whatever version of Emacs you are
2784 running, and also that you can move a file from one Emacs implementation
2785 to another. WHenever Org is forcing the year for you, it will display
2786 a message and beep.
2788 When this variable is nil, Org will check if the date is
2789 representable in the specific Emacs implementation you are using.
2790 If not, it will force a year, usually the current year, and beep
2791 to remind you. Currently this setting is not recommended because
2792 the likelihood that you will open your Org files in an Emacs that
2793 has limited date range is not negligible.
2795 A workaround for this problem is to use diary sexp dates for time
2796 stamps outside of this range."
2802 "Non-nil means display current interpretation of date prompt live.
2803 This display will be in an overlay, in the minibuffer."
2808 "Non-nil means pop up a calendar when prompting for a date.
2809 In the calendar, the date can be selected with mouse-1. However, the
2810 minibuffer will also be active, and you can simply enter the date as well.
2811 When nil, only the minibuffer will be available."
2819 "Hook to be used to set up keys for the date/time interface.
2820 Add key definitions to `minibuffer-local-map', which will be a temporary
2821 copy."
2826 "The hour when your day really ends. Must be an integer.
2827 This has influence for the following applications:
2829 the time given here, the day recognized as TODAY is actually yesterday.
2830 - When a date is read from the user and it is still before the time given
2831 here, the current date and time will be assumed to be yesterday, 23:59.
2832 Also, timestamps inserted in remember templates follow this rule.
2834 IMPORTANT: This is a feature whose implementation is and likely will
2835 remain incomplete. Really, it is only here because past midnight seems to
2836 be the favorite working time of John Wiegley :-)"
2841 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2842 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2844 23:59 of the previous day."
2850 "Non-nil means S-down will increase the time in a time stamp.
2851 When nil, S-up will increase."
2856 "Non-nil means make the calendar window follow timestamp changes.
2857 When a timestamp is modified and the calendar window is visible, it will be
2858 moved to the new date."
2863 "Options concerning tags in Org-mode."
2868 "List of tags allowed in Org-mode files.
2869 When this list is nil, Org-mode will base TAG input on what is already in the
2870 buffer.
2871 The value of this variable is an alist, the car of each entry must be a
2872 keyword as a string, the cdr may be a character that is used to select
2873 that tag through the fast-tag-selection interface.
2874 See the manual for details."
2889 "List of tags that will always appear in all Org-mode files.
2890 This is in addition to any in buffer settings or customizations
2891 of `org-tag-alist'.
2892 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2893 The value of this variable is an alist, the car of each entry must be a
2894 keyword as a string, the cdr may be a character that is used to select
2895 that tag through the fast-tag-selection interface.
2896 See the manual for details.
2897 To disable these tags on a per-file basis, insert anywhere in the file:
2898 #+STARTUP: noptag"
2909 "If non-nil, always offer completion for all tags of all agenda files.
2910 Instead of customizing this variable directly, you might want to
2911 set it locally for capture buffers, because there no list of
2912 tags in that file can be created dynamically (there are none).
2914 (add-hook 'org-capture-mode-hook
2915 (lambda ()
2916 (set (make-local-variable
2917 'org-complete-tags-always-offer-all-agenda-tags)
2918 t)))"
2924 "List of tags that can be inherited by all entries in the file.
2925 The tags will be inherited if the variable `org-use-tag-inheritance'
2926 says they should be.
2930 "Non-nil means use fast tag selection scheme.
2931 This is a special interface to select and deselect tags with single keys.
2932 When nil, fast selection is never used.
2933 When the symbol `auto', fast selection is used if and only if selection
2934 characters for tags have been configured, either through the variable
2935 `org-tag-alist' or through a #+TAGS line in the buffer.
2936 When t, fast selection is always used and selection keys are assigned
2937 automatically if necessary."
2945 "Non-nil means fast tag selection exits after first change.
2946 When nil, you have to press RET to exit it.
2947 During fast tag selection, you can toggle this flag with `C-c'.
2948 This variable can also have the value `expert'. In this case, the window
2949 displaying the tags menu is not even shown, until you press C-c again."
2957 "Non-nil means fast tags selection interface will also offer TODO states.
2961 "The column to which tags should be indented in a headline.
2962 If this number is positive, it specifies the column. If it is negative,
2963 it means that the tags should be flushright to that column. For example,
2964 -80 works well for a normal 80 character screen.
2965 When 0, place tags directly after headline text, with only one space in
2966 between."
2971 "Non-nil keeps tags aligned when modifying headlines.
2972 Some operations (i.e. demoting) change the length of a headline and
2973 therefore shift the tags around. With this option turned on, after
2974 each such operation the tags are again aligned to `org-tags-column'."
2979 "Non-nil means tags in levels apply also for sublevels.
2980 When nil, only the tags directly given in a specific line apply there.
2981 This may also be a list of tags that should be inherited, or a regexp that
2982 matches tags that should be inherited. Additional control is possible
2983 with the variable `org-tags-exclude-from-inheritance' which gives an
2984 explicit list of tags to be excluded from inheritance., even if the value of
2985 `org-use-tag-inheritance' would select it for inheritance.
2987 If this option is t, a match early-on in a tree can lead to a large
2988 number of matches in the subtree when constructing the agenda or creating
2989 a sparse tree. If you only want to see the first match in a tree during
2990 a search, check out the variable `org-tags-match-list-sublevels'."
2999 "List of tags that should never be inherited.
3000 This is a way to exclude a few tags from inheritance. For way to do
3001 the opposite, to actively allow inheritance for selected tags,
3002 see the variable `org-use-tag-inheritance'."
3007 "Check if TAG is one that should be inherited."
3019 "Non-nil means list also sublevels of headlines matching a search.
3020 This variable applies to tags/property searches, and also to stuck
3021 projects because this search is based on a tags match as well.
3023 When set to the symbol `indented', sublevels are indented with
3024 leading dots.
3026 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3027 the sublevels of a headline matching a tag search often also match
3028 the same search. Listing all of them can create very long lists.
3029 Setting this variable to nil causes subtrees of a match to be skipped.
3031 This variable is semi-obsolete and probably should always be true. It
3032 is better to limit inheritance to certain tags using the variables
3033 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3041 "When set, tags are sorted using this function as a comparator."
3057 "Options concerning properties in Org-mode."
3062 "How property key/value pairs should be formatted by `indent-line'.
3063 When `indent-line' hits a property definition, it will format the line
3064 according to this format, mainly to make sure that the values are
3065 lined-up with respect to each other."
3070 "Alist of properties and functions to adjust inserted values.
3071 Elements of this alist must be of the form
3073 ([string] [function])
3075 where [string] must be a property name and [function] must be a
3076 lambda expression: this lambda expression must take one argument,
3077 the value to adjust, and return the new value as a string.
3081 and the clock summary:
3084 (let ((clocksum (org-clock-sum-current-item))
3085 (effort (org-duration-string-to-minutes
3087 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3093 "Non-nil means properties apply also for sublevels.
3095 This setting is chiefly used during property searches. Turning it on can
3096 cause significant overhead when doing a search, which is why it is not
3097 on by default.
3099 When nil, only the properties directly given in the current entry count.
3100 When t, every property is inherited. The value may also be a list of
3101 properties that should have inheritance, or a regular expression matching
3102 properties that should be inherited.
3104 However, note that some special properties use inheritance under special
3105 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3107 for valid values of a property.
3109 Note for programmers:
3110 When querying an entry with `org-entry-get', you can control if inheritance
3111 should be used. By default, `org-entry-get' looks only at the local
3112 properties. You can request inheritance by setting the inherit argument
3113 to t (to force inheritance) or to `selective' (to respect the setting
3114 in this variable)."
3123 "Check if PROPERTY is one that should be inherited."
3134 "The default column format, if no other format has been defined.
3135 This variable can be set on the per-file basis by inserting a line
3137 #+COLUMNS: %25ITEM ....."
3142 "The ellipses to be used when a field in column view is truncated.
3143 When this is the empty string, as many characters as possible are shown,
3144 but then there will be no visual indication that the field has been truncated.
3145 When this is a string of length N, the last N characters of a truncated
3146 field are replaced by this string. If the column is narrower than the
3147 ellipses string, only part of the ellipses string will be shown."
3152 "Function that modifies values for display in column view.
3153 For example, it can be used to cut out a certain part from a time stamp.
3154 The function must take 2 arguments:
3156 column-title The title of the column (*not* the property name)
3157 value The value that should be modified.
3159 The function should return the value that should be displayed,
3160 or nil if the normal value should be used."
3165 "The property that is being used to keep track of effort estimates.
3166 Effort estimates given in this property need to have the format H:MM."
3174 "List of property/value pairs that can be inherited by any entry.
3176 These are fixed values, for the preset properties. The user variable
3177 that can be used to add to this list is `org-global-properties'.
3179 The entries in this list are cons cells where the car is a property
3180 name and cdr is a string with the value. If the value represents
3185 "List of property/value pairs that can be inherited by any entry.
3187 This list will be combined with the constant `org-global-properties-fixed'.
3189 The entries in this list are cons cells where the car is a property
3190 name and cdr is a string with the value.
3192 You can set buffer-local values for the same purpose in the variable
3193 `org-file-properties' this by adding lines like
3195 #+PROPERTY: NAME VALUE"
3202 "List of property/value pairs that can be inherited by any entry.
3203 Valid for the current buffer.
3208 "Options concerning agenda views in Org-mode."
3213 "Variable used by org files to set a category for agenda display.
3214 Such files should use a file variable to set it, for example
3218 or contain a special line
3220 #+CATEGORY: ELisp
3222 If the file does not specify a category, then file's base name
3228 "The files to be used for agenda display.
3232 If an entry is a directory, all files in that directory that are matched by
3233 `org-agenda-file-regexp' will be part of the file list.
3235 If the value of the variable is not a list but a single file name, then
3236 the list of agenda files is actually stored and maintained in that file, one
3237 agenda file per line. In this file paths can be given relative to
3238 `org-directory'. Tilde expansion and environment variable substitution
3239 are also made."
3246 "Regular expression to match files for `org-agenda-files'.
3247 If any element in the list in that variable contains a directory instead
3248 of a normal file, all files in that directory that are matched by this
3249 regular expression will be included."
3254 "List of extra files to be searched by text search commands.
3255 These files will be search in addition to the agenda files by the
3256 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3257 Note that these files will only be searched for text search commands,
3258 not for the other agenda views like todo lists, tag searches or the weekly
3259 agenda. This variable is intended to list notes and possibly archive files
3260 that should also be searched by these two commands.
3261 In fact, if the first element in the list is the symbol `agenda-archives',
3262 than all archive files of all agenda files will be added to the search
3263 scope."
3274 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3275 A nil value means to remove them, after a query, from the list."
3280 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3281 The command `org-calendar-goto-agenda' will be bound to this key. The
3282 default is the character `c' because then `c' can be used to switch back and
3283 forth between agenda and calendar."
3288 "The key to be installed in `calendar-mode-map' for agenda-action.
3289 The command `org-agenda-action' will be bound to this key. The
3290 default is the character `k' because we use the same key in the agenda."
3295 "The key to be installed in `calendar-mode-map' for adding diary entries.
3296 This option is irrelevant until `org-agenda-diary-file' has been configured
3297 to point to an Org-mode file. When that is the case, the command
3298 `org-agenda-diary-entry' will be bound to the key given here, by default
3299 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3300 if you want to continue doing this, you need to change this to a different
3301 key."
3306 "File to which to add new entries with the `i' key in agenda and calendar.
3307 When this is the symbol `diary-file', the functionality in the Emacs
3308 calendar will be used to add entries to the `diary-file'. But when this
3309 points to a file, `org-agenda-diary-entry' will be used instead."
3325 org-calendar-insert-diary-entry-key
3329 "Options for embedding LaTeX code into Org-mode."
3337 "Options for creating images from LaTeX fragments.
3338 This is a property list with the following properties:
3340 `default' means use the foreground of the default face.
3342 `default' means use the background of the default face.
3343 :scale a scaling factor for the size of the images, to get more pixels
3344 :html-foreground, :html-background, :html-scale
3345 the same numbers for HTML export.
3346 :matchers a list indicating which matchers should be used to
3347 find LaTeX fragments. Valid members of this list are:
3358 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3359 When nil, just push out a message."
3366 Use this to specify additional executable file say a jar file.
3368 When using MathToWeb as the converter, specify the full-path to
3369 your mathtoweb.jar file."
3377 "Command to convert LaTeX fragments to MathML.
3378 Replace format-specifiers in the command as noted below and use
3379 `shell-command' to convert LaTeX to MathML.
3380 %j: Executable file in fully expanded form as specified by
3381 `org-latex-to-mathml-jar-file'.
3382 %I: Input LaTeX file in fully expanded form
3383 %o: Output MathML file
3384 This command is used by `org-create-math-formula'.
3386 When using MathToWeb as the converter, set this to
3395 "Return t if `org-latex-to-mathml-convert-command' is usable."
3398 org-latex-to-mathml-convert-command)
3400 org-latex-to-mathml-convert-command))))
3405 t))))))
3412 \[PACKAGES]
3413 \[DEFAULT-PACKAGES]
3414 % The settings below are copied from fullpage.sty
3427 "The document header used for processing LaTeX fragments.
3428 It is imperative that this header make sure that no page number
3429 appears on the page. The package defined in the variables
3430 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3432 will be appended."
3439 "Set the packages alist and make sure it has 3 elements per entry."
3443 x))
3444 val)))
3448 "Get the packages alist and make sure it has 3 elements per entry."
3452 x))
3455 ;; The following variables are defined here because is it also used
3456 ;; when formatting latex fragments. Originally it was part of the
3457 ;; LaTeX exporter, which is why the name includes "export".
3474 )
3475 "Alist of default packages to be inserted in the header.
3476 Change this only if one of the packages here causes an incompatibility
3477 with another package you are using.
3478 The packages in this list are needed by one part or another of Org-mode
3479 to function properly.
3481 - inputenc, fontenc: for basic font and character selection
3482 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3483 for interpreting the entities in `org-entities'. You can skip some of these
3484 packages if you don't use any of the symbols in it.
3485 - graphicx: for including images
3486 - float, wrapfig: for figure placement
3487 - longtable: for long tables
3488 - hyperref: for cross references
3490 Therefore you should not modify this variable unless you know what you
3491 are doing. The one reason to change it anyway is that you might be loading
3492 some other package that conflicts with one of the default packages.
3494 If SNIPPET-FLAG is t, the package also needs to be included when
3495 compiling LaTeX snippets into images for inclusion into HTML."
3509 "Alist of packages to be inserted in every LaTeX header.
3510 These will be inserted after `org-export-latex-default-packages-alist'.
3512 SNIPPET-FLAG, when t, indicates that this package is also needed when
3513 turning LaTeX snippets into images for inclusion into HTML.
3514 Make sure that you only list packages here which:
3515 - you want in every file
3516 - do not conflict with the default packages in
3517 `org-export-latex-default-packages-alist'
3518 - do not conflict with the setup in `org-format-latex-header'."
3532 "Settings for Org-mode appearance."
3537 "Non-nil means fontify only the stars in each headline.
3538 When nil, the entire headline is fontified.
3539 Changing it requires restart of `font-lock-mode' to become effective
3540 also in regions already fontified."
3545 "Non-nil means hide the first N-1 stars in a headline.
3546 This works by using the face `org-hide' for these stars. This
3547 face is white for a light background, and black for a dark
3548 background. You may have to customize the face `org-hide' to
3549 make this work.
3550 Changing it requires restart of `font-lock-mode' to become effective
3551 also in regions already fontified.
3552 You may also set this on a per-file basis by adding one of the following
3553 lines to the buffer:
3555 #+STARTUP: hidestars
3556 #+STARTUP: showstars"
3561 "List of symbols corresponding to keywords to be hidden the org buffer.
3562 For example, a value '(title) for this list will make the document's title
3563 appear in the buffer without the initial #+TITLE: keyword."
3572 "Non-nil means change the face of a headline if it is marked DONE.
3573 Normally, only the TODO/DONE keyword indicates the state of a headline.
3574 When this is non-nil, the headline after the keyword is set to the
3575 `org-headline-done' as an additional indication."
3580 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3581 Changing this variable requires a restart of Emacs to take effect."
3586 "Non-nil means fontify the whole line for headings.
3587 This is useful when setting a background color for the
3588 org-level-* faces."
3593 "Non-nil means fontify what is treated specially by the exporters."
3598 "Non-nil mean font-lock should hide the emphasis marker characters."
3603 "Non-nil means show entities as UTF8 characters.
3610 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3616 "Regular expression for matching emphasis.
3617 After a match, the match groups contain these elements:
3618 0 The match of the full regular expression, including the characters
3619 before and after the proper match
3620 1 The character before the proper match, or empty at beginning of line
3621 2 The proper match, including the leading and trailing markers
3622 3 The leading marker like * or /, indicating the type of highlighting
3623 4 The text between the emphasis markers, not including the markers
3630 "Set variable and compute the emphasis regular expression."
3634 org-emphasis-alist org-emphasis-regexp-components)
3646 ;; make sure special characters appear at the right position in the class
3658 ;; Make the regexp
3666 body1
3678 body1
3686 "Components used to build the regular expression for emphasis.
3687 This is a list with five entries. Terminology: In an emphasis string
3691 specify what is allowed/forbidden in each part:
3693 pre Chars allowed as prematch. Beginning of line will be allowed too.
3694 post Chars allowed as postmatch. End of line will be allowed too.
3695 border The chars *forbidden* as border characters.
3697 non-shy groups here, and don't allow newline here.
3698 newline The maximum number of newlines allowed in an emphasis exp.
3700 Use customize to modify this, or restart Emacs after changing it."
3719 )
3720 "Special syntax for emphasized text.
3721 Text starting and ending with a special character will be emphasized, for
3722 example *bold*, _underlined_ and /italic/. This variable sets the marker
3723 characters, the face to be used by font-lock for highlighting in Org-mode
3724 Emacs buffers, and the HTML tags to be used for this.
3725 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3726 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3727 Use customize to modify this, or restart Emacs after changing it."
3742 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3745 ;;; Miscellaneous options
3748 "Completion in Org-mode."
3753 "Non-nil means use ido completion wherever possible.
3754 Note that `ido-mode' must be active for this variable to be relevant.
3755 If you decide to turn this variable on, you might well want to turn off
3756 `org-outline-path-complete-in-steps'.
3757 See also `org-completion-use-iswitchb'."
3762 "Non-nil means use iswitchb completion wherever possible.
3763 Note that `iswitchb-mode' must be active for this variable to be relevant.
3764 If you decide to turn this variable on, you might well want to turn off
3765 `org-outline-path-complete-in-steps'.
3766 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3772 Normal means, no org-mode-specific context."
3776 ;;; Functions and variables from their packages
3777 ;; Declared here to avoid compiler warnings
3779 ;; XEmacs only
3785 ;; Emacs only
3788 ;; Various packages
3807 org-agenda-format-item "org-agenda"
3838 ;;; Autoload and prepare some org modules
3840 ;; Some table stuff that needs to be defined here, because it is used
3841 ;; by the functions setting up org-mode or checking for table context.
3854 "Detect the first line outside a table when searching from within it.
3857 ;; Autoload the functions in org-table.el that are needed by functions here.
3862 org-table-convert org-table-convert-region org-table-copy-down
3863 org-table-copy-region org-table-create
3864 org-table-create-or-convert-from-region
3865 org-table-create-with-table.el org-table-current-dline
3866 org-table-cut-region org-table-delete-column org-table-edit-field
3867 org-table-edit-formulas org-table-end org-table-eval-formula
3868 org-table-export org-table-field-info
3869 org-table-get-stored-formulas org-table-goto-column
3870 org-table-hline-and-move org-table-import org-table-insert-column
3871 org-table-insert-hline org-table-insert-row org-table-iterate
3872 org-table-justify-field-maybe org-table-kill-row
3873 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3874 org-table-move-column org-table-move-column-left
3875 org-table-move-column-right org-table-move-row
3876 org-table-move-row-down org-table-move-row-up
3877 org-table-next-field org-table-next-row org-table-paste-rectangle
3878 org-table-previous-field org-table-recalculate
3879 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3880 org-table-toggle-coordinate-overlays
3881 org-table-toggle-formula-debugger org-table-wrap-region
3882 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3883 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3884 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3887 "Return t if the cursor is inside an org-type table.
3888 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3893 org-table-line-regexp)))
3894 nil))
3898 "Return t if and only if we are at a table.el table."
3904 "If there is a table.el table nearby, recognize it and move into it."
3910 nil
3920 t
3925 t)
3926 nil)
3927 nil))
3930 "Return t if the cursor is inside a hline in a table."
3935 nil))
3940 "Apply FUNCTION to the start of all tables in the buffer."
3956 ;; Declare and autoload functions from org-exp.el & Co
3964 org-insert-export-options-template
3965 org-table-clean-before-export))
3968 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3969 org-export-region-as-ascii))
3972 org-replace-region-by-latex org-export-region-as-latex
3973 org-export-as-latex org-export-as-pdf
3974 org-export-as-pdf-and-open))
3977 org-export-as-html-batch org-export-as-html-to-buffer
3978 org-replace-region-by-html org-export-region-as-html
3979 org-export-as-html))
3982 org-replace-region-by-docbook org-export-region-as-docbook
3983 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3984 org-export-as-docbook))
3987 org-export-icalendar-all-agenda-files
3988 org-export-icalendar-combine-agenda-files))
3992 ;; Declare and autoload functions from org-agenda.el
3997 org-todo-list org-tags-view org-agenda-list-stuck-projects
3998 org-diary org-agenda-to-appt
3999 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
4001 ;; Autoload org-remember
4006 org-remember-apply-template org-remember org-remember-handler)))
4011 org-capture-import-remember-templates)))
4013 ;; Autoload org-clock.el
4028 "Return non-nil if clock is currently running.
4029 The return value is actually the clock marker."
4034 "org-clock"
4036 org-clock-goto org-clock-sum org-clock-display
4037 org-clock-remove-overlays org-clock-report
4038 org-clocktable-shift org-dblock-write:clocktable
4039 org-get-clocktable org-resolve-clocks)))
4042 "If this is a CLOCK line, update it and return t.
4043 Otherwise, return nil."
4052 ts te h m s neg)
4055 nil)
4060 ;; The clock is running here
4081 t))))))
4084 "Check if the current buffer contains the running clock.
4085 If yes, offer to stop it and to save the buffer with the changes."
4094 "Check if this line starts a clock table, if yes, shift the time block."
4098 ;; Autoload org-timer.el
4102 "org-timer"
4104 org-timer-change-times-in-region
4105 org-timer-set-timer
4106 org-timer-reset-timers
4107 org-timer-show-remaining-time)))
4109 ;; Autoload org-feed.el
4113 "org-feed"
4117 ;; Autoload org-indent.el
4119 ;; Define the variable already here, to make sure we have it.
4121 "Non-nil if Org-Indent mode is enabled.
4126 "org-indent"
4129 ;; Autoload org-mobile.el
4133 "org-mobile"
4136 ;; Autoload archiving code
4137 ;; The stuff that is needed for cycling and tags has to be defined here.
4140 "Options concerning archiving in Org-mode."
4145 "The location where subtrees should be archived.
4147 The value of this variable is a string, consisting of two parts,
4148 separated by a double-colon. The first part is a filename and
4149 the second part is a headline.
4151 When the filename is omitted, archiving happens in the same file.
4152 %s in the filename will be replaced by the current file
4153 name (without the directory part). Archiving to a different file
4154 is useful to keep archived entries from contributing to the
4155 Org-mode Agenda.
4157 The archived entries will be filed as subtrees of the specified
4158 headline. When the headline is omitted, the subtrees are simply
4159 filed away at the end of the file, as top-level entries. Also in
4160 the heading you can use %s to represent the file name, this can be
4161 useful when using the same archive for a number of different files.
4163 Here are a few examples:
4165 If the current file is Projects.org, archive in file
4166 Projects.org_archive, as top-level trees. This is the default.
4169 Archive in the current file, under the top-level headline
4173 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4176 Archive in file ~/org/archive.org (absolute path), under headlines
4180 Archive in file ./basement (relative path), as level 3 trees
4183 You may set this option on a per-file basis by adding to the buffer a
4184 line like
4186 #+ARCHIVE: basement::** Finished Tasks
4188 You may also define it locally for a subtree by setting an ARCHIVE property
4189 in the entry. If such a property is found in an entry, or anywhere up
4190 the hierarchy, it will be used."
4195 "The tag that marks a subtree as archived.
4196 An archived subtree does not open during visibility cycling, and does
4197 not contribute to the agenda listings.
4198 After changing this, font-lock must be restarted in the relevant buffers to
4199 get the proper fontification."
4205 "Non-nil means the agenda will skip any items located in archived trees.
4206 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4207 variable is no longer recommended, you should leave it at the value t.
4208 Instead, use the key `v' to cycle the archives-mode in the agenda."
4214 "Non-nil means ignore archived trees when creating column view."
4220 "Non-nil means `org-cycle' will open archived trees.
4221 An archived tree is a tree marked with the tag ARCHIVE.
4222 When nil, archived trees will stay folded. You can still open them with
4223 normal outline commands like `show-all', but not with the cycling commands."
4229 "Non-nil means sparse tree construction shows matches in archived trees.
4230 When nil, matches in these trees are highlighted, but the trees are kept in
4231 collapsed state."
4237 "Re-hide all archived subtrees after a visibility state change."
4248 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4251 "Cycle subtree even if it is archived."
4258 "Re-hide all archived subtrees after a visibility state change."
4273 flag)))
4280 org-archive-to-archive-sibling org-toggle-archive-tag
4281 org-archive-subtree-default
4282 org-archive-subtree-default-with-confirmation)))
4284 ;; Autoload Column View Code
4292 org-columns-compute org-agenda-columns org-columns-remove-overlays
4295 ;; Autoload ID code
4303 org-id-get-with-outline-path-completion
4304 org-id-get-with-outline-drilling org-id-store-link
4305 org-id-goto org-id-find org-id-store-link))
4307 ;; Autoload Plotting Code
4312 ;;; Variables for pre-computed regular expressions, all buffer local
4330 "Matches a headline and puts everything into groups:
4331 group 1: the stars
4332 group 2: The todo keyword, maybe
4333 group 3: Priority cookie
4334 group 4: True headline
4338 "Printf format to make regexp to match an exact headline.
4339 This regexp will match the headline of any node which has the
4340 exact headline text that is put into the format, but may have any
4344 "Matches a headline and puts TODO state into group 2 if present.
4393 "Regular expression to match a plain time or time range.
4394 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4395 groups carry important information:
4396 0 the full match
4397 1 the first time, range or not
4405 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4406 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4407 groups carry important information:
4408 0 the full match
4409 7 hours of duration
4418 "Regular expression to match a timestamp time or time range.
4419 After a match, the following groups carry important information:
4420 0 the full match
4421 1 date plus weekday, for back referencing to make sure both times are on the same day
4422 2 the first time, range or not
4477 "Variable associated with STARTUP options for org-mode.
4478 Each element is a list of three items: The startup options as written
4479 in the #+STARTUP line, the corresponding variable, and the value to
4480 set this variable to if the option is found. An optional forth element PUSH
4484 "Update PROPS with KEY and VAL."
4498 "Printf format for a regexp matching an headline with some keyword.
4499 This regexp will match the headline of any node which has the
4500 exact keyword that is put into the format. The keyword isn't in
4504 "Printf format for a regexp matching an headline, possibly with some keyword.
4505 This regexp can match any headline with the specified keyword, or
4506 without a keyword. The keyword isn't in any group by default,
4510 "Precompute regular expressions for current buffer."
4530 kwds kws0 kwsa key log value cat arch tags const links hw dws
4531 tail sep kws1 prio props ftags drawers beamer-p
4553 ;; general TODO-like setup
4565 links)))
4572 props))))
4577 ftags
4587 l var val)
4617 ;; search for property blocks
4626 props)))))))
4643 ;; Process the TODO keywords
4645 ;; Use the global values as if they had been given locally.
4657 kws)))
4660 kwsa nil
4663 ;; 1 2
4671 kw)
4673 kws0)
4690 ;; Process the constants
4698 ;; Process the tags.
4709 tgs))
4717 ;; Compute the regular expressions and other local variables.
4718 ;; Using `org-outline-regexp-bol' would complicate them much,
4719 ;; because of the fixed white space at the end of that string.
4727 org-drawer-regexp
4731 org-not-done-keywords
4733 org-todo-regexp
4737 org-not-done-regexp
4741 org-not-done-heading-regexp
4743 org-todo-line-regexp
4745 org-complex-heading-regexp
4752 org-complex-heading-regexp-format
4757 ;; Stats cookies can be stuck to body.
4764 org-todo-line-tags-regexp
4771 org-deadline-time-regexp
4773 org-deadline-line-regexp
4775 org-scheduled-regexp
4777 org-scheduled-time-regexp
4779 org-closed-time-regexp
4781 org-keyword-time-regexp
4787 org-keyword-time-not-clock-regexp
4793 org-maybe-keyword-time-regexp
4799 org-planning-or-clock-line-re
4804 org-all-time-keywords
4807 org-clock-string org-closed-string))
4808 )
4813 "Return the contents of FILE, as a string."
4827 "Extract the log state setting from a TODO keyword string.
4841 "Remove a pair of parenthesis at the end of each string in LIST."
4845 x))
4846 list))
4849 "Assign fast keys to a keyword-key alist.
4850 Respect keys that are already there."
4868 ;;; Some variables used in various places
4875 "Function to be called when `C-c C-c' is used.
4879 ;; FIXME: Occasionally check by commenting these, to make sure
4880 ;; no other functions uses these, forgetting to let-bind them.
4885 ;; Defined somewhere in this file, but used before definition.
4891 ;;;; Define the Org-mode
4894 (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"))
4897 ;; We use a before-change function to check if a table might need
4898 ;; an update.
4900 "Indicates that a table might need an update.
4901 This variable is set by `org-before-change-function'.
4904 "Every change indicates that a table might need an update."
4914 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4915 ;; some places -- e.g. see the macro org-with-limited-levels.
4916 ;;
4917 ;; In Org buffers, the value of `outline-regexp' is that of
4918 ;; `org-outline-regexp'. The only function still directly relying on
4919 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4920 ;; job when `orgstruct-mode' is active.
4924 "Regexp to match Org headlines.
4925 This is similar to `org-outline-regexp' but additionally makes
4929 "Matches an headline, putting stars and text into groups.
4932 ;;;###autoload
4934 "Outline-based notes management and organizer, alias
4937 Org-mode develops organizational tasks around a NOTES file which
4938 contains information about projects as plain text. Org-mode is
4939 implemented on top of outline-mode, which is ideal to keep the content
4940 of large files well structured. It supports ToDo items, deadlines and
4941 time stamps, which magically appear in the diary listing of the Emacs
4942 calendar. Tables are easily created with a built-in table editor.
4943 Plain text URL-like links connect to websites, emails (VM), Usenet
4944 messages (Gnus), BBDB entries, and any files related to the project.
4945 For printing and sharing of notes, an Org-mode file (or a part of it)
4946 can be exported as a structured ASCII or HTML file.
4948 The following commands are available:
4952 ;; Get rid of Outline menus, they are not needed
4953 ;; Need to do this here because define-derived-mode sets up
4954 ;; the keymap so late. Still, it is a waste to call this each time
4955 ;; we switch another buffer into org-mode.
4958 ;; Assume this is Greg's port, it uses easymenu
4984 org-display-table 4
4987 org-ellipsis)))
4992 ;; tag faces set outside customize.... force initialization.
4994 ;; Calc embedded
5000 ;; Activate before-change-function
5004 ;; Check for running clock before killing a buffer
5006 ;; Paragraphs and auto-filling
5010 ;; Beginning/end of defun
5013 ;; Next error for sparse trees
5015 ;; Make sure dependence stuff works reliably, even for users who set it
5016 ;; too late :-(
5028 ;; Comment characters
5032 ;; Align options lines
5034 'align-mode-rules-list
5039 ;; Imenu
5043 ;; Make isearch reveal context
5046 ;; Emacs 21 and XEmacs make use of the hook
5048 ;; Emacs 22 deals with this through a special variable
5052 ;; Turn on org-beamer-mode?
5055 ;; Setup the pcomplete hooks
5068 ;; If empty file that did not turn on org-mode automatically, make it to.
5093 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5103 "Return today date, considering `org-extend-today-until'."
5108 ;;;; Font-Lock stuff, including the activators
5139 "Regular expression used to analyze links.
5140 Here is what the match groups contain after a match:
5141 1: http:
5142 2: http
5143 3: path
5144 4: [desc]
5152 "Number of stacked braces for sub/superscript matching.
5153 This has to be set before loading org.el to be effective."
5158 "Create a regular expression which will match a balanced sexp.
5159 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5160 as single character strings.
5161 The regexp returned will match the entire expression including the
5162 delimiters. It will also define a single group which contains the
5163 match except for the outermost delimiters. The maximum depth of
5164 stacked delimiters is N. Escaping delimiters is not possible."
5193 "Update the link regular expressions.
5194 This should be called after the variable `org-link-types' has changed."
5198 org-link-re-with-space
5204 org-link-re-with-space2
5210 org-link-re-with-space3
5215 org-angle-link-re
5221 org-plain-link-re
5225 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5226 org-bracket-link-regexp
5228 org-bracket-link-analytic-regexp
5236 org-bracket-link-analytic-regexp++
5244 org-any-link-re
5253 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5255 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5256 "Regular expression matching time strings for analysis.
5257 This one does not require the space after the date, so it can be used
5259 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5275 "Regular expression matching a time stamp or time stamp range.
5281 "Run through the buffer and add overlays to emphasized strings."
5290 'face
5303 rtn))
5306 "Insert or change an emphasis, i.e. a font like bold or italic.
5307 If there is an active region, change that region to a new emphasis.
5308 If there is no region, just insert the marker characters and position
5309 the cursor between them.
5310 CHAR should be either the marker character, or the first character of the
5311 HTML tag associated with that emphasis. If CHAR is a space, the means
5312 to remove the emphasis of the selected region.
5313 If char is not given (for example in an interactive call) it
5314 will be prompted for."
5365 "Run through the buffer and add overlays to links."
5374 nil
5380 t)))))
5388 t)))
5391 "When non-nil, fontify code in code blocks."
5403 "Fontify #+ lines and blocks, in the correct ways."
5406 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5407 limit t)
5415 end end1 quoting block-type ovl)
5418 ;; a single line of backend-specific content
5426 ; for backend-specific code
5427 t)
5429 ;; Truly a block
5441 beg end
5449 ;; remove old background overlays
5454 ;; add a background overlay
5468 t))
5481 ;; just any other in-buffer setting, but not indented
5485 t)
5493 t)
5501 "Strip protective commas between BEG and END in the current buffer."
5517 "Run through the buffer and add overlays to links."
5525 t)))
5528 "Run through the buffer and add overlays to footnotes."
5535 'keymap org-mouse-map
5536 'help-echo
5538 "Footnote definition"
5540 'font-lock-fontified t
5541 'font-lock-multiline t
5545 "Run through the buffer and add overlays to bracketed links."
5549 ;; FIXME: above we should remove the escapes.
5550 ;; but that requires another match, protecting match data,
5551 ;; a lot of overhead for font-lock.
5558 ;; We need to remove the invisible property here. Table narrowing
5559 ;; may have made some of this invisible.
5577 t)))
5580 "Run through the buffer and add overlays to dates."
5592 t)))
5601 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5605 "Run through the buffer and add overlays to target matches."
5613 'keymap org-mouse-map
5617 t)))))
5620 "Find all radio targets in this file and update the regular expression."
5635 t)))
5642 ;; This should be with the exporter code, but we also use if for font-locking
5652 "Compute regular expression for stuff treated specially by exporters."
5659 org-latex-regexps)))
5687 org-entities)))
5691 org-latex-entities)
5692 nil))
5694 ))
5695 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5698 org-export-html-special-string-regexps)))
5703 ))))
5705 'org-latex-and-specials-regexp
5710 "Run through the buffer and add overlays to links."
5714 limit t))
5728 rtn)))
5731 "Restart `font-lock-mode', to force refontification."
5737 "Return a list of all targets in this file.
5738 With optional argument RADIO, only find radio targets."
5740 rtn)
5745 rtn)))
5748 "Make regular expression matching all strings in TARGETS.
5749 The regular expression finds the targets also if there is a line break
5750 between words."
5759 x)
5760 targets
5772 t)))
5775 "Compute the outline level of the heading at point.
5776 This function assumes that the cursor is at the beginning of a line matched
5777 by `outline-regexp'. Otherwise it returns garbage.
5778 If this is called at a normal headline, the level is the number of stars.
5779 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5786 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5793 "Functions that can manipulate `org-font-lock-extra-keywords'.
5794 This is called after `org-font-lock-extra-keywords' is defined, but before
5795 it is installed to be used by font lock. This can be useful if something
5806 ;; Call the hook
5808 ;; Headlines
5815 ;; Table lines
5818 ;; Table internals
5823 ;; Drawers
5826 ;; Properties
5830 ;; Links
5840 ;; TODO keyword
5842 org-todo-regexp)
5844 ;; DONE
5852 nil)
5853 ;; Priorities
5855 ;; Tags
5857 ;; Special keywords
5862 ;; Emphasis
5867 ;; Checkboxes
5868 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5873 ;; Description list items
5876 ;; ARCHIVEd headings
5878 org-outline-regexp-bol
5881 ;; Specials
5885 ;; Code
5887 ;; COMMENT
5894 ;; Blocks and meta lines
5896 )))
5899 ;; Now set the full font-lock-keywords
5906 "Toggle the composition display of entities as UTF8 characters."
5918 "Find an entity to fontify."
5924 limit t)
5936 nil))))
5939 "Fontify string S like in Org-mode."
5951 "Get the right face for match N in font-lock matching of headlines."
5964 "Get the right face for a TODO keyword KWD.
5965 If KWD is a number, get the corresponding match group."
5973 "Create a face list that inherits INHERIT, but sets the foreground color.
5974 When FACE-OR-COLOR is not a string, just return it."
5978 face-or-color)
5979 face-or-color))
5982 "Add the special tag faces."
5991 "Add the special priority faces."
5998 org-priority-faces)))
6003 "Get the right face for a TODO keyword KWD.
6004 If KWD is a number, get the corresponding match group."
6011 "Remove fontification and activation overlays from links."
6016 deactivate-mark buffer-file-name buffer-file-truename)
6020 invisible t intangible t
6021 org-no-flyspell t org-emphasis t))
6031 "Remove specific display properties that have been added by font lock.
6032 The will remove the raise properties that are used to show superscripts
6033 and subscripts."
6043 "Add raise properties to sub/superscripts."
6047 org-match-substring-regexp
6048 org-match-substring-with-braces-regexp)
6049 limit t)
6059 ;; FIXME: Should we go back one character here, for a_b^c
6060 ;; (goto-char (1- pos)) ;????????????????????
6062 t
6064 'display
6080 t)))))
6082 ;;;; Visibility cycling, including org-goto and indirect buffer
6084 ;;; Cycling
6091 ;;;###autoload
6096 "TAB-action and visibility cycling for Org-mode.
6098 This is the command invoked in Org-mode by the TAB key. Its main purpose
6099 is outline visibility cycling, but it also invokes other actions
6100 in special contexts.
6102 - When this function is called with a prefix argument, rotate the entire
6103 buffer through 3 states (global cycling)
6104 1. OVERVIEW: Show only top-level headlines.
6105 2. CONTENTS: Show all headlines of all levels, but no body text.
6106 3. SHOW ALL: Show everything.
6107 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6108 determined by the variable `org-startup-folded', and by any VISIBILITY
6109 properties in the buffer.
6110 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6111 including any drawers.
6113 - When inside a table, re-align the table and move to the next field.
6115 - When point is at the beginning of a headline, rotate the subtree started
6116 by this line through 3 different states (local cycling)
6117 1. FOLDED: Only the main headline is shown.
6118 2. CHILDREN: The main headline and the direct children are shown.
6119 From this state, you can move to one of the children
6120 and zoom in further.
6121 3. SUBTREE: Show the entire subtree, including body text.
6122 If there is no subtree, switch directly from CHILDREN to FOLDED.
6124 - When point is at the beginning of an empty headline and the variable
6125 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6126 of the headline by demoting and promoting it to likely levels. This
6127 speeds up creation document structure by pressing TAB once or several
6128 times right after creating a new headline.
6130 - When there is a numeric prefix, go up to a heading with level ARG, do
6131 a `show-subtree' and return to the previous cursor position. If ARG
6132 is negative, go up that many levels.
6134 - When point is not at the beginning of a headline, execute the global
6135 binding for TAB, which is re-indenting the line. See the option
6136 `org-cycle-emulate-tab' for details.
6138 - Special case: if point is at the beginning of the buffer and there is
6139 no headline in line 1, this function will act as if called with prefix arg
6140 (C-u TAB, same as S-TAB) also when called without prefix arg.
6141 But only if also the variable `org-cycle-global-at-bob' is t."
6151 org-inlinetask-min-level
6156 limit-level)))
6159 outline-regexp
6167 org-cycle-hook))
6171 ;; special case: use global cycling
6185 ;; Table: enter it or move to the next field.
6196 ;; Global cycling: delegate to `org-cycle-internal-global'.
6199 ;; Drawers: delegate to `org-flag-drawer'.
6207 ;; Show-subtree, ARG levels up from here.
6215 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6223 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6230 ;; From there: TAB emulation and template completion.
6252 t
6261 "Do the global cycling action."
6262 ;; Hack to avoid display of messages for .org attachments in Gnus
6267 ;; We just created the overview - now do table of contents
6268 ;; This can be slow in very large buffers, so indicate action
6278 ;; We just showed the table of contents - now show everything
6286 ;; Default action: go to overview
6294 "Do the local cycling action."
6296 ;; First, determine end of headline (EOH), end of subtree or item
6297 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6321 ;; Determine end invisible part of buffer (EOL)
6323 ;; XEmacs doesn't have `next-single-char-property-change'
6333 ;; Find out what to do next and set `this-command'
6336 ;; Nothing is hidden behind this heading
6348 org-cycle-skip-children-state-if-no-children))))
6349 ;; Entire subtree is hidden in one line: children view
6357 ;; Fold every list in subtree to top-level items.
6379 ;; We just showed the children, or no children are there,
6380 ;; now show everything.
6387 ;; Default action: hide the subtree.
6394 ;;;###autoload
6396 "Cycle the global visibility. For details see `org-cycle'.
6398 With a numeric prefix, show all headlines up to that level."
6414 "Set the visibility required by startup options and properties."
6429 "Switch subtree visibilities according to :VISIBILITY: property."
6436 nil t)
6460 ;; This function uses outline-regexp instead of the more fundamental
6461 ;; org-outline-regexp so that org-cycle-global works outside of Org
6462 ;; buffers, where outline-regexp is needed.
6464 "Switch to overview mode, showing only top-level headlines.
6465 Really, this shows all headlines with level equal or greater than the level
6466 of the first headline in the buffer. This is important, because if the
6467 first headline is not level one, then (hide-sublevels 1) gives confusing
6468 results."
6479 "Show all headlines in the buffer, like a table of contents.
6480 With numerical argument N, show content up to level N."
6483 ;; Visit all headings and show their offspring
6490 t)
6499 "Adjust the window after a change in outline visibility.
6500 This function is the default value of the hook `org-cycle-hook'."
6510 "Remove outline overlays that do not contain non-white stuff."
6520 "Fix visibility issues after moving a subtree."
6521 ;; First, find a reasonable region to look at:
6522 ;; Start two siblings above, end three below
6540 ;; Properly fold already folded siblings
6551 "Show empty lines above all visible headlines.
6552 The region to be covered depends on STATE when called through
6553 `org-cycle-hook'. Lisp program can use t for STATE to get the
6554 entire buffer covered. Note that an empty line is only shown if there
6555 are at least `org-cycle-separator-lines' empty lines before the headline."
6565 beg end b e)
6589 ;; Never hide empty lines at the end of the file.
6599 "Move to the parent and re-show empty lines before visible headlines."
6605 "Return `org-agenda-files' list, plus all open org-mode files.
6606 This is useful for operations that need to scan all of a user's
6607 open and agenda-wise Org files."
6615 files))
6618 "Return the beginning position of the current entry."
6622 "Return the end position of the current entry."
6626 "Re-hide all drawers after a visibility state change."
6652 "Is the end of the current subtree visible?"
6657 "Move cursor to the first headline and recenter the headline.
6658 Optional argument N means put the headline into the Nth line of the window."
6664 ;;; Saving and restoring visibility
6667 "Return a list of the locations of all outline overlays.
6668 These are overlays with the `invisible' property value `outline'.
6669 The return value is a list of cons cells, with start and stop
6670 positions for each overlay.
6671 If USE-MARKERS is set, return the positions as markers."
6689 "Create visibility overlays for all positions in DATA.
6690 DATA should have been made by `org-outline-overlay-data'."
6698 data)))))
6700 ;;; Folding of blocks
6707 "Call FUNCTION at the head of all source blocks in the current buffer.
6708 Optional arguments START and END can be used to limit the range."
6720 "Toggle the visibility of all blocks in the current buffer."
6724 "Fold all blocks in the current buffer."
6730 "Unfold all blocks in the current buffer."
6736 "Toggle visibility of block at point."
6747 "Toggle the visibility of the current block."
6754 ov)
6770 ;; make the block accessible to isearch
6772 ov 'isearch-open-invisible
6783 ;; org-tab-after-check-for-cycling-hook
6785 ;; Remove overlays when changing major mode
6790 ;;; Org-goto
6796 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6812 nil)
6813 (org-defkey map "q" 'org-goto-quit)
6814 (org-defkey map "n" 'outline-next-visible-heading)
6815 (org-defkey map "p" 'outline-previous-visible-heading)
6816 (org-defkey map "f" 'outline-forward-same-level)
6817 (org-defkey map "b" 'outline-backward-same-level)
6818 (org-defkey map "u" 'outline-up-heading))
6819 (org-defkey map "/" 'org-occur)
6820 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6821 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6822 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6823 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6824 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6825 map))
6827 (defconst org-goto-help
6828 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6829 RET=jump to location [Q]uit and return to previous location
6830 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6832 (defvar org-goto-start-pos) ; dynamically scoped parameter
6834 ;; FIXME: Docstring does not mention both interfaces
6835 (defun org-goto (&optional alternative-interface)
6836 "Look up a different location in the current file, keeping current visibility.
6838 When you want look-up or go to a different location in a document, the
6839 fastest way is often to fold the entire buffer and then dive into the tree.
6840 This method has the disadvantage, that the previous location will be folded,
6841 which may not be what you want.
6843 This command works around this by showing a copy of the current buffer
6844 in an indirect buffer, in overview mode. You can dive into the tree in
6845 that copy, use org-occur and incremental search to find a location.
6846 When pressing RET or `Q', the command returns to the original buffer in
6847 which the visibility is still unchanged. After RET is will also jump to
6848 the location selected in the indirect buffer and expose the headline
6849 hierarchy above."
6850 (interactive "P")
6851 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6852 (org-refile-use-outline-path t)
6853 (org-refile-target-verify-function nil)
6854 (interface
6855 (if (not alternative-interface)
6856 org-goto-interface
6857 (if (eq org-goto-interface 'outline)
6858 'outline-path-completion
6859 'outline)))
6860 (org-goto-start-pos (point))
6861 (selected-point
6862 (if (eq interface 'outline)
6863 (car (org-get-location (current-buffer) org-goto-help))
6864 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6865 (org-refile-check-position pa)
6866 (nth 3 pa)))))
6867 (if selected-point
6868 (progn
6869 (org-mark-ring-push org-goto-start-pos)
6870 (goto-char selected-point)
6871 (if (or (outline-invisible-p) (org-invisible-p2))
6872 (org-show-context 'org-goto)))
6873 (message "Quit"))))
6875 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6876 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6877 (defvar org-goto-local-auto-isearch-map) ; defined below
6879 (defun org-get-location (buf help)
6880 "Let the user select a location in the Org-mode buffer BUF.
6881 This function uses a recursive edit. It returns the selected position
6882 or nil."
6883 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6884 (isearch-hide-immediately nil)
6885 (isearch-search-fun-function
6886 (lambda () 'org-goto-local-search-headings))
6887 (org-goto-selected-point org-goto-exit-command)
6888 (pop-up-frames nil)
6889 (special-display-buffer-names nil)
6890 (special-display-regexps nil)
6891 (special-display-function nil))
6892 (save-excursion
6893 (save-window-excursion
6894 (delete-other-windows)
6895 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6896 (org-pop-to-buffer-same-window
6897 (condition-case nil
6898 (make-indirect-buffer (current-buffer) "*org-goto*")
6899 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6900 (with-output-to-temp-buffer "*Help*"
6901 (princ help))
6902 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6903 (setq buffer-read-only nil)
6904 (let ((org-startup-truncated t)
6905 (org-startup-folded nil)
6906 (org-startup-align-all-tables nil))
6907 (org-mode)
6908 (org-overview))
6909 (setq buffer-read-only t)
6910 (if (and (boundp 'org-goto-start-pos)
6911 (integer-or-marker-p org-goto-start-pos))
6912 (let ((org-show-hierarchy-above t)
6913 (org-show-siblings t)
6914 (org-show-following-heading t))
6915 (goto-char org-goto-start-pos)
6916 (and (outline-invisible-p) (org-show-context)))
6917 (goto-char (point-min)))
6918 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6919 (message "Select location and press RET")
6920 (use-local-map org-goto-map)
6921 (recursive-edit)
6922 ))
6923 (kill-buffer "*org-goto*")
6924 (cons org-goto-selected-point org-goto-exit-command)))
6926 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6927 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6928 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6929 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6931 (defun org-goto-local-search-headings (string bound noerror)
6932 "Search and make sure that any matches are in headlines."
6933 (catch 'return
6934 (while (if isearch-forward
6935 (search-forward string bound noerror)
6936 (search-backward string bound noerror))
6937 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6938 (and (member :headline context)
6939 (not (member :tags context))))
6940 (throw 'return (point))))))
6942 (defun org-goto-local-auto-isearch ()
6943 "Start isearch."
6944 (interactive)
6945 (goto-char (point-min))
6946 (let ((keys (this-command-keys)))
6947 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6948 (isearch-mode t)
6949 (isearch-process-search-char (string-to-char keys)))))
6951 (defun org-goto-ret (&optional arg)
6952 "Finish `org-goto' by going to the new location."
6953 (interactive "P")
6954 (setq org-goto-selected-point (point)
6955 org-goto-exit-command 'return)
6956 (throw 'exit nil))
6958 (defun org-goto-left ()
6959 "Finish `org-goto' by going to the new location."
6960 (interactive)
6961 (if (org-at-heading-p)
6962 (progn
6963 (beginning-of-line 1)
6964 (setq org-goto-selected-point (point)
6965 org-goto-exit-command 'left)
6966 (throw 'exit nil))
6967 (error "Not on a heading")))
6969 (defun org-goto-right ()
6970 "Finish `org-goto' by going to the new location."
6971 (interactive)
6972 (if (org-at-heading-p)
6973 (progn
6974 (setq org-goto-selected-point (point)
6975 org-goto-exit-command 'right)
6976 (throw 'exit nil))
6977 (error "Not on a heading")))
6979 (defun org-goto-quit ()
6980 "Finish `org-goto' without cursor motion."
6981 (interactive)
6982 (setq org-goto-selected-point nil)
6983 (setq org-goto-exit-command 'quit)
6984 (throw 'exit nil))
6986 ;;; Indirect buffer display of subtrees
6988 (defvar org-indirect-dedicated-frame nil
6989 "This is the frame being used for indirect tree display.")
6990 (defvar org-last-indirect-buffer nil)
6992 (defun org-tree-to-indirect-buffer (&optional arg)
6993 "Create indirect buffer and narrow it to current subtree.
6994 With numerical prefix ARG, go up to this level and then take that tree.
6995 If ARG is negative, go up that many levels.
6996 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6997 indirect buffer previously made with this command, to avoid proliferation of
6998 indirect buffers. However, when you call the command with a \
7000 when `org-indirect-buffer-display' is `new-frame', the last buffer
7001 is kept so that you can work with several indirect buffers at the same time.
7002 If `org-indirect-buffer-display' is `dedicated-frame', the \
7004 requests that a new frame be made for the new buffer, so that the dedicated
7005 frame is not changed."
7006 (interactive "P")
7007 (let ((cbuf (current-buffer))
7008 (cwin (selected-window))
7009 (pos (point))
7010 beg end level heading ibuf)
7011 (save-excursion
7012 (org-back-to-heading t)
7013 (when (numberp arg)
7014 (setq level (org-outline-level))
7015 (if (< arg 0) (setq arg (+ level arg)))
7016 (while (> (setq level (org-outline-level)) arg)
7017 (outline-up-heading 1 t)))
7018 (setq beg (point)
7019 heading (org-get-heading))
7020 (org-end-of-subtree t t)
7021 (if (org-at-heading-p) (backward-char 1))
7022 (setq end (point)))
7023 (if (and (buffer-live-p org-last-indirect-buffer)
7024 (not (eq org-indirect-buffer-display 'new-frame))
7025 (not arg))
7026 (kill-buffer org-last-indirect-buffer))
7027 (setq ibuf (org-get-indirect-buffer cbuf)
7028 org-last-indirect-buffer ibuf)
7029 (cond
7030 ((or (eq org-indirect-buffer-display 'new-frame)
7031 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7032 (select-frame (make-frame))
7033 (delete-other-windows)
7034 (org-pop-to-buffer-same-window ibuf)
7035 (org-set-frame-title heading))
7036 ((eq org-indirect-buffer-display 'dedicated-frame)
7037 (raise-frame
7038 (select-frame (or (and org-indirect-dedicated-frame
7039 (frame-live-p org-indirect-dedicated-frame)
7040 org-indirect-dedicated-frame)
7041 (setq org-indirect-dedicated-frame (make-frame)))))
7042 (delete-other-windows)
7043 (org-pop-to-buffer-same-window ibuf)
7044 (org-set-frame-title (concat "Indirect: " heading)))
7045 ((eq org-indirect-buffer-display 'current-window)
7046 (org-pop-to-buffer-same-window ibuf))
7047 ((eq org-indirect-buffer-display 'other-window)
7048 (pop-to-buffer ibuf))
7049 (t (error "Invalid value")))
7050 (if (featurep 'xemacs)
7051 (save-excursion (org-mode) (turn-on-font-lock)))
7052 (narrow-to-region beg end)
7053 (show-all)
7054 (goto-char pos)
7055 (run-hook-with-args 'org-cycle-hook 'all)
7056 (and (window-live-p cwin) (select-window cwin))))
7058 (defun org-get-indirect-buffer (&optional buffer)
7059 (setq buffer (or buffer (current-buffer)))
7060 (let ((n 1) (base (buffer-name buffer)) bname)
7061 (while (buffer-live-p
7062 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7063 (setq n (1+ n)))
7064 (condition-case nil
7065 (make-indirect-buffer buffer bname 'clone)
7066 (error (make-indirect-buffer buffer bname)))))
7068 (defun org-set-frame-title (title)
7069 "Set the title of the current frame to the string TITLE."
7070 ;; FIXME: how to name a single frame in XEmacs???
7071 (unless (featurep 'xemacs)
7072 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7074 ;;;; Structure editing
7076 ;;; Inserting headlines
7078 (defun org-previous-line-empty-p ()
7079 (save-excursion
7080 (and (not (bobp))
7081 (or (beginning-of-line 0) t)
7082 (save-match-data
7085 (defun org-insert-heading (&optional force-heading invisible-ok)
7086 "Insert a new heading or item with same depth at point.
7087 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7088 If point is at the beginning of a headline, insert a sibling before the
7089 current headline. If point is not at the beginning, split the line,
7090 create the new headline with the text in the current line after point
7091 \(but see also the variable `org-M-RET-may-split-line').
7093 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7094 This is important for non-interactive uses of the command."
7095 (interactive "P")
7096 (if (or (= (buffer-size) 0)
7097 (and (not (save-excursion
7098 (and (ignore-errors (org-back-to-heading invisible-ok))
7099 (org-at-heading-p))))
7100 (or force-heading (not (org-in-item-p)))))
7101 (progn
7103 (run-hooks 'org-insert-heading-hook))
7104 (when (or force-heading (not (org-insert-item)))
7105 (let* ((empty-line-p nil)
7106 (level nil)
7107 (on-heading (org-at-heading-p))
7108 (head (save-excursion
7109 (condition-case nil
7110 (progn
7111 (org-back-to-heading invisible-ok)
7112 (when (and (not on-heading)
7113 (featurep 'org-inlinetask)
7114 (integerp org-inlinetask-min-level)
7115 (>= (length (match-string 0))
7116 org-inlinetask-min-level))
7117 ;; Find a heading level before the inline task
7118 (while (and (setq level (org-up-heading-safe))
7119 (>= level org-inlinetask-min-level)))
7120 (if (org-at-heading-p)
7121 (org-back-to-heading invisible-ok)
7122 (error "This should not happen")))
7123 (setq empty-line-p (org-previous-line-empty-p))
7124 (match-string 0))
7125 (error "*"))))
7126 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7127 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7128 pos hide-previous previous-pos)
7129 (cond
7130 ((and (org-at-heading-p) (bolp)
7131 (or (bobp)
7132 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7133 ;; insert before the current line
7134 (open-line (if blank 2 1)))
7135 ((and (bolp)
7136 (not org-insert-heading-respect-content)
7137 (or (bobp)
7138 (save-excursion
7139 (backward-char 1) (not (outline-invisible-p)))))
7140 ;; insert right here
7141 nil)
7142 (t
7143 ;; somewhere in the line
7144 (save-excursion
7145 (setq previous-pos (point-at-bol))
7146 (end-of-line)
7147 (setq hide-previous (outline-invisible-p)))
7148 (and org-insert-heading-respect-content (org-show-subtree))
7149 (let ((split
7150 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7151 (save-excursion
7152 (let ((p (point)))
7153 (goto-char (point-at-bol))
7154 (and (looking-at org-complex-heading-regexp)
7155 (match-beginning 4)
7156 (> p (match-beginning 4)))))))
7157 tags pos)
7158 (cond
7159 (org-insert-heading-respect-content
7160 (org-end-of-subtree nil t)
7161 (when (featurep 'org-inlinetask)
7162 (while (and (not (eobp))
7164 (>= (length (match-string 1))
7165 org-inlinetask-min-level))
7166 (org-end-of-subtree nil t)))
7167 (or (bolp) (newline))
7168 (or (org-previous-line-empty-p)
7169 (and blank (newline)))
7170 (open-line 1))
7171 ((org-at-heading-p)
7172 (when hide-previous
7173 (show-children)
7174 (org-show-entry))
7176 (setq tags (and (match-end 2) (match-string 2)))
7177 (and (match-end 1)
7178 (delete-region (match-beginning 1) (match-end 1)))
7179 (setq pos (point-at-bol))
7180 (or split (end-of-line 1))
7181 (delete-horizontal-space)
7183 (buffer-substring (point-at-bol) (point)))
7184 (insert " "))
7185 (newline (if blank 2 1))
7186 (when tags
7187 (save-excursion
7188 (goto-char pos)
7189 (end-of-line 1)
7190 (insert " " tags)
7191 (org-set-tags nil 'align))))
7192 (t
7193 (or split (end-of-line 1))
7194 (newline (if blank 2 1)))))))
7195 (insert head) (just-one-space)
7196 (setq pos (point))
7197 (end-of-line 1)
7198 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7199 (when (and org-insert-heading-respect-content hide-previous)
7200 (save-excursion
7201 (goto-char previous-pos)
7202 (hide-subtree)))
7203 (run-hooks 'org-insert-heading-hook)))))
7205 (defun org-get-heading (&optional no-tags no-todo)
7206 "Return the heading of the current entry, without the stars.
7207 When NO-TAGS is non-nil, don't include tags.
7208 When NO-TODO is non-nil, don't include TODO keywords."
7209 (save-excursion
7210 (org-back-to-heading t)
7211 (cond
7212 ((and no-tags no-todo)
7213 (looking-at org-complex-heading-regexp)
7214 (match-string 4))
7215 (no-tags
7216 (looking-at (concat org-outline-regexp
7219 (match-string 1))
7220 (no-todo
7221 (looking-at org-todo-line-regexp)
7222 (match-string 3))
7223 (t (looking-at org-heading-regexp)
7224 (match-string 2)))))
7226 (defun org-heading-components ()
7227 "Return the components of the current heading.
7228 This is a list with the following elements:
7229 - the level as an integer
7230 - the reduced level, different if `org-odd-levels-only' is set.
7231 - the TODO keyword, or nil
7232 - the priority character, like ?A, or nil if no priority is given
7233 - the headline text itself, or the tags string if no headline text
7234 - the tags string, or nil."
7235 (save-excursion
7236 (org-back-to-heading t)
7237 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7238 (list (length (match-string 1))
7239 (org-reduced-level (length (match-string 1)))
7240 (org-match-string-no-properties 2)
7241 (and (match-end 3) (aref (match-string 3) 2))
7242 (org-match-string-no-properties 4)
7243 (org-match-string-no-properties 5)))))
7245 (defun org-get-entry ()
7246 "Get the entry text, after heading, entire subtree."
7247 (save-excursion
7248 (org-back-to-heading t)
7249 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7251 (defun org-insert-heading-after-current ()
7252 "Insert a new heading with same level as current, after current subtree."
7253 (interactive)
7254 (org-back-to-heading)
7255 (org-insert-heading)
7256 (org-move-subtree-down)
7257 (end-of-line 1))
7259 (defun org-insert-heading-respect-content ()
7260 (interactive)
7261 (let ((org-insert-heading-respect-content t))
7262 (org-insert-heading t)))
7264 (defun org-insert-todo-heading-respect-content (&optional force-state)
7265 (interactive "P")
7266 (let ((org-insert-heading-respect-content t))
7267 (org-insert-todo-heading force-state t)))
7269 (defun org-insert-todo-heading (arg &optional force-heading)
7270 "Insert a new heading with the same level and TODO state as current heading.
7271 If the heading has no TODO state, or if the state is DONE, use the first
7272 state (TODO by default). Also with prefix arg, force first state."
7273 (interactive "P")
7274 (when (or force-heading (not (org-insert-item 'checkbox)))
7275 (org-insert-heading force-heading)
7276 (save-excursion
7277 (org-back-to-heading)
7278 (outline-previous-heading)
7279 (looking-at org-todo-line-regexp))
7280 (let*
7281 ((new-mark-x
7282 (if (or arg
7283 (not (match-beginning 2))
7284 (member (match-string 2) org-done-keywords))
7285 (car org-todo-keywords-1)
7286 (match-string 2)))
7287 (new-mark
7288 (or
7289 (run-hook-with-args-until-success
7290 'org-todo-get-default-hook new-mark-x nil)
7291 new-mark-x)))
7292 (beginning-of-line 1)
7293 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7294 (if org-treat-insert-todo-heading-as-state-change
7295 (org-todo new-mark)
7296 (insert new-mark " "))))
7297 (when org-provide-todo-statistics
7298 (org-update-parent-todo-statistics))))
7300 (defun org-insert-subheading (arg)
7301 "Insert a new subheading and demote it.
7302 Works for outline headings and for plain lists alike."
7303 (interactive "P")
7304 (org-insert-heading arg)
7305 (cond
7306 ((org-at-heading-p) (org-do-demote))
7307 ((org-at-item-p) (org-indent-item))))
7309 (defun org-insert-todo-subheading (arg)
7310 "Insert a new subheading with TODO keyword or checkbox and demote it.
7311 Works for outline headings and for plain lists alike."
7312 (interactive "P")
7313 (org-insert-todo-heading arg)
7314 (cond
7315 ((org-at-heading-p) (org-do-demote))
7316 ((org-at-item-p) (org-indent-item))))
7318 ;;; Promotion and Demotion
7320 (defvar org-after-demote-entry-hook nil
7321 "Hook run after an entry has been demoted.
7322 The cursor will be at the beginning of the entry.
7323 When a subtree is being demoted, the hook will be called for each node.")
7325 (defvar org-after-promote-entry-hook nil
7326 "Hook run after an entry has been promoted.
7327 The cursor will be at the beginning of the entry.
7328 When a subtree is being promoted, the hook will be called for each node.")
7330 (defun org-promote-subtree ()
7331 "Promote the entire subtree.
7332 See also `org-promote'."
7333 (interactive)
7334 (save-excursion
7335 (org-with-limited-levels (org-map-tree 'org-promote)))
7336 (org-fix-position-after-promote))
7338 (defun org-demote-subtree ()
7339 "Demote the entire subtree. See `org-demote'.
7340 See also `org-promote'."
7341 (interactive)
7342 (save-excursion
7343 (org-with-limited-levels (org-map-tree 'org-demote)))
7344 (org-fix-position-after-promote))
7347 (defun org-do-promote ()
7348 "Promote the current heading higher up the tree.
7349 If the region is active in `transient-mark-mode', promote all headings
7350 in the region."
7351 (interactive)
7352 (save-excursion
7353 (if (org-region-active-p)
7354 (org-map-region 'org-promote (region-beginning) (region-end))
7355 (org-promote)))
7356 (org-fix-position-after-promote))
7358 (defun org-do-demote ()
7359 "Demote the current heading lower down the tree.
7360 If the region is active in `transient-mark-mode', demote all headings
7361 in the region."
7362 (interactive)
7363 (save-excursion
7364 (if (org-region-active-p)
7365 (org-map-region 'org-demote (region-beginning) (region-end))
7366 (org-demote)))
7367 (org-fix-position-after-promote))
7369 (defun org-fix-position-after-promote ()
7370 "Make sure that after pro/demotion cursor position is right."
7371 (let ((pos (point)))
7372 (when (save-excursion
7373 (beginning-of-line 1)
7374 (looking-at org-todo-line-regexp)
7375 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7376 (cond ((eobp) (insert " "))
7377 ((eolp) (insert " "))
7378 ((equal (char-after) ?\ ) (forward-char 1))))))
7380 (defun org-current-level ()
7381 "Return the level of the current entry, or nil if before the first headline.
7382 The level is the number of stars at the beginning of the headline."
7383 (save-excursion
7384 (org-with-limited-levels
7385 (if (ignore-errors (org-back-to-heading t))
7386 (funcall outline-level)))))
7388 (defun org-get-previous-line-level ()
7389 "Return the outline depth of the last headline before the current line.
7390 Returns 0 for the first headline in the buffer, and nil if before the
7391 first headline."
7392 (let ((current-level (org-current-level))
7393 (prev-level (when (> (line-number-at-pos) 1)
7394 (save-excursion
7395 (beginning-of-line 0)
7396 (org-current-level)))))
7397 (cond ((null current-level) nil) ; Before first headline
7398 ((null prev-level) 0) ; At first headline
7399 (prev-level))))
7401 (defun org-reduced-level (l)
7402 "Compute the effective level of a heading.
7403 This takes into account the setting of `org-odd-levels-only'."
7404 (cond
7405 ((zerop l) 0)
7406 (org-odd-levels-only (1+ (floor (/ l 2))))
7407 (t l)))
7409 (defun org-level-increment ()
7410 "Return the number of stars that will be added or removed at a
7411 time to headlines when structure editing, based on the value of
7412 `org-odd-levels-only'."
7413 (if org-odd-levels-only 2 1))
7415 (defun org-get-valid-level (level &optional change)
7416 "Rectify a level change under the influence of `org-odd-levels-only'
7417 LEVEL is a current level, CHANGE is by how much the level should be
7418 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7419 even level numbers will become the next higher odd number."
7420 (if org-odd-levels-only
7421 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7422 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7423 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7424 (max 1 (+ level (or change 0)))))
7426 (if (boundp 'define-obsolete-function-alias)
7427 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7428 (define-obsolete-function-alias 'org-get-legal-level
7429 'org-get-valid-level)
7430 (define-obsolete-function-alias 'org-get-legal-level
7431 'org-get-valid-level "23.1")))
7433 (defun org-promote ()
7434 "Promote the current heading higher up the tree.
7435 If the region is active in `transient-mark-mode', promote all headings
7436 in the region."
7437 (org-back-to-heading t)
7438 (let* ((level (save-match-data (funcall outline-level)))
7439 (after-change-functions (remove 'flyspell-after-change-function
7440 after-change-functions))
7441 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7442 (diff (abs (- level (length up-head) -1))))
7443 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7444 (replace-match up-head nil t)
7445 ;; Fixup tag positioning
7446 (and org-auto-align-tags (org-set-tags nil t))
7447 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7448 (run-hooks 'org-after-promote-entry-hook)))
7450 (defun org-demote ()
7451 "Demote the current heading lower down the tree.
7452 If the region is active in `transient-mark-mode', demote all headings
7453 in the region."
7454 (org-back-to-heading t)
7455 (let* ((level (save-match-data (funcall outline-level)))
7456 (after-change-functions (remove 'flyspell-after-change-function
7457 after-change-functions))
7458 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7459 (diff (abs (- level (length down-head) -1))))
7460 (replace-match down-head nil t)
7461 ;; Fixup tag positioning
7462 (and org-auto-align-tags (org-set-tags nil t))
7463 (if org-adapt-indentation (org-fixup-indentation diff))
7464 (run-hooks 'org-after-demote-entry-hook)))
7466 (defun org-cycle-level ()
7467 "Cycle the level of an empty headline through possible states.
7468 This goes first to child, then to parent, level, then up the hierarchy.
7469 After top level, it switches back to sibling level."
7470 (interactive)
7471 (let ((org-adapt-indentation nil))
7472 (when (org-point-at-end-of-empty-headline)
7473 (setq this-command 'org-cycle-level) ; Only needed for caching
7474 (let ((cur-level (org-current-level))
7475 (prev-level (org-get-previous-line-level)))
7476 (cond
7477 ;; If first headline in file, promote to top-level.
7478 ((= prev-level 0)
7479 (loop repeat (/ (- cur-level 1) (org-level-increment))
7480 do (org-do-promote)))
7481 ;; If same level as prev, demote one.
7482 ((= prev-level cur-level)
7483 (org-do-demote))
7484 ;; If parent is top-level, promote to top level if not already.
7485 ((= prev-level 1)
7486 (loop repeat (/ (- cur-level 1) (org-level-increment))
7487 do (org-do-promote)))
7488 ;; If top-level, return to prev-level.
7489 ((= cur-level 1)
7490 (loop repeat (/ (- prev-level 1) (org-level-increment))
7491 do (org-do-demote)))
7492 ;; If less than prev-level, promote one.
7493 ((< cur-level prev-level)
7494 (org-do-promote))
7495 ;; If deeper than prev-level, promote until higher than
7496 ;; prev-level.
7497 ((> cur-level prev-level)
7498 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7499 do (org-do-promote))))
7500 t))))
7502 (defun org-map-tree (fun)
7503 "Call FUN for every heading underneath the current one."
7504 (org-back-to-heading)
7505 (let ((level (funcall outline-level)))
7506 (save-excursion
7507 (funcall fun)
7508 (while (and (progn
7509 (outline-next-heading)
7510 (> (funcall outline-level) level))
7511 (not (eobp)))
7512 (funcall fun)))))
7514 (defun org-map-region (fun beg end)
7515 "Call FUN for every heading between BEG and END."
7516 (let ((org-ignore-region t))
7517 (save-excursion
7518 (setq end (copy-marker end))
7519 (goto-char beg)
7520 (if (and (re-search-forward org-outline-regexp-bol nil t)
7521 (< (point) end))
7522 (funcall fun))
7523 (while (and (progn
7524 (outline-next-heading)
7525 (< (point) end))
7526 (not (eobp)))
7527 (funcall fun)))))
7529 (defvar org-property-end-re) ; silence byte-compiler
7530 (defun org-fixup-indentation (diff)
7531 "Change the indentation in the current entry by DIFF.
7532 However, if any line in the current entry has no indentation, or if it
7533 would end up with no indentation after the change, nothing at all is done."
7534 (save-excursion
7535 (let ((end (save-excursion (outline-next-heading)
7536 (point-marker)))
7537 (prohibit (if (> diff 0)
7540 col)
7541 (unless (save-excursion (end-of-line 1)
7542 (re-search-forward prohibit end t))
7543 (while (and (< (point) end)
7545 (goto-char (match-end 0))
7546 (setq col (current-column))
7547 (if (< diff 0) (replace-match ""))
7548 (org-indent-to-column (+ diff col))))
7549 (move-marker end nil))))
7551 (defun org-convert-to-odd-levels ()
7552 "Convert an org-mode file with all levels allowed to one with odd levels.
7553 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7554 level 5 etc."
7555 (interactive)
7556 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7557 (let ((outline-level 'org-outline-level)
7558 (org-odd-levels-only nil) n)
7559 (save-excursion
7560 (goto-char (point-min))
7562 (setq n (- (length (match-string 0)) 2))
7563 (while (>= (setq n (1- n)) 0)
7564 (org-demote))
7565 (end-of-line 1))))))
7567 (defun org-convert-to-oddeven-levels ()
7568 "Convert an org-mode file with only odd levels to one with odd/even levels.
7569 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7570 file contains a section with an even level, conversion would
7571 destroy the structure of the file. An error is signaled in this
7572 case."
7573 (interactive)
7574 (goto-char (point-min))
7575 ;; First check if there are no even levels
7577 (org-show-context t)
7578 (error "Not all levels are odd in this file. Conversion not possible"))
7579 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7580 (let ((outline-regexp org-outline-regexp)
7581 (outline-level 'org-outline-level)
7582 (org-odd-levels-only nil) n)
7583 (save-excursion
7584 (goto-char (point-min))
7586 (setq n (/ (1- (length (match-string 0))) 2))
7587 (while (>= (setq n (1- n)) 0)
7588 (org-promote))
7589 (end-of-line 1))))))
7591 (defun org-tr-level (n)
7592 "Make N odd if required."
7593 (if org-odd-levels-only (1+ (/ n 2)) n))
7595 ;;; Vertical tree motion, cutting and pasting of subtrees
7597 (defun org-move-subtree-up (&optional arg)
7598 "Move the current subtree up past ARG headlines of the same level."
7599 (interactive "p")
7600 (org-move-subtree-down (- (prefix-numeric-value arg))))
7602 (defun org-move-subtree-down (&optional arg)
7603 "Move the current subtree down past ARG headlines of the same level."
7604 (interactive "p")
7605 (setq arg (prefix-numeric-value arg))
7606 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7607 'org-get-last-sibling))
7608 (ins-point (make-marker))
7609 (cnt (abs arg))
7610 (col (current-column))
7611 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7612 ;; Select the tree
7613 (org-back-to-heading)
7614 (setq beg0 (point))
7615 (save-excursion
7616 (setq ne-beg (org-back-over-empty-lines))
7617 (setq beg (point)))
7618 (save-match-data
7619 (save-excursion (outline-end-of-heading)
7620 (setq folded (outline-invisible-p)))
7621 (outline-end-of-subtree))
7622 (outline-next-heading)
7623 (setq ne-end (org-back-over-empty-lines))
7624 (setq end (point))
7625 (goto-char beg0)
7626 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7627 ;; include less whitespace
7628 (save-excursion
7629 (goto-char beg)
7630 (forward-line (- ne-beg ne-end))
7631 (setq beg (point))))
7632 ;; Find insertion point, with error handling
7633 (while (> cnt 0)
7634 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7635 (progn (goto-char beg0)
7636 (error "Cannot move past superior level or buffer limit")))
7637 (setq cnt (1- cnt)))
7638 (if (> arg 0)
7639 ;; Moving forward - still need to move over subtree
7640 (progn (org-end-of-subtree t t)
7641 (save-excursion
7642 (org-back-over-empty-lines)
7643 (or (bolp) (newline)))))
7644 (setq ne-ins (org-back-over-empty-lines))
7645 (move-marker ins-point (point))
7646 (setq txt (buffer-substring beg end))
7647 (org-save-markers-in-region beg end)
7648 (delete-region beg end)
7649 (org-remove-empty-overlays-at beg)
7650 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7651 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7653 (let ((bbb (point)))
7654 (insert-before-markers txt)
7655 (org-reinstall-markers-in-region bbb)
7656 (move-marker ins-point bbb))
7658 (setq ins-end (point))
7659 (goto-char ins-point)
7660 (org-skip-whitespace)
7661 (when (and (< arg 0)
7662 (org-first-sibling-p)
7663 (> ne-ins ne-beg))
7664 ;; Move whitespace back to beginning
7665 (save-excursion
7666 (goto-char ins-end)
7667 (let ((kill-whole-line t))
7668 (kill-line (- ne-ins ne-beg)) (point)))
7670 (move-marker ins-point nil)
7671 (if folded
7672 (hide-subtree)
7673 (org-show-entry)
7674 (show-children)
7675 (org-cycle-hide-drawers 'children))
7676 (org-clean-visibility-after-subtree-move)
7677 ;; move back to the initial column we were at
7678 (move-to-column col)))
7680 (defvar org-subtree-clip ""
7681 "Clipboard for cut and paste of subtrees.
7682 This is actually only a copy of the kill, because we use the normal kill
7683 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7685 (defvar org-subtree-clip-folded nil
7686 "Was the last copied subtree folded?
7687 This is used to fold the tree back after pasting.")
7689 (defun org-cut-subtree (&optional n)
7690 "Cut the current subtree into the clipboard.
7691 With prefix arg N, cut this many sequential subtrees.
7692 This is a short-hand for marking the subtree and then cutting it."
7693 (interactive "p")
7694 (org-copy-subtree n 'cut))
7696 (defun org-copy-subtree (&optional n cut force-store-markers)
7697 "Cut the current subtree into the clipboard.
7698 With prefix arg N, cut this many sequential subtrees.
7699 This is a short-hand for marking the subtree and then copying it.
7700 If CUT is non-nil, actually cut the subtree.
7701 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7702 of some markers in the region, even if CUT is non-nil. This is
7703 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7704 (interactive "p")
7705 (let (beg end folded (beg0 (point)))
7706 (if (org-called-interactively-p 'any)
7707 (org-back-to-heading nil) ; take what looks like a subtree
7708 (org-back-to-heading t)) ; take what is really there
7709 (org-back-over-empty-lines)
7710 (setq beg (point))
7712 (save-match-data
7713 (save-excursion (outline-end-of-heading)
7714 (setq folded (outline-invisible-p)))
7715 (condition-case nil
7716 (org-forward-same-level (1- n) t)
7717 (error nil))
7718 (org-end-of-subtree t t))
7719 (org-back-over-empty-lines)
7720 (setq end (point))
7721 (goto-char beg0)
7722 (when (> end beg)
7723 (setq org-subtree-clip-folded folded)
7724 (when (or cut force-store-markers)
7725 (org-save-markers-in-region beg end))
7726 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7727 (setq org-subtree-clip (current-kill 0))
7728 (message "%s: Subtree(s) with %d characters"
7729 (if cut "Cut" "Copied")
7730 (length org-subtree-clip)))))
7732 (defun org-paste-subtree (&optional level tree for-yank)
7733 "Paste the clipboard as a subtree, with modification of headline level.
7734 The entire subtree is promoted or demoted in order to match a new headline
7735 level.
7737 If the cursor is at the beginning of a headline, the same level as
7738 that headline is used to paste the tree
7740 If not, the new level is derived from the *visible* headings
7741 before and after the insertion point, and taken to be the inferior headline
7742 level of the two. So if the previous visible heading is level 3 and the
7743 next is level 4 (or vice versa), level 4 will be used for insertion.
7744 This makes sure that the subtree remains an independent subtree and does
7745 not swallow low level entries.
7747 You can also force a different level, either by using a numeric prefix
7748 argument, or by inserting the heading marker by hand. For example, if the
7751 If optional TREE is given, use this text instead of the kill ring.
7753 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7754 move back over whitespace before inserting, and move point to the end of
7755 the inserted text when done."
7756 (interactive "P")
7757 (setq tree (or tree (and kill-ring (current-kill 0))))
7758 (unless (org-kill-is-subtree-p tree)
7759 (error "%s"
7760 (substitute-command-keys
7762 (org-with-limited-levels
7763 (let* ((visp (not (outline-invisible-p)))
7764 (txt tree)
7766 (old-level (if (string-match org-outline-regexp-bol txt)
7767 (- (match-end 0) (match-beginning 0) 1)
7768 -1))
7769 (force-level (cond (level (prefix-numeric-value level))
7771 (string-match
7773 (point-at-bol) (point))))
7774 (- (match-end 1) (match-beginning 1)))
7775 ((and (bolp)
7776 (looking-at org-outline-regexp))
7777 (- (match-end 0) (point) 1))
7778 (t nil)))
7779 (previous-level (save-excursion
7780 (condition-case nil
7781 (progn
7782 (outline-previous-visible-heading 1)
7783 (if (looking-at ^re_)
7784 (- (match-end 0) (match-beginning 0) 1)
7785 1))
7786 (error 1))))
7787 (next-level (save-excursion
7788 (condition-case nil
7789 (progn
7790 (or (looking-at org-outline-regexp)
7791 (outline-next-visible-heading 1))
7792 (if (looking-at ^re_)
7793 (- (match-end 0) (match-beginning 0) 1)
7794 1))
7795 (error 1))))
7796 (new-level (or force-level (max previous-level next-level)))
7797 (shift (if (or (= old-level -1)
7798 (= new-level -1)
7799 (= old-level new-level))
7800 0
7801 (- new-level old-level)))
7802 (delta (if (> shift 0) -1 1))
7803 (func (if (> shift 0) 'org-demote 'org-promote))
7804 (org-odd-levels-only nil)
7805 beg end newend)
7806 ;; Remove the forced level indicator
7807 (if force-level
7808 (delete-region (point-at-bol) (point)))
7809 ;; Paste
7810 (beginning-of-line (if (bolp) 1 2))
7811 (unless for-yank (org-back-over-empty-lines))
7812 (setq beg (point))
7813 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7814 (insert-before-markers txt)
7816 (setq newend (point))
7817 (org-reinstall-markers-in-region beg)
7818 (setq end (point))
7819 (goto-char beg)
7821 (setq beg (point))
7822 (if (and (outline-invisible-p) visp)
7823 (save-excursion (outline-show-heading)))
7824 ;; Shift if necessary
7825 (unless (= shift 0)
7826 (save-restriction
7827 (narrow-to-region beg end)
7828 (while (not (= shift 0))
7829 (org-map-region func (point-min) (point-max))
7830 (setq shift (+ delta shift)))
7831 (goto-char (point-min))
7832 (setq newend (point-max))))
7833 (when (or (org-called-interactively-p 'interactive) for-yank)
7834 (message "Clipboard pasted as level %d subtree" new-level))
7835 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7836 kill-ring
7837 (eq org-subtree-clip (current-kill 0))
7838 org-subtree-clip-folded)
7839 ;; The tree was folded before it was killed/copied
7840 (hide-subtree))
7841 (and for-yank (goto-char newend)))))
7843 (defun org-kill-is-subtree-p (&optional txt)
7844 "Check if the current kill is an outline subtree, or a set of trees.
7845 Returns nil if kill does not start with a headline, or if the first
7846 headline level is not the largest headline level in the tree.
7847 So this will actually accept several entries of equal levels as well,
7848 which is OK for `org-paste-subtree'.
7849 If optional TXT is given, check this string instead of the current kill."
7850 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7851 (re (org-get-limited-outline-regexp))
7852 (^re (concat "^" re))
7853 (start-level (and kill
7854 (string-match
7856 kill)
7857 (- (match-end 2) (match-beginning 2) 1)))
7858 (start (1+ (or (match-beginning 2) -1))))
7859 (if (not start-level)
7860 (progn
7861 nil) ;; does not even start with a heading
7862 (catch 'exit
7863 (while (setq start (string-match ^re kill (1+ start)))
7864 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7865 (throw 'exit nil)))
7866 t))))
7868 (defvar org-markers-to-move nil
7869 "Markers that should be moved with a cut-and-paste operation.
7870 Those markers are stored together with their positions relative to
7871 the start of the region.")
7873 (defun org-save-markers-in-region (beg end)
7874 "Check markers in region.
7875 If these markers are between BEG and END, record their position relative
7876 to BEG, so that after moving the block of text, we can put the markers back
7877 into place.
7878 This function gets called just before an entry or tree gets cut from the
7879 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7880 called immediately, to move the markers with the entries."
7881 (setq org-markers-to-move nil)
7882 (when (featurep 'org-clock)
7883 (org-clock-save-markers-for-cut-and-paste beg end))
7884 (when (featurep 'org-agenda)
7885 (org-agenda-save-markers-for-cut-and-paste beg end)))
7887 (defun org-check-and-save-marker (marker beg end)
7888 "Check if MARKER is between BEG and END.
7889 If yes, remember the marker and the distance to BEG."
7890 (when (and (marker-buffer marker)
7891 (equal (marker-buffer marker) (current-buffer)))
7892 (if (and (>= marker beg) (< marker end))
7893 (push (cons marker (- marker beg)) org-markers-to-move))))
7895 (defun org-reinstall-markers-in-region (beg)
7896 "Move all remembered markers to their position relative to BEG."
7897 (mapc (lambda (x)
7898 (move-marker (car x) (+ beg (cdr x))))
7899 org-markers-to-move)
7900 (setq org-markers-to-move nil))
7902 (defun org-narrow-to-subtree ()
7903 "Narrow buffer to the current subtree."
7904 (interactive)
7905 (save-excursion
7906 (save-match-data
7907 (org-with-limited-levels
7908 (narrow-to-region
7909 (progn (org-back-to-heading t) (point))
7910 (progn (org-end-of-subtree t t)
7911 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7912 (point)))))))
7914 (defun org-narrow-to-block ()
7915 "Narrow buffer to the current block."
7916 (interactive)
7917 (let* ((case-fold-search t)
7920 (if blockp
7921 (narrow-to-region (car blockp) (cdr blockp))
7922 (error "Not in a block"))))
7924 (eval-when-compile
7925 (defvar org-property-drawer-re))
7927 (defvar org-property-start-re) ;; defined below
7928 (defun org-clone-subtree-with-time-shift (n &optional shift)
7929 "Clone the task (subtree) at point N times.
7930 The clones will be inserted as siblings.
7932 In interactive use, the user will be prompted for the number of
7933 clones to be produced, and for a time SHIFT, which may be a
7934 repeater as used in time stamps, for example `+3d'.
7936 When a valid repeater is given and the entry contains any time
7937 stamps, the clones will become a sequence in time, with time
7938 stamps in the subtree shifted for each clone produced. If SHIFT
7939 is nil or the empty string, time stamps will be left alone. The
7940 ID property of the original subtree is removed.
7942 If the original subtree did contain time stamps with a repeater,
7943 the following will happen:
7944 - the repeater will be removed in each clone
7945 - an additional clone will be produced, with the current, unshifted
7946 date(s) in the entry.
7947 - the original entry will be placed *after* all the clones, with
7948 repeater intact.
7949 - the start days in the repeater in the original entry will be shifted
7950 to past the last clone.
7951 I this way you can spell out a number of instances of a repeating task,
7952 and still retain the repeater to cover future instances of the task."
7953 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7954 (let (beg end template task idprop
7955 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7956 (drawer-re org-drawer-regexp))
7957 (if (not (and (integerp n) (> n 0)))
7958 (error "Invalid number of replications %s" n))
7961 shift)))
7962 (error "Invalid shift specification %s" shift))
7963 (when doshift
7964 (setq shift-n (string-to-number (match-string 1 shift))
7965 shift-what (cdr (assoc (match-string 2 shift)
7966 '(("d" . day) ("w" . week)
7967 ("m" . month) ("y" . year))))))
7968 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7969 (setq nmin 1 nmax n)
7970 (org-back-to-heading t)
7971 (setq beg (point))
7972 (setq idprop (org-entry-get nil "ID"))
7973 (org-end-of-subtree t t)
7975 (setq end (point))
7976 (setq template (buffer-substring beg end))
7977 (when (and doshift
7979 (delete-region beg end)
7980 (setq end beg)
7981 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7982 (goto-char end)
7983 (loop for n from nmin to nmax do
7984 ;; prepare clone
7985 (with-temp-buffer
7986 (insert template)
7987 (org-mode)
7988 (goto-char (point-min))
7989 (org-show-subtree)
7990 (and idprop (if org-clone-delete-id
7991 (org-entry-delete nil "ID")
7992 (org-id-get-create t)))
7993 (unless (= n 0)
7995 (kill-whole-line))
7996 (goto-char (point-min))
7997 (while (re-search-forward drawer-re nil t)
7998 (mapc (lambda (d)
7999 (org-remove-empty-drawer-at d (point))) org-drawers)))
8000 (goto-char (point-min))
8001 (when doshift
8002 (while (re-search-forward org-ts-regexp-both nil t)
8003 (org-timestamp-change (* n shift-n) shift-what))
8004 (unless (= n n-no-remove)
8005 (goto-char (point-min))
8006 (while (re-search-forward org-ts-regexp nil t)
8007 (save-excursion
8008 (goto-char (match-beginning 0))
8010 (delete-region (match-beginning 1) (match-end 1)))))))
8011 (setq task (buffer-string)))
8012 (insert task))
8013 (goto-char beg)))
8015 ;;; Outline Sorting
8017 (defun org-sort (with-case)
8018 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8019 Optional argument WITH-CASE means sort case-sensitively."
8020 (interactive "P")
8021 (cond
8022 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8023 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8024 (t
8025 (org-call-with-arg 'org-sort-entries with-case))))
8027 (defun org-sort-remove-invisible (s)
8028 (remove-text-properties 0 (length s) org-rm-props s)
8029 (while (string-match org-bracket-link-regexp s)
8030 (setq s (replace-match (if (match-end 2)
8031 (match-string 3 s)
8032 (match-string 1 s)) t t s)))
8033 s)
8035 (defvar org-priority-regexp) ; defined later in the file
8037 (defvar org-after-sorting-entries-or-items-hook nil
8038 "Hook that is run after a bunch of entries or items have been sorted.
8039 When children are sorted, the cursor is in the parent line when this
8040 hook gets called. When a region or a plain list is sorted, the cursor
8041 will be in the first entry of the sorted region/list.")
8043 (defun org-sort-entries
8044 (&optional with-case sorting-type getkey-func compare-func property)
8045 "Sort entries on a certain level of an outline tree.
8046 If there is an active region, the entries in the region are sorted.
8047 Else, if the cursor is before the first entry, sort the top-level items.
8048 Else, the children of the entry at point are sorted.
8050 Sorting can be alphabetically, numerically, by date/time as given by
8051 a time stamp, by a property or by priority.
8053 The command prompts for the sorting type unless it has been given to the
8054 function through the SORTING-TYPE argument, which needs to be a character,
8055 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8056 precise meaning of each character:
8058 n Numerically, by converting the beginning of the entry/item to a number.
8059 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8060 t By date/time, either the first active time stamp in the entry, or, if
8061 none exist, by the first inactive one.
8062 s By the scheduled date/time.
8063 d By deadline date/time.
8064 c By creation time, which is assumed to be the first inactive time stamp
8065 at the beginning of a line.
8066 p By priority according to the cookie.
8067 r By the value of a property.
8069 Capital letters will reverse the sort order.
8071 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8072 called with point at the beginning of the record. It must return either
8073 a string or a number that should serve as the sorting key for that record.
8075 Comparing entries ignores case by default. However, with an optional argument
8076 WITH-CASE, the sorting considers case as well."
8077 (interactive "P")
8078 (let ((case-func (if with-case 'identity 'downcase))
8079 start beg end stars re re2
8080 txt what tmp)
8081 ;; Find beginning and end of region to sort
8082 (cond
8083 ((org-region-active-p)
8084 ;; we will sort the region
8085 (setq end (region-end)
8086 what "region")
8087 (goto-char (region-beginning))
8088 (if (not (org-at-heading-p)) (outline-next-heading))
8089 (setq start (point)))
8090 ((or (org-at-heading-p)
8091 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8092 ;; we will sort the children of the current headline
8093 (org-back-to-heading)
8094 (setq start (point)
8095 end (progn (org-end-of-subtree t t)
8097 (org-back-over-empty-lines)
8098 (point))
8099 what "children")
8100 (goto-char start)
8101 (show-subtree)
8102 (outline-next-heading))
8103 (t
8104 ;; we will sort the top-level entries in this file
8105 (goto-char (point-min))
8106 (or (org-at-heading-p) (outline-next-heading))
8107 (setq start (point))
8108 (goto-char (point-max))
8109 (beginning-of-line 1)
8111 ;; File ends in a non-white line
8112 (end-of-line 1)
8114 (setq end (point-max))
8115 (setq what "top-level")
8116 (goto-char start)
8117 (show-all)))
8119 (setq beg (point))
8120 (if (>= beg end) (error "Nothing to sort"))
8123 (setq stars (match-string 1)
8124 re (concat "^" (regexp-quote stars) " +")
8126 txt (buffer-substring beg end))
8128 (if (and (not (equal stars "*")) (string-match re2 txt))
8129 (error "Region to sort contains a level above the first entry"))
8131 (unless sorting-type
8132 (message
8133 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8135 A/N/T/S/D/C/P/O/F means reversed:"
8136 what)
8137 (setq sorting-type (read-char-exclusive))
8139 (and (= (downcase sorting-type) ?f)
8140 (setq getkey-func
8141 (org-icompleting-read "Sort using function: "
8142 obarray 'fboundp t nil nil))
8143 (setq getkey-func (intern getkey-func)))
8145 (and (= (downcase sorting-type) ?r)
8146 (setq property
8147 (org-icompleting-read "Property: "
8148 (mapcar 'list (org-buffer-property-keys t))
8149 nil t))))
8151 (message "Sorting entries...")
8153 (save-restriction
8154 (narrow-to-region start end)
8155 (let ((dcst (downcase sorting-type))
8156 (case-fold-search nil)
8157 (now (current-time)))
8158 (sort-subr
8159 (/= dcst sorting-type)
8160 ;; This function moves to the beginning character of the "record" to
8161 ;; be sorted.
8162 (lambda nil
8163 (if (re-search-forward re nil t)
8164 (goto-char (match-beginning 0))
8165 (goto-char (point-max))))
8166 ;; This function moves to the last character of the "record" being
8167 ;; sorted.
8168 (lambda nil
8169 (save-match-data
8170 (condition-case nil
8171 (outline-forward-same-level 1)
8172 (error
8173 (goto-char (point-max))))))
8174 ;; This function returns the value that gets sorted against.
8175 (lambda nil
8176 (cond
8177 ((= dcst ?n)
8178 (if (looking-at org-complex-heading-regexp)
8179 (string-to-number (match-string 4))
8180 nil))
8181 ((= dcst ?a)
8182 (if (looking-at org-complex-heading-regexp)
8183 (funcall case-func (match-string 4))
8184 nil))
8185 ((= dcst ?t)
8186 (let ((end (save-excursion (outline-next-heading) (point))))
8187 (if (or (re-search-forward org-ts-regexp end t)
8188 (re-search-forward org-ts-regexp-both end t))
8189 (org-time-string-to-seconds (match-string 0))
8190 (org-float-time now))))
8191 ((= dcst ?c)
8192 (let ((end (save-excursion (outline-next-heading) (point))))
8193 (if (re-search-forward
8195 end t)
8196 (org-time-string-to-seconds (match-string 0))
8197 (org-float-time now))))
8198 ((= dcst ?s)
8199 (let ((end (save-excursion (outline-next-heading) (point))))
8200 (if (re-search-forward org-scheduled-time-regexp end t)
8201 (org-time-string-to-seconds (match-string 1))
8202 (org-float-time now))))
8203 ((= dcst ?d)
8204 (let ((end (save-excursion (outline-next-heading) (point))))
8205 (if (re-search-forward org-deadline-time-regexp end t)
8206 (org-time-string-to-seconds (match-string 1))
8207 (org-float-time now))))
8208 ((= dcst ?p)
8209 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8210 (string-to-char (match-string 2))
8211 org-default-priority))
8212 ((= dcst ?r)
8213 (or (org-entry-get nil property) ""))
8214 ((= dcst ?o)
8215 (if (looking-at org-complex-heading-regexp)
8216 (- 9999 (length (member (match-string 2)
8217 org-todo-keywords-1)))))
8218 ((= dcst ?f)
8219 (if getkey-func
8220 (progn
8221 (setq tmp (funcall getkey-func))
8222 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8223 tmp)
8224 (error "Invalid key function `%s'" getkey-func)))
8225 (t (error "Invalid sorting type `%c'" sorting-type))))
8226 nil
8227 (cond
8228 ((= dcst ?a) 'string<)
8229 ((= dcst ?f) compare-func)
8230 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8231 (t nil)))))
8232 (run-hooks 'org-after-sorting-entries-or-items-hook)
8233 (message "Sorting entries...done")))
8235 (defun org-do-sort (table what &optional with-case sorting-type)
8236 "Sort TABLE of WHAT according to SORTING-TYPE.
8237 The user will be prompted for the SORTING-TYPE if the call to this
8238 function does not specify it. WHAT is only for the prompt, to indicate
8239 what is being sorted. The sorting key will be extracted from
8240 the car of the elements of the table.
8241 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8242 (unless sorting-type
8243 (message
8244 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8245 what)
8246 (setq sorting-type (read-char-exclusive)))
8247 (let ((dcst (downcase sorting-type))
8248 extractfun comparefun)
8249 ;; Define the appropriate functions
8250 (cond
8251 ((= dcst ?n)
8252 (setq extractfun 'string-to-number
8253 comparefun (if (= dcst sorting-type) '< '>)))
8254 ((= dcst ?a)
8255 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8256 (lambda(x) (downcase (org-sort-remove-invisible x))))
8257 comparefun (if (= dcst sorting-type)
8258 'string<
8259 (lambda (a b) (and (not (string< a b))
8260 (not (string= a b)))))))
8261 ((= dcst ?t)
8262 (setq extractfun
8263 (lambda (x)
8264 (if (or (string-match org-ts-regexp x)
8265 (string-match org-ts-regexp-both x))
8266 (org-float-time
8267 (org-time-string-to-time (match-string 0 x)))
8268 0))
8269 comparefun (if (= dcst sorting-type) '< '>)))
8270 (t (error "Invalid sorting type `%c'" sorting-type)))
8272 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8273 table)
8274 (lambda (a b) (funcall comparefun (car a) (car b))))))
8277 ;;; The orgstruct minor mode
8279 ;; Define a minor mode which can be used in other modes in order to
8280 ;; integrate the org-mode structure editing commands.
8282 ;; This is really a hack, because the org-mode structure commands use
8283 ;; keys which normally belong to the major mode. Here is how it
8284 ;; works: The minor mode defines all the keys necessary to operate the
8285 ;; structure commands, but wraps the commands into a function which
8286 ;; tests if the cursor is currently at a headline or a plain list
8287 ;; item. If that is the case, the structure command is used,
8288 ;; temporarily setting many Org-mode variables like regular
8289 ;; expressions for filling etc. However, when any of those keys is
8290 ;; used at a different location, function uses `key-binding' to look
8291 ;; up if the key has an associated command in another currently active
8292 ;; keymap (minor modes, major mode, global), and executes that
8293 ;; command. There might be problems if any of the keys is otherwise
8294 ;; used as a prefix key.
8296 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8297 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8298 ;; addresses this by checking explicitly for both bindings.
8300 (defvar orgstruct-mode-map (make-sparse-keymap)
8301 "Keymap for the minor `orgstruct-mode'.")
8303 (defvar org-local-vars nil
8304 "List of local variables, for use by `orgstruct-mode'.")
8306 ;;;###autoload
8307 (define-minor-mode orgstruct-mode
8308 "Toggle the minor mode `orgstruct-mode'.
8309 This mode is for using Org-mode structure commands in other
8310 modes. The following keys behave as if Org-mode were active, if
8311 the cursor is on a headline, or on a plain list item (both as
8312 defined by Org-mode).
8314 M-up Move entry/item up
8315 M-down Move entry/item down
8316 M-left Promote
8317 M-right Demote
8318 M-S-up Move entry/item up
8319 M-S-down Move entry/item down
8320 M-S-left Promote subtree
8321 M-S-right Demote subtree
8322 M-q Fill paragraph and items like in Org-mode
8323 C-c ^ Sort entries
8324 C-c - Cycle list bullet
8325 TAB Cycle item visibility
8326 M-RET Insert new heading/item
8327 S-M-RET Insert new TODO heading / Checkbox item
8328 C-c C-c Set tags / toggle checkbox"
8329 nil " OrgStruct" nil
8330 (org-load-modules-maybe)
8331 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8333 ;;;###autoload
8334 (defun turn-on-orgstruct ()
8335 "Unconditionally turn on `orgstruct-mode'."
8336 (orgstruct-mode 1))
8338 (defun orgstruct++-mode (&optional arg)
8339 "Toggle `orgstruct-mode', the enhanced version of it.
8340 In addition to setting orgstruct-mode, this also exports all indentation
8341 and autofilling variables from org-mode into the buffer. It will also
8342 recognize item context in multiline items.
8343 Note that turning off orgstruct-mode will *not* remove the
8344 indentation/paragraph settings. This can only be done by refreshing the
8346 (interactive "P")
8347 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8348 (if (< arg 1)
8349 (orgstruct-mode -1)
8350 (orgstruct-mode 1)
8351 (let (var val)
8352 (mapc
8353 (lambda (x)
8354 (when (string-match
8356 (symbol-name (car x)))
8357 (setq var (car x) val (nth 1 x))
8358 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8359 org-local-vars)
8360 (org-set-local 'orgstruct-is-++ t))))
8362 (defvar orgstruct-is-++ nil
8363 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8364 (make-variable-buffer-local 'orgstruct-is-++)
8366 ;;;###autoload
8367 (defun turn-on-orgstruct++ ()
8368 "Unconditionally turn on `orgstruct++-mode'."
8369 (orgstruct++-mode 1))
8371 (defun orgstruct-error ()
8372 "Error when there is no default binding for a structure key."
8373 (interactive)
8374 (error "This key has no function outside structure elements"))
8376 (defun orgstruct-setup ()
8377 "Setup orgstruct keymaps."
8378 (let ((nfunc 0)
8379 (bindings
8380 (list
8381 '([(meta up)] org-metaup)
8382 '([(meta down)] org-metadown)
8383 '([(meta left)] org-metaleft)
8384 '([(meta right)] org-metaright)
8385 '([(meta shift up)] org-shiftmetaup)
8386 '([(meta shift down)] org-shiftmetadown)
8387 '([(meta shift left)] org-shiftmetaleft)
8388 '([(meta shift right)] org-shiftmetaright)
8389 '([?\e (up)] org-metaup)
8390 '([?\e (down)] org-metadown)
8391 '([?\e (left)] org-metaleft)
8392 '([?\e (right)] org-metaright)
8393 '([?\e (shift up)] org-shiftmetaup)
8394 '([?\e (shift down)] org-shiftmetadown)
8395 '([?\e (shift left)] org-shiftmetaleft)
8396 '([?\e (shift right)] org-shiftmetaright)
8397 '([(shift up)] org-shiftup)
8398 '([(shift down)] org-shiftdown)
8399 '([(shift left)] org-shiftleft)
8400 '([(shift right)] org-shiftright)
8401 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8402 '("\M-q" fill-paragraph)
8403 '("\C-c^" org-sort)
8404 '("\C-c-" org-cycle-list-bullet)))
8405 elt key fun cmd)
8406 (while (setq elt (pop bindings))
8407 (setq nfunc (1+ nfunc))
8408 (setq key (org-key (car elt))
8409 fun (nth 1 elt)
8410 cmd (orgstruct-make-binding fun nfunc key))
8411 (org-defkey orgstruct-mode-map key cmd))
8413 ;; Special treatment needed for TAB and RET
8414 (org-defkey orgstruct-mode-map [(tab)]
8415 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8416 (org-defkey orgstruct-mode-map "\C-i"
8417 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8419 (org-defkey orgstruct-mode-map "\M-\C-m"
8420 (orgstruct-make-binding 'org-insert-heading 105
8421 "\M-\C-m" [(meta return)]))
8422 (org-defkey orgstruct-mode-map [(meta return)]
8423 (orgstruct-make-binding 'org-insert-heading 106
8424 [(meta return)] "\M-\C-m"))
8426 (org-defkey orgstruct-mode-map [(shift meta return)]
8427 (orgstruct-make-binding 'org-insert-todo-heading 107
8428 [(meta return)] "\M-\C-m"))
8430 (org-defkey orgstruct-mode-map "\e\C-m"
8431 (orgstruct-make-binding 'org-insert-heading 108
8432 "\e\C-m" [?\e (return)]))
8433 (org-defkey orgstruct-mode-map [?\e (return)]
8434 (orgstruct-make-binding 'org-insert-heading 109
8435 [?\e (return)] "\e\C-m"))
8436 (org-defkey orgstruct-mode-map [?\e (shift return)]
8437 (orgstruct-make-binding 'org-insert-todo-heading 110
8438 [?\e (return)] "\e\C-m"))
8440 (unless org-local-vars
8441 (setq org-local-vars (org-get-local-variables)))
8443 t))
8445 (defun orgstruct-make-binding (fun n &rest keys)
8446 "Create a function for binding in the structure minor mode.
8447 FUN is the command to call inside a table. N is used to create a unique
8448 command name. KEYS are keys that should be checked in for a command
8449 to execute outside of tables."
8450 (eval
8451 (list 'defun
8452 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8453 '(arg)
8455 "Outside of structure, run the binding of `"
8456 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8457 "'.")
8458 '(interactive "p")
8459 (list 'if
8460 `(org-context-p 'headline 'item
8461 (and orgstruct-is-++
8462 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8463 'item-body))
8464 (list 'org-run-like-in-org-mode (list 'quote fun))
8465 (list 'let '(orgstruct-mode)
8466 (list 'call-interactively
8467 (append '(or)
8468 (mapcar (lambda (k)
8469 (list 'key-binding k))
8470 keys)
8471 '('orgstruct-error))))))))
8473 (defun org-context-p (&rest contexts)
8474 "Check if local context is any of CONTEXTS.
8475 Possible values in the list of contexts are `table', `headline', and `item'."
8476 (let ((pos (point)))
8477 (goto-char (point-at-bol))
8478 (prog1 (or (and (memq 'table contexts)
8480 (and (memq 'headline contexts)
8481 (looking-at org-outline-regexp))
8482 (and (memq 'item contexts)
8484 (and (memq 'item-body contexts)
8485 (org-in-item-p)))
8486 (goto-char pos))))
8488 (defun org-get-local-variables ()
8489 "Return a list of all local variables in an org-mode buffer."
8490 (let (varlist)
8491 (with-current-buffer (get-buffer-create "*Org tmp*")
8492 (erase-buffer)
8493 (org-mode)
8494 (setq varlist (buffer-local-variables)))
8495 (kill-buffer "*Org tmp*")
8496 (delq nil
8497 (mapcar
8498 (lambda (x)
8499 (setq x
8500 (if (symbolp x)
8501 (list x)
8502 (list (car x) (list 'quote (cdr x)))))
8503 (if (string-match
8504 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8505 (symbol-name (car x)))
8506 x nil))
8507 varlist))))
8509 (defun org-clone-local-variables (from-buffer &optional regexp)
8510 "Clone local variables from FROM-BUFFER.
8511 Optional argument REGEXP selects variables to clone."
8512 (mapc
8513 (lambda (pair)
8514 (and (symbolp (car pair))
8515 (or (null regexp)
8516 (string-match regexp (symbol-name (car pair))))
8517 (set (make-local-variable (car pair))
8518 (cdr pair))))
8519 (buffer-local-variables from-buffer)))
8521 ;;;###autoload
8522 (defun org-run-like-in-org-mode (cmd)
8523 "Run a command, pretending that the current buffer is in Org-mode.
8524 This will temporarily bind local variables that are typically bound in
8525 Org-mode to the values they have in Org-mode, and then interactively
8526 call CMD."
8527 (org-load-modules-maybe)
8528 (unless org-local-vars
8529 (setq org-local-vars (org-get-local-variables)))
8530 (eval (list 'let org-local-vars
8531 (list 'call-interactively (list 'quote cmd)))))
8533 ;;;; Archiving
8535 (defun org-get-category (&optional pos force-refresh)
8536 "Get the category applying to position POS."
8537 (if force-refresh (org-refresh-category-properties))
8538 (let ((pos (or pos (point))))
8539 (or (get-text-property pos 'org-category)
8540 (progn (org-refresh-category-properties)
8541 (get-text-property pos 'org-category)))))
8543 (defun org-refresh-category-properties ()
8544 "Refresh category text properties in the buffer."
8545 (let ((def-cat (cond
8546 ((null org-category)
8547 (if buffer-file-name
8548 (file-name-sans-extension
8549 (file-name-nondirectory buffer-file-name))
8550 "???"))
8551 ((symbolp org-category) (symbol-name org-category))
8552 (t org-category)))
8553 beg end cat pos optionp)
8554 (org-unmodified
8555 (save-excursion
8556 (save-restriction
8557 (widen)
8558 (goto-char (point-min))
8559 (put-text-property (point) (point-max) 'org-category def-cat)
8560 (while (re-search-forward
8562 (setq pos (match-end 0)
8563 optionp (equal (char-after (match-beginning 0)) ?#)
8564 cat (org-trim (match-string 2)))
8565 (if optionp
8566 (setq beg (point-at-bol) end (point-max))
8567 (org-back-to-heading t)
8568 (setq beg (point) end (org-end-of-subtree t t)))
8569 (put-text-property beg end 'org-category cat)
8570 (put-text-property beg end 'org-category-position beg)
8571 (goto-char pos)))))))
8574 ;;;; Link Stuff
8576 ;;; Link abbreviations
8578 (defun org-link-expand-abbrev (link)
8579 "Apply replacements as defined in `org-link-abbrev-alist."
8581 (let* ((key (match-string 1 link))
8582 (as (or (assoc key org-link-abbrev-alist-local)
8583 (assoc key org-link-abbrev-alist)))
8584 (tag (and (match-end 2) (match-string 3 link)))
8585 rpl)
8586 (if (not as)
8587 link
8588 (setq rpl (cdr as))
8589 (cond
8590 ((symbolp rpl) (funcall rpl tag))
8591 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8592 ((string-match "%h" rpl)
8593 (replace-match (url-hexify-string (or tag "")) t t rpl))
8594 (t (concat rpl tag)))))
8595 link))
8597 ;;; Storing and inserting links
8599 (defvar org-insert-link-history nil
8600 "Minibuffer history for links inserted with `org-insert-link'.")
8602 (defvar org-stored-links nil
8603 "Contains the links stored with `org-store-link'.")
8605 (defvar org-store-link-plist nil
8606 "Plist with info about the most recently link created with `org-store-link'.")
8608 (defvar org-link-protocols nil
8609 "Link protocols added to Org-mode using `org-add-link-type'.")
8611 (defvar org-store-link-functions nil
8612 "List of functions that are called to create and store a link.
8613 Each function will be called in turn until one returns a non-nil
8614 value. Each function should check if it is responsible for creating
8615 this link (for example by looking at the major mode).
8616 If not, it must exit and return nil.
8617 If yes, it should return a non-nil value after a calling
8618 `org-store-link-props' with a list of properties and values.
8619 Special properties are:
8623 This is obligatory as well.
8624 :description Optional default description for the second pair
8625 of brackets in an Org-mode link. The user can still change
8626 this when inserting this link into an Org-mode buffer.
8628 In addition to these, any additional properties can be specified
8629 and then used in remember templates.")
8631 (defun org-add-link-type (type &optional follow export)
8632 "Add TYPE to the list of `org-link-types'.
8633 Re-compute all regular expressions depending on `org-link-types'
8635 FOLLOW and EXPORT are two functions.
8637 FOLLOW should take the link path as the single argument and do whatever
8638 is necessary to follow the link, for example find a file or display
8639 a mail message.
8641 EXPORT should format the link path for export to one of the export formats.
8642 It should be a function accepting three arguments:
8645 desc the description of the link, if any, or a description added by
8646 org-export-normalize-links if there is none
8647 format the export format, a symbol like `html' or `latex' or `ascii'..
8649 The function may use the FORMAT information to return different values
8650 depending on the format. The return value will be put literally into
8651 the exported file. If the return value is nil, this means Org should
8652 do what it normally does with links which do not have EXPORT defined.
8654 Org-mode has a built-in default for exporting links. If you are happy with
8655 this default, there is no need to define an export function for the link
8656 type. For a simple example of an export function, see `org-bbdb.el'."
8657 (add-to-list 'org-link-types type t)
8658 (org-make-link-regexps)
8659 (if (assoc type org-link-protocols)
8660 (setcdr (assoc type org-link-protocols) (list follow export))
8661 (push (list type follow export) org-link-protocols)))
8663 (defvar org-agenda-buffer-name)
8665 ;;;###autoload
8666 (defun org-store-link (arg)
8668 This link is added to `org-stored-links' and can later be inserted
8671 For some link types, a prefix arg is interpreted:
8672 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8673 For file links, arg negates `org-context-in-file-links'."
8674 (interactive "P")
8675 (org-load-modules-maybe)
8676 (setq org-store-link-plist nil) ; reset
8677 (org-with-limited-levels
8678 (let (link cpltxt desc description search txt custom-id agenda-link)
8679 (cond
8681 ((run-hook-with-args-until-success 'org-store-link-functions)
8682 (setq link (plist-get org-store-link-plist :link)
8683 desc (or (plist-get org-store-link-plist :description) link)))
8685 ((equal (buffer-name) "*Org Edit Src Example*")
8686 (let (label gc)
8687 (while (or (not label)
8688 (save-excursion
8689 (save-restriction
8690 (widen)
8691 (goto-char (point-min))
8692 (re-search-forward
8693 (regexp-quote (format org-coderef-label-format label))
8694 nil t))))
8695 (when label (message "Label exists already") (sit-for 2))
8696 (setq label (read-string "Code line label: " label)))
8697 (end-of-line 1)
8698 (setq link (format org-coderef-label-format label))
8699 (setq gc (- 79 (length link)))
8700 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8701 (insert link)
8702 (setq link (concat "(" label ")") desc nil)))
8704 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8705 ;; We are in the agenda, link to referenced location
8706 (let ((m (or (get-text-property (point) 'org-hd-marker)
8707 (get-text-property (point) 'org-marker))))
8708 (when m
8709 (org-with-point-at m
8710 (setq agenda-link
8711 (if (org-called-interactively-p 'any)
8712 (call-interactively 'org-store-link)
8713 (org-store-link nil)))))))
8715 ((eq major-mode 'calendar-mode)
8716 (let ((cd (calendar-cursor-to-date)))
8717 (setq link
8718 (format-time-string
8719 (car org-time-stamp-formats)
8720 (apply 'encode-time
8721 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8722 nil nil nil))))
8723 (org-store-link-props :type "calendar" :date cd)))
8725 ((eq major-mode 'w3-mode)
8726 (setq cpltxt (if (and (buffer-name)
8727 (not (string-match "Untitled" (buffer-name))))
8728 (buffer-name)
8729 (url-view-url t))
8730 link (org-make-link (url-view-url t)))
8731 (org-store-link-props :type "w3" :url (url-view-url t)))
8733 ((eq major-mode 'w3m-mode)
8734 (setq cpltxt (or w3m-current-title w3m-current-url)
8735 link (org-make-link w3m-current-url))
8736 (org-store-link-props :type "w3m" :url (url-view-url t)))
8738 ((setq search (run-hook-with-args-until-success
8739 'org-create-file-search-functions))
8740 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8741 "::" search))
8742 (setq cpltxt (or description link)))
8744 ((eq major-mode 'image-mode)
8745 (setq cpltxt (concat "file:"
8746 (abbreviate-file-name buffer-file-name))
8747 link (org-make-link cpltxt))
8748 (org-store-link-props :type "image" :file buffer-file-name))
8750 ((eq major-mode 'dired-mode)
8751 ;; link to the file in the current line
8752 (let ((file (dired-get-filename nil t)))
8753 (setq file (if file
8754 (abbreviate-file-name
8755 (expand-file-name (dired-get-filename nil t)))
8756 ;; otherwise, no file so use current directory.
8757 default-directory))
8758 (setq cpltxt (concat "file:" file)
8759 link (org-make-link cpltxt))))
8761 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8762 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8763 (cond
8765 (setq cpltxt
8766 (concat "file:"
8767 (abbreviate-file-name
8768 (buffer-file-name (buffer-base-buffer)))
8769 "::" (match-string 1))
8770 link (org-make-link cpltxt)))
8771 ((and (featurep 'org-id)
8772 (or (eq org-link-to-org-use-id t)
8773 (and (eq org-link-to-org-use-id 'create-if-interactive)
8774 (org-called-interactively-p 'any))
8775 (and (eq org-link-to-org-use-id
8776 'create-if-interactive-and-no-custom-id)
8777 (org-called-interactively-p 'any)
8778 (not custom-id))
8779 (and org-link-to-org-use-id
8780 (org-entry-get nil "ID"))))
8781 ;; We can make a link using the ID.
8782 (setq link (condition-case nil
8783 (prog1 (org-id-store-link)
8784 (setq desc (plist-get org-store-link-plist
8785 :description)))
8786 (error
8787 ;; probably before first headline, link to file only
8788 (concat "file:"
8789 (abbreviate-file-name
8790 (buffer-file-name (buffer-base-buffer))))))))
8791 (t
8792 ;; Just link to current headline
8793 (setq cpltxt (concat "file:"
8794 (abbreviate-file-name
8795 (buffer-file-name (buffer-base-buffer)))))
8796 ;; Add a context search string
8797 (when (org-xor org-context-in-file-links arg)
8798 (setq txt (cond
8799 ((org-at-heading-p) nil)
8800 ((org-region-active-p)
8801 (buffer-substring (region-beginning) (region-end)))
8802 (t nil)))
8804 (setq cpltxt
8805 (concat cpltxt "::"
8806 (condition-case nil
8807 (org-make-org-heading-search-string txt)
8808 (error "")))
8809 desc (or (nth 4 (ignore-errors
8810 (org-heading-components))) "NONE"))))
8812 (setq cpltxt (substring cpltxt 0 -2)))
8813 (setq link (org-make-link cpltxt)))))
8815 ((buffer-file-name (buffer-base-buffer))
8816 ;; Just link to this file here.
8817 (setq cpltxt (concat "file:"
8818 (abbreviate-file-name
8819 (buffer-file-name (buffer-base-buffer)))))
8820 ;; Add a context string
8821 (when (org-xor org-context-in-file-links arg)
8822 (setq txt (if (org-region-active-p)
8823 (buffer-substring (region-beginning) (region-end))
8824 (buffer-substring (point-at-bol) (point-at-eol))))
8825 ;; Only use search option if there is some text.
8827 (setq cpltxt
8828 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8829 desc "NONE")))
8830 (setq link (org-make-link cpltxt)))
8832 ((org-called-interactively-p 'interactive)
8833 (error "Cannot link to a buffer which is not visiting a file"))
8835 (t (setq link nil)))
8837 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8838 (setq link (or link cpltxt)
8839 desc (or desc cpltxt))
8840 (if (equal desc "NONE") (setq desc nil))
8842 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8843 (progn
8844 (setq org-stored-links
8845 (cons (list link desc) org-stored-links))
8846 (message "Stored: %s" (or desc link))
8847 (when custom-id
8848 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8849 "::#" custom-id))
8850 (setq org-stored-links
8851 (cons (list link desc) org-stored-links))))
8852 (or agenda-link (and link (org-make-link-string link desc)))))))
8854 (defun org-store-link-props (&rest plist)
8855 "Store link properties, extract names and addresses."
8856 (let (x adr)
8857 (when (setq x (plist-get plist :from))
8858 (setq adr (mail-extract-address-components x))
8859 (setq plist (plist-put plist :fromname (car adr)))
8860 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8861 (when (setq x (plist-get plist :to))
8862 (setq adr (mail-extract-address-components x))
8863 (setq plist (plist-put plist :toname (car adr)))
8864 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8865 (let ((from (plist-get plist :from))
8866 (to (plist-get plist :to)))
8867 (when (and from to org-from-is-user-regexp)
8868 (setq plist
8869 (plist-put plist :fromto
8870 (if (string-match org-from-is-user-regexp from)
8871 (concat "to %t")
8872 (concat "from %f"))))))
8873 (setq org-store-link-plist plist))
8875 (defun org-add-link-props (&rest plist)
8876 "Add these properties to the link property list."
8877 (let (key value)
8878 (while plist
8879 (setq key (pop plist) value (pop plist))
8880 (setq org-store-link-plist
8881 (plist-put org-store-link-plist key value)))))
8883 (defun org-email-link-description (&optional fmt)
8884 "Return the description part of an email link.
8885 This takes information from `org-store-link-plist' and formats it
8886 according to FMT (default from `org-email-link-description-format')."
8887 (setq fmt (or fmt org-email-link-description-format))
8888 (let* ((p org-store-link-plist)
8889 (to (plist-get p :toaddress))
8890 (from (plist-get p :fromaddress))
8891 (table
8892 (list
8893 (cons "%c" (plist-get p :fromto))
8894 (cons "%F" (plist-get p :from))
8895 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8896 (cons "%T" (plist-get p :to))
8897 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8898 (cons "%s" (plist-get p :subject))
8899 (cons "%d" (plist-get p :date))
8900 (cons "%m" (plist-get p :message-id)))))
8901 (when (string-match "%c" fmt)
8902 ;; Check if the user wrote this message
8903 (if (and org-from-is-user-regexp from to
8904 (save-match-data (string-match org-from-is-user-regexp from)))
8905 (setq fmt (replace-match "to %t" t t fmt))
8906 (setq fmt (replace-match "from %f" t t fmt))))
8907 (org-replace-escapes fmt table)))
8909 (defun org-make-org-heading-search-string (&optional string heading)
8910 "Make search string for STRING or current headline."
8911 (interactive)
8912 (let ((s (or string (org-get-heading)))
8913 (lines org-context-in-file-links))
8914 (unless (and string (not heading))
8915 ;; We are using a headline, clean up garbage in there.
8916 (if (string-match org-todo-regexp s)
8917 (setq s (replace-match "" t t s)))
8919 (setq s (replace-match "" t t s)))
8920 (setq s (org-trim s))
8923 (setq s (replace-match "" t t s)))
8924 (while (string-match org-ts-regexp s)
8925 (setq s (replace-match "" t t s))))
8926 (or string (setq s (concat "*" s))) ; Add * for headlines
8927 (when (and string (integerp lines) (> lines 0))
8929 (when (< lines (length slines))
8930 (setq s (mapconcat
8931 'identity
8932 (reverse (nthcdr (- (length slines) lines)
8936 (defun org-make-link (&rest strings)
8937 "Concatenate STRINGS."
8938 (apply 'concat strings))
8940 (defun org-make-link-string (link &optional description)
8941 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8943 (error "Empty link"))
8944 (when (and description
8945 (stringp description)
8947 (setq description nil))
8948 (when (stringp description)
8949 ;; Remove brackets from the description, they are fatal.
8951 (setq description (replace-match "{" t t description)))
8953 (setq description (replace-match "}" t t description))))
8954 (when (equal link description)
8955 ;; No description needed, it is identical
8956 (setq description nil))
8957 (when (and (not description)
8958 (not (string-match (org-image-file-name-regexp) link))
8959 (not (equal link (org-link-escape link))))
8960 (setq description (org-extract-attributes link)))
8961 (setq link
8962 (cond ((string-match (org-image-file-name-regexp) link) link)
8963 ((string-match org-link-types-re link)
8964 (concat (match-string 1 link)
8965 (org-link-escape (substring link (match-end 1)))))
8966 (t (org-link-escape link))))
8967 (concat "[[" link "]"
8968 (if description (concat "[" description "]") "")
8969 "]"))
8971 (defconst org-link-escape-chars
8972 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8973 "List of characters that should be escaped in link.
8974 This is the list that is used for internal purposes.")
8976 (defvar org-url-encoding-use-url-hexify nil)
8978 (defconst org-link-escape-chars-browser
8979 '(?\ )
8980 "List of escapes for characters that are problematic in links.
8981 This is the list that is used before handing over to the browser.")
8983 (defun org-link-escape (text &optional table merge)
8984 "Return percent escaped representation of TEXT.
8985 TEXT is a string with the text to escape.
8986 Optional argument TABLE is a list with characters that should be
8987 escaped. When nil, `org-link-escape-chars' is used.
8988 If optional argument MERGE is set, merge TABLE into
8989 `org-link-escape-chars'."
8990 (if (and org-url-encoding-use-url-hexify (not table))
8991 (url-hexify-string text)
8992 (cond
8993 ((and table merge)
8994 (mapc (lambda (defchr)
8995 (unless (member defchr table)
8996 (setq table (cons defchr table)))) org-link-escape-chars))
8997 ((null table)
8998 (setq table org-link-escape-chars)))
8999 (mapconcat
9000 (lambda (char)
9001 (if (or (member char table)
9002 (< char 32) (= char 37) (> char 126))
9003 (mapconcat (lambda (sequence-element)
9004 (format "%%%.2X" sequence-element))
9005 (or (encode-coding-char char 'utf-8)
9006 (error "Unable to percent escape character: %s"
9007 (char-to-string char))) "")
9008 (char-to-string char))) text "")))
9010 (defun org-link-unescape (str)
9011 "Unhex hexified Unicode strings as returned from the JavaScript function
9012 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
9013 (unless (and (null str) (string= "" str))
9014 (let ((pos 0) (case-fold-search t) unhexed)
9016 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9017 (setq str (replace-match unhexed t t str))
9018 (setq pos (+ pos (length unhexed))))))
9019 str)
9021 (defun org-link-unescape-compound (hex)
9022 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
9023 Note: this function also decodes single byte encodings like
9025 (save-match-data
9026 (let* ((bytes (cdr (split-string hex "%")))
9027 (ret "")
9028 (eat 0)
9029 (sum 0))
9030 (while bytes
9031 (let* ((val (string-to-number (pop bytes) 16))
9032 (shift-xor
9033 (if (= 0 eat)
9034 (cond
9035 ((>= val 252) (cons 6 252))
9036 ((>= val 248) (cons 5 248))
9037 ((>= val 240) (cons 4 240))
9038 ((>= val 224) (cons 3 224))
9039 ((>= val 192) (cons 2 192))
9040 (t (cons 0 0)))
9041 (cons 6 128))))
9042 (if (>= val 192) (setq eat (car shift-xor)))
9043 (setq val (logxor val (cdr shift-xor)))
9044 (setq sum (+ (lsh sum (car shift-xor)) val))
9045 (if (> eat 0) (setq eat (- eat 1)))
9046 (cond
9047 ((= 0 eat) ;multi byte
9048 (setq ret (concat ret (org-char-to-string sum)))
9049 (setq sum 0))
9050 ((not bytes) ; single byte(s)
9051 (setq ret (org-link-unescape-single-byte-sequence hex))))
9052 )) ;; end (while bytes
9053 ret )))
9055 (defun org-link-unescape-single-byte-sequence (hex)
9056 "Unhexify hex-encoded single byte character sequences."
9057 (mapconcat (lambda (byte)
9058 (char-to-string (string-to-number byte 16)))
9059 (cdr (split-string hex "%")) ""))
9061 (defun org-xor (a b)
9062 "Exclusive or."
9063 (if a (not b) b))
9065 (defun org-fixup-message-id-for-http (s)
9066 "Replace special characters in a message id, so it can be used in an http query."
9067 (when (string-match "%" s)
9068 (setq s (mapconcat (lambda (c)
9069 (if (eq c ?%)
9070 "%25"
9071 (char-to-string c)))
9072 s "")))
9073 (while (string-match "<" s)
9074 (setq s (replace-match "%3C" t t s)))
9075 (while (string-match ">" s)
9076 (setq s (replace-match "%3E" t t s)))
9077 (while (string-match "@" s)
9078 (setq s (replace-match "%40" t t s)))
9079 s)
9081 ;;;###autoload
9082 (defun org-insert-link-global ()
9083 "Insert a link like Org-mode does.
9084 This command can be called in any mode to insert a link in Org-mode syntax."
9085 (interactive)
9086 (org-load-modules-maybe)
9087 (org-run-like-in-org-mode 'org-insert-link))
9089 (defun org-insert-link (&optional complete-file link-location default-description)
9090 "Insert a link. At the prompt, enter the link.
9092 Completion can be used to insert any of the link protocol prefixes like
9093 http or ftp in use.
9095 The history can be used to select a link previously stored with
9096 `org-store-link'. When the empty string is entered (i.e. if you just
9097 press RET at the prompt), the link defaults to the most recently
9098 stored link. As SPC triggers completion in the minibuffer, you need to
9099 use M-SPC or C-q SPC to force the insertion of a space character.
9101 You will also be prompted for a description, and if one is given, it will
9102 be displayed in the buffer instead of the link.
9104 If there is already a link at point, this command will allow you to edit link
9105 and description parts.
9108 be selected using completion. The path to the file will be relative to the
9109 current directory if the file is in the current directory or a subdirectory.
9110 Otherwise, the link will be the absolute path as completed in the minibuffer
9111 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9112 option `org-link-file-path-type'.
9115 the current directory or below.
9118 `org-keep-stored-link-after-insertion'.
9120 If `org-make-link-description-function' is non-nil, this function will be
9121 called with the link target, and the result will be the default
9122 link description.
9124 If the LINK-LOCATION parameter is non-nil, this value will be
9125 used as the link location instead of reading one interactively.
9127 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9128 be used as the default description."
9129 (interactive "P")
9130 (let* ((wcf (current-window-configuration))
9131 (region (if (org-region-active-p)
9132 (buffer-substring (region-beginning) (region-end))))
9133 (remove (and region (list (region-beginning) (region-end))))
9134 (desc region)
9135 tmphist ; byte-compile incorrectly complains about this
9136 (link link-location)
9137 entry file all-prefixes)
9138 (cond
9139 (link-location) ; specified by arg, just use it.
9140 ((org-in-regexp org-bracket-link-regexp 1)
9141 ;; We do have a link at point, and we are going to edit it.
9142 (setq remove (list (match-beginning 0) (match-end 0)))
9143 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9144 (setq link (read-string "Link: "
9145 (org-link-unescape
9146 (org-match-string-no-properties 1)))))
9147 ((or (org-in-regexp org-angle-link-re)
9148 (org-in-regexp org-plain-link-re))
9149 ;; Convert to bracket link
9150 (setq remove (list (match-beginning 0) (match-end 0))
9151 link (read-string "Link: "
9152 (org-remove-angle-brackets (match-string 0)))))
9153 ((member complete-file '((4) (16)))
9154 ;; Completing read for file names.
9155 (setq link (org-file-complete-link complete-file)))
9156 (t
9157 ;; Read link, with completion for stored links.
9158 (with-output-to-temp-buffer "*Org Links*"
9159 (princ "Insert a link.
9161 (when org-stored-links
9163 (princ (mapconcat
9164 (lambda (x)
9165 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9167 (let ((cw (selected-window)))
9168 (select-window (get-buffer-window "*Org Links*" 'visible))
9169 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9170 (unless (pos-visible-in-window-p (point-max))
9171 (org-fit-window-to-buffer))
9172 (and (window-live-p cw) (select-window cw)))
9173 ;; Fake a link history, containing the stored links.
9174 (setq tmphist (append (mapcar 'car org-stored-links)
9175 org-insert-link-history))
9176 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9177 (mapcar 'car org-link-abbrev-alist)
9178 org-link-types))
9179 (unwind-protect
9180 (progn
9181 (setq link
9182 (let ((org-completion-use-ido nil)
9183 (org-completion-use-iswitchb nil))
9184 (org-completing-read
9185 "Link: "
9186 (append
9187 (mapcar (lambda (x) (list (concat x ":")))
9188 all-prefixes)
9189 (mapcar 'car org-stored-links))
9190 nil nil nil
9191 'tmphist
9192 (car (car org-stored-links)))))
9194 (error "No link selected"))
9195 (if (or (member link all-prefixes)
9196 (and (equal ":" (substring link -1))
9197 (member (substring link 0 -1) all-prefixes)
9198 (setq link (substring link 0 -1))))
9199 (setq link (org-link-try-special-completion link))))
9200 (set-window-configuration wcf)
9201 (kill-buffer "*Org Links*"))
9202 (setq entry (assoc link org-stored-links))
9203 (or entry (push link org-insert-link-history))
9204 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9205 (not org-keep-stored-link-after-insertion))
9206 (setq org-stored-links (delq (assoc link org-stored-links)
9207 org-stored-links)))
9208 (setq desc (or desc (nth 1 entry)))))
9210 (if (string-match org-plain-link-re link)
9211 ;; URL-like link, normalize the use of angular brackets.
9212 (setq link (org-make-link (org-remove-angle-brackets link))))
9214 ;; Check if we are linking to the current file with a search option
9215 ;; If yes, simplify the link by using only the search option.
9216 (when (and buffer-file-name
9218 (let* ((path (match-string 1 link))
9219 (case-fold-search nil)
9220 (search (match-string 2 link)))
9221 (save-match-data
9222 (if (equal (file-truename buffer-file-name) (file-truename path))
9223 ;; We are linking to this same file, with a search option
9224 (setq link search)))))
9226 ;; Check if we can/should use a relative path. If yes, simplify the link
9228 (let* ((type (match-string 1 link))
9229 (path (match-string 2 link))
9230 (origpath path)
9231 (case-fold-search nil))
9232 (cond
9233 ((or (eq org-link-file-path-type 'absolute)
9234 (equal complete-file '(16)))
9235 (setq path (abbreviate-file-name (expand-file-name path))))
9236 ((eq org-link-file-path-type 'noabbrev)
9237 (setq path (expand-file-name path)))
9238 ((eq org-link-file-path-type 'relative)
9239 (setq path (file-relative-name path)))
9240 (t
9241 (save-match-data
9242 (if (string-match (concat "^" (regexp-quote
9243 (expand-file-name
9244 (file-name-as-directory
9245 default-directory))))
9246 (expand-file-name path))
9247 ;; We are linking a file with relative path name.
9248 (setq path (substring (expand-file-name path)
9249 (match-end 0)))
9250 (setq path (abbreviate-file-name (expand-file-name path)))))))
9251 (setq link (concat type path))
9252 (if (equal desc origpath)
9253 (setq desc path))))
9255 (if org-make-link-description-function
9256 (setq desc (funcall org-make-link-description-function link desc))
9257 (if default-description (setq desc default-description)))
9259 (setq desc (read-string "Description: " desc))
9261 (if remove (apply 'delete-region remove))
9262 (insert (org-make-link-string link desc))))
9264 (defun org-link-try-special-completion (type)
9265 "If there is completion support for link type TYPE, offer it."
9266 (let ((fun (intern (concat "org-" type "-complete-link"))))
9267 (if (functionp fun)
9268 (funcall fun)
9269 (read-string "Link (no completion support): " (concat type ":")))))
9271 (defun org-file-complete-link (&optional arg)
9272 "Create a file link using completion."
9273 (let (file link)
9274 (setq file (read-file-name "File: "))
9275 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9276 (pwd1 (file-name-as-directory (abbreviate-file-name
9277 (expand-file-name ".")))))
9278 (cond
9279 ((equal arg '(16))
9280 (setq link (org-make-link
9281 "file:"
9282 (abbreviate-file-name (expand-file-name file)))))
9284 (setq link (org-make-link "file:" (match-string 1 file))))
9286 (expand-file-name file))
9287 (setq link (org-make-link
9288 "file:" (match-string 1 (expand-file-name file)))))
9289 (t (setq link (org-make-link "file:" file)))))
9290 link))
9292 (defun org-completing-read (&rest args)
9293 "Completing-read with SPACE being a normal character."
9294 (let ((enable-recursive-minibuffers t)
9295 (minibuffer-local-completion-map
9296 (copy-keymap minibuffer-local-completion-map)))
9297 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9298 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9299 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9300 (apply 'org-icompleting-read args)))
9302 (defun org-completing-read-no-i (&rest args)
9303 (let (org-completion-use-ido org-completion-use-iswitchb)
9304 (apply 'org-completing-read args)))
9306 (defun org-iswitchb-completing-read (prompt choices &rest args)
9307 "Use iswitch as a completing-read replacement to choose from choices.
9308 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9309 from."
9310 (let* ((iswitchb-use-virtual-buffers nil)
9311 (iswitchb-make-buflist-hook
9312 (lambda ()
9313 (setq iswitchb-temp-buflist choices))))
9314 (iswitchb-read-buffer prompt)))
9316 (defun org-icompleting-read (&rest args)
9317 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9318 (org-without-partial-completion
9319 (if (and org-completion-use-ido
9320 (fboundp 'ido-completing-read)
9321 (boundp 'ido-mode) ido-mode
9322 (listp (second args)))
9323 (let ((ido-enter-matching-directory nil))
9324 (apply 'ido-completing-read (concat (car args))
9325 (if (consp (car (nth 1 args)))
9326 (mapcar 'car (nth 1 args))
9327 (nth 1 args))
9328 (cddr args)))
9329 (if (and org-completion-use-iswitchb
9330 (boundp 'iswitchb-mode) iswitchb-mode
9331 (listp (second args)))
9332 (apply 'org-iswitchb-completing-read (concat (car args))
9333 (if (consp (car (nth 1 args)))
9334 (mapcar 'car (nth 1 args))
9335 (nth 1 args))
9336 (cddr args))
9337 (apply 'completing-read args)))))
9339 (defun org-extract-attributes (s)
9340 "Extract the attributes cookie from a string and set as text property."
9341 (let (a attr (start 0) key value)
9342 (save-match-data
9344 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9346 (setq key (match-string 1 a) value (match-string 2 a)
9347 start (match-end 0)
9348 attr (plist-put attr (intern key) value))))
9349 (org-add-props s nil 'org-attr attr))
9350 s))
9352 (defun org-extract-attributes-from-string (tag)
9353 (let (key value attr)
9355 (setq key (match-string 1 tag) value (match-string 2 tag)
9356 tag (replace-match "" t t tag)
9357 attr (plist-put attr (intern key) value)))
9358 (cons tag attr)))
9360 (defun org-attributes-to-string (plist)
9361 "Format a property list into an HTML attribute list."
9362 (let ((s "") key value)
9363 (while plist
9364 (setq key (pop plist) value (pop plist))
9365 (and value
9367 s))
9369 ;;; Opening/following a link
9371 (defvar org-link-search-failed nil)
9373 (defvar org-open-link-functions nil
9374 "Hook for functions finding a plain text link.
9375 These functions must take a single argument, the link content.
9376 They will be called for links that look like [[link text][description]]
9380 These functions will be called *before* Org attempts to resolve the
9381 link by doing text searches in the current buffer - so if you want a
9383 handle this as a special case.
9385 When the function does handle the link, it must return a non-nil value.
9386 If it decides that it is not responsible for this link, it must return
9387 nil to indicate that that Org-mode can continue with other options
9388 like exact and fuzzy text search.")
9390 (defun org-next-link ()
9391 "Move forward to the next link.
9392 If the link is in hidden text, expose it."
9393 (interactive)
9394 (when (and org-link-search-failed (eq this-command last-command))
9395 (goto-char (point-min))
9396 (message "Link search wrapped back to beginning of buffer"))
9397 (setq org-link-search-failed nil)
9398 (let* ((pos (point))
9399 (ct (org-context))
9400 (a (assoc :link ct)))
9401 (if a (goto-char (nth 2 a)))
9402 (if (re-search-forward org-any-link-re nil t)
9403 (progn
9404 (goto-char (match-beginning 0))
9405 (if (outline-invisible-p) (org-show-context)))
9406 (goto-char pos)
9407 (setq org-link-search-failed t)
9408 (error "No further link found"))))
9410 (defun org-previous-link ()
9411 "Move backward to the previous link.
9412 If the link is in hidden text, expose it."
9413 (interactive)
9414 (when (and org-link-search-failed (eq this-command last-command))
9415 (goto-char (point-max))
9416 (message "Link search wrapped back to end of buffer"))
9417 (setq org-link-search-failed nil)
9418 (let* ((pos (point))
9419 (ct (org-context))
9420 (a (assoc :link ct)))
9421 (if a (goto-char (nth 1 a)))
9422 (if (re-search-backward org-any-link-re nil t)
9423 (progn
9424 (goto-char (match-beginning 0))
9425 (if (outline-invisible-p) (org-show-context)))
9426 (goto-char pos)
9427 (setq org-link-search-failed t)
9428 (error "No further link found"))))
9430 (defun org-translate-link (s)
9431 "Translate a link string if a translation function has been defined."
9432 (if (and org-link-translation-function
9433 (fboundp org-link-translation-function)
9435 (progn
9436 (setq s (funcall org-link-translation-function
9437 (match-string 1) (match-string 2)))
9438 (concat (car s) ":" (cdr s)))
9439 s))
9441 (defun org-translate-link-from-planner (type path)
9442 "Translate a link from Emacs Planner syntax so that Org can follow it.
9443 This is still an experimental function, your mileage may vary."
9444 (cond
9445 ((member type '("http" "https" "news" "ftp"))
9446 ;; standard Internet links are the same.
9447 nil)
9448 ((and (equal type "irc") (string-match "^//" path))
9449 ;; Planner has two / at the beginning of an irc link, we have 1.
9450 ;; We should have zero, actually....
9451 (setq path (substring path 1)))
9452 ((and (equal type "lisp") (string-match "^/" path))
9453 ;; Planner has a slash, we do not.
9454 (setq type "elisp" path (substring path 1)))
9456 ;; A typical message link. Planner has the id after the final slash,
9457 ;; we separate it with a hash mark
9458 (setq path (concat (match-string 1 path) "#"
9459 (org-remove-angle-brackets (match-string 2 path)))))
9460 )
9461 (cons type path))
9463 (defun org-find-file-at-mouse (ev)
9464 "Open file link or URL at mouse."
9465 (interactive "e")
9466 (mouse-set-point ev)
9467 (org-open-at-point 'in-emacs))
9469 (defun org-open-at-mouse (ev)
9470 "Open file link or URL at mouse.
9471 See the docstring of `org-open-file' for details."
9472 (interactive "e")
9473 (mouse-set-point ev)
9474 (if (eq major-mode 'org-agenda-mode)
9475 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9476 (org-open-at-point))
9478 (defvar org-window-config-before-follow-link nil
9479 "The window configuration before following a link.
9480 This is saved in case the need arises to restore it.")
9482 (defvar org-open-link-marker (make-marker)
9483 "Marker pointing to the location where `org-open-at-point; was called.")
9485 ;;;###autoload
9486 (defun org-open-at-point-global ()
9487 "Follow a link like Org-mode does.
9488 This command can be called in any mode to follow a link that has
9489 Org-mode syntax."
9490 (interactive)
9491 (org-run-like-in-org-mode 'org-open-at-point))
9493 ;;;###autoload
9494 (defun org-open-link-from-string (s &optional arg reference-buffer)
9495 "Open a link in the string S, as if it was in Org-mode."
9497 (let ((reference-buffer (or reference-buffer (current-buffer))))
9498 (with-temp-buffer
9499 (let ((org-inhibit-startup (not reference-buffer)))
9500 (org-mode)
9501 (insert s)
9502 (goto-char (point-min))
9503 (when reference-buffer
9504 (setq org-link-abbrev-alist-local
9505 (with-current-buffer reference-buffer
9506 org-link-abbrev-alist-local)))
9507 (org-open-at-point arg reference-buffer)))))
9509 (defvar org-open-at-point-functions nil
9510 "Hook that is run when following a link at point.
9512 Functions in this hook must return t if they identify and follow
9513 a link at point. If they don't find anything interesting at point,
9514 they must return nil.")
9516 (defun org-open-at-point (&optional arg reference-buffer)
9517 "Open link at or after point.
9518 If there is no link at point, this function will search forward up to
9519 the end of the current line.
9520 Normally, files will be opened by an appropriate application. If the
9521 optional prefix argument ARG is non-nil, Emacs will visit the file.
9522 With a double prefix argument, try to open outside of Emacs, in the
9523 application the system uses for this file type."
9524 (interactive "P")
9525 ;; if in a code block, then open the block's results
9526 (unless (call-interactively #'org-babel-open-src-block-result)
9527 (org-load-modules-maybe)
9528 (move-marker org-open-link-marker (point))
9529 (setq org-window-config-before-follow-link (current-window-configuration))
9530 (org-remove-occur-highlights nil nil t)
9531 (cond
9532 ((and (org-at-heading-p)
9533 (not (org-in-regexp
9538 (not (get-text-property (point) 'org-linked-text)))
9539 (or (org-offer-links-in-entry arg)
9540 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9541 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9542 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9543 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9544 (not (org-in-regexp org-bracket-link-regexp)))
9545 (org-footnote-action))
9546 (t
9547 (let (type path link line search (pos (point)))
9548 (catch 'match
9549 (save-excursion
9551 (when (org-in-regexp org-bracket-link-regexp 1)
9552 (setq link (org-extract-attributes
9553 (org-link-unescape (org-match-string-no-properties 1))))
9555 (setq link (replace-match " " t t link)))
9556 (setq link (org-link-expand-abbrev link))
9557 (cond
9558 ((or (file-name-absolute-p link)
9560 (setq type "file" path link))
9561 ((string-match org-link-re-with-space3 link)
9562 (setq type (match-string 1 link) path (match-string 2 link)))
9563 (t (setq type "thisfile" path link)))
9564 (throw 'match t)))
9566 (when (get-text-property (point) 'org-linked-text)
9567 (setq type "thisfile"
9568 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9569 (1+ (point)) (point))
9570 path (buffer-substring
9571 (or (previous-single-property-change pos 'org-linked-text)
9572 (point-min))
9573 (or (next-single-property-change pos 'org-linked-text)
9574 (point-max))))
9575 (throw 'match t))
9577 (save-excursion
9578 (when (or (org-in-regexp org-angle-link-re)
9579 (org-in-regexp org-plain-link-re))
9580 (setq type (match-string 1)
9581 path (org-link-unescape (match-string 2)))
9582 (throw 'match t)))
9583 (save-excursion
9585 (setq type "tags"
9586 path (match-string 1))
9587 (while (string-match ":" path)
9588 (setq path (replace-match "+" t t path)))
9589 (throw 'match t)))
9591 (setq type "tree-match"
9592 path (match-string 1))
9593 (throw 'match t)))
9594 (unless path
9595 (error "No link found"))
9597 ;; switch back to reference buffer
9598 ;; needed when if called in a temporary buffer through
9599 ;; org-open-link-from-string
9600 (with-current-buffer (or reference-buffer (current-buffer))
9602 ;; Remove any trailing spaces in path
9604 (setq path (replace-match "" t t path)))
9605 (if (and org-link-translation-function
9606 (fboundp org-link-translation-function))
9607 ;; Check if we need to translate the link
9608 (let ((tmp (funcall org-link-translation-function type path)))
9609 (setq type (car tmp) path (cdr tmp))))
9611 (cond
9613 ((assoc type org-link-protocols)
9614 (funcall (nth 1 (assoc type org-link-protocols)) path))
9616 ((equal type "mailto")
9617 (let ((cmd (car org-link-mailto-program))
9618 (args (cdr org-link-mailto-program)) args1
9619 (address path) (subject "") a)
9621 (setq address (match-string 1 path)
9622 subject (org-link-escape (match-string 2 path))))
9623 (while args
9624 (cond
9625 ((not (stringp (car args))) (push (pop args) args1))
9626 (t (setq a (pop args))
9627 (if (string-match "%a" a)
9628 (setq a (replace-match address t t a)))
9629 (if (string-match "%s" a)
9630 (setq a (replace-match subject t t a)))
9631 (push a args1))))
9632 (apply cmd (nreverse args1))))
9634 ((member type '("http" "https" "ftp" "news"))
9635 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9636 (org-link-escape
9637 path org-link-escape-chars-browser)
9638 path))))
9640 ((string= type "doi")
9641 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9642 (org-link-escape
9643 path org-link-escape-chars-browser)
9644 path))))
9646 ((member type '("message"))
9647 (browse-url (concat type ":" path)))
9649 ((string= type "tags")
9650 (org-tags-view arg path))
9652 ((string= type "tree-match")
9655 ((string= type "file")
9657 (setq line (string-to-number (match-string 1 path))
9658 path (substring path 0 (match-beginning 0)))
9660 (setq search (match-string 1 path)
9661 path (substring path 0 (match-beginning 0)))))
9662 (if (string-match "[*?{]" (file-name-nondirectory path))
9663 (dired path)
9664 (org-open-file path arg line search)))
9666 ((string= type "shell")
9667 (let ((cmd path))
9668 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9669 (string-match org-confirm-shell-link-not-regexp cmd))
9670 (not org-confirm-shell-link-function)
9671 (funcall org-confirm-shell-link-function
9673 (org-add-props cmd nil
9674 'face 'org-warning))))
9675 (progn
9676 (message "Executing %s" cmd)
9677 (shell-command cmd))
9678 (error "Abort"))))
9680 ((string= type "elisp")
9681 (let ((cmd path))
9682 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9683 (string-match org-confirm-elisp-link-not-regexp cmd))
9684 (not org-confirm-elisp-link-function)
9685 (funcall org-confirm-elisp-link-function
9687 (org-add-props cmd nil
9688 'face 'org-warning))))
9689 (message "%s => %s" cmd
9690 (if (equal (string-to-char cmd) ?\()
9691 (eval (read cmd))
9692 (call-interactively (read cmd))))
9693 (error "Abort"))))
9695 ((and (string= type "thisfile")
9696 (run-hook-with-args-until-success
9697 'org-open-link-functions path)))
9699 ((string= type "thisfile")
9700 (if arg
9701 (switch-to-buffer-other-window
9702 (org-get-buffer-for-internal-link (current-buffer)))
9703 (org-mark-ring-push))
9704 (let ((cmd `(org-link-search
9705 ,path
9706 ,(cond ((equal arg '(4)) ''occur)
9707 ((equal arg '(16)) ''org-occur)
9708 (t nil))
9709 ,pos)))
9710 (condition-case nil (let ((org-link-search-inhibit-query t))
9711 (eval cmd))
9712 (error (progn (widen) (eval cmd))))))
9714 (t
9715 (browse-url-at-point)))))))
9716 (move-marker org-open-link-marker nil)
9717 (run-hook-with-args 'org-follow-link-hook)))
9719 (defun org-offer-links-in-entry (&optional nth zero)
9720 "Offer links in the current entry and follow the selected link.
9721 If there is only one link, follow it immediately as well.
9722 If NTH is an integer, immediately pick the NTH link found.
9723 If ZERO is a string, check also this string for a link, and if
9724 there is one, offer it as link number zero."
9728 (cnt ?0)
9729 (in-emacs (if (integerp nth) nil nth))
9730 have-zero end links link c)
9731 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9732 (push (match-string 0 zero) links)
9733 (setq cnt (1- cnt) have-zero t))
9734 (save-excursion
9735 (org-back-to-heading t)
9736 (setq end (save-excursion (outline-next-heading) (point)))
9737 (while (re-search-forward re end t)
9738 (push (match-string 0) links))
9739 (setq links (org-uniquify (reverse links))))
9741 (cond
9742 ((null links)
9743 (message "No links"))
9744 ((equal (length links) 1)
9745 (setq link (list (car links))))
9746 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9747 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9748 (t ; we have to select a link
9749 (save-excursion
9750 (save-window-excursion
9751 (delete-other-windows)
9752 (with-output-to-temp-buffer "*Select Link*"
9753 (mapc (lambda (l)
9754 (if (not (string-match org-bracket-link-regexp l))
9756 (org-remove-angle-brackets l)))
9757 (if (match-end 3)
9759 (match-string 3 l) (match-string 1 l)))
9761 (match-string 1 l))))))
9762 links))
9763 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9764 (message "Select link to open, RET to open all:")
9765 (setq c (read-char-exclusive))
9766 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9767 (when (equal c ?q) (error "Abort"))
9768 (if (equal c ?\C-m)
9769 (setq link links)
9770 (setq nth (- c ?0))
9771 (if have-zero (setq nth (1+ nth)))
9772 (unless (and (integerp nth) (>= (length links) nth))
9773 (error "Invalid link selection"))
9774 (setq link (list (nth (1- nth) links))))))
9775 (if link
9776 (let ((buf (current-buffer)))
9777 (dolist (l link)
9778 (org-open-link-from-string l in-emacs buf))
9779 t)
9780 nil)))
9782 ;; Add special file links that specify the way of opening
9784 (org-add-link-type "file+sys" 'org-open-file-with-system)
9785 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9786 (defun org-open-file-with-system (path)
9787 "Open file at PATH using the system way of opening it."
9788 (org-open-file path 'system))
9789 (defun org-open-file-with-emacs (path)
9790 "Open file at PATH in Emacs."
9791 (org-open-file path 'emacs))
9792 (defun org-remove-file-link-modifiers ()
9793 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9794 (goto-char (point-min))
9796 (org-if-unprotected
9797 (replace-match "file:" t t))))
9798 (eval-after-load "org-exp"
9799 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9800 'org-remove-file-link-modifiers))
9802 ;;;; Time estimates
9804 (defun org-get-effort (&optional pom)
9805 "Get the effort estimate for the current entry."
9806 (org-entry-get pom org-effort-property))
9808 ;;; File search
9810 (defvar org-create-file-search-functions nil
9811 "List of functions to construct the right search string for a file link.
9812 These functions are called in turn with point at the location to
9813 which the link should point.
9815 A function in the hook should first test if it would like to
9816 handle this file type, for example by checking the `major-mode'
9817 or the file extension. If it decides not to handle this file, it
9818 should just return nil to give other functions a chance. If it
9819 does handle the file, it must return the search string to be used
9820 when following the link. The search string will be part of the
9821 file link, given after a double colon, and `org-open-at-point'
9822 will automatically search for it. If special measures must be
9823 taken to make the search successful, another function should be
9824 added to the companion hook `org-execute-file-search-functions',
9825 which see.
9827 A function in this hook may also use `setq' to set the variable
9828 `description' to provide a suggestion for the descriptive text to
9829 be used for this link when it gets inserted into an Org-mode
9832 (defvar org-execute-file-search-functions nil
9833 "List of functions to execute a file search triggered by a link.
9835 Functions added to this hook must accept a single argument, the
9836 search string that was part of the file link, the part after the
9837 double colon. The function must first check if it would like to
9838 handle this search, for example by checking the `major-mode' or
9839 the file extension. If it decides not to handle this search, it
9840 should just return nil to give other functions a chance. If it
9841 does handle the search, it must return a non-nil value to keep
9842 other functions from trying.
9844 Each function can access the current prefix argument through the
9845 variable `current-prefix-argument'. Note that a single prefix is
9846 used to force opening a link in Emacs, so it may be good to only
9847 use a numeric or double prefix to guide the search function.
9849 In case this is needed, a function in this hook can also restore
9850 the window configuration before `org-open-at-point' was called using:
9852 (set-window-configuration org-window-config-before-follow-link)")
9854 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9855 (defun org-link-search (s &optional type avoid-pos stealth)
9856 "Search for a link search option.
9857 If S is surrounded by forward slashes, it is interpreted as a
9858 regular expression. In org-mode files, this will create an `org-occur'
9859 sparse tree. In ordinary files, `occur' will be used to list matches.
9860 If the current buffer is in `dired-mode', grep will be used to search
9861 in all files. If AVOID-POS is given, ignore matches near that position.
9863 When optional argument STEALTH is non-nil, do not modify
9864 visibility around point, thus ignoring
9865 `org-show-hierarchy-above', `org-show-following-heading' and
9866 `org-show-siblings' variables."
9867 (let ((case-fold-search t)
9871 org-emphasis-alist)
9873 (pos (point))
9874 (pre nil) (post nil)
9875 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9876 (cond
9877 ;; First check if there are any special search functions
9878 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9879 ;; Now try the builtin stuff
9880 ((and (equal (string-to-char s0) ?#)
9881 (> (length s0) 1)
9882 (save-excursion
9883 (goto-char (point-min))
9884 (and
9885 (re-search-forward
9887 (setq type 'dedicated
9888 pos (match-beginning 0))))
9889 ;; There is an exact target for this
9890 (goto-char pos)
9891 (org-back-to-heading t)))
9892 ((save-excursion
9893 (goto-char (point-min))
9894 (and
9895 (re-search-forward
9896 (concat "<<" (regexp-quote s0) ">>") nil t)
9897 (setq type 'dedicated
9898 pos (match-beginning 0))))
9899 ;; There is an exact target for this
9900 (goto-char pos))
9902 (save-excursion
9903 (goto-char (point-min))
9904 (and
9905 (re-search-forward
9906 (concat "[^[]" (regexp-quote
9907 (format org-coderef-label-format
9908 (match-string 1 s0))))
9909 nil t)
9910 (setq type 'dedicated
9911 pos (1+ (match-beginning 0))))))
9912 ;; There is a coderef target for this
9913 (goto-char pos))
9915 ;; A regular expression
9916 (cond
9917 ((eq major-mode 'org-mode)
9918 (org-occur (match-string 1 s)))
9919 ;;((eq major-mode 'dired-mode)
9920 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9921 (t (org-do-occur (match-string 1 s)))))
9922 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9923 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9924 (goto-char (point-min))
9925 (cond
9926 ((let (case-fold-search)
9927 (re-search-forward (format org-complex-heading-regexp-format
9928 (regexp-quote s))
9929 nil t))
9930 ;; OK, found a match
9931 (setq type 'dedicated)
9932 (goto-char (match-beginning 0)))
9933 ((and (not org-link-search-inhibit-query)
9934 (eq org-link-search-must-match-exact-headline 'query-to-create)
9935 (y-or-n-p "No match - create this as a new heading? "))
9936 (goto-char (point-max))
9937 (or (bolp) (newline))
9939 (beginning-of-line 0))
9940 (t
9941 (goto-char pos)
9942 (error "No match"))))
9943 (t
9944 ;; A normal search string
9945 (when (equal (string-to-char s) ?*)
9946 ;; Anchor on headlines, post may include tags.
9949 s (substring s 1)))
9950 (remove-text-properties
9951 0 (length s)
9952 '(face nil mouse-face nil keymap nil fontified nil) s)
9953 ;; Make a series of regular expressions to find a match
9962 re4 (concat "[^a-zA-Z_]" re4_)
9964 re1 (concat pre re2 post)
9965 re3 (concat pre (if pre re4_ re4) post)
9966 re5 (concat pre ".*" re4)
9967 re2 (concat pre re2)
9968 re2a (concat pre (if pre re2a_ re2a))
9969 re4 (concat pre (if pre re4_ re4))
9973 ))
9974 (cond
9975 ((eq type 'org-occur) (org-occur reall))
9976 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9977 (t (goto-char (point-min))
9978 (setq type 'fuzzy)
9979 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9980 (org-search-not-self 1 re1 nil t)
9981 (org-search-not-self 1 re2 nil t)
9982 (org-search-not-self 1 re2a nil t)
9983 (org-search-not-self 1 re3 nil t)
9984 (org-search-not-self 1 re4 nil t)
9985 (org-search-not-self 1 re5 nil t)
9986 )
9987 (goto-char (match-beginning 1))
9988 (goto-char pos)
9989 (error "No match"))))))
9990 (and (eq major-mode 'org-mode)
9991 (not stealth)
9992 (org-show-context 'link-search))
9993 type))
9995 (defun org-search-not-self (group &rest args)
9996 "Execute `re-search-forward', but only accept matches that do not
9997 enclose the position of `org-open-link-marker'."
9998 (let ((m org-open-link-marker))
9999 (catch 'exit
10000 (while (apply 're-search-forward args)
10001 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10002 (goto-char (match-end group))
10003 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10004 (> (match-beginning 0) (marker-position m))
10005 (< (match-end 0) (marker-position m)))
10006 (save-match-data
10007 (or (not (org-in-regexp
10008 org-bracket-link-analytic-regexp 1))
10009 (not (match-end 4)) ; no description
10010 (and (<= (match-beginning 4) (point))
10011 (>= (match-end 4) (point))))))
10012 (throw 'exit (point))))))))
10014 (defun org-get-buffer-for-internal-link (buffer)
10015 "Return a buffer to be used for displaying the link target of internal links."
10016 (cond
10017 ((not org-display-internal-link-with-indirect-buffer)
10018 buffer)
10019 ((string-match "(Clone)$" (buffer-name buffer))
10020 (message "Buffer is already a clone, not making another one")
10021 ;; we also do not modify visibility in this case
10022 buffer)
10023 (t ; make a new indirect buffer for displaying the link
10024 (let* ((bn (buffer-name buffer))
10025 (ibn (concat bn "(Clone)"))
10026 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10027 (with-current-buffer ib (org-overview))
10028 ib))))
10030 (defun org-do-occur (regexp &optional cleanup)
10031 "Call the Emacs command `occur'.
10032 If CLEANUP is non-nil, remove the printout of the regular expression
10033 in the *Occur* buffer. This is useful if the regex is long and not useful
10034 to read."
10035 (occur regexp)
10036 (when cleanup
10037 (let ((cwin (selected-window)) win beg end)
10038 (when (setq win (get-buffer-window "*Occur*"))
10039 (select-window win))
10040 (goto-char (point-min))
10041 (when (re-search-forward "match[a-z]+" nil t)
10042 (setq beg (match-end 0))
10044 (setq end (1- (match-beginning 0)))))
10045 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10046 (goto-char (point-min))
10047 (select-window cwin))))
10049 ;;; The mark ring for links jumps
10051 (defvar org-mark-ring nil
10052 "Mark ring for positions before jumps in Org-mode.")
10053 (defvar org-mark-ring-last-goto nil
10054 "Last position in the mark ring used to go back.")
10055 ;; Fill and close the ring
10056 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10057 (loop for i from 1 to org-mark-ring-length do
10058 (push (make-marker) org-mark-ring))
10059 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10060 org-mark-ring)
10062 (defun org-mark-ring-push (&optional pos buffer)
10063 "Put the current position or POS into the mark ring and rotate it."
10064 (interactive)
10065 (setq pos (or pos (point)))
10066 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10067 (move-marker (car org-mark-ring)
10068 (or pos (point))
10069 (or buffer (current-buffer)))
10070 (message "%s"
10071 (substitute-command-keys
10074 (defun org-mark-ring-goto (&optional n)
10075 "Jump to the previous position in the mark ring.
10076 With prefix arg N, jump back that many stored positions. When
10077 called several times in succession, walk through the entire ring.
10078 Org-mode commands jumping to a different position in the current file,
10079 or to another Org-mode file, automatically push the old position
10080 onto the ring."
10081 (interactive "p")
10082 (let (p m)
10083 (if (eq last-command this-command)
10084 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10085 (setq p org-mark-ring))
10086 (setq org-mark-ring-last-goto p)
10087 (setq m (car p))
10088 (org-pop-to-buffer-same-window (marker-buffer m))
10089 (goto-char m)
10090 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10092 (defun org-remove-angle-brackets (s)
10093 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10094 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10095 s)
10096 (defun org-add-angle-brackets (s)
10097 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10098 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10099 s)
10100 (defun org-remove-double-quotes (s)
10103 s)
10105 ;;; Following specific links
10107 (defun org-follow-timestamp-link ()
10108 (cond
10109 ((org-at-date-range-p t)
10110 (let ((org-agenda-start-on-weekday)
10111 (t1 (match-string 1))
10112 (t2 (match-string 2)))
10113 (setq t1 (time-to-days (org-time-string-to-time t1))
10114 t2 (time-to-days (org-time-string-to-time t2)))
10115 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10116 ((org-at-timestamp-p t)
10117 (org-agenda-list nil (time-to-days (org-time-string-to-time
10118 (substring (match-string 1) 0 10)))
10119 1))
10120 (t (error "This should not happen"))))
10123 ;;; Following file links
10124 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10125 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10126 (declare-function mailcap-mime-info
10127 "mailcap" (string &optional request no-decode))
10128 (defvar org-wait nil)
10129 (defun org-open-file (path &optional in-emacs line search)
10130 "Open the file at PATH.
10131 First, this expands any special file name abbreviations. Then the
10132 configuration variable `org-file-apps' is checked if it contains an
10133 entry for this file type, and if yes, the corresponding command is launched.
10135 If no application is found, Emacs simply visits the file.
10137 With optional prefix argument IN-EMACS, Emacs will visit the file.
10139 prefix arg, Org tries to avoid opening in Emacs
10140 and to use an external application to visit the file.
10142 Optional LINE specifies a line to go to, optional SEARCH a string
10143 to search for. If LINE or SEARCH is given, the file will be
10144 opened in Emacs, unless an entry from org-file-apps that makes
10145 use of groups in a regexp matches.
10147 If you want to change the way frames are used when following a
10148 link, please customize `org-link-frame-setup'.
10150 If the file does not exist, an error is thrown."
10151 (let* ((file (if (equal path "")
10152 buffer-file-name
10153 (substitute-in-file-name (expand-file-name path))))
10154 (file-apps (append org-file-apps (org-default-apps)))
10155 (apps (org-remove-if
10156 'org-file-apps-entry-match-against-dlink-p file-apps))
10157 (apps-dlink (org-remove-if-not
10158 'org-file-apps-entry-match-against-dlink-p file-apps))
10159 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10160 (dirp (if remp nil (file-directory-p file)))
10161 (file (if (and dirp org-open-directory-means-index-dot-org)
10162 (concat (file-name-as-directory file) "index.org")
10163 file))
10164 (a-m-a-p (assq 'auto-mode apps))
10165 (dfile (downcase file))
10166 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10167 (link (cond ((and (eq line nil)
10168 (eq search nil))
10169 file)
10170 (line
10171 (concat file "::" (number-to-string line)))
10172 (search
10173 (concat file "::" search))))
10174 (dlink (downcase link))
10175 (old-buffer (current-buffer))
10176 (old-pos (point))
10177 (old-mode major-mode)
10178 ext cmd link-match-data)
10180 (setq ext (match-string 1 dfile))
10182 (setq ext (match-string 1 dfile))))
10183 (cond
10184 ((member in-emacs '((16) system))
10185 (setq cmd (cdr (assoc 'system apps))))
10186 (in-emacs (setq cmd 'emacs))
10187 (t
10188 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10189 (and dirp (cdr (assoc 'directory apps)))
10190 ; first, try matching against apps-dlink
10191 ; if we get a match here, store the match data for later
10192 (let ((match (assoc-default dlink apps-dlink
10193 'string-match)))
10194 (if match
10195 (progn (setq link-match-data (match-data))
10196 match)
10197 (progn (setq in-emacs (or in-emacs line search))
10198 nil))) ; if we have no match in apps-dlink,
10199 ; always open the file in emacs if line or search
10200 ; is given (for backwards compatibility)
10201 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10202 'string-match)
10203 (cdr (assoc ext apps))
10204 (cdr (assoc t apps))))))
10205 (when (eq cmd 'system)
10206 (setq cmd (cdr (assoc 'system apps))))
10207 (when (eq cmd 'default)
10208 (setq cmd (cdr (assoc t apps))))
10209 (when (eq cmd 'mailcap)
10210 (require 'mailcap)
10211 (mailcap-parse-mailcaps)
10212 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10213 (command (mailcap-mime-info mime-type)))
10214 (if (stringp command)
10215 (setq cmd command)
10216 (setq cmd 'emacs))))
10217 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10218 (not (file-exists-p file))
10219 (not org-open-non-existing-files))
10220 (error "No such file: %s" file))
10221 (cond
10223 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10225 (setq cmd (replace-match "%s" t t cmd)))
10226 (while (string-match "%s" cmd)
10227 (setq cmd (replace-match
10228 (save-match-data
10229 (shell-quote-argument
10230 (convert-standard-filename file)))
10231 t t cmd)))
10233 ;; Replace "%1", "%2" etc. in command with group matches from regex
10234 (save-match-data
10235 (let ((match-index 1)
10236 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10237 (set-match-data link-match-data)
10238 (while (<= match-index number-of-groups)
10239 (let ((regex (concat "%" (number-to-string match-index)))
10240 (replace-with (match-string match-index dlink)))
10241 (while (string-match regex cmd)
10242 (setq cmd (replace-match replace-with t t cmd))))
10243 (setq match-index (+ match-index 1)))))
10245 (save-window-excursion
10246 (start-process-shell-command cmd nil cmd)
10247 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10248 ))
10249 ((or (stringp cmd)
10250 (eq cmd 'emacs))
10251 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10252 (widen)
10253 (if line (org-goto-line line)
10254 (if search (org-link-search search))))
10255 ((consp cmd)
10256 (let ((file (convert-standard-filename file)))
10257 (save-match-data
10258 (set-match-data link-match-data)
10259 (eval cmd))))
10260 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10261 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10262 (or (not (equal old-buffer (current-buffer)))
10263 (not (equal old-pos (point))))
10264 (org-mark-ring-push old-pos old-buffer))))
10266 (defun org-file-apps-entry-match-against-dlink-p (entry)
10267 "This function returns non-nil if `entry' uses a regular
10268 expression which should be matched against the whole link by
10269 org-open-file.
10271 It assumes that is the case when the entry uses a regular
10272 expression which has at least one grouping construct and the
10273 action is either a lisp form or a command string containing
10274 '%1', i.e. using at least one subexpression match as a
10275 parameter."
10276 (let ((selector (car entry))
10277 (action (cdr entry)))
10278 (if (stringp selector)
10279 (and (> (regexp-opt-depth selector) 0)
10280 (or (and (stringp action)
10281 (string-match "%[0-9]" action))
10282 (consp action)))
10283 nil)))
10285 (defun org-default-apps ()
10286 "Return the default applications for this operating system."
10287 (cond
10288 ((eq system-type 'darwin)
10289 org-file-apps-defaults-macosx)
10290 ((eq system-type 'windows-nt)
10291 org-file-apps-defaults-windowsnt)
10292 (t org-file-apps-defaults-gnu)))
10294 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10295 "Convert extensions to regular expressions in the cars of LIST.
10296 Also, weed out any non-string entries, because the return value is used
10297 only for regexp matching.
10298 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10299 point to the symbol `emacs', indicating that the file should
10300 be opened in Emacs."
10301 (append
10302 (delq nil
10303 (mapcar (lambda (x)
10304 (if (not (stringp (car x)))
10305 nil
10307 x
10309 list))
10310 (if add-auto-mode
10311 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10313 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10314 (defun org-file-remote-p (file)
10315 "Test whether FILE specifies a location on a remote system.
10316 Return non-nil if the location is indeed remote.
10320 (cond ((fboundp 'file-remote-p)
10321 (file-remote-p file))
10322 ((fboundp 'tramp-handle-file-remote-p)
10323 (tramp-handle-file-remote-p file))
10324 ((and (boundp 'ange-ftp-name-format)
10325 (string-match (car ange-ftp-name-format) file))
10326 t)
10327 (t nil)))
10330 ;;;; Refiling
10332 (defun org-get-org-file ()
10333 "Read a filename, with default directory `org-directory'."
10334 (let ((default (or org-default-notes-file remember-data-file)))
10335 (read-file-name (format "File name [%s]: " default)
10336 (file-name-as-directory org-directory)
10337 default)))
10339 (defun org-notes-order-reversed-p ()
10340 "Check if the current file should receive notes in reversed order."
10341 (cond
10342 ((not org-reverse-note-order) nil)
10343 ((eq t org-reverse-note-order) t)
10344 ((not (listp org-reverse-note-order)) nil)
10345 (t (catch 'exit
10346 (let ((all org-reverse-note-order)
10347 entry)
10348 (while (setq entry (pop all))
10349 (if (string-match (car entry) buffer-file-name)
10350 (throw 'exit (cdr entry))))
10351 nil)))))
10353 (defvar org-refile-target-table nil
10354 "The list of refile targets, created by `org-refile'.")
10356 (defvar org-agenda-new-buffers nil
10357 "Buffers created to visit agenda files.")
10359 (defvar org-refile-cache nil
10360 "Cache for refile targets.")
10362 (defvar org-refile-markers nil
10363 "All the markers used for caching refile locations.")
10365 (defun org-refile-marker (pos)
10366 "Get a new refile marker, but only if caching is in use."
10367 (if (not org-refile-use-cache)
10368 pos
10369 (let ((m (make-marker)))
10370 (move-marker m pos)
10371 (push m org-refile-markers)
10372 m)))
10374 (defun org-refile-cache-clear ()
10375 "Clear the refile cache and disable all the markers."
10376 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10377 (setq org-refile-markers nil)
10378 (setq org-refile-cache nil)
10379 (message "Refile cache has been cleared"))
10381 (defun org-refile-cache-check-set (set)
10382 "Check if all the markers in the cache still have live buffers."
10383 (let (marker)
10384 (catch 'exit
10385 (while (and set (setq marker (nth 3 (pop set))))
10386 ;; if org-refile-use-outline-path is 'file, marker may be nil
10387 (when (and marker (null (marker-buffer marker)))
10388 (message "not found") (sit-for 3)
10389 (throw 'exit nil)))
10390 t)))
10392 (defun org-refile-cache-put (set &rest identifiers)
10393 "Push the refile targets SET into the cache, under IDENTIFIERS."
10394 (let* ((key (sha1 (prin1-to-string identifiers)))
10395 (entry (assoc key org-refile-cache)))
10396 (if entry
10397 (setcdr entry set)
10398 (push (cons key set) org-refile-cache))))
10400 (defun org-refile-cache-get (&rest identifiers)
10401 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10402 (cond
10403 ((not org-refile-cache) nil)
10404 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10405 (t
10406 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10407 org-refile-cache))))
10408 (and set (org-refile-cache-check-set set) set)))))
10410 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10411 "Produce a table with refile targets."
10412 (let ((case-fold-search nil)
10413 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10414 (entries (or org-refile-targets '((nil . (:level . 1)))))
10415 targets tgs txt re files f desc descre fast-path-p level pos0)
10416 (message "Getting targets...")
10417 (with-current-buffer (or default-buffer (current-buffer))
10418 (while (setq entry (pop entries))
10419 (setq files (car entry) desc (cdr entry))
10420 (setq fast-path-p nil)
10421 (cond
10422 ((null files) (setq files (list (current-buffer))))
10423 ((eq files 'org-agenda-files)
10424 (setq files (org-agenda-files 'unrestricted)))
10425 ((and (symbolp files) (fboundp files))
10426 (setq files (funcall files)))
10427 ((and (symbolp files) (boundp files))
10428 (setq files (symbol-value files))))
10429 (if (stringp files) (setq files (list files)))
10430 (cond
10431 ((eq (car desc) :tag)
10433 ((eq (car desc) :todo)
10435 ((eq (car desc) :regexp)
10436 (setq descre (cdr desc)))
10437 ((eq (car desc) :level)
10439 (if org-odd-levels-only
10440 (1- (* 2 (cdr desc)))
10441 (cdr desc)))
10443 ((eq (car desc) :maxlevel)
10444 (setq fast-path-p t)
10446 (if org-odd-levels-only
10447 (1- (* 2 (cdr desc)))
10448 (cdr desc)))
10450 (t (error "Bad refiling target description %s" desc)))
10451 (while (setq f (pop files))
10452 (with-current-buffer
10453 (if (bufferp f) f (org-get-agenda-file-buffer f))
10454 (or
10455 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10456 (progn
10457 (if (bufferp f) (setq f (buffer-file-name
10458 (buffer-base-buffer f))))
10459 (setq f (and f (expand-file-name f)))
10460 (if (eq org-refile-use-outline-path 'file)
10461 (push (list (file-name-nondirectory f) f nil nil) tgs))
10462 (save-excursion
10463 (save-restriction
10464 (widen)
10465 (goto-char (point-min))
10466 (while (re-search-forward descre nil t)
10467 (goto-char (setq pos0 (point-at-bol)))
10468 (catch 'next
10469 (when org-refile-target-verify-function
10470 (save-match-data
10471 (or (funcall org-refile-target-verify-function)
10472 (throw 'next t))))
10473 (when (and (looking-at org-complex-heading-regexp)
10474 (not (member (match-string 4) excluded-entries))
10475 (match-string 4))
10476 (setq level (org-reduced-level
10477 (- (match-end 1) (match-beginning 1)))
10478 txt (org-link-display-format (match-string 4))
10480 re (format org-complex-heading-regexp-format
10481 (regexp-quote (match-string 4))))
10482 (when org-refile-use-outline-path
10483 (setq txt (mapconcat
10484 'org-protect-slash
10485 (append
10486 (if (eq org-refile-use-outline-path
10487 'file)
10488 (list (file-name-nondirectory
10489 (buffer-file-name
10490 (buffer-base-buffer))))
10491 (if (eq org-refile-use-outline-path
10492 'full-file-path)
10493 (list (buffer-file-name
10494 (buffer-base-buffer)))))
10495 (org-get-outline-path fast-path-p
10496 level txt)
10497 (list txt))
10498 "/")))
10499 (push (list txt f re (org-refile-marker (point)))
10500 tgs)))
10501 (when (= (point) pos0)
10502 ;; verification function has not moved point
10503 (goto-char (point-at-eol))))))))
10504 (when org-refile-use-cache
10505 (org-refile-cache-put tgs (buffer-file-name) descre))
10506 (setq targets (append tgs targets))
10507 ))))
10508 (message "Getting targets...done")
10509 (nreverse targets)))
10511 (defun org-protect-slash (s)
10512 (while (string-match "/" s)
10514 s)
10516 (defvar org-olpa (make-vector 20 nil))
10518 (defun org-get-outline-path (&optional fastp level heading)
10519 "Return the outline path to the current entry, as a list.
10521 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10522 routine which makes outline path derivations for an entire file,
10523 avoiding backtracing. Refile target collection makes use of that."
10524 (if fastp
10525 (progn
10526 (if (> level 19)
10527 (error "Outline path failure, more than 19 levels"))
10528 (loop for i from level upto 19 do
10529 (aset org-olpa i nil))
10530 (prog1
10531 (delq nil (append org-olpa nil))
10532 (aset org-olpa level heading)))
10533 (let (rtn case-fold-search)
10534 (save-excursion
10535 (save-restriction
10536 (widen)
10537 (while (org-up-heading-safe)
10538 (when (looking-at org-complex-heading-regexp)
10539 (push (org-match-string-no-properties 4) rtn)))
10540 rtn)))))
10542 (defun org-format-outline-path (path &optional width prefix)
10543 "Format the outline path PATH for display.
10544 Width is the maximum number of characters that is available.
10545 Prefix is a prefix to be included in the returned string,
10546 such as the file name."
10547 (setq width (or width 79))
10548 (if prefix (setq width (- width (length prefix))))
10549 (if (not path)
10550 (or prefix "")
10551 (let* ((nsteps (length path))
10552 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10553 (maxwidth (if (<= total-width width)
10554 10000 ;; everything fits
10555 ;; we need to shorten the level headings
10556 (/ (- width nsteps) nsteps)))
10557 (org-odd-levels-only nil)
10558 (n 0)
10559 (total (1+ (length prefix))))
10560 (setq maxwidth (max maxwidth 10))
10561 (concat prefix
10562 (mapconcat
10563 (lambda (h)
10564 (setq n (1+ n))
10565 (if (and (= n nsteps) (< maxwidth 10000))
10566 (setq maxwidth (- total-width total)))
10567 (if (< (length h) maxwidth)
10568 (progn (setq total (+ total (length h) 1)) h)
10569 (setq h (substring h 0 (- maxwidth 2))
10570 total (+ total maxwidth 1))
10572 (setq h (substring h 0 (match-beginning 0))))
10573 (setq h (concat h "..")))
10574 (org-add-props h nil 'face
10575 (nth (% (1- n) org-n-level-faces)
10576 org-level-faces))
10577 h)
10578 path "/")))))
10580 (defun org-display-outline-path (&optional file current)
10581 "Display the current outline path in the echo area."
10582 (interactive "P")
10583 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10584 (case-fold-search nil)
10585 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10586 (if current (setq path (append path
10587 (save-excursion
10588 (org-back-to-heading t)
10589 (if (looking-at org-complex-heading-regexp)
10590 (list (match-string 4)))))))
10591 (message "%s"
10592 (org-format-outline-path
10593 path
10594 (1- (frame-width))
10595 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10597 (defvar org-refile-history nil
10598 "History for refiling operations.")
10600 (defvar org-after-refile-insert-hook nil
10601 "Hook run after `org-refile' has inserted its stuff at the new location.
10602 Note that this is still *before* the stuff will be removed from
10603 the *old* location.")
10605 (defvar org-capture-last-stored-marker)
10606 (defun org-refile (&optional goto default-buffer rfloc)
10607 "Move the entry or entries at point to another heading.
10608 The list of target headings is compiled using the information in
10609 `org-refile-targets', which see.
10611 At the target location, the entry is filed as a subitem of the target
10612 heading. Depending on `org-reverse-note-order', the new subitem will
10613 either be the first or the last subitem.
10615 If there is an active region, all entries in that region will be moved.
10616 However, the region must fulfill the requirement that the first heading
10617 is the first one sets the top-level of the moved text - at most siblings
10618 below it are allowed.
10620 With prefix arg GOTO, the command will only visit the target location
10621 and not actually move anything.
10624 go to the location where the last refiling operation has put the subtree.
10625 With a prefix argument of `2', refile to the running clock.
10627 RFLOC can be a refile location obtained in a different way.
10629 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10631 If you are using target caching (see `org-refile-use-cache'),
10632 You have to clear the target cache in order to find new targets.
10633 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10634 prefix argument (`C-u C-u C-u C-c C-w')."
10636 (interactive "P")
10637 (if (member goto '(0 (64)))
10638 (org-refile-cache-clear)
10639 (let* ((cbuf (current-buffer))
10640 (regionp (org-region-active-p))
10641 (region-start (and regionp (region-beginning)))
10642 (region-end (and regionp (region-end)))
10643 (region-length (and regionp (- region-end region-start)))
10644 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10645 pos it nbuf file re level reversed)
10646 (setq last-command nil)
10647 (when regionp
10648 (goto-char region-start)
10649 (or (bolp) (goto-char (point-at-bol)))
10650 (setq region-start (point))
10651 (unless (or (org-kill-is-subtree-p
10652 (buffer-substring region-start region-end))
10653 (prog1 org-refile-active-region-within-subtree
10654 (org-toggle-heading)))
10655 (error "The region is not a (sequence of) subtree(s)")))
10656 (if (equal goto '(16))
10657 (org-refile-goto-last-stored)
10658 (when (or
10659 (and (equal goto 2)
10660 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10661 (prog1
10662 (setq it (list (or org-clock-heading "running clock")
10663 (buffer-file-name
10664 (marker-buffer org-clock-hd-marker))
10665 ""
10666 (marker-position org-clock-hd-marker)))
10667 (setq goto nil)))
10668 (setq it (or rfloc
10669 (let (heading-text)
10670 (save-excursion
10671 (unless goto
10672 (org-back-to-heading t)
10673 (setq heading-text
10674 (nth 4 (org-heading-components))))
10675 (org-refile-get-location
10676 (cond (goto "Goto")
10677 (regionp "Refile region to")
10680 default-buffer
10681 org-refile-allow-creating-parent-nodes
10682 goto))))))
10683 (setq file (nth 1 it)
10684 re (nth 2 it)
10685 pos (nth 3 it))
10686 (if (and (not goto)
10687 pos
10688 (equal (buffer-file-name) file)
10689 (if regionp
10690 (and (>= pos region-start)
10691 (<= pos region-end))
10692 (and (>= pos (point))
10693 (< pos (save-excursion
10694 (org-end-of-subtree t t))))))
10695 (error "Cannot refile to position inside the tree or region"))
10697 (setq nbuf (or (find-buffer-visiting file)
10698 (find-file-noselect file)))
10699 (if goto
10700 (progn
10701 (org-pop-to-buffer-same-window nbuf)
10702 (goto-char pos)
10703 (org-show-context 'org-goto))
10704 (if regionp
10705 (progn
10706 (org-kill-new (buffer-substring region-start region-end))
10707 (org-save-markers-in-region region-start region-end))
10708 (org-copy-subtree 1 nil t))
10709 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10710 (find-file-noselect file)))
10711 (setq reversed (org-notes-order-reversed-p))
10712 (save-excursion
10713 (save-restriction
10714 (widen)
10715 (if pos
10716 (progn
10717 (goto-char pos)
10718 (looking-at org-outline-regexp)
10719 (setq level (org-get-valid-level (funcall outline-level) 1))
10720 (goto-char
10721 (if reversed
10722 (or (outline-next-heading) (point-max))
10723 (or (save-excursion (org-get-next-sibling))
10724 (org-end-of-subtree t t)
10725 (point-max)))))
10726 (setq level 1)
10727 (if (not reversed)
10728 (goto-char (point-max))
10729 (goto-char (point-min))
10730 (or (outline-next-heading) (goto-char (point-max)))))
10731 (if (not (bolp)) (newline))
10732 (org-paste-subtree level)
10733 (when org-log-refile
10734 (org-add-log-setup 'refile nil nil 'findpos
10735 org-log-refile)
10736 (unless (eq org-log-refile 'note)
10737 (save-excursion (org-add-log-note))))
10738 (and org-auto-align-tags (org-set-tags nil t))
10739 (bookmark-set "org-refile-last-stored")
10740 ;; If we are refiling for capture, make sure that the
10741 ;; last-capture pointers point here
10742 (when (org-bound-and-true-p org-refile-for-capture)
10743 (bookmark-set "org-capture-last-stored-marker")
10744 (move-marker org-capture-last-stored-marker (point)))
10745 (if (fboundp 'deactivate-mark) (deactivate-mark))
10746 (run-hooks 'org-after-refile-insert-hook))))
10747 (if regionp
10748 (delete-region (point) (+ (point) region-length))
10749 (org-cut-subtree))
10750 (when (featurep 'org-inlinetask)
10751 (org-inlinetask-remove-END-maybe))
10752 (setq org-markers-to-move nil)
10755 (defun org-refile-goto-last-stored ()
10756 "Go to the location where the last refile was stored."
10757 (interactive)
10758 (bookmark-jump "org-refile-last-stored")
10759 (message "This is the location of the last refile"))
10761 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10762 no-exclude)
10763 "Prompt the user for a refile location, using PROMPT.
10764 PROMPT should not be suffixed with a colon and a space, because
10765 this function appends the default value from
10766 `org-refile-history' automatically, if that is not empty.
10767 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10768 this is used for the GOTO interface."
10769 (let ((org-refile-targets org-refile-targets)
10770 (org-refile-use-outline-path org-refile-use-outline-path)
10771 excluded-entries)
10772 (when (and (eq major-mode 'org-mode)
10773 (not org-refile-use-cache)
10774 (not no-exclude))
10775 (org-map-tree
10776 (lambda()
10777 (setq excluded-entries
10778 (append excluded-entries (list (org-get-heading t t)))))))
10779 (setq org-refile-target-table
10780 (org-refile-get-targets default-buffer excluded-entries)))
10781 (unless org-refile-target-table
10782 (error "No refile targets"))
10783 (let* ((prompt (concat prompt
10784 (and (car org-refile-history)
10785 (concat " (default " (car org-refile-history) ")"))
10786 ": "))
10787 (cbuf (current-buffer))
10788 (partial-completion-mode nil)
10789 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10790 (cfunc (if (and org-refile-use-outline-path
10791 org-outline-path-complete-in-steps)
10792 'org-olpath-completing-read
10793 'org-icompleting-read))
10794 (extra (if org-refile-use-outline-path "/" ""))
10795 (filename (and cfn (expand-file-name cfn)))
10796 (tbl (mapcar
10797 (lambda (x)
10798 (if (and (not (member org-refile-use-outline-path
10799 '(file full-file-path)))
10800 (not (equal filename (nth 1 x))))
10801 (cons (concat (car x) extra " ("
10802 (file-name-nondirectory (nth 1 x)) ")")
10803 (cdr x))
10804 (cons (concat (car x) extra) (cdr x))))
10805 org-refile-target-table))
10806 (completion-ignore-case t)
10807 pa answ parent-target child parent old-hist)
10808 (setq old-hist org-refile-history)
10809 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10810 nil 'org-refile-history (car org-refile-history)))
10811 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10812 (org-refile-check-position pa)
10813 (if pa
10814 (progn
10815 (when (or (not org-refile-history)
10816 (not (eq old-hist org-refile-history))
10817 (not (equal (car pa) (car org-refile-history))))
10818 (setq org-refile-history
10819 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10820 org-refile-history
10821 (cdr org-refile-history))))
10822 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10823 (pop org-refile-history)))
10824 pa)
10826 (progn
10827 (setq parent (match-string 1 answ)
10828 child (match-string 2 answ))
10829 (setq parent-target (or (assoc parent tbl)
10830 (assoc (concat parent "/") tbl)))
10831 (when (and parent-target
10832 (or (eq new-nodes t)
10833 (and (eq new-nodes 'confirm)
10835 child)))))
10836 (org-refile-new-child parent-target child)))
10837 (error "Invalid target location")))))
10839 (defun org-refile-check-position (refile-pointer)
10840 "Check if the refile pointer matches the readline to which it points."
10841 (let* ((file (nth 1 refile-pointer))
10842 (re (nth 2 refile-pointer))
10843 (pos (nth 3 refile-pointer))
10844 buffer)
10845 (when (org-string-nw-p re)
10846 (setq buffer (if (markerp pos)
10847 (marker-buffer pos)
10848 (or (find-buffer-visiting file)
10849 (find-file-noselect file))))
10850 (with-current-buffer buffer
10851 (save-excursion
10852 (save-restriction
10853 (widen)
10854 (goto-char pos)
10855 (beginning-of-line 1)
10856 (unless (org-looking-at-p re)
10857 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10859 (defun org-refile-new-child (parent-target child)
10860 "Use refile target PARENT-TARGET to add new CHILD below it."
10861 (unless parent-target
10862 (error "Cannot find parent for new node"))
10863 (let ((file (nth 1 parent-target))
10864 (pos (nth 3 parent-target))
10865 level)
10866 (with-current-buffer (or (find-buffer-visiting file)
10867 (find-file-noselect file))
10868 (save-excursion
10869 (save-restriction
10870 (widen)
10871 (if pos
10872 (goto-char pos)
10873 (goto-char (point-max))
10874 (if (not (bolp)) (newline)))
10875 (when (looking-at org-outline-regexp)
10876 (setq level (funcall outline-level))
10877 (org-end-of-subtree t t))
10878 (org-back-over-empty-lines)
10880 (if pos (org-get-valid-level level 1) 1) ?*)
10882 (beginning-of-line 0)
10883 (list (concat (car parent-target) "/" child) file "" (point)))))))
10885 (defun org-olpath-completing-read (prompt collection &rest args)
10886 "Read an outline path like a file name."
10887 (let ((thetable collection)
10888 (org-completion-use-ido nil) ; does not work with ido.
10889 (org-completion-use-iswitchb nil)) ; or iswitchb
10890 (apply
10891 'org-icompleting-read prompt
10892 (lambda (string predicate &optional flag)
10893 (let (rtn r f (l (length string)))
10894 (cond
10895 ((eq flag nil)
10896 ;; try completion
10897 (try-completion string thetable))
10898 ((eq flag t)
10899 ;; all-completions
10900 (setq rtn (all-completions string thetable predicate))
10901 (mapcar
10902 (lambda (x)
10903 (setq r (substring x l))
10904 (if (string-match " ([^)]*)$" x)
10905 (setq f (match-string 0 x))
10906 (setq f ""))
10907 (if (string-match "/" r)
10908 (concat string (substring r 0 (match-end 0)) f)
10909 x))
10910 rtn))
10911 ((eq flag 'lambda)
10912 ;; exact match?
10913 (assoc string thetable)))
10914 ))
10915 args)))
10917 ;;;; Dynamic blocks
10919 (defun org-find-dblock (name)
10920 "Find the first dynamic block with name NAME in the buffer.
10921 If not found, stay at current position and return nil."
10922 (let (pos)
10923 (save-excursion
10924 (goto-char (point-min))
10926 nil t)
10927 (match-beginning 0))))
10928 (if pos (goto-char pos))
10929 pos))
10931 (defconst org-dblock-start-re
10933 "Matches the start line of a dynamic block, with parameters.")
10936 "Matches the end of a dynamic block.")
10938 (defun org-create-dblock (plist)
10939 "Create a dynamic block section, with parameters taken from PLIST.
10940 PLIST must contain a :name entry which is used as name of the block."
10942 (end-of-line 1)
10943 (newline))
10944 (let ((col (current-column))
10945 (name (plist-get plist :name)))
10946 (insert "#+BEGIN: " name)
10947 (while plist
10948 (if (eq (car plist) :name)
10949 (setq plist (cddr plist))
10950 (insert " " (prin1-to-string (pop plist)))))
10952 (beginning-of-line -2)))
10954 (defun org-prepare-dblock ()
10955 "Prepare dynamic block for refresh.
10956 This empties the block, puts the cursor at the insert position and returns
10957 the property list including an extra property :name with the block name."
10958 (unless (looking-at org-dblock-start-re)
10959 (error "Not at a dynamic block"))
10960 (let* ((begdel (1+ (match-end 0)))
10961 (name (org-no-properties (match-string 1)))
10962 (params (append (list :name name)
10963 (read (concat "(" (match-string 3) ")")))))
10964 (save-excursion
10965 (beginning-of-line 1)
10967 (setq params (plist-put params :indentation-column (current-column))))
10968 (unless (re-search-forward org-dblock-end-re nil t)
10969 (error "Dynamic block not terminated"))
10970 (setq params
10971 (append params
10972 (list :content (buffer-substring
10973 begdel (match-beginning 0)))))
10974 (delete-region begdel (match-beginning 0))
10975 (goto-char begdel)
10976 (open-line 1)
10977 params))
10979 (defun org-map-dblocks (&optional command)
10980 "Apply COMMAND to all dynamic blocks in the current buffer.
10981 If COMMAND is not given, use `org-update-dblock'."
10982 (let ((cmd (or command 'org-update-dblock)))
10983 (save-excursion
10984 (goto-char (point-min))
10985 (while (re-search-forward org-dblock-start-re nil t)
10986 (goto-char (match-beginning 0))
10987 (save-excursion
10988 (condition-case nil
10989 (funcall cmd)
10990 (error (message "Error during update of dynamic block"))))
10991 (unless (re-search-forward org-dblock-end-re nil t)
10992 (error "Dynamic block not terminated"))))))
10994 (defun org-dblock-update (&optional arg)
10995 "User command for updating dynamic blocks.
10996 Update the dynamic block at point. With prefix ARG, update all dynamic
10997 blocks in the buffer."
10998 (interactive "P")
10999 (if arg
11000 (org-update-all-dblocks)
11001 (or (looking-at org-dblock-start-re)
11002 (org-beginning-of-dblock))
11003 (org-update-dblock)))
11005 (defun org-update-dblock ()
11006 "Update the dynamic block at point.
11007 This means to empty the block, parse for parameters and then call
11008 the correct writing function."
11009 (interactive)
11010 (save-window-excursion
11011 (let* ((pos (point))
11012 (line (org-current-line))
11013 (params (org-prepare-dblock))
11014 (name (plist-get params :name))
11015 (indent (plist-get params :indentation-column))
11016 (cmd (intern (concat "org-dblock-write:" name))))
11017 (message "Updating dynamic block `%s' at line %d..." name line)
11018 (funcall cmd params)
11019 (message "Updating dynamic block `%s' at line %d...done" name line)
11020 (goto-char pos)
11021 (when (and indent (> indent 0))
11022 (setq indent (make-string indent ?\ ))
11023 (save-excursion
11024 (org-beginning-of-dblock)
11025 (forward-line 1)
11026 (while (not (looking-at org-dblock-end-re))
11027 (insert indent)
11028 (beginning-of-line 2))
11029 (when (looking-at org-dblock-end-re)
11031 (replace-match ""))
11032 (insert indent)))))))
11034 (defun org-beginning-of-dblock ()
11035 "Find the beginning of the dynamic block at point.
11036 Error if there is no such block at point."
11037 (let ((pos (point))
11038 beg)
11039 (end-of-line 1)
11040 (if (and (re-search-backward org-dblock-start-re nil t)
11041 (setq beg (match-beginning 0))
11042 (re-search-forward org-dblock-end-re nil t)
11043 (> (match-end 0) pos))
11044 (goto-char beg)
11045 (goto-char pos)
11046 (error "Not in a dynamic block"))))
11048 (defun org-update-all-dblocks ()
11049 "Update all dynamic blocks in the buffer.
11050 This function can be used in a hook."
11051 (interactive)
11052 (when (eq major-mode 'org-mode)
11053 (org-map-dblocks 'org-update-dblock)))
11056 ;;;; Completion
11058 (defconst org-additional-option-like-keywords
11059 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11060 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11061 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11062 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11063 "BEGIN:" "END:"
11064 "ORGTBL" "TBLFM:" "TBLNAME:"
11065 "BEGIN_EXAMPLE" "END_EXAMPLE"
11066 "BEGIN_QUOTE" "END_QUOTE"
11067 "BEGIN_VERSE" "END_VERSE"
11068 "BEGIN_CENTER" "END_CENTER"
11069 "BEGIN_SRC" "END_SRC"
11070 "BEGIN_RESULT" "END_RESULT"
11071 "NAME:" "RESULTS:"
11072 "HEADER:" "HEADERS:"
11073 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11074 "CAPTION:" "LABEL:"
11075 "SETUPFILE:"
11076 "INCLUDE:"
11077 "BIND:"
11078 "MACRO:"))
11080 (defcustom org-structure-template-alist
11081 '(
11094 ("L" "#+LaTeX: "
11098 ("H" "#+HTML: "
11101 ("A" "#+ASCII: ")
11102 ("i" "#+INDEX: ?"
11103 "#+INDEX: ?")
11104 ("I" "#+INCLUDE %file ?"
11106 )
11107 "Structure completion elements.
11108 This is a list of abbreviation keys and values. The value gets inserted
11109 if you type `<' followed by the key and then press the completion key,
11110 usually `M-TAB'. %file will be replaced by a file name after prompting
11111 for the file using completion. The cursor will be placed at the position
11112 of the `?` in the template.
11113 There are two templates for each key, the first uses the original Org syntax,
11114 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11115 the default when the /org-mtags.el/ module has been loaded. See also the
11116 variable `org-mtags-prefer-muse-templates'."
11117 :group 'org-completion
11118 :type '(repeat
11119 (string :tag "Key")
11120 (string :tag "Template")
11121 (string :tag "Muse Template")))
11123 (defun org-try-structure-completion ()
11124 "Try to complete a structure template before point.
11126 expands them."
11127 (let ((l (buffer-substring (point-at-bol) (point)))
11128 a)
11131 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11132 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11133 (match-beginning 1)) a)
11134 t)))
11136 (defun org-complete-expand-structure-template (start cell)
11137 "Expand a structure template."
11138 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11139 (rpl (nth (if musep 2 1) cell))
11140 (ind ""))
11141 (delete-region start (point))
11143 (cond
11144 ((bolp))
11146 (setq ind (buffer-substring (point-at-bol) (point))))
11147 (t (newline))))
11148 (setq start (point))
11149 (if (string-match "%file" rpl)
11150 (setq rpl (replace-match
11151 (concat
11153 (save-match-data
11154 (abbreviate-file-name (read-file-name "Include file: ")))
11156 t t rpl)))
11159 (insert rpl)
11162 ;;;; TODO, DEADLINE, Comments
11164 (defun org-toggle-comment ()
11165 "Change the COMMENT state of an entry."
11166 (interactive)
11167 (save-excursion
11168 (org-back-to-heading)
11169 (let (case-fold-search)
11170 (cond
11171 ((looking-at (format org-heading-keyword-regexp-format
11172 org-comment-string))
11173 (goto-char (match-end 1))
11174 (looking-at (concat " +" org-comment-string))
11175 (replace-match "" t t)
11176 (when (eolp) (insert " ")))
11177 ((looking-at org-outline-regexp)
11178 (goto-char (match-end 0))
11179 (insert org-comment-string " "))))))
11181 (defvar org-last-todo-state-is-todo nil
11182 "This is non-nil when the last TODO state change led to a TODO state.
11183 If the last change removed the TODO tag or switched to DONE, then
11184 this is nil.")
11186 (defvar org-setting-tags nil) ; dynamically skipped
11188 (defvar org-todo-setup-filter-hook nil
11189 "Hook for functions that pre-filter todo specs.
11190 Each function takes a todo spec and returns either nil or the spec
11191 transformed into canonical form." )
11193 (defvar org-todo-get-default-hook nil
11194 "Hook for functions that get a default item for todo.
11195 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11196 nil or a string to be used for the todo mark." )
11198 (defvar org-agenda-headline-snapshot-before-repeat)
11200 (defun org-current-effective-time ()
11201 "Return current time adjusted for `org-extend-today-until' variable"
11202 (let* ((ct (org-current-time))
11203 (dct (decode-time ct))
11204 (ct1
11205 (if (and org-use-effective-time
11206 (< (nth 2 dct) org-extend-today-until))
11207 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11208 ct)))
11209 ct1))
11211 (defun org-todo-yesterday (&optional arg)
11212 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11213 (interactive "P")
11214 (if (eq major-mode 'org-agenda-mode)
11215 (apply 'org-agenda-todo-yesterday arg)
11216 (let* ((hour (third (decode-time
11217 (org-current-time))))
11218 (org-extend-today-until (1+ hour)))
11219 (org-todo arg))))
11221 (defun org-todo (&optional arg)
11222 "Change the TODO state of an item.
11223 The state of an item is given by a keyword at the start of the heading,
11224 like
11225 *** TODO Write paper
11226 *** DONE Call mom
11228 The different keywords are specified in the variable `org-todo-keywords'.
11230 So for this example: when the item starts with TODO, it is changed to DONE.
11231 When it starts with DONE, the DONE is removed. And when neither TODO nor
11232 DONE are present, add TODO at the beginning of the heading.
11235 state.
11236 With numeric prefix arg, switch to that state.
11238 keywords (nextset).
11240 With a numeric prefix arg of 0, inhibit note taking for the change.
11242 For calling through lisp, arg is also interpreted in the following way:
11243 'none -> empty state
11245 'done -> switch to DONE
11246 'nextset -> switch to the next set of keywords
11247 'previousset -> switch to the previous set of keywords
11249 really is a member of `org-todo-keywords'."
11250 (interactive "P")
11251 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11252 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11253 'region-start-level 'region))
11254 org-loop-over-headlines-in-active-region)
11255 (org-map-entries
11256 `(org-todo ,arg)
11257 org-loop-over-headlines-in-active-region
11258 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11259 (if (equal arg '(16)) (setq arg 'nextset))
11260 (let ((org-blocker-hook org-blocker-hook)
11261 (case-fold-search nil))
11262 (when (equal arg '(64))
11263 (setq arg nil org-blocker-hook nil))
11264 (when (and org-blocker-hook
11265 (or org-inhibit-blocking
11266 (org-entry-get nil "NOBLOCKING")))
11267 (setq org-blocker-hook nil))
11268 (save-excursion
11269 (catch 'exit
11270 (org-back-to-heading t)
11271 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11274 (let* ((match-data (match-data))
11275 (startpos (point-at-bol))
11276 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11277 (org-log-done org-log-done)
11278 (org-log-repeat org-log-repeat)
11279 (org-todo-log-states org-todo-log-states)
11280 (org-inhibit-logging
11281 (if (equal arg 0)
11282 (progn (setq arg nil) 'note) org-inhibit-logging))
11283 (this (match-string 1))
11284 (hl-pos (match-beginning 0))
11285 (head (org-get-todo-sequence-head this))
11286 (ass (assoc head org-todo-kwd-alist))
11287 (interpret (nth 1 ass))
11288 (done-word (nth 3 ass))
11289 (final-done-word (nth 4 ass))
11290 (last-state (or this ""))
11291 (completion-ignore-case t)
11292 (member (member this org-todo-keywords-1))
11293 (tail (cdr member))
11294 (state (cond
11295 ((and org-todo-key-trigger
11296 (or (and (equal arg '(4))
11297 (eq org-use-fast-todo-selection 'prefix))
11298 (and (not arg) org-use-fast-todo-selection
11299 (not (eq org-use-fast-todo-selection
11300 'prefix)))))
11301 ;; Use fast selection
11302 (org-fast-todo-selection))
11303 ((and (equal arg '(4))
11304 (or (not org-use-fast-todo-selection)
11305 (not org-todo-key-trigger)))
11306 ;; Read a state with completion
11307 (org-icompleting-read
11308 "State: " (mapcar (lambda(x) (list x))
11309 org-todo-keywords-1)
11310 nil t))
11311 ((eq arg 'right)
11312 (if this
11313 (if tail (car tail) nil)
11314 (car org-todo-keywords-1)))
11315 ((eq arg 'left)
11316 (if (equal member org-todo-keywords-1)
11317 nil
11318 (if this
11319 (nth (- (length org-todo-keywords-1)
11320 (length tail) 2)
11321 org-todo-keywords-1)
11322 (org-last org-todo-keywords-1))))
11323 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11324 (setq arg nil))) ; hack to fall back to cycling
11325 (arg
11326 ;; user or caller requests a specific state
11327 (cond
11328 ((equal arg "") nil)
11329 ((eq arg 'none) nil)
11330 ((eq arg 'done) (or done-word (car org-done-keywords)))
11331 ((eq arg 'nextset)
11332 (or (car (cdr (member head org-todo-heads)))
11333 (car org-todo-heads)))
11334 ((eq arg 'previousset)
11335 (let ((org-todo-heads (reverse org-todo-heads)))
11336 (or (car (cdr (member head org-todo-heads)))
11337 (car org-todo-heads))))
11338 ((car (member arg org-todo-keywords-1)))
11339 ((stringp arg)
11340 (error "State `%s' not valid in this file" arg))
11341 ((nth (1- (prefix-numeric-value arg))
11342 org-todo-keywords-1))))
11343 ((null member) (or head (car org-todo-keywords-1)))
11344 ((equal this final-done-word) nil) ;; -> make empty
11345 ((null tail) nil) ;; -> first entry
11346 ((memq interpret '(type priority))
11347 (if (eq this-command last-command)
11348 (car tail)
11349 (if (> (length tail) 0)
11350 (or done-word (car org-done-keywords))
11351 nil)))
11352 (t
11353 (car tail))))
11354 (state (or
11355 (run-hook-with-args-until-success
11356 'org-todo-get-default-hook state last-state)
11357 state))
11358 (next (if state (concat " " state " ") " "))
11359 (change-plist (list :type 'todo-state-change :from this :to state
11360 :position startpos))
11361 dolog now-done-p)
11362 (when org-blocker-hook
11363 (setq org-last-todo-state-is-todo
11364 (not (member this org-done-keywords)))
11365 (unless (save-excursion
11366 (save-match-data
11367 (org-with-wide-buffer
11368 (run-hook-with-args-until-failure
11369 'org-blocker-hook change-plist))))
11370 (if (org-called-interactively-p 'interactive)
11371 (error "TODO state change from %s to %s blocked" this state)
11372 ;; fail silently
11373 (message "TODO state change from %s to %s blocked" this state)
11374 (throw 'exit nil))))
11375 (store-match-data match-data)
11376 (replace-match next t t)
11377 (unless (pos-visible-in-window-p hl-pos)
11378 (message "TODO state changed to %s" (org-trim next)))
11379 (unless head
11380 (setq head (org-get-todo-sequence-head state)
11381 ass (assoc head org-todo-kwd-alist)
11382 interpret (nth 1 ass)
11383 done-word (nth 3 ass)
11384 final-done-word (nth 4 ass)))
11385 (when (memq arg '(nextset previousset))
11386 (message "Keyword-Set %d/%d: %s"
11387 (- (length org-todo-sets) -1
11388 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11389 (length org-todo-sets)
11390 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11391 (setq org-last-todo-state-is-todo
11392 (not (member state org-done-keywords)))
11393 (setq now-done-p (and (member state org-done-keywords)
11394 (not (member this org-done-keywords))))
11395 (and logging (org-local-logging logging))
11396 (when (and (or org-todo-log-states org-log-done)
11397 (not (eq org-inhibit-logging t))
11398 (not (memq arg '(nextset previousset))))
11399 ;; we need to look at recording a time and note
11400 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11401 (nth 2 (assoc this org-todo-log-states))))
11402 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11403 (setq dolog 'time))
11404 (when (and state
11405 (member state org-not-done-keywords)
11406 (not (member this org-not-done-keywords)))
11407 ;; This is now a todo state and was not one before
11408 ;; If there was a CLOSED time stamp, get rid of it.
11409 (org-add-planning-info nil nil 'closed))
11410 (when (and now-done-p org-log-done)
11411 ;; It is now done, and it was not done before
11412 (org-add-planning-info 'closed (org-current-effective-time))
11413 (if (and (not dolog) (eq 'note org-log-done))
11414 (org-add-log-setup 'done state this 'findpos 'note)))
11415 (when (and state dolog)
11416 ;; This is a non-nil state, and we need to log it
11417 (org-add-log-setup 'state state this 'findpos dolog)))
11418 ;; Fixup tag positioning
11419 (org-todo-trigger-tag-changes state)
11420 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11421 (when org-provide-todo-statistics
11422 (org-update-parent-todo-statistics))
11423 (run-hooks 'org-after-todo-state-change-hook)
11424 (if (and arg (not (member state org-done-keywords)))
11425 (setq head (org-get-todo-sequence-head state)))
11426 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11427 ;; Do we need to trigger a repeat?
11428 (when now-done-p
11429 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11430 ;; This is for the agenda, take a snapshot of the headline.
11431 (save-match-data
11432 (setq org-agenda-headline-snapshot-before-repeat
11433 (org-get-heading))))
11434 (org-auto-repeat-maybe state))
11435 ;; Fixup cursor location if close to the keyword
11436 (if (and (outline-on-heading-p)
11437 (not (bolp))
11438 (save-excursion (beginning-of-line 1)
11439 (looking-at org-todo-line-regexp))
11440 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11441 (progn
11442 (goto-char (or (match-end 2) (match-end 1)))
11443 (and (looking-at " ") (just-one-space))))
11444 (when org-trigger-hook
11445 (save-excursion
11446 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11448 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11449 "Block turning an entry into a TODO, using the hierarchy.
11450 This checks whether the current task should be blocked from state
11451 changes. Such blocking occurs when:
11453 1. The task has children which are not all in a completed state.
11455 2. A task has a parent with the property :ORDERED:, and there
11456 are siblings prior to the current task with incomplete
11457 status.
11459 3. The parent of the task is blocked because it has siblings that should
11460 be done first, or is child of a block grandparent TODO entry."
11462 (if (not org-enforce-todo-dependencies)
11463 t ; if locally turned off don't block
11464 (catch 'dont-block
11465 ;; If this is not a todo state change, or if this entry is already DONE,
11466 ;; do not block
11467 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11468 (member (plist-get change-plist :from)
11469 (cons 'done org-done-keywords))
11470 (member (plist-get change-plist :to)
11471 (cons 'todo org-not-done-keywords))
11472 (not (plist-get change-plist :to)))
11473 (throw 'dont-block t))
11474 ;; If this task has children, and any are undone, it's blocked
11475 (save-excursion
11476 (org-back-to-heading t)
11477 (let ((this-level (funcall outline-level)))
11478 (outline-next-heading)
11479 (let ((child-level (funcall outline-level)))
11480 (while (and (not (eobp))
11481 (> child-level this-level))
11482 ;; this todo has children, check whether they are all
11483 ;; completed
11484 (if (and (not (org-entry-is-done-p))
11485 (org-entry-is-todo-p))
11486 (throw 'dont-block nil))
11487 (outline-next-heading)
11488 (setq child-level (funcall outline-level))))))
11489 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11490 ;; any previous siblings are undone, it's blocked
11491 (save-excursion
11492 (org-back-to-heading t)
11493 (let* ((pos (point))
11494 (parent-pos (and (org-up-heading-safe) (point))))
11495 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11496 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11497 (forward-line 1)
11498 (re-search-forward org-not-done-heading-regexp pos t))
11499 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11500 ;; Search further up the hierarchy, to see if an ancestor is blocked
11501 (while t
11502 (goto-char parent-pos)
11503 (if (not (looking-at org-not-done-heading-regexp))
11504 (throw 'dont-block t)) ; do not block, parent is not a TODO
11505 (setq pos (point))
11506 (setq parent-pos (and (org-up-heading-safe) (point)))
11507 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11508 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11509 (forward-line 1)
11510 (re-search-forward org-not-done-heading-regexp pos t))
11511 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11513 (defcustom org-track-ordered-property-with-tag nil
11514 "Should the ORDERED property also be shown as a tag?
11515 The ORDERED property decides if an entry should require subtasks to be
11516 completed in sequence. Since a property is not very visible, setting
11517 this option means that toggling the ORDERED property with the command
11518 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11519 not relevant for the behavior, but it makes things more visible.
11521 Note that toggling the tag with tags commands will not change the property
11522 and therefore not influence behavior!
11524 This can be t, meaning the tag ORDERED should be used, It can also be a
11525 string to select a different tag for this task."
11526 :group 'org-todo
11527 :type '(choice
11528 (const :tag "No tracking" nil)
11529 (const :tag "Track with ORDERED tag" t)
11530 (string :tag "Use other tag")))
11532 (defun org-toggle-ordered-property ()
11533 "Toggle the ORDERED property of the current entry.
11534 For better visibility, you can track the value of this property with a tag.
11535 See variable `org-track-ordered-property-with-tag'."
11536 (interactive)
11537 (let* ((t1 org-track-ordered-property-with-tag)
11538 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11539 (save-excursion
11540 (org-back-to-heading)
11541 (if (org-entry-get nil "ORDERED")
11542 (progn
11543 (org-delete-property "ORDERED")
11544 (and tag (org-toggle-tag tag 'off))
11545 (message "Subtasks can be completed in arbitrary order"))
11546 (org-entry-put nil "ORDERED" "t")
11547 (and tag (org-toggle-tag tag 'on))
11548 (message "Subtasks must be completed in sequence")))))
11550 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11551 (defun org-block-todo-from-checkboxes (change-plist)
11552 "Block turning an entry into a TODO, using checkboxes.
11553 This checks whether the current task should be blocked from state
11554 changes because there are unchecked boxes in this entry."
11555 (if (not org-enforce-todo-checkbox-dependencies)
11556 t ; if locally turned off don't block
11557 (catch 'dont-block
11558 ;; If this is not a todo state change, or if this entry is already DONE,
11559 ;; do not block
11560 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11561 (member (plist-get change-plist :from)
11562 (cons 'done org-done-keywords))
11563 (member (plist-get change-plist :to)
11564 (cons 'todo org-not-done-keywords))
11565 (not (plist-get change-plist :to)))
11566 (throw 'dont-block t))
11567 ;; If this task has checkboxes that are not checked, it's blocked
11568 (save-excursion
11569 (org-back-to-heading t)
11570 (let ((beg (point)) end)
11571 (outline-next-heading)
11572 (setq end (point))
11573 (goto-char beg)
11574 (if (org-list-search-forward
11575 (concat (org-item-beginning-re)
11578 end t)
11579 (progn
11580 (if (boundp 'org-blocked-by-checkboxes)
11581 (setq org-blocked-by-checkboxes t))
11582 (throw 'dont-block nil)))))
11583 t))) ; do not block
11585 (defun org-entry-blocked-p ()
11586 "Is the current entry blocked?"
11587 (if (org-entry-get nil "NOBLOCKING")
11588 nil ;; Never block this entry
11589 (not
11590 (run-hook-with-args-until-failure
11591 'org-blocker-hook
11592 (list :type 'todo-state-change
11593 :position (point)
11594 :from 'todo
11595 :to 'done)))))
11597 (defun org-update-statistics-cookies (all)
11598 "Update the statistics cookie, either from TODO or from checkboxes.
11599 This should be called with the cursor in a line with a statistics cookie."
11600 (interactive "P")
11601 (if all
11602 (progn
11603 (org-update-checkbox-count 'all)
11604 (org-map-entries 'org-update-parent-todo-statistics))
11605 (if (not (org-at-heading-p))
11606 (org-update-checkbox-count)
11607 (let ((pos (move-marker (make-marker) (point)))
11608 end l1 l2)
11609 (ignore-errors (org-back-to-heading t))
11610 (if (not (org-at-heading-p))
11611 (org-update-checkbox-count)
11612 (setq l1 (org-outline-level))
11613 (setq end (save-excursion
11614 (outline-next-heading)
11615 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11616 (point)))
11617 (if (and (save-excursion
11618 (re-search-forward
11620 (not (save-excursion (re-search-forward
11622 (org-update-checkbox-count)
11623 (if (and l2 (> l2 l1))
11624 (progn
11625 (goto-char end)
11626 (org-update-parent-todo-statistics))
11627 (goto-char pos)
11628 (beginning-of-line 1)
11629 (while (re-search-forward
11631 (point-at-eol) t)
11632 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11633 (goto-char pos)
11634 (move-marker pos nil)))))
11636 (defvar org-entry-property-inherited-from) ;; defined below
11637 (defun org-update-parent-todo-statistics ()
11638 "Update any statistics cookie in the parent of the current headline.
11639 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11640 the entire subtree and this will travel up the hierarchy and update
11641 statistics everywhere."
11642 (let* ((prop (save-excursion (org-up-heading-safe)
11643 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11644 (recursive (or (not org-hierarchical-todo-statistics)
11646 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11647 0))
11648 (first t)
11650 level ltoggle l1 new ndel
11651 (cnt-all 0) (cnt-done 0) is-percent kwd
11652 checkbox-beg ov ovs ove cookie-present)
11653 (catch 'exit
11654 (save-excursion
11655 (beginning-of-line 1)
11656 (setq ltoggle (funcall outline-level))
11657 ;; Three situations are to consider:
11659 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11660 ;; to the top-level ancestor on the headline;
11662 ;; 2. If parent has "recursive" property, repeat up to the
11663 ;; headline setting that property, taking inheritance into
11664 ;; account;
11666 ;; 3. Else, move up to direct parent and proceed only once.
11667 (while (and (setq level (org-up-heading-safe))
11668 (or recursive first)
11669 (>= (point) lim))
11670 (setq first nil cookie-present nil)
11671 (unless (and level
11672 (not (string-match
11674 (downcase (or (org-entry-get nil "COOKIE_DATA")
11675 "")))))
11676 (throw 'exit nil))
11677 (while (re-search-forward box-re (point-at-eol) t)
11678 (setq cnt-all 0 cnt-done 0 cookie-present t)
11679 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11680 (save-match-data
11681 (unless (outline-next-heading) (throw 'exit nil))
11682 (while (and (looking-at org-complex-heading-regexp)
11683 (> (setq l1 (length (match-string 1))) level))
11684 (setq kwd (and (or recursive (= l1 ltoggle))
11685 (match-string 2)))
11686 (if (or (eq org-provide-todo-statistics 'all-headlines)
11687 (and (listp org-provide-todo-statistics)
11688 (or (member kwd org-provide-todo-statistics)
11689 (member kwd org-done-keywords))))
11690 (setq cnt-all (1+ cnt-all))
11691 (if (eq org-provide-todo-statistics t)
11692 (and kwd (setq cnt-all (1+ cnt-all)))))
11693 (and (member kwd org-done-keywords)
11694 (setq cnt-done (1+ cnt-done)))
11695 (outline-next-heading)))
11696 (setq new
11697 (if is-percent
11698 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11699 (format "[%d/%d]" cnt-done cnt-all))
11700 ndel (- (match-end 0) checkbox-beg))
11701 ;; handle overlays when updating cookie from column view
11702 (when (setq ov (car (overlays-at checkbox-beg)))
11703 (setq ovs (overlay-start ov) ove (overlay-end ov))
11704 (delete-overlay ov))
11705 (goto-char checkbox-beg)
11706 (insert new)
11707 (delete-region (point) (+ (point) ndel))
11708 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11709 (when ov (move-overlay ov ovs ove)))
11710 (when cookie-present
11711 (run-hook-with-args 'org-after-todo-statistics-hook
11712 cnt-done (- cnt-all cnt-done))))))
11713 (run-hooks 'org-todo-statistics-hook)))
11715 (defvar org-after-todo-statistics-hook nil
11716 "Hook that is called after a TODO statistics cookie has been updated.
11717 Each function is called with two arguments: the number of not-done entries
11718 and the number of done entries.
11720 For example, the following function, when added to this hook, will switch
11721 an entry to DONE when all children are done, and back to TODO when new
11722 entries are set to a TODO status. Note that this hook is only called
11723 when there is a statistics cookie in the headline!
11725 (defun org-summary-todo (n-done n-not-done)
11727 (let (org-log-done org-log-states) ; turn off logging
11729 ")
11731 (defvar org-todo-statistics-hook nil
11732 "Hook that is run whenever Org thinks TODO statistics should be updated.
11733 This hook runs even if there is no statistics cookie present, in which case
11734 `org-after-todo-statistics-hook' would not run.")
11736 (defun org-todo-trigger-tag-changes (state)
11737 "Apply the changes defined in `org-todo-state-tags-triggers'."
11738 (let ((l org-todo-state-tags-triggers)
11739 changes)
11740 (when (or (not state) (equal state ""))
11741 (setq changes (append changes (cdr (assoc "" l)))))
11742 (when (and (stringp state) (> (length state) 0))
11743 (setq changes (append changes (cdr (assoc state l)))))
11744 (when (member state org-not-done-keywords)
11745 (setq changes (append changes (cdr (assoc 'todo l)))))
11746 (when (member state org-done-keywords)
11747 (setq changes (append changes (cdr (assoc 'done l)))))
11748 (dolist (c changes)
11749 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11751 (defun org-local-logging (value)
11752 "Get logging settings from a property VALUE."
11753 (let* (words w a)
11754 ;; directly set the variables, they are already local.
11755 (setq org-log-done nil
11756 org-log-repeat nil
11757 org-todo-log-states nil)
11758 (setq words (org-split-string value))
11759 (while (setq w (pop words))
11760 (cond
11761 ((setq a (assoc w org-startup-options))
11762 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11763 (set (nth 1 a) (nth 2 a))))
11764 ((setq a (org-extract-log-state-settings w))
11765 (and (member (car a) org-todo-keywords-1)
11766 (push a org-todo-log-states)))))))
11768 (defun org-get-todo-sequence-head (kwd)
11769 "Return the head of the TODO sequence to which KWD belongs.
11770 If KWD is not set, check if there is a text property remembering the
11771 right sequence."
11772 (let (p)
11773 (cond
11774 ((not kwd)
11775 (or (get-text-property (point-at-bol) 'org-todo-head)
11776 (progn
11777 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11778 nil (point-at-eol)))
11779 (get-text-property p 'org-todo-head))))
11780 ((not (member kwd org-todo-keywords-1))
11781 (car org-todo-keywords-1))
11782 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11784 (defun org-fast-todo-selection ()
11785 "Fast TODO keyword selection with single keys.
11786 Returns the new TODO keyword, or nil if no state change should occur."
11787 (let* ((fulltable org-todo-key-alist)
11788 (done-keywords org-done-keywords) ;; needed for the faces.
11789 (maxlen (apply 'max (mapcar
11790 (lambda (x)
11791 (if (stringp (car x)) (string-width (car x)) 0))
11792 fulltable)))
11793 (expert nil)
11794 (fwidth (+ maxlen 3 1 3))
11795 (ncol (/ (- (window-width) 4) fwidth))
11796 tg cnt e c tbl
11797 groups ingroup)
11798 (save-excursion
11799 (save-window-excursion
11800 (if expert
11801 (set-buffer (get-buffer-create " *Org todo*"))
11802 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11803 (erase-buffer)
11804 (org-set-local 'org-done-keywords done-keywords)
11805 (setq tbl fulltable cnt 0)
11806 (while (setq e (pop tbl))
11807 (cond
11808 ((equal e '(:startgroup))
11809 (push '() groups) (setq ingroup t)
11810 (when (not (= cnt 0))
11811 (setq cnt 0)
11813 (insert "{ "))
11814 ((equal e '(:endgroup))
11815 (setq ingroup nil cnt 0)
11817 ((equal e '(:newline))
11818 (when (not (= cnt 0))
11819 (setq cnt 0)
11821 (setq e (car tbl))
11822 (while (equal (car tbl) '(:newline))
11824 (setq tbl (cdr tbl)))))
11825 (t
11826 (setq tg (car e) c (cdr e))
11827 (if ingroup (push tg (car groups)))
11828 (setq tg (org-add-props tg nil 'face
11829 (org-get-todo-face tg)))
11830 (if (and (= cnt 0) (not ingroup)) (insert " "))
11831 (insert "[" c "] " tg (make-string
11832 (- fwidth 4 (length tg)) ?\ ))
11833 (when (= (setq cnt (1+ cnt)) ncol)
11835 (if ingroup (insert " "))
11836 (setq cnt 0)))))
11838 (goto-char (point-min))
11839 (if (not expert) (org-fit-window-to-buffer))
11840 (message "[a-z..]:Set [SPC]:clear")
11841 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11842 (cond
11843 ((or (= c ?\C-g)
11844 (and (= c ?q) (not (rassoc c fulltable))))
11845 (setq quit-flag t))
11846 ((= c ?\ ) nil)
11847 ((setq e (rassoc c fulltable) tg (car e))
11848 tg)
11849 (t (setq quit-flag t)))))))
11851 (defun org-entry-is-todo-p ()
11852 (member (org-get-todo-state) org-not-done-keywords))
11854 (defun org-entry-is-done-p ()
11855 (member (org-get-todo-state) org-done-keywords))
11857 (defun org-get-todo-state ()
11858 (save-excursion
11859 (org-back-to-heading t)
11860 (and (looking-at org-todo-line-regexp)
11861 (match-end 2)
11862 (match-string 2))))
11864 (defun org-at-date-range-p (&optional inactive-ok)
11865 "Is the cursor inside a date range?"
11866 (interactive)
11867 (save-excursion
11868 (catch 'exit
11869 (let ((pos (point)))
11871 (skip-chars-backward "<[")
11872 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11873 (>= (match-end 0) pos)
11874 (throw 'exit t))
11876 (skip-chars-backward "<[")
11877 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11878 (>= (match-end 0) pos)
11879 (throw 'exit t)))
11880 nil)))
11882 (defun org-get-repeat (&optional tagline)
11883 "Check if there is a deadline/schedule with repeater in this entry."
11884 (save-match-data
11885 (save-excursion
11886 (org-back-to-heading t)
11887 (and (re-search-forward (if tagline
11889 org-repeat-re)
11890 (org-entry-end-position) t)
11891 (match-string-no-properties 1)))))
11893 (defvar org-last-changed-timestamp)
11894 (defvar org-last-inserted-timestamp)
11895 (defvar org-log-post-message)
11896 (defvar org-log-note-purpose)
11897 (defvar org-log-note-how)
11898 (defvar org-log-note-extra)
11899 (defun org-auto-repeat-maybe (done-word)
11900 "Check if the current headline contains a repeated deadline/schedule.
11901 If yes, set TODO state back to what it was and change the base date
11902 of repeating deadline/scheduled time stamps to new date.
11903 This function is run automatically after each state change to a DONE state."
11904 ;; last-state is dynamically scoped into this function
11905 (let* ((repeat (org-get-repeat))
11906 (aa (assoc last-state org-todo-kwd-alist))
11907 (interpret (nth 1 aa))
11908 (head (nth 2 aa))
11909 (whata '(("d" . day) ("m" . month) ("y" . year)))
11910 (msg "Entry repeats: ")
11911 (org-log-done nil)
11912 (org-todo-log-states nil)
11913 re type n what ts time to-state)
11914 (when repeat
11915 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11916 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11917 org-todo-repeat-to-state))
11918 (unless (and to-state (member to-state org-todo-keywords-1))
11919 (setq to-state (if (eq interpret 'type) last-state head)))
11920 (org-todo to-state)
11921 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11922 (org-entry-put nil "LAST_REPEAT" (format-time-string
11923 (org-time-stamp-format t t))))
11924 (when org-log-repeat
11925 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11926 (memq 'org-add-log-note post-command-hook))
11927 ;; OK, we are already setup for some record
11928 (if (eq org-log-repeat 'note)
11929 ;; make sure we take a note, not only a time stamp
11930 (setq org-log-note-how 'note))
11931 ;; Set up for taking a record
11932 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11933 last-state
11934 'findpos org-log-repeat)))
11935 (org-back-to-heading t)
11936 (org-add-planning-info nil nil 'closed)
11940 (while (re-search-forward
11941 re (save-excursion (outline-next-heading) (point)) t)
11942 (setq type (if (match-end 1) org-scheduled-string
11943 (if (match-end 3) org-deadline-string "Plain:"))
11944 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11946 (setq n (string-to-number (match-string 2 ts))
11947 what (match-string 3 ts))
11948 (if (equal what "w") (setq n (* n 7) what "d"))
11949 ;; Preparation, see if we need to modify the start date for the change
11950 (when (match-end 1)
11951 (setq time (save-match-data (org-time-string-to-time ts)))
11952 (cond
11953 ((equal (match-string 1 ts) ".")
11954 ;; Shift starting date to today
11955 (org-timestamp-change
11956 (- (org-today) (time-to-days time))
11957 'day))
11958 ((equal (match-string 1 ts) "+")
11959 (let ((nshiftmax 10) (nshift 0))
11960 (while (or (= nshift 0)
11961 (<= (time-to-days time)
11962 (time-to-days (current-time))))
11963 (when (= (incf nshift) nshiftmax)
11964 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11965 (error "Abort")))
11966 (org-timestamp-change n (cdr (assoc what whata)))
11967 (org-at-timestamp-p t)
11968 (setq ts (match-string 1))
11969 (setq time (save-match-data (org-time-string-to-time ts)))))
11970 (org-timestamp-change (- n) (cdr (assoc what whata)))
11971 ;; rematch, so that we have everything in place for the real shift
11972 (org-at-timestamp-p t)
11973 (setq ts (match-string 1))
11975 (org-timestamp-change n (cdr (assoc what whata)))
11976 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11977 (setq org-log-post-message msg)
11978 (message "%s" msg))))
11980 (defun org-show-todo-tree (arg)
11981 "Make a compact tree which shows all headlines marked with TODO.
11982 The tree will show the lines where the regexp matches, and all higher
11983 headlines above the match.
11985 With a numeric prefix N, construct a sparse tree for the Nth element
11986 of `org-todo-keywords-1'."
11987 (interactive "P")
11988 (let ((case-fold-search nil)
11989 (kwd-re
11990 (cond ((null arg) org-not-done-regexp)
11991 ((equal arg '(4))
11992 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11993 (mapcar 'list org-todo-keywords-1))))
11997 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11998 (regexp-quote (nth (1- (prefix-numeric-value arg))
11999 org-todo-keywords-1)))
12000 (t (error "Invalid prefix argument: %s" arg)))))
12001 (message "%d TODO entries found"
12002 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12004 (defun org-deadline (&optional remove time)
12006 With argument REMOVE, remove any deadline from the item.
12007 With argument TIME, set the deadline at the corresponding date. TIME
12009 (interactive "P")
12010 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12011 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12012 'region-start-level 'region))
12013 org-loop-over-headlines-in-active-region)
12014 (org-map-entries
12015 `(org-deadline ',remove ,time)
12016 org-loop-over-headlines-in-active-region
12017 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12018 (let* ((old-date (org-entry-get nil "DEADLINE"))
12019 (repeater (and old-date
12020 (string-match
12022 old-date)
12023 (match-string 1 old-date))))
12024 (if remove
12025 (progn
12026 (when (and old-date org-log-redeadline)
12027 (org-add-log-setup 'deldeadline nil old-date 'findpos
12028 org-log-redeadline))
12029 (org-remove-timestamp-with-keyword org-deadline-string)
12030 (message "Item no longer has a deadline."))
12031 (org-add-planning-info 'deadline time 'closed)
12032 (when (and old-date org-log-redeadline
12033 (not (equal old-date
12034 (substring org-last-inserted-timestamp 1 -1))))
12035 (org-add-log-setup 'redeadline nil old-date 'findpos
12036 org-log-redeadline))
12037 (when repeater
12038 (save-excursion
12039 (org-back-to-heading t)
12040 (when (re-search-forward (concat org-deadline-string " "
12041 org-last-inserted-timestamp)
12042 (save-excursion
12043 (outline-next-heading) (point)) t)
12044 (goto-char (1- (match-end 0)))
12045 (insert " " repeater)
12046 (setq org-last-inserted-timestamp
12047 (concat (substring org-last-inserted-timestamp 0 -1)
12048 " " repeater
12049 (substring org-last-inserted-timestamp -1))))))
12050 (message "Deadline on %s" org-last-inserted-timestamp)))))
12052 (defun org-schedule (&optional remove time)
12053 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12054 With argument REMOVE, remove any scheduling date from the item.
12055 With argument TIME, scheduled at the corresponding date. TIME can
12057 (interactive "P")
12058 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12059 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12060 'region-start-level 'region))
12061 org-loop-over-headlines-in-active-region)
12062 (org-map-entries
12063 `(org-schedule ',remove ,time)
12064 org-loop-over-headlines-in-active-region
12065 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12066 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12067 (repeater (and old-date
12068 (string-match
12070 old-date)
12071 (match-string 1 old-date))))
12072 (if remove
12073 (progn
12074 (when (and old-date org-log-reschedule)
12075 (org-add-log-setup 'delschedule nil old-date 'findpos
12076 org-log-reschedule))
12077 (org-remove-timestamp-with-keyword org-scheduled-string)
12078 (message "Item is no longer scheduled."))
12079 (org-add-planning-info 'scheduled time 'closed)
12080 (when (and old-date org-log-reschedule
12081 (not (equal old-date
12082 (substring org-last-inserted-timestamp 1 -1))))
12083 (org-add-log-setup 'reschedule nil old-date 'findpos
12084 org-log-reschedule))
12085 (when repeater
12086 (save-excursion
12087 (org-back-to-heading t)
12088 (when (re-search-forward (concat org-scheduled-string " "
12089 org-last-inserted-timestamp)
12090 (save-excursion
12091 (outline-next-heading) (point)) t)
12092 (goto-char (1- (match-end 0)))
12093 (insert " " repeater)
12094 (setq org-last-inserted-timestamp
12095 (concat (substring org-last-inserted-timestamp 0 -1)
12096 " " repeater
12097 (substring org-last-inserted-timestamp -1))))))
12098 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12100 (defun org-get-scheduled-time (pom &optional inherit)
12101 "Get the scheduled time as a time tuple, of a format suitable
12102 for calling org-schedule with, or if there is no scheduling,
12103 returns nil."
12104 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12105 (when time
12106 (apply 'encode-time (org-parse-time-string time)))))
12108 (defun org-get-deadline-time (pom &optional inherit)
12109 "Get the deadline as a time tuple, of a format suitable for
12110 calling org-deadline with, or if there is no scheduling, returns
12111 nil."
12112 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12113 (when time
12114 (apply 'encode-time (org-parse-time-string time)))))
12116 (defun org-remove-timestamp-with-keyword (keyword)
12117 "Remove all time stamps with KEYWORD in the current entry."
12119 beg)
12120 (save-excursion
12121 (org-back-to-heading t)
12122 (setq beg (point))
12123 (outline-next-heading)
12124 (while (re-search-backward re beg t)
12125 (replace-match "")
12127 (equal (char-before) ?\ ))
12128 (backward-delete-char 1)
12130 (point-at-bol) (point-at-eol)))
12131 (delete-region (point-at-bol)
12132 (min (point-max) (1+ (point-at-eol))))))))))
12134 (defun org-add-planning-info (what &optional time &rest remove)
12135 "Insert new timestamp with keyword in the line directly after the headline.
12136 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12137 If non is given, the user is prompted for a date.
12138 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12139 be removed."
12140 (interactive)
12141 (let (org-time-was-given org-end-time-was-given ts
12142 end default-time default-input)
12144 (catch 'exit
12145 (when (and (memq what '(scheduled deadline))
12146 (or (not time)
12147 (and (stringp time)
12148 (string-match "^[-+]+[0-9]" time))))
12149 ;; Try to get a default date/time from existing timestamp
12150 (save-excursion
12151 (org-back-to-heading t)
12152 (setq end (save-excursion (outline-next-heading) (point)))
12153 (when (re-search-forward (if (eq what 'scheduled)
12154 org-scheduled-time-regexp
12155 org-deadline-time-regexp)
12156 end t)
12157 (setq ts (match-string 1)
12158 default-time
12159 (apply 'encode-time (org-parse-time-string ts))
12160 default-input (and ts (org-get-compact-tod ts))))))
12161 (when what
12162 (setq time
12163 (if (stringp time)
12164 ;; This is a string (relative or absolute), set proper date
12165 (apply 'encode-time
12166 (org-read-date-analyze
12167 time default-time (decode-time default-time)))
12168 ;; If necessary, get the time from the user
12169 (or time (org-read-date nil 'to-time nil nil
12170 default-time default-input)))))
12172 (when (and org-insert-labeled-timestamps-at-point
12173 (member what '(scheduled deadline)))
12174 (insert
12175 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12176 (org-insert-time-stamp time org-time-was-given
12177 nil nil nil (list org-end-time-was-given))
12178 (setq what nil))
12179 (save-excursion
12180 (save-restriction
12181 (let (col list elt ts buffer-invisibility-spec)
12182 (org-back-to-heading t)
12184 (goto-char (match-end 1))
12185 (setq col (current-column))
12186 (goto-char (match-end 0))
12188 (when (and (not what)
12189 (not (looking-at
12191 org-keyword-time-not-clock-regexp))))
12192 ;; Nothing to add, nothing to remove...... :-)
12193 (throw 'exit nil))
12194 (if (and (not (looking-at org-outline-regexp))
12197 (not (equal (match-string 1) org-clock-string)))
12198 (narrow-to-region (match-beginning 0) (match-end 0))
12200 (backward-char 1)
12201 (narrow-to-region (point) (point))
12202 (and org-adapt-indentation (org-indent-to-column col)))
12203 ;; Check if we have to remove something.
12204 (setq list (cons what remove))
12205 (while list
12206 (setq elt (pop list))
12207 (when (or (and (eq elt 'scheduled)
12208 (re-search-forward org-scheduled-time-regexp nil t))
12209 (and (eq elt 'deadline)
12210 (re-search-forward org-deadline-time-regexp nil t))
12211 (and (eq elt 'closed)
12212 (re-search-forward org-closed-time-regexp nil t)))
12213 (replace-match "")
12214 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12216 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12217 (when what
12218 (insert
12219 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12220 (cond ((eq what 'scheduled) org-scheduled-string)
12221 ((eq what 'deadline) org-deadline-string)
12222 ((eq what 'closed) org-closed-string))
12223 " ")
12224 (setq ts (org-insert-time-stamp
12225 time
12226 (or org-time-was-given
12227 (and (eq what 'closed) org-log-done-with-time))
12228 (eq what 'closed)
12229 nil nil (list org-end-time-was-given)))
12230 (insert
12231 (if (not (or (bolp) (eq (char-before) ?\ )
12232 (memq (char-after) '(32 10))
12233 (eobp))) " " ""))
12234 (end-of-line 1))
12235 (goto-char (point-min))
12236 (widen)
12239 (delete-region (1- (point)) (point-at-eol)))
12240 ts))))))
12242 (defvar org-log-note-marker (make-marker))
12243 (defvar org-log-note-purpose nil)
12244 (defvar org-log-note-state nil)
12245 (defvar org-log-note-previous-state nil)
12246 (defvar org-log-note-how nil)
12247 (defvar org-log-note-extra nil)
12248 (defvar org-log-note-window-configuration nil)
12249 (defvar org-log-note-return-to (make-marker))
12250 (defvar org-log-note-effective-time nil
12251 "Remembered current time so that dynamically scoped
12252 `org-extend-today-until' affects tha timestamps in state change
12253 log")
12255 (defvar org-log-post-message nil
12256 "Message to be displayed after a log note has been stored.
12257 The auto-repeater uses this.")
12259 (defun org-add-note ()
12260 "Add a note to the current entry.
12261 This is done in the same way as adding a state change note."
12262 (interactive)
12263 (org-add-log-setup 'note nil nil 'findpos nil))
12265 (defvar org-property-end-re)
12266 (defun org-add-log-setup (&optional purpose state prev-state
12267 findpos how extra)
12268 "Set up the post command hook to take a note.
12269 If this is about to TODO state change, the new state is expected in STATE.
12270 When FINDPOS is non-nil, find the correct position for the note in
12271 the current entry. If not, assume that it can be inserted at point.
12272 HOW is an indicator what kind of note should be created.
12273 EXTRA is additional text that will be inserted into the notes buffer."
12274 (let* ((org-log-into-drawer (org-log-into-drawer))
12275 (drawer (cond ((stringp org-log-into-drawer)
12276 org-log-into-drawer)
12277 (org-log-into-drawer "LOGBOOK")
12278 (t nil))))
12279 (save-restriction
12280 (save-excursion
12281 (when findpos
12282 (org-back-to-heading t)
12283 (narrow-to-region (point) (save-excursion
12284 (outline-next-heading) (point)))
12288 (goto-char (match-end 0))
12289 (cond
12290 (drawer
12292 nil t)
12293 (progn
12294 (goto-char (match-end 0))
12295 (or org-log-states-order-reversed
12296 (and (re-search-forward org-property-end-re nil t)
12297 (goto-char (1- (match-beginning 0))))))
12299 (beginning-of-line 0)
12300 (org-indent-line-function)
12301 (beginning-of-line 2)
12302 (org-indent-line-function)
12303 (end-of-line 0)))
12304 ((and org-log-state-notes-insert-after-drawers
12305 (save-excursion
12306 (forward-line) (looking-at org-drawer-regexp)))
12307 (forward-line)
12308 (while (looking-at org-drawer-regexp)
12309 (goto-char (match-end 0))
12310 (re-search-forward org-property-end-re (point-max) t)
12311 (forward-line))
12312 (forward-line -1)))
12313 (unless org-log-states-order-reversed
12315 (org-skip-over-state-notes)
12317 (move-marker org-log-note-marker (point))
12318 (setq org-log-note-purpose purpose
12319 org-log-note-state state
12320 org-log-note-previous-state prev-state
12321 org-log-note-how how
12322 org-log-note-extra extra
12323 org-log-note-effective-time (org-current-effective-time))
12324 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12326 (defun org-skip-over-state-notes ()
12327 "Skip past the list of State notes in an entry."
12329 (when (ignore-errors (goto-char (org-in-item-p)))
12330 (let* ((struct (org-list-struct))
12331 (prevs (org-list-prevs-alist struct)))
12333 (goto-char (or (org-list-get-next-item (point) struct prevs)
12334 (org-list-get-item-end (point) struct)))))))
12336 (defun org-add-log-note (&optional purpose)
12337 "Pop up a window for taking a note, and add this note later at point."
12338 (remove-hook 'post-command-hook 'org-add-log-note)
12339 (setq org-log-note-window-configuration (current-window-configuration))
12340 (delete-other-windows)
12341 (move-marker org-log-note-return-to (point))
12342 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12343 (goto-char org-log-note-marker)
12344 (org-switch-to-buffer-other-window "*Org Note*")
12345 (erase-buffer)
12346 (if (memq org-log-note-how '(time state))
12347 (let (current-prefix-arg) (org-store-log-note))
12348 (let ((org-inhibit-startup t)) (org-mode))
12349 (insert (format "# Insert note for %s.
12351 (cond
12352 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12353 ((eq org-log-note-purpose 'done) "closed todo item")
12354 ((eq org-log-note-purpose 'state)
12356 (or org-log-note-previous-state "")
12357 (or org-log-note-state "")))
12358 ((eq org-log-note-purpose 'reschedule)
12359 "rescheduling")
12360 ((eq org-log-note-purpose 'delschedule)
12361 "no longer scheduled")
12362 ((eq org-log-note-purpose 'redeadline)
12363 "changing deadline")
12364 ((eq org-log-note-purpose 'deldeadline)
12365 "removing deadline")
12366 ((eq org-log-note-purpose 'refile)
12367 "refiling")
12368 ((eq org-log-note-purpose 'note)
12369 "this entry")
12370 (t (error "This should not happen")))))
12371 (if org-log-note-extra (insert org-log-note-extra))
12372 (org-set-local 'org-finish-function 'org-store-log-note)
12373 (run-hooks 'org-log-buffer-setup-hook)))
12375 (defvar org-note-abort nil) ; dynamically scoped
12376 (defun org-store-log-note ()
12377 "Finish taking a log note, and insert it to where it belongs."
12378 (let ((txt (buffer-string))
12379 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12380 lines ind bul)
12381 (kill-buffer (current-buffer))
12383 (setq txt (replace-match "" t t txt)))
12385 (setq txt (replace-match "" t t txt)))
12388 (setq note
12389 (org-replace-escapes
12390 note
12391 (list (cons "%u" (user-login-name))
12392 (cons "%U" user-full-name)
12393 (cons "%t" (format-time-string
12394 (org-time-stamp-format 'long 'inactive)
12395 org-log-note-effective-time))
12396 (cons "%T" (format-time-string
12397 (org-time-stamp-format 'long nil)
12398 org-log-note-effective-time))
12399 (cons "%d" (format-time-string
12400 (org-time-stamp-format nil 'inactive)
12401 org-log-note-effective-time))
12402 (cons "%D" (format-time-string
12403 (org-time-stamp-format nil nil)
12404 org-log-note-effective-time))
12405 (cons "%s" (if org-log-note-state
12407 ""))
12408 (cons "%S" (if org-log-note-previous-state
12412 (push note lines))
12413 (when (or current-prefix-arg org-note-abort)
12414 (when org-log-into-drawer
12415 (org-remove-empty-drawer-at
12416 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12417 org-log-note-marker))
12418 (setq lines nil))
12419 (when lines
12420 (with-current-buffer (marker-buffer org-log-note-marker)
12421 (save-excursion
12422 (goto-char org-log-note-marker)
12423 (move-marker org-log-note-marker nil)
12424 (end-of-line 1)
12426 (setq ind (save-excursion
12427 (if (ignore-errors (goto-char (org-in-item-p)))
12428 (let ((struct (org-list-struct)))
12429 (org-list-get-ind
12430 (org-list-get-top-point struct) struct))
12432 (cond
12433 ((and (org-at-heading-p)
12434 org-adapt-indentation)
12435 (1+ (org-current-level)))
12436 ((org-at-heading-p) 0)
12437 (t (org-get-indentation))))))
12438 (setq bul (org-list-bullet-string "-"))
12439 (org-indent-line-to ind)
12440 (insert bul (pop lines))
12441 (let ((ind-body (+ (length bul) ind)))
12442 (while lines
12444 (org-indent-line-to ind-body)
12445 (insert (pop lines))))
12446 (message "Note stored")
12447 (org-back-to-heading t)
12448 (org-cycle-hide-drawers 'children)))))
12449 (set-window-configuration org-log-note-window-configuration)
12450 (with-current-buffer (marker-buffer org-log-note-return-to)
12451 (goto-char org-log-note-return-to))
12452 (move-marker org-log-note-return-to nil)
12453 (and org-log-post-message (message "%s" org-log-post-message)))
12455 (defun org-remove-empty-drawer-at (drawer pos)
12456 "Remove an empty drawer DRAWER at position POS.
12457 POS may also be a marker."
12458 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12459 (save-excursion
12460 (save-restriction
12461 (widen)
12462 (goto-char pos)
12463 (if (org-in-regexp
12465 (replace-match ""))))))
12467 (defun org-sparse-tree (&optional arg)
12468 "Create a sparse tree, prompt for the details.
12469 This command can create sparse trees. You first need to select the type
12470 of match used to create the tree:
12472 t Show all TODO entries.
12473 T Show entries with a specific TODO keyword.
12474 m Show entries selected by a tags/property match.
12475 p Enter a property name and its value (both with completion on existing
12476 names/values) and show entries with that property.
12477 r Show entries matching a regular expression (`/' can be used as well)
12478 d Show deadlines due within `org-deadline-warning-days'.
12479 b Show deadlines and scheduled items before a date.
12480 a Show deadlines and scheduled items after a date."
12481 (interactive "P")
12482 (let (ans kwd value)
12483 (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")
12484 (setq ans (read-char-exclusive))
12485 (cond
12486 ((equal ans ?d)
12487 (call-interactively 'org-check-deadlines))
12488 ((equal ans ?b)
12489 (call-interactively 'org-check-before-date))
12490 ((equal ans ?a)
12491 (call-interactively 'org-check-after-date))
12492 ((equal ans ?D)
12493 (call-interactively 'org-check-dates-range))
12494 ((equal ans ?t)
12495 (org-show-todo-tree nil))
12496 ((equal ans ?T)
12497 (org-show-todo-tree '(4)))
12498 ((member ans '(?T ?m))
12499 (call-interactively 'org-match-sparse-tree))
12500 ((member ans '(?p ?P))
12501 (setq kwd (org-icompleting-read "Property: "
12502 (mapcar 'list (org-buffer-property-keys))))
12503 (setq value (org-icompleting-read "Value: "
12504 (mapcar 'list (org-property-values kwd))))
12507 (org-match-sparse-tree arg (concat kwd "=" value)))
12508 ((member ans '(?r ?R ?/))
12509 (call-interactively 'org-occur))
12512 (defvar org-occur-highlights nil
12513 "List of overlays used for occur matches.")
12514 (make-variable-buffer-local 'org-occur-highlights)
12515 (defvar org-occur-parameters nil
12516 "Parameters of the active org-occur calls.
12517 This is a list, each call to org-occur pushes as cons cell,
12518 containing the regular expression and the callback, onto the list.
12519 The list can contain several entries if `org-occur' has been called
12520 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12521 will only contain one set of parameters. When the highlights are
12522 removed (for example with `C-c C-c', or with the next edit (depending
12523 on `org-remove-highlights-with-change'), this variable is emptied
12524 as well.")
12525 (make-variable-buffer-local 'org-occur-parameters)
12527 (defun org-occur (regexp &optional keep-previous callback)
12528 "Make a compact tree which shows all matches of REGEXP.
12529 The tree will show the lines where the regexp matches, and all higher
12530 headlines above the match. It will also show the heading after the match,
12531 to make sure editing the matching entry is easy.
12532 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12533 call to `org-occur' will be kept, to allow stacking of calls to this
12534 command.
12535 If CALLBACK is non-nil, it is a function which is called to confirm
12536 that the match should indeed be shown."
12538 (when (equal regexp "")
12539 (error "Regexp cannot be empty"))
12540 (unless keep-previous
12541 (org-remove-occur-highlights nil nil t))
12542 (push (cons regexp callback) org-occur-parameters)
12543 (let ((cnt 0))
12544 (save-excursion
12545 (goto-char (point-min))
12546 (if (or (not keep-previous) ; do not want to keep
12547 (not org-occur-highlights)) ; no previous matches
12548 ;; hide everything
12549 (org-overview))
12550 (while (re-search-forward regexp nil t)
12551 (when (or (not callback)
12552 (save-match-data (funcall callback)))
12553 (setq cnt (1+ cnt))
12554 (when org-highlight-sparse-tree-matches
12555 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12556 (org-show-context 'occur-tree))))
12557 (when org-remove-highlights-with-change
12558 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12559 nil 'local))
12560 (unless org-sparse-tree-open-archived-trees
12561 (org-hide-archived-subtrees (point-min) (point-max)))
12562 (run-hooks 'org-occur-hook)
12563 (if (org-called-interactively-p 'interactive)
12564 (message "%d match(es) for regexp %s" cnt regexp))
12565 cnt))
12567 (defun org-occur-next-match (&optional n reset)
12568 "Function for `next-error-function' to find sparse tree matches.
12569 N is the number of matches to move, when negative move backwards.
12570 RESET is entirely ignored - this function always goes back to the
12571 starting point when no match is found."
12572 (let* ((limit (if (< n 0) (point-min) (point-max)))
12573 (search-func (if (< n 0)
12574 'previous-single-char-property-change
12575 'next-single-char-property-change))
12576 (n (abs n))
12577 (pos (point))
12578 p1)
12579 (catch 'exit
12580 (while (setq p1 (funcall search-func (point) 'org-type))
12581 (when (equal p1 limit)
12582 (goto-char pos)
12583 (error "No more matches"))
12584 (when (equal (get-char-property p1 'org-type) 'org-occur)
12585 (setq n (1- n))
12586 (when (= n 0)
12587 (goto-char p1)
12588 (throw 'exit (point))))
12589 (goto-char p1))
12590 (goto-char p1)
12591 (error "No more matches"))))
12593 (defun org-show-context (&optional key)
12594 "Make sure point and context are visible.
12595 How much context is shown depends upon the variables
12596 `org-show-hierarchy-above', `org-show-following-heading',
12597 `org-show-entry-below' and `org-show-siblings'."
12598 (let ((heading-p (org-at-heading-p t))
12599 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12600 (following-p (org-get-alist-option org-show-following-heading key))
12601 (entry-p (org-get-alist-option org-show-entry-below key))
12602 (siblings-p (org-get-alist-option org-show-siblings key)))
12603 (catch 'exit
12604 ;; Show heading or entry text
12605 (if (and heading-p (not entry-p))
12606 (org-flag-heading nil) ; only show the heading
12607 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12608 (org-show-hidden-entry))) ; show entire entry
12609 (when following-p
12610 ;; Show next sibling, or heading below text
12611 (save-excursion
12612 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12613 (org-flag-heading nil))))
12614 (when siblings-p (org-show-siblings))
12615 (when hierarchy-p
12616 ;; show all higher headings, possibly with siblings
12617 (save-excursion
12618 (while (and (condition-case nil
12619 (progn (org-up-heading-all 1) t)
12620 (error nil))
12621 (not (bobp)))
12622 (org-flag-heading nil)
12623 (when siblings-p (org-show-siblings))))))))
12625 (defvar org-reveal-start-hook nil
12626 "Hook run before revealing a location.")
12628 (defun org-reveal (&optional siblings)
12629 "Show current entry, hierarchy above it, and the following headline.
12630 This can be used to show a consistent set of context around locations
12631 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12632 not t for the search context.
12634 With optional argument SIBLINGS, on each level of the hierarchy all
12635 siblings are shown. This repairs the tree structure to what it would
12636 look like when opened with hierarchical calls to `org-cycle'.
12638 go to the parent and show the
12639 entire tree."
12640 (interactive "P")
12641 (run-hooks 'org-reveal-start-hook)
12642 (let ((org-show-hierarchy-above t)
12643 (org-show-following-heading t)
12644 (org-show-siblings (if siblings t org-show-siblings)))
12645 (org-show-context nil))
12646 (when (equal siblings '(16))
12647 (save-excursion
12648 (when (org-up-heading-safe)
12649 (org-show-subtree)
12650 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12652 (defun org-highlight-new-match (beg end)
12653 "Highlight from BEG to END and mark the highlight is an occur headline."
12654 (let ((ov (make-overlay beg end)))
12655 (overlay-put ov 'face 'secondary-selection)
12656 (overlay-put ov 'org-type 'org-occur)
12657 (push ov org-occur-highlights)))
12659 (defun org-remove-occur-highlights (&optional beg end noremove)
12660 "Remove the occur highlights from the buffer.
12661 BEG and END are ignored. If NOREMOVE is nil, remove this function
12662 from the `before-change-functions' in the current buffer."
12663 (interactive)
12664 (unless org-inhibit-highlight-removal
12665 (mapc 'delete-overlay org-occur-highlights)
12666 (setq org-occur-highlights nil)
12667 (setq org-occur-parameters nil)
12668 (unless noremove
12669 (remove-hook 'before-change-functions
12670 'org-remove-occur-highlights 'local))))
12672 ;;;; Priorities
12675 "Regular expression matching the priority indicator.")
12677 (defvar org-remove-priority-next-time nil)
12679 (defun org-priority-up ()
12680 "Increase the priority of the current item."
12681 (interactive)
12682 (org-priority 'up))
12684 (defun org-priority-down ()
12685 "Decrease the priority of the current item."
12686 (interactive)
12687 (org-priority 'down))
12689 (defun org-priority (&optional action)
12690 "Change the priority of an item by ARG.
12691 ACTION can be `set', `up', `down', or a character."
12692 (interactive)
12693 (unless org-enable-priority-commands
12694 (error "Priority commands are disabled"))
12695 (setq action (or action 'set))
12696 (let (current new news have remove)
12697 (save-excursion
12698 (org-back-to-heading t)
12699 (if (looking-at org-priority-regexp)
12700 (setq current (string-to-char (match-string 2))
12701 have t))
12702 (cond
12703 ((eq action 'remove)
12704 (setq remove t new ?\ ))
12705 ((or (eq action 'set)
12706 (if (featurep 'xemacs) (characterp action) (integerp action)))
12707 (if (not (eq action 'set))
12708 (setq new action)
12709 (message "Priority %c-%c, SPC to remove: "
12710 org-highest-priority org-lowest-priority)
12711 (save-match-data
12712 (setq new (read-char-exclusive))))
12713 (if (and (= (upcase org-highest-priority) org-highest-priority)
12714 (= (upcase org-lowest-priority) org-lowest-priority))
12715 (setq new (upcase new)))
12716 (cond ((equal new ?\ ) (setq remove t))
12717 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12718 (error "Priority must be between `%c' and `%c'"
12719 org-highest-priority org-lowest-priority))))
12720 ((eq action 'up)
12721 (setq new (if have
12722 (1- current) ; normal cycling
12723 ;; last priority was empty
12724 (if (eq last-command this-command)
12725 org-lowest-priority ; wrap around empty to lowest
12726 ;; default
12727 (if org-priority-start-cycle-with-default
12728 org-default-priority
12729 (1- org-default-priority))))))
12730 ((eq action 'down)
12731 (setq new (if have
12732 (1+ current) ; normal cycling
12733 ;; last priority was empty
12734 (if (eq last-command this-command)
12735 org-highest-priority ; wrap around empty to highest
12736 ;; default
12737 (if org-priority-start-cycle-with-default
12738 org-default-priority
12739 (1+ org-default-priority))))))
12740 (t (error "Invalid action")))
12741 (if (or (< (upcase new) org-highest-priority)
12742 (> (upcase new) org-lowest-priority))
12743 (if (and (memq action '(up down))
12744 (not have) (not (eq last-command this-command)))
12745 ;; `new' is from default priority
12746 (error
12747 "The default can not be set, see `org-default-priority' why")
12748 ;; normal cycling: `new' is beyond highest/lowest priority
12749 ;; and is wrapped around to the empty priority
12750 (setq remove t)))
12751 (setq news (format "%c" new))
12752 (if have
12753 (if remove
12754 (replace-match "" t t nil 1)
12755 (replace-match news t t nil 2))
12756 (if remove
12757 (error "No priority cookie found in line")
12758 (let ((case-fold-search nil))
12759 (looking-at org-todo-line-regexp))
12760 (if (match-end 2)
12761 (progn
12762 (goto-char (match-end 2))
12763 (insert " [#" news "]"))
12764 (goto-char (match-beginning 3))
12765 (insert "[#" news "] "))))
12766 (org-preserve-lc (org-set-tags nil 'align)))
12767 (if remove
12768 (message "Priority removed")
12769 (message "Priority of current item set to %s" news))))
12771 (defun org-get-priority (s)
12772 "Find priority cookie and return priority."
12773 (if (functionp org-get-priority-function)
12774 (funcall org-get-priority-function)
12775 (save-match-data
12776 (if (not (string-match org-priority-regexp s))
12777 (* 1000 (- org-lowest-priority org-default-priority))
12778 (* 1000 (- org-lowest-priority
12779 (string-to-char (match-string 2 s))))))))
12781 ;;;; Tags
12783 (defvar org-agenda-archives-mode)
12784 (defvar org-map-continue-from nil
12785 "Position from where mapping should continue.
12786 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12788 (defvar org-scanner-tags nil
12789 "The current tag list while the tags scanner is running.")
12790 (defvar org-trust-scanner-tags nil
12791 "Should `org-get-tags-at' use the tags for the scanner.
12792 This is for internal dynamical scoping only.
12793 When this is non-nil, the function `org-get-tags-at' will return the value
12794 of `org-scanner-tags' instead of building the list by itself. This
12795 can lead to large speed-ups when the tags scanner is used in a file with
12796 many entries, and when the list of tags is retrieved, for example to
12797 obtain a list of properties. Building the tags list for each entry in such
12798 a file becomes an N^2 operation - but with this variable set, it scales
12799 as N.")
12801 (defun org-scan-tags (action matcher &optional todo-only start-level)
12802 "Scan headline tags with inheritance and produce output ACTION.
12804 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12805 or `agenda' to produce an entry list for an agenda view. It can also be
12806 a Lisp form or a function that should be called at each matched headline, in
12807 this case the return value is a list of all return values from these calls.
12809 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12810 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12811 only lines with a TODO keyword are included in the output.
12813 START-LEVEL can be a string with asterisks, reducing the scope to
12814 headlines matching this string."
12815 (require 'org-agenda)
12816 (let* ((re (concat "^"
12817 (if start-level
12818 ;; Get the correct level to match
12820 org-outline-regexp)
12823 (org-re
12825 (props (list 'face 'default
12826 'done-face 'org-agenda-done
12827 'undone-face 'default
12828 'mouse-face 'highlight
12829 'org-not-done-regexp org-not-done-regexp
12830 'org-todo-regexp org-todo-regexp
12831 'org-complex-heading-regexp org-complex-heading-regexp
12832 'help-echo
12833 (format "mouse-2 or RET jump to org file %s"
12834 (abbreviate-file-name
12835 (or (buffer-file-name (buffer-base-buffer))
12836 (buffer-name (buffer-base-buffer)))))))
12837 (case-fold-search nil)
12838 (org-map-continue-from nil)
12839 lspos tags
12840 (tags-alist (list (cons 0 org-file-tags)))
12841 (llast 0) rtn rtn1 level category i txt
12842 todo marker entry priority)
12843 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12844 (setq action (list 'lambda nil action)))
12845 (save-excursion
12846 (goto-char (point-min))
12847 (when (eq action 'sparse-tree)
12848 (org-overview)
12849 (org-remove-occur-highlights))
12850 (while (re-search-forward re nil t)
12851 (setq org-map-continue-from nil)
12852 (catch :skip
12853 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12854 tags (if (match-end 4) (org-match-string-no-properties 4)))
12855 (goto-char (setq lspos (match-beginning 0)))
12856 (setq level (org-reduced-level (funcall outline-level))
12857 category (org-get-category))
12858 (setq i llast llast level)
12859 ;; remove tag lists from same and sublevels
12860 (while (>= i level)
12861 (when (setq entry (assoc i tags-alist))
12862 (setq tags-alist (delete entry tags-alist)))
12863 (setq i (1- i)))
12864 ;; add the next tags
12865 (when tags
12866 (setq tags (org-split-string tags ":")
12867 tags-alist
12868 (cons (cons level tags) tags-alist)))
12869 ;; compile tags for current headline
12870 (setq tags-list
12871 (if org-use-tag-inheritance
12872 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12873 tags)
12874 org-scanner-tags tags-list)
12875 (when org-use-tag-inheritance
12876 (setcdr (car tags-alist)
12877 (mapcar (lambda (x)
12878 (setq x (copy-sequence x))
12879 (org-add-prop-inherited x))
12880 (cdar tags-alist))))
12881 (when (and tags org-use-tag-inheritance
12882 (or (not (eq t org-use-tag-inheritance))
12883 org-tags-exclude-from-inheritance))
12884 ;; selective inheritance, remove uninherited ones
12885 (setcdr (car tags-alist)
12886 (org-remove-uninherited-tags (cdar tags-alist))))
12887 (when (and
12889 ;; eval matcher only when the todo condition is OK
12890 (and (or (not todo-only) (member todo org-not-done-keywords))
12891 (let ((case-fold-search t)) (eval matcher)))
12893 ;; Call the skipper, but return t if it does not skip,
12894 ;; so that the `and' form continues evaluating
12895 (progn
12896 (unless (eq action 'sparse-tree) (org-agenda-skip))
12897 t)
12899 ;; Check if timestamps are deselecting this entry
12900 (or (not todo-only)
12901 (and (member todo org-not-done-keywords)
12902 (or (not org-agenda-tags-todo-honor-ignore-options)
12903 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12905 ;; Extra check for the archive tag
12906 ;; FIXME: Does the skipper already do this????
12907 (or
12908 (not (member org-archive-tag tags-list))
12909 ;; we have an archive tag, should we use this anyway?
12910 (or (not org-agenda-skip-archived-trees)
12911 (and (eq action 'agenda) org-agenda-archives-mode))))
12913 ;; select this headline
12915 (cond
12916 ((eq action 'sparse-tree)
12917 (and org-highlight-sparse-tree-matches
12918 (org-get-heading) (match-end 0)
12919 (org-highlight-new-match
12920 (match-beginning 1) (match-end 1)))
12921 (org-show-context 'tags-tree))
12922 ((eq action 'agenda)
12923 (setq txt (org-agenda-format-item
12924 ""
12925 (concat
12926 (if (eq org-tags-match-list-sublevels 'indented)
12927 (make-string (1- level) ?.) "")
12928 (org-get-heading))
12929 category
12930 tags-list)
12931 priority (org-get-priority txt))
12932 (goto-char lspos)
12933 (setq marker (org-agenda-new-marker))
12934 (org-add-props txt props
12935 'org-marker marker 'org-hd-marker marker 'org-category category
12936 'todo-state todo
12937 'priority priority 'type "tagsmatch")
12938 (push txt rtn))
12939 ((functionp action)
12940 (setq org-map-continue-from nil)
12941 (save-excursion
12942 (setq rtn1 (funcall action))
12943 (push rtn1 rtn)))
12944 (t (error "Invalid action")))
12946 ;; if we are to skip sublevels, jump to end of subtree
12947 (unless org-tags-match-list-sublevels
12948 (org-end-of-subtree t)
12949 (backward-char 1))))
12950 ;; Get the correct position from where to continue
12951 (if org-map-continue-from
12952 (goto-char org-map-continue-from)
12953 (and (= (point) lspos) (end-of-line 1)))))
12954 (when (and (eq action 'sparse-tree)
12955 (not org-sparse-tree-open-archived-trees))
12956 (org-hide-archived-subtrees (point-min) (point-max)))
12957 (nreverse rtn)))
12959 (defun org-remove-uninherited-tags (tags)
12960 "Remove all tags that are not inherited from the list TAGS."
12961 (cond
12962 ((eq org-use-tag-inheritance t)
12963 (if org-tags-exclude-from-inheritance
12964 (org-delete-all org-tags-exclude-from-inheritance tags)
12965 tags))
12966 ((not org-use-tag-inheritance) nil)
12967 ((stringp org-use-tag-inheritance)
12968 (delq nil (mapcar
12969 (lambda (x)
12970 (if (and (string-match org-use-tag-inheritance x)
12971 (not (member x org-tags-exclude-from-inheritance)))
12972 x nil))
12973 tags)))
12974 ((listp org-use-tag-inheritance)
12975 (delq nil (mapcar
12976 (lambda (x)
12977 (if (member x org-use-tag-inheritance) x nil))
12978 tags)))))
12980 (defvar todo-only) ;; dynamically scoped
12982 (defun org-match-sparse-tree (&optional todo-only match)
12983 "Create a sparse tree according to tags string MATCH.
12984 MATCH can contain positive and negative selection of tags, like
12986 If optional argument TODO-ONLY is non-nil, only select lines that are
12987 also TODO lines."
12988 (interactive "P")
12989 (org-prepare-agenda-buffers (list (current-buffer)))
12990 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12992 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12994 (defvar org-cached-props nil)
12995 (defun org-cached-entry-get (pom property)
12996 (if (or (eq t org-use-property-inheritance)
12997 (and (stringp org-use-property-inheritance)
12998 (string-match org-use-property-inheritance property))
12999 (and (listp org-use-property-inheritance)
13000 (member property org-use-property-inheritance)))
13001 ;; Caching is not possible, check it directly
13002 (org-entry-get pom property 'inherit)
13003 ;; Get all properties, so that we can do complicated checks easily
13004 (cdr (assoc property (or org-cached-props
13005 (setq org-cached-props
13006 (org-entry-properties pom)))))))
13008 (defun org-global-tags-completion-table (&optional files)
13009 "Return the list of all tags in all agenda buffer/files.
13010 Optional FILES argument is a list of files to which can be used
13011 instead of the agenda files."
13012 (save-excursion
13013 (org-uniquify
13014 (delq nil
13015 (apply 'append
13016 (mapcar
13017 (lambda (file)
13018 (set-buffer (find-file-noselect file))
13019 (append (org-get-buffer-tags)
13020 (mapcar (lambda (x) (if (stringp (car-safe x))
13021 (list (car-safe x)) nil))
13022 org-tag-alist)))
13023 (if (and files (car files))
13024 files
13025 (org-agenda-files))))))))
13027 (defun org-make-tags-matcher (match)
13028 "Create the TAGS/TODO matcher form for the selection string MATCH."
13029 ;; todo-only is scoped dynamically into this function, and the function
13030 ;; may change it if the matcher asks for it.
13031 (unless match
13032 ;; Get a new match request, with completion
13033 (let ((org-last-tags-completion-table
13034 (org-global-tags-completion-table)))
13035 (setq match (org-completing-read-no-i
13036 "Match: " 'org-tags-completion-function nil nil nil
13037 'org-tags-history))))
13039 ;; Parse the string and create a lisp form
13040 (let ((match0 match)
13041 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13042 minus tag mm
13043 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13044 orterms term orlist re-p str-p level-p level-op time-p
13045 prop-p pn pv po gv rest)
13046 (if (string-match "/+" match)
13047 ;; match contains also a todo-matching request
13048 (progn
13049 (setq tagsmatch (substring match 0 (match-beginning 0))
13050 todomatch (substring match (match-end 0)))
13051 (if (string-match "^!" todomatch)
13052 (setq todo-only t todomatch (substring todomatch 1)))
13054 (setq todomatch nil)))
13055 ;; only matching tags
13056 (setq tagsmatch match todomatch nil))
13058 ;; Make the tags matcher
13060 (setq tagsmatcher t)
13061 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13062 (while (setq term (pop orterms))
13064 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13065 (while (string-match re term)
13066 (setq rest (substring term (match-end 0))
13067 minus (and (match-end 1)
13068 (equal (match-string 1 term) "-"))
13069 tag (save-match-data (replace-regexp-in-string
13071 (match-string 2 term)))
13072 re-p (equal (string-to-char tag) ?{)
13073 level-p (match-end 4)
13074 prop-p (match-end 5)
13075 mm (cond
13076 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13077 (level-p
13078 (setq level-op (org-op-to-function (match-string 3 term)))
13079 `(,level-op level ,(string-to-number
13080 (match-string 4 term))))
13081 (prop-p
13082 (setq pn (match-string 5 term)
13083 po (match-string 6 term)
13084 pv (match-string 7 term)
13085 re-p (equal (string-to-char pv) ?{)
13087 time-p (save-match-data
13089 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13090 (if time-p (setq pv (org-matcher-time pv)))
13091 (setq po (org-op-to-function po (if time-p 'time str-p)))
13092 (cond
13093 ((equal pn "CATEGORY")
13094 (setq gv '(get-text-property (point) 'org-category)))
13095 ((equal pn "TODO")
13096 (setq gv 'todo))
13097 (t
13098 (setq gv `(org-cached-entry-get nil ,pn))))
13099 (if re-p
13100 (if (eq po 'org<>)
13101 `(not (string-match ,pv (or ,gv "")))
13102 `(string-match ,pv (or ,gv "")))
13103 (if str-p
13104 `(,po (or ,gv "") ,pv)
13105 `(,po (string-to-number (or ,gv ""))
13106 ,(string-to-number pv) ))))
13107 (t `(member ,tag tags-list)))
13108 mm (if minus (list 'not mm) mm)
13109 term rest)
13110 (push mm tagsmatcher))
13111 (push (if (> (length tagsmatcher) 1)
13112 (cons 'and tagsmatcher)
13113 (car tagsmatcher))
13114 orlist)
13115 (setq tagsmatcher nil))
13116 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13117 (setq tagsmatcher
13118 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13119 ;; Make the todo matcher
13121 (setq todomatcher t)
13122 (setq orterms (org-split-string todomatch "|") orlist nil)
13123 (while (setq term (pop orterms))
13124 (while (string-match re term)
13125 (setq minus (and (match-end 1)
13126 (equal (match-string 1 term) "-"))
13127 kwd (match-string 2 term)
13128 re-p (equal (string-to-char kwd) ?{)
13129 term (substring term (match-end 0))
13130 mm (if re-p
13131 `(string-match ,(substring kwd 1 -1) todo)
13132 (list 'equal 'todo kwd))
13133 mm (if minus (list 'not mm) mm))
13134 (push mm todomatcher))
13135 (push (if (> (length todomatcher) 1)
13136 (cons 'and todomatcher)
13137 (car todomatcher))
13138 orlist)
13139 (setq todomatcher nil))
13140 (setq todomatcher (if (> (length orlist) 1)
13141 (cons 'or orlist) (car orlist))))
13143 ;; Return the string and lisp forms of the matcher
13144 (setq matcher (if todomatcher
13145 (list 'and tagsmatcher todomatcher)
13146 tagsmatcher))
13147 (cons match0 matcher)))
13149 (defun org-op-to-function (op &optional stringp)
13150 "Turn an operator into the appropriate function."
13151 (setq op
13152 (cond
13153 ((equal op "<" ) '(< string< org-time<))
13154 ((equal op ">" ) '(> org-string> org-time>))
13155 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13156 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13157 ((member op '("=" "==")) '(= string= org-time=))
13158 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13159 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13161 (defun org<> (a b) (not (= a b)))
13162 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13163 (defun org-string>= (a b) (not (string< a b)))
13164 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13165 (defun org-string<> (a b) (not (string= a b)))
13166 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13167 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13168 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13169 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13170 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13171 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13172 (defun org-2ft (s)
13173 "Convert S to a floating point time.
13174 If S is already a number, just return it. If it is a string, parse
13175 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13176 (cond
13177 ((numberp s) s)
13178 ((stringp s)
13179 (condition-case nil
13180 (float-time (apply 'encode-time (org-parse-time-string s)))
13181 (error 0.)))
13182 (t 0.)))
13184 (defun org-time-today ()
13185 "Time in seconds today at 0:00.
13186 Returns the float number of seconds since the beginning of the
13187 epoch to the beginning of today (00:00)."
13188 (float-time (apply 'encode-time
13189 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13191 (defun org-matcher-time (s)
13192 "Interpret a time comparison value."
13193 (save-match-data
13194 (cond
13195 ((string= s "<now>") (float-time))
13196 ((string= s "<today>") (org-time-today))
13197 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13198 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13200 (+ (org-time-today)
13201 (* (string-to-number (match-string 1 s))
13202 (cdr (assoc (match-string 2 s)
13203 '(("d" . 86400.0) ("w" . 604800.0)
13204 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13205 (t (org-2ft s)))))
13207 (defun org-match-any-p (re list)
13208 "Does re match any element of list?"
13209 (setq list (mapcar (lambda (x) (string-match re x)) list))
13210 (delq nil list))
13212 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13213 (defvar org-tags-overlay (make-overlay 1 1))
13214 (org-detach-overlay org-tags-overlay)
13216 (defun org-get-local-tags-at (&optional pos)
13217 "Get a list of tags defined in the current headline."
13218 (org-get-tags-at pos 'local))
13220 (defun org-get-local-tags ()
13221 "Get a list of tags defined in the current headline."
13222 (org-get-tags-at nil 'local))
13224 (defun org-get-tags-at (&optional pos local)
13225 "Get a list of all headline tags applicable at POS.
13226 POS defaults to point. If tags are inherited, the list contains
13227 the targets in the same sequence as the headlines appear, i.e.
13228 the tags of the current headline come last.
13229 When LOCAL is non-nil, only return tags from the current headline,
13230 ignore inherited ones."
13231 (interactive)
13232 (if (and org-trust-scanner-tags
13233 (or (not pos) (equal pos (point)))
13234 (not local))
13235 org-scanner-tags
13236 (let (tags ltags lastpos parent)
13237 (save-excursion
13238 (save-restriction
13239 (widen)
13240 (goto-char (or pos (point)))
13241 (save-match-data
13242 (catch 'done
13243 (condition-case nil
13244 (progn
13245 (org-back-to-heading t)
13246 (while (not (equal lastpos (point)))
13247 (setq lastpos (point))
13248 (when (looking-at
13250 (setq ltags (org-split-string
13251 (org-match-string-no-properties 1) ":"))
13252 (when parent
13253 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13254 (setq tags (append
13255 (if parent
13256 (org-remove-uninherited-tags ltags)
13257 ltags)
13258 tags)))
13259 (or org-use-tag-inheritance (throw 'done t))
13260 (if local (throw 'done t))
13261 (or (org-up-heading-safe) (error nil))
13262 (setq parent t)))
13263 (error nil)))))
13264 (if local
13265 tags
13266 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13268 (defun org-add-prop-inherited (s)
13269 (add-text-properties 0 (length s) '(inherited t) s)
13270 s)
13272 (defun org-toggle-tag (tag &optional onoff)
13273 "Toggle the tag TAG for the current line.
13274 If ONOFF is `on' or `off', don't toggle but set to this state."
13275 (let (res current)
13276 (save-excursion
13277 (org-back-to-heading t)
13279 (point-at-eol) t)
13280 (progn
13281 (setq current (match-string 1))
13282 (replace-match ""))
13283 (setq current ""))
13284 (setq current (nreverse (org-split-string current ":")))
13285 (cond
13286 ((eq onoff 'on)
13287 (setq res t)
13288 (or (member tag current) (push tag current)))
13289 ((eq onoff 'off)
13290 (or (not (member tag current)) (setq current (delete tag current))))
13291 (t (if (member tag current)
13292 (setq current (delete tag current))
13293 (setq res t)
13294 (push tag current))))
13295 (end-of-line 1)
13296 (if current
13297 (progn
13298 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13299 (org-set-tags nil t))
13300 (delete-horizontal-space))
13301 (run-hooks 'org-after-tags-change-hook))
13302 res))
13304 (defun org-align-tags-here (to-col)
13305 ;; Assumes that this is a headline
13306 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13307 (beginning-of-line 1)
13309 (< pos (match-beginning 2)))
13310 (progn
13311 (setq tags-l (- (match-end 2) (match-beginning 2)))
13312 (goto-char (match-beginning 1))
13313 (insert " ")
13314 (delete-region (point) (1+ (match-beginning 2)))
13315 (setq ncol (max (current-column)
13316 (1+ col)
13317 (if (> to-col 0)
13318 to-col
13319 (- (abs to-col) tags-l))))
13320 (setq p (point))
13321 (insert (make-string (- ncol (current-column)) ?\ ))
13322 (setq ncol (current-column))
13323 (when indent-tabs-mode (tabify p (point-at-eol)))
13324 (org-move-to-column (min ncol col) t))
13325 (goto-char pos))))
13327 (defun org-set-tags-command (&optional arg just-align)
13328 "Call the set-tags command for the current entry."
13329 (interactive "P")
13330 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13331 (org-set-tags arg just-align)
13332 (save-excursion
13333 (org-back-to-heading t)
13334 (org-set-tags arg just-align))))
13336 (defun org-set-tags-to (data)
13337 "Set the tags of the current entry to DATA, replacing the current tags.
13338 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13339 If DATA is nil or the empty string, any tags will be removed."
13340 (interactive "sTags: ")
13341 (setq data
13342 (cond
13343 ((eq data nil) "")
13344 ((equal data "") "")
13345 ((stringp data)
13346 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13347 ":"))
13348 ((listp data)
13349 (concat ":" (mapconcat 'identity data ":") ":"))
13350 (t nil)))
13351 (when data
13352 (save-excursion
13353 (org-back-to-heading t)
13354 (when (looking-at org-complex-heading-regexp)
13355 (if (match-end 5)
13356 (progn
13357 (goto-char (match-beginning 5))
13358 (insert data)
13359 (delete-region (point) (point-at-eol))
13360 (org-set-tags nil 'align))
13361 (goto-char (point-at-eol))
13362 (insert " " data)
13363 (org-set-tags nil 'align)))
13364 (beginning-of-line 1)
13366 (delete-region (match-beginning 1) (match-end 1))))))
13368 (defun org-align-all-tags ()
13369 "Align the tags i all headings."
13370 (interactive)
13371 (save-excursion
13372 (or (ignore-errors (org-back-to-heading t))
13373 (outline-next-heading))
13374 (if (org-at-heading-p)
13375 (org-set-tags t)
13376 (message "No headings"))))
13378 (defvar org-indent-indentation-per-level)
13379 (defun org-set-tags (&optional arg just-align)
13380 "Set the tags for the current headline.
13381 With prefix ARG, realign all tags in headings in the current buffer."
13382 (interactive "P")
13383 (let* ((re org-outline-regexp-bol)
13384 (current (unless arg (org-get-tags-string)))
13385 (col (current-column))
13386 (org-setting-tags t)
13387 table current-tags inherited-tags ; computed below when needed
13388 tags p0 c0 c1 rpl di tc level)
13389 (if arg
13390 (save-excursion
13391 (goto-char (point-min))
13392 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13393 (while (re-search-forward re nil t)
13394 (org-set-tags nil t)
13395 (end-of-line 1)))
13396 (message "All tags realigned to column %d" org-tags-column))
13397 (if just-align
13398 (setq tags current)
13399 ;; Get a new set of tags from the user
13400 (save-excursion
13401 (setq table (append org-tag-persistent-alist
13402 (or org-tag-alist (org-get-buffer-tags))
13403 (and
13404 org-complete-tags-always-offer-all-agenda-tags
13405 (org-global-tags-completion-table
13406 (org-agenda-files))))
13407 org-last-tags-completion-table table
13408 current-tags (org-split-string current ":")
13409 inherited-tags (nreverse
13410 (nthcdr (length current-tags)
13411 (nreverse (org-get-tags-at))))
13412 tags
13413 (if (or (eq t org-use-fast-tag-selection)
13414 (and org-use-fast-tag-selection
13415 (delq nil (mapcar 'cdr table))))
13416 (org-fast-tag-selection
13417 current-tags inherited-tags table
13418 (if org-fast-tag-selection-include-todo
13419 org-todo-key-alist))
13420 (let ((org-add-colon-after-tag-completion t))
13421 (org-trim
13422 (org-icompleting-read "Tags: "
13423 'org-tags-completion-function
13424 nil nil current 'org-tags-history))))))
13425 (while (string-match "[-+&]+" tags)
13426 ;; No boolean logic, just a list
13427 (setq tags (replace-match ":" t t tags))))
13429 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13431 (if org-tags-sort-function
13432 (setq tags (mapconcat 'identity
13433 (sort (org-split-string
13434 tags (org-re "[^[:alnum:]_@#%]+"))
13435 org-tags-sort-function) ":")))
13438 (setq tags "")
13439 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13440 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13442 ;; Insert new tags at the correct column
13443 (beginning-of-line 1)
13444 (setq level (or (and (looking-at org-outline-regexp)
13445 (- (match-end 0) (point) 1))
13446 1))
13447 (cond
13448 ((and (equal current "") (equal tags "")))
13449 ((re-search-forward
13451 (point-at-eol) t)
13452 (if (equal tags "")
13453 (setq rpl "")
13454 (goto-char (match-beginning 0))
13455 (setq c0 (current-column)
13456 ;; compute offset for the case of org-indent-mode active
13457 di (if org-indent-mode
13458 (* (1- org-indent-indentation-per-level) (1- level))
13459 0)
13460 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13461 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13462 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13463 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13464 (replace-match rpl t t)
13465 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13466 tags)
13467 (t (error "Tags alignment failed")))
13468 (org-move-to-column col)
13469 (unless just-align
13470 (run-hooks 'org-after-tags-change-hook)))))
13472 (defun org-change-tag-in-region (beg end tag off)
13473 "Add or remove TAG for each entry in the region.
13474 This works in the agenda, and also in an org-mode buffer."
13475 (interactive
13476 (list (region-beginning) (region-end)
13477 (let ((org-last-tags-completion-table
13478 (if (eq major-mode 'org-mode)
13479 (org-get-buffer-tags)
13480 (org-global-tags-completion-table))))
13481 (org-icompleting-read
13482 "Tag: " 'org-tags-completion-function nil nil nil
13483 'org-tags-history))
13484 (progn
13486 (equal (read-char-exclusive) ?r))))
13487 (if (fboundp 'deactivate-mark) (deactivate-mark))
13488 (let ((agendap (equal major-mode 'org-agenda-mode))
13489 l1 l2 m buf pos newhead (cnt 0))
13490 (goto-char end)
13491 (setq l2 (1- (org-current-line)))
13492 (goto-char beg)
13493 (setq l1 (org-current-line))
13494 (loop for l from l1 to l2 do
13495 (org-goto-line l)
13496 (setq m (get-text-property (point) 'org-hd-marker))
13497 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13498 (and agendap m))
13499 (setq buf (if agendap (marker-buffer m) (current-buffer))
13500 pos (if agendap m (point)))
13501 (with-current-buffer buf
13502 (save-excursion
13503 (save-restriction
13504 (goto-char pos)
13505 (setq cnt (1+ cnt))
13506 (org-toggle-tag tag (if off 'off 'on))
13507 (setq newhead (org-get-heading)))))
13508 (and agendap (org-agenda-change-all-lines newhead m))))
13509 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13511 (defun org-tags-completion-function (string predicate &optional flag)
13512 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13513 (confirm (lambda (x) (stringp (car x)))))
13515 (setq s1 (match-string 1 string)
13516 s2 (match-string 2 string))
13517 (setq s1 "" s2 string))
13518 (cond
13519 ((eq flag nil)
13520 ;; try completion
13521 (setq rtn (try-completion s2 ctable confirm))
13522 (if (stringp rtn)
13523 (setq rtn
13524 (concat s1 s2 (substring rtn (length s2))
13525 (if (and org-add-colon-after-tag-completion
13526 (assoc rtn ctable))
13527 ":" ""))))
13528 rtn)
13529 ((eq flag t)
13530 ;; all-completions
13531 (all-completions s2 ctable confirm)
13532 )
13533 ((eq flag 'lambda)
13534 ;; exact match?
13535 (assoc s2 ctable)))
13536 ))
13538 (defun org-fast-tag-insert (kwd tags face &optional end)
13539 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13540 (insert (format "%-12s" (concat kwd ":"))
13541 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13542 (or end "")))
13544 (defun org-fast-tag-show-exit (flag)
13545 (save-excursion
13546 (org-goto-line 3)
13548 (replace-match ""))
13549 (when flag
13550 (end-of-line 1)
13551 (org-move-to-column (- (window-width) 19) t)
13552 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13554 (defun org-set-current-tags-overlay (current prefix)
13555 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13556 (if (featurep 'xemacs)
13557 (org-overlay-display org-tags-overlay (concat prefix s)
13558 'secondary-selection)
13559 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13560 (org-overlay-display org-tags-overlay (concat prefix s)))))
13562 (defvar org-last-tag-selection-key nil)
13563 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13564 "Fast tag selection with single keys.
13565 CURRENT is the current list of tags in the headline, INHERITED is the
13566 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13567 possibly with grouping information. TODO-TABLE is a similar table with
13568 TODO keywords, should these have keys assigned to them.
13569 If the keys are nil, a-z are automatically assigned.
13570 Returns the new tags string, or nil to not change the current settings."
13571 (let* ((fulltable (append table todo-table))
13572 (maxlen (apply 'max (mapcar
13573 (lambda (x)
13574 (if (stringp (car x)) (string-width (car x)) 0))
13575 fulltable)))
13576 (buf (current-buffer))
13577 (expert (eq org-fast-tag-selection-single-key 'expert))
13578 (buffer-tags nil)
13579 (fwidth (+ maxlen 3 1 3))
13580 (ncol (/ (- (window-width) 4) fwidth))
13581 (i-face 'org-done)
13582 (c-face 'org-todo)
13583 tg cnt e c char c1 c2 ntable tbl rtn
13584 ov-start ov-end ov-prefix
13585 (exit-after-next org-fast-tag-selection-single-key)
13586 (done-keywords org-done-keywords)
13587 groups ingroup)
13588 (save-excursion
13589 (beginning-of-line 1)
13590 (if (looking-at
13592 (setq ov-start (match-beginning 1)
13593 ov-end (match-end 1)
13594 ov-prefix "")
13595 (setq ov-start (1- (point-at-eol))
13596 ov-end (1+ ov-start))
13598 (setq ov-prefix
13599 (concat
13600 (buffer-substring (1- (point)) (point))
13601 (if (> (current-column) org-tags-column)
13602 " "
13603 (make-string (- org-tags-column (current-column)) ?\ ))))))
13604 (move-overlay org-tags-overlay ov-start ov-end)
13605 (save-window-excursion
13606 (if expert
13607 (set-buffer (get-buffer-create " *Org tags*"))
13608 (delete-other-windows)
13609 (split-window-vertically)
13610 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13611 (erase-buffer)
13612 (org-set-local 'org-done-keywords done-keywords)
13615 (org-fast-tag-show-exit exit-after-next)
13616 (org-set-current-tags-overlay current ov-prefix)
13617 (setq tbl fulltable char ?a cnt 0)
13618 (while (setq e (pop tbl))
13619 (cond
13620 ((equal (car e) :startgroup)
13621 (push '() groups) (setq ingroup t)
13622 (when (not (= cnt 0))
13623 (setq cnt 0)
13625 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13626 ((equal (car e) :endgroup)
13627 (setq ingroup nil cnt 0)
13629 ((equal e '(:newline))
13630 (when (not (= cnt 0))
13631 (setq cnt 0)
13633 (setq e (car tbl))
13634 (while (equal (car tbl) '(:newline))
13636 (setq tbl (cdr tbl)))))
13637 (t
13638 (setq tg (copy-sequence (car e)) c2 nil)
13639 (if (cdr e)
13640 (setq c (cdr e))
13641 ;; automatically assign a character.
13642 (setq c1 (string-to-char
13643 (downcase (substring
13644 tg (if (= (string-to-char tg) ?@) 1 0)))))
13645 (if (or (rassoc c1 ntable) (rassoc c1 table))
13646 (while (or (rassoc char ntable) (rassoc char table))
13647 (setq char (1+ char)))
13648 (setq c2 c1))
13649 (setq c (or c2 char)))
13650 (if ingroup (push tg (car groups)))
13651 (setq tg (org-add-props tg nil 'face
13652 (cond
13653 ((not (assoc tg table))
13654 (org-get-todo-face tg))
13655 ((member tg current) c-face)
13656 ((member tg inherited) i-face)
13657 (t nil))))
13658 (if (and (= cnt 0) (not ingroup)) (insert " "))
13659 (insert "[" c "] " tg (make-string
13660 (- fwidth 4 (length tg)) ?\ ))
13661 (push (cons tg c) ntable)
13662 (when (= (setq cnt (1+ cnt)) ncol)
13664 (if ingroup (insert " "))
13665 (setq cnt 0)))))
13666 (setq ntable (nreverse ntable))
13668 (goto-char (point-min))
13669 (if (not expert) (org-fit-window-to-buffer))
13670 (setq rtn
13671 (catch 'exit
13672 (while t
13673 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13674 (if (not groups) "no " "")
13675 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13676 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13677 (setq org-last-tag-selection-key c)
13678 (cond
13680 ((= c ?!)
13681 (setq groups (not groups))
13682 (goto-char (point-min))
13683 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13684 ((= c ?\C-c)
13685 (if (not expert)
13686 (org-fast-tag-show-exit
13687 (setq exit-after-next (not exit-after-next)))
13688 (setq expert nil)
13689 (delete-other-windows)
13690 (set-window-buffer (split-window-vertically) " *Org tags*")
13691 (org-switch-to-buffer-other-window " *Org tags*")
13692 (org-fit-window-to-buffer)))
13693 ((or (= c ?\C-g)
13694 (and (= c ?q) (not (rassoc c ntable))))
13695 (org-detach-overlay org-tags-overlay)
13696 (setq quit-flag t))
13697 ((= c ?\ )
13698 (setq current nil)
13699 (if exit-after-next (setq exit-after-next 'now)))
13701 (condition-case nil
13702 (setq tg (org-icompleting-read
13703 "Tag: "
13704 (or buffer-tags
13705 (with-current-buffer buf
13706 (org-get-buffer-tags)))))
13707 (quit (setq tg "")))
13709 (add-to-list 'buffer-tags (list tg))
13710 (if (member tg current)
13711 (setq current (delete tg current))
13712 (push tg current)))
13713 (if exit-after-next (setq exit-after-next 'now)))
13714 ((setq e (rassoc c todo-table) tg (car e))
13715 (with-current-buffer buf
13716 (save-excursion (org-todo tg)))
13717 (if exit-after-next (setq exit-after-next 'now)))
13718 ((setq e (rassoc c ntable) tg (car e))
13719 (if (member tg current)
13720 (setq current (delete tg current))
13721 (loop for g in groups do
13722 (if (member tg g)
13723 (mapc (lambda (x)
13724 (setq current (delete x current)))
13725 g)))
13726 (push tg current))
13727 (if exit-after-next (setq exit-after-next 'now))))
13729 ;; Create a sorted list
13730 (setq current
13731 (sort current
13732 (lambda (a b)
13733 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13734 (if (eq exit-after-next 'now) (throw 'exit t))
13735 (goto-char (point-min))
13736 (beginning-of-line 2)
13737 (delete-region (point) (point-at-eol))
13738 (org-fast-tag-insert "Current" current c-face)
13739 (org-set-current-tags-overlay current ov-prefix)
13740 (while (re-search-forward
13742 (setq tg (match-string 1))
13743 (add-text-properties
13744 (match-beginning 1) (match-end 1)
13745 (list 'face
13746 (cond
13747 ((member tg current) c-face)
13748 ((member tg inherited) i-face)
13749 (t (get-text-property (match-beginning 1) 'face))))))
13750 (goto-char (point-min)))))
13751 (org-detach-overlay org-tags-overlay)
13752 (if rtn
13753 (mapconcat 'identity current ":")
13754 nil))))
13756 (defun org-get-tags-string ()
13757 "Get the TAGS string in the current headline."
13758 (unless (org-at-heading-p t)
13759 (error "Not on a heading"))
13760 (save-excursion
13761 (beginning-of-line 1)
13763 (org-match-string-no-properties 1)
13764 "")))
13766 (defun org-get-tags ()
13767 "Get the list of tags specified in the current headline."
13768 (org-split-string (org-get-tags-string) ":"))
13770 (defun org-get-buffer-tags ()
13771 "Get a table of all tags used in the buffer, for completion."
13772 (let (tags)
13773 (save-excursion
13774 (goto-char (point-min))
13775 (while (re-search-forward
13777 (when (equal (char-after (point-at-bol 0)) ?*)
13778 (mapc (lambda (x) (add-to-list 'tags x))
13779 (org-split-string (org-match-string-no-properties 1) ":")))))
13780 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13781 (mapcar 'list tags)))
13783 ;;;; The mapping API
13785 ;;;###autoload
13786 (defun org-map-entries (func &optional match scope &rest skip)
13787 "Call FUNC at each headline selected by MATCH in SCOPE.
13789 FUNC is a function or a lisp form. The function will be called without
13790 arguments, with the cursor positioned at the beginning of the headline.
13791 The return values of all calls to the function will be collected and
13792 returned as a list.
13794 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13795 does not need to preserve point. After evaluation, the cursor will be
13796 moved to the end of the line (presumably of the headline of the
13797 processed entry) and search continues from there. Under some
13798 circumstances, this may not produce the wanted results. For example,
13799 if you have removed (e.g. archived) the current (sub)tree it could
13800 mean that the next entry will be skipped entirely. In such cases, you
13801 can specify the position from where search should continue by making
13802 FUNC set the variable `org-map-continue-from' to the desired buffer
13803 position.
13805 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13806 Only headlines that are matched by this query will be considered during
13807 the iteration. When MATCH is nil or t, all headlines will be
13808 visited by the iteration.
13810 SCOPE determines the scope of this command. It can be any of:
13812 nil The current buffer, respecting the restriction if any
13813 tree The subtree started with the entry at point
13814 region The entries within the active region, if any
13815 region-start-level
13816 The entries within the active region, but only those at
13817 the same level than the first one.
13818 file The current buffer, without restriction
13819 file-with-archives
13820 The current buffer, and any archives associated with it
13821 agenda All agenda files
13822 agenda-with-archives
13823 All agenda files with any archive files associated with them
13824 \(file1 file2 ...)
13825 If this is a list, all files in the list will be scanned
13827 The remaining args are treated as settings for the skipping facilities of
13828 the scanner. The following items can be given here:
13830 archive skip trees with the archive tag.
13831 comment skip trees with the COMMENT keyword
13832 function or Emacs Lisp form:
13833 will be used as value for `org-agenda-skip-function', so whenever
13834 the function returns t, FUNC will not be called for that
13835 entry and search will continue from the point where the
13836 function leaves it.
13838 If your function needs to retrieve the tags including inherited tags
13839 at the *current* entry, you can use the value of the variable
13840 `org-scanner-tags' which will be much faster than getting the value
13841 with `org-get-tags-at'. If your function gets properties with
13842 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13843 to t around the call to `org-entry-properties' to get the same speedup.
13844 Note that if your function moves around to retrieve tags and properties at
13845 a *different* entry, you cannot use these techniques."
13846 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13847 (not (org-region-active-p)))
13848 (let* ((org-agenda-archives-mode nil) ; just to make sure
13849 (org-agenda-skip-archived-trees (memq 'archive skip))
13850 (org-agenda-skip-comment-trees (memq 'comment skip))
13851 (org-agenda-skip-function
13852 (car (org-delete-all '(comment archive) skip)))
13853 (org-tags-match-list-sublevels t)
13854 (start-level (eq scope 'region-start-level))
13855 matcher file res
13856 org-todo-keywords-for-agenda
13857 org-done-keywords-for-agenda
13858 org-todo-keyword-alist-for-agenda
13859 org-drawers-for-agenda
13860 org-tag-alist-for-agenda)
13862 (cond
13863 ((eq match t) (setq matcher t))
13864 ((eq match nil) (setq matcher t))
13865 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13867 (save-excursion
13868 (save-restriction
13869 (cond ((eq scope 'tree)
13870 (org-back-to-heading t)
13871 (org-narrow-to-subtree)
13872 (setq scope nil))
13873 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13874 (org-region-active-p))
13875 ;; If needed, set start-level to a string like "2"
13876 (when start-level
13877 (save-excursion
13878 (goto-char (region-beginning))
13879 (unless (org-at-heading-p) (outline-next-heading))
13880 (setq start-level (org-current-level))))
13881 (narrow-to-region (region-beginning)
13882 (save-excursion
13883 (goto-char (region-end))
13884 (unless (and (bolp) (org-at-heading-p))
13885 (outline-next-heading))
13886 (point)))
13887 (setq scope nil)))
13889 (if (not scope)
13890 (progn
13891 (org-prepare-agenda-buffers
13892 (list (buffer-file-name (current-buffer))))
13893 (setq res (org-scan-tags func matcher nil start-level)))
13894 ;; Get the right scope
13895 (cond
13896 ((and scope (listp scope) (symbolp (car scope)))
13897 (setq scope (eval scope)))
13898 ((eq scope 'agenda)
13899 (setq scope (org-agenda-files t)))
13900 ((eq scope 'agenda-with-archives)
13901 (setq scope (org-agenda-files t))
13902 (setq scope (org-add-archive-files scope)))
13903 ((eq scope 'file)
13904 (setq scope (list (buffer-file-name))))
13905 ((eq scope 'file-with-archives)
13906 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13907 (org-prepare-agenda-buffers scope)
13908 (while (setq file (pop scope))
13909 (with-current-buffer (org-find-base-buffer-visiting file)
13910 (save-excursion
13911 (save-restriction
13912 (widen)
13913 (goto-char (point-min))
13914 (setq res (append res (org-scan-tags func matcher))))))))))
13915 res)))
13917 ;;;; Properties
13919 ;;; Setting and retrieving properties
13921 (defconst org-special-properties
13922 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13923 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13924 "The special properties valid in Org-mode.
13926 These are properties that are not defined in the property drawer,
13927 but in some other way.")
13929 (defconst org-default-properties
13930 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13931 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13932 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13933 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13934 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13935 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13936 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13937 "Some properties that are used by Org-mode for various purposes.
13938 Being in this list makes sure that they are offered for completion.")
13941 "Regular expression matching the first line of a property drawer.")
13944 "Regular expression matching the last line of a property drawer.")
13947 "Regular expression matching the first line of a property drawer.")
13950 "Regular expression matching the first line of a property drawer.")
13952 (defconst org-property-drawer-re
13955 "Matches an entire property drawer.")
13957 (defconst org-clock-drawer-re
13960 "Matches an entire clock drawer.")
13962 (defsubst org-re-property (property)
13963 "Return a regexp matching PROPERTY.
13964 Match group 1 will be set to the value "
13967 (defun org-property-action ()
13968 "Do an action on properties."
13969 (interactive)
13970 (let (c)
13971 (org-at-property-p)
13972 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13973 (setq c (read-char-exclusive))
13974 (cond
13975 ((equal c ?s)
13976 (call-interactively 'org-set-property))
13977 ((equal c ?d)
13978 (call-interactively 'org-delete-property))
13979 ((equal c ?D)
13980 (call-interactively 'org-delete-property-globally))
13981 ((equal c ?c)
13982 (call-interactively 'org-compute-property-at-point))
13983 (t (error "No such property action %c" c)))))
13985 (defun org-set-effort (&optional value)
13986 "Set the effort property of the current entry.
13987 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13988 allowed value."
13989 (interactive "P")
13990 (if (equal value 0) (setq value 10))
13991 (let* ((completion-ignore-case t)
13992 (prop org-effort-property)
13993 (cur (org-entry-get nil prop))
13994 (allowed (org-property-get-allowed-values nil prop 'table))
13995 (existing (mapcar 'list (org-property-values prop)))
13996 rpl
13997 (val (cond
13998 ((stringp value) value)
13999 ((and allowed (integerp value))
14000 (or (car (nth (1- value) allowed))
14001 (car (org-last allowed))))
14002 (allowed
14003 (message "Select 1-9,0, [RET%s]: %s"
14004 (if cur (concat "=" cur) "")
14005 (mapconcat 'car allowed " "))
14006 (setq rpl (read-char-exclusive))
14008 cur
14009 (setq rpl (- rpl ?0))
14010 (if (equal rpl 0) (setq rpl 10))
14011 (if (and (> rpl 0) (<= rpl (length allowed)))
14012 (car (nth (1- rpl) allowed))
14013 (org-completing-read "Effort: " allowed nil))))
14014 (t
14015 (let (org-completion-use-ido org-completion-use-iswitchb)
14016 (org-completing-read
14018 (concat "[" cur "]") "")
14019 ": ")
14020 existing nil nil "" nil cur))))))
14021 (unless (equal (org-entry-get nil prop) val)
14022 (org-entry-put nil prop val))
14023 (message "%s is now %s" prop val)))
14025 (defun org-at-property-p ()
14026 "Is cursor inside a property drawer?"
14027 (save-excursion
14028 (beginning-of-line 1)
14030 (save-match-data ;; Used by calling procedures
14031 (let ((p (point))
14032 (range (unless (org-before-first-heading-p)
14033 (org-get-property-block))))
14034 (and range (<= (car range) p) (< p (cdr range))))))))
14036 (defun org-get-property-block (&optional beg end force)
14037 "Return the (beg . end) range of the body of the property drawer.
14038 BEG and END can be beginning and end of subtree, if not given
14039 they will be found.
14040 If the drawer does not exist and FORCE is non-nil, create the drawer."
14041 (catch 'exit
14042 (save-excursion
14043 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14044 (end (or end (progn (outline-next-heading) (point)))))
14045 (goto-char beg)
14046 (if (re-search-forward org-property-start-re end t)
14047 (setq beg (1+ (match-end 0)))
14048 (if force
14049 (save-excursion
14050 (org-insert-property-drawer)
14051 (setq end (progn (outline-next-heading) (point))))
14052 (throw 'exit nil))
14053 (goto-char beg)
14054 (if (re-search-forward org-property-start-re end t)
14055 (setq beg (1+ (match-end 0)))))
14056 (if (re-search-forward org-property-end-re end t)
14057 (setq end (match-beginning 0))
14058 (or force (throw 'exit nil))
14059 (goto-char beg)
14060 (setq end beg)
14061 (org-indent-line-function)
14063 (cons beg end)))))
14065 (defun org-entry-properties (&optional pom which specific)
14066 "Get all properties of the entry at point-or-marker POM.
14067 This includes the TODO keyword, the tags, time strings for deadline,
14068 scheduled, and clocking, and any additional properties defined in the
14069 entry. The return value is an alist, keys may occur multiple times
14070 if the property key was used several times.
14071 POM may also be nil, in which case the current entry is used.
14072 If WHICH is nil or `all', get all properties. If WHICH is
14073 `special' or `standard', only get that subclass. If WHICH
14074 is a string only get exactly this property. SPECIFIC can be a string, the
14075 specific property we are interested in. Specifying it can speed
14076 things up because then unnecessary parsing is avoided."
14077 (setq which (or which 'all))
14078 (org-with-point-at pom
14079 (let ((clockstr (substring org-clock-string 0 -1))
14080 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14081 (case-fold-search nil)
14082 beg end range props sum-props key key1 value string clocksum)
14083 (save-excursion
14084 (when (condition-case nil
14085 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14086 (error nil))
14087 (setq beg (point))
14088 (setq sum-props (get-text-property (point) 'org-summaries))
14089 (setq clocksum (get-text-property (point) :org-clock-minutes))
14090 (outline-next-heading)
14091 (setq end (point))
14092 (when (memq which '(all special))
14093 ;; Get the special properties, like TODO and tags
14094 (goto-char beg)
14095 (when (and (or (not specific) (string= specific "TODO"))
14096 (looking-at org-todo-line-regexp) (match-end 2))
14097 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14098 (when (and (or (not specific) (string= specific "PRIORITY"))
14099 (looking-at org-priority-regexp))
14100 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14101 (when (or (not specific) (string= specific "FILE"))
14102 (push (cons "FILE" buffer-file-name) props))
14103 (when (and (or (not specific) (string= specific "TAGS"))
14104 (setq value (org-get-tags-string))
14106 (push (cons "TAGS" value) props))
14107 (when (and (or (not specific) (string= specific "ALLTAGS"))
14108 (setq value (org-get-tags-at)))
14109 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14110 ":"))
14111 props))
14112 (when (or (not specific) (string= specific "BLOCKED"))
14113 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14114 (when (or (not specific)
14115 (member specific
14116 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14117 "TIMESTAMP" "TIMESTAMP_IA")))
14118 (catch 'match
14119 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14120 (setq key (if (match-end 1)
14121 (substring (org-match-string-no-properties 1)
14122 0 -1))
14123 string (if (equal key clockstr)
14124 (org-no-properties
14125 (org-trim
14126 (buffer-substring
14127 (match-beginning 3) (goto-char
14128 (point-at-eol)))))
14129 (substring (org-match-string-no-properties 3)
14130 1 -1)))
14131 ;; Get the correct property name from the key. This is
14132 ;; necessary if the user has configured time keywords.
14133 (setq key1 (concat key ":"))
14134 (cond
14135 ((not key)
14136 (setq key
14137 (if (= (char-after (match-beginning 3)) ?\[)
14138 "TIMESTAMP_IA" "TIMESTAMP")))
14139 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14140 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14141 ((equal key1 org-closed-string) (setq key "CLOSED"))
14142 ((equal key1 org-clock-string) (setq key "CLOCK")))
14143 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14144 (progn
14145 (push (cons key string) props)
14146 ;; no need to search further if match is found
14147 (throw 'match t))
14148 (when (or (equal key "CLOCK") (not (assoc key props)))
14149 (push (cons key string) props))))))
14150 )
14152 (when (memq which '(all standard))
14153 ;; Get the standard properties, like :PROP: ...
14154 (setq range (org-get-property-block beg end))
14155 (when range
14156 (goto-char (car range))
14157 (while (re-search-forward
14159 (cdr range) t)
14160 (setq key (org-match-string-no-properties 1)
14161 value (org-trim (or (org-match-string-no-properties 2) "")))
14162 (unless (member key excluded)
14163 (push (cons key (or value "")) props)))))
14164 (if clocksum
14165 (push (cons "CLOCKSUM"
14166 (org-columns-number-to-string (/ (float clocksum) 60.)
14167 'add_times))
14168 props))
14169 (unless (assoc "CATEGORY" props)
14170 (push (cons "CATEGORY" (org-get-category)) props))
14171 (append sum-props (nreverse props)))))))
14173 (defun org-entry-get (pom property &optional inherit literal-nil)
14174 "Get value of PROPERTY for entry at point-or-marker POM.
14175 If INHERIT is non-nil and the entry does not have the property,
14176 then also check higher levels of the hierarchy.
14177 If INHERIT is the symbol `selective', use inheritance only if the setting
14178 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14179 If the property is present but empty, the return value is the empty string.
14180 If the property is not present at all, nil is returned.
14183 do not interpret it as the list atom nil. This is used for inheritance
14185 (org-with-point-at pom
14186 (if (and inherit (if (eq inherit 'selective)
14187 (org-property-inherit-p property)
14188 t))
14189 (org-entry-get-with-inheritance property literal-nil)
14190 (if (member property org-special-properties)
14191 ;; We need a special property. Use `org-entry-properties' to
14192 ;; retrieve it, but specify the wanted property
14193 (cdr (assoc property (org-entry-properties nil 'special property)))
14194 (let ((range (unless (org-before-first-heading-p)
14195 (org-get-property-block)))
14196 (props (list (or (assoc property org-file-properties)
14197 (assoc property org-global-properties)
14198 (assoc property org-global-properties-fixed))))
14199 val)
14200 (flet ((ap (key)
14201 (when (re-search-forward
14202 (org-re-property key) (cdr range) t)
14203 (setq props
14204 (org-update-property-plist
14205 key
14206 (if (match-end 1)
14207 (org-match-string-no-properties 1) "")
14208 props)))))
14209 (when (and range (goto-char (car range)))
14210 (ap property)
14211 (goto-char (car range))
14212 (while (ap (concat property "+")))
14213 (setq val (cdr (assoc property props)))
14214 (when val (if literal-nil val (org-not-nil val))))))))))
14216 (defun org-property-or-variable-value (var &optional inherit)
14217 "Check if there is a property fixing the value of VAR.
14218 If yes, return this value. If not, return the current value of the variable."
14219 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14221 (read prop)
14222 (symbol-value var))))
14224 (defun org-entry-delete (pom property)
14225 "Delete the property PROPERTY from entry at point-or-marker POM."
14226 (org-with-point-at pom
14227 (if (member property org-special-properties)
14228 nil ; cannot delete these properties.
14229 (let ((range (org-get-property-block)))
14230 (if (and range
14231 (goto-char (car range))
14232 (re-search-forward
14233 (org-re-property property)
14234 (cdr range) t))
14235 (progn
14236 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14237 t)
14238 nil)))))
14240 ;; Multi-values properties are properties that contain multiple values
14241 ;; These values are assumed to be single words, separated by whitespace.
14242 (defun org-entry-add-to-multivalued-property (pom property value)
14243 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14244 (let* ((old (org-entry-get pom property))
14246 (setq value (org-entry-protect-space value))
14247 (unless (member value values)
14248 (setq values (cons value values))
14249 (org-entry-put pom property
14250 (mapconcat 'identity values " ")))))
14252 (defun org-entry-remove-from-multivalued-property (pom property value)
14253 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14254 (let* ((old (org-entry-get pom property))
14256 (setq value (org-entry-protect-space value))
14257 (when (member value values)
14258 (setq values (delete value values))
14259 (org-entry-put pom property
14260 (mapconcat 'identity values " ")))))
14262 (defun org-entry-member-in-multivalued-property (pom property value)
14263 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14264 (let* ((old (org-entry-get pom property))
14266 (setq value (org-entry-protect-space value))
14267 (member value values)))
14269 (defun org-entry-get-multivalued-property (pom property)
14270 "Return a list of values in a multivalued property."
14271 (let* ((value (org-entry-get pom property))
14273 (mapcar 'org-entry-restore-space values)))
14275 (defun org-entry-put-multivalued-property (pom property &rest values)
14276 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14277 VALUES should be a list of strings. Spaces will be protected."
14278 (org-entry-put pom property
14279 (mapconcat 'org-entry-protect-space values " "))
14280 (let* ((value (org-entry-get pom property))
14282 (mapcar 'org-entry-restore-space values)))
14284 (defun org-entry-protect-space (s)
14285 "Protect spaces and newline in string S."
14286 (while (string-match " " s)
14287 (setq s (replace-match "%20" t t s)))
14289 (setq s (replace-match "%0A" t t s)))
14290 s)
14292 (defun org-entry-restore-space (s)
14293 "Restore spaces and newline in string S."
14294 (while (string-match "%20" s)
14295 (setq s (replace-match " " t t s)))
14296 (while (string-match "%0A" s)
14298 s)
14300 (defvar org-entry-property-inherited-from (make-marker)
14301 "Marker pointing to the entry from where a property was inherited.
14302 Each call to `org-entry-get-with-inheritance' will set this marker to the
14303 location of the entry where the inheritance search matched. If there was
14304 no match, the marker will point nowhere.
14305 Note that also `org-entry-get' calls this function, if the INHERIT flag
14306 is set.")
14308 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14309 "Get entry property, and search higher levels if not present.
14310 The search will stop at the first ancestor which has the property defined.
14312 should be considered as undefined (this is the meaning of nil here).
14314 (move-marker org-entry-property-inherited-from nil)
14315 (let (tmp)
14316 (unless (org-before-first-heading-p)
14317 (save-excursion
14318 (save-restriction
14319 (widen)
14320 (catch 'ex
14321 (while t
14322 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14323 (org-back-to-heading t)
14324 (move-marker org-entry-property-inherited-from (point))
14325 (throw 'ex tmp))
14326 (or (org-up-heading-safe) (throw 'ex nil)))))))
14327 (setq tmp (or tmp
14328 (cdr (assoc property org-file-properties))
14329 (cdr (assoc property org-global-properties))
14330 (cdr (assoc property org-global-properties-fixed))))
14331 (if literal-nil tmp (org-not-nil tmp))))
14333 (defvar org-property-changed-functions nil
14334 "Hook called when the value of a property has changed.
14335 Each hook function should accept two arguments, the name of the property
14336 and the new value.")
14338 (defun org-entry-put (pom property value)
14339 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14340 (org-with-point-at pom
14341 (org-back-to-heading t)
14342 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14343 range)
14344 (cond
14345 ((equal property "TODO")
14347 (not (member value org-todo-keywords-1)))
14349 (if (or (not value)
14351 (setq value 'none))
14352 (org-todo value)
14353 (org-set-tags nil 'align))
14354 ((equal property "PRIORITY")
14356 (string-to-char value) ?\ ))
14357 (org-set-tags nil 'align))
14358 ((equal property "SCHEDULED")
14359 (if (re-search-forward org-scheduled-time-regexp end t)
14360 (cond
14361 ((eq value 'earlier) (org-timestamp-change -1 'day))
14362 ((eq value 'later) (org-timestamp-change 1 'day))
14363 (t (call-interactively 'org-schedule)))
14364 (call-interactively 'org-schedule)))
14365 ((equal property "DEADLINE")
14366 (if (re-search-forward org-deadline-time-regexp end t)
14367 (cond
14368 ((eq value 'earlier) (org-timestamp-change -1 'day))
14369 ((eq value 'later) (org-timestamp-change 1 'day))
14370 (t (call-interactively 'org-deadline)))
14371 (call-interactively 'org-deadline)))
14372 ((member property org-special-properties)
14373 (error "The %s property can not yet be set with `org-entry-put'"
14374 property))
14375 (t ; a non-special property
14376 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14377 (setq range (org-get-property-block beg end 'force))
14378 (goto-char (car range))
14379 (if (re-search-forward
14380 (org-re-property property) (cdr range) t)
14381 (progn
14382 (delete-region (match-beginning 0) (match-end 0))
14383 (goto-char (match-beginning 0)))
14384 (goto-char (cdr range))
14386 (backward-char 1)
14387 (org-indent-line-function))
14388 (insert ":" property ":")
14389 (and value (insert " " value))
14390 (org-indent-line-function)))))
14391 (run-hook-with-args 'org-property-changed-functions property value)))
14393 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14394 "Get all property keys in the current buffer.
14395 With INCLUDE-SPECIALS, also list the special properties that reflect things
14396 like tags and TODO state.
14397 With INCLUDE-DEFAULTS, also include properties that has special meaning
14398 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14399 and others.
14400 With INCLUDE-COLUMNS, also include property names given in COLUMN
14401 formats in the current buffer."
14402 (let (rtn range cfmt s p)
14403 (save-excursion
14404 (save-restriction
14405 (widen)
14406 (goto-char (point-min))
14407 (while (re-search-forward org-property-start-re nil t)
14408 (setq range (org-get-property-block))
14409 (goto-char (car range))
14410 (while (re-search-forward
14412 (cdr range) t)
14413 (add-to-list 'rtn (org-match-string-no-properties 1)))
14414 (outline-next-heading))))
14416 (when include-specials
14417 (setq rtn (append org-special-properties rtn)))
14419 (when include-defaults
14420 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14421 (add-to-list 'rtn org-effort-property))
14423 (when include-columns
14424 (save-excursion
14425 (save-restriction
14426 (widen)
14427 (goto-char (point-min))
14428 (while (re-search-forward
14430 nil t)
14431 (setq cfmt (match-string 2) s 0)
14433 cfmt s)
14434 (setq s (match-end 0)
14435 p (match-string 1 cfmt))
14436 (unless (or (equal p "ITEM")
14437 (member p org-special-properties))
14438 (add-to-list 'rtn (match-string 1 cfmt))))))))
14440 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14442 (defun org-property-values (key)
14443 "Return a list of all values of property KEY in the current buffer."
14444 (save-excursion
14445 (save-restriction
14446 (widen)
14447 (goto-char (point-min))
14448 (let ((re (org-re-property key))
14449 values)
14450 (while (re-search-forward re nil t)
14451 (add-to-list 'values (org-trim (match-string 1))))
14452 (delete "" values)))))
14454 (defun org-insert-property-drawer ()
14455 "Insert a property drawer into the current entry."
14456 (org-back-to-heading t)
14457 (looking-at org-outline-regexp)
14458 (let ((indent (if org-adapt-indentation
14459 (- (match-end 0) (match-beginning 0))
14460 0))
14461 (beg (point))
14463 end hiddenp)
14464 (outline-next-heading)
14465 (setq end (point))
14466 (goto-char beg)
14467 (while (re-search-forward re end t))
14468 (setq hiddenp (outline-invisible-p))
14469 (end-of-line 1)
14472 (if (member (match-string 1) '("CLOCK:" ":END:"))
14473 ;; just skip this line
14474 (beginning-of-line 2)
14475 ;; Drawer start, find the end
14477 (beginning-of-line 1)))
14478 (org-skip-over-state-notes)
14480 (if (eq (char-before) ?*) (forward-char 1))
14482 (beginning-of-line 0)
14483 (org-indent-to-column indent)
14484 (beginning-of-line 2)
14485 (org-indent-to-column indent)
14486 (beginning-of-line 0)
14487 (if hiddenp
14488 (save-excursion
14489 (org-back-to-heading t)
14490 (hide-entry))
14491 (org-flag-drawer t))))
14493 (defun org-insert-drawer (&optional arg drawer)
14494 "Insert a drawer at point.
14496 Optional argument DRAWER, when non-nil, is a string representing
14497 drawer's name. Otherwise, the user is prompted for a name.
14499 If a region is active, insert the drawer around that region
14500 instead.
14502 Point is left between drawer's boundaries."
14503 (interactive "P")
14504 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14505 "LOGBOOK"))
14506 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14507 ;; internally by Org. They are meant to be inserted
14508 ;; automatically.
14509 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14510 ;; Remove system drawers from list. Note: For some reason,
14511 ;; `org-completing-read' ignores the predicate while
14512 ;; `completing-read' handles it fine.
14513 (drawer (if arg "PROPERTIES"
14514 (or drawer
14515 (completing-read
14516 "Drawer: " org-drawers
14517 (lambda (d) (not (member d system-drawers))))))))
14518 (cond
14519 ;; With C-u, fall back on `org-insert-property-drawer'
14520 (arg (org-insert-property-drawer))
14521 ;; With an active region, insert a drawer at point.
14522 ((not (org-region-active-p))
14523 (progn
14526 (forward-line -2)))
14527 ;; Otherwise, insert the drawer at point
14528 (t
14529 (let ((rbeg (region-beginning))
14530 (rend (copy-marker (region-end))))
14531 (unwind-protect
14532 (progn
14533 (goto-char rbeg)
14534 (beginning-of-line)
14535 (when (save-excursion
14536 (re-search-forward org-outline-regexp-bol rend t))
14537 (error "Drawers cannot contain headlines"))
14538 ;; Position point at the beginning of the first
14539 ;; non-blank line in region. Insert drawer's opening
14540 ;; there, then indent it.
14541 (org-skip-whitespace)
14542 (beginning-of-line)
14544 (forward-line -1)
14545 (indent-for-tab-command)
14546 ;; Move point to the beginning of the first blank line
14547 ;; after the last non-blank line in region. Insert
14548 ;; drawer's closing, then indent it.
14549 (goto-char rend)
14552 (indent-for-tab-command)
14554 ;; Clear marker, whatever the outcome of insertion is.
14555 (set-marker rend nil)))))))
14557 (defvar org-property-set-functions-alist nil
14558 "Property set function alist.
14559 Each entry should have the following format:
14561 (PROPERTY . READ-FUNCTION)
14563 The read function will be called with the same argument as
14564 `org-completing-read'.")
14566 (defun org-set-property-function (property)
14567 "Get the function that should be used to set PROPERTY.
14568 This is computed according to `org-property-set-functions-alist'."
14569 (or (cdr (assoc property org-property-set-functions-alist))
14570 'org-completing-read))
14572 (defun org-read-property-value (property)
14573 "Read PROPERTY value from user."
14574 (let* ((completion-ignore-case t)
14575 (allowed (org-property-get-allowed-values nil property 'table))
14576 (cur (org-entry-get nil property))
14577 (prompt (concat property " value"
14579 (concat " [" cur "]") "") ": "))
14580 (set-function (org-set-property-function property))
14581 (val (if allowed
14582 (funcall set-function prompt allowed nil
14583 (not (get-text-property 0 'org-unrestricted
14584 (caar allowed))))
14585 (let (org-completion-use-ido org-completion-use-iswitchb)
14586 (funcall set-function prompt
14587 (mapcar 'list (org-property-values property))
14588 nil nil "" nil cur)))))
14589 (if (equal val "")
14590 cur
14591 val)))
14593 (defvar org-last-set-property nil)
14594 (defun org-read-property-name ()
14595 "Read a property name."
14596 (let* ((completion-ignore-case t)
14597 (keys (org-buffer-property-keys nil t t))
14598 (default-prop (or (save-excursion
14599 (save-match-data
14600 (beginning-of-line)
14602 (null (string= (match-string 1) "END"))
14603 (match-string 1))))
14604 org-last-set-property))
14605 (property (org-icompleting-read
14606 (concat "Property"
14607 (if default-prop (concat " [" default-prop "]") "")
14608 ": ")
14609 (mapcar 'list keys)
14610 nil nil nil nil
14611 default-prop
14612 )))
14613 (if (member property keys)
14614 property
14615 (or (cdr (assoc (downcase property)
14616 (mapcar (lambda (x) (cons (downcase x) x))
14617 keys)))
14618 property))))
14620 (defun org-set-property (property value)
14621 "In the current entry, set PROPERTY to VALUE.
14622 When called interactively, this will prompt for a property name, offering
14623 completion on existing and default properties. And then it will prompt
14624 for a value, offering completion either on allowed values (via an inherited
14625 xxx_ALL property) or on existing values in other instances of this property
14626 in the current file."
14627 (interactive (list nil nil))
14628 (let* ((property (or property (org-read-property-name)))
14629 (value (or value (org-read-property-value property)))
14630 (fn (assoc property org-properties-postprocess-alist)))
14631 (setq org-last-set-property property)
14632 ;; Possibly postprocess the inserted value:
14633 (when fn (setq value (funcall (cadr fn) value)))
14634 (unless (equal (org-entry-get nil property) value)
14635 (org-entry-put nil property value))))
14637 (defun org-delete-property (property)
14638 "In the current entry, delete PROPERTY."
14639 (interactive
14640 (let* ((completion-ignore-case t)
14641 (prop (org-icompleting-read "Property: "
14642 (org-entry-properties nil 'standard))))
14643 (list prop)))
14644 (message "Property %s %s" property
14645 (if (org-entry-delete nil property)
14646 "deleted"
14647 "was not present in the entry")))
14649 (defun org-delete-property-globally (property)
14650 "Remove PROPERTY globally, from all entries."
14651 (interactive
14652 (let* ((completion-ignore-case t)
14653 (prop (org-icompleting-read
14654 "Globally remove property: "
14655 (mapcar 'list (org-buffer-property-keys)))))
14656 (list prop)))
14657 (save-excursion
14658 (save-restriction
14659 (widen)
14660 (goto-char (point-min))
14661 (let ((cnt 0))
14662 (while (re-search-forward
14663 (org-re-property property)
14664 nil t)
14665 (setq cnt (1+ cnt))
14666 (replace-match ""))
14669 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14671 (defun org-compute-property-at-point ()
14672 "Compute the property at point.
14673 This looks for an enclosing column format, extracts the operator and
14674 then applies it to the property in the column format's scope."
14675 (interactive)
14676 (unless (org-at-property-p)
14677 (error "Not at a property"))
14678 (let ((prop (org-match-string-no-properties 2)))
14679 (org-columns-get-format-and-top-level)
14680 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14681 (error "No operator defined for property %s" prop))
14682 (org-columns-compute prop)))
14684 (defvar org-property-allowed-value-functions nil
14685 "Hook for functions supplying allowed values for a specific property.
14686 The functions must take a single argument, the name of the property, and
14688 the values, this means that these values are intended as defaults for
14689 completion, but that other values should be allowed too.
14690 The functions must return nil if they are not responsible for this
14691 property.")
14693 (defun org-property-get-allowed-values (pom property &optional table)
14694 "Get allowed values for the property PROPERTY.
14695 When TABLE is non-nil, return an alist that can directly be used for
14696 completion."
14697 (let (vals)
14698 (cond
14699 ((equal property "TODO")
14700 (setq vals (org-with-point-at pom
14701 (append org-todo-keywords-1 '("")))))
14702 ((equal property "PRIORITY")
14703 (let ((n org-lowest-priority))
14704 (while (>= n org-highest-priority)
14705 (push (char-to-string n) vals)
14706 (setq n (1- n)))))
14707 ((member property org-special-properties))
14708 ((setq vals (run-hook-with-args-until-success
14709 'org-property-allowed-value-functions property)))
14710 (t
14711 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14713 (setq vals (car (read-from-string (concat "(" vals ")"))))
14714 (setq vals (mapcar (lambda (x)
14715 (cond ((stringp x) x)
14716 ((numberp x) (number-to-string x))
14717 ((symbolp x) (symbol-name x))
14718 (t "???")))
14719 vals)))))
14720 (when (member ":ETC" vals)
14721 (setq vals (remove ":ETC" vals))
14722 (org-add-props (car vals) '(org-unrestricted t)))
14723 (if table (mapcar 'list vals) vals)))
14725 (defun org-property-previous-allowed-value (&optional previous)
14726 "Switch to the next allowed value for this property."
14727 (interactive)
14728 (org-property-next-allowed-value t))
14730 (defun org-property-next-allowed-value (&optional previous)
14731 "Switch to the next allowed value for this property."
14732 (interactive)
14733 (unless (org-at-property-p)
14734 (error "Not at a property"))
14735 (let* ((key (match-string 2))
14736 (value (match-string 3))
14737 (allowed (or (org-property-get-allowed-values (point) key)
14738 (and (member value '("[ ]" "[-]" "[X]"))
14739 '("[ ]" "[X]"))))
14740 nval)
14741 (unless allowed
14742 (error "Allowed values for this property have not been defined"))
14743 (if previous (setq allowed (reverse allowed)))
14744 (if (member value allowed)
14745 (setq nval (car (cdr (member value allowed)))))
14746 (setq nval (or nval (car allowed)))
14747 (if (equal nval value)
14748 (error "Only one allowed value for this property"))
14749 (org-at-property-p)
14750 (replace-match (concat " :" key ": " nval) t t)
14751 (org-indent-line-function)
14752 (beginning-of-line 1)
14754 (run-hook-with-args 'org-property-changed-functions key nval)))
14756 (defun org-find-olp (path &optional this-buffer)
14757 "Return a marker pointing to the entry at outline path OLP.
14758 If anything goes wrong, throw an error.
14759 You can wrap this call to catch the error like this:
14761 (condition-case msg
14762 (org-mobile-locate-entry (match-string 4))
14763 (error (nth 1 msg)))
14765 The return value will then be either a string with the error message,
14766 or a marker if everything is OK.
14768 If THIS-BUFFER is set, the outline path does not contain a file,
14769 only headings."
14770 (let* ((file (if this-buffer buffer-file-name (pop path)))
14771 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14772 (level 1)
14773 (lmin 1)
14774 (lmax 1)
14775 limit re end found pos heading cnt flevel)
14776 (unless buffer (error "File not found :%s" file))
14777 (with-current-buffer buffer
14778 (save-excursion
14779 (save-restriction
14780 (widen)
14781 (setq limit (point-max))
14782 (goto-char (point-min))
14783 (while (setq heading (pop path))
14784 (setq re (format org-complex-heading-regexp-format
14785 (regexp-quote heading)))
14786 (setq cnt 0 pos (point))
14787 (while (re-search-forward re end t)
14788 (setq level (- (match-end 1) (match-beginning 1)))
14789 (if (and (>= level lmin) (<= level lmax))
14790 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14791 (when (= cnt 0) (error "Heading not found on level %d: %s"
14792 lmax heading))
14793 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14794 lmax heading))
14795 (goto-char found)
14796 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14797 (setq end (save-excursion (org-end-of-subtree t t))))
14798 (when (org-at-heading-p)
14799 (move-marker (make-marker) (point))))))))
14801 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14802 "Find node HEADING in BUFFER.
14803 Return a marker to the heading if it was found, or nil if not.
14804 If POS-ONLY is set, return just the position instead of a marker.
14806 The heading text must match exact, but it may have a TODO keyword,
14807 a priority cookie and tags in the standard locations."
14808 (with-current-buffer (or buffer (current-buffer))
14809 (save-excursion
14810 (save-restriction
14811 (widen)
14812 (goto-char (point-min))
14813 (let (case-fold-search)
14814 (if (re-search-forward
14815 (format org-complex-heading-regexp-format
14816 (regexp-quote heading)) nil t)
14817 (if pos-only
14818 (match-beginning 0)
14819 (move-marker (make-marker) (match-beginning 0)))))))))
14821 (defun org-find-exact-heading-in-directory (heading &optional dir)
14822 "Find Org node headline HEADING in all .org files in directory DIR.
14823 When the target headline is found, return a marker to this location."
14824 (let ((files (directory-files (or dir default-directory)
14826 file visiting m buffer)
14827 (catch 'found
14828 (while (setq file (pop files))
14829 (message "trying %s" file)
14830 (setq visiting (org-find-base-buffer-visiting file))
14831 (setq buffer (or visiting (find-file-noselect file)))
14832 (setq m (org-find-exact-headline-in-buffer
14833 heading buffer))
14834 (when (and (not m) (not visiting)) (kill-buffer buffer))
14835 (and m (throw 'found m))))))
14837 (defun org-find-entry-with-id (ident)
14838 "Locate the entry that contains the ID property with exact value IDENT.
14839 IDENT can be a string, a symbol or a number, this function will search for
14840 the string representation of it.
14841 Return the position where this entry starts, or nil if there is no such entry."
14842 (interactive "sID: ")
14843 (let ((id (cond
14844 ((stringp ident) ident)
14845 ((symbol-name ident) (symbol-name ident))
14846 ((numberp ident) (number-to-string ident))
14847 (t (error "IDENT %s must be a string, symbol or number" ident))))
14848 (case-fold-search nil))
14849 (save-excursion
14850 (save-restriction
14851 (widen)
14852 (goto-char (point-min))
14853 (when (re-search-forward
14855 nil t)
14856 (org-back-to-heading t)
14857 (point))))))
14859 ;;;; Timestamps
14861 (defvar org-last-changed-timestamp nil)
14862 (defvar org-last-inserted-timestamp nil
14863 "The last time stamp inserted with `org-insert-time-stamp'.")
14864 (defvar org-time-was-given) ; dynamically scoped parameter
14865 (defvar org-end-time-was-given) ; dynamically scoped parameter
14866 (defvar org-ts-what) ; dynamically scoped parameter
14868 (defun org-time-stamp (arg &optional inactive)
14869 "Prompt for a date/time and insert a time stamp.
14870 If the user specifies a time like HH:MM, or if this command is called
14871 with a prefix argument, the time stamp will contain date and time.
14872 Otherwise, only the date will be included. All parts of a date not
14873 specified by the user will be filled in from the current date/time.
14874 So if you press just return without typing anything, the time stamp
14875 will represent the current date/time. If there is already a timestamp
14876 at the cursor, it will be modified."
14877 (interactive "P")
14878 (let* ((ts nil)
14879 (default-time
14880 ;; Default time is either today, or, when entering a range,
14881 ;; the range start.
14882 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14883 (save-excursion
14884 (re-search-backward
14886 (- (point) 20) t)))
14887 (apply 'encode-time (org-parse-time-string (match-string 1)))
14888 (current-time)))
14889 (default-input (and ts (org-get-compact-tod ts)))
14890 (repeater (save-excursion
14891 (save-match-data
14892 (beginning-of-line)
14893 (when (re-search-forward
14895 (save-excursion (progn (end-of-line) (point))) t)
14896 (match-string 0)))))
14897 org-time-was-given org-end-time-was-given time)
14898 (cond
14899 ((and (org-at-timestamp-p t)
14900 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14901 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14902 (insert "--")
14903 (setq time (let ((this-command this-command))
14904 (org-read-date arg 'totime nil nil
14905 default-time default-input inactive)))
14906 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14907 ((org-at-timestamp-p t)
14908 (setq time (let ((this-command this-command))
14909 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14910 (when (org-at-timestamp-p t) ; just to get the match data
14911 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14912 (replace-match "")
14913 (setq org-last-changed-timestamp
14914 (org-insert-time-stamp
14915 time (or org-time-was-given arg)
14916 inactive nil nil (list org-end-time-was-given)))
14917 (when repeater (goto-char (1- (point))) (insert " " repeater)
14918 (setq org-last-changed-timestamp
14919 (concat (substring org-last-inserted-timestamp 0 -1)
14920 " " repeater ">"))))
14921 (message "Timestamp updated"))
14922 (t
14923 (setq time (let ((this-command this-command))
14924 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14925 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14926 nil nil (list org-end-time-was-given))))))
14928 ;; FIXME: can we use this for something else, like computing time differences?
14929 (defun org-get-compact-tod (s)
14930 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14931 (let* ((t1 (match-string 1 s))
14932 (h1 (string-to-number (match-string 2 s)))
14933 (m1 (string-to-number (match-string 3 s)))
14934 (t2 (and (match-end 4) (match-string 5 s)))
14935 (h2 (and t2 (string-to-number (match-string 6 s))))
14936 (m2 (and t2 (string-to-number (match-string 7 s))))
14937 dh dm)
14938 (if (not t2)
14939 t1
14940 (setq dh (- h2 h1) dm (- m2 m1))
14941 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14942 (concat t1 "+" (number-to-string dh)
14943 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14945 (defun org-time-stamp-inactive (&optional arg)
14946 "Insert an inactive time stamp.
14947 An inactive time stamp is enclosed in square brackets instead of angle
14948 brackets. It is inactive in the sense that it does not trigger agenda entries,
14949 does not link to the calendar and cannot be changed with the S-cursor keys.
14950 So these are more for recording a certain time/date."
14951 (interactive "P")
14952 (org-time-stamp arg 'inactive))
14954 (defvar org-date-ovl (make-overlay 1 1))
14955 (overlay-put org-date-ovl 'face 'org-warning)
14956 (org-detach-overlay org-date-ovl)
14958 (defvar org-ans1) ; dynamically scoped parameter
14959 (defvar org-ans2) ; dynamically scoped parameter
14961 (defvar org-plain-time-of-day-regexp) ; defined below
14963 (defvar org-overriding-default-time nil) ; dynamically scoped
14964 (defvar org-read-date-overlay nil)
14965 (defvar org-dcst nil) ; dynamically scoped
14966 (defvar org-read-date-history nil)
14967 (defvar org-read-date-final-answer nil)
14968 (defvar org-read-date-analyze-futurep nil)
14969 (defvar org-read-date-analyze-forced-year nil)
14971 (defun org-read-date (&optional with-time to-time from-string prompt
14972 default-time default-input inactive)
14973 "Read a date, possibly a time, and make things smooth for the user.
14974 The prompt will suggest to enter an ISO date, but you can also enter anything
14975 which will at least partially be understood by `parse-time-string'.
14976 Unrecognized parts of the date will default to the current day, month, year,
14977 hour and minute. If this command is called to replace a timestamp at point,
14978 or to enter the second timestamp of a range, the default time is taken
14979 from the existing stamp. Furthermore, the command prefers the future,
14980 so if you are giving a date where the year is not given, and the day-month
14981 combination is already past in the current year, it will assume you
14982 mean next year. For details, see the manual. A few examples:
14984 3-2-5 --> 2003-02-05
14985 feb 15 --> currentyear-02-15
14986 2/15 --> currentyear-02-15
14987 sep 12 9 --> 2009-09-12
14988 12:45 --> today 12:45
14989 22 sept 0:34 --> currentyear-09-22 0:34
14990 12 --> currentyear-currentmonth-12
14991 Fri --> nearest Friday (today or later)
14992 etc.
14994 Furthermore you can specify a relative date by giving, as the *first* thing
14995 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14996 change in days weeks, months, years.
14997 With a single plus or minus, the date is relative to today. With a double
14998 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14999 +4d --> four days from today
15000 +4 --> same as above
15001 +2w --> two weeks from today
15002 ++5 --> five days from default date
15004 The function understands only English month and weekday abbreviations,
15005 but this can be configured with the variables `parse-time-months' and
15006 `parse-time-weekdays'.
15008 While prompting, a calendar is popped up - you can also select the
15009 date with the mouse (button 1). The calendar shows a period of three
15010 months. To scroll it to other months, use the keys `>' and `<'.
15011 If you don't like the calendar, turn it off with
15012 \(setq org-read-date-popup-calendar nil)
15014 With optional argument TO-TIME, the date will immediately be converted
15015 to an internal time.
15016 With an optional argument WITH-TIME, the prompt will suggest to also
15017 insert a time. Note that when WITH-TIME is not set, you can still
15018 enter a time, and this function will inform the calling routine about
15019 this change. The calling routine may then choose to change the format
15020 used to insert the time stamp into the buffer to include the time.
15021 With optional argument FROM-STRING, read from this string instead from
15022 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15023 the time/date that is used for everything that is not specified by the
15024 user."
15025 (require 'parse-time)
15026 (let* ((org-time-stamp-rounding-minutes
15027 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15028 (org-dcst org-display-custom-times)
15029 (ct (org-current-time))
15030 (def (or org-overriding-default-time default-time ct))
15031 (defdecode (decode-time def))
15032 (dummy (progn
15033 (when (< (nth 2 defdecode) org-extend-today-until)
15034 (setcar (nthcdr 2 defdecode) -1)
15035 (setcar (nthcdr 1 defdecode) 59)
15036 (setq def (apply 'encode-time defdecode)
15037 defdecode (decode-time def)))))
15038 (calendar-frame-setup nil)
15039 (calendar-setup nil)
15040 (calendar-move-hook nil)
15041 (calendar-view-diary-initially-flag nil)
15042 (calendar-view-holidays-initially-flag nil)
15043 (timestr (format-time-string
15044 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
15045 (prompt (concat (if prompt (concat prompt " ") "")
15046 (format "Date+time [%s]: " timestr)))
15047 ans (org-ans0 "") org-ans1 org-ans2 final)
15049 (cond
15050 (from-string (setq ans from-string))
15051 (org-read-date-popup-calendar
15052 (save-excursion
15053 (save-window-excursion
15054 (calendar)
15055 (unwind-protect
15056 (progn
15057 (calendar-forward-day (- (time-to-days def)
15058 (calendar-absolute-from-gregorian
15059 (calendar-current-date))))
15060 (org-eval-in-calendar nil t)
15061 (let* ((old-map (current-local-map))
15062 (map (copy-keymap calendar-mode-map))
15063 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15064 (org-defkey map (kbd "RET") 'org-calendar-select)
15065 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15066 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15067 (org-defkey minibuffer-local-map [(meta shift left)]
15068 (lambda () (interactive)
15069 (org-eval-in-calendar '(calendar-backward-month 1))))
15070 (org-defkey minibuffer-local-map [(meta shift right)]
15071 (lambda () (interactive)
15072 (org-eval-in-calendar '(calendar-forward-month 1))))
15073 (org-defkey minibuffer-local-map [(meta shift up)]
15074 (lambda () (interactive)
15075 (org-eval-in-calendar '(calendar-backward-year 1))))
15076 (org-defkey minibuffer-local-map [(meta shift down)]
15077 (lambda () (interactive)
15078 (org-eval-in-calendar '(calendar-forward-year 1))))
15079 (org-defkey minibuffer-local-map [?\e (shift left)]
15080 (lambda () (interactive)
15081 (org-eval-in-calendar '(calendar-backward-month 1))))
15082 (org-defkey minibuffer-local-map [?\e (shift right)]
15083 (lambda () (interactive)
15084 (org-eval-in-calendar '(calendar-forward-month 1))))
15085 (org-defkey minibuffer-local-map [?\e (shift up)]
15086 (lambda () (interactive)
15087 (org-eval-in-calendar '(calendar-backward-year 1))))
15088 (org-defkey minibuffer-local-map [?\e (shift down)]
15089 (lambda () (interactive)
15090 (org-eval-in-calendar '(calendar-forward-year 1))))
15091 (org-defkey minibuffer-local-map [(shift up)]
15092 (lambda () (interactive)
15093 (org-eval-in-calendar '(calendar-backward-week 1))))
15094 (org-defkey minibuffer-local-map [(shift down)]
15095 (lambda () (interactive)
15096 (org-eval-in-calendar '(calendar-forward-week 1))))
15097 (org-defkey minibuffer-local-map [(shift left)]
15098 (lambda () (interactive)
15099 (org-eval-in-calendar '(calendar-backward-day 1))))
15100 (org-defkey minibuffer-local-map [(shift right)]
15101 (lambda () (interactive)
15102 (org-eval-in-calendar '(calendar-forward-day 1))))
15103 (org-defkey minibuffer-local-map ">"
15104 (lambda () (interactive)
15105 (org-eval-in-calendar '(scroll-calendar-left 1))))
15106 (org-defkey minibuffer-local-map "<"
15107 (lambda () (interactive)
15108 (org-eval-in-calendar '(scroll-calendar-right 1))))
15109 (org-defkey minibuffer-local-map "\C-v"
15110 (lambda () (interactive)
15111 (org-eval-in-calendar
15112 '(calendar-scroll-left-three-months 1))))
15113 (org-defkey minibuffer-local-map "\M-v"
15114 (lambda () (interactive)
15115 (org-eval-in-calendar
15116 '(calendar-scroll-right-three-months 1))))
15117 (run-hooks 'org-read-date-minibuffer-setup-hook)
15118 (unwind-protect
15119 (progn
15120 (use-local-map map)
15121 (setq org-read-date-inactive inactive)
15122 (add-hook 'post-command-hook 'org-read-date-display)
15123 (setq org-ans0 (read-string prompt default-input
15124 'org-read-date-history nil))
15125 ;; org-ans0: from prompt
15126 ;; org-ans1: from mouse click
15127 ;; org-ans2: from calendar motion
15128 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15129 (remove-hook 'post-command-hook 'org-read-date-display)
15130 (use-local-map old-map)
15131 (when org-read-date-overlay
15132 (delete-overlay org-read-date-overlay)
15133 (setq org-read-date-overlay nil)))))
15134 (bury-buffer "*Calendar*")))))
15136 (t ; Naked prompt only
15137 (unwind-protect
15138 (setq ans (read-string prompt default-input
15139 'org-read-date-history timestr))
15140 (when org-read-date-overlay
15141 (delete-overlay org-read-date-overlay)
15142 (setq org-read-date-overlay nil)))))
15144 (setq final (org-read-date-analyze ans def defdecode))
15146 (when org-read-date-analyze-forced-year
15147 (message "Year was forced into %s"
15148 (if org-read-date-force-compatible-dates
15149 "compatible range (1970-2037)"
15150 "range representable on this machine"))
15151 (ding))
15153 ;; One round trip to get rid of 34th of August and stuff like that....
15154 (setq final (decode-time (apply 'encode-time final)))
15156 (setq org-read-date-final-answer ans)
15158 (if to-time
15159 (apply 'encode-time final)
15160 (if (and (boundp 'org-time-was-given) org-time-was-given)
15161 (format "%04d-%02d-%02d %02d:%02d"
15162 (nth 5 final) (nth 4 final) (nth 3 final)
15163 (nth 2 final) (nth 1 final))
15164 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15166 (defvar def)
15167 (defvar defdecode)
15168 (defvar with-time)
15169 (defvar org-read-date-inactive)
15170 (defun org-read-date-display ()
15171 "Display the current date prompt interpretation in the minibuffer."
15172 (when org-read-date-display-live
15173 (when org-read-date-overlay
15174 (delete-overlay org-read-date-overlay))
15175 (let ((p (point)))
15176 (end-of-line 1)
15177 (while (not (equal (buffer-substring
15178 (max (point-min) (- (point) 4)) (point))
15179 " "))
15180 (insert " "))
15181 (goto-char p))
15182 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15183 " " (or org-ans1 org-ans2)))
15184 (org-end-time-was-given nil)
15185 (f (org-read-date-analyze ans def defdecode))
15186 (fmts (if org-dcst
15187 org-time-stamp-custom-formats
15188 org-time-stamp-formats))
15189 (fmt (if (or with-time
15190 (and (boundp 'org-time-was-given) org-time-was-given))
15191 (cdr fmts)
15192 (car fmts)))
15193 (txt (format-time-string fmt (apply 'encode-time f)))
15194 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15195 (txt (concat "=> " txt)))
15196 (when (and org-end-time-was-given
15197 (string-match org-plain-time-of-day-regexp txt))
15198 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15199 org-end-time-was-given
15200 (substring txt (match-end 0)))))
15201 (when org-read-date-analyze-futurep
15202 (setq txt (concat txt " (=>F)")))
15203 (setq org-read-date-overlay
15204 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15205 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15207 (defun org-read-date-analyze (ans def defdecode)
15208 "Analyze the combined answer of the date prompt."
15209 ;; FIXME: cleanup and comment
15210 (let ((nowdecode (decode-time (current-time)))
15211 delta deltan deltaw deltadef year month day
15212 hour minute second wday pm h2 m2 tl wday1
15213 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15214 (setq org-read-date-analyze-futurep nil
15215 org-read-date-analyze-forced-year nil)
15217 (setq ans "+0"))
15219 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15220 (setq ans (replace-match "" t t ans)
15221 deltan (car delta)
15222 deltaw (nth 1 delta)
15223 deltadef (nth 2 delta)))
15225 ;; Check if there is an iso week date in there
15226 ;; If yes, store the info and postpone interpreting it until the rest
15227 ;; of the parsing is done
15228 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15229 (setq iso-year (if (match-end 1)
15230 (org-small-year-to-year
15231 (string-to-number (match-string 1 ans))))
15232 iso-weekday (if (match-end 3)
15233 (string-to-number (match-string 3 ans)))
15234 iso-week (string-to-number (match-string 2 ans)))
15235 (setq ans (replace-match "" t t ans)))
15237 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15238 (when (string-match
15240 (setq year (if (match-end 2)
15241 (string-to-number (match-string 2 ans))
15242 (progn (setq kill-year t)
15243 (string-to-number (format-time-string "%Y"))))
15244 month (string-to-number (match-string 3 ans))
15245 day (string-to-number (match-string 4 ans)))
15246 (if (< year 100) (setq year (+ 2000 year)))
15248 t nil ans)))
15250 ;; Help matching dotted european dates
15251 (when (string-match
15252 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15253 (setq year (if (match-end 3)
15254 (string-to-number (match-string 3 ans))
15255 (progn (setq kill-year t)
15256 (string-to-number (format-time-string "%Y"))))
15257 day (string-to-number (match-string 1 ans))
15258 month (string-to-number (match-string 2 ans))
15260 t nil ans)))
15262 ;; Help matching american dates, like 5/30 or 5/30/7
15263 (when (string-match
15264 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15265 (setq year (if (match-end 4)
15266 (string-to-number (match-string 4 ans))
15267 (progn (setq kill-year t)
15268 (string-to-number (format-time-string "%Y"))))
15269 month (string-to-number (match-string 1 ans))
15270 day (string-to-number (match-string 2 ans)))
15271 (if (< year 100) (setq year (+ 2000 year)))
15273 t nil ans)))
15274 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15275 ;; If there is a time with am/pm, and *no* time without it, we convert
15276 ;; so that matching will be successful.
15277 (loop for i from 1 to 2 do ; twice, for end time as well
15280 (setq hour (string-to-number (match-string 1 ans))
15281 minute (if (match-end 3)
15282 (string-to-number (match-string 3 ans))
15283 0)
15284 pm (equal ?p
15285 (string-to-char (downcase (match-string 4 ans)))))
15286 (if (and (= hour 12) (not pm))
15287 (setq hour 0)
15288 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15289 (setq ans (replace-match (format "%02d:%02d" hour minute)
15290 t t ans))))
15292 ;; Check if a time range is given as a duration
15293 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15294 (setq hour (string-to-number (match-string 1 ans))
15295 h2 (+ hour (string-to-number (match-string 3 ans)))
15296 minute (string-to-number (match-string 2 ans))
15297 m2 (+ minute (if (match-end 5) (string-to-number
15298 (match-string 5 ans))0)))
15299 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15300 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15301 t t ans)))
15303 ;; Check if there is a time range
15304 (when (boundp 'org-end-time-was-given)
15305 (setq org-time-was-given nil)
15306 (when (and (string-match org-plain-time-of-day-regexp ans)
15307 (match-end 8))
15308 (setq org-end-time-was-given (match-string 8 ans))
15309 (setq ans (concat (substring ans 0 (match-beginning 7))
15310 (substring ans (match-end 7))))))
15312 (setq tl (parse-time-string ans)
15313 day (or (nth 3 tl) (nth 3 defdecode))
15314 month (or (nth 4 tl)
15315 (if (and org-read-date-prefer-future
15316 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15317 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15318 (nth 4 defdecode)))
15319 year (or (and (not kill-year) (nth 5 tl))
15320 (if (and org-read-date-prefer-future
15321 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15322 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15323 (nth 5 defdecode)))
15324 hour (or (nth 2 tl) (nth 2 defdecode))
15325 minute (or (nth 1 tl) (nth 1 defdecode))
15326 second (or (nth 0 tl) 0)
15327 wday (nth 6 tl))
15329 (when (and (eq org-read-date-prefer-future 'time)
15330 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15331 (equal day (nth 3 nowdecode))
15332 (equal month (nth 4 nowdecode))
15333 (equal year (nth 5 nowdecode))
15334 (nth 2 tl)
15335 (or (< (nth 2 tl) (nth 2 nowdecode))
15336 (and (= (nth 2 tl) (nth 2 nowdecode))
15337 (nth 1 tl)
15338 (< (nth 1 tl) (nth 1 nowdecode)))))
15339 (setq day (1+ day)
15340 futurep t))
15342 ;; Special date definitions below
15343 (cond
15344 (iso-week
15345 ;; There was an iso week
15346 (require 'cal-iso)
15347 (setq futurep nil)
15348 (setq year (or iso-year year)
15349 day (or iso-weekday wday 1)
15350 wday nil ; to make sure that the trigger below does not match
15351 iso-date (calendar-gregorian-from-absolute
15352 (calendar-absolute-from-iso
15353 (list iso-week day year))))
15354 ; FIXME: Should we also push ISO weeks into the future?
15355 ; (when (and org-read-date-prefer-future
15356 ; (not iso-year)
15357 ; (< (calendar-absolute-from-gregorian iso-date)
15358 ; (time-to-days (current-time))))
15359 ; (setq year (1+ year)
15360 ; iso-date (calendar-gregorian-from-absolute
15361 ; (calendar-absolute-from-iso
15362 ; (list iso-week day year)))))
15363 (setq month (car iso-date)
15364 year (nth 2 iso-date)
15365 day (nth 1 iso-date)))
15366 (deltan
15367 (setq futurep nil)
15368 (unless deltadef
15369 (let ((now (decode-time (current-time))))
15370 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15371 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15372 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15373 ((equal deltaw "m") (setq month (+ month deltan)))
15374 ((equal deltaw "y") (setq year (+ year deltan)))))
15375 ((and wday (not (nth 3 tl)))
15376 (setq futurep nil)
15377 ;; Weekday was given, but no day, so pick that day in the week
15378 ;; on or after the derived date.
15379 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15380 (unless (equal wday wday1)
15381 (setq day (+ day (% (- wday wday1 -7) 7))))))
15382 (if (and (boundp 'org-time-was-given)
15383 (nth 2 tl))
15384 (setq org-time-was-given t))
15385 (if (< year 100) (setq year (+ 2000 year)))
15386 ;; Check of the date is representable
15387 (if org-read-date-force-compatible-dates
15388 (progn
15389 (if (< year 1970)
15390 (setq year 1970 org-read-date-analyze-forced-year t))
15391 (if (> year 2037)
15392 (setq year 2037 org-read-date-analyze-forced-year t)))
15393 (condition-case nil
15394 (ignore (encode-time second minute hour day month year))
15395 (error
15396 (setq year (nth 5 defdecode))
15397 (setq org-read-date-analyze-forced-year t))))
15398 (setq org-read-date-analyze-futurep futurep)
15399 (list second minute hour day month year)))
15401 (defvar parse-time-weekdays)
15403 (defun org-read-date-get-relative (s today default)
15404 "Check string S for special relative date string.
15405 TODAY and DEFAULT are internal times, for today and for a default.
15406 Return shift list (N what def-flag)
15408 N is the number of WHATs to shift.
15409 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15410 the DEFAULT date rather than TODAY."
15411 (require 'parse-time)
15412 (when (and
15413 (string-match
15414 (concat
15419 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15420 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15421 (string-to-char (substring (match-string 1 s) -1))
15422 ?+))
15423 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15424 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15425 (what (if (match-end 3) (match-string 3 s) "d"))
15426 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15427 (date (if rel default today))
15428 (wday (nth 6 (decode-time date)))
15429 delta)
15430 (if wday1
15431 (progn
15432 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15433 (if (= dir ?-) (setq delta (- delta 7)))
15434 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15435 (list delta "d" rel))
15436 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15438 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15439 "Turn a user-specified date into the internal representation.
15440 The internal representation needed by the calendar is (month day year).
15441 This is a wrapper to handle the brain-dead convention in calendar that
15442 user function argument order change dependent on argument order."
15443 (if (boundp 'calendar-date-style)
15444 (cond
15445 ((eq calendar-date-style 'american)
15446 (list arg1 arg2 arg3))
15447 ((eq calendar-date-style 'european)
15448 (list arg2 arg1 arg3))
15449 ((eq calendar-date-style 'iso)
15450 (list arg2 arg3 arg1)))
15451 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15452 (if (org-bound-and-true-p european-calendar-style)
15453 (list arg2 arg1 arg3)
15454 (list arg1 arg2 arg3)))))
15456 (defun org-eval-in-calendar (form &optional keepdate)
15457 "Eval FORM in the calendar window and return to current window.
15458 Also, store the cursor date in variable org-ans2."
15459 (let ((sf (selected-frame))
15460 (sw (selected-window)))
15461 (select-window (get-buffer-window "*Calendar*" t))
15462 (eval form)
15463 (when (and (not keepdate) (calendar-cursor-to-date))
15464 (let* ((date (calendar-cursor-to-date))
15465 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15466 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15467 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15468 (select-window sw)
15469 (org-select-frame-set-input-focus sf)))
15471 (defun org-calendar-select ()
15472 "Return to `org-read-date' with the date currently selected.
15473 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15474 (interactive)
15475 (when (calendar-cursor-to-date)
15476 (let* ((date (calendar-cursor-to-date))
15477 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15478 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15479 (if (active-minibuffer-window) (exit-minibuffer))))
15481 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15482 "Insert a date stamp for the date given by the internal TIME.
15483 WITH-HM means use the stamp format that includes the time of the day.
15484 INACTIVE means use square brackets instead of angular ones, so that the
15485 stamp will not contribute to the agenda.
15486 PRE and POST are optional strings to be inserted before and after the
15487 stamp.
15488 The command returns the inserted time stamp."
15489 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15490 stamp)
15491 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15492 (insert-before-markers (or pre ""))
15493 (when (listp extra)
15494 (setq extra (car extra))
15495 (if (and (stringp extra)
15497 (setq extra (format "-%02d:%02d"
15498 (string-to-number (match-string 1 extra))
15499 (string-to-number (match-string 2 extra))))
15500 (setq extra nil)))
15501 (when extra
15502 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15503 (insert-before-markers (setq stamp (format-time-string fmt time)))
15504 (insert-before-markers (or post ""))
15505 (setq org-last-inserted-timestamp stamp)))
15507 (defun org-toggle-time-stamp-overlays ()
15508 "Toggle the use of custom time stamp formats."
15509 (interactive)
15510 (setq org-display-custom-times (not org-display-custom-times))
15511 (unless org-display-custom-times
15512 (let ((p (point-min)) (bmp (buffer-modified-p)))
15513 (while (setq p (next-single-property-change p 'display))
15514 (if (and (get-text-property p 'display)
15515 (eq (get-text-property p 'face) 'org-date))
15516 (remove-text-properties
15517 p (setq p (next-single-property-change p 'display))
15518 '(display t))))
15519 (set-buffer-modified-p bmp)))
15520 (if (featurep 'xemacs)
15521 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15522 (org-restart-font-lock)
15523 (setq org-table-may-need-update t)
15524 (if org-display-custom-times
15525 (message "Time stamps are overlaid with custom format")
15526 (message "Time stamp overlays removed")))
15528 (defun org-display-custom-time (beg end)
15529 "Overlay modified time stamp format over timestamp between BEG and END."
15530 (let* ((ts (buffer-substring beg end))
15531 t1 w1 with-hm tf time str w2 (off 0))
15532 (save-match-data
15533 (setq t1 (org-parse-time-string ts t))
15534 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15535 (setq off (- (match-end 0) (match-beginning 0)))))
15536 (setq end (- end off))
15537 (setq w1 (- end beg)
15538 with-hm (and (nth 1 t1) (nth 2 t1))
15539 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15540 time (org-fix-decoded-time t1)
15541 str (org-add-props
15542 (format-time-string
15543 (substring tf 1 -1) (apply 'encode-time time))
15544 nil 'mouse-face 'highlight)
15545 w2 (length str))
15546 (if (not (= w2 w1))
15547 (add-text-properties (1+ beg) (+ 2 beg)
15548 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15549 (if (featurep 'xemacs)
15550 (progn
15551 (put-text-property beg end 'invisible t)
15552 (put-text-property beg end 'end-glyph (make-glyph str)))
15553 (put-text-property beg end 'display str))))
15555 (defun org-translate-time (string)
15556 "Translate all timestamps in STRING to custom format.
15557 But do this only if the variable `org-display-custom-times' is set."
15558 (when org-display-custom-times
15559 (save-match-data
15560 (let* ((start 0)
15561 (re org-ts-regexp-both)
15562 t1 with-hm inactive tf time str beg end)
15563 (while (setq start (string-match re string start))
15564 (setq beg (match-beginning 0)
15565 end (match-end 0)
15566 t1 (save-match-data
15567 (org-parse-time-string (substring string beg end) t))
15568 with-hm (and (nth 1 t1) (nth 2 t1))
15569 inactive (equal (substring string beg (1+ beg)) "[")
15570 tf (funcall (if with-hm 'cdr 'car)
15571 org-time-stamp-custom-formats)
15572 time (org-fix-decoded-time t1)
15573 str (format-time-string
15574 (concat
15575 (if inactive "[" "<") (substring tf 1 -1)
15576 (if inactive "]" ">"))
15577 (apply 'encode-time time))
15578 string (replace-match str t t string)
15579 start (+ start (length str)))))))
15580 string)
15582 (defun org-fix-decoded-time (time)
15583 "Set 0 instead of nil for the first 6 elements of time.
15584 Don't touch the rest."
15585 (let ((n 0))
15586 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15588 (defun org-days-to-time (timestamp-string)
15589 "Difference between TIMESTAMP-STRING and now in days."
15590 (- (time-to-days (org-time-string-to-time timestamp-string))
15591 (time-to-days (current-time))))
15593 (defun org-deadline-close (timestamp-string &optional ndays)
15594 "Is the time in TIMESTAMP-STRING close to the current date?"
15595 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15596 (and (< (org-days-to-time timestamp-string) ndays)
15597 (not (org-entry-is-done-p))))
15599 (defun org-get-wdays (ts)
15600 "Get the deadline lead time appropriate for timestring TS."
15601 (cond
15602 ((<= org-deadline-warning-days 0)
15603 ;; 0 or negative, enforce this value no matter what
15604 (- org-deadline-warning-days))
15606 ;; lead time is specified.
15607 (floor (* (string-to-number (match-string 1 ts))
15608 (cdr (assoc (match-string 2 ts)
15609 '(("d" . 1) ("w" . 7)
15610 ("m" . 30.4) ("y" . 365.25)))))))
15611 ;; go for the default.
15612 (t org-deadline-warning-days)))
15614 (defun org-calendar-select-mouse (ev)
15615 "Return to `org-read-date' with the date currently selected.
15616 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15617 (interactive "e")
15618 (mouse-set-point ev)
15619 (when (calendar-cursor-to-date)
15620 (let* ((date (calendar-cursor-to-date))
15621 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15622 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15623 (if (active-minibuffer-window) (exit-minibuffer))))
15625 (defun org-check-deadlines (ndays)
15626 "Check if there are any deadlines due or past due.
15627 A deadline is considered due if it happens within `org-deadline-warning-days'
15628 days from today's date. If the deadline appears in an entry marked DONE,
15629 it is not shown. The prefix arg NDAYS can be used to test that many
15631 (interactive "P")
15632 (let* ((org-warn-days
15633 (cond
15634 ((equal ndays '(4)) 100000)
15635 (ndays (prefix-numeric-value ndays))
15636 (t (abs org-deadline-warning-days))))
15637 (case-fold-search nil)
15639 (callback
15640 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15642 (message "%d deadlines past-due or due within %d days"
15643 (org-occur regexp nil callback)
15644 org-warn-days)))
15646 (defun org-check-before-date (date)
15647 "Check if there are deadlines or scheduled entries before DATE."
15648 (interactive (list (org-read-date)))
15649 (let ((case-fold-search nil)
15653 (callback
15654 (lambda () (time-less-p
15655 (org-time-string-to-time (match-string 2))
15656 (org-time-string-to-time date)))))
15657 (message "%d entries before %s"
15658 (org-occur regexp nil callback) date)))
15660 (defun org-check-after-date (date)
15661 "Check if there are deadlines or scheduled entries after DATE."
15662 (interactive (list (org-read-date)))
15663 (let ((case-fold-search nil)
15667 (callback
15668 (lambda () (not
15669 (time-less-p
15670 (org-time-string-to-time (match-string 2))
15671 (org-time-string-to-time date))))))
15672 (message "%d entries after %s"
15673 (org-occur regexp nil callback) date)))
15675 (defun org-check-dates-range (start-date end-date)
15676 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15677 (interactive (list (org-read-date nil nil nil "Range starts")
15678 (org-read-date nil nil nil "Range end")))
15679 (let ((case-fold-search nil)
15683 (callback
15684 (lambda ()
15685 (let ((match (match-string 2)))
15686 (and
15687 (not (time-less-p
15688 (org-time-string-to-time match)
15689 (org-time-string-to-time start-date)))
15690 (time-less-p
15691 (org-time-string-to-time match)
15692 (org-time-string-to-time end-date)))))))
15693 (message "%d entries between %s and %s"
15694 (org-occur regexp nil callback) start-date end-date)))
15696 (defun org-evaluate-time-range (&optional to-buffer)
15697 "Evaluate a time range by computing the difference between start and end.
15698 Normally the result is just printed in the echo area, but with prefix arg
15699 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15700 If the time range is actually in a table, the result is inserted into the
15701 next column.
15702 For time difference computation, a year is assumed to be exactly 365
15703 days in order to avoid rounding problems."
15704 (interactive "P")
15705 (or
15706 (org-clock-update-time-maybe)
15707 (save-excursion
15708 (unless (org-at-date-range-p t)
15709 (goto-char (point-at-bol))
15710 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15711 (if (not (org-at-date-range-p t))
15712 (error "Not at a time-stamp range, and none found in current line")))
15713 (let* ((ts1 (match-string 1))
15714 (ts2 (match-string 2))
15715 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15716 (match-end (match-end 0))
15717 (time1 (org-time-string-to-time ts1))
15718 (time2 (org-time-string-to-time ts2))
15719 (t1 (org-float-time time1))
15720 (t2 (org-float-time time2))
15721 (diff (abs (- t2 t1)))
15722 (negative (< (- t2 t1) 0))
15723 ;; (ys (floor (* 365 24 60 60)))
15724 (ds (* 24 60 60))
15725 (hs (* 60 60))
15726 (fy "%dy %dd %02d:%02d")
15727 (fy1 "%dy %dd")
15728 (fd "%dd %02d:%02d")
15729 (fd1 "%dd")
15730 (fh "%02d:%02d")
15731 y d h m align)
15732 (if havetime
15733 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15734 y 0
15735 d (floor (/ diff ds)) diff (mod diff ds)
15736 h (floor (/ diff hs)) diff (mod diff hs)
15737 m (floor (/ diff 60)))
15738 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15739 y 0
15740 d (floor (+ (/ diff ds) 0.5))
15741 h 0 m 0))
15742 (if (not to-buffer)
15743 (message "%s" (org-make-tdiff-string y d h m))
15744 (if (org-at-table-p)
15745 (progn
15746 (goto-char match-end)
15747 (setq align t)
15748 (and (looking-at " *|") (goto-char (match-end 0))))
15749 (goto-char match-end))
15750 (if (looking-at
15752 (replace-match ""))
15753 (if negative (insert " -"))
15754 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15755 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15756 (insert " " (format fh h m))))
15757 (if align (org-table-align))
15758 (message "Time difference inserted")))))
15760 (defun org-make-tdiff-string (y d h m)
15761 (let ((fmt "")
15762 (l nil))
15763 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15764 l (push y l)))
15765 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15766 l (push d l)))
15767 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15768 l (push h l)))
15769 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15770 l (push m l)))
15771 (apply 'format fmt (nreverse l))))
15773 (defun org-time-string-to-time (s &optional buffer pos)
15774 (condition-case errdata
15775 (apply 'encode-time (org-parse-time-string s))
15777 s (if (not (and buffer pos))
15778 ""
15779 (format " at %d in buffer `%s'" pos buffer))
15780 (cdr errdata)))))
15782 (defun org-time-string-to-seconds (s)
15783 (org-float-time (org-time-string-to-time s)))
15785 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15786 "Convert a time stamp to an absolute day number.
15787 If there is a specifier for a cyclic time stamp, get the closest date to
15788 DAYNR.
15789 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15790 The variable date is bound by the calendar when this is called."
15791 (cond
15793 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15794 daynr
15795 (+ daynr 1000)))
15797 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15798 (time-to-days (current-time))) (match-string 0 s)
15799 prefer show-all))
15800 (t (time-to-days
15801 (condition-case errdata
15802 (apply 'encode-time (org-parse-time-string s))
15804 s (if (not (and buffer pos))
15805 ""
15806 (format " at %d in buffer `%s'" pos buffer))
15807 (cdr errdata))))))))
15809 (defun org-days-to-iso-week (days)
15810 "Return the iso week number."
15811 (require 'cal-iso)
15812 (car (calendar-iso-from-absolute days)))
15814 (defun org-small-year-to-year (year)
15815 "Convert 2-digit years into 4-digit years.
15816 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15817 The year 2000 cannot be abbreviated. Any year larger than 99
15818 is returned unchanged."
15819 (if (< year 38)
15820 (setq year (+ 2000 year))
15821 (if (< year 100)
15822 (setq year (+ 1900 year))))
15823 year)
15825 (defun org-time-from-absolute (d)
15826 "Return the time corresponding to date D.
15827 D may be an absolute day number, or a calendar-type list (month day year)."
15828 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15829 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15831 (defun org-calendar-holiday ()
15832 "List of holidays, for Diary display in Org-mode."
15833 (require 'holidays)
15834 (let ((hl (funcall
15835 (if (fboundp 'calendar-check-holidays)
15836 'calendar-check-holidays 'check-calendar-holidays) date)))
15837 (if hl (mapconcat 'identity hl "; "))))
15839 (defun org-diary-sexp-entry (sexp entry date)
15840 "Process a SEXP diary ENTRY for DATE."
15841 (require 'diary-lib)
15842 (let ((result (if calendar-debug-sexp
15843 (let ((stack-trace-on-error t))
15844 (eval (car (read-from-string sexp))))
15845 (condition-case nil
15846 (eval (car (read-from-string sexp)))
15847 (error
15848 (beep)
15849 (message "Bad sexp at line %d in %s: %s"
15850 (org-current-line)
15851 (buffer-file-name) sexp)
15852 (sleep-for 2))))))
15853 (cond ((stringp result) (split-string result "; "))
15854 ((and (consp result)
15855 (not (consp (cdr result)))
15856 (stringp (cdr result))) (cdr result))
15857 ((and (consp result)
15858 (stringp (car result))) result)
15859 (result entry)
15860 (t nil))))
15862 (defun org-diary-to-ical-string (frombuf)
15863 "Get iCalendar entries from diary entries in buffer FROMBUF.
15864 This uses the icalendar.el library."
15865 (let* ((tmpdir (if (featurep 'xemacs)
15866 (temp-directory)
15867 temporary-file-directory))
15868 (tmpfile (make-temp-name
15869 (expand-file-name "orgics" tmpdir)))
15870 buf rtn b e)
15871 (with-current-buffer frombuf
15872 (icalendar-export-region (point-min) (point-max) tmpfile)
15873 (setq buf (find-buffer-visiting tmpfile))
15874 (set-buffer buf)
15875 (goto-char (point-min))
15876 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15877 (setq b (match-beginning 0)))
15878 (goto-char (point-max))
15879 (if (re-search-backward "^END:VEVENT" nil t)
15880 (setq e (match-end 0)))
15882 (kill-buffer buf)
15883 (delete-file tmpfile)
15884 rtn))
15886 (defun org-closest-date (start current change prefer show-all)
15887 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15888 When PREFER is `past', return a date that is either CURRENT or past.
15889 When PREFER is `future', return a date that is either CURRENT or future.
15890 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15891 ;; Make the proper lists from the dates
15892 (catch 'exit
15893 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15894 dn dw sday cday n1 n2 n0
15895 d m y y1 y2 date1 date2 nmonths nm ny m2)
15897 (setq start (org-date-to-gregorian start)
15898 current (org-date-to-gregorian
15899 (if show-all
15900 current
15901 (time-to-days (current-time))))
15902 sday (calendar-absolute-from-gregorian start)
15903 cday (calendar-absolute-from-gregorian current))
15905 (if (<= cday sday) (throw 'exit sday))
15908 (setq dn (string-to-number (match-string 1 change))
15909 dw (cdr (assoc (match-string 2 change) a1)))
15910 (error "Invalid change specifier: %s" change))
15911 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15912 (cond
15913 ((eq dw 'day)
15914 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15915 n2 (+ n1 dn)))
15916 ((eq dw 'year)
15917 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15918 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15919 (setq date1 (list m d y1)
15920 n1 (calendar-absolute-from-gregorian date1)
15921 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15922 n2 (calendar-absolute-from-gregorian date2)))
15923 ((eq dw 'month)
15924 ;; approx number of month between the two dates
15925 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15926 ;; How often does dn fit in there?
15927 (setq d (nth 1 start) m (car start) y (nth 2 start)
15928 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15929 m (+ m nm)
15930 ny (floor (/ m 12))
15931 y (+ y ny)
15932 m (- m (* ny 12)))
15933 (while (> m 12) (setq m (- m 12) y (1+ y)))
15934 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15935 (setq m2 (+ m dn) y2 y)
15936 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15937 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15938 (while (<= n2 cday)
15939 (setq n1 n2 m m2 y y2)
15940 (setq m2 (+ m dn) y2 y)
15941 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15942 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15943 ;; Make sure n1 is the earlier date
15944 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15945 (if show-all
15946 (cond
15947 ((eq prefer 'past) (if (= cday n2) n2 n1))
15948 ((eq prefer 'future) (if (= cday n1) n1 n2))
15949 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15950 (cond
15951 ((eq prefer 'past) (if (= cday n2) n2 n1))
15952 ((eq prefer 'future) (if (= cday n1) n1 n2))
15953 (t (if (= cday n1) n1 n2)))))))
15955 (defun org-date-to-gregorian (date)
15956 "Turn any specification of DATE into a Gregorian date for the calendar."
15957 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15958 ((and (listp date) (= (length date) 3)) date)
15959 ((stringp date)
15960 (setq date (org-parse-time-string date))
15961 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15962 ((listp date)
15963 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15965 (defun org-parse-time-string (s &optional nodefault)
15966 "Parse the standard Org-mode time string.
15967 This should be a lot faster than the normal `parse-time-string'.
15968 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15969 hour and minute fields will be nil if not given."
15970 (if (string-match org-ts-regexp0 s)
15971 (list 0
15972 (if (or (match-beginning 8) (not nodefault))
15973 (string-to-number (or (match-string 8 s) "0")))
15974 (if (or (match-beginning 7) (not nodefault))
15975 (string-to-number (or (match-string 7 s) "0")))
15976 (string-to-number (match-string 4 s))
15977 (string-to-number (match-string 3 s))
15978 (string-to-number (match-string 2 s))
15979 nil nil nil)
15980 (error "Not a standard Org-mode time string: %s" s)))
15982 (defun org-timestamp-up (&optional arg)
15983 "Increase the date item at the cursor by one.
15984 If the cursor is on the year, change the year. If it is on the month,
15985 the day or the time, change that.
15986 With prefix ARG, change by that many units."
15987 (interactive "p")
15988 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15990 (defun org-timestamp-down (&optional arg)
15991 "Decrease the date item at the cursor by one.
15992 If the cursor is on the year, change the year. If it is on the month,
15993 the day or the time, change that.
15994 With prefix ARG, change by that many units."
15995 (interactive "p")
15996 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15998 (defun org-timestamp-up-day (&optional arg)
15999 "Increase the date in the time stamp by one day.
16000 With prefix ARG, change that many days."
16001 (interactive "p")
16002 (if (and (not (org-at-timestamp-p t))
16003 (org-at-heading-p))
16004 (org-todo 'up)
16005 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16007 (defun org-timestamp-down-day (&optional arg)
16008 "Decrease the date in the time stamp by one day.
16009 With prefix ARG, change that many days."
16010 (interactive "p")
16011 (if (and (not (org-at-timestamp-p t))
16012 (org-at-heading-p))
16013 (org-todo 'down)
16014 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16016 (defun org-at-timestamp-p (&optional inactive-ok)
16017 "Determine if the cursor is in or at a timestamp."
16018 (interactive)
16019 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16020 (pos (point))
16021 (ans (or (looking-at tsr)
16022 (save-excursion
16024 (if (> (point) (point-min)) (backward-char 1))
16025 (and (looking-at tsr)
16026 (> (- (match-end 0) pos) -1))))))
16027 (and ans
16028 (boundp 'org-ts-what)
16029 (setq org-ts-what
16030 (cond
16031 ((= pos (match-beginning 0)) 'bracket)
16032 ;; Point is considered to be "on the bracket" whether
16033 ;; it's really on it or right after it.
16034 ((or (= pos (1- (match-end 0)))
16035 (= pos (match-end 0))) 'bracket)
16036 ((org-pos-in-match-range pos 2) 'year)
16037 ((org-pos-in-match-range pos 3) 'month)
16038 ((org-pos-in-match-range pos 7) 'hour)
16039 ((org-pos-in-match-range pos 8) 'minute)
16040 ((or (org-pos-in-match-range pos 4)
16041 (org-pos-in-match-range pos 5)) 'day)
16042 ((and (> pos (or (match-end 8) (match-end 5)))
16043 (< pos (match-end 0)))
16044 (- pos (or (match-end 8) (match-end 5))))
16045 (t 'day))))
16046 ans))
16048 (defun org-toggle-timestamp-type ()
16049 "Toggle the type (<active> or [inactive]) of a time stamp."
16050 (interactive)
16051 (when (org-at-timestamp-p t)
16052 (let ((beg (match-beginning 0)) (end (match-end 0))
16053 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16054 (save-excursion
16055 (goto-char beg)
16056 (while (re-search-forward "[][<>]" end t)
16057 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16058 t t)))
16059 (message "Timestamp is now %sactive"
16060 (if (equal (char-after beg) ?<) "" "in")))))
16062 (defun org-timestamp-change (n &optional what updown)
16063 "Change the date in the time stamp at point.
16064 The date will be changed by N times WHAT. WHAT can be `day', `month',
16065 `year', `minute', `second'. If WHAT is not given, the cursor position
16066 in the timestamp determines what will be changed."
16067 (let ((origin (point)) origin-cat
16068 with-hm inactive
16069 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16070 org-ts-what
16071 extra rem
16072 ts time time0)
16073 (if (not (org-at-timestamp-p t))
16074 (error "Not at a timestamp"))
16075 (if (and (not what) (eq org-ts-what 'bracket))
16076 (org-toggle-timestamp-type)
16077 ;; Point isn't on brackets. Remember the part of the time-stamp
16078 ;; the point was in. Indeed, size of time-stamps may change,
16079 ;; but point must be kept in the same category nonetheless.
16080 (setq origin-cat org-ts-what)
16081 (if (and (not what) (not (eq org-ts-what 'day))
16082 org-display-custom-times
16083 (get-text-property (point) 'display)
16084 (not (get-text-property (1- (point)) 'display)))
16085 (setq org-ts-what 'day))
16086 (setq org-ts-what (or what org-ts-what)
16087 inactive (= (char-after (match-beginning 0)) ?\[)
16088 ts (match-string 0))
16089 (replace-match "")
16090 (if (string-match
16092 ts)
16093 (setq extra (match-string 1 ts)))
16095 (setq with-hm t))
16096 (setq time0 (org-parse-time-string ts))
16097 (when (and updown
16098 (eq org-ts-what 'minute)
16099 (not current-prefix-arg))
16100 ;; This looks like s-up and s-down. Change by one rounding step.
16101 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16102 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16103 (setcar (cdr time0) (+ (nth 1 time0)
16104 (if (> n 0) (- rem) (- dm rem))))))
16105 (setq time
16106 (encode-time (or (car time0) 0)
16107 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16108 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16109 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16110 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16111 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16112 (nthcdr 6 time0)))
16113 (when (and (member org-ts-what '(hour minute))
16114 extra
16116 (setq extra (org-modify-ts-extra
16117 extra
16118 (if (eq org-ts-what 'hour) 2 5)
16119 n dm)))
16120 (when (integerp org-ts-what)
16121 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16122 (if (eq what 'calendar)
16123 (let ((cal-date (org-get-date-from-calendar)))
16124 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16125 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16126 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16127 (setcar time0 (or (car time0) 0))
16128 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16129 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16130 (setq time (apply 'encode-time time0))))
16131 ;; Insert the new time-stamp, and ensure point stays in the same
16132 ;; category as before (i.e. not after the last position in that
16133 ;; category).
16134 (let ((pos (point)))
16135 ;; Stay before inserted string. `save-excursion' is of no use.
16136 (setq org-last-changed-timestamp
16137 (org-insert-time-stamp time with-hm inactive nil nil extra))
16138 (goto-char pos))
16139 (save-match-data
16140 (looking-at org-ts-regexp3)
16141 (goto-char (cond
16142 ;; `day' category ends before `hour' if any, or at
16143 ;; the end of the day name.
16144 ((eq origin-cat 'day)
16145 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16146 ((eq origin-cat 'hour) (min (match-end 7) origin))
16147 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16148 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16149 ;; `year' and `month' have both fixed size: point
16150 ;; couldn't have moved into another part.
16151 (t origin))))
16152 ;; Update clock if on a CLOCK line.
16153 (org-clock-update-time-maybe)
16154 ;; Try to recenter the calendar window, if any.
16155 (if (and org-calendar-follow-timestamp-change
16156 (get-buffer-window "*Calendar*" t)
16157 (memq org-ts-what '(day month year)))
16158 (org-recenter-calendar (time-to-days time))))))
16160 (defun org-modify-ts-extra (s pos n dm)
16161 "Change the different parts of the lead-time and repeat fields in timestamp."
16162 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16163 ng h m new rem)
16164 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16165 (cond
16166 ((or (org-pos-in-match-range pos 2)
16167 (org-pos-in-match-range pos 3))
16168 (setq m (string-to-number (match-string 3 s))
16169 h (string-to-number (match-string 2 s)))
16170 (if (org-pos-in-match-range pos 2)
16171 (setq h (+ h n))
16172 (setq n (* dm (org-no-warnings (signum n))))
16173 (when (not (= 0 (setq rem (% m dm))))
16174 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16175 (setq m (+ m n)))
16176 (if (< m 0) (setq m (+ m 60) h (1- h)))
16177 (if (> m 59) (setq m (- m 60) h (1+ h)))
16178 (setq h (min 24 (max 0 h)))
16179 (setq ng 1 new (format "-%02d:%02d" h m)))
16180 ((org-pos-in-match-range pos 6)
16181 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16182 ((org-pos-in-match-range pos 5)
16183 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16185 ((org-pos-in-match-range pos 9)
16186 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16187 ((org-pos-in-match-range pos 8)
16188 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16190 (when ng
16191 (setq s (concat
16192 (substring s 0 (match-beginning ng))
16193 new
16194 (substring s (match-end ng))))))
16195 s))
16197 (defun org-recenter-calendar (date)
16198 "If the calendar is visible, recenter it to DATE."
16199 (let ((cwin (get-buffer-window "*Calendar*" t)))
16200 (when cwin
16201 (let ((calendar-move-hook nil))
16202 (with-selected-window cwin
16203 (calendar-goto-date (if (listp date) date
16204 (calendar-gregorian-from-absolute date))))))))
16206 (defun org-goto-calendar (&optional arg)
16207 "Go to the Emacs calendar at the current date.
16208 If there is a time stamp in the current line, go to that date.
16209 A prefix ARG can be used to force the current date."
16210 (interactive "P")
16211 (let ((tsr org-ts-regexp) diff
16212 (calendar-move-hook nil)
16213 (calendar-view-holidays-initially-flag nil)
16214 (calendar-view-diary-initially-flag nil))
16215 (if (or (org-at-timestamp-p)
16216 (save-excursion
16217 (beginning-of-line 1)
16218 (looking-at (concat ".*" tsr))))
16219 (let ((d1 (time-to-days (current-time)))
16220 (d2 (time-to-days
16221 (org-time-string-to-time (match-string 1)))))
16222 (setq diff (- d2 d1))))
16223 (calendar)
16224 (calendar-goto-today)
16225 (if (and diff (not arg)) (calendar-forward-day diff))))
16227 (defun org-get-date-from-calendar ()
16228 "Return a list (month day year) of date at point in calendar."
16229 (with-current-buffer "*Calendar*"
16230 (save-match-data
16231 (calendar-cursor-to-date))))
16233 (defun org-date-from-calendar ()
16234 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16235 If there is already a time stamp at the cursor position, update it."
16236 (interactive)
16237 (if (org-at-timestamp-p t)
16238 (org-timestamp-change 0 'calendar)
16239 (let ((cal-date (org-get-date-from-calendar)))
16240 (org-insert-time-stamp
16241 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16243 (defun org-minutes-to-hh:mm-string (m)
16244 "Compute H:MM from a number of minutes."
16245 (let ((h (/ m 60)))
16246 (setq m (- m (* 60 h)))
16247 (format org-time-clocksum-format h m)))
16249 (defun org-hh:mm-string-to-minutes (s)
16250 "Convert a string H:MM to a number of minutes.
16251 If the string is just a number, interpret it as minutes.
16252 In fact, the first hh:mm or number in the string will be taken,
16253 there can be extra stuff in the string.
16254 If no number is found, the return value is 0."
16255 (cond
16256 ((integerp s) s)
16258 (+ (* (string-to-number (match-string 1 s)) 60)
16259 (string-to-number (match-string 2 s))))
16261 (string-to-number (match-string 1 s)))
16262 (t 0)))
16264 (defcustom org-effort-durations
16265 `(("h" . 60)
16266 ("d" . ,(* 60 8))
16267 ("w" . ,(* 60 8 5))
16268 ("m" . ,(* 60 8 5 4))
16269 ("y" . ,(* 60 8 5 40)))
16270 "Conversion factor to minutes for an effort modifier.
16272 Each entry has the form (MODIFIER . MINUTES).
16274 In an effort string, a number followed by MODIFIER is multiplied
16275 by the specified number of MINUTES to obtain an effort in
16276 minutes.
16280 :group 'org-agenda
16281 :version "24.1"
16282 :type '(alist :key-type (string :tag "Modifier")
16283 :value-type (number :tag "Minutes")))
16285 (defun org-duration-string-to-minutes (s)
16286 "Convert a duration string S to minutes.
16288 A bare number is interpreted as minutes, modifiers can be set by
16289 customizing `org-effort-durations' (which see).
16291 Entries containing a colon are interpreted as H:MM by
16292 `org-hh:mm-string-to-minutes'."
16293 (let ((result 0)
16295 (regexp-opt (mapcar 'car org-effort-durations))
16297 (while (string-match re s)
16298 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16299 (string-to-number (match-string 1 s))))
16300 (setq s (replace-match "" nil t s)))
16301 (incf result (org-hh:mm-string-to-minutes s))
16302 result))
16304 ;;;; Files
16306 (defun org-save-all-org-buffers ()
16307 "Save all Org-mode buffers without user confirmation."
16308 (interactive)
16309 (message "Saving all Org-mode buffers...")
16310 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16311 (when (featurep 'org-id) (org-id-locations-save))
16312 (message "Saving all Org-mode buffers... done"))
16314 (defun org-revert-all-org-buffers ()
16315 "Revert all Org-mode buffers.
16316 Prompt for confirmation when there are unsaved changes.
16317 Be sure you know what you are doing before letting this function
16318 overwrite your changes.
16320 This function is useful in a setup where one tracks org files
16321 with a version control system, to revert on one machine after pulling
16322 changes from another. I believe the procedure must be like this:
16324 1. M-x org-save-all-org-buffers
16325 2. Pull changes from the other machine, resolve conflicts
16326 3. M-x org-revert-all-org-buffers"
16327 (interactive)
16328 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16329 (error "Abort"))
16330 (save-excursion
16331 (save-window-excursion
16332 (mapc
16333 (lambda (b)
16334 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16335 (with-current-buffer b buffer-file-name))
16336 (org-pop-to-buffer-same-window b)
16337 (revert-buffer t 'no-confirm)))
16338 (buffer-list))
16339 (when (and (featurep 'org-id) org-id-track-globally)
16340 (org-id-locations-load)))))
16342 ;;;; Agenda files
16344 ;;;###autoload
16345 (defun org-switchb (&optional arg)
16346 "Switch between Org buffers.
16347 With one prefix argument, restrict available buffers to files.
16348 With two prefix arguments, restrict available buffers to agenda files.
16350 Defaults to `iswitchb' for buffer name completion.
16351 Set `org-completion-use-ido' to make it use ido instead."
16352 (interactive "P")
16353 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16354 ((equal arg '(16)) (org-buffer-list 'agenda))
16355 (t (org-buffer-list))))
16356 (org-completion-use-iswitchb org-completion-use-iswitchb)
16357 (org-completion-use-ido org-completion-use-ido))
16358 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16359 (setq org-completion-use-iswitchb t))
16360 (org-pop-to-buffer-same-window
16361 (org-icompleting-read "Org buffer: "
16362 (mapcar 'list (mapcar 'buffer-name blist))
16363 nil t))))
16365 ;;; Define some older names previously used for this functionality
16366 ;;;###autoload
16367 (defalias 'org-ido-switchb 'org-switchb)
16368 ;;;###autoload
16369 (defalias 'org-iswitchb 'org-switchb)
16371 (defun org-buffer-list (&optional predicate exclude-tmp)
16372 "Return a list of Org buffers.
16373 PREDICATE can be `export', `files' or `agenda'.
16375 export restrict the list to Export buffers.
16376 files restrict the list to buffers visiting Org files.
16377 agenda restrict the list to buffers visiting agenda files.
16379 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16380 (let* ((bfn nil)
16381 (agenda-files (and (eq predicate 'agenda)
16382 (mapcar 'file-truename (org-agenda-files t))))
16383 (filter
16384 (cond
16385 ((eq predicate 'files)
16386 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16387 ((eq predicate 'export)
16388 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16389 ((eq predicate 'agenda)
16390 (lambda (b)
16391 (with-current-buffer b
16392 (and (eq major-mode 'org-mode)
16393 (setq bfn (buffer-file-name b))
16394 (member (file-truename bfn) agenda-files)))))
16395 (t (lambda (b) (with-current-buffer b
16396 (or (eq major-mode 'org-mode)
16397 (string-match "\*Org .*Export"
16398 (buffer-name b)))))))))
16399 (delq nil
16400 (mapcar
16401 (lambda(b)
16402 (if (and (funcall filter b)
16403 (or (not exclude-tmp)
16404 (not (string-match "tmp" (buffer-name b)))))
16405 b
16406 nil))
16407 (buffer-list)))))
16409 (defun org-agenda-files (&optional unrestricted archives)
16410 "Get the list of agenda files.
16411 Optional UNRESTRICTED means return the full list even if a restriction
16412 is currently in place.
16413 When ARCHIVES is t, include all archive files that are really being
16414 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16415 `org-agenda-archives-mode' is t."
16416 (let ((files
16417 (cond
16418 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16419 ((stringp org-agenda-files) (org-read-agenda-file-list))
16420 ((listp org-agenda-files) org-agenda-files)
16421 (t (error "Invalid value of `org-agenda-files'")))))
16422 (setq files (apply 'append
16423 (mapcar (lambda (f)
16424 (if (file-directory-p f)
16425 (directory-files
16426 f t org-agenda-file-regexp)
16427 (list f)))
16428 files)))
16429 (when org-agenda-skip-unavailable-files
16430 (setq files (delq nil
16431 (mapcar (function
16432 (lambda (file)
16433 (and (file-readable-p file) file)))
16434 files))))
16435 (when (or (eq archives t)
16436 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16437 (setq files (org-add-archive-files files)))
16438 files))
16440 (defun org-agenda-file-p (&optional file)
16441 "Return non-nil, if FILE is an agenda file.
16442 If FILE is omitted, use the file associated with the current
16443 buffer."
16444 (member (or file (buffer-file-name))
16445 (org-agenda-files t)))
16447 (defun org-edit-agenda-file-list ()
16448 "Edit the list of agenda files.
16449 Depending on setup, this either uses customize to edit the variable
16450 `org-agenda-files', or it visits the file that is holding the list. In the
16451 latter case, the buffer is set up in a way that saving it automatically kills
16452 the buffer and restores the previous window configuration."
16453 (interactive)
16454 (if (stringp org-agenda-files)
16455 (let ((cw (current-window-configuration)))
16456 (find-file org-agenda-files)
16457 (org-set-local 'org-window-configuration cw)
16458 (org-add-hook 'after-save-hook
16459 (lambda ()
16460 (set-window-configuration
16461 (prog1 org-window-configuration
16462 (kill-buffer (current-buffer))))
16463 (org-install-agenda-files-menu)
16464 (message "New agenda file list installed"))
16465 nil 'local)
16466 (message "%s" (substitute-command-keys
16468 (customize-variable 'org-agenda-files)))
16470 (defun org-store-new-agenda-file-list (list)
16471 "Set new value for the agenda file list and save it correctly."
16472 (if (stringp org-agenda-files)
16473 (let ((fe (org-read-agenda-file-list t)) b u)
16474 (while (setq b (find-buffer-visiting org-agenda-files))
16475 (kill-buffer b))
16476 (with-temp-file org-agenda-files
16477 (insert
16478 (mapconcat
16479 (lambda (f) ;; Keep un-expanded entries.
16480 (if (setq u (assoc f fe))
16481 (cdr u)
16482 f))
16485 (let ((org-mode-hook nil) (org-inhibit-startup t)
16486 (org-insert-mode-line-in-empty-file nil))
16487 (setq org-agenda-files list)
16488 (customize-save-variable 'org-agenda-files org-agenda-files))))
16490 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16491 "Read the list of agenda files from a file.
16492 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16493 filenames, used by `org-store-new-agenda-file-list' to write back
16494 un-expanded file names."
16495 (when (file-directory-p org-agenda-files)
16496 (error "`org-agenda-files' cannot be a single directory"))
16497 (when (stringp org-agenda-files)
16498 (with-temp-buffer
16499 (insert-file-contents org-agenda-files)
16500 (mapcar
16501 (lambda (f)
16502 (let ((e (expand-file-name (substitute-in-file-name f)
16503 org-directory)))
16504 (if pair-with-expansion
16505 (cons e f)
16506 e)))
16509 ;;;###autoload
16510 (defun org-cycle-agenda-files ()
16511 "Cycle through the files in `org-agenda-files'.
16512 If the current buffer visits an agenda file, find the next one in the list.
16513 If the current buffer does not, find the first agenda file."
16514 (interactive)
16515 (let* ((fs (org-agenda-files t))
16516 (files (append fs (list (car fs))))
16517 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16518 file)
16519 (unless files (error "No agenda files"))
16520 (catch 'exit
16521 (while (setq file (pop files))
16522 (if (equal (file-truename file) tcf)
16523 (when (car files)
16524 (find-file (car files))
16525 (throw 'exit t))))
16526 (find-file (car fs)))
16527 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16529 (defun org-agenda-file-to-front (&optional to-end)
16530 "Move/add the current file to the top of the agenda file list.
16531 If the file is not present in the list, it is added to the front. If it is
16532 present, it is moved there. With optional argument TO-END, add/move to the
16533 end of the list."
16534 (interactive "P")
16535 (let ((org-agenda-skip-unavailable-files nil)
16536 (file-alist (mapcar (lambda (x)
16537 (cons (file-truename x) x))
16538 (org-agenda-files t)))
16539 (ctf (file-truename buffer-file-name))
16540 x had)
16541 (setq x (assoc ctf file-alist) had x)
16543 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16544 (if to-end
16545 (setq file-alist (append (delq x file-alist) (list x)))
16546 (setq file-alist (cons x (delq x file-alist))))
16547 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16548 (org-install-agenda-files-menu)
16549 (message "File %s to %s of agenda file list"
16550 (if had "moved" "added") (if to-end "end" "front"))))
16552 (defun org-remove-file (&optional file)
16553 "Remove current file from the list of files in variable `org-agenda-files'.
16554 These are the files which are being checked for agenda entries.
16555 Optional argument FILE means use this file instead of the current."
16556 (interactive)
16557 (let* ((org-agenda-skip-unavailable-files nil)
16558 (file (or file buffer-file-name))
16559 (true-file (file-truename file))
16560 (afile (abbreviate-file-name file))
16561 (files (delq nil (mapcar
16562 (lambda (x)
16563 (if (equal true-file
16564 (file-truename x))
16565 nil x))
16566 (org-agenda-files t)))))
16567 (if (not (= (length files) (length (org-agenda-files t))))
16568 (progn
16569 (org-store-new-agenda-file-list files)
16570 (org-install-agenda-files-menu)
16571 (message "Removed file: %s" afile))
16572 (message "File was not in list: %s (not removed)" afile))))
16574 (defun org-file-menu-entry (file)
16575 (vector file (list 'find-file file) t))
16577 (defun org-check-agenda-file (file)
16578 "Make sure FILE exists. If not, ask user what to do."
16579 (when (not (file-exists-p file))
16580 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16581 (abbreviate-file-name file))
16582 (let ((r (downcase (read-char-exclusive))))
16583 (cond
16584 ((equal r ?r)
16585 (org-remove-file file)
16586 (throw 'nextfile t))
16587 (t (error "Abort"))))))
16589 (defun org-get-agenda-file-buffer (file)
16590 "Get a buffer visiting FILE. If the buffer needs to be created, add
16591 it to the list of buffers which might be released later."
16592 (let ((buf (org-find-base-buffer-visiting file)))
16593 (if buf
16594 buf ; just return it
16595 ;; Make a new buffer and remember it
16596 (setq buf (find-file-noselect file))
16597 (if buf (push buf org-agenda-new-buffers))
16598 buf)))
16600 (defun org-release-buffers (blist)
16601 "Release all buffers in list, asking the user for confirmation when needed.
16602 When a buffer is unmodified, it is just killed. When modified, it is saved
16603 \(if the user agrees) and then killed."
16604 (let (buf file)
16605 (while (setq buf (pop blist))
16606 (setq file (buffer-file-name buf))
16607 (when (and (buffer-modified-p buf)
16608 file
16609 (y-or-n-p (format "Save file %s? " file)))
16610 (with-current-buffer buf (save-buffer)))
16611 (kill-buffer buf))))
16613 (defun org-prepare-agenda-buffers (files)
16614 "Create buffers for all agenda files, protect archived trees and comments."
16615 (interactive)
16616 (let ((pa '(:org-archived t))
16617 (pc '(:org-comment t))
16618 (pall '(:org-archived t :org-comment t))
16619 (inhibit-read-only t)
16620 (rea (concat ":" org-archive-tag ":"))
16621 bmp file re)
16622 (save-excursion
16623 (save-restriction
16624 (while (setq file (pop files))
16625 (catch 'nextfile
16626 (if (bufferp file)
16627 (set-buffer file)
16628 (org-check-agenda-file file)
16629 (set-buffer (org-get-agenda-file-buffer file)))
16630 (widen)
16631 (setq bmp (buffer-modified-p))
16632 (org-refresh-category-properties)
16633 (setq org-todo-keywords-for-agenda
16634 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16635 (setq org-done-keywords-for-agenda
16636 (append org-done-keywords-for-agenda org-done-keywords))
16637 (setq org-todo-keyword-alist-for-agenda
16638 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16639 (setq org-drawers-for-agenda
16640 (append org-drawers-for-agenda org-drawers))
16641 (setq org-tag-alist-for-agenda
16642 (append org-tag-alist-for-agenda org-tag-alist))
16644 (save-excursion
16645 (remove-text-properties (point-min) (point-max) pall)
16646 (when org-agenda-skip-archived-trees
16647 (goto-char (point-min))
16648 (while (re-search-forward rea nil t)
16649 (if (org-at-heading-p t)
16650 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16651 (goto-char (point-min))
16652 (setq re (format org-heading-keyword-regexp-format
16653 org-comment-string))
16654 (while (re-search-forward re nil t)
16655 (add-text-properties
16656 (match-beginning 0) (org-end-of-subtree t) pc)))
16657 (set-buffer-modified-p bmp)))))
16658 (setq org-todo-keywords-for-agenda
16659 (org-uniquify org-todo-keywords-for-agenda))
16660 (setq org-todo-keyword-alist-for-agenda
16661 (org-uniquify org-todo-keyword-alist-for-agenda)
16662 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16664 ;;;; Embedded LaTeX
16666 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16667 "Keymap for the minor `org-cdlatex-mode'.")
16669 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16670 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16671 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16672 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16673 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16675 (defvar org-cdlatex-texmathp-advice-is-done nil
16676 "Flag remembering if we have applied the advice to texmathp already.")
16678 (define-minor-mode org-cdlatex-mode
16679 "Toggle the minor `org-cdlatex-mode'.
16680 This mode supports entering LaTeX environment and math in LaTeX fragments
16681 in Org-mode.
16683 nil " OCDL" nil
16684 (when org-cdlatex-mode
16685 (require 'cdlatex)
16686 (run-hooks 'cdlatex-mode-hook)
16687 (cdlatex-compute-tables))
16688 (unless org-cdlatex-texmathp-advice-is-done
16689 (setq org-cdlatex-texmathp-advice-is-done t)
16690 (defadvice texmathp (around org-math-always-on activate)
16691 "Always return t in org-mode buffers.
16692 This is because we want to insert math symbols without dollars even outside
16693 the LaTeX math segments. If Orgmode thinks that point is actually inside
16694 an embedded LaTeX fragment, let texmathp do its job.
16696 (interactive)
16697 (let (p)
16698 (cond
16699 ((not (eq major-mode 'org-mode)) ad-do-it)
16700 ((eq this-command 'cdlatex-math-symbol)
16701 (setq ad-return-value t
16702 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16703 (t
16704 (let ((p (org-inside-LaTeX-fragment-p)))
16705 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16706 (setq ad-return-value t
16707 texmathp-why '("Org-mode embedded math" . 0))
16708 (if p ad-do-it)))))))))
16710 (defun turn-on-org-cdlatex ()
16711 "Unconditionally turn on `org-cdlatex-mode'."
16712 (org-cdlatex-mode 1))
16714 (defun org-inside-LaTeX-fragment-p ()
16715 "Test if point is inside a LaTeX fragment.
16717 sequence appearing also before point.
16718 Even though the matchers for math are configurable, this function assumes
16720 delimiters are skipped when they have been removed by customization.
16721 The return value is nil, or a cons cell with the delimiter and the
16722 position of this delimiter.
16724 This function does a reasonably good job, but can locally be fooled by
16725 for example currency specifications. For example it will assume being in
16727 fragments that are properly closed, but during editing, we have to live
16728 with the uncertainty caused by missing closing delimiters. This function
16729 looks only before point, not after."
16730 (catch 'exit
16731 (let ((pos (point))
16732 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16733 (lim (progn
16735 (point)))
16736 dd-on str (start 0) m re)
16737 (goto-char pos)
16738 (when dodollar
16740 re (nth 1 (assoc "$" org-latex-regexps)))
16741 (while (string-match re str start)
16742 (cond
16743 ((= (match-end 0) (length str))
16744 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16745 ((= (match-end 0) (- (length str) 5))
16746 (throw 'exit nil))
16747 (t (setq start (match-end 0))))))
16748 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16749 (goto-char pos)
16750 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16751 (and (match-beginning 2) (throw 'exit nil))
16752 ;; count $$
16754 (setq dd-on (not dd-on)))
16755 (goto-char pos)
16756 (if dd-on (cons "$$" m))))))
16758 (defun org-inside-latex-macro-p ()
16759 "Is point inside a LaTeX macro or its arguments?"
16760 (save-match-data
16761 (org-in-regexp
16764 (defun org-try-cdlatex-tab ()
16765 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16766 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16767 - inside a LaTeX fragment, or
16768 - after the first word in a line, where an abbreviation expansion could
16769 insert a LaTeX environment."
16770 (when org-cdlatex-mode
16771 (cond
16772 ;; Before any word on the line: No expansion possible.
16774 ;; Just after first word on the line: Expand it. Make sure it
16775 ;; cannot happen on headlines, though.
16776 ((save-excursion
16777 (skip-chars-backward "a-zA-Z0-9*")
16779 (and (bolp) (not (org-at-heading-p))))
16780 (cdlatex-tab) t)
16781 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16783 (defun org-cdlatex-underscore-caret (&optional arg)
16784 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16785 Revert to the normal definition outside of these fragments."
16786 (interactive "P")
16787 (if (org-inside-LaTeX-fragment-p)
16788 (call-interactively 'cdlatex-sub-superscript)
16789 (let (org-cdlatex-mode)
16790 (call-interactively (key-binding (vector last-input-event))))))
16792 (defun org-cdlatex-math-modify (&optional arg)
16793 "Execute `cdlatex-math-modify' in LaTeX fragments.
16794 Revert to the normal definition outside of these fragments."
16795 (interactive "P")
16796 (if (org-inside-LaTeX-fragment-p)
16797 (call-interactively 'cdlatex-math-modify)
16798 (let (org-cdlatex-mode)
16799 (call-interactively (key-binding (vector last-input-event))))))
16801 (defvar org-latex-fragment-image-overlays nil
16802 "List of overlays carrying the images of latex fragments.")
16803 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16805 (defun org-remove-latex-fragment-image-overlays ()
16806 "Remove all overlays with LaTeX fragment images in current buffer."
16807 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16808 (setq org-latex-fragment-image-overlays nil))
16810 (defun org-preview-latex-fragment (&optional subtree)
16811 "Preview the LaTeX fragment at point, or all locally or globally.
16812 If the cursor is in a LaTeX fragment, create the image and overlay
16813 it over the source code. If there is no fragment at point, display
16814 all fragments in the current text, from one headline to the next. With
16815 prefix SUBTREE, display all fragments in the current subtree. With a
16817 the cursor is before the first headline,
16818 display all fragments in the buffer.
16820 (interactive "P")
16821 (unless buffer-file-name
16822 (error "Can't preview LaTeX fragment in a non-file buffer"))
16823 (org-remove-latex-fragment-image-overlays)
16824 (save-excursion
16825 (save-restriction
16826 (let (beg end at msg)
16827 (cond
16828 ((or (equal subtree '(16))
16829 (not (save-excursion
16830 (re-search-backward org-outline-regexp-bol nil t))))
16831 (setq beg (point-min) end (point-max)
16832 msg "Creating images for buffer...%s"))
16833 ((equal subtree '(4))
16834 (org-back-to-heading)
16835 (setq beg (point) end (org-end-of-subtree t)
16836 msg "Creating images for subtree...%s"))
16837 (t
16838 (if (setq at (org-inside-LaTeX-fragment-p))
16839 (goto-char (max (point-min) (- (cdr at) 2)))
16840 (org-back-to-heading))
16841 (setq beg (point) end (progn (outline-next-heading) (point))
16842 msg (if at "Creating image...%s"
16843 "Creating images for entry...%s"))))
16844 (message msg "")
16845 (narrow-to-region beg end)
16846 (goto-char beg)
16847 (org-format-latex
16848 (concat "ltxpng/" (file-name-sans-extension
16849 (file-name-nondirectory
16850 buffer-file-name)))
16851 default-directory 'overlays msg at 'forbuffer 'dvipng)
16852 (message msg "done. Use `C-c C-c' to remove images.")))))
16854 (defvar org-latex-regexps
16856 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16859 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16863 "Regular expressions for matching embedded LaTeX.")
16865 (defvar org-export-have-math nil) ;; dynamic scoping
16866 (defun org-format-latex (prefix &optional dir overlays msg at
16867 forbuffer processing-type)
16868 "Replace LaTeX fragments with links to an image, and produce images.
16869 Some of the options can be changed using the variable
16870 `org-format-latex-options'."
16871 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16872 (let* ((prefixnodir (file-name-nondirectory prefix))
16873 (absprefix (expand-file-name prefix dir))
16874 (todir (file-name-directory absprefix))
16875 (opt org-format-latex-options)
16876 (matchers (plist-get opt :matchers))
16877 (re-list org-latex-regexps)
16878 (org-format-latex-header-extra
16879 (plist-get (org-infile-export-plist) :latex-header-extra))
16880 (cnt 0) txt hash link beg end re e checkdir
16881 executables-checked string
16882 m n block-type block linkfile movefile ov)
16883 ;; Check the different regular expressions
16884 (while (setq e (pop re-list))
16885 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16887 (when (member m matchers)
16888 (goto-char (point-min))
16889 (while (re-search-forward re nil t)
16890 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16891 (not (get-text-property (match-beginning n)
16892 'org-protected))
16893 (or (not overlays)
16894 (not (eq (get-char-property (match-beginning n)
16895 'org-overlay-type)
16896 'org-latex-overlay))))
16897 (setq org-export-have-math t)
16898 (cond
16899 ((eq processing-type 'verbatim)
16900 ;; Leave the text verbatim, just protect it
16901 (add-text-properties (match-beginning n) (match-end n)
16902 '(org-protected t)))
16903 ((eq processing-type 'mathjax)
16904 ;; Prepare for MathJax processing
16905 (setq string (match-string n))
16906 (if (member m '("$" "$1"))
16907 (save-excursion
16908 (delete-region (match-beginning n) (match-end n))
16909 (goto-char (match-beginning n))
16912 '(org-protected t))))
16913 (add-text-properties (match-beginning n) (match-end n)
16914 '(org-protected t))))
16915 ((eq processing-type 'dvipng)
16916 ;; Process to an image
16917 (setq txt (match-string n)
16918 beg (match-beginning n) end (match-end n)
16919 cnt (1+ cnt))
16920 (let (print-length print-level) ; make sure full list is printed
16921 (setq hash (sha1 (prin1-to-string
16922 (list org-format-latex-header
16923 org-format-latex-header-extra
16924 org-export-latex-default-packages-alist
16925 org-export-latex-packages-alist
16926 org-format-latex-options
16927 forbuffer txt)))
16928 linkfile (format "%s_%s.png" prefix hash)
16929 movefile (format "%s_%s.png" absprefix hash)))
16930 (setq link (concat block "[[file:" linkfile "]]" block))
16931 (if msg (message msg cnt))
16932 (goto-char beg)
16933 (unless checkdir ; make sure the directory exists
16934 (setq checkdir t)
16935 (or (file-directory-p todir) (make-directory todir t)))
16937 (unless executables-checked
16938 (org-check-external-command
16939 "latex" "needed to convert LaTeX fragments to images")
16940 (org-check-external-command
16941 "dvipng" "needed to convert LaTeX fragments to images")
16942 (setq executables-checked t))
16944 (unless (file-exists-p movefile)
16945 (org-create-formula-image
16946 txt movefile opt forbuffer))
16947 (if overlays
16948 (progn
16949 (mapc (lambda (o)
16950 (if (eq (overlay-get o 'org-overlay-type)
16951 'org-latex-overlay)
16952 (delete-overlay o)))
16953 (overlays-in beg end))
16954 (setq ov (make-overlay beg end))
16955 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16956 (if (featurep 'xemacs)
16957 (progn
16958 (overlay-put ov 'invisible t)
16959 (overlay-put
16960 ov 'end-glyph
16961 (make-glyph (vector 'png :file movefile))))
16962 (overlay-put
16963 ov 'display
16964 (list 'image :type 'png :file movefile :ascent 'center)))
16965 (push ov org-latex-fragment-image-overlays)
16966 (goto-char end))
16967 (delete-region beg end)
16968 (insert (org-add-props link
16969 (list 'org-latex-src
16970 (replace-regexp-in-string
16972 'org-latex-src-embed-type
16973 (if block-type 'paragraph 'character))))))
16974 ((eq processing-type 'mathml)
16975 ;; Process to MathML
16976 (unless executables-checked
16977 (unless (save-match-data (org-format-latex-mathml-available-p))
16978 (error "LaTeX to MathML converter not configured"))
16979 (setq executables-checked t))
16980 (setq txt (match-string n)
16981 beg (match-beginning n) end (match-end n)
16982 cnt (1+ cnt))
16983 (if msg (message msg cnt))
16984 (goto-char beg)
16985 (delete-region beg end)
16986 (insert (org-format-latex-as-mathml
16987 txt block-type prefix dir)))
16988 (t
16989 (error "Unknown conversion type %s for latex fragments"
16990 processing-type)))))))))
16992 (defun org-create-math-formula (latex-frag &optional mathml-file)
16993 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16994 Use `org-latex-to-mathml-convert-command'. If the conversion is
16996 elements otherwise return nil. When MATHML-FILE is specified,
16997 write the results in to that file. When invoked as an
16998 interactive command, prompt for LATEX-FRAG, with initial value
16999 set to the current active region and echo the results for user
17000 inspection."
17001 (interactive (list (let ((frag (when (region-active-p)
17002 (buffer-substring-no-properties
17003 (region-beginning) (region-end)))))
17004 (read-string "LaTeX Fragment: " frag nil frag))))
17005 (unless latex-frag (error "Invalid latex-frag"))
17006 (let* ((tmp-in-file (file-relative-name
17007 (make-temp-name (expand-file-name "ltxmathml-in"))))
17008 (ignore (write-region latex-frag nil tmp-in-file))
17009 (tmp-out-file (file-relative-name
17010 (make-temp-name (expand-file-name "ltxmathml-out"))))
17011 (cmd (format-spec
17012 org-latex-to-mathml-convert-command
17013 `((?j . ,(shell-quote-argument
17014 (expand-file-name org-latex-to-mathml-jar-file)))
17015 (?I . ,(shell-quote-argument tmp-in-file))
17016 (?o . ,(shell-quote-argument tmp-out-file)))))
17017 mathml shell-command-output)
17018 (when (org-called-interactively-p 'any)
17019 (unless (org-format-latex-mathml-available-p)
17020 (error "LaTeX to MathML converter not configured")))
17021 (message "Running %s" cmd)
17022 (setq shell-command-output (shell-command-to-string cmd))
17023 (setq mathml
17024 (when (file-readable-p tmp-out-file)
17025 (with-current-buffer (find-file-noselect tmp-out-file t)
17026 (goto-char (point-min))
17027 (when (re-search-forward
17028 (concat
17029 (regexp-quote
17032 (regexp-quote "</math>")) nil t)
17033 (prog1 (match-string 0) (kill-buffer))))))
17034 (cond
17035 (mathml
17036 (setq mathml
17038 (when mathml-file
17039 (write-region mathml nil mathml-file))
17040 (when (org-called-interactively-p 'any)
17041 (message mathml)))
17042 ((message "LaTeX to MathML conversion failed")
17043 (message shell-command-output)))
17044 (delete-file tmp-in-file)
17045 (when (file-exists-p tmp-out-file)
17046 (delete-file tmp-out-file))
17047 mathml))
17049 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17050 prefix &optional dir)
17051 "Use `org-create-math-formula' but check local cache first."
17052 (let* ((absprefix (expand-file-name prefix dir))
17053 (print-length nil) (print-level nil)
17054 (formula-id (concat
17055 "formula-"
17056 (sha1
17057 (prin1-to-string
17058 (list latex-frag
17059 org-latex-to-mathml-convert-command)))))
17060 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17061 (formula-cache-dir (file-name-directory formula-cache)))
17063 (unless (file-directory-p formula-cache-dir)
17064 (make-directory formula-cache-dir t))
17066 (unless (file-exists-p formula-cache)
17067 (org-create-math-formula latex-frag formula-cache))
17069 (if (file-exists-p formula-cache)
17070 ;; Successful conversion. Return the link to MathML file.
17071 (org-add-props
17072 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17074 'org-latex-src-embed-type (if latex-frag-type
17075 'paragraph 'character)))
17076 ;; Failed conversion. Return the LaTeX fragment verbatim
17077 (add-text-properties
17078 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17079 latex-frag)))
17081 ;; This function borrows from Ganesh Swami's latex2png.el
17082 (defun org-create-formula-image (string tofile options buffer)
17083 "This calls dvipng."
17084 (require 'org-latex)
17085 (let* ((tmpdir (if (featurep 'xemacs)
17086 (temp-directory)
17087 temporary-file-directory))
17088 (texfilebase (make-temp-name
17089 (expand-file-name "orgtex" tmpdir)))
17090 (texfile (concat texfilebase ".tex"))
17091 (dvifile (concat texfilebase ".dvi"))
17092 (pngfile (concat texfilebase ".png"))
17093 (fnh (if (featurep 'xemacs)
17094 (font-height (get-face-font 'default))
17095 (face-attribute 'default :height nil)))
17096 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17097 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17098 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17099 "Black"))
17100 (bg (or (plist-get options (if buffer :background :html-background))
17101 "Transparent")))
17102 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17103 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17104 (with-temp-file texfile
17105 (insert (org-splice-latex-header
17106 org-format-latex-header
17107 org-export-latex-default-packages-alist
17108 org-export-latex-packages-alist t
17109 org-format-latex-header-extra))
17111 (require 'org-latex)
17112 (org-export-latex-fix-inputenc))
17113 (let ((dir default-directory))
17114 (condition-case nil
17115 (progn
17116 (cd tmpdir)
17117 (call-process "latex" nil nil nil texfile))
17118 (error nil))
17119 (cd dir))
17120 (if (not (file-exists-p dvifile))
17121 (progn (message "Failed to create dvi file from %s" texfile) nil)
17122 (condition-case nil
17123 (call-process "dvipng" nil nil nil
17124 "-fg" fg "-bg" bg
17125 "-D" dpi
17126 ;;"-x" scale "-y" scale
17127 "-T" "tight"
17128 "-o" pngfile
17129 dvifile)
17130 (error nil))
17131 (if (not (file-exists-p pngfile))
17132 (if org-format-latex-signal-error
17133 (error "Failed to create png file from %s" texfile)
17134 (message "Failed to create png file from %s" texfile)
17135 nil)
17136 ;; Use the requested file name and clean up
17137 (copy-file pngfile tofile 'replace)
17138 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17139 (delete-file (concat texfilebase e)))
17140 pngfile))))
17142 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17143 "Fill a LaTeX header template TPL.
17144 In the template, the following place holders will be recognized:
17147 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17149 [NO-PACKAGES] do not include PKG
17150 [EXTRA] the string EXTRA
17151 [NO-EXTRA] do not include EXTRA
17153 For backward compatibility, if both the positive and the negative place
17155 assumed to be present at the end of the template.
17156 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17157 EXTRA is a string.
17158 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17159 (let (rpl (end ""))
17161 (setq rpl (if (or (match-end 1) (not def-pkg))
17162 "" (org-latex-packages-to-string def-pkg snippets-p t))
17163 tpl (replace-match rpl t t tpl))
17164 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17167 (setq rpl (if (or (match-end 1) (not pkg))
17168 "" (org-latex-packages-to-string pkg snippets-p t))
17169 tpl (replace-match rpl t t tpl))
17170 (if pkg (setq end
17172 (org-latex-packages-to-string pkg snippets-p)))))
17175 (setq rpl (if (or (match-end 1) (not extra))
17177 tpl (replace-match rpl t t tpl))
17183 tpl)))
17185 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17187 (setq pkg (mapconcat (lambda(p)
17188 (cond
17189 ((stringp p) p)
17190 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17191 (format "%% Package %s omitted" (cadr p)))
17192 ((equal "" (car p))
17194 (t
17196 (car p) (cadr p)))))
17197 pkg
17201 (defun org-dvipng-color (attr)
17202 "Return an rgb color specification for dvipng."
17203 (apply 'format "rgb %s %s %s"
17204 (mapcar 'org-normalize-color
17205 (color-values (face-attribute 'default attr nil)))))
17207 (defun org-normalize-color (value)
17208 "Return string to be used as color value for an RGB component."
17209 (format "%g" (/ value 65535.0)))
17211 ;; Image display
17214 (defvar org-inline-image-overlays nil)
17215 (make-variable-buffer-local 'org-inline-image-overlays)
17217 (defun org-toggle-inline-images (&optional include-linked)
17218 "Toggle the display of inline images.
17219 INCLUDE-LINKED is passed to `org-display-inline-images'."
17220 (interactive "P")
17221 (if org-inline-image-overlays
17222 (progn
17223 (org-remove-inline-images)
17224 (message "Inline image display turned off"))
17225 (org-display-inline-images include-linked)
17226 (if org-inline-image-overlays
17227 (message "%d images displayed inline"
17228 (length org-inline-image-overlays))
17229 (message "No images to display inline"))))
17231 (defun org-display-inline-images (&optional include-linked refresh beg end)
17232 "Display inline images.
17233 Normally only links without a description part are inlined, because this
17234 is how it will work for export. When INCLUDE-LINKED is set, also links
17235 with a description part will be inlined. This can be nice for a quick
17236 look at those images, but it does not reflect what exported files will look
17237 like.
17238 When REFRESH is set, refresh existing images between BEG and END.
17239 This will create new image displays only if necessary.
17240 BEG and END default to the buffer boundaries."
17241 (interactive "P")
17242 (unless refresh
17243 (org-remove-inline-images)
17244 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17245 (save-excursion
17246 (save-restriction
17247 (widen)
17248 (setq beg (or beg (point-min)) end (or end (point-max)))
17249 (goto-char (point-min))
17251 (substring (org-image-file-name-regexp) 0 -2)
17253 old file ov img)
17254 (while (re-search-forward re end t)
17255 (setq old (get-char-property-and-overlay (match-beginning 1)
17256 'org-image-overlay))
17257 (setq file (expand-file-name
17258 (concat (or (match-string 3) "") (match-string 4))))
17259 (when (file-exists-p file)
17260 (if (and (car-safe old) refresh)
17261 (image-refresh (overlay-get (cdr old) 'display))
17262 (setq img (save-match-data (create-image file)))
17263 (when img
17264 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17265 (overlay-put ov 'display img)
17266 (overlay-put ov 'face 'default)
17267 (overlay-put ov 'org-image-overlay t)
17268 (overlay-put ov 'modification-hooks
17269 (list 'org-display-inline-modification-hook))
17270 (push ov org-inline-image-overlays)))))))))
17272 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17273 "Remove inline-display overlay if a corresponding region is modified."
17274 (let ((inhibit-modification-hooks t))
17275 (when (and ov after)
17276 (delete ov org-inline-image-overlays)
17277 (delete-overlay ov))))
17279 (defun org-remove-inline-images ()
17280 "Remove inline display of images."
17281 (interactive)
17282 (mapc 'delete-overlay org-inline-image-overlays)
17283 (setq org-inline-image-overlays nil))
17285 ;;;; Key bindings
17287 ;; Outline functions from `outline-mode-prefix-map'
17288 ;; that can be remapped in Org:
17289 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17290 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17291 (define-key org-mode-map [remap outline-forward-same-level]
17292 'org-forward-same-level)
17293 (define-key org-mode-map [remap outline-backward-same-level]
17294 'org-backward-same-level)
17295 (define-key org-mode-map [remap show-branches]
17296 'org-kill-note-or-show-branches)
17297 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17298 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17299 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17301 ;; Outline functions from `outline-mode-prefix-map'
17302 ;; that can not be remapped in Org:
17303 ;; - the column "key binding" shows whether the Outline function is still
17304 ;; available in Org mode on the same key that it has been bound to in
17305 ;; Outline mode:
17306 ;; - "overridden": key used for a different functionality in Org mode
17307 ;; - else: key still bound to the same Outline function in Org mode
17308 ;; | Outline function | key binding | Org replacement |
17309 ;; |------------------------------------+-------------+-----------------------|
17310 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17311 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17312 ;; | `show-children' | `C-c C-i' | visibility cycling |
17313 ;; | `hide-subtree' | overridden | visibility cycling |
17314 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17315 ;; | `hide-body' | overridden | no replacement |
17316 ;; | `show-all' | overridden | no replacement |
17317 ;; | `hide-entry' | overridden | visibility cycling |
17318 ;; | `show-entry' | overridden | no replacement |
17319 ;; | `hide-leaves' | overridden | no replacement |
17320 ;; | `hide-sublevels' | overridden | no replacement |
17321 ;; | `hide-other' | overridden | no replacement |
17322 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17323 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17325 ;; Make `C-c C-x' a prefix key
17326 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17328 ;; TAB key with modifiers
17329 (org-defkey org-mode-map "\C-i" 'org-cycle)
17330 (org-defkey org-mode-map [(tab)] 'org-cycle)
17331 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17332 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17334 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17335 ;; The following line is necessary under Suse GNU/Linux
17336 (unless (featurep 'xemacs)
17337 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17338 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17339 (define-key org-mode-map [backtab] 'org-shifttab)
17341 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17342 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17343 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17345 ;; Cursor keys with modifiers
17346 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17347 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17348 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17349 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17351 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17352 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17353 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17354 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17356 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17357 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17358 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17359 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17361 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17362 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17363 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17364 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17366 ;; Babel keys
17367 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17368 (mapc (lambda (pair)
17369 (define-key org-babel-map (car pair) (cdr pair)))
17370 org-babel-key-bindings)
17372 ;;; Extra keys for tty access.
17373 ;; We only set them when really needed because otherwise the
17374 ;; menus don't show the simple keys
17376 (when (or org-use-extra-keys
17377 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17378 (not window-system))
17379 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17380 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17381 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17382 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17383 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17384 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17385 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17386 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17387 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17388 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17389 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17390 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17391 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17392 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17393 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17394 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17395 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17396 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17397 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17398 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17399 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17400 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17401 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17402 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17403 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17404 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17405 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17406 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17408 ;; All the other keys
17410 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17411 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17412 (if (boundp 'narrow-map)
17413 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17414 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17415 (if (boundp 'narrow-map)
17416 (org-defkey narrow-map "b" 'org-narrow-to-block)
17417 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17418 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17419 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17420 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17421 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17422 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17423 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17424 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17425 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17426 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17427 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17428 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17429 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17430 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17431 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17432 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17433 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17434 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17436 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17437 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17438 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17439 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17440 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17441 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17442 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17443 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17444 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17445 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17446 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17447 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17448 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17449 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17450 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17451 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17452 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17453 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17454 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17455 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17457 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17458 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17459 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17460 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17461 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17462 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17463 (org-defkey org-mode-map "\C-c^" 'org-sort)
17464 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17465 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17466 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17467 (org-defkey org-mode-map "\C-m" 'org-return)
17468 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17469 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17470 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17471 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17472 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17473 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17474 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17475 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17476 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17477 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17478 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17479 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17480 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17481 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17482 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17483 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17484 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17485 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17486 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17487 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17488 (org-defkey org-mode-map "\C-c\C-@" 'org-mark-list)
17489 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17490 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17492 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17493 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17494 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17495 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17497 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17498 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17499 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17500 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17501 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17502 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17503 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17504 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17505 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17506 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17508 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17509 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17510 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17511 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17512 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17513 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17514 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17516 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17517 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17518 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17519 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17520 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17522 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17524 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17526 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17527 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17529 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17532 (when (featurep 'xemacs)
17533 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17536 (defconst org-speed-commands-default
17537 '(
17538 ("Outline Navigation")
17539 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17540 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17541 ("f" . (org-speed-move-safe 'org-forward-same-level))
17542 ("b" . (org-speed-move-safe 'org-backward-same-level))
17543 ("u" . (org-speed-move-safe 'outline-up-heading))
17544 ("j" . org-goto)
17545 ("g" . (org-refile t))
17546 ("Outline Visibility")
17547 ("c" . org-cycle)
17548 ("C" . org-shifttab)
17549 (" " . org-display-outline-path)
17550 ("Outline Structure Editing")
17551 ("U" . org-shiftmetaup)
17552 ("D" . org-shiftmetadown)
17553 ("r" . org-metaright)
17554 ("l" . org-metaleft)
17555 ("R" . org-shiftmetaright)
17556 ("L" . org-shiftmetaleft)
17557 ("i" . (progn (forward-char 1) (call-interactively
17558 'org-insert-heading-respect-content)))
17559 ("^" . org-sort)
17560 ("w" . org-refile)
17561 ("a" . org-archive-subtree-default-with-confirmation)
17562 ("." . org-mark-subtree)
17563 ("Clock Commands")
17564 ("I" . org-clock-in)
17565 ("O" . org-clock-out)
17566 ("Meta Data Editing")
17567 ("t" . org-todo)
17568 ("0" . (org-priority ?\ ))
17569 ("1" . (org-priority ?A))
17570 ("2" . (org-priority ?B))
17571 ("3" . (org-priority ?C))
17572 (";" . org-set-tags-command)
17573 ("e" . org-set-effort)
17574 ("Agenda Views etc")
17575 ("v" . org-agenda)
17576 ("/" . org-sparse-tree)
17577 ("Misc")
17578 ("o" . org-open-at-point)
17579 ("?" . org-speed-command-help)
17580 ("<" . (org-agenda-set-restriction-lock 'subtree))
17581 (">" . (org-agenda-remove-restriction-lock))
17582 )
17583 "The default speed commands.")
17585 (defun org-print-speed-command (e)
17586 (if (> (length (car e)) 1)
17587 (progn
17589 (princ (car e))
17591 (princ (make-string (length (car e)) ?-))
17593 (princ (car e))
17594 (princ " ")
17595 (if (symbolp (cdr e))
17596 (princ (symbol-name (cdr e)))
17597 (prin1 (cdr e)))
17600 (defun org-speed-command-help ()
17601 "Show the available speed commands."
17602 (interactive)
17603 (if (not org-use-speed-commands)
17604 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17605 (with-output-to-temp-buffer "*Help*"
17607 (mapc 'org-print-speed-command org-speed-commands-user)
17610 (mapc 'org-print-speed-command org-speed-commands-default))
17611 (with-current-buffer "*Help*"
17612 (setq truncate-lines t))))
17614 (defun org-speed-move-safe (cmd)
17615 "Execute CMD, but make sure that the cursor always ends up in a headline.
17616 If not, return to the original position and throw an error."
17617 (interactive)
17618 (let ((pos (point)))
17619 (call-interactively cmd)
17620 (unless (and (bolp) (org-at-heading-p))
17621 (goto-char pos)
17622 (error "Boundary reached while executing %s" cmd))))
17624 (defvar org-self-insert-command-undo-counter 0)
17626 (defvar org-table-auto-blank-field) ; defined in org-table.el
17627 (defvar org-speed-command nil)
17629 (defun org-speed-command-default-hook (keys)
17630 "Hook for activating single-letter speed commands.
17631 `org-speed-commands-default' specifies a minimal command set.
17632 Use `org-speed-commands-user' for further customization."
17633 (when (or (and (bolp) (looking-at org-outline-regexp))
17634 (and (functionp org-use-speed-commands)
17635 (funcall org-use-speed-commands)))
17636 (cdr (assoc keys (append org-speed-commands-user
17637 org-speed-commands-default)))))
17639 (defun org-babel-speed-command-hook (keys)
17640 "Hook for activating single-letter code block commands."
17641 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17642 (cdr (assoc keys org-babel-key-bindings))))
17644 (defcustom org-speed-command-hook
17645 '(org-speed-command-default-hook org-babel-speed-command-hook)
17646 "Hook for activating speed commands at strategic locations.
17647 Hook functions are called in sequence until a valid handler is
17648 found.
17650 Each hook takes a single argument, a user-pressed command key
17651 which is also a `self-insert-command' from the global map.
17653 Within the hook, examine the cursor position and the command key
17654 and return nil or a valid handler as appropriate. Handler could
17655 be one of an interactive command, a function, or a form.
17657 Set `org-use-speed-commands' to non-nil value to enable this
17658 hook. The default setting is `org-speed-command-default-hook'."
17659 :group 'org-structure
17660 :version "24.1"
17661 :type 'hook)
17663 (defun org-self-insert-command (N)
17664 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17665 If the cursor is in a table looking at whitespace, the whitespace is
17666 overwritten, and the table is not marked as requiring realignment."
17667 (interactive "p")
17668 (org-check-before-invisible-edit 'insert)
17669 (cond
17670 ((and org-use-speed-commands
17671 (setq org-speed-command
17672 (run-hook-with-args-until-success
17673 'org-speed-command-hook (this-command-keys))))
17674 (cond
17675 ((commandp org-speed-command)
17676 (setq this-command org-speed-command)
17677 (call-interactively org-speed-command))
17678 ((functionp org-speed-command)
17679 (funcall org-speed-command))
17680 ((and org-speed-command (listp org-speed-command))
17681 (eval org-speed-command))
17682 (t (let (org-use-speed-commands)
17683 (call-interactively 'org-self-insert-command)))))
17684 ((and
17685 (org-table-p)
17686 (progn
17687 ;; check if we blank the field, and if that triggers align
17688 (and (featurep 'org-table) org-table-auto-blank-field
17689 (member last-command
17690 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17692 ;; got extra space, this field does not determine column width
17693 (let (org-table-may-need-update) (org-table-blank-field))
17694 ;; no extra space, this field may determine column width
17695 (org-table-blank-field)))
17696 t)
17697 (eq N 1)
17699 (let (org-table-may-need-update)
17700 (goto-char (1- (match-end 0)))
17701 (delete-char -1)
17702 (goto-char (match-beginning 0))
17703 (self-insert-command N)))
17704 (t
17705 (setq org-table-may-need-update t)
17706 (self-insert-command N)
17707 (org-fix-tags-on-the-fly)
17708 (if org-self-insert-cluster-for-undo
17709 (if (not (eq last-command 'org-self-insert-command))
17710 (setq org-self-insert-command-undo-counter 1)
17711 (if (>= org-self-insert-command-undo-counter 20)
17712 (setq org-self-insert-command-undo-counter 1)
17713 (and (> org-self-insert-command-undo-counter 0)
17714 buffer-undo-list (listp buffer-undo-list)
17715 (not (cadr buffer-undo-list)) ; remove nil entry
17716 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17717 (setq org-self-insert-command-undo-counter
17718 (1+ org-self-insert-command-undo-counter))))))))
17720 (defun org-check-before-invisible-edit (kind)
17721 "Check is editing if kind KIND would be dangerous with invisible text around.
17722 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17723 ;; First, try to get out of here as quickly as possible, to reduce overhead
17724 (if (and org-catch-invisible-edits
17725 (or (not (boundp 'visible-mode)) (not visible-mode))
17726 (or (get-char-property (point) 'invisible)
17727 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17728 ;; OK, we need to take a closer look
17729 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17730 (invisible-before-point (if (bobp) nil (get-char-property
17731 (1- (point)) 'invisible)))
17732 (border-and-ok-direction
17733 (or
17734 ;; Check if we are acting predictably before invisible text
17735 (and invisible-at-point (not invisible-before-point)
17736 (memq kind '(insert delete-backward)))
17737 ;; Check if we are acting predictably after invisible text
17738 ;; This works not well, and I have turned it off. It seems
17739 ;; better to always show and stop after invisible text.
17740 ;; (and (not invisible-at-point) invisible-before-point
17741 ;; (memq kind '(insert delete)))
17742 )))
17744 (when (or (memq invisible-at-point '(outline org-hide-block))
17745 (memq invisible-before-point '(outline org-hide-block)))
17746 (if (eq org-catch-invisible-edits 'error)
17747 (error "Editing in invisible areas is prohibited - make visible first"))
17748 ;; Make the area visible
17749 (save-excursion
17750 (if invisible-before-point
17751 (goto-char (previous-single-char-property-change
17752 (point) 'invisible)))
17753 (org-cycle))
17754 (cond
17755 ((eq org-catch-invisible-edits 'show)
17756 ;; That's it, we do the edit after showing
17757 (message
17758 "Unfolding invisible region around point before editing")
17759 (sit-for 1))
17760 ((and (eq org-catch-invisible-edits 'smart)
17761 border-and-ok-direction)
17762 (message "Unfolding invisible region around point before editing"))
17763 (t
17764 ;; Don't do the edit, make the user repeat it in full visibility
17765 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17767 (defun org-fix-tags-on-the-fly ()
17768 (when (and (equal (char-after (point-at-bol)) ?*)
17769 (org-at-heading-p))
17770 (org-align-tags-here org-tags-column)))
17772 (defun org-delete-backward-char (N)
17773 "Like `delete-backward-char', insert whitespace at field end in tables.
17774 When deleting backwards, in tables this function will insert whitespace in
17776 still be marked for re-alignment if the field did fill the entire column,
17777 because, in this case the deletion might narrow the column."
17778 (interactive "p")
17779 (org-check-before-invisible-edit 'delete-backward)
17780 (if (and (org-table-p)
17781 (eq N 1)
17782 (string-match "|" (buffer-substring (point-at-bol) (point)))
17783 (looking-at ".*?|"))
17784 (let ((pos (point))
17786 (c org-table-may-need-update))
17787 (backward-delete-char N)
17788 (if (not overwrite-mode)
17789 (progn
17790 (skip-chars-forward "^|")
17791 (insert " ")
17792 (goto-char (1- pos))))
17793 ;; noalign: if there were two spaces at the end, this field
17794 ;; does not determine the width of the column.
17795 (if noalign (setq org-table-may-need-update c)))
17796 (backward-delete-char N)
17797 (org-fix-tags-on-the-fly)))
17799 (defun org-delete-char (N)
17800 "Like `delete-char', but insert whitespace at field end in tables.
17801 When deleting characters, in tables this function will insert whitespace in
17803 still be marked for re-alignment if the field did fill the entire column,
17804 because, in this case the deletion might narrow the column."
17805 (interactive "p")
17806 (org-check-before-invisible-edit 'delete)
17807 (if (and (org-table-p)
17808 (not (bolp))
17809 (not (= (char-after) ?|))
17810 (eq N 1))
17811 (if (looking-at ".*?|")
17812 (let ((pos (point))
17814 (c org-table-may-need-update))
17815 (replace-match (concat
17816 (substring (match-string 0) 1 -1)
17817 " |"))
17818 (goto-char pos)
17819 ;; noalign: if there were two spaces at the end, this field
17820 ;; does not determine the width of the column.
17821 (if noalign (setq org-table-may-need-update c)))
17822 (delete-char N))
17823 (delete-char N)
17824 (org-fix-tags-on-the-fly)))
17826 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17827 (put 'org-self-insert-command 'delete-selection t)
17828 (put 'orgtbl-self-insert-command 'delete-selection t)
17829 (put 'org-delete-char 'delete-selection 'supersede)
17830 (put 'org-delete-backward-char 'delete-selection 'supersede)
17831 (put 'org-yank 'delete-selection 'yank)
17833 ;; Make `flyspell-mode' delay after some commands
17834 (put 'org-self-insert-command 'flyspell-delayed t)
17835 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17836 (put 'org-delete-char 'flyspell-delayed t)
17837 (put 'org-delete-backward-char 'flyspell-delayed t)
17839 ;; Make pabbrev-mode expand after org-mode commands
17840 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17841 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17843 ;; How to do this: Measure non-white length of current string
17844 ;; If equal to column width, we should realign.
17846 (defun org-remap (map &rest commands)
17847 "In MAP, remap the functions given in COMMANDS.
17848 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17849 (let (new old)
17850 (while commands
17851 (setq old (pop commands) new (pop commands))
17852 (if (fboundp 'command-remapping)
17853 (org-defkey map (vector 'remap old) new)
17854 (substitute-key-definition old new map global-map)))))
17856 (when (eq org-enable-table-editor 'optimized)
17857 ;; If the user wants maximum table support, we need to hijack
17858 ;; some standard editing functions
17859 (org-remap org-mode-map
17860 'self-insert-command 'org-self-insert-command
17861 'delete-char 'org-delete-char
17862 'delete-backward-char 'org-delete-backward-char)
17863 (org-defkey org-mode-map "|" 'org-force-self-insert))
17865 (defvar org-ctrl-c-ctrl-c-hook nil
17866 "Hook for functions attaching themselves to `C-c C-c'.
17868 This can be used to add additional functionality to the C-c C-c
17869 key which executes context-dependent commands. This hook is run
17870 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17871 run after the last test.
17873 Each function will be called with no arguments. The function
17874 must check if the context is appropriate for it to act. If yes,
17875 it should do its thing and then return a non-nil value. If the
17876 context is wrong, just do nothing and return nil.")
17878 (defvar org-ctrl-c-ctrl-c-final-hook nil
17879 "Hook for functions attaching themselves to `C-c C-c'.
17881 This can be used to add additional functionality to the C-c C-c
17882 key which executes context-dependent commands. This hook is run
17883 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17884 before the first test.
17886 Each function will be called with no arguments. The function
17887 must check if the context is appropriate for it to act. If yes,
17888 it should do its thing and then return a non-nil value. If the
17889 context is wrong, just do nothing and return nil.")
17891 (defvar org-tab-first-hook nil
17892 "Hook for functions to attach themselves to TAB.
17893 See `org-ctrl-c-ctrl-c-hook' for more information.
17894 This hook runs as the first action when TAB is pressed, even before
17895 `org-cycle' messes around with the `outline-regexp' to cater for
17896 inline tasks and plain list item folding.
17897 If any function in this hook returns t, any other actions that
17898 would have been caused by TAB (such as table field motion or visibility
17899 cycling) will not occur.")
17901 (defvar org-tab-after-check-for-table-hook nil
17902 "Hook for functions to attach themselves to TAB.
17903 See `org-ctrl-c-ctrl-c-hook' for more information.
17904 This hook runs after it has been established that the cursor is not in a
17905 table, but before checking if the cursor is in a headline or if global cycling
17906 should be done.
17907 If any function in this hook returns t, not other actions like visibility
17908 cycling will be done.")
17910 (defvar org-tab-after-check-for-cycling-hook nil
17911 "Hook for functions to attach themselves to TAB.
17912 See `org-ctrl-c-ctrl-c-hook' for more information.
17913 This hook runs after it has been established that not table field motion and
17914 not visibility should be done because of current context. This is probably
17915 the place where a package like yasnippets can hook in.")
17917 (defvar org-tab-before-tab-emulation-hook nil
17918 "Hook for functions to attach themselves to TAB.
17919 See `org-ctrl-c-ctrl-c-hook' for more information.
17920 This hook runs after every other options for TAB have been exhausted, but
17923 (defvar org-metaleft-hook nil
17924 "Hook for functions attaching themselves to `M-left'.
17925 See `org-ctrl-c-ctrl-c-hook' for more information.")
17926 (defvar org-metaright-hook nil
17927 "Hook for functions attaching themselves to `M-right'.
17928 See `org-ctrl-c-ctrl-c-hook' for more information.")
17929 (defvar org-metaup-hook nil
17930 "Hook for functions attaching themselves to `M-up'.
17931 See `org-ctrl-c-ctrl-c-hook' for more information.")
17932 (defvar org-metadown-hook nil
17933 "Hook for functions attaching themselves to `M-down'.
17934 See `org-ctrl-c-ctrl-c-hook' for more information.")
17935 (defvar org-shiftmetaleft-hook nil
17936 "Hook for functions attaching themselves to `M-S-left'.
17937 See `org-ctrl-c-ctrl-c-hook' for more information.")
17938 (defvar org-shiftmetaright-hook nil
17939 "Hook for functions attaching themselves to `M-S-right'.
17940 See `org-ctrl-c-ctrl-c-hook' for more information.")
17941 (defvar org-shiftmetaup-hook nil
17942 "Hook for functions attaching themselves to `M-S-up'.
17943 See `org-ctrl-c-ctrl-c-hook' for more information.")
17944 (defvar org-shiftmetadown-hook nil
17945 "Hook for functions attaching themselves to `M-S-down'.
17946 See `org-ctrl-c-ctrl-c-hook' for more information.")
17947 (defvar org-metareturn-hook nil
17948 "Hook for functions attaching themselves to `M-RET'.
17949 See `org-ctrl-c-ctrl-c-hook' for more information.")
17950 (defvar org-shiftup-hook nil
17951 "Hook for functions attaching themselves to `S-up'.
17952 See `org-ctrl-c-ctrl-c-hook' for more information.")
17953 (defvar org-shiftup-final-hook nil
17954 "Hook for functions attaching themselves to `S-up'.
17955 This one runs after all other options except shift-select have been excluded.
17956 See `org-ctrl-c-ctrl-c-hook' for more information.")
17957 (defvar org-shiftdown-hook nil
17958 "Hook for functions attaching themselves to `S-down'.
17959 See `org-ctrl-c-ctrl-c-hook' for more information.")
17960 (defvar org-shiftdown-final-hook nil
17961 "Hook for functions attaching themselves to `S-down'.
17962 This one runs after all other options except shift-select have been excluded.
17963 See `org-ctrl-c-ctrl-c-hook' for more information.")
17964 (defvar org-shiftleft-hook nil
17965 "Hook for functions attaching themselves to `S-left'.
17966 See `org-ctrl-c-ctrl-c-hook' for more information.")
17967 (defvar org-shiftleft-final-hook nil
17968 "Hook for functions attaching themselves to `S-left'.
17969 This one runs after all other options except shift-select have been excluded.
17970 See `org-ctrl-c-ctrl-c-hook' for more information.")
17971 (defvar org-shiftright-hook nil
17972 "Hook for functions attaching themselves to `S-right'.
17973 See `org-ctrl-c-ctrl-c-hook' for more information.")
17974 (defvar org-shiftright-final-hook nil
17975 "Hook for functions attaching themselves to `S-right'.
17976 This one runs after all other options except shift-select have been excluded.
17977 See `org-ctrl-c-ctrl-c-hook' for more information.")
17979 (defun org-modifier-cursor-error ()
17980 "Throw an error, a modified cursor command was applied in wrong context."
17981 (error "This command is active in special context like tables, headlines or items"))
17983 (defun org-shiftselect-error ()
17984 "Throw an error because Shift-Cursor command was applied in wrong context."
17985 (if (and (boundp 'shift-select-mode) shift-select-mode)
17986 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17987 (error "This command works only in special context like headlines or timestamps")))
17989 (defun org-call-for-shift-select (cmd)
17990 (let ((this-command-keys-shift-translated t))
17991 (call-interactively cmd)))
17993 (defun org-shifttab (&optional arg)
17994 "Global visibility cycling or move to previous table field.
17995 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17996 on context.
17997 See the individual commands for more information."
17998 (interactive "P")
17999 (cond
18000 ((org-at-table-p) (call-interactively 'org-table-previous-field))
18001 ((integerp arg)
18002 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18003 (message "Content view to level: %d" arg)
18004 (org-content (prefix-numeric-value arg2))
18005 (setq org-cycle-global-status 'overview)))
18006 (t (call-interactively 'org-global-cycle))))
18008 (defun org-shiftmetaleft ()
18009 "Promote subtree or delete table column.
18010 Calls `org-promote-subtree', `org-outdent-item',
18011 or `org-table-delete-column', depending on context.
18012 See the individual commands for more information."
18013 (interactive)
18014 (cond
18015 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18016 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18017 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18018 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
18019 (t (org-modifier-cursor-error))))
18021 (defun org-shiftmetaright ()
18022 "Demote subtree or insert table column.
18023 Calls `org-demote-subtree', `org-indent-item',
18024 or `org-table-insert-column', depending on context.
18025 See the individual commands for more information."
18026 (interactive)
18027 (cond
18028 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18029 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18030 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18031 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
18032 (t (org-modifier-cursor-error))))
18034 (defun org-shiftmetaup (&optional arg)
18035 "Move subtree up or kill table row.
18036 Calls `org-move-subtree-up' or `org-table-kill-row' or
18037 `org-move-item-up' depending on context. See the individual commands
18038 for more information."
18039 (interactive "P")
18040 (cond
18041 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18042 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18043 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18044 ((org-at-item-p) (call-interactively 'org-move-item-up))
18045 (t (org-modifier-cursor-error))))
18047 (defun org-shiftmetadown (&optional arg)
18048 "Move subtree down or insert table row.
18049 Calls `org-move-subtree-down' or `org-table-insert-row' or
18050 `org-move-item-down', depending on context. See the individual
18051 commands for more information."
18052 (interactive "P")
18053 (cond
18054 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18055 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18056 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18057 ((org-at-item-p) (call-interactively 'org-move-item-down))
18058 (t (org-modifier-cursor-error))))
18060 (defsubst org-hidden-tree-error ()
18061 (error
18062 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18064 (defun org-metaleft (&optional arg)
18065 "Promote heading or move table column to left.
18066 Calls `org-do-promote' or `org-table-move-column', depending on context.
18067 With no specific context, calls the Emacs default `backward-word'.
18068 See the individual commands for more information."
18069 (interactive "P")
18070 (cond
18071 ((run-hook-with-args-until-success 'org-metaleft-hook))
18072 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18073 ((org-with-limited-levels
18074 (or (org-at-heading-p)
18075 (and (org-region-active-p)
18076 (save-excursion
18077 (goto-char (region-beginning))
18078 (org-at-heading-p)))))
18079 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18080 (call-interactively 'org-do-promote))
18081 ;; At an inline task.
18082 ((org-at-heading-p)
18083 (call-interactively 'org-inlinetask-promote))
18084 ((or (org-at-item-p)
18085 (and (org-region-active-p)
18086 (save-excursion
18087 (goto-char (region-beginning))
18088 (org-at-item-p))))
18089 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18090 (call-interactively 'org-outdent-item))
18091 (t (call-interactively 'backward-word))))
18093 (defun org-metaright (&optional arg)
18094 "Demote a subtree, a list item or move table column to right.
18095 In front of a drawer or a block keyword, indent it correctly.
18096 With no specific context, calls the Emacs default `forward-word'.
18097 See the individual commands for more information."
18098 (interactive "P")
18099 (cond
18100 ((run-hook-with-args-until-success 'org-metaright-hook))
18101 ((org-at-table-p) (call-interactively 'org-table-move-column))
18102 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18103 ((org-at-block-p) (call-interactively 'org-indent-block))
18104 ((org-with-limited-levels
18105 (or (org-at-heading-p)
18106 (and (org-region-active-p)
18107 (save-excursion
18108 (goto-char (region-beginning))
18109 (org-at-heading-p)))))
18110 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18111 (call-interactively 'org-do-demote))
18112 ;; At an inline task.
18113 ((org-at-heading-p)
18114 (call-interactively 'org-inlinetask-demote))
18115 ((or (org-at-item-p)
18116 (and (org-region-active-p)
18117 (save-excursion
18118 (goto-char (region-beginning))
18119 (org-at-item-p))))
18120 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18121 (call-interactively 'org-indent-item))
18122 (t (call-interactively 'forward-word))))
18124 (defun org-check-for-hidden (what)
18125 "Check if there are hidden headlines/items in the current visual line.
18126 WHAT can be either `headlines' or `items'. If the current line is
18127 an outline or item heading and it has a folded subtree below it,
18128 this function returns t, nil otherwise."
18129 (let ((re (cond
18130 ((eq what 'headlines) org-outline-regexp-bol)
18131 ((eq what 'items) (org-item-beginning-re))
18132 (t (error "This should not happen"))))
18133 beg end)
18134 (save-excursion
18135 (catch 'exit
18136 (unless (org-region-active-p)
18137 (setq beg (point-at-bol))
18138 (beginning-of-line 2)
18139 (while (and (not (eobp)) ;; this is like `next-line'
18140 (get-char-property (1- (point)) 'invisible))
18141 (beginning-of-line 2))
18142 (setq end (point))
18143 (goto-char beg)
18144 (goto-char (point-at-eol))
18145 (setq end (max end (point)))
18146 (while (re-search-forward re end t)
18147 (if (get-char-property (match-beginning 0) 'invisible)
18148 (throw 'exit t))))
18149 nil))))
18151 (defun org-metaup (&optional arg)
18152 "Move subtree up or move table row up.
18153 Calls `org-move-subtree-up' or `org-table-move-row' or
18154 `org-move-item-up', depending on context. See the individual commands
18155 for more information."
18156 (interactive "P")
18157 (cond
18158 ((run-hook-with-args-until-success 'org-metaup-hook))
18159 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18160 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18161 ((org-at-item-p) (call-interactively 'org-move-item-up))
18162 (t (transpose-lines 1) (beginning-of-line -1))))
18164 (defun org-metadown (&optional arg)
18165 "Move subtree down or move table row down.
18166 Calls `org-move-subtree-down' or `org-table-move-row' or
18167 `org-move-item-down', depending on context. See the individual
18168 commands for more information."
18169 (interactive "P")
18170 (cond
18171 ((run-hook-with-args-until-success 'org-metadown-hook))
18172 ((org-at-table-p) (call-interactively 'org-table-move-row))
18173 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18174 ((org-at-item-p) (call-interactively 'org-move-item-down))
18175 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18177 (defun org-shiftup (&optional arg)
18178 "Increase item in timestamp or increase priority of current headline.
18179 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18180 depending on context. See the individual commands for more information."
18181 (interactive "P")
18182 (cond
18183 ((run-hook-with-args-until-success 'org-shiftup-hook))
18184 ((and org-support-shift-select (org-region-active-p))
18185 (org-call-for-shift-select 'previous-line))
18186 ((org-at-timestamp-p t)
18187 (call-interactively (if org-edit-timestamp-down-means-later
18188 'org-timestamp-down 'org-timestamp-up)))
18189 ((and (not (eq org-support-shift-select 'always))
18190 org-enable-priority-commands
18191 (org-at-heading-p))
18192 (call-interactively 'org-priority-up))
18193 ((and (not org-support-shift-select) (org-at-item-p))
18194 (call-interactively 'org-previous-item))
18195 ((org-clocktable-try-shift 'up arg))
18196 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18197 (org-support-shift-select
18198 (org-call-for-shift-select 'previous-line))
18199 (t (org-shiftselect-error))))
18201 (defun org-shiftdown (&optional arg)
18202 "Decrease item in timestamp or decrease priority of current headline.
18203 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18204 depending on context. See the individual commands for more information."
18205 (interactive "P")
18206 (cond
18207 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18208 ((and org-support-shift-select (org-region-active-p))
18209 (org-call-for-shift-select 'next-line))
18210 ((org-at-timestamp-p t)
18211 (call-interactively (if org-edit-timestamp-down-means-later
18212 'org-timestamp-up 'org-timestamp-down)))
18213 ((and (not (eq org-support-shift-select 'always))
18214 org-enable-priority-commands
18215 (org-at-heading-p))
18216 (call-interactively 'org-priority-down))
18217 ((and (not org-support-shift-select) (org-at-item-p))
18218 (call-interactively 'org-next-item))
18219 ((org-clocktable-try-shift 'down arg))
18220 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18221 (org-support-shift-select
18222 (org-call-for-shift-select 'next-line))
18223 (t (org-shiftselect-error))))
18225 (defun org-shiftright (&optional arg)
18226 "Cycle the thing at point or in the current line, depending on context.
18227 Depending on context, this does one of the following:
18229 - switch a timestamp at point one day into the future
18230 - on a headline, switch to the next TODO keyword.
18231 - on an item, switch entire list to the next bullet type
18232 - on a property line, switch to the next allowed value
18233 - on a clocktable definition line, move time block into the future"
18234 (interactive "P")
18235 (cond
18236 ((run-hook-with-args-until-success 'org-shiftright-hook))
18237 ((and org-support-shift-select (org-region-active-p))
18238 (org-call-for-shift-select 'forward-char))
18239 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18240 ((and (not (eq org-support-shift-select 'always))
18241 (org-at-heading-p))
18242 (let ((org-inhibit-logging
18243 (not org-treat-S-cursor-todo-selection-as-state-change))
18244 (org-inhibit-blocking
18245 (not org-treat-S-cursor-todo-selection-as-state-change)))
18246 (org-call-with-arg 'org-todo 'right)))
18247 ((or (and org-support-shift-select
18248 (not (eq org-support-shift-select 'always))
18249 (org-at-item-bullet-p))
18250 (and (not org-support-shift-select) (org-at-item-p)))
18251 (org-call-with-arg 'org-cycle-list-bullet nil))
18252 ((and (not (eq org-support-shift-select 'always))
18253 (org-at-property-p))
18254 (call-interactively 'org-property-next-allowed-value))
18255 ((org-clocktable-try-shift 'right arg))
18256 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18257 (org-support-shift-select
18258 (org-call-for-shift-select 'forward-char))
18259 (t (org-shiftselect-error))))
18261 (defun org-shiftleft (&optional arg)
18262 "Cycle the thing at point or in the current line, depending on context.
18263 Depending on context, this does one of the following:
18265 - switch a timestamp at point one day into the past
18266 - on a headline, switch to the previous TODO keyword.
18267 - on an item, switch entire list to the previous bullet type
18268 - on a property line, switch to the previous allowed value
18269 - on a clocktable definition line, move time block into the past"
18270 (interactive "P")
18271 (cond
18272 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18273 ((and org-support-shift-select (org-region-active-p))
18274 (org-call-for-shift-select 'backward-char))
18275 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18276 ((and (not (eq org-support-shift-select 'always))
18277 (org-at-heading-p))
18278 (let ((org-inhibit-logging
18279 (not org-treat-S-cursor-todo-selection-as-state-change))
18280 (org-inhibit-blocking
18281 (not org-treat-S-cursor-todo-selection-as-state-change)))
18282 (org-call-with-arg 'org-todo 'left)))
18283 ((or (and org-support-shift-select
18284 (not (eq org-support-shift-select 'always))
18285 (org-at-item-bullet-p))
18286 (and (not org-support-shift-select) (org-at-item-p)))
18287 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18288 ((and (not (eq org-support-shift-select 'always))
18289 (org-at-property-p))
18290 (call-interactively 'org-property-previous-allowed-value))
18291 ((org-clocktable-try-shift 'left arg))
18292 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18293 (org-support-shift-select
18294 (org-call-for-shift-select 'backward-char))
18295 (t (org-shiftselect-error))))
18297 (defun org-shiftcontrolright ()
18298 "Switch to next TODO set."
18299 (interactive)
18300 (cond
18301 ((and org-support-shift-select (org-region-active-p))
18302 (org-call-for-shift-select 'forward-word))
18303 ((and (not (eq org-support-shift-select 'always))
18304 (org-at-heading-p))
18305 (org-call-with-arg 'org-todo 'nextset))
18306 (org-support-shift-select
18307 (org-call-for-shift-select 'forward-word))
18308 (t (org-shiftselect-error))))
18310 (defun org-shiftcontrolleft ()
18311 "Switch to previous TODO set."
18312 (interactive)
18313 (cond
18314 ((and org-support-shift-select (org-region-active-p))
18315 (org-call-for-shift-select 'backward-word))
18316 ((and (not (eq org-support-shift-select 'always))
18317 (org-at-heading-p))
18318 (org-call-with-arg 'org-todo 'previousset))
18319 (org-support-shift-select
18320 (org-call-for-shift-select 'backward-word))
18321 (t (org-shiftselect-error))))
18323 (defun org-shiftcontrolup ()
18324 "Change timestamps synchronously up in CLOCK log lines."
18325 (interactive)
18326 (cond ((and (not org-support-shift-select)
18327 (org-at-clock-log-p)
18328 (org-at-timestamp-p t))
18329 (org-clock-timestamps-up))
18330 (t (org-shiftselect-error))))
18332 (defun org-shiftcontroldown ()
18333 "Change timestamps synchronously down in CLOCK log lines."
18334 (interactive)
18335 (cond ((and (not org-support-shift-select)
18336 (org-at-clock-log-p)
18337 (org-at-timestamp-p t))
18338 (org-clock-timestamps-down))
18339 (t (org-shiftselect-error))))
18341 (defun org-ctrl-c-ret ()
18342 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18343 (interactive)
18344 (cond
18345 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18346 (t (call-interactively 'org-insert-heading))))
18348 (defun org-find-visible ()
18349 (let ((s (point)))
18350 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18351 (get-char-property s 'invisible)))
18352 s))
18353 (defun org-find-invisible ()
18354 (let ((s (point)))
18355 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18356 (not (get-char-property s 'invisible))))
18357 s))
18359 (defun org-copy-visible (beg end)
18360 "Copy the visible parts of the region."
18361 (interactive "r")
18362 (let (snippets s)
18363 (save-excursion
18364 (save-restriction
18365 (narrow-to-region beg end)
18366 (setq s (goto-char (point-min)))
18367 (while (not (= (point) (point-max)))
18368 (goto-char (org-find-invisible))
18369 (push (buffer-substring s (point)) snippets)
18370 (setq s (goto-char (org-find-visible))))))
18371 (kill-new (apply 'concat (nreverse snippets)))))
18373 (defun org-copy-special ()
18374 "Copy region in table or copy current subtree.
18375 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18376 See the individual commands for more information."
18377 (interactive)
18378 (call-interactively
18379 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18381 (defun org-cut-special ()
18382 "Cut region in table or cut current subtree.
18383 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18384 See the individual commands for more information."
18385 (interactive)
18386 (call-interactively
18387 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18389 (defun org-paste-special (arg)
18390 "Paste rectangular region into table, or past subtree relative to level.
18391 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18392 See the individual commands for more information."
18393 (interactive "P")
18394 (if (org-at-table-p)
18395 (org-table-paste-rectangle)
18396 (org-paste-subtree arg)))
18398 (defun org-edit-special (&optional arg)
18399 "Call a special editor for the stuff at point.
18400 When at a table, call the formula editor with `org-table-edit-formulas'.
18401 When at the first line of an src example, call `org-edit-src-code'.
18402 When in an #+include line, visit the include file. Otherwise call
18403 `ffap' to visit the file at point."
18404 (interactive)
18405 ;; possibly prep session before editing source
18406 (when arg
18407 (let* ((info (org-babel-get-src-block-info))
18408 (lang (nth 0 info))
18409 (params (nth 2 info))
18410 (session (cdr (assoc :session params))))
18411 (when (and info session) ;; we are in a source-code block with a session
18412 (funcall
18413 (intern (concat "org-babel-prep-session:" lang)) session params))))
18414 (cond ;; proceed with `org-edit-special'
18415 ((save-excursion
18416 (beginning-of-line 1)
18417 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18418 (find-file (org-trim (match-string 1))))
18419 ((org-edit-src-code))
18420 ((org-edit-fixed-width-region))
18421 ((org-at-table.el-p)
18422 (org-edit-src-code))
18423 ((or (org-at-table-p)
18424 (save-excursion
18425 (beginning-of-line 1)
18427 (call-interactively 'org-table-edit-formulas))
18428 (t (call-interactively 'ffap))))
18430 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18431 (defun org-ctrl-c-ctrl-c (&optional arg)
18432 "Set tags in headline, or update according to changed information at point.
18434 This command does many different things, depending on context:
18436 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18437 this is what we do.
18439 - If the cursor is on a statistics cookie, update it.
18441 - If the cursor is in a headline, prompt for tags and insert them
18442 into the current line, aligned to `org-tags-column'. When called
18443 with prefix arg, realign all tags in the current buffer.
18445 - If the cursor is in one of the special #+KEYWORD lines, this
18446 triggers scanning the buffer for these lines and updating the
18447 information.
18449 - If the cursor is inside a table, realign the table. This command
18450 works even if the automatic table editor has been turned off.
18452 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18453 the entire table.
18455 - If the cursor is at a footnote reference or definition, jump to
18456 the corresponding definition or references, respectively.
18458 - If the cursor is a the beginning of a dynamic block, update it.
18460 - If the current buffer is a capture buffer, close note and file it.
18462 - If the cursor is on a <<<target>>>, update radio targets and
18463 corresponding links in this buffer.
18465 - If the cursor is on a numbered item in a plain list, renumber the
18466 ordered list.
18468 - If the cursor is on a checkbox, toggle it.
18470 - If the cursor is on a code block, evaluate it. The variable
18471 `org-confirm-babel-evaluate' can be used to control prompting
18472 before code block evaluation, by default every code block
18473 evaluation requires confirmation. Code block evaluation can be
18474 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18475 (interactive "P")
18476 (let ((org-enable-table-editor t))
18477 (cond
18478 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18479 org-occur-highlights
18480 org-latex-fragment-image-overlays)
18481 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18482 (org-remove-occur-highlights)
18483 (org-remove-latex-fragment-image-overlays)
18484 (message "Temporary highlights/overlays removed from current buffer"))
18485 ((and (local-variable-p 'org-finish-function (current-buffer))
18486 (fboundp org-finish-function))
18487 (funcall org-finish-function))
18488 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18489 ((org-in-regexp org-ts-regexp-both)
18490 (org-timestamp-change 0 'day))
18491 ((or (looking-at org-property-start-re)
18492 (org-at-property-p))
18493 (call-interactively 'org-property-action))
18494 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18496 (or (org-at-heading-p) (org-at-item-p)))
18497 (call-interactively 'org-update-statistics-cookies))
18498 ((org-at-heading-p) (call-interactively 'org-set-tags))
18499 ((org-at-table.el-p)
18500 (message "Use C-c ' to edit table.el tables"))
18501 ((org-at-table-p)
18502 (org-table-maybe-eval-formula)
18503 (if arg
18504 (call-interactively 'org-table-recalculate)
18505 (org-table-maybe-recalculate-line))
18506 (call-interactively 'org-table-align)
18507 (orgtbl-send-table 'maybe))
18508 ((or (org-footnote-at-reference-p)
18509 (org-footnote-at-definition-p))
18510 (call-interactively 'org-footnote-action))
18511 ((org-at-item-checkbox-p)
18512 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18513 ;; list only if at top item.
18514 (let* ((cbox (match-string 1))
18515 (struct (org-list-struct))
18516 (old-struct (copy-tree struct))
18517 (parents (org-list-parents-alist struct))
18518 (orderedp (org-entry-get nil "ORDERED"))
18519 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18520 block-item)
18521 ;; Use a light version of `org-toggle-checkbox' to avoid
18522 ;; computing list structure twice.
18523 (let ((new-box (cond
18524 ((equal arg '(16)) "[-]")
18525 ((equal arg '(4)) nil)
18526 ((equal "[X]" cbox) "[ ]")
18527 (t "[X]"))))
18528 (if (and firstp arg)
18529 ;; If at first item of sub-list, remove check-box from
18530 ;; every item at the same level.
18531 (mapc
18532 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18533 (org-list-get-all-items
18534 (point-at-bol) struct (org-list-prevs-alist struct)))
18535 (org-list-set-checkbox (point-at-bol) struct new-box)))
18536 ;; Replicate `org-list-write-struct', while grabbing a return
18537 ;; value from `org-list-struct-fix-box'.
18538 (org-list-struct-fix-ind struct parents 2)
18539 (org-list-struct-fix-item-end struct)
18540 (let ((prevs (org-list-prevs-alist struct)))
18541 (org-list-struct-fix-bul struct prevs)
18542 (org-list-struct-fix-ind struct parents)
18543 (setq block-item
18544 (org-list-struct-fix-box struct parents prevs orderedp)))
18545 (org-list-struct-apply-struct struct old-struct)
18546 (org-update-checkbox-count-maybe)
18547 (when block-item
18548 (message
18549 "Checkboxes were removed due to unchecked box at line %d"
18550 (org-current-line block-item)))
18551 (when firstp (org-list-send-list 'maybe))))
18552 ((org-at-item-p)
18553 ;; Cursor at an item: repair list. Do checkbox related actions
18554 ;; only if function was called with an argument. Send list only
18555 ;; if at top item.
18556 (let* ((struct (org-list-struct))
18557 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18558 old-struct)
18559 (when arg
18560 (setq old-struct (copy-tree struct))
18561 (if firstp
18562 ;; If at first item of sub-list, add check-box to every
18563 ;; item at the same level.
18564 (mapc
18565 (lambda (pos)
18566 (unless (org-list-get-checkbox pos struct)
18567 (org-list-set-checkbox pos struct "[ ]")))
18568 (org-list-get-all-items
18569 (point-at-bol) struct (org-list-prevs-alist struct)))
18570 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18571 (org-list-write-struct
18572 struct (org-list-parents-alist struct) old-struct)
18573 (when arg (org-update-checkbox-count-maybe))
18574 (when firstp (org-list-send-list 'maybe))))
18575 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18576 ;; Dynamic block
18577 (beginning-of-line 1)
18578 (save-excursion (org-update-dblock)))
18579 ((save-excursion
18580 (beginning-of-line 1)
18582 (cond
18583 ((equal (match-string 1) "TBLFM")
18584 ;; Recalculate the table before this line
18585 (save-excursion
18586 (beginning-of-line 1)
18588 (if (org-at-table-p)
18589 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18590 (t
18591 (let ((org-inhibit-startup-visibility-stuff t)
18592 (org-startup-align-all-tables nil))
18593 (when (boundp 'org-table-coordinate-overlays)
18594 (mapc 'delete-overlay org-table-coordinate-overlays)
18595 (setq org-table-coordinate-overlays nil))
18596 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18597 (message "Local setup has been refreshed"))))
18598 ((org-clock-update-time-maybe))
18599 (t
18600 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18601 (error "C-c C-c can do nothing useful at this location"))))))
18603 (defun org-mode-restart ()
18604 "Restart Org-mode, to scan again for special lines.
18605 Also updates the keyword regular expressions."
18606 (interactive)
18607 (org-mode)
18608 (message "Org-mode restarted"))
18610 (defun org-kill-note-or-show-branches ()
18611 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18612 (interactive)
18613 (if (not org-finish-function)
18614 (progn
18615 (hide-subtree)
18616 (call-interactively 'show-branches))
18617 (let ((org-note-abort t))
18618 (funcall org-finish-function))))
18620 (defun org-return (&optional indent)
18621 "Goto next table row or insert a newline.
18622 Calls `org-table-next-row' or `newline', depending on context.
18623 See the individual commands for more information."
18624 (interactive)
18625 (cond
18626 ((or (bobp) (org-in-src-block-p))
18627 (if indent (newline-and-indent) (newline)))
18628 ((org-at-table-p)
18629 (org-table-justify-field-maybe)
18630 (call-interactively 'org-table-next-row))
18631 ;; when `newline-and-indent' is called within a list, make sure
18632 ;; text moved stays inside the item.
18633 ((and (org-in-item-p) indent)
18634 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18635 (progn
18636 (save-match-data (newline))
18637 (org-indent-line-to (length (match-string 0))))
18638 (let ((ind (org-get-indentation)))
18639 (newline)
18640 (if (org-looking-back org-list-end-re)
18641 (org-indent-line-function)
18642 (org-indent-line-to ind)))))
18643 ((and org-return-follows-link
18644 (let ((tprop (get-text-property (point) 'face)))
18645 (or (eq tprop 'org-link)
18646 (and (listp tprop) (memq 'org-link tprop)))))
18647 (call-interactively 'org-open-at-point))
18648 ((and (org-at-heading-p)
18649 (looking-at
18651 (org-show-entry)
18652 (end-of-line 1)
18653 (newline))
18654 (t (if indent (newline-and-indent) (newline)))))
18656 (defun org-return-indent ()
18657 "Goto next table row or insert a newline and indent.
18658 Calls `org-table-next-row' or `newline-and-indent', depending on
18659 context. See the individual commands for more information."
18660 (interactive)
18661 (org-return t))
18663 (defun org-ctrl-c-star ()
18664 "Compute table, or change heading status of lines.
18665 Calls `org-table-recalculate' or `org-toggle-heading',
18666 depending on context."
18667 (interactive)
18668 (cond
18669 ((org-at-table-p)
18670 (call-interactively 'org-table-recalculate))
18671 (t
18672 ;; Convert all lines in region to list items
18673 (call-interactively 'org-toggle-heading))))
18675 (defun org-ctrl-c-minus ()
18676 "Insert separator line in table or modify bullet status of line.
18677 Also turns a plain line or a region of lines into list items.
18678 Calls `org-table-insert-hline', `org-toggle-item', or
18679 `org-cycle-list-bullet', depending on context."
18680 (interactive)
18681 (cond
18682 ((org-at-table-p)
18683 (call-interactively 'org-table-insert-hline))
18684 ((org-region-active-p)
18685 (call-interactively 'org-toggle-item))
18686 ((org-in-item-p)
18687 (call-interactively 'org-cycle-list-bullet))
18688 (t
18689 (call-interactively 'org-toggle-item))))
18691 (defun org-toggle-item (arg)
18692 "Convert headings or normal lines to items, items to normal lines.
18693 If there is no active region, only the current line is considered.
18695 If the first non blank line in the region is an headline, convert
18696 all headlines to items, shifting text accordingly.
18698 If it is an item, convert all items to normal lines.
18700 If it is normal text, change region into an item. With a prefix
18701 argument ARG, change each line in region into an item."
18702 (interactive "P")
18703 (let ((shift-text
18704 (function
18705 ;; Shift text in current section to IND, from point to END.
18706 ;; The function leaves point to END line.
18707 (lambda (ind end)
18708 (let ((min-i 1000) (end (copy-marker end)))
18709 ;; First determine the minimum indentation (MIN-I) of
18710 ;; the text.
18711 (save-excursion
18712 (catch 'exit
18713 (while (< (point) end)
18714 (let ((i (org-get-indentation)))
18715 (cond
18716 ;; Skip blank lines and inline tasks.
18718 ((looking-at org-outline-regexp-bol))
18719 ;; We can't find less than 0 indentation.
18720 ((zerop i) (throw 'exit (setq min-i 0)))
18721 ((< i min-i) (setq min-i i))))
18722 (forward-line))))
18723 ;; Then indent each line so that a line indented to
18724 ;; MIN-I becomes indented to IND. Ignore blank lines
18725 ;; and inline tasks in the process.
18726 (let ((delta (- ind min-i)))
18727 (while (< (point) end)
18729 (looking-at org-outline-regexp-bol))
18730 (org-indent-line-to (+ (org-get-indentation) delta)))
18731 (forward-line)))))))
18732 (skip-blanks
18733 (function
18734 ;; Return beginning of first non-blank line, starting from
18735 ;; line at POS.
18736 (lambda (pos)
18737 (save-excursion
18738 (goto-char pos)
18740 (point-at-bol)))))
18741 beg end)
18742 ;; Determine boundaries of changes.
18743 (if (org-region-active-p)
18744 (setq beg (funcall skip-blanks (region-beginning))
18745 end (copy-marker (region-end)))
18746 (setq beg (funcall skip-blanks (point-at-bol))
18747 end (copy-marker (point-at-eol))))
18748 ;; Depending on the starting line, choose an action on the text
18749 ;; between BEG and END.
18750 (org-with-limited-levels
18751 (save-excursion
18752 (goto-char beg)
18753 (cond
18754 ;; Case 1. Start at an item: de-itemize. Note that it only
18755 ;; happens when a region is active: `org-ctrl-c-minus'
18756 ;; would call `org-cycle-list-bullet' otherwise.
18757 ((org-at-item-p)
18758 (while (< (point) end)
18759 (when (org-at-item-p)
18761 (delete-region (point) (match-end 0)))
18762 (forward-line)))
18763 ;; Case 2. Start at an heading: convert to items.
18764 ((org-at-heading-p)
18765 (let* ((bul (org-list-bullet-string "-"))
18766 (bul-len (length bul))
18767 ;; Indentation of the first heading. It should be
18768 ;; relative to the indentation of its parent, if any.
18769 (start-ind (save-excursion
18770 (cond
18771 ((not org-adapt-indentation) 0)
18772 ((not (outline-previous-heading)) 0)
18773 (t (length (match-string 0))))))
18774 ;; Level of first heading. Further headings will be
18775 ;; compared to it to determine hierarchy in the list.
18776 (ref-level (org-reduced-level (org-outline-level))))
18777 (while (< (point) end)
18778 (let* ((level (org-reduced-level (org-outline-level)))
18779 (delta (max 0 (- level ref-level))))
18780 ;; If current headline is less indented than the first
18781 ;; one, set it as reference, in order to preserve
18782 ;; subtrees.
18783 (when (< level ref-level) (setq ref-level level))
18784 (replace-match bul t t)
18785 (org-indent-line-to (+ start-ind (* delta bul-len)))
18786 ;; Ensure all text down to END (or SECTION-END) belongs
18787 ;; to the newly created item.
18788 (let ((section-end (save-excursion
18789 (or (outline-next-heading) (point)))))
18790 (forward-line)
18791 (funcall shift-text
18792 (+ start-ind (* (1+ delta) bul-len))
18793 (min end section-end)))))))
18794 ;; Case 3. Normal line with ARG: turn each non-item line into
18795 ;; an item.
18796 (arg
18797 (while (< (point) end)
18798 (unless (or (org-at-heading-p) (org-at-item-p))
18800 (replace-match
18802 (forward-line)))
18803 ;; Case 4. Normal line without ARG: make the first line of
18804 ;; region an item, and shift indentation of others
18805 ;; lines to set them as item's body.
18806 (t (let* ((bul (org-list-bullet-string "-"))
18807 (bul-len (length bul))
18808 (ref-ind (org-get-indentation)))
18810 (insert bul)
18811 (forward-line)
18812 (while (< (point) end)
18813 ;; Ensure that lines less indented than first one
18814 ;; still get included in item body.
18815 (funcall shift-text
18816 (+ ref-ind bul-len)
18817 (min end (save-excursion (or (outline-next-heading)
18818 (point)))))
18819 (forward-line)))))))))
18821 (defun org-toggle-heading (&optional nstars)
18822 "Convert headings to normal text, or items or text to headings.
18823 If there is no active region, only the current line is considered.
18825 If the first non blank line is an headline, remove the stars from
18826 all headlines in the region.
18828 If it is a plain list item, turn all plain list items into headings.
18830 If it is a normal line, turn each and every normal line (i.e. not
18831 an heading or an item) in the region into a heading.
18833 When converting a line into a heading, the number of stars is chosen
18834 such that the lines become children of the current entry. However,
18835 when a prefix argument is given, its value determines the number of
18836 stars to add."
18837 (interactive "P")
18838 (let ((skip-blanks
18839 (function
18840 ;; Return beginning of first non-blank line, starting from
18841 ;; line at POS.
18842 (lambda (pos)
18843 (save-excursion
18844 (goto-char pos)
18846 (point-at-bol)))))
18847 beg end)
18848 ;; Determine boundaries of changes. If region ends at a bol, do
18849 ;; not consider the last line to be in the region.
18850 (if (org-region-active-p)
18851 (setq beg (funcall skip-blanks (region-beginning))
18852 end (copy-marker (save-excursion
18853 (goto-char (region-end))
18854 (if (bolp) (point) (point-at-eol)))))
18855 (setq beg (funcall skip-blanks (point-at-bol))
18856 end (copy-marker (point-at-eol))))
18857 ;; Ensure inline tasks don't count as headings.
18858 (org-with-limited-levels
18859 (save-excursion
18860 (goto-char beg)
18861 (cond
18862 ;; Case 1. Started at an heading: de-star headings.
18863 ((org-at-heading-p)
18864 (while (< (point) end)
18865 (when (org-at-heading-p t)
18866 (looking-at org-outline-regexp) (replace-match ""))
18867 (forward-line)))
18868 ;; Case 2. Started at an item: change items into headlines.
18869 ;; One star will be added by `org-list-to-subtree'.
18870 ((org-at-item-p)
18871 (let* ((stars (make-string
18872 (if nstars
18873 ;; subtract the star that will be added again by
18874 ;; `org-list-to-subtree'
18875 (1- (prefix-numeric-value current-prefix-arg))
18876 (or (org-current-level) 0))
18877 ?*))
18878 (add-stars
18879 (cond (nstars "") ; stars from prefix only
18880 ((equal stars "") "") ; before first heading
18881 (org-odd-levels-only "*") ; inside heading, odd
18882 (t "")))) ; inside heading, oddeven
18883 (while (< (point) end)
18884 (when (org-at-item-p)
18885 ;; Pay attention to cases when region ends before list.
18886 (let* ((struct (org-list-struct))
18887 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18888 (save-restriction
18889 (narrow-to-region (point) list-end)
18890 (insert
18891 (org-list-to-subtree
18892 (org-list-parse-list t)
18893 '(:istart (concat stars add-stars (funcall get-stars depth))
18894 :icount (concat stars add-stars (funcall get-stars depth))))))))
18895 (forward-line))))
18896 ;; Case 3. Started at normal text: make every line an heading,
18897 ;; skipping headlines and items.
18898 (t (let* ((stars (make-string
18899 (if nstars
18900 (prefix-numeric-value current-prefix-arg)
18901 (or (org-current-level) 0))
18902 ?*))
18903 (add-stars
18904 (cond (nstars "") ; stars from prefix only
18905 ((equal stars "") "*") ; before first heading
18906 (org-odd-levels-only "**") ; inside heading, odd
18907 (t "*"))) ; inside heading, oddeven
18908 (rpl (concat stars add-stars " ")))
18909 (while (< (point) end)
18910 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18912 (replace-match (concat rpl (match-string 2))))
18913 (forward-line)))))))))
18915 (defun org-meta-return (&optional arg)
18916 "Insert a new heading or wrap a region in a table.
18917 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18918 See the individual commands for more information."
18919 (interactive "P")
18920 (cond
18921 ((run-hook-with-args-until-success 'org-metareturn-hook))
18922 ((or (org-at-drawer-p) (org-at-property-p))
18923 (newline-and-indent))
18924 ((org-at-table-p)
18925 (call-interactively 'org-table-wrap-region))
18926 (t (call-interactively 'org-insert-heading))))
18928 ;;; Menu entries
18930 ;; Define the Org-mode menus
18931 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18932 '("Tbl"
18933 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18934 ["Next Field" org-cycle (org-at-table-p)]
18935 ["Previous Field" org-shifttab (org-at-table-p)]
18936 ["Next Row" org-return (org-at-table-p)]
18937 "--"
18938 ["Blank Field" org-table-blank-field (org-at-table-p)]
18939 ["Edit Field" org-table-edit-field (org-at-table-p)]
18940 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18941 "--"
18942 ("Column"
18943 ["Move Column Left" org-metaleft (org-at-table-p)]
18944 ["Move Column Right" org-metaright (org-at-table-p)]
18945 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18946 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18947 ("Row"
18948 ["Move Row Up" org-metaup (org-at-table-p)]
18949 ["Move Row Down" org-metadown (org-at-table-p)]
18950 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18951 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18952 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18953 "--"
18954 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18955 ("Rectangle"
18956 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18957 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18958 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18959 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18960 "--"
18961 ("Calculate"
18962 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18963 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18964 ["Edit Formulas" org-edit-special (org-at-table-p)]
18965 "--"
18966 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18967 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18968 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18969 "--"
18970 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18971 "--"
18972 ["Sum Column/Rectangle" org-table-sum
18973 (or (org-at-table-p) (org-region-active-p))]
18974 ["Which Column?" org-table-current-column (org-at-table-p)])
18975 ["Debug Formulas"
18976 org-table-toggle-formula-debugger
18977 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18978 ["Show Col/Row Numbers"
18979 org-table-toggle-coordinate-overlays
18980 :style toggle
18981 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18982 "--"
18983 ["Create" org-table-create (and (not (org-at-table-p))
18984 org-enable-table-editor)]
18985 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18986 ["Import from File" org-table-import (not (org-at-table-p))]
18987 ["Export to File" org-table-export (org-at-table-p)]
18988 "--"
18989 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18991 (easy-menu-define org-org-menu org-mode-map "Org menu"
18992 '("Org"
18993 ("Show/Hide"
18994 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18995 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18996 ["Sparse Tree..." org-sparse-tree t]
18997 ["Reveal Context" org-reveal t]
18998 ["Show All" show-all t]
18999 "--"
19000 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
19001 "--"
19002 ["New Heading" org-insert-heading t]
19003 ("Navigate Headings"
19004 ["Up" outline-up-heading t]
19005 ["Next" outline-next-visible-heading t]
19006 ["Previous" outline-previous-visible-heading t]
19007 ["Next Same Level" outline-forward-same-level t]
19008 ["Previous Same Level" outline-backward-same-level t]
19009 "--"
19010 ["Jump" org-goto t])
19011 ("Edit Structure"
19012 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
19013 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
19014 "--"
19015 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
19016 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
19017 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19018 "--"
19019 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19020 "--"
19021 ["Copy visible text" org-copy-visible t]
19022 "--"
19023 ["Promote Heading" org-metaleft (not (org-at-table-p))]
19024 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
19025 ["Demote Heading" org-metaright (not (org-at-table-p))]
19026 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
19027 "--"
19028 ["Sort Region/Children" org-sort (not (org-at-table-p))]
19029 "--"
19030 ["Convert to odd levels" org-convert-to-odd-levels t]
19031 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19032 ("Editing"
19033 ["Emphasis..." org-emphasize t]
19034 ["Edit Source Example" org-edit-special t]
19035 "--"
19036 ["Footnote new/jump" org-footnote-action t]
19037 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19038 ("Archive"
19039 ["Archive (default method)" org-archive-subtree-default t]
19040 "--"
19041 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
19042 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
19043 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
19044 )
19045 "--"
19046 ("Hyperlinks"
19047 ["Store Link (Global)" org-store-link t]
19048 ["Find existing link to here" org-occur-link-in-agenda-files t]
19049 ["Insert Link" org-insert-link t]
19050 ["Follow Link" org-open-at-point t]
19051 "--"
19052 ["Next link" org-next-link t]
19053 ["Previous link" org-previous-link t]
19054 "--"
19055 ["Descriptive Links"
19056 org-toggle-link-display
19057 :style radio
19058 :selected org-descriptive-links
19059 ]
19060 ["Literal Links"
19061 org-toggle-link-display
19062 :style radio
19063 :selected (not org-descriptive-links)])
19064 "--"
19065 ("TODO Lists"
19066 ["TODO/DONE/-" org-todo t]
19067 ("Select keyword"
19068 ["Next keyword" org-shiftright (org-at-heading-p)]
19069 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19070 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19071 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19072 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19073 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19074 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19075 "--"
19076 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19077 :selected org-enforce-todo-dependencies :style toggle :active t]
19078 "Settings for tree at point"
19079 ["Do Children sequentially" org-toggle-ordered-property :style radio
19080 :selected (org-entry-get nil "ORDERED")
19081 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19082 ["Do Children parallel" org-toggle-ordered-property :style radio
19083 :selected (not (org-entry-get nil "ORDERED"))
19084 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19085 "--"
19086 ["Set Priority" org-priority t]
19087 ["Priority Up" org-shiftup t]
19088 ["Priority Down" org-shiftdown t]
19089 "--"
19090 ["Get news from all feeds" org-feed-update-all t]
19091 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19092 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19093 ("TAGS and Properties"
19094 ["Set Tags" org-set-tags-command t]
19095 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19096 "--"
19097 ["Set property" org-set-property t]
19098 ["Column view of properties" org-columns t]
19099 ["Insert Column View DBlock" org-insert-columns-dblock t])
19100 ("Dates and Scheduling"
19101 ["Timestamp" org-time-stamp t]
19102 ["Timestamp (inactive)" org-time-stamp-inactive t]
19103 ("Change Date"
19104 ["1 Day Later" org-shiftright t]
19105 ["1 Day Earlier" org-shiftleft t]
19106 ["1 ... Later" org-shiftup t]
19107 ["1 ... Earlier" org-shiftdown t])
19108 ["Compute Time Range" org-evaluate-time-range t]
19109 ["Schedule Item" org-schedule t]
19110 ["Deadline" org-deadline t]
19111 "--"
19112 ["Custom time format" org-toggle-time-stamp-overlays
19113 :style radio :selected org-display-custom-times]
19114 "--"
19115 ["Goto Calendar" org-goto-calendar t]
19116 ["Date from Calendar" org-date-from-calendar t]
19117 "--"
19118 ["Start/Restart Timer" org-timer-start t]
19119 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19120 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19121 ["Insert Timer String" org-timer t]
19122 ["Insert Timer Item" org-timer-item t])
19123 ("Logging work"
19124 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19125 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19126 ["Clock out" org-clock-out t]
19127 ["Clock cancel" org-clock-cancel t]
19128 "--"
19129 ["Mark as default task" org-clock-mark-default-task t]
19130 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19131 ["Goto running clock" org-clock-goto t]
19132 "--"
19133 ["Display times" org-clock-display t]
19134 ["Create clock table" org-clock-report t]
19135 "--"
19136 ["Record DONE time"
19137 (progn (setq org-log-done (not org-log-done))
19138 (message "Switching to %s will %s record a timestamp"
19139 (car org-done-keywords)
19140 (if org-log-done "automatically" "not")))
19141 :style toggle :selected org-log-done])
19142 "--"
19143 ["Agenda Command..." org-agenda t]
19144 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19145 ("File List for Agenda")
19146 ("Special views current file"
19147 ["TODO Tree" org-show-todo-tree t]
19148 ["Check Deadlines" org-check-deadlines t]
19149 ["Timeline" org-timeline t]
19150 ["Tags/Property tree" org-match-sparse-tree t])
19151 "--"
19152 ["Export/Publish..." org-export t]
19153 ("LaTeX"
19154 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19155 :selected org-cdlatex-mode]
19156 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19157 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19158 ["Modify math symbol" org-cdlatex-math-modify
19159 (org-inside-LaTeX-fragment-p)]
19160 ["Insert citation" org-reftex-citation t]
19161 "--"
19162 ["Template for BEAMER" org-insert-beamer-options-template t])
19163 "--"
19164 ("MobileOrg"
19165 ["Push Files and Views" org-mobile-push t]
19166 ["Get Captured and Flagged" org-mobile-pull t]
19167 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19168 "--"
19169 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19170 "--"
19171 ("Documentation"
19172 ["Show Version" org-version t]
19173 ["Info Documentation" org-info t])
19174 ("Customize"
19175 ["Browse Org Group" org-customize t]
19176 "--"
19177 ["Expand This Menu" org-create-customize-menu
19178 (fboundp 'customize-menu-create)])
19179 ["Send bug report" org-submit-bug-report t]
19180 "--"
19181 ("Refresh/Reload"
19182 ["Refresh setup current buffer" org-mode-restart t]
19183 ["Reload Org (after update)" org-reload t]
19184 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19185 ))
19187 (defun org-info (&optional node)
19188 "Read documentation for Org-mode in the info system.
19189 With optional NODE, go directly to that node."
19190 (interactive)
19191 (info (format "(org)%s" (or node ""))))
19193 ;;;###autoload
19194 (defun org-submit-bug-report ()
19195 "Submit a bug report on Org-mode via mail.
19197 Don't hesitate to report any problems or inaccurate documentation.
19199 If you don't have setup sending mail from (X)Emacs, please copy the
19200 output buffer into your mail program, as it gives us important
19201 information about your Org-mode version and configuration."
19202 (interactive)
19203 (require 'reporter)
19204 (org-load-modules-maybe)
19205 (org-require-autoloaded-modules)
19206 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19207 (reporter-submit-bug-report
19208 "emacs-orgmode@gnu.org"
19209 (org-version)
19210 (let (list)
19211 (save-window-excursion
19212 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19213 (delete-other-windows)
19214 (erase-buffer)
19215 (insert "You are about to submit a bug report to the Org-mode mailing list.
19217 We would like to add your full Org-mode and Outline configuration to the
19218 bug report. This greatly simplifies the work of the maintainer and
19219 other experts on the mailing list.
19221 HOWEVER, some variables you have customized may contain private
19222 information. The names of customers, colleagues, or friends, might
19223 appear in the form of file names, tags, todo states, or search strings.
19224 If you answer yes to the prompt, you might want to check and remove
19225 such private information before sending the email.")
19226 (add-text-properties (point-min) (point-max) '(face org-warning))
19227 (when (yes-or-no-p "Include your Org-mode configuration ")
19228 (mapatoms
19229 (lambda (v)
19230 (and (boundp v)
19232 (or (and (symbol-value v)
19234 (and
19235 (get v 'custom-type) (get v 'standard-value)
19236 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19237 (push v list)))))
19238 (kill-buffer (get-buffer "*Warn about privacy*"))
19239 list))
19240 nil nil
19241 "Remember to cover the basics, that is, what you expected to happen and
19242 what in fact did happen. You don't know how to make a good report? See
19244 http://orgmode.org/manual/Feedback.html#Feedback
19246 Your bug report will be posted to the Org-mode mailing list.
19247 ------------------------------------------------------------------------")
19248 (save-excursion
19253 (defun org-install-agenda-files-menu ()
19254 (let ((bl (buffer-list)))
19255 (save-excursion
19256 (while bl
19257 (set-buffer (pop bl))
19258 (if (eq major-mode 'org-mode) (setq bl nil)))
19259 (when (eq major-mode 'org-mode)
19260 (easy-menu-change
19261 '("Org") "File List for Agenda"
19262 (append
19263 (list
19264 ["Edit File List" (org-edit-agenda-file-list) t]
19265 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19266 ["Remove Current File from List" org-remove-file t]
19267 ["Cycle through agenda files" org-cycle-agenda-files t]
19268 ["Occur in all agenda files" org-occur-in-agenda-files t]
19269 "--")
19270 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19272 ;;;; Documentation
19274 ;;;###autoload
19275 (defun org-require-autoloaded-modules ()
19276 (interactive)
19277 (mapc 'require
19278 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19279 org-docbook org-exp org-html org-icalendar
19280 org-id org-latex
19281 org-publish org-remember org-table
19282 org-timer org-xoxo)))
19284 ;;;###autoload
19285 (defun org-reload (&optional uncompiled)
19286 "Reload all org lisp files.
19287 With prefix arg UNCOMPILED, load the uncompiled versions."
19288 (interactive "P")
19289 (require 'find-func)
19291 (dir-org (file-name-directory (org-find-library-name "org")))
19292 (dir-org-contrib (ignore-errors
19293 (file-name-directory
19294 (org-find-library-name "org-contribdir"))))
19295 (babel-files
19296 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19297 (append (list nil "comint" "eval" "exp" "keys"
19298 "lob" "ref" "table" "tangle")
19299 (delq nil
19300 (mapcar
19301 (lambda (lang)
19302 (when (cdr lang) (symbol-name (car lang))))
19303 org-babel-load-languages)))))
19304 (files
19305 (append (directory-files dir-org t file-re)
19306 babel-files
19307 (and dir-org-contrib
19308 (directory-files dir-org-contrib t file-re))))
19309 (remove-re (concat (if (featurep 'xemacs)
19310 "org-colview" "org-colview-xemacs")
19312 (setq files (mapcar 'file-name-sans-extension files))
19313 (setq files (mapcar
19314 (lambda (x) (if (string-match remove-re x) nil x))
19315 files))
19316 (setq files (delq nil files))
19317 (mapc
19318 (lambda (f)
19319 (when (featurep (intern (file-name-nondirectory f)))
19320 (if (and (not uncompiled)
19321 (file-exists-p (concat f ".elc")))
19322 (load (concat f ".elc") nil nil t)
19323 (load (concat f ".el") nil nil t))))
19324 files))
19325 (org-version))
19327 ;;;###autoload
19328 (defun org-customize ()
19329 "Call the customize function with org as argument."
19330 (interactive)
19331 (org-load-modules-maybe)
19332 (org-require-autoloaded-modules)
19333 (customize-browse 'org))
19335 (defun org-create-customize-menu ()
19336 "Create a full customization menu for Org-mode, insert it into the menu."
19337 (interactive)
19338 (org-load-modules-maybe)
19339 (org-require-autoloaded-modules)
19340 (if (fboundp 'customize-menu-create)
19341 (progn
19342 (easy-menu-change
19343 '("Org") "Customize"
19344 `(["Browse Org group" org-customize t]
19345 "--"
19346 ,(customize-menu-create 'org)
19347 ["Set" Custom-set t]
19348 ["Save" Custom-save t]
19349 ["Reset to Current" Custom-reset-current t]
19350 ["Reset to Saved" Custom-reset-saved t]
19351 ["Reset to Standard Settings" Custom-reset-standard t]))
19353 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19355 ;;;; Miscellaneous stuff
19357 ;;; Generally useful functions
19359 (defun org-get-at-bol (property)
19360 "Get text property PROPERTY at beginning of line."
19361 (get-text-property (point-at-bol) property))
19363 (defun org-find-text-property-in-string (prop s)
19364 "Return the first non-nil value of property PROP in string S."
19365 (or (get-text-property 0 prop s)
19366 (get-text-property (or (next-single-property-change 0 prop s) 0)
19367 prop s)))
19369 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19370 "Display the given MESSAGE as a warning."
19371 (if (fboundp 'display-warning)
19372 (display-warning 'org message
19373 (if (featurep 'xemacs) 'warning :warning))
19374 (let ((buf (get-buffer-create "*Org warnings*")))
19375 (with-current-buffer buf
19376 (goto-char (point-max))
19377 (insert "Warning (Org): " message)
19378 (unless (bolp)
19379 (newline)))
19380 (display-buffer buf)
19381 (sit-for 0))))
19383 (defun org-eval (form)
19384 "Eval FORM and return result."
19385 (condition-case error
19386 (eval form)
19387 (error (format "%%![Error: %s]" error))))
19389 (defun org-in-clocktable-p ()
19390 "Check if the cursor is in a clocktable."
19391 (let ((pos (point)) start)
19392 (save-excursion
19393 (end-of-line 1)
19395 (setq start (match-beginning 0))
19397 (>= (match-end 0) pos)
19398 start))))
19400 (defun org-in-commented-line ()
19401 "Is point in a line starting with `#'?"
19402 (equal (char-after (point-at-bol)) ?#))
19404 (defun org-in-indented-comment-line ()
19405 "Is point in a line starting with `#' after some white space?"
19406 (save-excursion
19407 (save-match-data
19408 (goto-char (point-at-bol))
19411 (defun org-in-verbatim-emphasis ()
19412 (save-match-data
19413 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19415 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19416 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19417 (if (and marker (marker-buffer marker)
19418 (buffer-live-p (marker-buffer marker)))
19419 (progn
19420 (org-pop-to-buffer-same-window (marker-buffer marker))
19421 (if (or (> marker (point-max)) (< marker (point-min)))
19422 (widen))
19423 (goto-char marker)
19424 (org-show-context 'org-goto))
19425 (if bookmark
19426 (bookmark-jump bookmark)
19427 (error "Cannot find location"))))
19429 (defun org-quote-csv-field (s)
19430 "Quote field for inclusion in CSV material."
19433 s))
19435 (defun org-force-self-insert (N)
19436 "Needed to enforce self-insert under remapping."
19437 (interactive "p")
19438 (self-insert-command N))
19440 (defun org-string-width (s)
19441 "Compute width of string, ignoring invisible characters.
19442 This ignores character with invisibility property `org-link', and also
19443 characters with property `org-cwidth', because these will become invisible
19444 upon the next fontification round."
19445 (let (b l)
19446 (when (or (eq t buffer-invisibility-spec)
19447 (assq 'org-link buffer-invisibility-spec))
19448 (while (setq b (text-property-any 0 (length s)
19449 'invisible 'org-link s))
19450 (setq s (concat (substring s 0 b)
19451 (substring s (or (next-single-property-change
19452 b 'invisible s) (length s)))))))
19453 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19454 (setq s (concat (substring s 0 b)
19455 (substring s (or (next-single-property-change
19456 b 'org-cwidth s) (length s))))))
19457 (setq l (string-width s) b -1)
19458 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19459 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19460 l))
19462 (defun org-shorten-string (s maxlength)
19463 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19464 If the string is shorter or has length MAXLENGTH, just return the
19465 original string. If it is longer, the functions finds a space in the
19466 string, breaks this string off at that locations and adds three dots
19467 as ellipsis. Including the ellipsis, the string will not be longer
19468 than MAXLENGTH. If finding a good breaking point in the string does
19469 not work, the string is just chopped off in the middle of a word
19470 if necessary."
19471 (if (<= (length s) maxlength)
19472 s
19473 (let* ((n (max (- maxlength 4) 1))
19475 (if (string-match re s)
19476 (concat (match-string 1 s) "...")
19477 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19479 (defun org-get-indentation (&optional line)
19480 "Get the indentation of the current line, interpreting tabs.
19481 When LINE is given, assume it represents a line and compute its indentation."
19482 (if line
19483 (if (string-match "^ *" (org-remove-tabs line))
19484 (match-end 0))
19485 (save-excursion
19486 (beginning-of-line 1)
19488 (current-column))))
19490 (defun org-get-string-indentation (s)
19491 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19492 (let ((n -1) (i 0) (w tab-width) c)
19493 (catch 'exit
19494 (while (< (setq n (1+ n)) (length s))
19495 (setq c (aref s n))
19496 (cond ((= c ?\ ) (setq i (1+ i)))
19498 (t (throw 'exit t)))))
19499 i))
19501 (defun org-remove-tabs (s &optional width)
19502 "Replace tabulators in S with spaces.
19503 Assumes that s is a single line, starting in column 0."
19504 (setq width (or width tab-width))
19506 (setq s (replace-match
19507 (make-string
19508 (- (* width (/ (+ (match-beginning 0) width) width))
19509 (match-beginning 0)) ?\ )
19510 t t s)))
19511 s)
19513 (defun org-fix-indentation (line ind)
19514 "Fix indentation in LINE.
19515 IND is a cons cell with target and minimum indentation.
19516 If the current indentation in LINE is smaller than the minimum,
19517 leave it alone. If it is larger than ind, set it to the target."
19518 (let* ((l (org-remove-tabs line))
19519 (i (org-get-indentation l))
19520 (i1 (car ind)) (i2 (cdr ind)))
19521 (if (>= i i2) (setq l (substring line i2)))
19522 (if (> i1 0)
19523 (concat (make-string i1 ?\ ) l)
19524 l)))
19526 (defun org-remove-indentation (code &optional n)
19527 "Remove the maximum common indentation from the lines in CODE.
19528 N may optionally be the number of spaces to remove."
19529 (with-temp-buffer
19530 (insert code)
19531 (org-do-remove-indentation n)
19532 (buffer-string)))
19534 (defun org-do-remove-indentation (&optional n)
19535 "Remove the maximum common indentation from the buffer."
19536 (untabify (point-min) (point-max))
19537 (let ((min 10000) re)
19538 (if n
19539 (setq min n)
19540 (goto-char (point-min))
19542 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19543 (unless (or (= min 0) (= min 10000))
19545 (goto-char (point-min))
19546 (while (re-search-forward re nil t)
19547 (replace-match "")
19548 (end-of-line 1))
19549 min)))
19551 (defun org-fill-template (template alist)
19552 "Find each %key of ALIST in TEMPLATE and replace it."
19553 (let ((case-fold-search nil)
19554 entry key value)
19555 (setq alist (sort (copy-sequence alist)
19556 (lambda (a b) (< (length (car a)) (length (car b))))))
19557 (while (setq entry (pop alist))
19558 (setq template
19559 (replace-regexp-in-string
19560 (concat "%" (regexp-quote (car entry)))
19561 (cdr entry) template t t)))
19562 template))
19564 (defun org-base-buffer (buffer)
19565 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19566 (if (not buffer)
19567 buffer
19568 (or (buffer-base-buffer buffer)
19569 buffer)))
19571 (defun org-trim (s)
19572 "Remove whitespace at beginning and end of string."
19575 s)
19577 (defun org-wrap (string &optional width lines)
19578 "Wrap string to either a number of lines, or a width in characters.
19579 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19580 that costs. If there is a word longer than WIDTH, the text is actually
19581 wrapped to the length of that word.
19582 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19583 many lines, whatever width that takes.
19584 The return value is a list of lines, without newlines at the end."
19586 (maxword (apply 'max (mapcar 'org-string-width words)))
19587 w ll)
19588 (cond (width
19589 (org-do-wrap words (max maxword width)))
19590 (lines
19591 (setq w maxword)
19592 (setq ll (org-do-wrap words maxword))
19593 (if (<= (length ll) lines)
19594 ll
19595 (setq ll words)
19596 (while (> (length ll) lines)
19597 (setq w (1+ w))
19598 (setq ll (org-do-wrap words w)))
19599 ll))
19600 (t (error "Cannot wrap this")))))
19602 (defun org-do-wrap (words width)
19603 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19604 (let (lines line)
19605 (while words
19606 (setq line (pop words))
19607 (while (and words (< (+ (length line) (length (car words))) width))
19608 (setq line (concat line " " (pop words))))
19609 (setq lines (push line lines)))
19610 (nreverse lines)))
19612 (defun org-split-string (string &optional separators)
19613 "Splits STRING into substrings at SEPARATORS.
19614 No empty strings are returned if there are matches at the beginning
19615 and end of string."
19617 (start 0)
19618 notfirst
19619 (list nil))
19620 (while (and (string-match rexp string
19621 (if (and notfirst
19622 (= start (match-beginning 0))
19623 (< start (length string)))
19624 (1+ start) start))
19625 (< (match-beginning 0) (length string)))
19626 (setq notfirst t)
19627 (or (eq (match-beginning 0) 0)
19628 (and (eq (match-beginning 0) (match-end 0))
19629 (eq (match-beginning 0) start))
19630 (setq list
19631 (cons (substring string start (match-beginning 0))
19632 list)))
19633 (setq start (match-end 0)))
19634 (or (eq start (length string))
19635 (setq list
19636 (cons (substring string start)
19637 list)))
19638 (nreverse list)))
19640 (defun org-quote-vert (s)
19642 (while (string-match "|" s)
19644 s)
19646 (defun org-uuidgen-p (s)
19647 "Is S an ID created by UUIDGEN?"
19648 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19650 (defun org-in-src-block-p nil
19651 "Whether point is in a code source block."
19652 (let (ov)
19653 (when (setq ov (overlays-at (point)))
19654 (memq 'org-block-background
19655 (overlay-properties
19656 (car ov))))))
19658 (defun org-context ()
19659 "Return a list of contexts of the current cursor position.
19660 If several contexts apply, all are returned.
19661 Each context entry is a list with a symbol naming the context, and
19662 two positions indicating start and end of the context. Possible
19663 contexts are:
19665 :headline anywhere in a headline
19666 :headline-stars on the leading stars in a headline
19667 :todo-keyword on a TODO keyword (including DONE) in a headline
19668 :tags on the TAGS in a headline
19669 :priority on the priority cookie in a headline
19670 :item on the first line of a plain list item
19671 :item-bullet on the bullet/number of a plain list item
19672 :checkbox on the checkbox in a plain list item
19673 :table in an org-mode table
19674 :table-special on a special filed in a table
19675 :table-table in a table.el table
19676 :clocktable in a clocktable
19677 :src-block in a source block
19678 :link on a hyperlink
19679 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
19680 :target on a <<target>>
19681 :radio-target on a <<<radio-target>>>
19682 :latex-fragment on a LaTeX fragment
19683 :latex-preview on a LaTeX fragment with overlaid preview image
19685 This function expects the position to be visible because it uses font-lock
19686 faces as a help to recognize the following contexts: :table-special, :link,
19687 and :keyword."
19688 (let* ((f (get-text-property (point) 'face))
19689 (faces (if (listp f) f (list f)))
19690 (case-fold-search t)
19691 (p (point)) clist o)
19692 ;; First the large context
19693 (cond
19694 ((org-at-heading-p t)
19695 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19696 (when (progn
19697 (beginning-of-line 1)
19698 (looking-at org-todo-line-tags-regexp))
19699 (push (org-point-in-group p 1 :headline-stars) clist)
19700 (push (org-point-in-group p 2 :todo-keyword) clist)
19701 (push (org-point-in-group p 4 :tags) clist))
19702 (goto-char p)
19705 (push (org-point-in-group p 0 :priority) clist)))
19707 ((org-at-item-p)
19708 (push (org-point-in-group p 2 :item-bullet) clist)
19709 (push (list :item (point-at-bol)
19710 (save-excursion (org-end-of-item) (point)))
19711 clist)
19712 (and (org-at-item-checkbox-p)
19713 (push (org-point-in-group p 0 :checkbox) clist)))
19715 ((org-at-table-p)
19716 (push (list :table (org-table-begin) (org-table-end)) clist)
19717 (if (memq 'org-formula faces)
19718 (push (list :table-special
19719 (previous-single-property-change p 'face)
19720 (next-single-property-change p 'face)) clist)))
19721 ((org-at-table-p 'any)
19722 (push (list :table-table) clist)))
19723 (goto-char p)
19725 ;; New the "medium" contexts: clocktables, source blocks
19726 (cond ((org-in-clocktable-p)
19727 (push (list :clocktable
19729 (search-backward "#+BEGIN: clocktable" nil t))
19730 (match-beginning 0))
19732 (match-end 0))) clist))
19733 ((org-in-src-block-p)
19734 (push (list :src-block
19736 (search-backward "#+BEGIN_SRC" nil t))
19737 (match-beginning 0))
19738 (and (search-forward "#+END_SRC" nil t)
19739 (match-beginning 0))) clist)))
19740 (goto-char p)
19742 ;; Now the small context
19743 (cond
19744 ((org-at-timestamp-p)
19745 (push (org-point-in-group p 0 :timestamp) clist))
19746 ((memq 'org-link faces)
19747 (push (list :link
19748 (previous-single-property-change p 'face)
19749 (next-single-property-change p 'face)) clist))
19750 ((memq 'org-special-keyword faces)
19751 (push (list :keyword
19752 (previous-single-property-change p 'face)
19753 (next-single-property-change p 'face)) clist))
19754 ((org-at-target-p)
19755 (push (org-point-in-group p 0 :target) clist)
19756 (goto-char (1- (match-beginning 0)))
19757 (if (looking-at org-radio-target-regexp)
19758 (push (org-point-in-group p 0 :radio-target) clist))
19759 (goto-char p))
19760 ((setq o (car (delq nil
19761 (mapcar
19762 (lambda (x)
19763 (if (memq x org-latex-fragment-image-overlays) x))
19764 (overlays-at (point))))))
19765 (push (list :latex-fragment
19766 (overlay-start o) (overlay-end o)) clist)
19767 (push (list :latex-preview
19768 (overlay-start o) (overlay-end o)) clist))
19769 ((org-inside-LaTeX-fragment-p)
19770 ;; FIXME: positions wrong.
19771 (push (list :latex-fragment (point) (point)) clist)))
19773 (setq clist (nreverse (delq nil clist)))
19774 clist))
19776 ;; FIXME: Compare with at-regexp-p Do we need both?
19777 (defun org-in-regexp (re &optional nlines visually)
19778 "Check if point is inside a match of regexp.
19779 Normally only the current line is checked, but you can include NLINES extra
19780 lines both before and after point into the search.
19781 If VISUALLY is set, require that the cursor is not after the match but
19782 really on, so that the block visually is on the match."
19783 (catch 'exit
19784 (let ((pos (point))
19785 (eol (point-at-eol (+ 1 (or nlines 0))))
19786 (inc (if visually 1 0)))
19787 (save-excursion
19788 (beginning-of-line (- 1 (or nlines 0)))
19789 (while (re-search-forward re eol t)
19790 (if (and (<= (match-beginning 0) pos)
19791 (>= (+ inc (match-end 0)) pos))
19792 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19794 (defun org-at-regexp-p (regexp)
19795 "Is point inside a match of REGEXP in the current line?"
19796 (catch 'exit
19797 (save-excursion
19798 (let ((pos (point)) (end (point-at-eol)))
19799 (beginning-of-line 1)
19800 (while (re-search-forward regexp end t)
19801 (if (and (<= (match-beginning 0) pos)
19802 (>= (match-end 0) pos))
19803 (throw 'exit t)))
19804 nil))))
19806 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19807 "Non-nil when point is between matches of START-RE and END-RE.
19809 Also return a non-nil value when point is on one of the matches.
19811 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19812 buffer positions. Default values are the positions of headlines
19813 surrounding the point.
19815 The functions returns a cons cell whose car (resp. cdr) is the
19816 position before START-RE (resp. after END-RE)."
19817 (save-match-data
19818 (let ((pos (point))
19819 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19820 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19821 beg end)
19822 (save-excursion
19823 ;; Point is on a block when on START-RE or if START-RE can be
19824 ;; found before it...
19825 (and (or (org-at-regexp-p start-re)
19826 (re-search-backward start-re limit-up t))
19827 (setq beg (match-beginning 0))
19828 ;; ... and END-RE after it...
19829 (goto-char (match-end 0))
19830 (re-search-forward end-re limit-down t)
19831 (> (setq end (match-end 0)) pos)
19832 ;; ... without another START-RE in-between.
19833 (goto-char (match-beginning 0))
19834 (not (re-search-backward start-re (1+ beg) t))
19835 ;; Return value.
19836 (cons beg end))))))
19838 (defun org-in-block-p (names)
19839 "Non-nil when point belongs to a block whose name belongs to NAMES.
19841 NAMES is a list of strings containing names of blocks.
19843 Return first block name matched, or nil. Beware that in case of
19844 nested blocks, the returned name may not belong to the closest
19845 block from point."
19846 (save-match-data
19847 (catch 'exit
19848 (let ((case-fold-search t)
19849 (lim-up (save-excursion (outline-previous-heading)))
19850 (lim-down (save-excursion (outline-next-heading))))
19851 (mapc (lambda (name)
19852 (let ((n (regexp-quote name)))
19853 (when (org-between-regexps-p
19856 lim-up lim-down)
19857 (throw 'exit n))))
19858 names))
19859 nil)))
19861 (defun org-occur-in-agenda-files (regexp &optional nlines)
19862 "Call `multi-occur' with buffers for all agenda files."
19864 (let* ((files (org-agenda-files))
19865 (tnames (mapcar 'file-truename files))
19866 (extra org-agenda-text-search-extra-files)
19867 f)
19868 (when (eq (car extra) 'agenda-archives)
19869 (setq extra (cdr extra))
19870 (setq files (org-add-archive-files files)))
19871 (while (setq f (pop extra))
19872 (unless (member (file-truename f) tnames)
19873 (add-to-list 'files f 'append)
19874 (add-to-list 'tnames (file-truename f) 'append)))
19875 (multi-occur
19876 (mapcar (lambda (x)
19877 (with-current-buffer
19878 (or (get-file-buffer x) (find-file-noselect x))
19879 (widen)
19880 (current-buffer)))
19881 files)
19882 regexp)))
19884 (if (boundp 'occur-mode-find-occurrence-hook)
19885 ;; Emacs 23
19886 (add-hook 'occur-mode-find-occurrence-hook
19887 (lambda ()
19888 (when (eq major-mode 'org-mode)
19889 (org-reveal))))
19890 ;; Emacs 22
19891 (defadvice occur-mode-goto-occurrence
19892 (after org-occur-reveal activate)
19893 (and (eq major-mode 'org-mode) (org-reveal)))
19894 (defadvice occur-mode-goto-occurrence-other-window
19895 (after org-occur-reveal activate)
19896 (and (eq major-mode 'org-mode) (org-reveal)))
19897 (defadvice occur-mode-display-occurrence
19898 (after org-occur-reveal activate)
19899 (when (eq major-mode 'org-mode)
19900 (let ((pos (occur-mode-find-occurrence)))
19901 (with-current-buffer (marker-buffer pos)
19902 (save-excursion
19903 (goto-char pos)
19904 (org-reveal)))))))
19906 (defun org-occur-link-in-agenda-files ()
19907 "Create a link and search for it in the agendas.
19908 The link is not stored in `org-stored-links', it is just created
19909 for the search purpose."
19910 (interactive)
19911 (let ((link (condition-case nil
19912 (org-store-link nil)
19913 (error "Unable to create a link to here"))))
19914 (org-occur-in-agenda-files (regexp-quote link))))
19916 (defun org-uniquify (list)
19917 "Remove duplicate elements from LIST."
19918 (let (res)
19919 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19920 res))
19922 (defun org-delete-all (elts list)
19923 "Remove all elements in ELTS from LIST."
19924 (while elts
19925 (setq list (delete (pop elts) list)))
19926 list)
19928 (defun org-count (cl-item cl-seq)
19929 "Count the number of occurrences of ITEM in SEQ.
19930 Taken from `count' in cl-seq.el with all keyword arguments removed."
19931 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19932 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19933 (while (< cl-start cl-end)
19934 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19935 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19936 (setq cl-start (1+ cl-start)))
19937 cl-count))
19939 (defun org-remove-if (predicate seq)
19940 "Remove everything from SEQ that fulfills PREDICATE."
19941 (let (res e)
19942 (while seq
19943 (setq e (pop seq))
19944 (if (not (funcall predicate e)) (push e res)))
19945 (nreverse res)))
19947 (defun org-remove-if-not (predicate seq)
19948 "Remove everything from SEQ that does not fulfill PREDICATE."
19949 (let (res e)
19950 (while seq
19951 (setq e (pop seq))
19952 (if (funcall predicate e) (push e res)))
19953 (nreverse res)))
19955 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19956 "Reduce two-argument FUNCTION across SEQ.
19957 Taken from `reduce' in cl-seq.el with all keyword arguments but
19959 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19960 (cadr (memq :initial-value cl-keys)))
19961 (cl-seq (pop cl-seq))
19962 (t (funcall cl-func)))))
19963 (while cl-seq
19964 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19965 cl-accum))
19967 (defun org-back-over-empty-lines ()
19968 "Move backwards over whitespace, to the beginning of the first empty line.
19969 Returns the number of empty lines passed."
19970 (let ((pos (point)))
19971 (if (cdr (assoc 'heading org-blank-before-new-entry))
19973 (unless (eobp)
19974 (forward-line -1)))
19975 (beginning-of-line 2)
19976 (goto-char (min (point) pos))
19977 (count-lines (point) pos)))
19979 (defun org-skip-whitespace ()
19982 (defun org-point-in-group (point group &optional context)
19983 "Check if POINT is in match-group GROUP.
19984 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19985 match. If the match group does not exist or point is not inside it,
19986 return nil."
19987 (and (match-beginning group)
19988 (>= point (match-beginning group))
19989 (<= point (match-end group))
19990 (if context
19991 (list context (match-beginning group) (match-end group))
19992 t)))
19994 (defun org-switch-to-buffer-other-window (&rest args)
19995 "Switch to buffer in a second window on the current frame.
19996 In particular, do not allow pop-up frames.
19997 Returns the newly created buffer."
19998 (let (pop-up-frames special-display-buffer-names special-display-regexps
19999 special-display-function)
20000 (apply 'switch-to-buffer-other-window args)))
20002 (defun org-combine-plists (&rest plists)
20003 "Create a single property list from all plists in PLISTS.
20004 The process starts by copying the first list, and then setting properties
20005 from the other lists. Settings in the last list are the most significant
20006 ones and overrule settings in the other lists."
20007 (let ((rtn (copy-sequence (pop plists)))
20008 p v ls)
20009 (while plists
20010 (setq ls (pop plists))
20011 (while ls
20012 (setq p (pop ls) v (pop ls))
20013 (setq rtn (plist-put rtn p v))))
20014 rtn))
20016 (defun org-move-line-down (arg)
20017 "Move the current line down. With prefix argument, move it past ARG lines."
20018 (interactive "p")
20019 (let ((col (current-column))
20020 beg end pos)
20021 (beginning-of-line 1) (setq beg (point))
20022 (beginning-of-line 2) (setq end (point))
20023 (beginning-of-line (+ 1 arg))
20024 (setq pos (move-marker (make-marker) (point)))
20025 (insert (delete-and-extract-region beg end))
20026 (goto-char pos)
20027 (org-move-to-column col)))
20029 (defun org-move-line-up (arg)
20030 "Move the current line up. With prefix argument, move it past ARG lines."
20031 (interactive "p")
20032 (let ((col (current-column))
20033 beg end pos)
20034 (beginning-of-line 1) (setq beg (point))
20035 (beginning-of-line 2) (setq end (point))
20036 (beginning-of-line (- arg))
20037 (setq pos (move-marker (make-marker) (point)))
20038 (insert (delete-and-extract-region beg end))
20039 (goto-char pos)
20040 (org-move-to-column col)))
20042 (defun org-replace-escapes (string table)
20043 "Replace %-escapes in STRING with values in TABLE.
20045 The sequences in STRING may contain normal field width and padding information,
20047 so values can contain further %-escapes if they are define later in TABLE."
20048 (let ((tbl (copy-alist table))
20049 (case-fold-search nil)
20050 (pchg 0)
20051 e re rpl)
20052 (while (setq e (pop tbl))
20053 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20054 (when (and (cdr e) (string-match re (cdr e)))
20055 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20056 (safe "SREF"))
20057 (add-text-properties 0 3 (list 'sref sref) safe)
20058 (setcdr e (replace-match safe t t (cdr e)))))
20059 (while (string-match re string)
20060 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20061 (cdr e)))
20062 (setq string (replace-match rpl t t string))))
20063 (while (setq pchg (next-property-change pchg string))
20064 (let ((sref (get-text-property pchg 'sref string)))
20065 (when (and sref (string-match "SREF" string pchg))
20066 (setq string (replace-match sref t t string)))))
20067 string))
20069 (defun org-sublist (list start end)
20070 "Return a section of LIST, from START to END.
20071 Counting starts at 1."
20072 (let (rtn (c start))
20073 (setq list (nthcdr (1- start) list))
20074 (while (and list (<= c end))
20075 (push (pop list) rtn)
20076 (setq c (1+ c)))
20077 (nreverse rtn)))
20079 (defun org-find-base-buffer-visiting (file)
20080 "Like `find-buffer-visiting' but always return the base buffer and
20081 not an indirect buffer."
20082 (let ((buf (or (get-file-buffer file)
20083 (find-buffer-visiting file))))
20084 (if buf
20085 (or (buffer-base-buffer buf) buf)
20086 nil)))
20088 (defun org-image-file-name-regexp (&optional extensions)
20089 "Return regexp matching the file names of images.
20090 If EXTENSIONS is given, only match these."
20091 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20092 (image-file-name-regexp)
20093 (let ((image-file-name-extensions
20094 (or extensions
20095 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20096 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20098 (regexp-opt (nconc (mapcar 'upcase
20099 image-file-name-extensions)
20100 image-file-name-extensions)
20101 t)
20104 (defun org-file-image-p (file &optional extensions)
20105 "Return non-nil if FILE is an image."
20106 (save-match-data
20107 (string-match (org-image-file-name-regexp extensions) file)))
20109 (defun org-get-cursor-date ()
20110 "Return the date at cursor in as a time.
20111 This works in the calendar and in the agenda, anywhere else it just
20112 returns the current time."
20113 (let (date day defd)
20114 (cond
20115 ((eq major-mode 'calendar-mode)
20116 (setq date (calendar-cursor-to-date)
20117 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20118 ((eq major-mode 'org-agenda-mode)
20119 (setq day (get-text-property (point) 'day))
20120 (if day
20121 (setq date (calendar-gregorian-from-absolute day)
20122 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20123 (nth 2 date))))))
20124 (or defd (current-time))))
20126 (defvar org-agenda-action-marker (make-marker)
20127 "Marker pointing to the entry for the next agenda action.")
20129 (defun org-mark-entry-for-agenda-action ()
20130 "Mark the current entry as target of an agenda action.
20131 Agenda actions are actions executed from the agenda with the key `k',
20132 which make use of the date at the cursor."
20133 (interactive)
20134 (move-marker org-agenda-action-marker
20135 (save-excursion (org-back-to-heading t) (point))
20136 (current-buffer))
20137 (message
20138 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20140 (defun org-mark-subtree ()
20141 "Mark the current subtree.
20142 This puts point at the start of the current subtree, and mark at the end.
20144 If point is in an inline task, mark that task instead."
20145 (interactive)
20146 (let ((inline-task-p
20147 (and (featurep 'org-inlinetask)
20148 (org-inlinetask-in-task-p)))
20149 (beg))
20150 ;; Get beginning of subtree
20151 (cond
20152 (inline-task-p (org-inlinetask-goto-beginning))
20153 ((org-at-heading-p) (beginning-of-line))
20154 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20155 (setq beg (point))
20156 ;; Get end of it
20157 (if inline-task-p
20158 (org-inlinetask-goto-end)
20159 (org-end-of-subtree))
20160 ;; Mark zone
20161 (push-mark (point) nil t)
20162 (goto-char beg)))
20164 ;;; Paragraph filling stuff.
20165 ;; We want this to be just right, so use the full arsenal.
20167 (defun org-indent-line-function ()
20168 "Indent line depending on context."
20169 (interactive)
20170 (let* ((pos (point))
20171 (itemp (org-at-item-p))
20172 (case-fold-search t)
20174 (inline-task-p (and (featurep 'org-inlinetask)
20175 (org-inlinetask-in-task-p)))
20176 (inline-re (and inline-task-p
20177 (org-inlinetask-outline-regexp)))
20178 column)
20179 (beginning-of-line 1)
20180 (cond
20181 ;; Comments
20182 ((looking-at "# ") (setq column 0))
20183 ;; Headings
20184 ((looking-at org-outline-regexp) (setq column 0))
20185 ;; Included files
20187 ;; Footnote definition
20188 ((looking-at org-footnote-definition-re) (setq column 0))
20189 ;; Literal examples
20191 (setq column (org-get-indentation))) ; do nothing
20192 ;; Lists
20193 ((ignore-errors (goto-char (org-in-item-p)))
20194 (setq column (if itemp
20195 (org-get-indentation)
20196 (org-list-item-body-column (point))))
20197 (goto-char pos))
20198 ;; Drawers
20200 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20201 (save-excursion
20202 (goto-char (1- (match-beginning 1)))
20203 (setq column (current-column))))
20204 ;; Special blocks
20206 (save-excursion
20207 (re-search-backward
20209 (setq column (org-get-indentation (match-string 0))))
20212 (save-excursion
20214 (setq column
20215 (cond ((equal (downcase (match-string 1)) "src")
20216 ;; src blocks: let `org-edit-src-exit' handle them
20217 (org-get-indentation))
20218 ((equal (downcase (match-string 1)) "example")
20219 (max (org-get-indentation)
20220 (org-get-indentation (match-string 0))))
20221 (t
20222 (org-get-indentation (match-string 0))))))
20223 ;; This line has nothing special, look at the previous relevant
20224 ;; line to compute indentation
20225 (t
20226 (beginning-of-line 0)
20227 (while (and (not (bobp))
20228 (not (looking-at org-drawer-regexp))
20229 ;; When point started in an inline task, do not move
20230 ;; above task starting line.
20231 (not (and inline-task-p (looking-at inline-re)))
20232 ;; Skip drawers, blocks, empty lines, verbatim,
20233 ;; comments, tables, footnotes definitions, lists,
20234 ;; inline tasks.
20236 (re-search-backward org-drawer-regexp nil t))
20240 (looking-at org-footnote-definition-re)
20241 (and (ignore-errors (goto-char (org-in-item-p)))
20242 (goto-char
20243 (org-list-get-top-point (org-list-struct))))
20244 (and (not inline-task-p)
20245 (featurep 'org-inlinetask)
20246 (org-inlinetask-in-task-p)
20247 (or (org-inlinetask-goto-beginning) t))))
20248 (beginning-of-line 0))
20249 (cond
20250 ;; There was an heading above.
20252 (if (not org-adapt-indentation)
20253 (setq column 0)
20254 (goto-char (match-end 0))
20255 (setq column (current-column))))
20256 ;; A drawer had started and is unfinished
20257 ((looking-at org-drawer-regexp)
20258 (goto-char (1- (match-beginning 1)))
20259 (setq column (current-column)))
20260 ;; Else, nothing noticeable found: get indentation and go on.
20261 (t (setq column (org-get-indentation))))))
20262 ;; Now apply indentation and move cursor accordingly
20263 (goto-char pos)
20264 (if (<= (current-column) (current-indentation))
20265 (org-indent-line-to column)
20266 (save-excursion (org-indent-line-to column)))
20267 ;; Special polishing for properties, see `org-property-format'
20268 (setq column (current-column))
20269 (beginning-of-line 1)
20270 (if (looking-at
20272 (replace-match (concat (match-string 1)
20273 (format org-property-format
20274 (match-string 2) (match-string 3)))
20275 t t))
20276 (org-move-to-column column)))
20278 (defun org-indent-drawer ()
20279 "Indent the drawer at point."
20280 (interactive)
20281 (let ((p (point))
20282 (e (and (save-excursion (re-search-forward ":END:" nil t))
20283 (match-end 0)))
20284 (folded
20285 (save-excursion
20286 (end-of-line)
20287 (when (overlays-at (point))
20288 (member 'invisible (overlay-properties
20289 (car (overlays-at (point)))))))))
20290 (when folded (org-cycle))
20291 (indent-for-tab-command)
20292 (while (and (move-beginning-of-line 2) (< (point) e))
20293 (indent-for-tab-command))
20294 (goto-char p)
20295 (when folded (org-cycle)))
20296 (message "Drawer at point indented"))
20298 (defun org-indent-block ()
20299 "Indent the block at point."
20300 (interactive)
20301 (let ((p (point))
20302 (case-fold-search t)
20304 (match-end 0)))
20305 (folded
20306 (save-excursion
20307 (end-of-line)
20308 (when (overlays-at (point))
20309 (member 'invisible (overlay-properties
20310 (car (overlays-at (point)))))))))
20311 (when folded (org-cycle))
20312 (indent-for-tab-command)
20313 (while (and (move-beginning-of-line 2) (< (point) e))
20314 (indent-for-tab-command))
20315 (goto-char p)
20316 (when folded (org-cycle)))
20317 (message "Block at point indented"))
20319 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20320 "Variable to store copy of `adaptive-fill-regexp'.
20321 Since `adaptive-fill-regexp' is set to never match, we need to
20322 store a backup of its value before entering `org-mode' so that
20323 the functionality can be provided as a fall-back.")
20325 (defun org-set-autofill-regexps ()
20326 (interactive)
20327 ;; In the paragraph separator we include headlines, because filling
20328 ;; text in a line directly attached to a headline would otherwise
20329 ;; fill the headline as well.
20332 ;; The paragraph starter includes hand-formatted lists.
20333 (org-set-local
20334 'paragraph-start
20335 (concat
20344 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20345 ;; But only if the user has not turned off tables or fixed-width regions
20346 (org-set-local
20347 'auto-fill-inhibit-regexp
20348 (concat org-outline-regexp
20351 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20352 (concat
20354 (if org-enable-table-editor "|" "")
20355 (if org-enable-fixed-width-editor ":" "")
20356 "]"))))
20357 ;; We use our own fill-paragraph function, to make sure that tables
20358 ;; and fixed-width regions are not wrapped. That function will pass
20359 ;; through to `fill-paragraph' when appropriate.
20360 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20361 ;; Prevent auto-fill from inserting unwanted new items.
20362 (if (boundp 'fill-nobreak-predicate)
20363 (org-set-local
20364 'fill-nobreak-predicate
20365 (org-uniquify
20366 (append fill-nobreak-predicate
20367 '(org-fill-item-nobreak-p org-fill-line-break-nobreak-p)))))
20368 ;; Adaptive filling: To get full control, first make sure that
20369 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20370 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20371 (org-set-local 'org-adaptive-fill-regexp-backup
20372 adaptive-fill-regexp))
20374 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20375 (org-set-local 'adaptive-fill-function
20376 'org-adaptive-fill-function)
20377 (org-set-local
20378 'align-mode-rules-list
20379 '((org-in-buffer-settings
20381 (modes . '(org-mode))))))
20383 (defun org-fill-item-nobreak-p ()
20384 "Non-nil when a line break at point would insert a new item."
20385 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20387 (defun org-fill-line-break-nobreak-p ()
20388 "Non-nil when a line break at point would create an Org line break."
20389 (save-excursion
20394 (defun org-fill-paragraph (&optional justify)
20395 "Re-align a table, pass through to fill-paragraph if no table."
20396 (let ((table-p (org-at-table-p))
20397 (table.el-p (org-at-table.el-p))
20398 (itemp (org-in-item-p)))
20399 (cond ((and (equal (char-after (point-at-bol)) ?*)
20400 (save-excursion (goto-char (point-at-bol))
20401 (looking-at org-outline-regexp)))
20402 t) ; skip headlines
20403 (table.el-p t) ; skip table.el tables
20404 (table-p (org-table-align) t) ; align Org tables
20405 (itemp ; align text in items
20406 (let* ((struct (save-excursion (goto-char itemp)
20407 (org-list-struct)))
20408 (parents (org-list-parents-alist struct))
20409 (children (org-list-get-children itemp struct parents))
20410 beg end prev next prefix)
20411 ;; Determine in which part of item point is: before
20412 ;; first child, after last child, between two
20413 ;; sub-lists, or simply in item if there's no child.
20414 (cond
20415 ((not children)
20416 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20417 beg itemp
20418 end (org-list-get-item-end itemp struct)))
20419 ((< (point) (setq next (car children)))
20420 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20421 beg itemp
20422 end next))
20423 ((> (point) (setq prev (car (last children))))
20424 (setq beg (org-list-get-item-end prev struct)
20425 end (org-list-get-item-end itemp struct)
20426 prefix (save-excursion
20427 (goto-char beg)
20429 (make-string (current-column) ?\ ))))
20430 (t (catch 'exit
20431 (while (setq next (pop children))
20432 (if (> (point) next)
20433 (setq prev next)
20434 (setq beg (org-list-get-item-end prev struct)
20435 end next
20436 prefix (save-excursion
20437 (goto-char beg)
20439 (make-string (current-column) ?\ )))
20440 (throw 'exit nil))))))
20441 ;; Use `fill-paragraph' with buffer narrowed to item
20442 ;; without any child, and with our computed PREFIX.
20443 (flet ((fill-context-prefix (from to &optional flr) prefix))
20444 (save-restriction
20445 (narrow-to-region beg end)
20446 (save-excursion (fill-paragraph justify)))) t))
20447 ;; Special case where point is not in a list but is on
20448 ;; a paragraph adjacent to a list: make sure this paragraph
20449 ;; doesn't get merged with the end of the list by narrowing
20450 ;; buffer first.
20451 ((save-excursion (forward-paragraph -1)
20452 (setq itemp (org-in-item-p)))
20453 (let ((struct (save-excursion (goto-char itemp)
20454 (org-list-struct))))
20455 (save-restriction
20456 (narrow-to-region (org-list-get-bottom-point struct)
20457 (save-excursion (forward-paragraph 1)
20458 (point)))
20459 (fill-paragraph justify) t)))
20460 ;; Else simply call `fill-paragraph'.
20461 (t nil))))
20463 ;; For reference, this is the default value of adaptive-fill-regexp
20466 (defun org-adaptive-fill-function ()
20467 "Return a fill prefix for org-mode files."
20468 (let (itemp)
20469 (save-excursion
20470 (cond
20471 ;; Comment line
20473 (match-string-no-properties 0))
20474 ;; Plain list item
20475 ((org-at-item-p)
20476 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20477 ;; Point is in a list after `backward-paragraph': original
20478 ;; point wasn't in the list, or filling would have been taken
20479 ;; care of by `org-auto-fill-function', but the list and the
20480 ;; real paragraph are not separated by a blank line. Thus, move
20481 ;; point after the list to go back to real paragraph and
20482 ;; determine fill-prefix.
20483 ((setq itemp (org-in-item-p))
20484 (goto-char itemp)
20485 (let* ((struct (org-list-struct))
20486 (bottom (org-list-get-bottom-point struct)))
20487 (goto-char bottom)
20488 (make-string (org-get-indentation) ?\ )))
20489 ;; Other text
20490 ((looking-at org-adaptive-fill-regexp-backup)
20491 (match-string-no-properties 0))))))
20493 (defun org-auto-fill-function ()
20494 "Auto-fill function."
20495 (let (itemp prefix)
20496 ;; When in a list, compute an appropriate fill-prefix and make
20497 ;; sure it will be used by `do-auto-fill'.
20498 (if (setq itemp (org-in-item-p))
20499 (progn
20500 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20501 (flet ((fill-context-prefix (from to &optional flr) prefix))
20502 (do-auto-fill)))
20503 ;; Else just use `do-auto-fill'.
20504 (do-auto-fill))))
20506 ;;; Other stuff.
20508 (defun org-toggle-fixed-width-section (arg)
20509 "Toggle the fixed-width export.
20510 If there is no active region, the QUOTE keyword at the current headline is
20511 inserted or removed. When present, it causes the text between this headline
20512 and the next to be exported as fixed-width text, and unmodified.
20513 If there is an active region, this command adds or removes a colon as the
20514 first character of this line. If the first character of a line is a colon,
20515 this line is also exported in fixed-width font."
20516 (interactive "P")
20517 (let* ((cc 0)
20518 (regionp (org-region-active-p))
20519 (beg (if regionp (region-beginning) (point)))
20520 (end (if regionp (region-end)))
20521 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20522 (case-fold-search nil)
20524 off)
20525 (if regionp
20526 (save-excursion
20527 (goto-char beg)
20528 (setq cc (current-column))
20529 (beginning-of-line 1)
20530 (setq off (looking-at re))
20531 (while (> nlines 0)
20532 (setq nlines (1- nlines))
20533 (beginning-of-line 1)
20534 (cond
20535 (arg
20536 (org-move-to-column cc t)
20538 (forward-line -1))
20539 ((and off (looking-at re))
20540 (replace-match "" t t nil 1))
20541 ((not off) (org-move-to-column cc t) (insert ": ")))
20542 (forward-line 1)))
20543 (save-excursion
20544 (org-back-to-heading)
20545 (cond
20546 ((looking-at (format org-heading-keyword-regexp-format
20547 org-quote-string))
20548 (goto-char (match-end 1))
20549 (looking-at (concat " +" org-quote-string))
20550 (replace-match "" t t)
20551 (when (eolp) (insert " ")))
20552 ((looking-at org-outline-regexp)
20553 (goto-char (match-end 0))
20554 (insert org-quote-string " ")))))))
20556 (defun org-reftex-citation ()
20557 "Use reftex-citation to insert a citation into the buffer.
20558 This looks for a line like
20560 #+BIBLIOGRAPHY: foo plain option:-d
20562 and derives from it that foo.bib is the bibliography file relevant
20563 for this document. It then installs the necessary environment for RefTeX
20564 to work in this buffer and calls `reftex-citation' to insert a citation
20565 into the buffer.
20567 Export of such citations to both LaTeX and HTML is handled by the contributed
20568 package org-exp-bibtex by Taru Karttunen."
20569 (interactive)
20570 (let ((reftex-docstruct-symbol 'rds)
20572 rds bib)
20573 (save-excursion
20574 (save-restriction
20575 (widen)
20576 (let ((case-fold-search t)
20578 (if (not (save-excursion
20579 (or (re-search-forward re nil t)
20580 (re-search-backward re nil t))))
20581 (error "No bibliography defined in file")
20582 (setq bib (concat (match-string 1) ".bib")
20583 rds (list (list 'bib bib)))))))
20584 (call-interactively 'reftex-citation)))
20586 ;;;; Functions extending outline functionality
20588 (defun org-beginning-of-line (&optional arg)
20589 "Go to the beginning of the current line. If that is invisible, continue
20590 to a visible line beginning. This makes the function of C-a more intuitive.
20591 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20592 first attempt, and only move to after the tags when the cursor is already
20593 beyond the end of the headline."
20594 (interactive "P")
20595 (let ((pos (point))
20596 (special (if (consp org-special-ctrl-a/e)
20597 (car org-special-ctrl-a/e)
20598 org-special-ctrl-a/e))
20599 refpos)
20600 (if (org-bound-and-true-p line-move-visual)
20601 (beginning-of-visual-line 1)
20602 (beginning-of-line 1))
20603 (if (and arg (fboundp 'move-beginning-of-line))
20604 (call-interactively 'move-beginning-of-line)
20605 (if (bobp)
20606 nil
20607 (backward-char 1)
20608 (if (org-truely-invisible-p)
20609 (while (and (not (bobp)) (org-truely-invisible-p))
20610 (backward-char 1)
20611 (beginning-of-line 1))
20612 (forward-char 1))))
20613 (when special
20614 (cond
20615 ((and (looking-at org-complex-heading-regexp)
20616 (= (char-after (match-end 1)) ?\ ))
20617 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20618 (point-at-eol)))
20619 (goto-char
20620 (if (eq special t)
20621 (cond ((> pos refpos) refpos)
20622 ((= pos (point)) refpos)
20623 (t (point)))
20624 (cond ((> pos (point)) (point))
20625 ((not (eq last-command this-command)) (point))
20626 (t refpos)))))
20627 ((org-at-item-p)
20628 ;; Being at an item and not looking at an the item means point
20629 ;; was previously moved to beginning of a visual line, whiche
20630 ;; doesn't contain the item. Therefore, do nothing special,
20631 ;; just stay here.
20632 (when (looking-at org-list-full-item-re)
20633 ;; Set special position at first white space character after
20634 ;; bullet, and check-box, if any.
20635 (let ((after-bullet
20636 (let ((box (match-end 3)))
20637 (if (not box) (match-end 1)
20638 (let ((after (char-after box)))
20639 (if (and after (= after ? )) (1+ box) box))))))
20640 ;; Special case: Move point to special position when
20641 ;; currently after it or at beginning of line.
20642 (if (eq special t)
20643 (when (or (> pos after-bullet) (= (point) pos))
20644 (goto-char after-bullet))
20645 ;; Reversed case: Move point to special position when
20646 ;; point was already at beginning of line and command is
20647 ;; repeated.
20648 (when (and (= (point) pos) (eq last-command this-command))
20649 (goto-char after-bullet))))))))
20650 (org-no-warnings
20651 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20653 (defun org-end-of-line (&optional arg)
20654 "Go to the end of the line.
20655 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20656 first attempt, and only move to after the tags when the cursor is already
20657 beyond the end of the headline."
20658 (interactive "P")
20659 (let ((special (if (consp org-special-ctrl-a/e)
20660 (cdr org-special-ctrl-a/e)
20661 org-special-ctrl-a/e)))
20662 (cond
20663 ((or (not special) arg
20664 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20665 (call-interactively
20666 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20667 ((fboundp 'move-end-of-line) 'move-end-of-line)
20668 (t 'end-of-line))))
20669 ((org-at-heading-p)
20670 (let ((pos (point)))
20671 (beginning-of-line 1)
20673 (if (eq special t)
20674 (if (or (< pos (match-beginning 1))
20675 (= pos (match-end 0)))
20676 (goto-char (match-beginning 1))
20677 (goto-char (match-end 0)))
20678 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20679 (goto-char (match-end 0))
20680 (goto-char (match-beginning 1))))
20681 (call-interactively (if (fboundp 'move-end-of-line)
20682 'move-end-of-line
20683 'end-of-line)))))
20684 ((org-at-drawer-p)
20685 (move-end-of-line 1)
20686 (when (overlays-at (1- (point))) (backward-char 1)))
20687 ;; At an item: Move before any hidden text.
20688 (t (call-interactively
20689 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20690 ((fboundp 'move-end-of-line) 'move-end-of-line)
20691 (t 'end-of-line)))))
20692 (org-no-warnings
20693 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20695 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20696 (define-key org-mode-map "\C-e" 'org-end-of-line)
20698 (defun org-backward-sentence (&optional arg)
20699 "Go to beginning of sentence, or beginning of table field.
20700 This will call `backward-sentence' or `org-table-beginning-of-field',
20701 depending on context."
20702 (interactive "P")
20703 (cond
20704 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20705 (t (call-interactively 'backward-sentence))))
20707 (defun org-forward-sentence (&optional arg)
20708 "Go to end of sentence, or end of table field.
20709 This will call `forward-sentence' or `org-table-end-of-field',
20710 depending on context."
20711 (interactive "P")
20712 (cond
20713 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20714 (t (call-interactively 'forward-sentence))))
20716 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20717 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20719 (defun org-kill-line (&optional arg)
20720 "Kill line, to tags or end of line."
20721 (interactive "P")
20722 (cond
20723 ((or (not org-special-ctrl-k)
20724 (bolp)
20725 (not (org-at-heading-p)))
20726 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20727 org-ctrl-k-protect-subtree)
20728 (if (or (eq org-ctrl-k-protect-subtree 'error)
20729 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20730 (error "C-k aborted - would kill hidden subtree")))
20731 (call-interactively
20732 (if visual-line-mode 'kill-visual-line 'kill-line)))
20734 (kill-region (point) (match-beginning 1))
20735 (org-set-tags nil t))
20736 (t (kill-region (point) (point-at-eol)))))
20738 (define-key org-mode-map "\C-k" 'org-kill-line)
20740 (defun org-yank (&optional arg)
20741 "Yank. If the kill is a subtree, treat it specially.
20742 This command will look at the current kill and check if is a single
20743 subtree, or a series of subtrees[1]. If it passes the test, and if the
20744 cursor is at the beginning of a line or after the stars of a currently
20745 empty headline, then the yank is handled specially. How exactly depends
20746 on the value of the following variables, both set by default.
20748 org-yank-folded-subtrees
20749 When set, the subtree(s) will be folded after insertion, but only
20750 if doing so would now swallow text after the yanked text.
20752 org-yank-adjusted-subtrees
20753 When set, the subtree will be promoted or demoted in order to
20754 fit into the local outline tree structure, which means that the level
20755 will be adjusted so that it becomes the smaller one of the two
20756 *visible* surrounding headings.
20758 Any prefix to this command will cause `yank' to be called directly with
20760 will just
20761 plainly yank the text as it is.
20763 \[1] The test checks if the first non-white line is a heading
20764 and if there are no other headings with fewer stars."
20765 (interactive "P")
20766 (org-yank-generic 'yank arg))
20768 (defun org-yank-generic (command arg)
20769 "Perform some yank-like command.
20771 This function implements the behavior described in the `org-yank'
20772 documentation. However, it has been generalized to work for any
20773 interactive command with similar behavior."
20775 ;; pretend to be command COMMAND
20776 (setq this-command command)
20778 (if arg
20779 (call-interactively command)
20781 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20782 (and (org-kill-is-subtree-p)
20783 (or (bolp)
20785 (string-match
20787 (buffer-substring (point-at-bol) (point)))))))
20788 swallowp)
20789 (cond
20790 ((and subtreep org-yank-folded-subtrees)
20791 (let ((beg (point))
20792 end)
20793 (if (and subtreep org-yank-adjusted-subtrees)
20794 (org-paste-subtree nil nil 'for-yank)
20795 (call-interactively command))
20797 (setq end (point))
20798 (goto-char beg)
20799 (when (and (bolp) subtreep
20800 (not (setq swallowp
20801 (org-yank-folding-would-swallow-text beg end))))
20802 (org-with-limited-levels
20803 (or (looking-at org-outline-regexp)
20804 (re-search-forward org-outline-regexp-bol end t))
20805 (while (and (< (point) end) (looking-at org-outline-regexp))
20806 (hide-subtree)
20807 (org-cycle-show-empty-lines 'folded)
20808 (condition-case nil
20809 (outline-forward-same-level 1)
20810 (error (goto-char end))))))
20811 (when swallowp
20812 (message
20813 "Inserted text not folded because that would swallow text"))
20815 (goto-char end)
20817 (beginning-of-line 1)
20818 (push-mark beg 'nomsg)))
20819 ((and subtreep org-yank-adjusted-subtrees)
20820 (let ((beg (point-at-bol)))
20821 (org-paste-subtree nil nil 'for-yank)
20822 (push-mark beg 'nomsg)))
20823 (t
20824 (call-interactively command))))))
20826 (defun org-yank-folding-would-swallow-text (beg end)
20827 "Would hide-subtree at BEG swallow any text after END?"
20828 (let (level)
20829 (org-with-limited-levels
20830 (save-excursion
20831 (goto-char beg)
20832 (when (or (looking-at org-outline-regexp)
20833 (re-search-forward org-outline-regexp-bol end t))
20834 (setq level (org-outline-level)))
20835 (goto-char end)
20837 (if (or (eobp)
20838 (and (bolp) (looking-at org-outline-regexp)
20839 (<= (org-outline-level) level)))
20840 nil ; Nothing would be swallowed
20841 t))))) ; something would swallow
20843 (define-key org-mode-map "\C-y" 'org-yank)
20845 (defun org-truely-invisible-p ()
20846 "Check if point is at a character currently not visible.
20847 This version does not only check the character property, but also
20848 `visible-mode'."
20849 ;; Early versions of noutline don't have `outline-invisible-p'.
20850 (if (org-bound-and-true-p visible-mode)
20851 nil
20852 (outline-invisible-p)))
20854 (defun org-invisible-p2 ()
20855 "Check if point is at a character currently not visible."
20856 (save-excursion
20857 (if (and (eolp) (not (bobp))) (backward-char 1))
20858 ;; Early versions of noutline don't have `outline-invisible-p'.
20859 (outline-invisible-p)))
20861 (defun org-back-to-heading (&optional invisible-ok)
20862 "Call `outline-back-to-heading', but provide a better error message."
20863 (condition-case nil
20864 (outline-back-to-heading invisible-ok)
20865 (error (error "Before first headline at position %d in buffer %s"
20866 (point) (current-buffer)))))
20868 (defun org-beginning-of-defun ()
20869 "Go to the beginning of the subtree, i.e. back to the heading."
20870 (org-back-to-heading))
20871 (defun org-end-of-defun ()
20872 "Go to the end of the subtree."
20873 (org-end-of-subtree nil t))
20875 (defun org-before-first-heading-p ()
20876 "Before first heading?"
20877 (save-excursion
20878 (end-of-line)
20879 (null (re-search-backward org-outline-regexp-bol nil t))))
20881 (defun org-at-heading-p (&optional ignored)
20882 (outline-on-heading-p t))
20883 ;; Compatibility alias with Org versions < 7.8.03
20884 (defalias 'org-on-heading-p 'org-at-heading-p)
20886 (defun org-at-drawer-p nil
20887 "Is cursor at a drawer keyword?"
20888 (save-excursion
20889 (move-beginning-of-line 1)
20890 (looking-at org-drawer-regexp)))
20892 (defun org-at-block-p nil
20893 "Is cursor at a block keyword?"
20894 (save-excursion
20895 (move-beginning-of-line 1)
20896 (looking-at org-block-regexp)))
20898 (defun org-point-at-end-of-empty-headline ()
20899 "If point is at the end of an empty headline, return t, else nil.
20900 If the heading only contains a TODO keyword, it is still still considered
20901 empty."
20903 (save-excursion
20904 (beginning-of-line 1)
20905 (let ((case-fold-search nil))
20906 (looking-at org-todo-line-regexp)))
20907 (string= (match-string 3) "")))
20909 (defun org-at-heading-or-item-p ()
20910 (or (org-at-heading-p) (org-at-item-p)))
20912 (defun org-at-target-p ()
20913 (or (org-in-regexp org-radio-target-regexp)
20914 (org-in-regexp org-target-regexp)))
20915 ;; Compatibility alias with Org versions < 7.8.03
20916 (defalias 'org-on-target-p 'org-at-target-p)
20918 (defun org-up-heading-all (arg)
20919 "Move to the heading line of which the present line is a subheading.
20920 This function considers both visible and invisible heading lines.
20921 With argument, move up ARG levels."
20922 (if (fboundp 'outline-up-heading-all)
20923 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20924 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20926 (defun org-up-heading-safe ()
20927 "Move to the heading line of which the present line is a subheading.
20928 This version will not throw an error. It will return the level of the
20929 headline found, or nil if no higher level is found.
20931 Also, this function will be a lot faster than `outline-up-heading',
20932 because it relies on stars being the outline starters. This can really
20933 make a significant difference in outlines with very many siblings."
20934 (let (start-level re)
20935 (org-back-to-heading t)
20936 (setq start-level (funcall outline-level))
20937 (if (equal start-level 1)
20938 nil
20940 (if (re-search-backward re nil t)
20941 (funcall outline-level)))))
20943 (defun org-first-sibling-p ()
20944 "Is this heading the first child of its parents?"
20945 (interactive)
20946 (let ((re org-outline-regexp-bol)
20947 level l)
20948 (unless (org-at-heading-p t)
20949 (error "Not at a heading"))
20950 (setq level (funcall outline-level))
20951 (save-excursion
20952 (if (not (re-search-backward re nil t))
20953 t
20954 (setq l (funcall outline-level))
20955 (< l level)))))
20957 (defun org-goto-sibling (&optional previous)
20958 "Goto the next sibling, even if it is invisible.
20959 When PREVIOUS is set, go to the previous sibling instead. Returns t
20960 when a sibling was found. When none is found, return nil and don't
20961 move point."
20962 (let ((fun (if previous 're-search-backward 're-search-forward))
20963 (pos (point))
20964 (re org-outline-regexp-bol)
20965 level l)
20966 (when (condition-case nil (org-back-to-heading t) (error nil))
20967 (setq level (funcall outline-level))
20968 (catch 'exit
20969 (or previous (forward-char 1))
20970 (while (funcall fun re nil t)
20971 (setq l (funcall outline-level))
20972 (when (< l level) (goto-char pos) (throw 'exit nil))
20973 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20974 (goto-char pos)
20975 nil))))
20977 (defun org-show-siblings ()
20978 "Show all siblings of the current headline."
20979 (save-excursion
20980 (while (org-goto-sibling) (org-flag-heading nil)))
20981 (save-excursion
20982 (while (org-goto-sibling 'previous)
20983 (org-flag-heading nil))))
20985 (defun org-goto-first-child ()
20986 "Goto the first child, even if it is invisible.
20987 Return t when a child was found. Otherwise don't move point and
20988 return nil."
20989 (let (level (pos (point)) (re org-outline-regexp-bol))
20990 (when (condition-case nil (org-back-to-heading t) (error nil))
20991 (setq level (outline-level))
20992 (forward-char 1)
20993 (if (and (re-search-forward re nil t) (> (outline-level) level))
20994 (progn (goto-char (match-beginning 0)) t)
20995 (goto-char pos) nil))))
20997 (defun org-show-hidden-entry ()
20998 "Show an entry where even the heading is hidden."
20999 (save-excursion
21000 (org-show-entry)))
21002 (defun org-flag-heading (flag &optional entry)
21003 "Flag the current heading. FLAG non-nil means make invisible.
21004 When ENTRY is non-nil, show the entire entry."
21005 (save-excursion
21006 (org-back-to-heading t)
21007 ;; Check if we should show the entire entry
21008 (if entry
21009 (progn
21010 (org-show-entry)
21011 (save-excursion
21012 (and (outline-next-heading)
21013 (org-flag-heading nil))))
21014 (outline-flag-region (max (point-min) (1- (point)))
21015 (save-excursion (outline-end-of-heading) (point))
21016 flag))))
21018 (defun org-get-next-sibling ()
21019 "Move to next heading of the same level, and return point.
21020 If there is no such heading, return nil.
21021 This is like outline-next-sibling, but invisible headings are ok."
21022 (let ((level (funcall outline-level)))
21023 (outline-next-heading)
21024 (while (and (not (eobp)) (> (funcall outline-level) level))
21025 (outline-next-heading))
21026 (if (or (eobp) (< (funcall outline-level) level))
21027 nil
21028 (point))))
21030 (defun org-get-last-sibling ()
21031 "Move to previous heading of the same level, and return point.
21032 If there is no such heading, return nil."
21033 (let ((opoint (point))
21034 (level (funcall outline-level)))
21035 (outline-previous-heading)
21036 (when (and (/= (point) opoint) (outline-on-heading-p t))
21037 (while (and (> (funcall outline-level) level)
21038 (not (bobp)))
21039 (outline-previous-heading))
21040 (if (< (funcall outline-level) level)
21041 nil
21042 (point)))))
21044 (defun org-end-of-subtree (&optional invisible-OK to-heading)
21045 ;; This contains an exact copy of the original function, but it uses
21046 ;; `org-back-to-heading', to make it work also in invisible
21047 ;; trees. And is uses an invisible-OK argument.
21048 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21049 ;; Furthermore, when used inside Org, finding the end of a large subtree
21050 ;; with many children and grandchildren etc, this can be much faster
21051 ;; than the outline version.
21052 (org-back-to-heading invisible-OK)
21053 (let ((first t)
21054 (level (funcall outline-level)))
21055 (if (and (eq major-mode 'org-mode) (< level 1000))
21056 ;; A true heading (not a plain list item), in Org-mode
21057 ;; This means we can easily find the end by looking
21058 ;; only for the right number of stars. Using a regexp to do
21059 ;; this is so much faster than using a Lisp loop.
21061 (forward-char 1)
21062 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21063 ;; something else, do it the slow way
21064 (while (and (not (eobp))
21065 (or first (> (funcall outline-level) level)))
21066 (setq first nil)
21067 (outline-next-heading)))
21068 (unless to-heading
21070 (progn
21071 ;; Go to end of line before heading
21072 (forward-char -1)
21074 ;; leave blank line before heading
21075 (forward-char -1))))))
21076 (point))
21078 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21079 "Use Org version in org-mode, for dramatic speed-up."
21080 (if (eq major-mode 'org-mode)
21081 (progn
21082 (org-end-of-subtree nil t)
21083 (unless (eobp) (backward-char 1)))
21084 ad-do-it))
21086 (defun org-end-of-meta-data-and-drawers ()
21087 "Jump to the first text after meta data and drawers in the current entry.
21088 This will move over empty lines, lines with planning time stamps,
21089 clocking lines, and drawers."
21090 (org-back-to-heading t)
21091 (let ((end (save-excursion (outline-next-heading) (point)))
21094 (forward-line 1)
21095 (while (re-search-forward re end t)
21096 (if (not (match-end 1))
21097 ;; empty or planning line
21098 (forward-line 1)
21099 ;; a drawer, find the end
21101 (forward-line 1)))
21103 (point)))
21105 (defun org-forward-same-level (arg &optional invisible-ok)
21106 "Move forward to the arg'th subheading at same level as this one.
21107 Stop at the first and last subheadings of a superior heading.
21108 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
21109 it wil also look at invisible ones."
21110 (interactive "p")
21111 (org-back-to-heading invisible-ok)
21112 (org-at-heading-p)
21113 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21115 l)
21116 (forward-char 1)
21117 (while (> arg 0)
21118 (while (and (re-search-forward re nil 'move)
21119 (setq l (- (match-end 0) (match-beginning 0) 1))
21120 (= l level)
21121 (not invisible-ok)
21122 (progn (backward-char 1) (outline-invisible-p)))
21123 (if (< l level) (setq arg 1)))
21124 (setq arg (1- arg)))
21125 (beginning-of-line 1)))
21127 (defun org-backward-same-level (arg &optional invisible-ok)
21128 "Move backward to the arg'th subheading at same level as this one.
21129 Stop at the first and last subheadings of a superior heading."
21130 (interactive "p")
21131 (org-back-to-heading)
21132 (org-at-heading-p)
21133 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21135 l)
21136 (while (> arg 0)
21137 (while (and (re-search-backward re nil 'move)
21138 (setq l (- (match-end 0) (match-beginning 0) 1))
21139 (= l level)
21140 (not invisible-ok)
21141 (outline-invisible-p))
21142 (if (< l level) (setq arg 1)))
21143 (setq arg (1- arg)))))
21145 (defun org-show-subtree ()
21146 "Show everything after this heading at deeper levels."
21147 (outline-flag-region
21148 (point)
21149 (save-excursion
21150 (org-end-of-subtree t t))
21151 nil))
21153 (defun org-show-entry ()
21154 "Show the body directly following this heading.
21155 Show the heading too, if it is currently invisible."
21156 (interactive)
21157 (save-excursion
21158 (condition-case nil
21159 (progn
21160 (org-back-to-heading t)
21161 (outline-flag-region
21162 (max (point-min) (1- (point)))
21163 (save-excursion
21164 (if (re-search-forward
21166 (match-beginning 1)
21167 (point-max)))
21168 nil)
21169 (org-cycle-hide-drawers 'children))
21170 (error nil))))
21172 (defun org-make-options-regexp (kwds &optional extra)
21173 "Make a regular expression for keyword lines."
21174 (concat
21175 "^"
21182 ;; Make isearch reveal the necessary context
21183 (defun org-isearch-end ()
21184 "Reveal context after isearch exits."
21185 (when isearch-success ; only if search was successful
21186 (if (featurep 'xemacs)
21187 ;; Under XEmacs, the hook is run in the correct place,
21188 ;; we directly show the context.
21189 (org-show-context 'isearch)
21190 ;; In Emacs the hook runs *before* restoring the overlays.
21191 ;; So we have to use a one-time post-command-hook to do this.
21192 ;; (Emacs 22 has a special variable, see function `org-mode')
21193 (unless (and (boundp 'isearch-mode-end-hook-quit)
21194 isearch-mode-end-hook-quit)
21195 ;; Only when the isearch was not quitted.
21196 (org-add-hook 'post-command-hook 'org-isearch-post-command
21197 'append 'local)))))
21199 (defun org-isearch-post-command ()
21200 "Remove self from hook, and show context."
21201 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21202 (org-show-context 'isearch))
21205 ;;;; Integration with and fixes for other packages
21207 ;;; Imenu support
21209 (defvar org-imenu-markers nil
21210 "All markers currently used by Imenu.")
21211 (make-variable-buffer-local 'org-imenu-markers)
21213 (defun org-imenu-new-marker (&optional pos)
21214 "Return a new marker for use by Imenu, and remember the marker."
21215 (let ((m (make-marker)))
21216 (move-marker m (or pos (point)))
21217 (push m org-imenu-markers)
21218 m))
21220 (defun org-imenu-get-tree ()
21221 "Produce the index for Imenu."
21222 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21223 (setq org-imenu-markers nil)
21224 (let* ((n org-imenu-depth)
21225 (re (concat "^" (org-get-limited-outline-regexp)))
21226 (subs (make-vector (1+ n) nil))
21227 (last-level 0)
21228 m level head)
21229 (save-excursion
21230 (save-restriction
21231 (widen)
21232 (goto-char (point-max))
21233 (while (re-search-backward re nil t)
21234 (setq level (org-reduced-level (funcall outline-level)))
21235 (when (<= level n)
21236 (looking-at org-complex-heading-regexp)
21237 (setq head (org-link-display-format
21238 (org-match-string-no-properties 4))
21239 m (org-imenu-new-marker))
21240 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21241 (if (>= level last-level)
21242 (push (cons head m) (aref subs level))
21243 (push (cons head (aref subs (1+ level))) (aref subs level))
21244 (loop for i from (1+ level) to n do (aset subs i nil)))
21245 (setq last-level level)))))
21246 (aref subs 1)))
21248 (eval-after-load "imenu"
21249 '(progn
21250 (add-hook 'imenu-after-jump-hook
21251 (lambda ()
21252 (if (eq major-mode 'org-mode)
21253 (org-show-context 'org-goto))))))
21255 (defun org-link-display-format (link)
21256 "Replace a link with either the description, or the link target
21257 if no description is present"
21258 (save-match-data
21259 (if (string-match org-bracket-link-analytic-regexp link)
21260 (replace-match (if (match-end 5)
21261 (match-string 5 link)
21262 (concat (match-string 1 link)
21263 (match-string 3 link)))
21264 nil t link)
21265 link)))
21267 (defun org-toggle-link-display ()
21268 "Toggle the literal or descriptive display of links."
21269 (interactive)
21270 (if org-descriptive-links
21271 (progn (org-remove-from-invisibility-spec '(org-link))
21272 (org-restart-font-lock)
21273 (setq org-descriptive-links nil))
21274 (progn (add-to-invisibility-spec '(org-link))
21275 (org-restart-font-lock)
21276 (setq org-descriptive-links t))))
21278 ;; Speedbar support
21280 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21281 "Overlay marking the agenda restriction line in speedbar.")
21282 (overlay-put org-speedbar-restriction-lock-overlay
21283 'face 'org-agenda-restriction-lock)
21284 (overlay-put org-speedbar-restriction-lock-overlay
21285 'help-echo "Agendas are currently limited to this item.")
21286 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21288 (defun org-speedbar-set-agenda-restriction ()
21289 "Restrict future agenda commands to the location at point in speedbar.
21291 (interactive)
21292 (require 'org-agenda)
21293 (let (p m tp np dir txt)
21294 (cond
21295 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21296 'org-imenu t))
21297 (setq m (get-text-property p 'org-imenu-marker))
21298 (with-current-buffer (marker-buffer m)
21299 (goto-char m)
21300 (org-agenda-set-restriction-lock 'subtree)))
21301 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21302 'speedbar-function 'speedbar-find-file))
21303 (setq tp (previous-single-property-change
21304 (1+ p) 'speedbar-function)
21305 np (next-single-property-change
21306 tp 'speedbar-function)
21307 dir (speedbar-line-directory)
21308 txt (buffer-substring-no-properties (or tp (point-min))
21309 (or np (point-max))))
21310 (with-current-buffer (find-file-noselect
21311 (let ((default-directory dir))
21312 (expand-file-name txt)))
21313 (unless (eq major-mode 'org-mode)
21314 (error "Cannot restrict to non-Org-mode file"))
21315 (org-agenda-set-restriction-lock 'file)))
21316 (t (error "Don't know how to restrict Org-mode's agenda")))
21317 (move-overlay org-speedbar-restriction-lock-overlay
21318 (point-at-bol) (point-at-eol))
21319 (setq current-prefix-arg nil)
21320 (org-agenda-maybe-redo)))
21322 (eval-after-load "speedbar"
21323 '(progn
21324 (speedbar-add-supported-extension ".org")
21325 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21326 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21327 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21328 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21329 (add-hook 'speedbar-visiting-tag-hook
21330 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21332 ;;; Fixes and Hacks for problems with other packages
21334 ;; Make flyspell not check words in links, to not mess up our keymap
21335 (defun org-mode-flyspell-verify ()
21336 "Don't let flyspell put overlays at active buttons, or on
21337 {todo,all-time,additional-option-like}-keywords."
21338 (let ((pos (max (1- (point)) (point-min)))
21339 (word (thing-at-point 'word)))
21340 (and (not (get-text-property pos 'keymap))
21341 (not (get-text-property pos 'org-no-flyspell))
21342 (not (member word org-todo-keywords-1))
21343 (not (member word org-all-time-keywords))
21344 (not (member word org-additional-option-like-keywords)))))
21346 (defun org-remove-flyspell-overlays-in (beg end)
21347 "Remove flyspell overlays in region."
21348 (and (org-bound-and-true-p flyspell-mode)
21349 (fboundp 'flyspell-delete-region-overlays)
21350 (flyspell-delete-region-overlays beg end))
21351 (add-text-properties beg end '(org-no-flyspell t)))
21353 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21354 (eval-after-load "bookmark"
21355 '(if (boundp 'bookmark-after-jump-hook)
21356 ;; We can use the hook
21357 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21358 ;; Hook not available, use advice
21359 (defadvice bookmark-jump (after org-make-visible activate)
21360 "Make the position visible."
21361 (org-bookmark-jump-unhide))))
21363 ;; Make sure saveplace shows the location if it was hidden
21364 (eval-after-load "saveplace"
21365 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21366 "Make the position visible."
21367 (org-bookmark-jump-unhide)))
21369 ;; Make sure ecb shows the location if it was hidden
21370 (eval-after-load "ecb"
21371 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21372 "Make hierarchy visible when jumping into location from ECB tree buffer."
21373 (if (eq major-mode 'org-mode)
21374 (org-show-context))))
21376 (defun org-bookmark-jump-unhide ()
21377 "Unhide the current position, to show the bookmark location."
21378 (and (eq major-mode 'org-mode)
21379 (or (outline-invisible-p)
21380 (save-excursion (goto-char (max (point-min) (1- (point))))
21381 (outline-invisible-p)))
21382 (org-show-context 'bookmark-jump)))
21384 ;; Make session.el ignore our circular variable
21385 (eval-after-load "session"
21386 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21388 ;;;; Experimental code
21390 (defun org-closed-in-range ()
21391 "Sparse tree of items closed in a certain time range.
21392 Still experimental, may disappear in the future."
21393 (interactive)
21394 ;; Get the time interval from the user.
21395 (let* ((time1 (org-float-time
21396 (org-read-date nil 'to-time nil "Starting date: ")))
21397 (time2 (org-float-time
21398 (org-read-date nil 'to-time nil "End date:")))
21399 ;; callback function
21400 (callback (lambda ()
21401 (let ((time
21402 (org-float-time
21403 (apply 'encode-time
21404 (org-parse-time-string
21405 (match-string 1))))))
21406 ;; check if time in interval
21407 (and (>= time time1) (<= time time2))))))
21408 ;; make tree, check each match with the callback
21411 ;;;; Finish up
21413 (provide 'org)
21415 (run-hooks 'org-load-hook)
21417 ;;; org.el ends here