| blob | 24321be7f6274a222ea43e7244c2660bdccc7fe2 |
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
197 ;;;; Customization variables
199 "Remove ID property of clones of a subtree.
200 When non-nil, clones of a subtree don't inherit the ID property.
201 Otherwise they inherit the ID property with a new unique
202 identifier."
207 ;;; Version
213 "Show the org-mode version in the echo area.
214 With prefix arg HERE, insert it at point."
240 ;;; Compatibility constants
242 ;;; The custom variables
245 "Outline-based notes management and organizer."
251 "Mode hook for Org-mode, run after the mode was turned on."
256 "Hook that is run after org.el has been loaded."
261 "Hook that is run after an Org log buffer is created."
271 "Load all extensions listed in `org-modules'."
276 org-modules)
280 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
289 (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)
290 "Modules that should always be loaded together with org.el.
291 If a description starts with <C>, the file is not part of Emacs
292 and loading it will require that you have downloaded and properly installed
293 the org-mode distribution.
295 You can also use this system to load external packages (i.e. neither Org
296 core modules, nor modules from the CONTRIB directory). Just add symbols
297 to the end of the list. If the package is called org-xyz.el, then you need
298 to add the symbol `xyz', and the package must have a call to
300 (provide 'org-xyz)"
303 :type
334 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
343 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
352 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
368 "Non-nil means make shift-cursor commands select text when possible.
370 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
371 start selecting a region, or enlarge regions started in this way.
372 In Org-mode, in special contexts, these same keys are used for
373 other purposes, important enough to compete with shift selection.
374 Org tries to balance these needs by supporting `shift-select-mode'
375 outside these special contexts, under control of this variable.
377 The default of this variable is nil, to avoid confusing behavior. Shifted
378 cursor keys will then execute Org commands in the following contexts:
379 - on a headline, changing TODO state (left/right) and priority (up/down)
380 - on a time stamp, changing the time
381 - in a plain list item, changing the bullet type
382 - in a property definition line, switching between allowed values
383 - in the BEGIN line of a clock table (changing the time block).
384 Outside these contexts, the commands will throw an error.
386 When this variable is t and the cursor is not in a special
387 context, Org-mode will support shift-selection for making and
388 enlarging regions. To make this more effective, the bullet
389 cycling will no longer happen anywhere in an item line, but only
390 if the cursor is exactly on the bullet.
392 If you set this variable to the symbol `always', then the keys
393 will not be special in headlines, property lines, and item lines,
394 to make shift selection work there as well. If this is what you
395 want, you can use the following alternative commands: `C-c C-t'
396 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
397 can be used to switch TODO sets, `C-c -' to cycle item bullet
398 types, and properties can be edited by hand or in column view.
400 However, when the cursor is on a timestamp, shift-cursor commands
401 will still edit the time stamp - this is just too good to give up.
403 XEmacs user should have this variable set to nil, because
404 `shift-select-mode' is in Emacs 23 or later only."
412 "Shall some commands act upon headlines in the active region?
414 When set to `t', some commands will be performed in all headlines
415 within the active region.
417 When set to `start-level', some commands will be performed in all
418 headlines within the active region, provided that these headlines
419 are of the same level than the first one.
421 When set to a string, those commands will be performed on the
422 matching headlines within the active region. Such string must be
423 a tags/property/todo match as it is used in the agenda tags view.
425 The list of commands is: `org-schedule', `org-deadline',
426 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
427 `org-archive-to-archive-sibling'. The archiving commands skip
428 already archived entries."
438 "Options concerning startup of Org-mode."
443 "Non-nil means entering Org-mode will switch to OVERVIEW.
444 This can also be configured on a per-file basis by adding one of
445 the following lines anywhere in the buffer:
447 #+STARTUP: fold (or `overview', this is equivalent)
448 #+STARTUP: nofold (or `showall', this is equivalent)
449 #+STARTUP: content
450 #+STARTUP: showeverything"
459 "Non-nil means entering Org-mode will set `truncate-lines'.
460 This is useful since some lines containing links can be very long and
461 uninteresting. Also tables look terrible when wrapped."
466 "Non-nil means turn on `org-indent-mode' on startup.
467 This can also be configured on a per-file basis by adding one of
468 the following lines anywhere in the buffer:
470 #+STARTUP: indent
471 #+STARTUP: noindent"
479 When this option is turned on, you can use TeX-like syntax for sub- and
481 considered as a single item - so grouping with {} is normally not
482 needed. For example, the following things will be parsed as single
483 sub- or superscripts.
485 10^24 or 10^tau several digits will be considered 1 item.
486 10^-12 or 10^-tau a leading sign with digits or a word
487 x^2-y^3 will be read as x^2 - y^3, because items are
488 terminated by almost any nonword/nondigit char.
489 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
491 Still, ambiguity is possible - so when in doubt use {} to enclose the
492 sub/superscript. If you set this variable to the symbol `{}',
493 the braces are *required* in order to trigger interpretations as
495 frequently in plain text.
497 Not all export backends support this, but HTML does.
513 "Non-nil means turn on `org-beamer-mode' on startup.
514 This can also be configured on a per-file basis by adding one of
515 the following lines anywhere in the buffer:
517 #+STARTUP: beamer"
523 "Non-nil means align all tables when visiting a file.
524 This is useful when the column width in tables is forced with <N> cookies
525 in table fields. Such tables will look correct only after the first re-align.
526 This can also be configured on a per-file basis by adding one of
527 the following lines anywhere in the buffer:
528 #+STARTUP: align
529 #+STARTUP: noalign"
534 "Non-nil means show inline images when loading a new Org file.
535 This can also be configured on a per-file basis by adding one of
536 the following lines anywhere in the buffer:
537 #+STARTUP: inlineimages
538 #+STARTUP: noinlineimages"
544 "Non-nil means insert the first line setting Org-mode in empty files.
545 When the function `org-mode' is called interactively in an empty file, this
546 normally means that the file name does not automatically trigger Org-mode.
547 To ensure that the file will always be in Org-mode in the future, a
548 line enforcing Org-mode will be inserted into the buffer, if this option
549 has been set."
554 "Non-nil means use alternative key bindings for some keys.
555 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
556 These keys are also used by other packages like shift-selection-mode'
557 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
558 If you want to use Org-mode together with one of these other modes,
559 or more generally if you would like to move some Org-mode commands to
560 other keys, set this variable and configure the keys with the variable
561 `org-disputed-keys'.
563 This option is only relevant at load-time of Org-mode, and must be set
564 *before* org.el is loaded. Changing it requires a restart of Emacs to
565 become effective."
570 "Non-nil means use extra key sequence definitions for certain commands.
571 This happens automatically if you run XEmacs or if `window-system'
572 is nil. This variable lets you do the same manually. You must
573 set it before loading org.
575 Example: on Carbon Emacs 22 running graphically, with an external
576 keyboard on a Powerbook, the default way of setting M-left might
577 not work for either Alt or ESC. Setting this variable will make
578 it work for ESC."
592 "Keys for which Org-mode and other modes compete.
593 This is an alist, cars are the default keys, second element specifies
594 the alternative to use when `org-replace-disputed-keys' is t.
596 Keys can be specified in any syntax supported by `define-key'.
597 The value of this option takes effect only at Org-mode's startup,
598 therefore you'll have to restart Emacs to apply it after changing."
603 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
604 Or return the original if not disputed.
605 Also apply the translations defined in `org-xemacs-key-equivalents'."
610 org-disputed-keys)))
614 key)
624 "Define a key, possibly translated, as returned by `org-key'."
628 "The ellipsis to use in the Org-mode outline.
629 When nil, just use the standard three dots. When a string, use that instead,
630 When a face, use the standard 3 dots, but with the specified face.
631 The change affects only Org-mode (which will then use its own display table).
632 Changing this requires executing `M-x org-mode' in a buffer to become
633 effective."
643 "Keywords in Org-mode."
648 "String to mark deadline entries.
649 A deadline is this string, followed by a time stamp. Should be a word,
650 terminated by a colon. You can insert a schedule keyword and
652 Changes become only effective after restarting Emacs."
657 "String to mark scheduled TODO entries.
658 A schedule is this string, followed by a time stamp. Should be a word,
659 terminated by a colon. You can insert a schedule keyword and
661 Changes become only effective after restarting Emacs."
666 "String used as the prefix for timestamps logging closing a TODO entry."
671 "String used as prefix for timestamps clocking work hours on an item."
676 "Entries starting with this keyword will never be exported.
677 An entry can be toggled between COMMENT and normal with
679 Changes become only effective after restarting Emacs."
684 "Entries starting with this keyword will be exported in fixed-width font.
685 Quoting applies only to the text in the entry following the headline, and does
686 not extend beyond the next headline, even if that is lower level.
687 An entry can be toggled between QUOTE and normal with
694 "Regular expression for specifying repeated events.
698 "Options concerning the general structure of Org-mode files."
703 "Options about how to make context of a location visible."
727 "Non-nil means show full hierarchy when revealing a location.
728 Org-mode often shows locations in an org-mode file which might have
729 been invisible before. When this is set, the hierarchy of headings
730 above the exposed location is shown.
731 Turning this off for example for sparse trees makes them very compact.
732 Instead of t, this can also be an alist specifying this option for different
733 contexts. Valid contexts are
734 agenda when exposing an entry from the agenda
735 org-goto when using the command `org-goto' on key C-c C-j
736 occur-tree when using the command `org-occur' on key C-c /
737 tags-tree when constructing a sparse tree based on tags matches
738 link-search when exposing search matches associated with a link
739 mark-goto when exposing the jump goal of a mark
740 bookmark-jump when exposing a bookmark location
741 isearch when exiting from an incremental search
742 default default for all contexts not set explicitly"
747 "Non-nil means show following heading when revealing a location.
748 Org-mode often shows locations in an org-mode file which might have
749 been invisible before. When this is set, the heading following the
750 match is shown.
751 Turning this off for example for sparse trees makes them very compact,
752 but makes it harder to edit the location of the match. In such a case,
754 Instead of t, this can also be an alist specifying this option for different
755 contexts. See `org-show-hierarchy-above' for valid contexts."
760 "Non-nil means show all sibling heading when revealing a location.
761 Org-mode often shows locations in an org-mode file which might have
762 been invisible before. When this is set, the sibling of the current entry
763 heading are all made visible. If `org-show-hierarchy-above' is t,
764 the same happens on each level of the hierarchy above the current entry.
766 By default this is on for the isearch context, off for all other contexts.
767 Turning this off for example for sparse trees makes them very compact,
768 but makes it harder to edit the location of the match. In such a case,
770 Instead of t, this can also be an alist specifying this option for different
771 contexts. See `org-show-hierarchy-above' for valid contexts."
776 "Non-nil means show the entry below a headline when revealing a location.
777 Org-mode often shows locations in an org-mode file which might have
778 been invisible before. When this is set, the text below the headline that is
779 exposed is also shown.
781 By default this is off for all contexts.
782 Instead of t, this can also be an alist specifying this option for different
783 contexts. See `org-show-hierarchy-above' for valid contexts."
788 "How should indirect tree buffers be displayed?
789 This applies to indirect buffers created with the commands
791 Valid values are:
792 current-window Display in the current window
793 other-window Just display in another window.
794 dedicated-frame Create one new frame, and re-use it each time.
795 new-frame Make a new frame each time. Note that in this case
796 previously-made indirect buffers are kept, and you need to
797 kill these buffers yourself."
807 "Non-nil means activate single letter commands at beginning of a headline.
808 This may also be a function to test for appropriate locations where speed
809 commands should be active."
817 "Alist of additional speed commands.
818 This list will be checked before `org-speed-commands-default'
819 when the variable `org-use-speed-commands' is non-nil
820 and when the cursor is at the beginning of a headline.
821 The car if each entry is a string with a single letter, which must
822 be assigned to `self-insert-command' in the global map.
823 The cdr is either a command to be called interactively, a function
824 to be called, or a form to be evaluated.
825 An entry that is just a list with a single string will be interpreted
826 as a descriptive headline that will be added when listing the speed
827 commands in the Help buffer using the `?' speed command."
839 "Options concerning visibility cycling in Org-mode."
844 "Non-nil means skip CHILDREN state in entries that don't have any."
849 "Maximum level which should still be subject to visibility cycling.
850 Levels higher than this will, for cycling, be treated as text, not a headline.
851 When `org-odd-levels-only' is set, a value of N in this variable actually
852 means 2N-1 stars as the limiting headline.
853 When nil, cycle all levels.
854 Note that the limiting level of cycling is also influenced by
855 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
856 `org-inlinetask-min-level' is, cycling will be limited to levels one less
857 than its value."
864 "Names of drawers. Drawers are not opened by cycling on the headline above.
865 Drawers only open with a TAB on the drawer line itself. A drawer looks like
866 this:
867 :DRAWERNAME:
868 .....
869 :END:
871 the property API.
873 Drawers can be defined on the per-file basis with a line like:
875 #+DRAWERS: HIDDEN STATE PROPERTIES"
881 "Non-nil means entering Org-mode will fold all blocks.
882 This can also be set in on a per-file basis with
884 #+STARTUP: hideblocks
885 #+STARTUP: showblocks"
891 "Cycle globally if cursor is at beginning of buffer and not at a headline.
892 This makes it possible to do global cycling without having to use S-TAB or
894 of the buffer
895 must not be a headline - it may be empty or some other text. When used in
896 this way, `org-cycle-hook' is disables temporarily, to make sure the
897 cursor stays at the beginning of the buffer.
898 When this option is nil, don't do anything special at the beginning
899 of the buffer."
904 "Non-nil means cycle entry level or item indentation in new empty entries.
906 When the cursor is at the end of an empty headline, i.e with only stars
907 and maybe a TODO keyword, TAB will then switch the entry to become a child,
908 and then all possible ancestor states, before returning to the original state.
909 This makes data entry extremely fast: M-RET to create a new headline,
910 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
912 When the cursor is at the end of an empty plain list item, one TAB will
913 make it a subitem, two or more tabs will back up to make this an item
914 higher up in the item hierarchy."
919 "Where should `org-cycle' emulate TAB.
920 nil Never
921 white Only in completely white lines
922 whitestart Only at the beginning of lines, before the first non-white char
923 t Everywhere except in headlines
924 exc-hl-bol Everywhere except at the start of a headline
925 If TAB is used in a place where it does not emulate TAB, the current subtree
926 visibility is cycled."
933 ))
936 "Number of empty lines needed to keep an empty line between collapsed trees.
937 If you leave an empty line between the end of a subtree and the following
938 headline, this empty line is hidden when the subtree is folded.
939 Org-mode will leave (exactly) one empty line visible if the number of
940 empty lines is equal or larger to the number given in this variable.
941 So the default 2 means at least 2 empty lines after the end of a subtree
942 are needed to produce free space between a collapsed subtree and the
943 following headline.
945 If the number is negative, and the number of empty lines is at least -N,
946 all empty lines are shown.
948 Special case: when 0, never leave empty lines in collapsed view."
954 "Hook that is run before visibility cycling is happening.
955 The function(s) in this hook must accept a single argument which indicates
956 the new state that will be set right after running this hook. The
957 argument is a symbol. Before a global state change, it can have the values
958 `overview', `content', or `all'. Before a local state change, it can have
959 the values `folded', `children', or `subtree'."
964 org-cycle-hide-drawers
965 org-cycle-show-empty-lines
966 org-optimize-window-after-visibility-change)
967 "Hook that is run after `org-cycle' has changed the buffer visibility.
968 The function(s) in this hook must accept a single argument which indicates
969 the new state that was set by the most recent `org-cycle' command. The
970 argument is a symbol. After a global state change, it can have the values
971 `overview', `content', or `all'. After a local state change, it can have
972 the values `folded', `children', or `subtree'."
977 "Options concerning structure editing in Org-mode."
982 "Non-nil means skip even levels and only use odd levels for the outline.
983 This has the effect that two stars are being added/taken away in
984 promotion/demotion commands. It also influences how levels are
985 handled by the exporters.
986 Changing it requires restart of `font-lock-mode' to become effective
987 for fontification also in regions already fontified.
988 You may also set this on a per-file basis by adding one of the following
989 lines to the buffer:
991 #+STARTUP: odd
992 #+STARTUP: oddeven"
998 "Non-nil means adapt indentation to outline node level.
1000 When this variable is set, Org assumes that you write outlines by
1001 indenting text in each node to align with the headline (after the stars).
1002 The following issues are influenced by this variable:
1004 - When this is set and the *entire* text in an entry is indented, the
1005 indentation is increased by one space in a demotion command, and
1006 decreased by one in a promotion command. If any line in the entry
1007 body starts with text at column 0, indentation is not changed at all.
1009 - Property drawers and planning information is inserted indented when
1010 this variable s set. When nil, they will not be indented.
1012 - TAB indents a line relative to context. The lines below a headline
1013 will be indented when this variable is set.
1015 Note that this is all about true indentation, by adding and removing
1016 space characters. See also `org-indent.el' which does level-dependent
1017 indentation in a virtual way, i.e. at display time in Emacs."
1022 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1024 When t, `C-a' will bring back the cursor to the beginning of the
1025 headline text, i.e. after the stars and after a possible TODO
1026 keyword. In an item, this will be the position after bullet and
1027 check-box, if any. When the cursor is already at that position,
1028 another `C-a' will bring it to the beginning of the line.
1030 `C-e' will jump to the end of the headline, ignoring the presence
1031 of tags in the headline. A second `C-e' will then jump to the
1032 true end of the line, after any tags. This also means that, when
1033 this variable is non-nil, `C-e' also will never jump beyond the
1034 end of the heading of a folded section, i.e. not after the
1035 ellipses.
1037 When set to the symbol `reversed', the first `C-a' or `C-e' works
1038 normally, going to the true line boundary first. Only a directly
1039 following, identical keypress will bring the cursor to the
1040 special positions.
1042 This may also be a cons cell where the behavior for `C-a' and
1043 `C-e' is set separately."
1062 "Non-nil means `C-k' will behave specially in headlines.
1063 When nil, `C-k' will call the default `kill-line' command.
1064 When t, the following will happen while the cursor is in the headline:
1066 - When the cursor is at the beginning of a headline, kill the entire
1067 line and possible the folded subtree below the line.
1068 - When in the middle of the headline text, kill the headline up to the tags.
1069 - When after the headline text, kill the tags."
1074 "Non-nil means, do not delete a hidden subtree with C-k.
1075 When set to the symbol `error', simply throw an error when C-k is
1076 used to kill (part-of) a headline that has hidden text behind it.
1077 Any other non-nil value will result in a query to the user, if it is
1078 OK to kill that hidden subtree. When nil, kill without remorse."
1087 "Check if in invisible region before inserting or deleting a character.
1088 Valid values are:
1090 nil Do not check, so just do invisible edits.
1091 error Throw an error and do nothing.
1092 show Make point visible, and do the requested edit.
1093 show-and-error Make point visible, then throw an error and abort the edit.
1094 smart Make point visible, and do insertion/deletion if it is
1095 adjacent to visible text and the change feels predictable.
1096 Never delete a previously invisible character or add in the
1097 middle or right after an invisible region. Basically, this
1098 allows insertion and backward-delete right before ellipses.
1099 FIXME: maybe in this case we should not even show?"
1110 "Non-nil means when yanking subtrees, fold them.
1111 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1112 it starts with a heading and all other headings in it are either children
1113 or siblings, then fold all the subtrees. However, do this only if no
1114 text after the yank would be swallowed into a folded tree by this action."
1119 "Non-nil means when yanking subtrees, adjust the level.
1120 With this setting, `org-paste-subtree' is used to insert the subtree, see
1121 this function for details."
1126 "Non-nil means M-RET will split the line at the cursor position.
1127 When nil, it will go to the end of the line before making a
1128 new line.
1129 You may also set this option in a different way for different
1130 contexts. Valid contexts are:
1132 headline when creating a new headline
1133 item when creating a new item
1134 table in a table field
1135 default the value to be used for all contexts not explicitly
1136 customized"
1153 "Non-nil means insert new headings after the current subtree.
1154 When nil, the new heading is created directly after the current line.
1157 for the duration of the command."
1163 "Should `org-insert-heading' leave a blank line before new heading/item?
1164 The value is an alist, with `heading' and `plain-list-item' as CAR,
1165 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1166 which case Org will look at the surrounding headings/items and try to
1167 make an intelligent decision whether to insert a blank line or not.
1169 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1170 set, the setting here is ignored and no empty line is inserted, to avoid
1171 breaking the list structure."
1184 "Hook being run after inserting a new heading."
1190 This currently only means they are never auto-wrapped.
1191 When nil, such lines will be treated like ordinary lines.
1192 See also the QUOTE keyword."
1197 "Non-nil means typing characters in `org-goto' starts incremental search."
1202 "Options concerning sparse trees in Org-mode."
1207 "Non-nil means highlight all matches that define a sparse tree.
1208 The highlights will automatically disappear the next time the buffer is
1209 changed by an edit command."
1214 "Non-nil means any change to the buffer will remove temporary highlights.
1215 Such highlights are created by `org-occur' and `org-clock-display'.
1216 When nil, `C-c C-c needs to be used to get rid of the highlights.
1217 The highlights created by `org-preview-latex-fragment' always need
1218 `C-c C-c' to be removed."
1225 "Hook that is run after `org-occur' has constructed a sparse tree.
1226 This can be used to recenter the window to show as much of the structure
1227 as possible."
1232 "Options concerning imenu and speedbar in Org-mode."
1237 "The maximum level for Imenu access to Org-mode headlines.
1238 This also applied for speedbar access."
1243 "Options concerning tables in Org-mode."
1249 When nil, such lines will be treated like ordinary lines.
1251 When equal to the symbol `optimized', the table editor will be optimized to
1252 do the following:
1253 - Automatic overwrite mode in front of whitespace in table fields.
1254 This makes the structure of the table stay in tact as long as the edited
1255 field does not exceed the column width.
1256 - Minimize the number of realigns. Normally, the table is aligned each time
1257 TAB or RET are pressed to move to another field. With optimization this
1258 happens only if changes to a field might have changed the column width.
1259 Optimization requires replacing the functions `self-insert-command',
1260 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1261 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1262 very good at guessing when a re-align will be necessary, but you can always
1265 If you would like to use the optimized version in Org-mode, but the
1266 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1268 This variable can be used to turn on and off the table editor during a session,
1269 but in order to toggle optimization, a restart is required.
1271 See also the variable `org-table-auto-blank-field'."
1279 "Non-nil means cluster self-insert commands for undo when possible.
1280 If this is set, then, like in the Emacs command loop, 20 consecutive
1281 characters will be undone together.
1282 This is configurable, because there is some impact on typing performance."
1287 "Non-nil means TAB will automatically notice a table.el table.
1288 When it sees such a table, it moves point into it and - if necessary -
1289 calls `table-recognize-table'."
1294 "Options concerning links in Org-mode."
1299 "Buffer-local version of `org-link-abbrev-alist', which see.
1304 "Alist of link abbreviations.
1305 The car of each element is a string, to be replaced at the start of a link.
1307 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1309 [[linkkey:tag][description]]
1311 The 'linkkey' must be a word word, starting with a letter, followed
1312 by letters, numbers, '-' or '_'.
1314 If REPLACE is a string, the tag will simply be appended to create the link.
1317 be inserted at that point (see the function `url-hexify-string').
1319 REPLACE may also be a function that will be called with the tag as the
1320 only argument to create the link, which should be returned as a string.
1322 See the manual for examples."
1332 "Non-nil means Org will display descriptive links.
1333 E.g. [[http://orgmode.org][Org website]] will be displayed as
1335 description. When set to `nil', Org will display the full links
1336 literally.
1338 You can interactively set the value of this variable by calling
1339 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1344 "How the path name in file links should be stored.
1345 Valid values are:
1347 relative Relative to the current directory, i.e. the directory of the file
1348 into which the link is being inserted.
1349 absolute Absolute path, if possible with ~ for home directory.
1350 noabbrev Absolute path, no abbreviation of home directory.
1351 adaptive Use relative path for files in the current directory and sub-
1352 directories of it. For other files, use an absolute path."
1361 "Types of links that should be activated in Org-mode files.
1362 This is a list of symbols, each leading to the activation of a certain link
1363 type. In principle, it does not hurt to turn on most link types - there may
1364 be a small gain when turning off unused link types. The types are:
1366 bracket The recommended [[link][description]] or [[link]] links with hiding.
1367 angle Links in angular brackets that may contain whitespace like
1368 <bbdb:Carsten Dominik>.
1369 plain Plain links in normal text, no whitespace, like http://google.com.
1370 radio Text that is matched by a radio target, see manual for details.
1371 tag Tag settings in a headline (link to tag search).
1372 date Time stamps (link to calendar).
1373 footnote Footnote labels.
1375 Changing this variable requires a restart of Emacs to become effective."
1387 "Function to use to generate link descriptions from links.
1388 If nil the link location will be used. This function must take
1389 two parameters; the first is the link and the second the
1390 description `org-insert-link' has generated, and should return the
1391 description to use."
1396 "Options concerning storing links in Org-mode."
1401 "Format of the description part of a link to an email or usenet message.
1402 The following %-escapes will be replaced by corresponding information:
1410 %s subject
1411 %d date
1412 %m message-id.
1414 You may use normal field width specification between the % and the letter.
1415 This is for example useful to limit the length of the subject.
1429 It should match if the message is from the user him/herself."
1434 "Non-nil means storing a link to an Org file will use entry IDs.
1436 Note that before this variable is even considered, org-id must be loaded,
1437 so please customize `org-modules' and turn it on.
1439 The variable can have the following values:
1441 t Create an ID if needed to make a link to the current entry.
1443 create-if-interactive
1444 If `org-store-link' is called directly (interactively, as a user
1445 command), do create an ID to support the link. But when doing the
1446 job for remember, only use the ID if it already exists. The
1447 purpose of this setting is to avoid proliferation of unwanted
1448 IDs, just because you happen to be in an Org file when you
1449 call `org-remember' that automatically and preemptively
1450 creates a link. If you do want to get an ID link in a remember
1451 template to an entry not having an ID, create it first by
1452 explicitly creating a link to it, using `C-c C-l' first.
1454 create-if-interactive-and-no-custom-id
1455 Like create-if-interactive, but do not create an ID if there is
1456 a CUSTOM_ID property defined in the entry. This is the default.
1458 use-existing
1459 Use existing ID, do not create one.
1461 nil Never use an ID to make a link, instead link using a text search for
1462 the headline text."
1467 create-if-interactive)
1469 create-if-interactive-and-no-custom-id)
1474 "Non-nil means file links from `org-store-link' contain context.
1475 A search string will be added to the file name with :: as separator and
1476 used to find the context when the link is activated by the command
1477 `org-open-at-point'. When this option is t, the entire active region
1478 will be placed in the search string of the file link. If set to a
1479 positive integer, only the first n lines of context will be stored.
1482 negates this setting for the duration of the command."
1487 "Non-nil means keep link in list for entire session.
1489 The command `org-store-link' adds a link pointing to the current
1490 location to an internal list. These links accumulate during a session.
1491 The command `org-insert-link' can be used to insert links into any
1492 Org-mode file (offering completion for all stored links). When this
1494 will be removed from the list, to make completing the unused links
1495 more efficient."
1500 "Options concerning following links in Org-mode."
1505 "Function to translate links with different syntax to Org syntax.
1506 This can be used to translate links created for example by the Planner
1507 or emacs-wiki packages to Org syntax.
1508 The function must accept two parameters, a TYPE containing the link
1510 which is everything after the link protocol. It should return a cons
1511 with possibly modified values of type and path.
1512 Org contains a function for this, so if you set this variable to
1513 `org-translate-link-from-planner', you should be able follow many
1514 links created by planner."
1519 "Hook that is run after a link has been followed."
1524 "Non-nil means on links TAB will follow the link.
1525 Needs to be set before org.el is loaded.
1526 This really should not be used, it does not make sense, and the
1527 implementation is bad."
1532 "Non-nil means on links RET will follow the link."
1538 "Non-nil means mouse-1 on a link will follow the link.
1539 A longer mouse click will still set point. Does not work on XEmacs.
1540 Needs to be set before org.el is loaded."
1545 "Number of different positions to be recorded in the ring.
1546 Changing this requires a restart of Emacs to work correctly."
1551 "Non-nil means internal links in Org files must exactly match a headline.
1552 When nil, the link search tries to match a phrase with all words
1553 in the search text."
1560 query-to-create)))
1568 "Setup the frame configuration for following links.
1569 When following a link with Emacs, it may often be useful to display
1570 this link in another window or frame. This variable can be used to
1571 set this up for the different types of links.
1572 For VM, use any of
1573 `vm-visit-folder'
1574 `vm-visit-folder-other-window'
1575 `vm-visit-folder-other-frame'
1576 For Gnus, use any of
1577 `gnus'
1578 `gnus-other-frame'
1579 `org-gnus-no-new-news'
1580 For FILE, use any of
1581 `find-file'
1582 `find-file-other-window'
1583 `find-file-other-frame'
1584 For Wanderlust use any of
1585 `wl'
1586 `wl-other-frame'
1587 For the calendar, use the variable `calendar-setup'.
1588 For BBDB, it is currently only possible to display the matches in
1589 another window."
1613 "Non-nil means use indirect buffer to display infile links.
1614 Activating internal links (from one location in a file to another location
1615 in the same file) normally just jumps to the location. When the link is
1617 is displayed in
1618 another window. When this option is set, the other window actually displays
1619 an indirect buffer clone of the current buffer, to avoid any visibility
1620 changes to the current buffer."
1625 "Non-nil means `org-open-file' will open non-existing files.
1626 When nil, an error will be generated.
1627 This variable applies only to external applications because they
1628 might choke on non-existing files. If the link is to a file that
1629 will be opened in Emacs, the variable is ignored."
1634 "Non-nil means a link to a directory really means to index.org.
1635 When nil, following a directory link will run dired or open a finder/explorer
1636 window on that directory."
1641 "Function and arguments to call for following mailto links.
1642 This is a list with the first element being a Lisp function, and the
1643 remaining elements being arguments to the function. In string arguments,
1644 %a will be replaced by the address, and %s will be replaced by the subject
1645 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1654 "Non-nil means ask for confirmation before executing shell links.
1655 Shell links can be dangerous: just think about a link
1657 [[shell:rm -rf ~/*][Google Search]]
1660 but really it would remove your entire home directory.
1661 Therefore we advise against setting this variable to nil.
1662 Just change it to `y-or-n-p' if you want to confirm with a
1670 'safe-local-variable
1674 "A regexp to skip confirmation for shell links."
1680 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1681 Elisp links can be dangerous: just think about a link
1686 but really it would remove your entire home directory.
1687 Therefore we advise against setting this variable to nil.
1688 Just change it to `y-or-n-p' if you want to confirm with a
1696 'safe-local-variable
1700 "A regexp to skip confirmation for Elisp links."
1709 "Default file applications on a UNIX or GNU/Linux system.
1720 "Default file applications on a MacOS X system.
1722 for some files for which the OS does not have a good default.
1730 'mswindows-shell-execute
1735 'mswindows-shell-execute
1738 "Default file applications on a Windows NT system.
1743 '(
1748 )
1749 "External applications for opening `file:path' items in a document.
1750 Org-mode uses system defaults for different file types, but
1751 you can use this variable to set the application for a given file
1752 extension. The entries in this list are cons cells where the car identifies
1753 files and the cdr the corresponding command. Possible values for the
1754 file identifier are
1756 ways, depending on its contents:
1758 - Alphanumeric characters only:
1759 Match links with this file extension.
1761 to open PDFs with evince.
1763 - Regular expression: Match links where the
1764 filename matches the regexp. If you want to
1765 use groups here, use shy groups.
1769 to open *.html and *.xhtml with firefox.
1771 - Regular expression which contains (non-shy) groups:
1773 anything after that, matches the regexp.
1774 In a custom command string, %1, %2, etc. are replaced with
1775 the parts of the link that were matched by the groups.
1776 For backwards compatibility, if a command string is given
1777 that does not use any of the group matches, this case is
1778 handled identically to the second one (i.e. match against
1779 file name only).
1780 In a custom lisp form, you can access the group matches with
1781 (match-string n link).
1784 to open [[file:document.pdf::5]] with evince at page 5.
1786 `directory' Matches a directory
1787 `remote' Matches a remote file, accessible through tramp or efs.
1788 Remote files most likely should be visited through Emacs
1789 because external applications cannot handle such paths.
1790 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1791 so all files Emacs knows how to handle. Using this with
1792 command `emacs' will open most files in Emacs. Beware that this
1793 will also open html files inside Emacs, unless you add
1795 t Default for files not matched by any of the other options.
1796 `system' The system command to open files, like `open' on Windows
1797 and Mac OS X, and mailcap under GNU/Linux. This is the command
1798 that will be selected if you call `C-c C-o' with a double
1801 Possible values for the command are:
1802 `emacs' The file will be visited by the current Emacs process.
1803 `default' Use the default application for this file type, which is the
1804 association for t in the list, most likely in the system-specific
1805 part.
1806 This can be used to overrule an unwanted setting in the
1807 system-specific variable.
1809 This command is specified by the entry whose car is `system'.
1810 Most likely, the system-specific version of this variable
1811 does define this command, but you can overrule/replace it
1812 here.
1813 string A command to be executed by a shell; %s will be replaced
1814 by the path to the file.
1815 sexp A Lisp form which will be evaluated. The file path will
1816 be available in the Lisp variable `file'.
1817 For more examples, see the system specific constants
1818 `org-file-apps-defaults-macosx'
1819 `org-file-apps-defaults-windowsnt'
1820 `org-file-apps-defaults-gnu'."
1830 auto-mode))
1841 "Options concerning refiling entries in Org-mode."
1846 "Directory with org files.
1847 This is just a default location to look for Org files. There is no need
1848 at all to put your files into this directory. It is only used in the
1849 following situations:
1851 1. When a remember template specifies a target file that is not an
1852 absolute path. The path will then be interpreted relative to
1853 `org-directory'
1854 2. When a remember note is filed away in an interactive way (when exiting the
1855 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1856 with `org-directory' as the default path."
1862 "Default target for storing notes.
1863 Used as a fall back file for org-remember.el and org-capture.el, for
1864 templates that do not specify a target file."
1869 file))
1872 "The default interface to be used for `org-goto'.
1873 Allowed values are:
1874 outline The interface shows an outline of the relevant file
1875 and the correct heading is found by moving through
1876 the outline or by searching with incremental search.
1877 outline-path-completion Headlines in the current buffer are offered via
1878 completion. This is the interface also used by
1879 the refile command."
1886 "Maximum target level when running `org-goto' with refile interface."
1891 "Non-nil means store new notes at the beginning of a file or entry.
1892 When nil, new notes will be filed to the end of a file or entry.
1893 This can also be a list with cons cells of regular expressions that
1894 are matched against file names, and values."
1904 "Information to record when a task is refiled.
1906 Possible values are:
1908 nil Don't add anything
1909 time Add a time stamp to the task
1910 note Prompt for a note and add it with template `org-log-note-headings'
1912 This option can also be set with on a per-file-basis with
1914 #+STARTUP: nologrefile
1915 #+STARTUP: logrefile
1916 #+STARTUP: lognoterefile
1918 You can have local logging settings for a subtree by setting the LOGGING
1919 property to one or more of these keywords.
1921 When bulk-refiling from the agenda, the value `note' is forbidden and
1922 will temporarily be changed to `time'."
1933 This is a list of cons cells. Each cell contains:
1934 - a specification of the files to be considered, either a list of files,
1935 or a symbol whose function or variable value will be used to retrieve
1936 a file name or a list of file names. If you use `org-agenda-files' for
1937 that, all agenda files will be scanned for targets. Nil means consider
1938 headings in the current buffer.
1939 - A specification of how to find candidate refile targets. This may be
1940 any of:
1942 This tag has to be present in all target headlines, inheritance will
1943 not be considered.
1945 todo keyword.
1947 headlines that are refiling targets.
1948 - a cons cell (:level . N). Any headline of level N is considered a target.
1949 Note that, when `org-odd-levels-only' is set, level corresponds to
1950 order in hierarchy, not to the number of stars.
1951 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1952 Note that, when `org-odd-levels-only' is set, level corresponds to
1953 order in hierarchy, not to the number of stars.
1955 Each element of this list generates a set of possible targets.
1956 The union of these sets is presented (with completion) to
1957 the user by `org-refile'.
1959 You can set the variable `org-refile-target-verify-function' to a function
1960 to verify each headline found by the simple criteria above.
1962 When this variable is nil, all top-level headlines in the current buffer
1963 are used, equivalent to the value `((nil . (:level . 1))'."
1979 "Function to verify if the headline at point should be a refile target.
1980 The function will be called without arguments, with point at the
1981 beginning of the headline. It should return t and leave point
1982 where it is if the headline is a valid target for refiling.
1984 If the target should not be selected, the function must return nil.
1985 In addition to this, it may move point to a place from where the search
1986 should be continued. For example, the function may decide that the entire
1987 subtree of the current entry should be excluded and move point to the end
1988 of the subtree."
1993 "Non-nil means cache refile targets to speed up the process.
1994 The cache for a particular file will be updated automatically when
1995 the buffer has been killed, or when any of the marker used for flagging
1996 refile targets no longer points at a live buffer.
1997 If you have added new entries to a buffer that might themselves be targets,
1998 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1999 find that easier, `C-u C-u C-u C-c C-w'."
2005 "Non-nil means provide refile targets as paths.
2006 So a level 3 headline will be available as level1/level2/level3.
2008 When the value is `file', also include the file name (without directory)
2009 into the path. In this case, you can also stop the completion after
2010 the file name, to get entries inserted as top level in the file.
2012 When `full-file-path', include the full file path."
2021 "Non-nil means complete the outline path in hierarchical steps.
2022 When Org-mode uses the refile interface to select an outline path
2023 \(see variable `org-refile-use-outline-path'), the completion of
2024 the path can be done is a single go, or if can be done in steps down
2025 the headline hierarchy. Going in steps is probably the best if you
2026 do not use a special completion package like `ido' or `icicles'.
2027 However, when using these packages, going in one step can be very
2028 fast, while still showing the whole path to the entry."
2033 "Non-nil means allow to create new nodes as refile targets.
2035 of an existing node. When the value of this variable is `confirm',
2036 new node creation must be confirmed by the user (recommended)
2037 When nil, the completion must match an existing entry.
2039 Note that, if the new heading is not seen by the criteria
2040 listed in `org-refile-targets', multiple instances of the same
2041 heading would be created by trying again to file under the new
2042 heading."
2050 "Non-nil means also refile active region within a subtree.
2052 By default `org-refile' doesn't allow refiling regions if they
2053 don't contain a set of subtrees, but it might be convenient to
2054 do so sometimes: in that case, the first line of the region is
2055 converted to a headline before refiling."
2061 "Options concerning TODO items in Org-mode."
2066 "Options concerning Progress logging in Org-mode."
2073 "The available interpretation symbols for customizing `org-todo-keywords'.
2077 "List of TODO entry keyword sequences and their interpretation.
2080 Each sequence starts with a symbol, either `sequence' or `type',
2081 indicating if the keywords should be interpreted as a sequence of
2082 action steps, or as different types of TODO items. The first
2083 keywords are states requiring action - these states will select a headline
2084 for inclusion into the global TODO list Org-mode produces. If one of
2087 the last keyword is treated as the only DONE state of the sequence.
2090 additional state where no keyword is present. For details about this
2091 cycling, see the manual.
2093 TODO keywords and interpretation can also be set on a per-file basis with
2094 the special #+SEQ_TODO and #+TYP_TODO lines.
2096 Each keyword can optionally specify a character for fast state selection
2097 \(in combination with the variable `org-use-fast-todo-selection')
2098 and specifiers for state change logging, using the same syntax
2101 indicates to record a time stamp each time this state is selected.
2103 Each keyword may also specify if a timestamp or a note should be
2104 recorded when entering or leaving the state, by adding additional
2105 characters in the parenthesis after the keyword. This looks like this:
2107 record only the time of the state change. With X and Y being either
2109 Y when leaving the state if and only if the *target* state does not
2110 define X. You may omit any of the fast-selection key or X or /Y,
2111 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2113 For backward compatibility, this variable may also be just a list
2114 of keywords - in this case the interpretation (sequence or type) will be
2115 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2125 ;;Quick and dirty way to see
2126 ;;`org-todo-interpretations'. This takes the
2127 ;;place of item arguments
2128 :convert-widget
2135 org-todo-interpretation-widgets))
2136 widget))
2167 "Controls how TODO keywords are interpreted.
2168 This variable is in principle obsolete and is only used for
2169 backward compatibility, if the interpretation of todo keywords is
2170 not given already in `org-todo-keywords'. See that variable for
2171 more information."
2178 "Non-nil means use the fast todo selection scheme with C-c C-t.
2179 This variable describes if and under what circumstances the cycling
2180 mechanism for TODO keywords will be replaced by a single-key, direct
2181 selection scheme.
2183 When nil, fast selection is never used.
2185 When the symbol `prefix', it will be used when `org-todo' is called with
2186 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2187 in an agenda buffer.
2189 When t, fast selection is used by default. In this case, the prefix
2190 argument forces cycling instead.
2192 In all cases, the special interface is only used if access keys have actually
2193 been assigned by the user, i.e. if keywords in the configuration are followed
2194 by a letter in parenthesis, like TODO(t)."
2202 "Non-nil means update todo statistics after insert and toggle.
2203 ALL-HEADLINES means update todo statistics by including headlines
2204 with no TODO keyword as well, counting them as not done.
2205 A list of TODO keywords means the same, but skip keywords that are
2206 not in this list.
2208 When this is set, todo statistics is updated in the parent of the
2209 current entry each time a todo state is changed."
2219 "Non-nil means TODO statistics covers just direct children.
2220 When nil, all entries in the subtree are considered.
2221 This has only an effect if `org-provide-todo-statistics' is set.
2222 To set this to nil for only a single subtree, use a COOKIE_DATA
2228 "Hook which is run after the state of a TODO item was changed.
2229 The new state (a string with a TODO keyword, or nil) is available in the
2230 Lisp variable `state'."
2235 "Hook for functions that are allowed to block a state change.
2237 Each function gets as its single argument a property list, see
2238 `org-trigger-hook' for more information about this list.
2240 If any of the functions in this hook returns nil, the state change
2244 "Hook for functions that are triggered by a state change.
2246 Each function gets as its single argument a property list with at least
2247 the following elements:
2249 (:type type-of-change :position pos-at-entry-start
2250 :from old-state :to new-state)
2252 Depending on the type, more properties may be present.
2254 This mechanism is currently implemented for:
2256 TODO state changes
2257 ------------------
2258 :type todo-state-change
2259 :from previous state (keyword as a string), or nil, or a symbol
2260 'todo' or 'done', to indicate the general type of state.
2264 "Non-nil means undone TODO entries will block switching the parent to DONE.
2265 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2266 be blocked if any prior sibling is not yet done.
2267 Finally, if the parent is blocked because of ordered siblings of its own,
2268 the child will also be blocked.
2269 This variable needs to be set before org.el is loaded, and you need to
2270 restart Emacs after a change to make the change effective. The only way
2271 to change is while Emacs is running is through the customize interface."
2283 "Non-nil means unchecked boxes will block switching the parent to DONE.
2284 When this is nil, checkboxes have no influence on switching TODO states.
2285 When non-nil, you first need to check off all check boxes before the TODO
2286 entry can be switched to DONE.
2287 This variable needs to be set before org.el is loaded, and you need to
2288 restart Emacs after a change to make the change effective. The only way
2289 to change is while Emacs is running is through the customize interface."
2301 "Non-nil means inserting a TODO heading is treated as state change.
2303 logging will apply if appropriate. When nil, the new TODO item will
2304 be inserted directly, and no logging will take place."
2309 "Non-nil means switching TODO states with S-cursor counts as state change.
2310 This is the default behavior. However, setting this to nil allows a
2311 convenient way to select a TODO state and bypass any logging associated
2312 with that."
2317 "Tag changes that should be triggered by TODO state changes.
2318 This is a list. Each entry is
2320 (state-change (tag . flag) .......)
2322 State-change can be a string with a state, and empty string to indicate the
2323 state that has no TODO keyword, or it can be one of the symbols `todo'
2324 or `done', meaning any not-done or done state, respectively."
2338 "Information to record when a task moves to the DONE state.
2340 Possible values are:
2342 nil Don't add anything, just change the keyword
2343 time Add a time stamp to the task
2344 note Prompt for a note and add it with template `org-log-note-headings'
2346 This option can also be set with on a per-file-basis with
2348 #+STARTUP: nologdone
2349 #+STARTUP: logdone
2350 #+STARTUP: lognotedone
2352 You can have local logging settings for a subtree by setting the LOGGING
2353 property to one or more of these keywords."
2361 ;; Normalize old uses of org-log-done.
2368 "Information to record when the scheduling date of a tasks is modified.
2370 Possible values are:
2372 nil Don't add anything, just change the date
2373 time Add a time stamp to the task
2374 note Prompt for a note and add it with template `org-log-note-headings'
2376 This option can also be set with on a per-file-basis with
2378 #+STARTUP: nologreschedule
2379 #+STARTUP: logreschedule
2380 #+STARTUP: lognotereschedule"
2389 "Information to record when the deadline date of a tasks is modified.
2391 Possible values are:
2393 nil Don't add anything, just change the date
2394 time Add a time stamp to the task
2395 note Prompt for a note and add it with template `org-log-note-headings'
2397 This option can also be set with on a per-file-basis with
2399 #+STARTUP: nologredeadline
2400 #+STARTUP: logredeadline
2401 #+STARTUP: lognoteredeadline
2403 You can have local logging settings for a subtree by setting the LOGGING
2404 property to one or more of these keywords."
2413 "Non-nil means record a note when clocking out of an item.
2414 This can also be configured on a per-file basis by adding one of
2415 the following lines anywhere in the buffer:
2417 #+STARTUP: lognoteclock-out
2418 #+STARTUP: nolognoteclock-out"
2424 "Non-nil means the CLOSED time stamp will contain date and time.
2425 When nil, only the date will be recorded."
2439 "Headings for notes added to entries.
2440 The value is an alist, with the car being a symbol indicating the note
2441 context, and the cdr is the heading to be used. The heading may also be the
2442 empty string.
2443 %t in the heading will be replaced by a time stamp.
2444 %T will be an active time stamp instead the default inactive one
2445 %d will be replaced by a short-format time stamp.
2446 %D will be replaced by an active short-format time stamp.
2447 %s will be replaced by the new TODO state, in double quotes.
2448 %S will be replaced by the old TODO state, in double quotes.
2449 %u will be replaced by the user name.
2450 %U will be replaced by the full user name.
2452 In fact, it is not a good idea to change the `state' entry, because
2453 agenda log mode depends on the format of these entries."
2459 "Heading when changing todo state (todo sequence only)"
2473 "Non-nil means insert state change notes and time stamps into a drawer.
2474 When nil, state changes notes will be inserted after the headline and
2475 any scheduling and clock lines, but not inside a drawer.
2477 The value of this variable should be the name of the drawer to use.
2478 LOGBOOK is proposed as the default drawer for this purpose, you can
2479 also set this to a string to define the drawer of your choice.
2483 If this variable is set, `org-log-state-notes-insert-after-drawers'
2484 will be ignored.
2486 You can set the property LOG_INTO_DRAWER to overrule this setting for
2487 a subtree."
2499 "Return the value of `org-log-into-drawer', but let properties overrule.
2500 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2501 used instead of the default value."
2509 "Non-nil means insert state change notes after any drawers in entry.
2510 Only the drawers that *immediately* follow the headline and the
2511 deadline/scheduled line are skipped.
2512 When nil, insert notes right after the heading and perhaps the line
2513 with deadline/scheduling if present.
2515 This variable will have no effect if `org-log-into-drawer' is
2516 set."
2522 "Non-nil means the latest state note will be directly after heading.
2523 When nil, the state change notes will be ordered according to time."
2529 "The TODO state to which a repeater should return the repeating task.
2530 By default this is the first task in a TODO sequence, or the previous state
2531 in a TODO_TYP set. But you can specify another task here.
2532 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2539 "Non-nil means record moving through the DONE state when triggering repeat.
2540 An auto-repeating task is immediately switched back to TODO when
2543 record a closing note, there will be no record of the task moving
2544 through DONE. This variable forces taking a note anyway.
2546 nil Don't force a record
2547 time Record a time stamp
2548 note Record a note
2550 This option can also be set with on a per-file-basis with
2552 #+STARTUP: logrepeat
2553 #+STARTUP: lognoterepeat
2554 #+STARTUP: nologrepeat
2556 You can have local logging settings for a subtree by setting the LOGGING
2557 property to one or more of these keywords."
2567 "Priorities in Org-mode."
2572 "Non-nil means priority commands are active.
2573 When nil, these commands will be disabled, so that you never accidentally
2574 set a priority."
2579 "The highest priority of TODO items. A character like ?A, ?B etc.
2580 Must have a smaller ASCII number than `org-lowest-priority'."
2585 "The lowest priority of TODO items. A character like ?A, ?B etc.
2586 Must have a larger ASCII number than `org-highest-priority'."
2591 "The default priority of TODO items.
2592 This is the priority an item gets if no explicit priority is given.
2593 When starting to cycle on an empty priority the first step in the cycle
2594 depends on `org-priority-start-cycle-with-default'. The resulting first
2595 step priority must not exceed the range from `org-highest-priority' to
2596 `org-lowest-priority' which means that `org-default-priority' has to be
2597 in this range exclusive or inclusive the range boundaries. Else the
2598 first step refuses to set the default and the second will fall back
2599 to (depending on the command used) the highest or lowest priority."
2604 "Non-nil means start with default priority when starting to cycle.
2605 When this is nil, the first step in the cycle will be (depending on the
2606 command used) one higher or lower than the default priority.
2607 See also `org-default-priority'."
2612 "Function to extract the priority from a string.
2613 The string is normally the headline. If this is nil Org computes the
2614 priority from the priority cookie like [#A] in the headline. It returns
2615 an integer, increasing by 1000 for each priority level.
2616 The user can set a different function here, which should take a string
2617 as an argument and return the numeric priority."
2623 "Options concerning time stamps and deadlines in Org-mode."
2628 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2629 When nil, these labeled time stamps are forces into the second line of an
2630 entry, just after the headline. When scheduling from the global TODO list,
2631 the time stamp will always be forced into the second line."
2636 "Formats for `format-time-string' which are used for time stamps.
2640 "Number of minutes to round time stamps to.
2641 These are two values, the first applies when first creating a time stamp.
2642 The second applies when changing it with the commands `S-up' and `S-down'.
2643 When changing the time stamp, this means that it will change in steps
2644 of N minutes, as given by the second value.
2646 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2647 numbers should be factors of 60, so for example 5, 10, 15.
2649 When this is larger than 1, you can still force an exact time stamp by using
2650 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2651 and by using a prefix arg to `S-up/down' to specify the exact number
2652 of minutes to shift."
2662 ;; Normalize old customizations of this variable.
2666 org-time-stamp-rounding-minutes)))
2669 "Non-nil means overlay custom formats over all time stamps.
2670 The formats are defined through the variable `org-time-stamp-custom-formats'.
2671 To turn this on on a per-file basis, insert anywhere in the file:
2672 #+STARTUP: customtime"
2680 "Custom formats for time stamps. See `format-time-string' for the syntax.
2681 These are overlaid over the default ISO format if the variable
2682 `org-display-custom-times' is set. Time like %H:%M should be at the
2683 end of the second format. The custom formats are also honored by export
2684 commands, if custom time display is turned on at the time of export."
2689 "Get the right format for a time string."
2694 f)))
2697 "The format string used when creating CLOCKSUM lines.
2698 This is also used when org-mode generates a time duration."
2704 org-mode generates a time duration."
2709 "The format string used when creating CLOCKSUM lines, or when
2710 org-mode generates a time duration."
2715 "No. of days before expiration during which a deadline becomes active.
2716 This variable governs the display in sparse trees and in the agenda.
2717 When 0 or negative, it means use this number (the absolute value of it)
2718 even if a deadline has a different individual lead time specified.
2720 Custom commands can set this variable in the options section."
2726 "Non-nil means assume future for incomplete date input from user.
2727 This affects the following situations:
2728 1. The user gives a month but not a year.
2731 2. The user gives a day, but no month.
2734 it will be considered as *this* month.
2736 If you set this variable to the symbol `time', then also the following
2737 will work:
2739 3. If the user gives a time, but no day. If the time is before now,
2740 to will be interpreted as tomorrow.
2742 Currently none of this works for ISO week specifications.
2744 When this option is nil, the current day, month and year will always be
2745 used as defaults.
2747 See also `org-agenda-jump-prefer-future'."
2755 "Should the agenda jump command prefer the future for incomplete dates?
2756 The default is to do the same as configured in `org-read-date-prefer-future'.
2757 But you can also set a deviating value here.
2758 This may t or nil, or the symbol `org-read-date-prefer-future'."
2764 org-read-date-prefer-future)
2769 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2771 Depending on the system Emacs is running on, certain dates cannot
2772 be represented with the type used internally to represent time.
2773 Dates between 1970-1-1 and 2038-1-1 can always be represented
2774 correctly. Some systems allow for earlier dates, some for later,
2775 some for both. One way to find out it to insert any date into an
2776 Org buffer, putting the cursor on the year and hitting S-up and
2777 S-down to test the range.
2779 When this variable is set to t, the date/time prompt will not let
2780 you specify dates outside the 1970-2037 range, so it is certain that
2781 these dates will work in whatever version of Emacs you are
2782 running, and also that you can move a file from one Emacs implementation
2783 to another. WHenever Org is forcing the year for you, it will display
2784 a message and beep.
2786 When this variable is nil, Org will check if the date is
2787 representable in the specific Emacs implementation you are using.
2788 If not, it will force a year, usually the current year, and beep
2789 to remind you. Currently this setting is not recommended because
2790 the likelihood that you will open your Org files in an Emacs that
2791 has limited date range is not negligible.
2793 A workaround for this problem is to use diary sexp dates for time
2794 stamps outside of this range."
2800 "Non-nil means display current interpretation of date prompt live.
2801 This display will be in an overlay, in the minibuffer."
2806 "Non-nil means pop up a calendar when prompting for a date.
2807 In the calendar, the date can be selected with mouse-1. However, the
2808 minibuffer will also be active, and you can simply enter the date as well.
2809 When nil, only the minibuffer will be available."
2817 "Hook to be used to set up keys for the date/time interface.
2818 Add key definitions to `minibuffer-local-map', which will be a temporary
2819 copy."
2824 "The hour when your day really ends. Must be an integer.
2825 This has influence for the following applications:
2827 the time given here, the day recognized as TODAY is actually yesterday.
2828 - When a date is read from the user and it is still before the time given
2829 here, the current date and time will be assumed to be yesterday, 23:59.
2830 Also, timestamps inserted in remember templates follow this rule.
2832 IMPORTANT: This is a feature whose implementation is and likely will
2833 remain incomplete. Really, it is only here because past midnight seems to
2834 be the favorite working time of John Wiegley :-)"
2839 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2840 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2842 23:59 of the previous day."
2848 "Non-nil means S-down will increase the time in a time stamp.
2849 When nil, S-up will increase."
2854 "Non-nil means make the calendar window follow timestamp changes.
2855 When a timestamp is modified and the calendar window is visible, it will be
2856 moved to the new date."
2861 "Options concerning tags in Org-mode."
2866 "List of tags allowed in Org-mode files.
2867 When this list is nil, Org-mode will base TAG input on what is already in the
2868 buffer.
2869 The value of this variable is an alist, the car of each entry must be a
2870 keyword as a string, the cdr may be a character that is used to select
2871 that tag through the fast-tag-selection interface.
2872 See the manual for details."
2887 "List of tags that will always appear in all Org-mode files.
2888 This is in addition to any in buffer settings or customizations
2889 of `org-tag-alist'.
2890 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2891 The value of this variable is an alist, the car of each entry must be a
2892 keyword as a string, the cdr may be a character that is used to select
2893 that tag through the fast-tag-selection interface.
2894 See the manual for details.
2895 To disable these tags on a per-file basis, insert anywhere in the file:
2896 #+STARTUP: noptag"
2907 "If non-nil, always offer completion for all tags of all agenda files.
2908 Instead of customizing this variable directly, you might want to
2909 set it locally for capture buffers, because there no list of
2910 tags in that file can be created dynamically (there are none).
2912 (add-hook 'org-capture-mode-hook
2913 (lambda ()
2914 (set (make-local-variable
2915 'org-complete-tags-always-offer-all-agenda-tags)
2916 t)))"
2922 "List of tags that can be inherited by all entries in the file.
2923 The tags will be inherited if the variable `org-use-tag-inheritance'
2924 says they should be.
2928 "Non-nil means use fast tag selection scheme.
2929 This is a special interface to select and deselect tags with single keys.
2930 When nil, fast selection is never used.
2931 When the symbol `auto', fast selection is used if and only if selection
2932 characters for tags have been configured, either through the variable
2933 `org-tag-alist' or through a #+TAGS line in the buffer.
2934 When t, fast selection is always used and selection keys are assigned
2935 automatically if necessary."
2943 "Non-nil means fast tag selection exits after first change.
2944 When nil, you have to press RET to exit it.
2945 During fast tag selection, you can toggle this flag with `C-c'.
2946 This variable can also have the value `expert'. In this case, the window
2947 displaying the tags menu is not even shown, until you press C-c again."
2955 "Non-nil means fast tags selection interface will also offer TODO states.
2959 "The column to which tags should be indented in a headline.
2960 If this number is positive, it specifies the column. If it is negative,
2961 it means that the tags should be flushright to that column. For example,
2962 -80 works well for a normal 80 character screen.
2963 When 0, place tags directly after headline text, with only one space in
2964 between."
2969 "Non-nil keeps tags aligned when modifying headlines.
2970 Some operations (i.e. demoting) change the length of a headline and
2971 therefore shift the tags around. With this option turned on, after
2972 each such operation the tags are again aligned to `org-tags-column'."
2977 "Non-nil means tags in levels apply also for sublevels.
2978 When nil, only the tags directly given in a specific line apply there.
2979 This may also be a list of tags that should be inherited, or a regexp that
2980 matches tags that should be inherited. Additional control is possible
2981 with the variable `org-tags-exclude-from-inheritance' which gives an
2982 explicit list of tags to be excluded from inheritance., even if the value of
2983 `org-use-tag-inheritance' would select it for inheritance.
2985 If this option is t, a match early-on in a tree can lead to a large
2986 number of matches in the subtree when constructing the agenda or creating
2987 a sparse tree. If you only want to see the first match in a tree during
2988 a search, check out the variable `org-tags-match-list-sublevels'."
2997 "List of tags that should never be inherited.
2998 This is a way to exclude a few tags from inheritance. For way to do
2999 the opposite, to actively allow inheritance for selected tags,
3000 see the variable `org-use-tag-inheritance'."
3005 "Check if TAG is one that should be inherited."
3017 "Non-nil means list also sublevels of headlines matching a search.
3018 This variable applies to tags/property searches, and also to stuck
3019 projects because this search is based on a tags match as well.
3021 When set to the symbol `indented', sublevels are indented with
3022 leading dots.
3024 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3025 the sublevels of a headline matching a tag search often also match
3026 the same search. Listing all of them can create very long lists.
3027 Setting this variable to nil causes subtrees of a match to be skipped.
3029 This variable is semi-obsolete and probably should always be true. It
3030 is better to limit inheritance to certain tags using the variables
3031 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3039 "When set, tags are sorted using this function as a comparator."
3055 "Options concerning properties in Org-mode."
3060 "How property key/value pairs should be formatted by `indent-line'.
3061 When `indent-line' hits a property definition, it will format the line
3062 according to this format, mainly to make sure that the values are
3063 lined-up with respect to each other."
3068 "Alist of properties and functions to adjust inserted values.
3069 Elements of this alist must be of the form
3071 ([string] [function])
3073 where [string] must be a property name and [function] must be a
3074 lambda expression: this lambda expression must take one argument,
3075 the value to adjust, and return the new value as a string.
3079 and the clock summary:
3082 (let ((clocksum (org-clock-sum-current-item))
3083 (effort (org-duration-string-to-minutes
3085 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3091 "Non-nil means properties apply also for sublevels.
3093 This setting is chiefly used during property searches. Turning it on can
3094 cause significant overhead when doing a search, which is why it is not
3095 on by default.
3097 When nil, only the properties directly given in the current entry count.
3098 When t, every property is inherited. The value may also be a list of
3099 properties that should have inheritance, or a regular expression matching
3100 properties that should be inherited.
3102 However, note that some special properties use inheritance under special
3103 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3105 for valid values of a property.
3107 Note for programmers:
3108 When querying an entry with `org-entry-get', you can control if inheritance
3109 should be used. By default, `org-entry-get' looks only at the local
3110 properties. You can request inheritance by setting the inherit argument
3111 to t (to force inheritance) or to `selective' (to respect the setting
3112 in this variable)."
3121 "Check if PROPERTY is one that should be inherited."
3132 "The default column format, if no other format has been defined.
3133 This variable can be set on the per-file basis by inserting a line
3135 #+COLUMNS: %25ITEM ....."
3140 "The ellipses to be used when a field in column view is truncated.
3141 When this is the empty string, as many characters as possible are shown,
3142 but then there will be no visual indication that the field has been truncated.
3143 When this is a string of length N, the last N characters of a truncated
3144 field are replaced by this string. If the column is narrower than the
3145 ellipses string, only part of the ellipses string will be shown."
3150 "Function that modifies values for display in column view.
3151 For example, it can be used to cut out a certain part from a time stamp.
3152 The function must take 2 arguments:
3154 column-title The title of the column (*not* the property name)
3155 value The value that should be modified.
3157 The function should return the value that should be displayed,
3158 or nil if the normal value should be used."
3163 "The property that is being used to keep track of effort estimates.
3164 Effort estimates given in this property need to have the format H:MM."
3172 "List of property/value pairs that can be inherited by any entry.
3174 These are fixed values, for the preset properties. The user variable
3175 that can be used to add to this list is `org-global-properties'.
3177 The entries in this list are cons cells where the car is a property
3178 name and cdr is a string with the value. If the value represents
3183 "List of property/value pairs that can be inherited by any entry.
3185 This list will be combined with the constant `org-global-properties-fixed'.
3187 The entries in this list are cons cells where the car is a property
3188 name and cdr is a string with the value.
3190 You can set buffer-local values for the same purpose in the variable
3191 `org-file-properties' this by adding lines like
3193 #+PROPERTY: NAME VALUE"
3200 "List of property/value pairs that can be inherited by any entry.
3201 Valid for the current buffer.
3206 "Options concerning agenda views in Org-mode."
3211 "Variable used by org files to set a category for agenda display.
3212 Such files should use a file variable to set it, for example
3216 or contain a special line
3218 #+CATEGORY: ELisp
3220 If the file does not specify a category, then file's base name
3226 "The files to be used for agenda display.
3230 If an entry is a directory, all files in that directory that are matched by
3231 `org-agenda-file-regexp' will be part of the file list.
3233 If the value of the variable is not a list but a single file name, then
3234 the list of agenda files is actually stored and maintained in that file, one
3235 agenda file per line. In this file paths can be given relative to
3236 `org-directory'. Tilde expansion and environment variable substitution
3237 are also made."
3244 "Regular expression to match files for `org-agenda-files'.
3245 If any element in the list in that variable contains a directory instead
3246 of a normal file, all files in that directory that are matched by this
3247 regular expression will be included."
3252 "List of extra files to be searched by text search commands.
3253 These files will be search in addition to the agenda files by the
3254 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3255 Note that these files will only be searched for text search commands,
3256 not for the other agenda views like todo lists, tag searches or the weekly
3257 agenda. This variable is intended to list notes and possibly archive files
3258 that should also be searched by these two commands.
3259 In fact, if the first element in the list is the symbol `agenda-archives',
3260 than all archive files of all agenda files will be added to the search
3261 scope."
3272 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3273 A nil value means to remove them, after a query, from the list."
3278 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3279 The command `org-calendar-goto-agenda' will be bound to this key. The
3280 default is the character `c' because then `c' can be used to switch back and
3281 forth between agenda and calendar."
3286 "The key to be installed in `calendar-mode-map' for agenda-action.
3287 The command `org-agenda-action' will be bound to this key. The
3288 default is the character `k' because we use the same key in the agenda."
3293 "The key to be installed in `calendar-mode-map' for adding diary entries.
3294 This option is irrelevant until `org-agenda-diary-file' has been configured
3295 to point to an Org-mode file. When that is the case, the command
3296 `org-agenda-diary-entry' will be bound to the key given here, by default
3297 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3298 if you want to continue doing this, you need to change this to a different
3299 key."
3304 "File to which to add new entries with the `i' key in agenda and calendar.
3305 When this is the symbol `diary-file', the functionality in the Emacs
3306 calendar will be used to add entries to the `diary-file'. But when this
3307 points to a file, `org-agenda-diary-entry' will be used instead."
3323 org-calendar-insert-diary-entry-key
3327 "Options for embedding LaTeX code into Org-mode."
3335 "Options for creating images from LaTeX fragments.
3336 This is a property list with the following properties:
3338 `default' means use the foreground of the default face.
3340 `default' means use the background of the default face.
3341 :scale a scaling factor for the size of the images, to get more pixels
3342 :html-foreground, :html-background, :html-scale
3343 the same numbers for HTML export.
3344 :matchers a list indicating which matchers should be used to
3345 find LaTeX fragments. Valid members of this list are:
3356 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3357 When nil, just push out a message."
3364 Use this to specify additional executable file say a jar file.
3366 When using MathToWeb as the converter, specify the full-path to
3367 your mathtoweb.jar file."
3375 "Command to convert LaTeX fragments to MathML.
3376 Replace format-specifiers in the command as noted below and use
3377 `shell-command' to convert LaTeX to MathML.
3378 %j: Executable file in fully expanded form as specified by
3379 `org-latex-to-mathml-jar-file'.
3380 %I: Input LaTeX file in fully expanded form
3381 %o: Output MathML file
3382 This command is used by `org-create-math-formula'.
3384 When using MathToWeb as the converter, set this to
3393 "Return t if `org-latex-to-mathml-convert-command' is usable."
3396 org-latex-to-mathml-convert-command)
3398 org-latex-to-mathml-convert-command))))
3403 t))))))
3410 \[PACKAGES]
3411 \[DEFAULT-PACKAGES]
3412 % The settings below are copied from fullpage.sty
3425 "The document header used for processing LaTeX fragments.
3426 It is imperative that this header make sure that no page number
3427 appears on the page. The package defined in the variables
3428 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3430 will be appended."
3437 "Set the packages alist and make sure it has 3 elements per entry."
3441 x))
3442 val)))
3446 "Get the packages alist and make sure it has 3 elements per entry."
3450 x))
3453 ;; The following variables are defined here because is it also used
3454 ;; when formatting latex fragments. Originally it was part of the
3455 ;; LaTeX exporter, which is why the name includes "export".
3472 )
3473 "Alist of default packages to be inserted in the header.
3474 Change this only if one of the packages here causes an incompatibility
3475 with another package you are using.
3476 The packages in this list are needed by one part or another of Org-mode
3477 to function properly.
3479 - inputenc, fontenc: for basic font and character selection
3480 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3481 for interpreting the entities in `org-entities'. You can skip some of these
3482 packages if you don't use any of the symbols in it.
3483 - graphicx: for including images
3484 - float, wrapfig: for figure placement
3485 - longtable: for long tables
3486 - hyperref: for cross references
3488 Therefore you should not modify this variable unless you know what you
3489 are doing. The one reason to change it anyway is that you might be loading
3490 some other package that conflicts with one of the default packages.
3492 If SNIPPET-FLAG is t, the package also needs to be included when
3493 compiling LaTeX snippets into images for inclusion into HTML."
3507 "Alist of packages to be inserted in every LaTeX header.
3508 These will be inserted after `org-export-latex-default-packages-alist'.
3510 SNIPPET-FLAG, when t, indicates that this package is also needed when
3511 turning LaTeX snippets into images for inclusion into HTML.
3512 Make sure that you only list packages here which:
3513 - you want in every file
3514 - do not conflict with the default packages in
3515 `org-export-latex-default-packages-alist'
3516 - do not conflict with the setup in `org-format-latex-header'."
3530 "Settings for Org-mode appearance."
3535 "Non-nil means fontify only the stars in each headline.
3536 When nil, the entire headline is fontified.
3537 Changing it requires restart of `font-lock-mode' to become effective
3538 also in regions already fontified."
3543 "Non-nil means hide the first N-1 stars in a headline.
3544 This works by using the face `org-hide' for these stars. This
3545 face is white for a light background, and black for a dark
3546 background. You may have to customize the face `org-hide' to
3547 make this work.
3548 Changing it requires restart of `font-lock-mode' to become effective
3549 also in regions already fontified.
3550 You may also set this on a per-file basis by adding one of the following
3551 lines to the buffer:
3553 #+STARTUP: hidestars
3554 #+STARTUP: showstars"
3559 "List of symbols corresponding to keywords to be hidden the org buffer.
3560 For example, a value '(title) for this list will make the document's title
3561 appear in the buffer without the initial #+TITLE: keyword."
3570 "Non-nil means change the face of a headline if it is marked DONE.
3571 Normally, only the TODO/DONE keyword indicates the state of a headline.
3572 When this is non-nil, the headline after the keyword is set to the
3573 `org-headline-done' as an additional indication."
3578 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3579 Changing this variable requires a restart of Emacs to take effect."
3584 "Non-nil means fontify the whole line for headings.
3585 This is useful when setting a background color for the
3586 org-level-* faces."
3591 "Non-nil means fontify what is treated specially by the exporters."
3596 "Non-nil mean font-lock should hide the emphasis marker characters."
3601 "Non-nil means show entities as UTF8 characters.
3608 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3614 "Regular expression for matching emphasis.
3615 After a match, the match groups contain these elements:
3616 0 The match of the full regular expression, including the characters
3617 before and after the proper match
3618 1 The character before the proper match, or empty at beginning of line
3619 2 The proper match, including the leading and trailing markers
3620 3 The leading marker like * or /, indicating the type of highlighting
3621 4 The text between the emphasis markers, not including the markers
3628 "Set variable and compute the emphasis regular expression."
3632 org-emphasis-alist org-emphasis-regexp-components)
3644 ;; make sure special characters appear at the right position in the class
3656 ;; Make the regexp
3664 body1
3676 body1
3684 "Components used to build the regular expression for emphasis.
3685 This is a list with five entries. Terminology: In an emphasis string
3689 specify what is allowed/forbidden in each part:
3691 pre Chars allowed as prematch. Beginning of line will be allowed too.
3692 post Chars allowed as postmatch. End of line will be allowed too.
3693 border The chars *forbidden* as border characters.
3695 non-shy groups here, and don't allow newline here.
3696 newline The maximum number of newlines allowed in an emphasis exp.
3698 Use customize to modify this, or restart Emacs after changing it."
3717 )
3718 "Special syntax for emphasized text.
3719 Text starting and ending with a special character will be emphasized, for
3720 example *bold*, _underlined_ and /italic/. This variable sets the marker
3721 characters, the face to be used by font-lock for highlighting in Org-mode
3722 Emacs buffers, and the HTML tags to be used for this.
3723 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3724 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3725 Use customize to modify this, or restart Emacs after changing it."
3740 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3743 ;;; Miscellaneous options
3746 "Completion in Org-mode."
3751 "Non-nil means use ido completion wherever possible.
3752 Note that `ido-mode' must be active for this variable to be relevant.
3753 If you decide to turn this variable on, you might well want to turn off
3754 `org-outline-path-complete-in-steps'.
3755 See also `org-completion-use-iswitchb'."
3760 "Non-nil means use iswitchb completion wherever possible.
3761 Note that `iswitchb-mode' must be active for this variable to be relevant.
3762 If you decide to turn this variable on, you might well want to turn off
3763 `org-outline-path-complete-in-steps'.
3764 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3770 Normal means, no org-mode-specific context."
3774 ;;; Functions and variables from their packages
3775 ;; Declared here to avoid compiler warnings
3777 ;; XEmacs only
3783 ;; Emacs only
3786 ;; Various packages
3805 org-agenda-format-item "org-agenda"
3836 ;;; Autoload and prepare some org modules
3838 ;; Some table stuff that needs to be defined here, because it is used
3839 ;; by the functions setting up org-mode or checking for table context.
3852 "Detect the first line outside a table when searching from within it.
3855 ;; Autoload the functions in org-table.el that are needed by functions here.
3860 org-table-convert org-table-convert-region org-table-copy-down
3861 org-table-copy-region org-table-create
3862 org-table-create-or-convert-from-region
3863 org-table-create-with-table.el org-table-current-dline
3864 org-table-cut-region org-table-delete-column org-table-edit-field
3865 org-table-edit-formulas org-table-end org-table-eval-formula
3866 org-table-export org-table-field-info
3867 org-table-get-stored-formulas org-table-goto-column
3868 org-table-hline-and-move org-table-import org-table-insert-column
3869 org-table-insert-hline org-table-insert-row org-table-iterate
3870 org-table-justify-field-maybe org-table-kill-row
3871 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3872 org-table-move-column org-table-move-column-left
3873 org-table-move-column-right org-table-move-row
3874 org-table-move-row-down org-table-move-row-up
3875 org-table-next-field org-table-next-row org-table-paste-rectangle
3876 org-table-previous-field org-table-recalculate
3877 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3878 org-table-toggle-coordinate-overlays
3879 org-table-toggle-formula-debugger org-table-wrap-region
3880 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3881 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3882 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3885 "Return t if the cursor is inside an org-type table.
3886 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3891 org-table-line-regexp)))
3892 nil))
3896 "Return t if and only if we are at a table.el table."
3902 "If there is a table.el table nearby, recognize it and move into it."
3908 nil
3918 t
3923 t)
3924 nil)
3925 nil))
3928 "Return t if the cursor is inside a hline in a table."
3933 nil))
3938 "Apply FUNCTION to the start of all tables in the buffer."
3954 ;; Declare and autoload functions from org-exp.el & Co
3962 org-insert-export-options-template
3963 org-table-clean-before-export))
3966 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3967 org-export-region-as-ascii))
3970 org-replace-region-by-latex org-export-region-as-latex
3971 org-export-as-latex org-export-as-pdf
3972 org-export-as-pdf-and-open))
3975 org-export-as-html-batch org-export-as-html-to-buffer
3976 org-replace-region-by-html org-export-region-as-html
3977 org-export-as-html))
3980 org-replace-region-by-docbook org-export-region-as-docbook
3981 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3982 org-export-as-docbook))
3985 org-export-icalendar-all-agenda-files
3986 org-export-icalendar-combine-agenda-files))
3990 ;; Declare and autoload functions from org-agenda.el
3995 org-todo-list org-tags-view org-agenda-list-stuck-projects
3996 org-diary org-agenda-to-appt
3997 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3999 ;; Autoload org-remember
4004 org-remember-apply-template org-remember org-remember-handler)))
4009 org-capture-import-remember-templates)))
4011 ;; Autoload org-clock.el
4026 "Return non-nil if clock is currently running.
4027 The return value is actually the clock marker."
4032 "org-clock"
4034 org-clock-goto org-clock-sum org-clock-display
4035 org-clock-remove-overlays org-clock-report
4036 org-clocktable-shift org-dblock-write:clocktable
4037 org-get-clocktable org-resolve-clocks)))
4040 "If this is a CLOCK line, update it and return t.
4041 Otherwise, return nil."
4050 ts te h m s neg)
4053 nil)
4058 ;; The clock is running here
4079 t))))))
4082 "Check if the current buffer contains the running clock.
4083 If yes, offer to stop it and to save the buffer with the changes."
4092 "Check if this line starts a clock table, if yes, shift the time block."
4096 ;; Autoload org-timer.el
4100 "org-timer"
4102 org-timer-change-times-in-region
4103 org-timer-set-timer
4104 org-timer-reset-timers
4105 org-timer-show-remaining-time)))
4107 ;; Autoload org-feed.el
4111 "org-feed"
4115 ;; Autoload org-indent.el
4117 ;; Define the variable already here, to make sure we have it.
4119 "Non-nil if Org-Indent mode is enabled.
4124 "org-indent"
4127 ;; Autoload org-mobile.el
4131 "org-mobile"
4134 ;; Autoload archiving code
4135 ;; The stuff that is needed for cycling and tags has to be defined here.
4138 "Options concerning archiving in Org-mode."
4143 "The location where subtrees should be archived.
4145 The value of this variable is a string, consisting of two parts,
4146 separated by a double-colon. The first part is a filename and
4147 the second part is a headline.
4149 When the filename is omitted, archiving happens in the same file.
4150 %s in the filename will be replaced by the current file
4151 name (without the directory part). Archiving to a different file
4152 is useful to keep archived entries from contributing to the
4153 Org-mode Agenda.
4155 The archived entries will be filed as subtrees of the specified
4156 headline. When the headline is omitted, the subtrees are simply
4157 filed away at the end of the file, as top-level entries. Also in
4158 the heading you can use %s to represent the file name, this can be
4159 useful when using the same archive for a number of different files.
4161 Here are a few examples:
4163 If the current file is Projects.org, archive in file
4164 Projects.org_archive, as top-level trees. This is the default.
4167 Archive in the current file, under the top-level headline
4171 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4174 Archive in file ~/org/archive.org (absolute path), under headlines
4178 Archive in file ./basement (relative path), as level 3 trees
4181 You may set this option on a per-file basis by adding to the buffer a
4182 line like
4184 #+ARCHIVE: basement::** Finished Tasks
4186 You may also define it locally for a subtree by setting an ARCHIVE property
4187 in the entry. If such a property is found in an entry, or anywhere up
4188 the hierarchy, it will be used."
4193 "The tag that marks a subtree as archived.
4194 An archived subtree does not open during visibility cycling, and does
4195 not contribute to the agenda listings.
4196 After changing this, font-lock must be restarted in the relevant buffers to
4197 get the proper fontification."
4203 "Non-nil means the agenda will skip any items located in archived trees.
4204 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4205 variable is no longer recommended, you should leave it at the value t.
4206 Instead, use the key `v' to cycle the archives-mode in the agenda."
4212 "Non-nil means ignore archived trees when creating column view."
4218 "Non-nil means `org-cycle' will open archived trees.
4219 An archived tree is a tree marked with the tag ARCHIVE.
4220 When nil, archived trees will stay folded. You can still open them with
4221 normal outline commands like `show-all', but not with the cycling commands."
4227 "Non-nil means sparse tree construction shows matches in archived trees.
4228 When nil, matches in these trees are highlighted, but the trees are kept in
4229 collapsed state."
4235 "Re-hide all archived subtrees after a visibility state change."
4246 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4249 "Cycle subtree even if it is archived."
4256 "Re-hide all archived subtrees after a visibility state change."
4271 flag)))
4278 org-archive-to-archive-sibling org-toggle-archive-tag
4279 org-archive-subtree-default
4280 org-archive-subtree-default-with-confirmation)))
4282 ;; Autoload Column View Code
4290 org-columns-compute org-agenda-columns org-columns-remove-overlays
4293 ;; Autoload ID code
4301 org-id-get-with-outline-path-completion
4302 org-id-get-with-outline-drilling org-id-store-link
4303 org-id-goto org-id-find org-id-store-link))
4305 ;; Autoload Plotting Code
4310 ;;; Variables for pre-computed regular expressions, all buffer local
4328 "Matches a headline and puts everything into groups:
4329 group 1: the stars
4330 group 2: The todo keyword, maybe
4331 group 3: Priority cookie
4332 group 4: True headline
4336 "Printf format to make regexp to match an exact headline.
4337 This regexp will match the headline of any node which has the
4338 exact headline text that is put into the format, but may have any
4342 "Matches a headline and puts TODO state into group 2 if present.
4391 "Regular expression to match a plain time or time range.
4392 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4393 groups carry important information:
4394 0 the full match
4395 1 the first time, range or not
4403 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4404 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4405 groups carry important information:
4406 0 the full match
4407 7 hours of duration
4416 "Regular expression to match a timestamp time or time range.
4417 After a match, the following groups carry important information:
4418 0 the full match
4419 1 date plus weekday, for back referencing to make sure both times are on the same day
4420 2 the first time, range or not
4475 "Variable associated with STARTUP options for org-mode.
4476 Each element is a list of three items: The startup options as written
4477 in the #+STARTUP line, the corresponding variable, and the value to
4478 set this variable to if the option is found. An optional forth element PUSH
4482 "Update PROPS with KEY and VAL."
4496 "Printf format for a regexp matching an headline with some keyword.
4497 This regexp will match the headline of any node which has the
4498 exact keyword that is put into the format. The keyword isn't in
4502 "Printf format for a regexp matching an headline, possibly with some keyword.
4503 This regexp can match any headline with the specified keyword, or
4504 without a keyword. The keyword isn't in any group by default,
4508 "Precompute regular expressions for current buffer."
4528 kwds kws0 kwsa key log value cat arch tags const links hw dws
4529 tail sep kws1 prio props ftags drawers beamer-p
4551 ;; general TODO-like setup
4563 links)))
4570 props))))
4575 ftags
4585 l var val)
4615 ;; search for property blocks
4624 props)))))))
4641 ;; Process the TODO keywords
4643 ;; Use the global values as if they had been given locally.
4655 kws)))
4658 kwsa nil
4661 ;; 1 2
4669 kw)
4671 kws0)
4688 ;; Process the constants
4696 ;; Process the tags.
4707 tgs))
4715 ;; Compute the regular expressions and other local variables.
4716 ;; Using `org-outline-regexp-bol' would complicate them much,
4717 ;; because of the fixed white space at the end of that string.
4725 org-drawer-regexp
4729 org-not-done-keywords
4731 org-todo-regexp
4735 org-not-done-regexp
4739 org-not-done-heading-regexp
4741 org-todo-line-regexp
4743 org-complex-heading-regexp
4750 org-complex-heading-regexp-format
4755 ;; Stats cookies can be stuck to body.
4762 org-todo-line-tags-regexp
4769 org-deadline-time-regexp
4771 org-deadline-line-regexp
4773 org-scheduled-regexp
4775 org-scheduled-time-regexp
4777 org-closed-time-regexp
4779 org-keyword-time-regexp
4785 org-keyword-time-not-clock-regexp
4791 org-maybe-keyword-time-regexp
4797 org-planning-or-clock-line-re
4802 org-all-time-keywords
4805 org-clock-string org-closed-string))
4806 )
4811 "Return the contents of FILE, as a string."
4825 "Extract the log state setting from a TODO keyword string.
4839 "Remove a pair of parenthesis at the end of each string in LIST."
4843 x))
4844 list))
4847 "Assign fast keys to a keyword-key alist.
4848 Respect keys that are already there."
4866 ;;; Some variables used in various places
4873 "Function to be called when `C-c C-c' is used.
4877 ;; FIXME: Occasionally check by commenting these, to make sure
4878 ;; no other functions uses these, forgetting to let-bind them.
4883 ;; Defined somewhere in this file, but used before definition.
4889 ;;;; Define the Org-mode
4892 (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"))
4895 ;; We use a before-change function to check if a table might need
4896 ;; an update.
4898 "Indicates that a table might need an update.
4899 This variable is set by `org-before-change-function'.
4902 "Every change indicates that a table might need an update."
4912 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4913 ;; some places -- e.g. see the macro org-with-limited-levels.
4914 ;;
4915 ;; In Org buffers, the value of `outline-regexp' is that of
4916 ;; `org-outline-regexp'. The only function still directly relying on
4917 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4918 ;; job when `orgstruct-mode' is active.
4922 "Regexp to match Org headlines.
4923 This is similar to `org-outline-regexp' but additionally makes
4927 "Matches an headline, putting stars and text into groups.
4930 ;;;###autoload
4932 "Outline-based notes management and organizer, alias
4935 Org-mode develops organizational tasks around a NOTES file which
4936 contains information about projects as plain text. Org-mode is
4937 implemented on top of outline-mode, which is ideal to keep the content
4938 of large files well structured. It supports ToDo items, deadlines and
4939 time stamps, which magically appear in the diary listing of the Emacs
4940 calendar. Tables are easily created with a built-in table editor.
4941 Plain text URL-like links connect to websites, emails (VM), Usenet
4942 messages (Gnus), BBDB entries, and any files related to the project.
4943 For printing and sharing of notes, an Org-mode file (or a part of it)
4944 can be exported as a structured ASCII or HTML file.
4946 The following commands are available:
4950 ;; Get rid of Outline menus, they are not needed
4951 ;; Need to do this here because define-derived-mode sets up
4952 ;; the keymap so late. Still, it is a waste to call this each time
4953 ;; we switch another buffer into org-mode.
4956 ;; Assume this is Greg's port, it uses easymenu
4982 org-display-table 4
4985 org-ellipsis)))
4990 ;; tag faces set outside customize.... force initialization.
4992 ;; Calc embedded
4998 ;; Activate before-change-function
5002 ;; Check for running clock before killing a buffer
5004 ;; Paragraphs and auto-filling
5008 ;; Beginning/end of defun
5011 ;; Next error for sparse trees
5013 ;; Make sure dependence stuff works reliably, even for users who set it
5014 ;; too late :-(
5026 ;; Comment characters
5030 ;; Align options lines
5032 'align-mode-rules-list
5037 ;; Imenu
5041 ;; Make isearch reveal context
5044 ;; Emacs 21 and XEmacs make use of the hook
5046 ;; Emacs 22 deals with this through a special variable
5050 ;; Turn on org-beamer-mode?
5053 ;; Setup the pcomplete hooks
5066 ;; If empty file that did not turn on org-mode automatically, make it to.
5091 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5101 "Return today date, considering `org-extend-today-until'."
5106 ;;;; Font-Lock stuff, including the activators
5137 "Regular expression used to analyze links.
5138 Here is what the match groups contain after a match:
5139 1: http:
5140 2: http
5141 3: path
5142 4: [desc]
5150 "Number of stacked braces for sub/superscript matching.
5151 This has to be set before loading org.el to be effective."
5156 "Create a regular expression which will match a balanced sexp.
5157 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5158 as single character strings.
5159 The regexp returned will match the entire expression including the
5160 delimiters. It will also define a single group which contains the
5161 match except for the outermost delimiters. The maximum depth of
5162 stacked delimiters is N. Escaping delimiters is not possible."
5191 "Update the link regular expressions.
5192 This should be called after the variable `org-link-types' has changed."
5196 org-link-re-with-space
5202 org-link-re-with-space2
5208 org-link-re-with-space3
5213 org-angle-link-re
5219 org-plain-link-re
5223 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5224 org-bracket-link-regexp
5226 org-bracket-link-analytic-regexp
5234 org-bracket-link-analytic-regexp++
5242 org-any-link-re
5251 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5253 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5254 "Regular expression matching time strings for analysis.
5255 This one does not require the space after the date, so it can be used
5257 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5273 "Regular expression matching a time stamp or time stamp range.
5279 "Run through the buffer and add overlays to emphasized strings."
5288 'face
5301 rtn))
5304 "Insert or change an emphasis, i.e. a font like bold or italic.
5305 If there is an active region, change that region to a new emphasis.
5306 If there is no region, just insert the marker characters and position
5307 the cursor between them.
5308 CHAR should be either the marker character, or the first character of the
5309 HTML tag associated with that emphasis. If CHAR is a space, the means
5310 to remove the emphasis of the selected region.
5311 If char is not given (for example in an interactive call) it
5312 will be prompted for."
5363 "Run through the buffer and add overlays to links."
5372 nil
5378 t)))))
5386 t)))
5389 "When non-nil, fontify code in code blocks."
5401 "Fontify #+ lines and blocks, in the correct ways."
5404 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5405 limit t)
5413 end end1 quoting block-type ovl)
5416 ;; a single line of backend-specific content
5424 ; for backend-specific code
5425 t)
5427 ;; Truly a block
5439 beg end
5447 ;; remove old background overlays
5452 ;; add a background overlay
5466 t))
5479 ;; just any other in-buffer setting, but not indented
5483 t)
5491 t)
5499 "Run through the buffer and add overlays to links."
5507 t)))
5510 "Run through the buffer and add overlays to footnotes."
5517 'keymap org-mouse-map
5518 'help-echo
5520 "Footnote definition"
5522 'font-lock-fontified t
5523 'font-lock-multiline t
5527 "Run through the buffer and add overlays to bracketed links."
5531 ;; FIXME: above we should remove the escapes.
5532 ;; but that requires another match, protecting match data,
5533 ;; a lot of overhead for font-lock.
5540 ;; We need to remove the invisible property here. Table narrowing
5541 ;; may have made some of this invisible.
5559 t)))
5562 "Run through the buffer and add overlays to dates."
5574 t)))
5583 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5587 "Run through the buffer and add overlays to target matches."
5595 'keymap org-mouse-map
5599 t)))))
5602 "Find all radio targets in this file and update the regular expression."
5617 t)))
5624 ;; This should be with the exporter code, but we also use if for font-locking
5634 "Compute regular expression for stuff treated specially by exporters."
5641 org-latex-regexps)))
5669 org-entities)))
5673 org-latex-entities)
5674 nil))
5676 ))
5677 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5680 org-export-html-special-string-regexps)))
5685 ))))
5687 'org-latex-and-specials-regexp
5692 "Run through the buffer and add overlays to links."
5696 limit t))
5710 rtn)))
5713 "Restart `font-lock-mode', to force refontification."
5719 "Return a list of all targets in this file.
5720 With optional argument RADIO, only find radio targets."
5722 rtn)
5727 rtn)))
5730 "Make regular expression matching all strings in TARGETS.
5731 The regular expression finds the targets also if there is a line break
5732 between words."
5741 x)
5742 targets
5754 t)))
5757 "Compute the outline level of the heading at point.
5758 This function assumes that the cursor is at the beginning of a line matched
5759 by `outline-regexp'. Otherwise it returns garbage.
5760 If this is called at a normal headline, the level is the number of stars.
5761 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5768 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5775 "Functions that can manipulate `org-font-lock-extra-keywords'.
5776 This is called after `org-font-lock-extra-keywords' is defined, but before
5777 it is installed to be used by font lock. This can be useful if something
5788 ;; Call the hook
5790 ;; Headlines
5797 ;; Table lines
5800 ;; Table internals
5805 ;; Drawers
5808 ;; Properties
5812 ;; Links
5822 ;; TODO keyword
5824 org-todo-regexp)
5826 ;; DONE
5834 nil)
5835 ;; Priorities
5837 ;; Tags
5839 ;; Special keywords
5844 ;; Emphasis
5849 ;; Checkboxes
5850 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5855 ;; Description list items
5858 ;; ARCHIVEd headings
5860 org-outline-regexp-bol
5863 ;; Specials
5867 ;; Code
5869 ;; COMMENT
5876 ;; Blocks and meta lines
5878 )))
5881 ;; Now set the full font-lock-keywords
5888 "Toggle the composition display of entities as UTF8 characters."
5900 "Find an entity to fontify."
5906 limit t)
5918 nil))))
5921 "Fontify string S like in Org-mode."
5933 "Get the right face for match N in font-lock matching of headlines."
5946 "Get the right face for a TODO keyword KWD.
5947 If KWD is a number, get the corresponding match group."
5955 "Create a face list that inherits INHERIT, but sets the foreground color.
5956 When FACE-OR-COLOR is not a string, just return it."
5960 face-or-color)
5961 face-or-color))
5964 "Add the special tag faces."
5973 "Add the special priority faces."
5980 org-priority-faces)))
5985 "Get the right face for a TODO keyword KWD.
5986 If KWD is a number, get the corresponding match group."
5993 "Remove fontification and activation overlays from links."
5998 deactivate-mark buffer-file-name buffer-file-truename)
6002 invisible t intangible t
6003 org-no-flyspell t org-emphasis t))
6013 "Remove specific display properties that have been added by font lock.
6014 The will remove the raise properties that are used to show superscripts
6015 and subscripts."
6025 "Add raise properties to sub/superscripts."
6029 org-match-substring-regexp
6030 org-match-substring-with-braces-regexp)
6031 limit t)
6041 ;; FIXME: Should we go back one character here, for a_b^c
6042 ;; (goto-char (1- pos)) ;????????????????????
6044 t
6046 'display
6062 t)))))
6064 ;;;; Visibility cycling, including org-goto and indirect buffer
6066 ;;; Cycling
6073 ;;;###autoload
6078 "TAB-action and visibility cycling for Org-mode.
6080 This is the command invoked in Org-mode by the TAB key. Its main purpose
6081 is outline visibility cycling, but it also invokes other actions
6082 in special contexts.
6084 - When this function is called with a prefix argument, rotate the entire
6085 buffer through 3 states (global cycling)
6086 1. OVERVIEW: Show only top-level headlines.
6087 2. CONTENTS: Show all headlines of all levels, but no body text.
6088 3. SHOW ALL: Show everything.
6089 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6090 determined by the variable `org-startup-folded', and by any VISIBILITY
6091 properties in the buffer.
6092 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6093 including any drawers.
6095 - When inside a table, re-align the table and move to the next field.
6097 - When point is at the beginning of a headline, rotate the subtree started
6098 by this line through 3 different states (local cycling)
6099 1. FOLDED: Only the main headline is shown.
6100 2. CHILDREN: The main headline and the direct children are shown.
6101 From this state, you can move to one of the children
6102 and zoom in further.
6103 3. SUBTREE: Show the entire subtree, including body text.
6104 If there is no subtree, switch directly from CHILDREN to FOLDED.
6106 - When point is at the beginning of an empty headline and the variable
6107 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6108 of the headline by demoting and promoting it to likely levels. This
6109 speeds up creation document structure by pressing TAB once or several
6110 times right after creating a new headline.
6112 - When there is a numeric prefix, go up to a heading with level ARG, do
6113 a `show-subtree' and return to the previous cursor position. If ARG
6114 is negative, go up that many levels.
6116 - When point is not at the beginning of a headline, execute the global
6117 binding for TAB, which is re-indenting the line. See the option
6118 `org-cycle-emulate-tab' for details.
6120 - Special case: if point is at the beginning of the buffer and there is
6121 no headline in line 1, this function will act as if called with prefix arg
6122 (C-u TAB, same as S-TAB) also when called without prefix arg.
6123 But only if also the variable `org-cycle-global-at-bob' is t."
6133 org-inlinetask-min-level
6138 limit-level)))
6141 outline-regexp
6149 org-cycle-hook))
6153 ;; special case: use global cycling
6167 ;; Table: enter it or move to the next field.
6178 ;; Global cycling: delegate to `org-cycle-internal-global'.
6181 ;; Drawers: delegate to `org-flag-drawer'.
6189 ;; Show-subtree, ARG levels up from here.
6197 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6205 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6212 ;; From there: TAB emulation and template completion.
6234 t
6243 "Do the global cycling action."
6244 ;; Hack to avoid display of messages for .org attachments in Gnus
6249 ;; We just created the overview - now do table of contents
6250 ;; This can be slow in very large buffers, so indicate action
6260 ;; We just showed the table of contents - now show everything
6268 ;; Default action: go to overview
6276 "Do the local cycling action."
6278 ;; First, determine end of headline (EOH), end of subtree or item
6279 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6303 ;; Determine end invisible part of buffer (EOL)
6305 ;; XEmacs doesn't have `next-single-char-property-change'
6315 ;; Find out what to do next and set `this-command'
6318 ;; Nothing is hidden behind this heading
6330 org-cycle-skip-children-state-if-no-children))))
6331 ;; Entire subtree is hidden in one line: children view
6339 ;; Fold every list in subtree to top-level items.
6361 ;; We just showed the children, or no children are there,
6362 ;; now show everything.
6369 ;; Default action: hide the subtree.
6376 ;;;###autoload
6378 "Cycle the global visibility. For details see `org-cycle'.
6380 With a numeric prefix, show all headlines up to that level."
6396 "Set the visibility required by startup options and properties."
6411 "Switch subtree visibilities according to :VISIBILITY: property."
6418 nil t)
6442 ;; This function uses outline-regexp instead of the more fundamental
6443 ;; org-outline-regexp so that org-cycle-global works outside of Org
6444 ;; buffers, where outline-regexp is needed.
6446 "Switch to overview mode, showing only top-level headlines.
6447 Really, this shows all headlines with level equal or greater than the level
6448 of the first headline in the buffer. This is important, because if the
6449 first headline is not level one, then (hide-sublevels 1) gives confusing
6450 results."
6461 "Show all headlines in the buffer, like a table of contents.
6462 With numerical argument N, show content up to level N."
6465 ;; Visit all headings and show their offspring
6472 t)
6481 "Adjust the window after a change in outline visibility.
6482 This function is the default value of the hook `org-cycle-hook'."
6492 "Remove outline overlays that do not contain non-white stuff."
6502 "Fix visibility issues after moving a subtree."
6503 ;; First, find a reasonable region to look at:
6504 ;; Start two siblings above, end three below
6522 ;; Properly fold already folded siblings
6533 "Show empty lines above all visible headlines.
6534 The region to be covered depends on STATE when called through
6535 `org-cycle-hook'. Lisp program can use t for STATE to get the
6536 entire buffer covered. Note that an empty line is only shown if there
6537 are at least `org-cycle-separator-lines' empty lines before the headline."
6547 beg end b e)
6571 ;; Never hide empty lines at the end of the file.
6581 "Move to the parent and re-show empty lines before visible headlines."
6587 "Return `org-agenda-files' list, plus all open org-mode files.
6588 This is useful for operations that need to scan all of a user's
6589 open and agenda-wise Org files."
6597 files))
6600 "Return the beginning position of the current entry."
6604 "Return the end position of the current entry."
6608 "Re-hide all drawers after a visibility state change."
6634 "Is the end of the current subtree visible?"
6639 "Move cursor to the first headline and recenter the headline.
6640 Optional argument N means put the headline into the Nth line of the window."
6646 ;;; Saving and restoring visibility
6649 "Return a list of the locations of all outline overlays.
6650 These are overlays with the `invisible' property value `outline'.
6651 The return value is a list of cons cells, with start and stop
6652 positions for each overlay.
6653 If USE-MARKERS is set, return the positions as markers."
6671 "Create visibility overlays for all positions in DATA.
6672 DATA should have been made by `org-outline-overlay-data'."
6680 data)))))
6682 ;;; Folding of blocks
6689 "Call FUNCTION at the head of all source blocks in the current buffer.
6690 Optional arguments START and END can be used to limit the range."
6702 "Toggle the visibility of all blocks in the current buffer."
6706 "Fold all blocks in the current buffer."
6712 "Unfold all blocks in the current buffer."
6718 "Toggle visibility of block at point."
6729 "Toggle the visibility of the current block."
6736 ov)
6752 ;; make the block accessible to isearch
6754 ov 'isearch-open-invisible
6765 ;; org-tab-after-check-for-cycling-hook
6767 ;; Remove overlays when changing major mode
6772 ;;; Org-goto
6778 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6794 nil)
6795 (org-defkey map "q" 'org-goto-quit)
6796 (org-defkey map "n" 'outline-next-visible-heading)
6797 (org-defkey map "p" 'outline-previous-visible-heading)
6798 (org-defkey map "f" 'outline-forward-same-level)
6799 (org-defkey map "b" 'outline-backward-same-level)
6800 (org-defkey map "u" 'outline-up-heading))
6801 (org-defkey map "/" 'org-occur)
6802 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6803 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6804 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6805 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6806 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6807 map))
6809 (defconst org-goto-help
6810 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6811 RET=jump to location [Q]uit and return to previous location
6812 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6814 (defvar org-goto-start-pos) ; dynamically scoped parameter
6816 ;; FIXME: Docstring does not mention both interfaces
6817 (defun org-goto (&optional alternative-interface)
6818 "Look up a different location in the current file, keeping current visibility.
6820 When you want look-up or go to a different location in a document, the
6821 fastest way is often to fold the entire buffer and then dive into the tree.
6822 This method has the disadvantage, that the previous location will be folded,
6823 which may not be what you want.
6825 This command works around this by showing a copy of the current buffer
6826 in an indirect buffer, in overview mode. You can dive into the tree in
6827 that copy, use org-occur and incremental search to find a location.
6828 When pressing RET or `Q', the command returns to the original buffer in
6829 which the visibility is still unchanged. After RET is will also jump to
6830 the location selected in the indirect buffer and expose the headline
6831 hierarchy above."
6832 (interactive "P")
6833 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6834 (org-refile-use-outline-path t)
6835 (org-refile-target-verify-function nil)
6836 (interface
6837 (if (not alternative-interface)
6838 org-goto-interface
6839 (if (eq org-goto-interface 'outline)
6840 'outline-path-completion
6841 'outline)))
6842 (org-goto-start-pos (point))
6843 (selected-point
6844 (if (eq interface 'outline)
6845 (car (org-get-location (current-buffer) org-goto-help))
6846 (let ((pa (org-refile-get-location "Goto")))
6847 (org-refile-check-position pa)
6848 (nth 3 pa)))))
6849 (if selected-point
6850 (progn
6851 (org-mark-ring-push org-goto-start-pos)
6852 (goto-char selected-point)
6853 (if (or (outline-invisible-p) (org-invisible-p2))
6854 (org-show-context 'org-goto)))
6855 (message "Quit"))))
6857 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6858 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6859 (defvar org-goto-local-auto-isearch-map) ; defined below
6861 (defun org-get-location (buf help)
6862 "Let the user select a location in the Org-mode buffer BUF.
6863 This function uses a recursive edit. It returns the selected position
6864 or nil."
6865 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6866 (isearch-hide-immediately nil)
6867 (isearch-search-fun-function
6868 (lambda () 'org-goto-local-search-headings))
6869 (org-goto-selected-point org-goto-exit-command)
6870 (pop-up-frames nil)
6871 (special-display-buffer-names nil)
6872 (special-display-regexps nil)
6873 (special-display-function nil))
6874 (save-excursion
6875 (save-window-excursion
6876 (delete-other-windows)
6877 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6878 (org-pop-to-buffer-same-window
6879 (condition-case nil
6880 (make-indirect-buffer (current-buffer) "*org-goto*")
6881 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6882 (with-output-to-temp-buffer "*Help*"
6883 (princ help))
6884 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6885 (setq buffer-read-only nil)
6886 (let ((org-startup-truncated t)
6887 (org-startup-folded nil)
6888 (org-startup-align-all-tables nil))
6889 (org-mode)
6890 (org-overview))
6891 (setq buffer-read-only t)
6892 (if (and (boundp 'org-goto-start-pos)
6893 (integer-or-marker-p org-goto-start-pos))
6894 (let ((org-show-hierarchy-above t)
6895 (org-show-siblings t)
6896 (org-show-following-heading t))
6897 (goto-char org-goto-start-pos)
6898 (and (outline-invisible-p) (org-show-context)))
6899 (goto-char (point-min)))
6900 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6901 (message "Select location and press RET")
6902 (use-local-map org-goto-map)
6903 (recursive-edit)
6904 ))
6905 (kill-buffer "*org-goto*")
6906 (cons org-goto-selected-point org-goto-exit-command)))
6908 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6909 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6910 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6911 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6913 (defun org-goto-local-search-headings (string bound noerror)
6914 "Search and make sure that any matches are in headlines."
6915 (catch 'return
6916 (while (if isearch-forward
6917 (search-forward string bound noerror)
6918 (search-backward string bound noerror))
6919 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6920 (and (member :headline context)
6921 (not (member :tags context))))
6922 (throw 'return (point))))))
6924 (defun org-goto-local-auto-isearch ()
6925 "Start isearch."
6926 (interactive)
6927 (goto-char (point-min))
6928 (let ((keys (this-command-keys)))
6929 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6930 (isearch-mode t)
6931 (isearch-process-search-char (string-to-char keys)))))
6933 (defun org-goto-ret (&optional arg)
6934 "Finish `org-goto' by going to the new location."
6935 (interactive "P")
6936 (setq org-goto-selected-point (point)
6937 org-goto-exit-command 'return)
6938 (throw 'exit nil))
6940 (defun org-goto-left ()
6941 "Finish `org-goto' by going to the new location."
6942 (interactive)
6943 (if (org-at-heading-p)
6944 (progn
6945 (beginning-of-line 1)
6946 (setq org-goto-selected-point (point)
6947 org-goto-exit-command 'left)
6948 (throw 'exit nil))
6949 (error "Not on a heading")))
6951 (defun org-goto-right ()
6952 "Finish `org-goto' by going to the new location."
6953 (interactive)
6954 (if (org-at-heading-p)
6955 (progn
6956 (setq org-goto-selected-point (point)
6957 org-goto-exit-command 'right)
6958 (throw 'exit nil))
6959 (error "Not on a heading")))
6961 (defun org-goto-quit ()
6962 "Finish `org-goto' without cursor motion."
6963 (interactive)
6964 (setq org-goto-selected-point nil)
6965 (setq org-goto-exit-command 'quit)
6966 (throw 'exit nil))
6968 ;;; Indirect buffer display of subtrees
6970 (defvar org-indirect-dedicated-frame nil
6971 "This is the frame being used for indirect tree display.")
6972 (defvar org-last-indirect-buffer nil)
6974 (defun org-tree-to-indirect-buffer (&optional arg)
6975 "Create indirect buffer and narrow it to current subtree.
6976 With numerical prefix ARG, go up to this level and then take that tree.
6977 If ARG is negative, go up that many levels.
6978 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6979 indirect buffer previously made with this command, to avoid proliferation of
6980 indirect buffers. However, when you call the command with a \
6982 when `org-indirect-buffer-display' is `new-frame', the last buffer
6983 is kept so that you can work with several indirect buffers at the same time.
6984 If `org-indirect-buffer-display' is `dedicated-frame', the \
6986 requests that a new frame be made for the new buffer, so that the dedicated
6987 frame is not changed."
6988 (interactive "P")
6989 (let ((cbuf (current-buffer))
6990 (cwin (selected-window))
6991 (pos (point))
6992 beg end level heading ibuf)
6993 (save-excursion
6994 (org-back-to-heading t)
6995 (when (numberp arg)
6996 (setq level (org-outline-level))
6997 (if (< arg 0) (setq arg (+ level arg)))
6998 (while (> (setq level (org-outline-level)) arg)
6999 (outline-up-heading 1 t)))
7000 (setq beg (point)
7001 heading (org-get-heading))
7002 (org-end-of-subtree t t)
7003 (if (org-at-heading-p) (backward-char 1))
7004 (setq end (point)))
7005 (if (and (buffer-live-p org-last-indirect-buffer)
7006 (not (eq org-indirect-buffer-display 'new-frame))
7007 (not arg))
7008 (kill-buffer org-last-indirect-buffer))
7009 (setq ibuf (org-get-indirect-buffer cbuf)
7010 org-last-indirect-buffer ibuf)
7011 (cond
7012 ((or (eq org-indirect-buffer-display 'new-frame)
7013 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7014 (select-frame (make-frame))
7015 (delete-other-windows)
7016 (org-pop-to-buffer-same-window ibuf)
7017 (org-set-frame-title heading))
7018 ((eq org-indirect-buffer-display 'dedicated-frame)
7019 (raise-frame
7020 (select-frame (or (and org-indirect-dedicated-frame
7021 (frame-live-p org-indirect-dedicated-frame)
7022 org-indirect-dedicated-frame)
7023 (setq org-indirect-dedicated-frame (make-frame)))))
7024 (delete-other-windows)
7025 (org-pop-to-buffer-same-window ibuf)
7026 (org-set-frame-title (concat "Indirect: " heading)))
7027 ((eq org-indirect-buffer-display 'current-window)
7028 (org-pop-to-buffer-same-window ibuf))
7029 ((eq org-indirect-buffer-display 'other-window)
7030 (pop-to-buffer ibuf))
7031 (t (error "Invalid value")))
7032 (if (featurep 'xemacs)
7033 (save-excursion (org-mode) (turn-on-font-lock)))
7034 (narrow-to-region beg end)
7035 (show-all)
7036 (goto-char pos)
7037 (run-hook-with-args 'org-cycle-hook 'all)
7038 (and (window-live-p cwin) (select-window cwin))))
7040 (defun org-get-indirect-buffer (&optional buffer)
7041 (setq buffer (or buffer (current-buffer)))
7042 (let ((n 1) (base (buffer-name buffer)) bname)
7043 (while (buffer-live-p
7044 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7045 (setq n (1+ n)))
7046 (condition-case nil
7047 (make-indirect-buffer buffer bname 'clone)
7048 (error (make-indirect-buffer buffer bname)))))
7050 (defun org-set-frame-title (title)
7051 "Set the title of the current frame to the string TITLE."
7052 ;; FIXME: how to name a single frame in XEmacs???
7053 (unless (featurep 'xemacs)
7054 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7056 ;;;; Structure editing
7058 ;;; Inserting headlines
7060 (defun org-previous-line-empty-p ()
7061 (save-excursion
7062 (and (not (bobp))
7063 (or (beginning-of-line 0) t)
7064 (save-match-data
7067 (defun org-insert-heading (&optional force-heading invisible-ok)
7068 "Insert a new heading or item with same depth at point.
7069 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7070 If point is at the beginning of a headline, insert a sibling before the
7071 current headline. If point is not at the beginning, split the line,
7072 create the new headline with the text in the current line after point
7073 \(but see also the variable `org-M-RET-may-split-line').
7075 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7076 This is important for non-interactive uses of the command."
7077 (interactive "P")
7078 (if (or (= (buffer-size) 0)
7079 (and (not (save-excursion
7080 (and (ignore-errors (org-back-to-heading invisible-ok))
7081 (org-at-heading-p))))
7082 (or force-heading (not (org-in-item-p)))))
7083 (progn
7085 (run-hooks 'org-insert-heading-hook))
7086 (when (or force-heading (not (org-insert-item)))
7087 (let* ((empty-line-p nil)
7088 (level nil)
7089 (on-heading (org-at-heading-p))
7090 (head (save-excursion
7091 (condition-case nil
7092 (progn
7093 (org-back-to-heading invisible-ok)
7094 (when (and (not on-heading)
7095 (featurep 'org-inlinetask)
7096 (integerp org-inlinetask-min-level)
7097 (>= (length (match-string 0))
7098 org-inlinetask-min-level))
7099 ;; Find a heading level before the inline task
7100 (while (and (setq level (org-up-heading-safe))
7101 (>= level org-inlinetask-min-level)))
7102 (if (org-at-heading-p)
7103 (org-back-to-heading invisible-ok)
7104 (error "This should not happen")))
7105 (setq empty-line-p (org-previous-line-empty-p))
7106 (match-string 0))
7107 (error "*"))))
7108 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7109 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7110 pos hide-previous previous-pos)
7111 (cond
7112 ((and (org-at-heading-p) (bolp)
7113 (or (bobp)
7114 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7115 ;; insert before the current line
7116 (open-line (if blank 2 1)))
7117 ((and (bolp)
7118 (not org-insert-heading-respect-content)
7119 (or (bobp)
7120 (save-excursion
7121 (backward-char 1) (not (outline-invisible-p)))))
7122 ;; insert right here
7123 nil)
7124 (t
7125 ;; somewhere in the line
7126 (save-excursion
7127 (setq previous-pos (point-at-bol))
7128 (end-of-line)
7129 (setq hide-previous (outline-invisible-p)))
7130 (and org-insert-heading-respect-content (org-show-subtree))
7131 (let ((split
7132 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7133 (save-excursion
7134 (let ((p (point)))
7135 (goto-char (point-at-bol))
7136 (and (looking-at org-complex-heading-regexp)
7137 (match-beginning 4)
7138 (> p (match-beginning 4)))))))
7139 tags pos)
7140 (cond
7141 (org-insert-heading-respect-content
7142 (org-end-of-subtree nil t)
7143 (when (featurep 'org-inlinetask)
7144 (while (and (not (eobp))
7146 (>= (length (match-string 1))
7147 org-inlinetask-min-level))
7148 (org-end-of-subtree nil t)))
7149 (or (bolp) (newline))
7150 (or (org-previous-line-empty-p)
7151 (and blank (newline)))
7152 (open-line 1))
7153 ((org-at-heading-p)
7154 (when hide-previous
7155 (show-children)
7156 (org-show-entry))
7158 (setq tags (and (match-end 2) (match-string 2)))
7159 (and (match-end 1)
7160 (delete-region (match-beginning 1) (match-end 1)))
7161 (setq pos (point-at-bol))
7162 (or split (end-of-line 1))
7163 (delete-horizontal-space)
7165 (buffer-substring (point-at-bol) (point)))
7166 (insert " "))
7167 (newline (if blank 2 1))
7168 (when tags
7169 (save-excursion
7170 (goto-char pos)
7171 (end-of-line 1)
7172 (insert " " tags)
7173 (org-set-tags nil 'align))))
7174 (t
7175 (or split (end-of-line 1))
7176 (newline (if blank 2 1)))))))
7177 (insert head) (just-one-space)
7178 (setq pos (point))
7179 (end-of-line 1)
7180 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7181 (when (and org-insert-heading-respect-content hide-previous)
7182 (save-excursion
7183 (goto-char previous-pos)
7184 (hide-subtree)))
7185 (run-hooks 'org-insert-heading-hook)))))
7187 (defun org-get-heading (&optional no-tags no-todo)
7188 "Return the heading of the current entry, without the stars.
7189 When NO-TAGS is non-nil, don't include tags.
7190 When NO-TODO is non-nil, don't include TODO keywords."
7191 (save-excursion
7192 (org-back-to-heading t)
7193 (cond
7194 ((and no-tags no-todo)
7195 (looking-at org-complex-heading-regexp)
7196 (match-string 4))
7197 (no-tags
7198 (looking-at (concat org-outline-regexp
7201 (match-string 1))
7202 (no-todo
7203 (looking-at org-todo-line-regexp)
7204 (match-string 3))
7205 (t (looking-at org-heading-regexp)
7206 (match-string 2)))))
7208 (defun org-heading-components ()
7209 "Return the components of the current heading.
7210 This is a list with the following elements:
7211 - the level as an integer
7212 - the reduced level, different if `org-odd-levels-only' is set.
7213 - the TODO keyword, or nil
7214 - the priority character, like ?A, or nil if no priority is given
7215 - the headline text itself, or the tags string if no headline text
7216 - the tags string, or nil."
7217 (save-excursion
7218 (org-back-to-heading t)
7219 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7220 (list (length (match-string 1))
7221 (org-reduced-level (length (match-string 1)))
7222 (org-match-string-no-properties 2)
7223 (and (match-end 3) (aref (match-string 3) 2))
7224 (org-match-string-no-properties 4)
7225 (org-match-string-no-properties 5)))))
7227 (defun org-get-entry ()
7228 "Get the entry text, after heading, entire subtree."
7229 (save-excursion
7230 (org-back-to-heading t)
7231 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7233 (defun org-insert-heading-after-current ()
7234 "Insert a new heading with same level as current, after current subtree."
7235 (interactive)
7236 (org-back-to-heading)
7237 (org-insert-heading)
7238 (org-move-subtree-down)
7239 (end-of-line 1))
7241 (defun org-insert-heading-respect-content ()
7242 (interactive)
7243 (let ((org-insert-heading-respect-content t))
7244 (org-insert-heading t)))
7246 (defun org-insert-todo-heading-respect-content (&optional force-state)
7247 (interactive "P")
7248 (let ((org-insert-heading-respect-content t))
7249 (org-insert-todo-heading force-state t)))
7251 (defun org-insert-todo-heading (arg &optional force-heading)
7252 "Insert a new heading with the same level and TODO state as current heading.
7253 If the heading has no TODO state, or if the state is DONE, use the first
7254 state (TODO by default). Also with prefix arg, force first state."
7255 (interactive "P")
7256 (when (or force-heading (not (org-insert-item 'checkbox)))
7257 (org-insert-heading force-heading)
7258 (save-excursion
7259 (org-back-to-heading)
7260 (outline-previous-heading)
7261 (looking-at org-todo-line-regexp))
7262 (let*
7263 ((new-mark-x
7264 (if (or arg
7265 (not (match-beginning 2))
7266 (member (match-string 2) org-done-keywords))
7267 (car org-todo-keywords-1)
7268 (match-string 2)))
7269 (new-mark
7270 (or
7271 (run-hook-with-args-until-success
7272 'org-todo-get-default-hook new-mark-x nil)
7273 new-mark-x)))
7274 (beginning-of-line 1)
7275 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7276 (if org-treat-insert-todo-heading-as-state-change
7277 (org-todo new-mark)
7278 (insert new-mark " "))))
7279 (when org-provide-todo-statistics
7280 (org-update-parent-todo-statistics))))
7282 (defun org-insert-subheading (arg)
7283 "Insert a new subheading and demote it.
7284 Works for outline headings and for plain lists alike."
7285 (interactive "P")
7286 (org-insert-heading arg)
7287 (cond
7288 ((org-at-heading-p) (org-do-demote))
7289 ((org-at-item-p) (org-indent-item))))
7291 (defun org-insert-todo-subheading (arg)
7292 "Insert a new subheading with TODO keyword or checkbox and demote it.
7293 Works for outline headings and for plain lists alike."
7294 (interactive "P")
7295 (org-insert-todo-heading arg)
7296 (cond
7297 ((org-at-heading-p) (org-do-demote))
7298 ((org-at-item-p) (org-indent-item))))
7300 ;;; Promotion and Demotion
7302 (defvar org-after-demote-entry-hook nil
7303 "Hook run after an entry has been demoted.
7304 The cursor will be at the beginning of the entry.
7305 When a subtree is being demoted, the hook will be called for each node.")
7307 (defvar org-after-promote-entry-hook nil
7308 "Hook run after an entry has been promoted.
7309 The cursor will be at the beginning of the entry.
7310 When a subtree is being promoted, the hook will be called for each node.")
7312 (defun org-promote-subtree ()
7313 "Promote the entire subtree.
7314 See also `org-promote'."
7315 (interactive)
7316 (save-excursion
7317 (org-with-limited-levels (org-map-tree 'org-promote)))
7318 (org-fix-position-after-promote))
7320 (defun org-demote-subtree ()
7321 "Demote the entire subtree. See `org-demote'.
7322 See also `org-promote'."
7323 (interactive)
7324 (save-excursion
7325 (org-with-limited-levels (org-map-tree 'org-demote)))
7326 (org-fix-position-after-promote))
7329 (defun org-do-promote ()
7330 "Promote the current heading higher up the tree.
7331 If the region is active in `transient-mark-mode', promote all headings
7332 in the region."
7333 (interactive)
7334 (save-excursion
7335 (if (org-region-active-p)
7336 (org-map-region 'org-promote (region-beginning) (region-end))
7337 (org-promote)))
7338 (org-fix-position-after-promote))
7340 (defun org-do-demote ()
7341 "Demote the current heading lower down the tree.
7342 If the region is active in `transient-mark-mode', demote all headings
7343 in the region."
7344 (interactive)
7345 (save-excursion
7346 (if (org-region-active-p)
7347 (org-map-region 'org-demote (region-beginning) (region-end))
7348 (org-demote)))
7349 (org-fix-position-after-promote))
7351 (defun org-fix-position-after-promote ()
7352 "Make sure that after pro/demotion cursor position is right."
7353 (let ((pos (point)))
7354 (when (save-excursion
7355 (beginning-of-line 1)
7356 (looking-at org-todo-line-regexp)
7357 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7358 (cond ((eobp) (insert " "))
7359 ((eolp) (insert " "))
7360 ((equal (char-after) ?\ ) (forward-char 1))))))
7362 (defun org-current-level ()
7363 "Return the level of the current entry, or nil if before the first headline.
7364 The level is the number of stars at the beginning of the headline."
7365 (save-excursion
7366 (org-with-limited-levels
7367 (if (ignore-errors (org-back-to-heading t))
7368 (funcall outline-level)))))
7370 (defun org-get-previous-line-level ()
7371 "Return the outline depth of the last headline before the current line.
7372 Returns 0 for the first headline in the buffer, and nil if before the
7373 first headline."
7374 (let ((current-level (org-current-level))
7375 (prev-level (when (> (line-number-at-pos) 1)
7376 (save-excursion
7377 (beginning-of-line 0)
7378 (org-current-level)))))
7379 (cond ((null current-level) nil) ; Before first headline
7380 ((null prev-level) 0) ; At first headline
7381 (prev-level))))
7383 (defun org-reduced-level (l)
7384 "Compute the effective level of a heading.
7385 This takes into account the setting of `org-odd-levels-only'."
7386 (cond
7387 ((zerop l) 0)
7388 (org-odd-levels-only (1+ (floor (/ l 2))))
7389 (t l)))
7391 (defun org-level-increment ()
7392 "Return the number of stars that will be added or removed at a
7393 time to headlines when structure editing, based on the value of
7394 `org-odd-levels-only'."
7395 (if org-odd-levels-only 2 1))
7397 (defun org-get-valid-level (level &optional change)
7398 "Rectify a level change under the influence of `org-odd-levels-only'
7399 LEVEL is a current level, CHANGE is by how much the level should be
7400 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7401 even level numbers will become the next higher odd number."
7402 (if org-odd-levels-only
7403 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7404 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7405 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7406 (max 1 (+ level (or change 0)))))
7408 (if (boundp 'define-obsolete-function-alias)
7409 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7410 (define-obsolete-function-alias 'org-get-legal-level
7411 'org-get-valid-level)
7412 (define-obsolete-function-alias 'org-get-legal-level
7413 'org-get-valid-level "23.1")))
7415 (defun org-promote ()
7416 "Promote the current heading higher up the tree.
7417 If the region is active in `transient-mark-mode', promote all headings
7418 in the region."
7419 (org-back-to-heading t)
7420 (let* ((level (save-match-data (funcall outline-level)))
7421 (after-change-functions (remove 'flyspell-after-change-function
7422 after-change-functions))
7423 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7424 (diff (abs (- level (length up-head) -1))))
7425 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7426 (replace-match up-head nil t)
7427 ;; Fixup tag positioning
7428 (and org-auto-align-tags (org-set-tags nil t))
7429 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7430 (run-hooks 'org-after-promote-entry-hook)))
7432 (defun org-demote ()
7433 "Demote the current heading lower down the tree.
7434 If the region is active in `transient-mark-mode', demote all headings
7435 in the region."
7436 (org-back-to-heading t)
7437 (let* ((level (save-match-data (funcall outline-level)))
7438 (after-change-functions (remove 'flyspell-after-change-function
7439 after-change-functions))
7440 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7441 (diff (abs (- level (length down-head) -1))))
7442 (replace-match down-head nil t)
7443 ;; Fixup tag positioning
7444 (and org-auto-align-tags (org-set-tags nil t))
7445 (if org-adapt-indentation (org-fixup-indentation diff))
7446 (run-hooks 'org-after-demote-entry-hook)))
7448 (defun org-cycle-level ()
7449 "Cycle the level of an empty headline through possible states.
7450 This goes first to child, then to parent, level, then up the hierarchy.
7451 After top level, it switches back to sibling level."
7452 (interactive)
7453 (let ((org-adapt-indentation nil))
7454 (when (org-point-at-end-of-empty-headline)
7455 (setq this-command 'org-cycle-level) ; Only needed for caching
7456 (let ((cur-level (org-current-level))
7457 (prev-level (org-get-previous-line-level)))
7458 (cond
7459 ;; If first headline in file, promote to top-level.
7460 ((= prev-level 0)
7461 (loop repeat (/ (- cur-level 1) (org-level-increment))
7462 do (org-do-promote)))
7463 ;; If same level as prev, demote one.
7464 ((= prev-level cur-level)
7465 (org-do-demote))
7466 ;; If parent is top-level, promote to top level if not already.
7467 ((= prev-level 1)
7468 (loop repeat (/ (- cur-level 1) (org-level-increment))
7469 do (org-do-promote)))
7470 ;; If top-level, return to prev-level.
7471 ((= cur-level 1)
7472 (loop repeat (/ (- prev-level 1) (org-level-increment))
7473 do (org-do-demote)))
7474 ;; If less than prev-level, promote one.
7475 ((< cur-level prev-level)
7476 (org-do-promote))
7477 ;; If deeper than prev-level, promote until higher than
7478 ;; prev-level.
7479 ((> cur-level prev-level)
7480 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7481 do (org-do-promote))))
7482 t))))
7484 (defun org-map-tree (fun)
7485 "Call FUN for every heading underneath the current one."
7486 (org-back-to-heading)
7487 (let ((level (funcall outline-level)))
7488 (save-excursion
7489 (funcall fun)
7490 (while (and (progn
7491 (outline-next-heading)
7492 (> (funcall outline-level) level))
7493 (not (eobp)))
7494 (funcall fun)))))
7496 (defun org-map-region (fun beg end)
7497 "Call FUN for every heading between BEG and END."
7498 (let ((org-ignore-region t))
7499 (save-excursion
7500 (setq end (copy-marker end))
7501 (goto-char beg)
7502 (if (and (re-search-forward org-outline-regexp-bol nil t)
7503 (< (point) end))
7504 (funcall fun))
7505 (while (and (progn
7506 (outline-next-heading)
7507 (< (point) end))
7508 (not (eobp)))
7509 (funcall fun)))))
7511 (defvar org-property-end-re) ; silence byte-compiler
7512 (defun org-fixup-indentation (diff)
7513 "Change the indentation in the current entry by DIFF.
7514 However, if any line in the current entry has no indentation, or if it
7515 would end up with no indentation after the change, nothing at all is done."
7516 (save-excursion
7517 (let ((end (save-excursion (outline-next-heading)
7518 (point-marker)))
7519 (prohibit (if (> diff 0)
7522 col)
7523 (unless (save-excursion (end-of-line 1)
7524 (re-search-forward prohibit end t))
7525 (while (and (< (point) end)
7527 (goto-char (match-end 0))
7528 (setq col (current-column))
7529 (if (< diff 0) (replace-match ""))
7530 (org-indent-to-column (+ diff col))))
7531 (move-marker end nil))))
7533 (defun org-convert-to-odd-levels ()
7534 "Convert an org-mode file with all levels allowed to one with odd levels.
7535 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7536 level 5 etc."
7537 (interactive)
7538 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7539 (let ((outline-level 'org-outline-level)
7540 (org-odd-levels-only nil) n)
7541 (save-excursion
7542 (goto-char (point-min))
7544 (setq n (- (length (match-string 0)) 2))
7545 (while (>= (setq n (1- n)) 0)
7546 (org-demote))
7547 (end-of-line 1))))))
7549 (defun org-convert-to-oddeven-levels ()
7550 "Convert an org-mode file with only odd levels to one with odd/even levels.
7551 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7552 file contains a section with an even level, conversion would
7553 destroy the structure of the file. An error is signaled in this
7554 case."
7555 (interactive)
7556 (goto-char (point-min))
7557 ;; First check if there are no even levels
7559 (org-show-context t)
7560 (error "Not all levels are odd in this file. Conversion not possible"))
7561 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7562 (let ((outline-regexp org-outline-regexp)
7563 (outline-level 'org-outline-level)
7564 (org-odd-levels-only nil) n)
7565 (save-excursion
7566 (goto-char (point-min))
7568 (setq n (/ (1- (length (match-string 0))) 2))
7569 (while (>= (setq n (1- n)) 0)
7570 (org-promote))
7571 (end-of-line 1))))))
7573 (defun org-tr-level (n)
7574 "Make N odd if required."
7575 (if org-odd-levels-only (1+ (/ n 2)) n))
7577 ;;; Vertical tree motion, cutting and pasting of subtrees
7579 (defun org-move-subtree-up (&optional arg)
7580 "Move the current subtree up past ARG headlines of the same level."
7581 (interactive "p")
7582 (org-move-subtree-down (- (prefix-numeric-value arg))))
7584 (defun org-move-subtree-down (&optional arg)
7585 "Move the current subtree down past ARG headlines of the same level."
7586 (interactive "p")
7587 (setq arg (prefix-numeric-value arg))
7588 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7589 'org-get-last-sibling))
7590 (ins-point (make-marker))
7591 (cnt (abs arg))
7592 (col (current-column))
7593 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7594 ;; Select the tree
7595 (org-back-to-heading)
7596 (setq beg0 (point))
7597 (save-excursion
7598 (setq ne-beg (org-back-over-empty-lines))
7599 (setq beg (point)))
7600 (save-match-data
7601 (save-excursion (outline-end-of-heading)
7602 (setq folded (outline-invisible-p)))
7603 (outline-end-of-subtree))
7604 (outline-next-heading)
7605 (setq ne-end (org-back-over-empty-lines))
7606 (setq end (point))
7607 (goto-char beg0)
7608 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7609 ;; include less whitespace
7610 (save-excursion
7611 (goto-char beg)
7612 (forward-line (- ne-beg ne-end))
7613 (setq beg (point))))
7614 ;; Find insertion point, with error handling
7615 (while (> cnt 0)
7616 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7617 (progn (goto-char beg0)
7618 (error "Cannot move past superior level or buffer limit")))
7619 (setq cnt (1- cnt)))
7620 (if (> arg 0)
7621 ;; Moving forward - still need to move over subtree
7622 (progn (org-end-of-subtree t t)
7623 (save-excursion
7624 (org-back-over-empty-lines)
7625 (or (bolp) (newline)))))
7626 (setq ne-ins (org-back-over-empty-lines))
7627 (move-marker ins-point (point))
7628 (setq txt (buffer-substring beg end))
7629 (org-save-markers-in-region beg end)
7630 (delete-region beg end)
7631 (org-remove-empty-overlays-at beg)
7632 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7633 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7635 (let ((bbb (point)))
7636 (insert-before-markers txt)
7637 (org-reinstall-markers-in-region bbb)
7638 (move-marker ins-point bbb))
7640 (setq ins-end (point))
7641 (goto-char ins-point)
7642 (org-skip-whitespace)
7643 (when (and (< arg 0)
7644 (org-first-sibling-p)
7645 (> ne-ins ne-beg))
7646 ;; Move whitespace back to beginning
7647 (save-excursion
7648 (goto-char ins-end)
7649 (let ((kill-whole-line t))
7650 (kill-line (- ne-ins ne-beg)) (point)))
7652 (move-marker ins-point nil)
7653 (if folded
7654 (hide-subtree)
7655 (org-show-entry)
7656 (show-children)
7657 (org-cycle-hide-drawers 'children))
7658 (org-clean-visibility-after-subtree-move)
7659 ;; move back to the initial column we were at
7660 (move-to-column col)))
7662 (defvar org-subtree-clip ""
7663 "Clipboard for cut and paste of subtrees.
7664 This is actually only a copy of the kill, because we use the normal kill
7665 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7667 (defvar org-subtree-clip-folded nil
7668 "Was the last copied subtree folded?
7669 This is used to fold the tree back after pasting.")
7671 (defun org-cut-subtree (&optional n)
7672 "Cut the current subtree into the clipboard.
7673 With prefix arg N, cut this many sequential subtrees.
7674 This is a short-hand for marking the subtree and then cutting it."
7675 (interactive "p")
7676 (org-copy-subtree n 'cut))
7678 (defun org-copy-subtree (&optional n cut force-store-markers)
7679 "Cut the current subtree into the clipboard.
7680 With prefix arg N, cut this many sequential subtrees.
7681 This is a short-hand for marking the subtree and then copying it.
7682 If CUT is non-nil, actually cut the subtree.
7683 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7684 of some markers in the region, even if CUT is non-nil. This is
7685 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7686 (interactive "p")
7687 (let (beg end folded (beg0 (point)))
7688 (if (org-called-interactively-p 'any)
7689 (org-back-to-heading nil) ; take what looks like a subtree
7690 (org-back-to-heading t)) ; take what is really there
7691 (org-back-over-empty-lines)
7692 (setq beg (point))
7694 (save-match-data
7695 (save-excursion (outline-end-of-heading)
7696 (setq folded (outline-invisible-p)))
7697 (condition-case nil
7698 (org-forward-same-level (1- n) t)
7699 (error nil))
7700 (org-end-of-subtree t t))
7701 (org-back-over-empty-lines)
7702 (setq end (point))
7703 (goto-char beg0)
7704 (when (> end beg)
7705 (setq org-subtree-clip-folded folded)
7706 (when (or cut force-store-markers)
7707 (org-save-markers-in-region beg end))
7708 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7709 (setq org-subtree-clip (current-kill 0))
7710 (message "%s: Subtree(s) with %d characters"
7711 (if cut "Cut" "Copied")
7712 (length org-subtree-clip)))))
7714 (defun org-paste-subtree (&optional level tree for-yank)
7715 "Paste the clipboard as a subtree, with modification of headline level.
7716 The entire subtree is promoted or demoted in order to match a new headline
7717 level.
7719 If the cursor is at the beginning of a headline, the same level as
7720 that headline is used to paste the tree
7722 If not, the new level is derived from the *visible* headings
7723 before and after the insertion point, and taken to be the inferior headline
7724 level of the two. So if the previous visible heading is level 3 and the
7725 next is level 4 (or vice versa), level 4 will be used for insertion.
7726 This makes sure that the subtree remains an independent subtree and does
7727 not swallow low level entries.
7729 You can also force a different level, either by using a numeric prefix
7730 argument, or by inserting the heading marker by hand. For example, if the
7733 If optional TREE is given, use this text instead of the kill ring.
7735 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7736 move back over whitespace before inserting, and move point to the end of
7737 the inserted text when done."
7738 (interactive "P")
7739 (setq tree (or tree (and kill-ring (current-kill 0))))
7740 (unless (org-kill-is-subtree-p tree)
7741 (error "%s"
7742 (substitute-command-keys
7744 (org-with-limited-levels
7745 (let* ((visp (not (outline-invisible-p)))
7746 (txt tree)
7748 (old-level (if (string-match org-outline-regexp-bol txt)
7749 (- (match-end 0) (match-beginning 0) 1)
7750 -1))
7751 (force-level (cond (level (prefix-numeric-value level))
7753 (string-match
7755 (point-at-bol) (point))))
7756 (- (match-end 1) (match-beginning 1)))
7757 ((and (bolp)
7758 (looking-at org-outline-regexp))
7759 (- (match-end 0) (point) 1))
7760 (t nil)))
7761 (previous-level (save-excursion
7762 (condition-case nil
7763 (progn
7764 (outline-previous-visible-heading 1)
7765 (if (looking-at ^re_)
7766 (- (match-end 0) (match-beginning 0) 1)
7767 1))
7768 (error 1))))
7769 (next-level (save-excursion
7770 (condition-case nil
7771 (progn
7772 (or (looking-at org-outline-regexp)
7773 (outline-next-visible-heading 1))
7774 (if (looking-at ^re_)
7775 (- (match-end 0) (match-beginning 0) 1)
7776 1))
7777 (error 1))))
7778 (new-level (or force-level (max previous-level next-level)))
7779 (shift (if (or (= old-level -1)
7780 (= new-level -1)
7781 (= old-level new-level))
7782 0
7783 (- new-level old-level)))
7784 (delta (if (> shift 0) -1 1))
7785 (func (if (> shift 0) 'org-demote 'org-promote))
7786 (org-odd-levels-only nil)
7787 beg end newend)
7788 ;; Remove the forced level indicator
7789 (if force-level
7790 (delete-region (point-at-bol) (point)))
7791 ;; Paste
7792 (beginning-of-line (if (bolp) 1 2))
7793 (unless for-yank (org-back-over-empty-lines))
7794 (setq beg (point))
7795 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7796 (insert-before-markers txt)
7798 (setq newend (point))
7799 (org-reinstall-markers-in-region beg)
7800 (setq end (point))
7801 (goto-char beg)
7803 (setq beg (point))
7804 (if (and (outline-invisible-p) visp)
7805 (save-excursion (outline-show-heading)))
7806 ;; Shift if necessary
7807 (unless (= shift 0)
7808 (save-restriction
7809 (narrow-to-region beg end)
7810 (while (not (= shift 0))
7811 (org-map-region func (point-min) (point-max))
7812 (setq shift (+ delta shift)))
7813 (goto-char (point-min))
7814 (setq newend (point-max))))
7815 (when (or (org-called-interactively-p 'interactive) for-yank)
7816 (message "Clipboard pasted as level %d subtree" new-level))
7817 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7818 kill-ring
7819 (eq org-subtree-clip (current-kill 0))
7820 org-subtree-clip-folded)
7821 ;; The tree was folded before it was killed/copied
7822 (hide-subtree))
7823 (and for-yank (goto-char newend)))))
7825 (defun org-kill-is-subtree-p (&optional txt)
7826 "Check if the current kill is an outline subtree, or a set of trees.
7827 Returns nil if kill does not start with a headline, or if the first
7828 headline level is not the largest headline level in the tree.
7829 So this will actually accept several entries of equal levels as well,
7830 which is OK for `org-paste-subtree'.
7831 If optional TXT is given, check this string instead of the current kill."
7832 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7833 (re (org-get-limited-outline-regexp))
7834 (^re (concat "^" re))
7835 (start-level (and kill
7836 (string-match
7838 kill)
7839 (- (match-end 2) (match-beginning 2) 1)))
7840 (start (1+ (or (match-beginning 2) -1))))
7841 (if (not start-level)
7842 (progn
7843 nil) ;; does not even start with a heading
7844 (catch 'exit
7845 (while (setq start (string-match ^re kill (1+ start)))
7846 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7847 (throw 'exit nil)))
7848 t))))
7850 (defvar org-markers-to-move nil
7851 "Markers that should be moved with a cut-and-paste operation.
7852 Those markers are stored together with their positions relative to
7853 the start of the region.")
7855 (defun org-save-markers-in-region (beg end)
7856 "Check markers in region.
7857 If these markers are between BEG and END, record their position relative
7858 to BEG, so that after moving the block of text, we can put the markers back
7859 into place.
7860 This function gets called just before an entry or tree gets cut from the
7861 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7862 called immediately, to move the markers with the entries."
7863 (setq org-markers-to-move nil)
7864 (when (featurep 'org-clock)
7865 (org-clock-save-markers-for-cut-and-paste beg end))
7866 (when (featurep 'org-agenda)
7867 (org-agenda-save-markers-for-cut-and-paste beg end)))
7869 (defun org-check-and-save-marker (marker beg end)
7870 "Check if MARKER is between BEG and END.
7871 If yes, remember the marker and the distance to BEG."
7872 (when (and (marker-buffer marker)
7873 (equal (marker-buffer marker) (current-buffer)))
7874 (if (and (>= marker beg) (< marker end))
7875 (push (cons marker (- marker beg)) org-markers-to-move))))
7877 (defun org-reinstall-markers-in-region (beg)
7878 "Move all remembered markers to their position relative to BEG."
7879 (mapc (lambda (x)
7880 (move-marker (car x) (+ beg (cdr x))))
7881 org-markers-to-move)
7882 (setq org-markers-to-move nil))
7884 (defun org-narrow-to-subtree ()
7885 "Narrow buffer to the current subtree."
7886 (interactive)
7887 (save-excursion
7888 (save-match-data
7889 (org-with-limited-levels
7890 (narrow-to-region
7891 (progn (org-back-to-heading t) (point))
7892 (progn (org-end-of-subtree t t)
7893 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7894 (point)))))))
7896 (defun org-narrow-to-block ()
7897 "Narrow buffer to the current block."
7898 (interactive)
7899 (let* ((case-fold-search t)
7902 (if blockp
7903 (narrow-to-region (car blockp) (cdr blockp))
7904 (error "Not in a block"))))
7906 (eval-when-compile
7907 (defvar org-property-drawer-re))
7909 (defvar org-property-start-re) ;; defined below
7910 (defun org-clone-subtree-with-time-shift (n &optional shift)
7911 "Clone the task (subtree) at point N times.
7912 The clones will be inserted as siblings.
7914 In interactive use, the user will be prompted for the number of
7915 clones to be produced, and for a time SHIFT, which may be a
7916 repeater as used in time stamps, for example `+3d'.
7918 When a valid repeater is given and the entry contains any time
7919 stamps, the clones will become a sequence in time, with time
7920 stamps in the subtree shifted for each clone produced. If SHIFT
7921 is nil or the empty string, time stamps will be left alone. The
7922 ID property of the original subtree is removed.
7924 If the original subtree did contain time stamps with a repeater,
7925 the following will happen:
7926 - the repeater will be removed in each clone
7927 - an additional clone will be produced, with the current, unshifted
7928 date(s) in the entry.
7929 - the original entry will be placed *after* all the clones, with
7930 repeater intact.
7931 - the start days in the repeater in the original entry will be shifted
7932 to past the last clone.
7933 I this way you can spell out a number of instances of a repeating task,
7934 and still retain the repeater to cover future instances of the task."
7935 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7936 (let (beg end template task idprop
7937 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7938 (drawer-re org-drawer-regexp))
7939 (if (not (and (integerp n) (> n 0)))
7940 (error "Invalid number of replications %s" n))
7943 shift)))
7944 (error "Invalid shift specification %s" shift))
7945 (when doshift
7946 (setq shift-n (string-to-number (match-string 1 shift))
7947 shift-what (cdr (assoc (match-string 2 shift)
7948 '(("d" . day) ("w" . week)
7949 ("m" . month) ("y" . year))))))
7950 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7951 (setq nmin 1 nmax n)
7952 (org-back-to-heading t)
7953 (setq beg (point))
7954 (setq idprop (org-entry-get nil "ID"))
7955 (org-end-of-subtree t t)
7957 (setq end (point))
7958 (setq template (buffer-substring beg end))
7959 (when (and doshift
7961 (delete-region beg end)
7962 (setq end beg)
7963 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7964 (goto-char end)
7965 (loop for n from nmin to nmax do
7966 ;; prepare clone
7967 (with-temp-buffer
7968 (insert template)
7969 (org-mode)
7970 (goto-char (point-min))
7971 (org-show-subtree)
7972 (and idprop (if org-clone-delete-id
7973 (org-entry-delete nil "ID")
7974 (org-id-get-create t)))
7975 (unless (= n 0)
7977 (kill-whole-line))
7978 (goto-char (point-min))
7979 (while (re-search-forward drawer-re nil t)
7980 (mapc (lambda (d)
7981 (org-remove-empty-drawer-at d (point))) org-drawers)))
7982 (goto-char (point-min))
7983 (when doshift
7984 (while (re-search-forward org-ts-regexp-both nil t)
7985 (org-timestamp-change (* n shift-n) shift-what))
7986 (unless (= n n-no-remove)
7987 (goto-char (point-min))
7988 (while (re-search-forward org-ts-regexp nil t)
7989 (save-excursion
7990 (goto-char (match-beginning 0))
7992 (delete-region (match-beginning 1) (match-end 1)))))))
7993 (setq task (buffer-string)))
7994 (insert task))
7995 (goto-char beg)))
7997 ;;; Outline Sorting
7999 (defun org-sort (with-case)
8000 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8001 Optional argument WITH-CASE means sort case-sensitively."
8002 (interactive "P")
8003 (cond
8004 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8005 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8006 (t
8007 (org-call-with-arg 'org-sort-entries with-case))))
8009 (defun org-sort-remove-invisible (s)
8010 (remove-text-properties 0 (length s) org-rm-props s)
8011 (while (string-match org-bracket-link-regexp s)
8012 (setq s (replace-match (if (match-end 2)
8013 (match-string 3 s)
8014 (match-string 1 s)) t t s)))
8015 s)
8017 (defvar org-priority-regexp) ; defined later in the file
8019 (defvar org-after-sorting-entries-or-items-hook nil
8020 "Hook that is run after a bunch of entries or items have been sorted.
8021 When children are sorted, the cursor is in the parent line when this
8022 hook gets called. When a region or a plain list is sorted, the cursor
8023 will be in the first entry of the sorted region/list.")
8025 (defun org-sort-entries
8026 (&optional with-case sorting-type getkey-func compare-func property)
8027 "Sort entries on a certain level of an outline tree.
8028 If there is an active region, the entries in the region are sorted.
8029 Else, if the cursor is before the first entry, sort the top-level items.
8030 Else, the children of the entry at point are sorted.
8032 Sorting can be alphabetically, numerically, by date/time as given by
8033 a time stamp, by a property or by priority.
8035 The command prompts for the sorting type unless it has been given to the
8036 function through the SORTING-TYPE argument, which needs to be a character,
8037 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8038 precise meaning of each character:
8040 n Numerically, by converting the beginning of the entry/item to a number.
8041 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8042 t By date/time, either the first active time stamp in the entry, or, if
8043 none exist, by the first inactive one.
8044 s By the scheduled date/time.
8045 d By deadline date/time.
8046 c By creation time, which is assumed to be the first inactive time stamp
8047 at the beginning of a line.
8048 p By priority according to the cookie.
8049 r By the value of a property.
8051 Capital letters will reverse the sort order.
8053 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8054 called with point at the beginning of the record. It must return either
8055 a string or a number that should serve as the sorting key for that record.
8057 Comparing entries ignores case by default. However, with an optional argument
8058 WITH-CASE, the sorting considers case as well."
8059 (interactive "P")
8060 (let ((case-func (if with-case 'identity 'downcase))
8061 start beg end stars re re2
8062 txt what tmp)
8063 ;; Find beginning and end of region to sort
8064 (cond
8065 ((org-region-active-p)
8066 ;; we will sort the region
8067 (setq end (region-end)
8068 what "region")
8069 (goto-char (region-beginning))
8070 (if (not (org-at-heading-p)) (outline-next-heading))
8071 (setq start (point)))
8072 ((or (org-at-heading-p)
8073 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8074 ;; we will sort the children of the current headline
8075 (org-back-to-heading)
8076 (setq start (point)
8077 end (progn (org-end-of-subtree t t)
8079 (org-back-over-empty-lines)
8080 (point))
8081 what "children")
8082 (goto-char start)
8083 (show-subtree)
8084 (outline-next-heading))
8085 (t
8086 ;; we will sort the top-level entries in this file
8087 (goto-char (point-min))
8088 (or (org-at-heading-p) (outline-next-heading))
8089 (setq start (point))
8090 (goto-char (point-max))
8091 (beginning-of-line 1)
8093 ;; File ends in a non-white line
8094 (end-of-line 1)
8096 (setq end (point-max))
8097 (setq what "top-level")
8098 (goto-char start)
8099 (show-all)))
8101 (setq beg (point))
8102 (if (>= beg end) (error "Nothing to sort"))
8105 (setq stars (match-string 1)
8106 re (concat "^" (regexp-quote stars) " +")
8108 txt (buffer-substring beg end))
8110 (if (and (not (equal stars "*")) (string-match re2 txt))
8111 (error "Region to sort contains a level above the first entry"))
8113 (unless sorting-type
8114 (message
8115 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8117 A/N/T/S/D/C/P/O/F means reversed:"
8118 what)
8119 (setq sorting-type (read-char-exclusive))
8121 (and (= (downcase sorting-type) ?f)
8122 (setq getkey-func
8123 (org-icompleting-read "Sort using function: "
8124 obarray 'fboundp t nil nil))
8125 (setq getkey-func (intern getkey-func)))
8127 (and (= (downcase sorting-type) ?r)
8128 (setq property
8129 (org-icompleting-read "Property: "
8130 (mapcar 'list (org-buffer-property-keys t))
8131 nil t))))
8133 (message "Sorting entries...")
8135 (save-restriction
8136 (narrow-to-region start end)
8137 (let ((dcst (downcase sorting-type))
8138 (case-fold-search nil)
8139 (now (current-time)))
8140 (sort-subr
8141 (/= dcst sorting-type)
8142 ;; This function moves to the beginning character of the "record" to
8143 ;; be sorted.
8144 (lambda nil
8145 (if (re-search-forward re nil t)
8146 (goto-char (match-beginning 0))
8147 (goto-char (point-max))))
8148 ;; This function moves to the last character of the "record" being
8149 ;; sorted.
8150 (lambda nil
8151 (save-match-data
8152 (condition-case nil
8153 (outline-forward-same-level 1)
8154 (error
8155 (goto-char (point-max))))))
8156 ;; This function returns the value that gets sorted against.
8157 (lambda nil
8158 (cond
8159 ((= dcst ?n)
8160 (if (looking-at org-complex-heading-regexp)
8161 (string-to-number (match-string 4))
8162 nil))
8163 ((= dcst ?a)
8164 (if (looking-at org-complex-heading-regexp)
8165 (funcall case-func (match-string 4))
8166 nil))
8167 ((= dcst ?t)
8168 (let ((end (save-excursion (outline-next-heading) (point))))
8169 (if (or (re-search-forward org-ts-regexp end t)
8170 (re-search-forward org-ts-regexp-both end t))
8171 (org-time-string-to-seconds (match-string 0))
8172 (org-float-time now))))
8173 ((= dcst ?c)
8174 (let ((end (save-excursion (outline-next-heading) (point))))
8175 (if (re-search-forward
8177 end t)
8178 (org-time-string-to-seconds (match-string 0))
8179 (org-float-time now))))
8180 ((= dcst ?s)
8181 (let ((end (save-excursion (outline-next-heading) (point))))
8182 (if (re-search-forward org-scheduled-time-regexp end t)
8183 (org-time-string-to-seconds (match-string 1))
8184 (org-float-time now))))
8185 ((= dcst ?d)
8186 (let ((end (save-excursion (outline-next-heading) (point))))
8187 (if (re-search-forward org-deadline-time-regexp end t)
8188 (org-time-string-to-seconds (match-string 1))
8189 (org-float-time now))))
8190 ((= dcst ?p)
8191 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8192 (string-to-char (match-string 2))
8193 org-default-priority))
8194 ((= dcst ?r)
8195 (or (org-entry-get nil property) ""))
8196 ((= dcst ?o)
8197 (if (looking-at org-complex-heading-regexp)
8198 (- 9999 (length (member (match-string 2)
8199 org-todo-keywords-1)))))
8200 ((= dcst ?f)
8201 (if getkey-func
8202 (progn
8203 (setq tmp (funcall getkey-func))
8204 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8205 tmp)
8206 (error "Invalid key function `%s'" getkey-func)))
8207 (t (error "Invalid sorting type `%c'" sorting-type))))
8208 nil
8209 (cond
8210 ((= dcst ?a) 'string<)
8211 ((= dcst ?f) compare-func)
8212 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8213 (t nil)))))
8214 (run-hooks 'org-after-sorting-entries-or-items-hook)
8215 (message "Sorting entries...done")))
8217 (defun org-do-sort (table what &optional with-case sorting-type)
8218 "Sort TABLE of WHAT according to SORTING-TYPE.
8219 The user will be prompted for the SORTING-TYPE if the call to this
8220 function does not specify it. WHAT is only for the prompt, to indicate
8221 what is being sorted. The sorting key will be extracted from
8222 the car of the elements of the table.
8223 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8224 (unless sorting-type
8225 (message
8226 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8227 what)
8228 (setq sorting-type (read-char-exclusive)))
8229 (let ((dcst (downcase sorting-type))
8230 extractfun comparefun)
8231 ;; Define the appropriate functions
8232 (cond
8233 ((= dcst ?n)
8234 (setq extractfun 'string-to-number
8235 comparefun (if (= dcst sorting-type) '< '>)))
8236 ((= dcst ?a)
8237 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8238 (lambda(x) (downcase (org-sort-remove-invisible x))))
8239 comparefun (if (= dcst sorting-type)
8240 'string<
8241 (lambda (a b) (and (not (string< a b))
8242 (not (string= a b)))))))
8243 ((= dcst ?t)
8244 (setq extractfun
8245 (lambda (x)
8246 (if (or (string-match org-ts-regexp x)
8247 (string-match org-ts-regexp-both x))
8248 (org-float-time
8249 (org-time-string-to-time (match-string 0 x)))
8250 0))
8251 comparefun (if (= dcst sorting-type) '< '>)))
8252 (t (error "Invalid sorting type `%c'" sorting-type)))
8254 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8255 table)
8256 (lambda (a b) (funcall comparefun (car a) (car b))))))
8259 ;;; The orgstruct minor mode
8261 ;; Define a minor mode which can be used in other modes in order to
8262 ;; integrate the org-mode structure editing commands.
8264 ;; This is really a hack, because the org-mode structure commands use
8265 ;; keys which normally belong to the major mode. Here is how it
8266 ;; works: The minor mode defines all the keys necessary to operate the
8267 ;; structure commands, but wraps the commands into a function which
8268 ;; tests if the cursor is currently at a headline or a plain list
8269 ;; item. If that is the case, the structure command is used,
8270 ;; temporarily setting many Org-mode variables like regular
8271 ;; expressions for filling etc. However, when any of those keys is
8272 ;; used at a different location, function uses `key-binding' to look
8273 ;; up if the key has an associated command in another currently active
8274 ;; keymap (minor modes, major mode, global), and executes that
8275 ;; command. There might be problems if any of the keys is otherwise
8276 ;; used as a prefix key.
8278 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8279 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8280 ;; addresses this by checking explicitly for both bindings.
8282 (defvar orgstruct-mode-map (make-sparse-keymap)
8283 "Keymap for the minor `orgstruct-mode'.")
8285 (defvar org-local-vars nil
8286 "List of local variables, for use by `orgstruct-mode'.")
8288 ;;;###autoload
8289 (define-minor-mode orgstruct-mode
8290 "Toggle the minor mode `orgstruct-mode'.
8291 This mode is for using Org-mode structure commands in other
8292 modes. The following keys behave as if Org-mode were active, if
8293 the cursor is on a headline, or on a plain list item (both as
8294 defined by Org-mode).
8296 M-up Move entry/item up
8297 M-down Move entry/item down
8298 M-left Promote
8299 M-right Demote
8300 M-S-up Move entry/item up
8301 M-S-down Move entry/item down
8302 M-S-left Promote subtree
8303 M-S-right Demote subtree
8304 M-q Fill paragraph and items like in Org-mode
8305 C-c ^ Sort entries
8306 C-c - Cycle list bullet
8307 TAB Cycle item visibility
8308 M-RET Insert new heading/item
8309 S-M-RET Insert new TODO heading / Checkbox item
8310 C-c C-c Set tags / toggle checkbox"
8311 nil " OrgStruct" nil
8312 (org-load-modules-maybe)
8313 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8315 ;;;###autoload
8316 (defun turn-on-orgstruct ()
8317 "Unconditionally turn on `orgstruct-mode'."
8318 (orgstruct-mode 1))
8320 (defun orgstruct++-mode (&optional arg)
8321 "Toggle `orgstruct-mode', the enhanced version of it.
8322 In addition to setting orgstruct-mode, this also exports all indentation
8323 and autofilling variables from org-mode into the buffer. It will also
8324 recognize item context in multiline items.
8325 Note that turning off orgstruct-mode will *not* remove the
8326 indentation/paragraph settings. This can only be done by refreshing the
8328 (interactive "P")
8329 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8330 (if (< arg 1)
8331 (orgstruct-mode -1)
8332 (orgstruct-mode 1)
8333 (let (var val)
8334 (mapc
8335 (lambda (x)
8336 (when (string-match
8338 (symbol-name (car x)))
8339 (setq var (car x) val (nth 1 x))
8340 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8341 org-local-vars)
8342 (org-set-local 'orgstruct-is-++ t))))
8344 (defvar orgstruct-is-++ nil
8345 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8346 (make-variable-buffer-local 'orgstruct-is-++)
8348 ;;;###autoload
8349 (defun turn-on-orgstruct++ ()
8350 "Unconditionally turn on `orgstruct++-mode'."
8351 (orgstruct++-mode 1))
8353 (defun orgstruct-error ()
8354 "Error when there is no default binding for a structure key."
8355 (interactive)
8356 (error "This key has no function outside structure elements"))
8358 (defun orgstruct-setup ()
8359 "Setup orgstruct keymaps."
8360 (let ((nfunc 0)
8361 (bindings
8362 (list
8363 '([(meta up)] org-metaup)
8364 '([(meta down)] org-metadown)
8365 '([(meta left)] org-metaleft)
8366 '([(meta right)] org-metaright)
8367 '([(meta shift up)] org-shiftmetaup)
8368 '([(meta shift down)] org-shiftmetadown)
8369 '([(meta shift left)] org-shiftmetaleft)
8370 '([(meta shift right)] org-shiftmetaright)
8371 '([?\e (up)] org-metaup)
8372 '([?\e (down)] org-metadown)
8373 '([?\e (left)] org-metaleft)
8374 '([?\e (right)] org-metaright)
8375 '([?\e (shift up)] org-shiftmetaup)
8376 '([?\e (shift down)] org-shiftmetadown)
8377 '([?\e (shift left)] org-shiftmetaleft)
8378 '([?\e (shift right)] org-shiftmetaright)
8379 '([(shift up)] org-shiftup)
8380 '([(shift down)] org-shiftdown)
8381 '([(shift left)] org-shiftleft)
8382 '([(shift right)] org-shiftright)
8383 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8384 '("\M-q" fill-paragraph)
8385 '("\C-c^" org-sort)
8386 '("\C-c-" org-cycle-list-bullet)))
8387 elt key fun cmd)
8388 (while (setq elt (pop bindings))
8389 (setq nfunc (1+ nfunc))
8390 (setq key (org-key (car elt))
8391 fun (nth 1 elt)
8392 cmd (orgstruct-make-binding fun nfunc key))
8393 (org-defkey orgstruct-mode-map key cmd))
8395 ;; Special treatment needed for TAB and RET
8396 (org-defkey orgstruct-mode-map [(tab)]
8397 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8398 (org-defkey orgstruct-mode-map "\C-i"
8399 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8401 (org-defkey orgstruct-mode-map "\M-\C-m"
8402 (orgstruct-make-binding 'org-insert-heading 105
8403 "\M-\C-m" [(meta return)]))
8404 (org-defkey orgstruct-mode-map [(meta return)]
8405 (orgstruct-make-binding 'org-insert-heading 106
8406 [(meta return)] "\M-\C-m"))
8408 (org-defkey orgstruct-mode-map [(shift meta return)]
8409 (orgstruct-make-binding 'org-insert-todo-heading 107
8410 [(meta return)] "\M-\C-m"))
8412 (org-defkey orgstruct-mode-map "\e\C-m"
8413 (orgstruct-make-binding 'org-insert-heading 108
8414 "\e\C-m" [?\e (return)]))
8415 (org-defkey orgstruct-mode-map [?\e (return)]
8416 (orgstruct-make-binding 'org-insert-heading 109
8417 [?\e (return)] "\e\C-m"))
8418 (org-defkey orgstruct-mode-map [?\e (shift return)]
8419 (orgstruct-make-binding 'org-insert-todo-heading 110
8420 [?\e (return)] "\e\C-m"))
8422 (unless org-local-vars
8423 (setq org-local-vars (org-get-local-variables)))
8425 t))
8427 (defun orgstruct-make-binding (fun n &rest keys)
8428 "Create a function for binding in the structure minor mode.
8429 FUN is the command to call inside a table. N is used to create a unique
8430 command name. KEYS are keys that should be checked in for a command
8431 to execute outside of tables."
8432 (eval
8433 (list 'defun
8434 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8435 '(arg)
8437 "Outside of structure, run the binding of `"
8438 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8439 "'.")
8440 '(interactive "p")
8441 (list 'if
8442 `(org-context-p 'headline 'item
8443 (and orgstruct-is-++
8444 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8445 'item-body))
8446 (list 'org-run-like-in-org-mode (list 'quote fun))
8447 (list 'let '(orgstruct-mode)
8448 (list 'call-interactively
8449 (append '(or)
8450 (mapcar (lambda (k)
8451 (list 'key-binding k))
8452 keys)
8453 '('orgstruct-error))))))))
8455 (defun org-context-p (&rest contexts)
8456 "Check if local context is any of CONTEXTS.
8457 Possible values in the list of contexts are `table', `headline', and `item'."
8458 (let ((pos (point)))
8459 (goto-char (point-at-bol))
8460 (prog1 (or (and (memq 'table contexts)
8462 (and (memq 'headline contexts)
8463 (looking-at org-outline-regexp))
8464 (and (memq 'item contexts)
8466 (and (memq 'item-body contexts)
8467 (org-in-item-p)))
8468 (goto-char pos))))
8470 (defun org-get-local-variables ()
8471 "Return a list of all local variables in an org-mode buffer."
8472 (let (varlist)
8473 (with-current-buffer (get-buffer-create "*Org tmp*")
8474 (erase-buffer)
8475 (org-mode)
8476 (setq varlist (buffer-local-variables)))
8477 (kill-buffer "*Org tmp*")
8478 (delq nil
8479 (mapcar
8480 (lambda (x)
8481 (setq x
8482 (if (symbolp x)
8483 (list x)
8484 (list (car x) (list 'quote (cdr x)))))
8485 (if (string-match
8486 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8487 (symbol-name (car x)))
8488 x nil))
8489 varlist))))
8491 (defun org-clone-local-variables (from-buffer &optional regexp)
8492 "Clone local variables from FROM-BUFFER.
8493 Optional argument REGEXP selects variables to clone."
8494 (mapc
8495 (lambda (pair)
8496 (and (symbolp (car pair))
8497 (or (null regexp)
8498 (string-match regexp (symbol-name (car pair))))
8499 (set (make-local-variable (car pair))
8500 (cdr pair))))
8501 (buffer-local-variables from-buffer)))
8503 ;;;###autoload
8504 (defun org-run-like-in-org-mode (cmd)
8505 "Run a command, pretending that the current buffer is in Org-mode.
8506 This will temporarily bind local variables that are typically bound in
8507 Org-mode to the values they have in Org-mode, and then interactively
8508 call CMD."
8509 (org-load-modules-maybe)
8510 (unless org-local-vars
8511 (setq org-local-vars (org-get-local-variables)))
8512 (eval (list 'let org-local-vars
8513 (list 'call-interactively (list 'quote cmd)))))
8515 ;;;; Archiving
8517 (defun org-get-category (&optional pos force-refresh)
8518 "Get the category applying to position POS."
8519 (if force-refresh (org-refresh-category-properties))
8520 (let ((pos (or pos (point))))
8521 (or (get-text-property pos 'org-category)
8522 (progn (org-refresh-category-properties)
8523 (get-text-property pos 'org-category)))))
8525 (defun org-refresh-category-properties ()
8526 "Refresh category text properties in the buffer."
8527 (let ((def-cat (cond
8528 ((null org-category)
8529 (if buffer-file-name
8530 (file-name-sans-extension
8531 (file-name-nondirectory buffer-file-name))
8532 "???"))
8533 ((symbolp org-category) (symbol-name org-category))
8534 (t org-category)))
8535 beg end cat pos optionp)
8536 (org-unmodified
8537 (save-excursion
8538 (save-restriction
8539 (widen)
8540 (goto-char (point-min))
8541 (put-text-property (point) (point-max) 'org-category def-cat)
8542 (while (re-search-forward
8544 (setq pos (match-end 0)
8545 optionp (equal (char-after (match-beginning 0)) ?#)
8546 cat (org-trim (match-string 2)))
8547 (if optionp
8548 (setq beg (point-at-bol) end (point-max))
8549 (org-back-to-heading t)
8550 (setq beg (point) end (org-end-of-subtree t t)))
8551 (put-text-property beg end 'org-category cat)
8552 (put-text-property beg end 'org-category-position beg)
8553 (goto-char pos)))))))
8556 ;;;; Link Stuff
8558 ;;; Link abbreviations
8560 (defun org-link-expand-abbrev (link)
8561 "Apply replacements as defined in `org-link-abbrev-alist."
8563 (let* ((key (match-string 1 link))
8564 (as (or (assoc key org-link-abbrev-alist-local)
8565 (assoc key org-link-abbrev-alist)))
8566 (tag (and (match-end 2) (match-string 3 link)))
8567 rpl)
8568 (if (not as)
8569 link
8570 (setq rpl (cdr as))
8571 (cond
8572 ((symbolp rpl) (funcall rpl tag))
8573 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8574 ((string-match "%h" rpl)
8575 (replace-match (url-hexify-string (or tag "")) t t rpl))
8576 (t (concat rpl tag)))))
8577 link))
8579 ;;; Storing and inserting links
8581 (defvar org-insert-link-history nil
8582 "Minibuffer history for links inserted with `org-insert-link'.")
8584 (defvar org-stored-links nil
8585 "Contains the links stored with `org-store-link'.")
8587 (defvar org-store-link-plist nil
8588 "Plist with info about the most recently link created with `org-store-link'.")
8590 (defvar org-link-protocols nil
8591 "Link protocols added to Org-mode using `org-add-link-type'.")
8593 (defvar org-store-link-functions nil
8594 "List of functions that are called to create and store a link.
8595 Each function will be called in turn until one returns a non-nil
8596 value. Each function should check if it is responsible for creating
8597 this link (for example by looking at the major mode).
8598 If not, it must exit and return nil.
8599 If yes, it should return a non-nil value after a calling
8600 `org-store-link-props' with a list of properties and values.
8601 Special properties are:
8605 This is obligatory as well.
8606 :description Optional default description for the second pair
8607 of brackets in an Org-mode link. The user can still change
8608 this when inserting this link into an Org-mode buffer.
8610 In addition to these, any additional properties can be specified
8611 and then used in remember templates.")
8613 (defun org-add-link-type (type &optional follow export)
8614 "Add TYPE to the list of `org-link-types'.
8615 Re-compute all regular expressions depending on `org-link-types'
8617 FOLLOW and EXPORT are two functions.
8619 FOLLOW should take the link path as the single argument and do whatever
8620 is necessary to follow the link, for example find a file or display
8621 a mail message.
8623 EXPORT should format the link path for export to one of the export formats.
8624 It should be a function accepting three arguments:
8627 desc the description of the link, if any, or a description added by
8628 org-export-normalize-links if there is none
8629 format the export format, a symbol like `html' or `latex' or `ascii'..
8631 The function may use the FORMAT information to return different values
8632 depending on the format. The return value will be put literally into
8633 the exported file. If the return value is nil, this means Org should
8634 do what it normally does with links which do not have EXPORT defined.
8636 Org-mode has a built-in default for exporting links. If you are happy with
8637 this default, there is no need to define an export function for the link
8638 type. For a simple example of an export function, see `org-bbdb.el'."
8639 (add-to-list 'org-link-types type t)
8640 (org-make-link-regexps)
8641 (if (assoc type org-link-protocols)
8642 (setcdr (assoc type org-link-protocols) (list follow export))
8643 (push (list type follow export) org-link-protocols)))
8645 (defvar org-agenda-buffer-name)
8647 ;;;###autoload
8648 (defun org-store-link (arg)
8650 This link is added to `org-stored-links' and can later be inserted
8653 For some link types, a prefix arg is interpreted:
8654 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8655 For file links, arg negates `org-context-in-file-links'."
8656 (interactive "P")
8657 (org-load-modules-maybe)
8658 (setq org-store-link-plist nil) ; reset
8659 (org-with-limited-levels
8660 (let (link cpltxt desc description search txt custom-id agenda-link)
8661 (cond
8663 ((run-hook-with-args-until-success 'org-store-link-functions)
8664 (setq link (plist-get org-store-link-plist :link)
8665 desc (or (plist-get org-store-link-plist :description) link)))
8667 ((equal (buffer-name) "*Org Edit Src Example*")
8668 (let (label gc)
8669 (while (or (not label)
8670 (save-excursion
8671 (save-restriction
8672 (widen)
8673 (goto-char (point-min))
8674 (re-search-forward
8675 (regexp-quote (format org-coderef-label-format label))
8676 nil t))))
8677 (when label (message "Label exists already") (sit-for 2))
8678 (setq label (read-string "Code line label: " label)))
8679 (end-of-line 1)
8680 (setq link (format org-coderef-label-format label))
8681 (setq gc (- 79 (length link)))
8682 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8683 (insert link)
8684 (setq link (concat "(" label ")") desc nil)))
8686 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8687 ;; We are in the agenda, link to referenced location
8688 (let ((m (or (get-text-property (point) 'org-hd-marker)
8689 (get-text-property (point) 'org-marker))))
8690 (when m
8691 (org-with-point-at m
8692 (setq agenda-link
8693 (if (org-called-interactively-p 'any)
8694 (call-interactively 'org-store-link)
8695 (org-store-link nil)))))))
8697 ((eq major-mode 'calendar-mode)
8698 (let ((cd (calendar-cursor-to-date)))
8699 (setq link
8700 (format-time-string
8701 (car org-time-stamp-formats)
8702 (apply 'encode-time
8703 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8704 nil nil nil))))
8705 (org-store-link-props :type "calendar" :date cd)))
8707 ((eq major-mode 'w3-mode)
8708 (setq cpltxt (if (and (buffer-name)
8709 (not (string-match "Untitled" (buffer-name))))
8710 (buffer-name)
8711 (url-view-url t))
8712 link (org-make-link (url-view-url t)))
8713 (org-store-link-props :type "w3" :url (url-view-url t)))
8715 ((eq major-mode 'w3m-mode)
8716 (setq cpltxt (or w3m-current-title w3m-current-url)
8717 link (org-make-link w3m-current-url))
8718 (org-store-link-props :type "w3m" :url (url-view-url t)))
8720 ((setq search (run-hook-with-args-until-success
8721 'org-create-file-search-functions))
8722 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8723 "::" search))
8724 (setq cpltxt (or description link)))
8726 ((eq major-mode 'image-mode)
8727 (setq cpltxt (concat "file:"
8728 (abbreviate-file-name buffer-file-name))
8729 link (org-make-link cpltxt))
8730 (org-store-link-props :type "image" :file buffer-file-name))
8732 ((eq major-mode 'dired-mode)
8733 ;; link to the file in the current line
8734 (let ((file (dired-get-filename nil t)))
8735 (setq file (if file
8736 (abbreviate-file-name
8737 (expand-file-name (dired-get-filename nil t)))
8738 ;; otherwise, no file so use current directory.
8739 default-directory))
8740 (setq cpltxt (concat "file:" file)
8741 link (org-make-link cpltxt))))
8743 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8744 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8745 (cond
8747 (setq cpltxt
8748 (concat "file:"
8749 (abbreviate-file-name
8750 (buffer-file-name (buffer-base-buffer)))
8751 "::" (match-string 1))
8752 link (org-make-link cpltxt)))
8753 ((and (featurep 'org-id)
8754 (or (eq org-link-to-org-use-id t)
8755 (and (eq org-link-to-org-use-id 'create-if-interactive)
8756 (org-called-interactively-p 'any))
8757 (and (eq org-link-to-org-use-id
8758 'create-if-interactive-and-no-custom-id)
8759 (org-called-interactively-p 'any)
8760 (not custom-id))
8761 (and org-link-to-org-use-id
8762 (org-entry-get nil "ID"))))
8763 ;; We can make a link using the ID.
8764 (setq link (condition-case nil
8765 (prog1 (org-id-store-link)
8766 (setq desc (plist-get org-store-link-plist
8767 :description)))
8768 (error
8769 ;; probably before first headline, link to file only
8770 (concat "file:"
8771 (abbreviate-file-name
8772 (buffer-file-name (buffer-base-buffer))))))))
8773 (t
8774 ;; Just link to current headline
8775 (setq cpltxt (concat "file:"
8776 (abbreviate-file-name
8777 (buffer-file-name (buffer-base-buffer)))))
8778 ;; Add a context search string
8779 (when (org-xor org-context-in-file-links arg)
8780 (setq txt (cond
8781 ((org-at-heading-p) nil)
8782 ((org-region-active-p)
8783 (buffer-substring (region-beginning) (region-end)))
8784 (t nil)))
8786 (setq cpltxt
8787 (concat cpltxt "::"
8788 (condition-case nil
8789 (org-make-org-heading-search-string txt)
8790 (error "")))
8791 desc (or (nth 4 (ignore-errors
8792 (org-heading-components))) "NONE"))))
8794 (setq cpltxt (substring cpltxt 0 -2)))
8795 (setq link (org-make-link cpltxt)))))
8797 ((buffer-file-name (buffer-base-buffer))
8798 ;; Just link to this file here.
8799 (setq cpltxt (concat "file:"
8800 (abbreviate-file-name
8801 (buffer-file-name (buffer-base-buffer)))))
8802 ;; Add a context string
8803 (when (org-xor org-context-in-file-links arg)
8804 (setq txt (if (org-region-active-p)
8805 (buffer-substring (region-beginning) (region-end))
8806 (buffer-substring (point-at-bol) (point-at-eol))))
8807 ;; Only use search option if there is some text.
8809 (setq cpltxt
8810 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8811 desc "NONE")))
8812 (setq link (org-make-link cpltxt)))
8814 ((org-called-interactively-p 'interactive)
8815 (error "Cannot link to a buffer which is not visiting a file"))
8817 (t (setq link nil)))
8819 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8820 (setq link (or link cpltxt)
8821 desc (or desc cpltxt))
8822 (if (equal desc "NONE") (setq desc nil))
8824 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8825 (progn
8826 (setq org-stored-links
8827 (cons (list link desc) org-stored-links))
8828 (message "Stored: %s" (or desc link))
8829 (when custom-id
8830 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8831 "::#" custom-id))
8832 (setq org-stored-links
8833 (cons (list link desc) org-stored-links))))
8834 (or agenda-link (and link (org-make-link-string link desc)))))))
8836 (defun org-store-link-props (&rest plist)
8837 "Store link properties, extract names and addresses."
8838 (let (x adr)
8839 (when (setq x (plist-get plist :from))
8840 (setq adr (mail-extract-address-components x))
8841 (setq plist (plist-put plist :fromname (car adr)))
8842 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8843 (when (setq x (plist-get plist :to))
8844 (setq adr (mail-extract-address-components x))
8845 (setq plist (plist-put plist :toname (car adr)))
8846 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8847 (let ((from (plist-get plist :from))
8848 (to (plist-get plist :to)))
8849 (when (and from to org-from-is-user-regexp)
8850 (setq plist
8851 (plist-put plist :fromto
8852 (if (string-match org-from-is-user-regexp from)
8853 (concat "to %t")
8854 (concat "from %f"))))))
8855 (setq org-store-link-plist plist))
8857 (defun org-add-link-props (&rest plist)
8858 "Add these properties to the link property list."
8859 (let (key value)
8860 (while plist
8861 (setq key (pop plist) value (pop plist))
8862 (setq org-store-link-plist
8863 (plist-put org-store-link-plist key value)))))
8865 (defun org-email-link-description (&optional fmt)
8866 "Return the description part of an email link.
8867 This takes information from `org-store-link-plist' and formats it
8868 according to FMT (default from `org-email-link-description-format')."
8869 (setq fmt (or fmt org-email-link-description-format))
8870 (let* ((p org-store-link-plist)
8871 (to (plist-get p :toaddress))
8872 (from (plist-get p :fromaddress))
8873 (table
8874 (list
8875 (cons "%c" (plist-get p :fromto))
8876 (cons "%F" (plist-get p :from))
8877 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8878 (cons "%T" (plist-get p :to))
8879 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8880 (cons "%s" (plist-get p :subject))
8881 (cons "%d" (plist-get p :date))
8882 (cons "%m" (plist-get p :message-id)))))
8883 (when (string-match "%c" fmt)
8884 ;; Check if the user wrote this message
8885 (if (and org-from-is-user-regexp from to
8886 (save-match-data (string-match org-from-is-user-regexp from)))
8887 (setq fmt (replace-match "to %t" t t fmt))
8888 (setq fmt (replace-match "from %f" t t fmt))))
8889 (org-replace-escapes fmt table)))
8891 (defun org-make-org-heading-search-string (&optional string heading)
8892 "Make search string for STRING or current headline."
8893 (interactive)
8894 (let ((s (or string (org-get-heading)))
8895 (lines org-context-in-file-links))
8896 (unless (and string (not heading))
8897 ;; We are using a headline, clean up garbage in there.
8898 (if (string-match org-todo-regexp s)
8899 (setq s (replace-match "" t t s)))
8901 (setq s (replace-match "" t t s)))
8902 (setq s (org-trim s))
8905 (setq s (replace-match "" t t s)))
8906 (while (string-match org-ts-regexp s)
8907 (setq s (replace-match "" t t s))))
8908 (or string (setq s (concat "*" s))) ; Add * for headlines
8909 (when (and string (integerp lines) (> lines 0))
8911 (when (< lines (length slines))
8912 (setq s (mapconcat
8913 'identity
8914 (reverse (nthcdr (- (length slines) lines)
8918 (defun org-make-link (&rest strings)
8919 "Concatenate STRINGS."
8920 (apply 'concat strings))
8922 (defun org-make-link-string (link &optional description)
8923 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8925 (error "Empty link"))
8926 (when (and description
8927 (stringp description)
8929 (setq description nil))
8930 (when (stringp description)
8931 ;; Remove brackets from the description, they are fatal.
8933 (setq description (replace-match "{" t t description)))
8935 (setq description (replace-match "}" t t description))))
8936 (when (equal link description)
8937 ;; No description needed, it is identical
8938 (setq description nil))
8939 (when (and (not description)
8940 (not (string-match (org-image-file-name-regexp) link))
8941 (not (equal link (org-link-escape link))))
8942 (setq description (org-extract-attributes link)))
8943 (setq link
8944 (cond ((string-match (org-image-file-name-regexp) link) link)
8945 ((string-match org-link-types-re link)
8946 (concat (match-string 1 link)
8947 (org-link-escape (substring link (match-end 1)))))
8948 (t (org-link-escape link))))
8949 (concat "[[" link "]"
8950 (if description (concat "[" description "]") "")
8951 "]"))
8953 (defconst org-link-escape-chars
8954 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8955 "List of characters that should be escaped in link.
8956 This is the list that is used for internal purposes.")
8958 (defvar org-url-encoding-use-url-hexify nil)
8960 (defconst org-link-escape-chars-browser
8961 '(?\ )
8962 "List of escapes for characters that are problematic in links.
8963 This is the list that is used before handing over to the browser.")
8965 (defun org-link-escape (text &optional table merge)
8966 "Return percent escaped representation of TEXT.
8967 TEXT is a string with the text to escape.
8968 Optional argument TABLE is a list with characters that should be
8969 escaped. When nil, `org-link-escape-chars' is used.
8970 If optional argument MERGE is set, merge TABLE into
8971 `org-link-escape-chars'."
8972 (if (and org-url-encoding-use-url-hexify (not table))
8973 (url-hexify-string text)
8974 (cond
8975 ((and table merge)
8976 (mapc (lambda (defchr)
8977 (unless (member defchr table)
8978 (setq table (cons defchr table)))) org-link-escape-chars))
8979 ((null table)
8980 (setq table org-link-escape-chars)))
8981 (mapconcat
8982 (lambda (char)
8983 (if (or (member char table)
8984 (< char 32) (= char 37) (> char 126))
8985 (mapconcat (lambda (sequence-element)
8986 (format "%%%.2X" sequence-element))
8987 (or (encode-coding-char char 'utf-8)
8988 (error "Unable to percent escape character: %s"
8989 (char-to-string char))) "")
8990 (char-to-string char))) text "")))
8992 (defun org-link-unescape (str)
8993 "Unhex hexified Unicode strings as returned from the JavaScript function
8994 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8995 (unless (and (null str) (string= "" str))
8996 (let ((pos 0) (case-fold-search t) unhexed)
8998 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8999 (setq str (replace-match unhexed t t str))
9000 (setq pos (+ pos (length unhexed))))))
9001 str)
9003 (defun org-link-unescape-compound (hex)
9004 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
9005 Note: this function also decodes single byte encodings like
9007 (save-match-data
9008 (let* ((bytes (cdr (split-string hex "%")))
9009 (ret "")
9010 (eat 0)
9011 (sum 0))
9012 (while bytes
9013 (let* ((val (string-to-number (pop bytes) 16))
9014 (shift-xor
9015 (if (= 0 eat)
9016 (cond
9017 ((>= val 252) (cons 6 252))
9018 ((>= val 248) (cons 5 248))
9019 ((>= val 240) (cons 4 240))
9020 ((>= val 224) (cons 3 224))
9021 ((>= val 192) (cons 2 192))
9022 (t (cons 0 0)))
9023 (cons 6 128))))
9024 (if (>= val 192) (setq eat (car shift-xor)))
9025 (setq val (logxor val (cdr shift-xor)))
9026 (setq sum (+ (lsh sum (car shift-xor)) val))
9027 (if (> eat 0) (setq eat (- eat 1)))
9028 (cond
9029 ((= 0 eat) ;multi byte
9030 (setq ret (concat ret (org-char-to-string sum)))
9031 (setq sum 0))
9032 ((not bytes) ; single byte(s)
9033 (setq ret (org-link-unescape-single-byte-sequence hex))))
9034 )) ;; end (while bytes
9035 ret )))
9037 (defun org-link-unescape-single-byte-sequence (hex)
9038 "Unhexify hex-encoded single byte character sequences."
9039 (mapconcat (lambda (byte)
9040 (char-to-string (string-to-number byte 16)))
9041 (cdr (split-string hex "%")) ""))
9043 (defun org-xor (a b)
9044 "Exclusive or."
9045 (if a (not b) b))
9047 (defun org-fixup-message-id-for-http (s)
9048 "Replace special characters in a message id, so it can be used in an http query."
9049 (when (string-match "%" s)
9050 (setq s (mapconcat (lambda (c)
9051 (if (eq c ?%)
9052 "%25"
9053 (char-to-string c)))
9054 s "")))
9055 (while (string-match "<" s)
9056 (setq s (replace-match "%3C" t t s)))
9057 (while (string-match ">" s)
9058 (setq s (replace-match "%3E" t t s)))
9059 (while (string-match "@" s)
9060 (setq s (replace-match "%40" t t s)))
9061 s)
9063 ;;;###autoload
9064 (defun org-insert-link-global ()
9065 "Insert a link like Org-mode does.
9066 This command can be called in any mode to insert a link in Org-mode syntax."
9067 (interactive)
9068 (org-load-modules-maybe)
9069 (org-run-like-in-org-mode 'org-insert-link))
9071 (defun org-insert-link (&optional complete-file link-location default-description)
9072 "Insert a link. At the prompt, enter the link.
9074 Completion can be used to insert any of the link protocol prefixes like
9075 http or ftp in use.
9077 The history can be used to select a link previously stored with
9078 `org-store-link'. When the empty string is entered (i.e. if you just
9079 press RET at the prompt), the link defaults to the most recently
9080 stored link. As SPC triggers completion in the minibuffer, you need to
9081 use M-SPC or C-q SPC to force the insertion of a space character.
9083 You will also be prompted for a description, and if one is given, it will
9084 be displayed in the buffer instead of the link.
9086 If there is already a link at point, this command will allow you to edit link
9087 and description parts.
9090 be selected using completion. The path to the file will be relative to the
9091 current directory if the file is in the current directory or a subdirectory.
9092 Otherwise, the link will be the absolute path as completed in the minibuffer
9093 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9094 option `org-link-file-path-type'.
9097 the current directory or below.
9100 `org-keep-stored-link-after-insertion'.
9102 If `org-make-link-description-function' is non-nil, this function will be
9103 called with the link target, and the result will be the default
9104 link description.
9106 If the LINK-LOCATION parameter is non-nil, this value will be
9107 used as the link location instead of reading one interactively.
9109 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9110 be used as the default description."
9111 (interactive "P")
9112 (let* ((wcf (current-window-configuration))
9113 (region (if (org-region-active-p)
9114 (buffer-substring (region-beginning) (region-end))))
9115 (remove (and region (list (region-beginning) (region-end))))
9116 (desc region)
9117 tmphist ; byte-compile incorrectly complains about this
9118 (link link-location)
9119 entry file all-prefixes)
9120 (cond
9121 (link-location) ; specified by arg, just use it.
9122 ((org-in-regexp org-bracket-link-regexp 1)
9123 ;; We do have a link at point, and we are going to edit it.
9124 (setq remove (list (match-beginning 0) (match-end 0)))
9125 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9126 (setq link (read-string "Link: "
9127 (org-link-unescape
9128 (org-match-string-no-properties 1)))))
9129 ((or (org-in-regexp org-angle-link-re)
9130 (org-in-regexp org-plain-link-re))
9131 ;; Convert to bracket link
9132 (setq remove (list (match-beginning 0) (match-end 0))
9133 link (read-string "Link: "
9134 (org-remove-angle-brackets (match-string 0)))))
9135 ((member complete-file '((4) (16)))
9136 ;; Completing read for file names.
9137 (setq link (org-file-complete-link complete-file)))
9138 (t
9139 ;; Read link, with completion for stored links.
9140 (with-output-to-temp-buffer "*Org Links*"
9141 (princ "Insert a link.
9143 (when org-stored-links
9145 (princ (mapconcat
9146 (lambda (x)
9147 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9149 (let ((cw (selected-window)))
9150 (select-window (get-buffer-window "*Org Links*" 'visible))
9151 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9152 (unless (pos-visible-in-window-p (point-max))
9153 (org-fit-window-to-buffer))
9154 (and (window-live-p cw) (select-window cw)))
9155 ;; Fake a link history, containing the stored links.
9156 (setq tmphist (append (mapcar 'car org-stored-links)
9157 org-insert-link-history))
9158 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9159 (mapcar 'car org-link-abbrev-alist)
9160 org-link-types))
9161 (unwind-protect
9162 (progn
9163 (setq link
9164 (let ((org-completion-use-ido nil)
9165 (org-completion-use-iswitchb nil))
9166 (org-completing-read
9167 "Link: "
9168 (append
9169 (mapcar (lambda (x) (list (concat x ":")))
9170 all-prefixes)
9171 (mapcar 'car org-stored-links))
9172 nil nil nil
9173 'tmphist
9174 (car (car org-stored-links)))))
9176 (error "No link selected"))
9177 (if (or (member link all-prefixes)
9178 (and (equal ":" (substring link -1))
9179 (member (substring link 0 -1) all-prefixes)
9180 (setq link (substring link 0 -1))))
9181 (setq link (org-link-try-special-completion link))))
9182 (set-window-configuration wcf)
9183 (kill-buffer "*Org Links*"))
9184 (setq entry (assoc link org-stored-links))
9185 (or entry (push link org-insert-link-history))
9186 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9187 (not org-keep-stored-link-after-insertion))
9188 (setq org-stored-links (delq (assoc link org-stored-links)
9189 org-stored-links)))
9190 (setq desc (or desc (nth 1 entry)))))
9192 (if (string-match org-plain-link-re link)
9193 ;; URL-like link, normalize the use of angular brackets.
9194 (setq link (org-make-link (org-remove-angle-brackets link))))
9196 ;; Check if we are linking to the current file with a search option
9197 ;; If yes, simplify the link by using only the search option.
9198 (when (and buffer-file-name
9200 (let* ((path (match-string 1 link))
9201 (case-fold-search nil)
9202 (search (match-string 2 link)))
9203 (save-match-data
9204 (if (equal (file-truename buffer-file-name) (file-truename path))
9205 ;; We are linking to this same file, with a search option
9206 (setq link search)))))
9208 ;; Check if we can/should use a relative path. If yes, simplify the link
9210 (let* ((type (match-string 1 link))
9211 (path (match-string 2 link))
9212 (origpath path)
9213 (case-fold-search nil))
9214 (cond
9215 ((or (eq org-link-file-path-type 'absolute)
9216 (equal complete-file '(16)))
9217 (setq path (abbreviate-file-name (expand-file-name path))))
9218 ((eq org-link-file-path-type 'noabbrev)
9219 (setq path (expand-file-name path)))
9220 ((eq org-link-file-path-type 'relative)
9221 (setq path (file-relative-name path)))
9222 (t
9223 (save-match-data
9224 (if (string-match (concat "^" (regexp-quote
9225 (expand-file-name
9226 (file-name-as-directory
9227 default-directory))))
9228 (expand-file-name path))
9229 ;; We are linking a file with relative path name.
9230 (setq path (substring (expand-file-name path)
9231 (match-end 0)))
9232 (setq path (abbreviate-file-name (expand-file-name path)))))))
9233 (setq link (concat type path))
9234 (if (equal desc origpath)
9235 (setq desc path))))
9237 (if org-make-link-description-function
9238 (setq desc (funcall org-make-link-description-function link desc))
9239 (if default-description (setq desc default-description)))
9241 (setq desc (read-string "Description: " desc))
9243 (if remove (apply 'delete-region remove))
9244 (insert (org-make-link-string link desc))))
9246 (defun org-link-try-special-completion (type)
9247 "If there is completion support for link type TYPE, offer it."
9248 (let ((fun (intern (concat "org-" type "-complete-link"))))
9249 (if (functionp fun)
9250 (funcall fun)
9251 (read-string "Link (no completion support): " (concat type ":")))))
9253 (defun org-file-complete-link (&optional arg)
9254 "Create a file link using completion."
9255 (let (file link)
9256 (setq file (read-file-name "File: "))
9257 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9258 (pwd1 (file-name-as-directory (abbreviate-file-name
9259 (expand-file-name ".")))))
9260 (cond
9261 ((equal arg '(16))
9262 (setq link (org-make-link
9263 "file:"
9264 (abbreviate-file-name (expand-file-name file)))))
9266 (setq link (org-make-link "file:" (match-string 1 file))))
9268 (expand-file-name file))
9269 (setq link (org-make-link
9270 "file:" (match-string 1 (expand-file-name file)))))
9271 (t (setq link (org-make-link "file:" file)))))
9272 link))
9274 (defun org-completing-read (&rest args)
9275 "Completing-read with SPACE being a normal character."
9276 (let ((enable-recursive-minibuffers t)
9277 (minibuffer-local-completion-map
9278 (copy-keymap minibuffer-local-completion-map)))
9279 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9280 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9281 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9282 (apply 'org-icompleting-read args)))
9284 (defun org-completing-read-no-i (&rest args)
9285 (let (org-completion-use-ido org-completion-use-iswitchb)
9286 (apply 'org-completing-read args)))
9288 (defun org-iswitchb-completing-read (prompt choices &rest args)
9289 "Use iswitch as a completing-read replacement to choose from choices.
9290 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9291 from."
9292 (let* ((iswitchb-use-virtual-buffers nil)
9293 (iswitchb-make-buflist-hook
9294 (lambda ()
9295 (setq iswitchb-temp-buflist choices))))
9296 (iswitchb-read-buffer prompt)))
9298 (defun org-icompleting-read (&rest args)
9299 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9300 (org-without-partial-completion
9301 (if (and org-completion-use-ido
9302 (fboundp 'ido-completing-read)
9303 (boundp 'ido-mode) ido-mode
9304 (listp (second args)))
9305 (let ((ido-enter-matching-directory nil))
9306 (apply 'ido-completing-read (concat (car args))
9307 (if (consp (car (nth 1 args)))
9308 (mapcar 'car (nth 1 args))
9309 (nth 1 args))
9310 (cddr args)))
9311 (if (and org-completion-use-iswitchb
9312 (boundp 'iswitchb-mode) iswitchb-mode
9313 (listp (second args)))
9314 (apply 'org-iswitchb-completing-read (concat (car args))
9315 (if (consp (car (nth 1 args)))
9316 (mapcar 'car (nth 1 args))
9317 (nth 1 args))
9318 (cddr args))
9319 (apply 'completing-read args)))))
9321 (defun org-extract-attributes (s)
9322 "Extract the attributes cookie from a string and set as text property."
9323 (let (a attr (start 0) key value)
9324 (save-match-data
9326 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9328 (setq key (match-string 1 a) value (match-string 2 a)
9329 start (match-end 0)
9330 attr (plist-put attr (intern key) value))))
9331 (org-add-props s nil 'org-attr attr))
9332 s))
9334 (defun org-extract-attributes-from-string (tag)
9335 (let (key value attr)
9337 (setq key (match-string 1 tag) value (match-string 2 tag)
9338 tag (replace-match "" t t tag)
9339 attr (plist-put attr (intern key) value)))
9340 (cons tag attr)))
9342 (defun org-attributes-to-string (plist)
9343 "Format a property list into an HTML attribute list."
9344 (let ((s "") key value)
9345 (while plist
9346 (setq key (pop plist) value (pop plist))
9347 (and value
9349 s))
9351 ;;; Opening/following a link
9353 (defvar org-link-search-failed nil)
9355 (defvar org-open-link-functions nil
9356 "Hook for functions finding a plain text link.
9357 These functions must take a single argument, the link content.
9358 They will be called for links that look like [[link text][description]]
9362 These functions will be called *before* Org attempts to resolve the
9363 link by doing text searches in the current buffer - so if you want a
9365 handle this as a special case.
9367 When the function does handle the link, it must return a non-nil value.
9368 If it decides that it is not responsible for this link, it must return
9369 nil to indicate that that Org-mode can continue with other options
9370 like exact and fuzzy text search.")
9372 (defun org-next-link ()
9373 "Move forward to the next link.
9374 If the link is in hidden text, expose it."
9375 (interactive)
9376 (when (and org-link-search-failed (eq this-command last-command))
9377 (goto-char (point-min))
9378 (message "Link search wrapped back to beginning of buffer"))
9379 (setq org-link-search-failed nil)
9380 (let* ((pos (point))
9381 (ct (org-context))
9382 (a (assoc :link ct)))
9383 (if a (goto-char (nth 2 a)))
9384 (if (re-search-forward org-any-link-re nil t)
9385 (progn
9386 (goto-char (match-beginning 0))
9387 (if (outline-invisible-p) (org-show-context)))
9388 (goto-char pos)
9389 (setq org-link-search-failed t)
9390 (error "No further link found"))))
9392 (defun org-previous-link ()
9393 "Move backward to the previous link.
9394 If the link is in hidden text, expose it."
9395 (interactive)
9396 (when (and org-link-search-failed (eq this-command last-command))
9397 (goto-char (point-max))
9398 (message "Link search wrapped back to end of buffer"))
9399 (setq org-link-search-failed nil)
9400 (let* ((pos (point))
9401 (ct (org-context))
9402 (a (assoc :link ct)))
9403 (if a (goto-char (nth 1 a)))
9404 (if (re-search-backward org-any-link-re nil t)
9405 (progn
9406 (goto-char (match-beginning 0))
9407 (if (outline-invisible-p) (org-show-context)))
9408 (goto-char pos)
9409 (setq org-link-search-failed t)
9410 (error "No further link found"))))
9412 (defun org-translate-link (s)
9413 "Translate a link string if a translation function has been defined."
9414 (if (and org-link-translation-function
9415 (fboundp org-link-translation-function)
9417 (progn
9418 (setq s (funcall org-link-translation-function
9419 (match-string 1) (match-string 2)))
9420 (concat (car s) ":" (cdr s)))
9421 s))
9423 (defun org-translate-link-from-planner (type path)
9424 "Translate a link from Emacs Planner syntax so that Org can follow it.
9425 This is still an experimental function, your mileage may vary."
9426 (cond
9427 ((member type '("http" "https" "news" "ftp"))
9428 ;; standard Internet links are the same.
9429 nil)
9430 ((and (equal type "irc") (string-match "^//" path))
9431 ;; Planner has two / at the beginning of an irc link, we have 1.
9432 ;; We should have zero, actually....
9433 (setq path (substring path 1)))
9434 ((and (equal type "lisp") (string-match "^/" path))
9435 ;; Planner has a slash, we do not.
9436 (setq type "elisp" path (substring path 1)))
9438 ;; A typical message link. Planner has the id after the final slash,
9439 ;; we separate it with a hash mark
9440 (setq path (concat (match-string 1 path) "#"
9441 (org-remove-angle-brackets (match-string 2 path)))))
9442 )
9443 (cons type path))
9445 (defun org-find-file-at-mouse (ev)
9446 "Open file link or URL at mouse."
9447 (interactive "e")
9448 (mouse-set-point ev)
9449 (org-open-at-point 'in-emacs))
9451 (defun org-open-at-mouse (ev)
9452 "Open file link or URL at mouse.
9453 See the docstring of `org-open-file' for details."
9454 (interactive "e")
9455 (mouse-set-point ev)
9456 (if (eq major-mode 'org-agenda-mode)
9457 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9458 (org-open-at-point))
9460 (defvar org-window-config-before-follow-link nil
9461 "The window configuration before following a link.
9462 This is saved in case the need arises to restore it.")
9464 (defvar org-open-link-marker (make-marker)
9465 "Marker pointing to the location where `org-open-at-point; was called.")
9467 ;;;###autoload
9468 (defun org-open-at-point-global ()
9469 "Follow a link like Org-mode does.
9470 This command can be called in any mode to follow a link that has
9471 Org-mode syntax."
9472 (interactive)
9473 (org-run-like-in-org-mode 'org-open-at-point))
9475 ;;;###autoload
9476 (defun org-open-link-from-string (s &optional arg reference-buffer)
9477 "Open a link in the string S, as if it was in Org-mode."
9479 (let ((reference-buffer (or reference-buffer (current-buffer))))
9480 (with-temp-buffer
9481 (let ((org-inhibit-startup (not reference-buffer)))
9482 (org-mode)
9483 (insert s)
9484 (goto-char (point-min))
9485 (when reference-buffer
9486 (setq org-link-abbrev-alist-local
9487 (with-current-buffer reference-buffer
9488 org-link-abbrev-alist-local)))
9489 (org-open-at-point arg reference-buffer)))))
9491 (defvar org-open-at-point-functions nil
9492 "Hook that is run when following a link at point.
9494 Functions in this hook must return t if they identify and follow
9495 a link at point. If they don't find anything interesting at point,
9496 they must return nil.")
9498 (defun org-open-at-point (&optional arg reference-buffer)
9499 "Open link at or after point.
9500 If there is no link at point, this function will search forward up to
9501 the end of the current line.
9502 Normally, files will be opened by an appropriate application. If the
9503 optional prefix argument ARG is non-nil, Emacs will visit the file.
9504 With a double prefix argument, try to open outside of Emacs, in the
9505 application the system uses for this file type."
9506 (interactive "P")
9507 ;; if in a code block, then open the block's results
9508 (unless (call-interactively #'org-babel-open-src-block-result)
9509 (org-load-modules-maybe)
9510 (move-marker org-open-link-marker (point))
9511 (setq org-window-config-before-follow-link (current-window-configuration))
9512 (org-remove-occur-highlights nil nil t)
9513 (cond
9514 ((and (org-at-heading-p)
9515 (not (org-in-regexp
9520 (not (get-text-property (point) 'org-linked-text)))
9521 (or (org-offer-links-in-entry arg)
9522 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9523 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9524 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9525 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9526 (not (org-in-regexp org-bracket-link-regexp)))
9527 (org-footnote-action))
9528 (t
9529 (let (type path link line search (pos (point)))
9530 (catch 'match
9531 (save-excursion
9533 (when (org-in-regexp org-bracket-link-regexp 1)
9534 (setq link (org-extract-attributes
9535 (org-link-unescape (org-match-string-no-properties 1))))
9537 (setq link (replace-match " " t t link)))
9538 (setq link (org-link-expand-abbrev link))
9539 (cond
9540 ((or (file-name-absolute-p link)
9542 (setq type "file" path link))
9543 ((string-match org-link-re-with-space3 link)
9544 (setq type (match-string 1 link) path (match-string 2 link)))
9545 (t (setq type "thisfile" path link)))
9546 (throw 'match t)))
9548 (when (get-text-property (point) 'org-linked-text)
9549 (setq type "thisfile"
9550 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9551 (1+ (point)) (point))
9552 path (buffer-substring
9553 (or (previous-single-property-change pos 'org-linked-text)
9554 (point-min))
9555 (or (next-single-property-change pos 'org-linked-text)
9556 (point-max))))
9557 (throw 'match t))
9559 (save-excursion
9560 (when (or (org-in-regexp org-angle-link-re)
9561 (org-in-regexp org-plain-link-re))
9562 (setq type (match-string 1)
9563 path (org-link-unescape (match-string 2)))
9564 (throw 'match t)))
9565 (save-excursion
9567 (setq type "tags"
9568 path (match-string 1))
9569 (while (string-match ":" path)
9570 (setq path (replace-match "+" t t path)))
9571 (throw 'match t)))
9573 (setq type "tree-match"
9574 path (match-string 1))
9575 (throw 'match t)))
9576 (unless path
9577 (error "No link found"))
9579 ;; switch back to reference buffer
9580 ;; needed when if called in a temporary buffer through
9581 ;; org-open-link-from-string
9582 (with-current-buffer (or reference-buffer (current-buffer))
9584 ;; Remove any trailing spaces in path
9586 (setq path (replace-match "" t t path)))
9587 (if (and org-link-translation-function
9588 (fboundp org-link-translation-function))
9589 ;; Check if we need to translate the link
9590 (let ((tmp (funcall org-link-translation-function type path)))
9591 (setq type (car tmp) path (cdr tmp))))
9593 (cond
9595 ((assoc type org-link-protocols)
9596 (funcall (nth 1 (assoc type org-link-protocols)) path))
9598 ((equal type "mailto")
9599 (let ((cmd (car org-link-mailto-program))
9600 (args (cdr org-link-mailto-program)) args1
9601 (address path) (subject "") a)
9603 (setq address (match-string 1 path)
9604 subject (org-link-escape (match-string 2 path))))
9605 (while args
9606 (cond
9607 ((not (stringp (car args))) (push (pop args) args1))
9608 (t (setq a (pop args))
9609 (if (string-match "%a" a)
9610 (setq a (replace-match address t t a)))
9611 (if (string-match "%s" a)
9612 (setq a (replace-match subject t t a)))
9613 (push a args1))))
9614 (apply cmd (nreverse args1))))
9616 ((member type '("http" "https" "ftp" "news"))
9617 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9618 (org-link-escape
9619 path org-link-escape-chars-browser)
9620 path))))
9622 ((string= type "doi")
9623 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9624 (org-link-escape
9625 path org-link-escape-chars-browser)
9626 path))))
9628 ((member type '("message"))
9629 (browse-url (concat type ":" path)))
9631 ((string= type "tags")
9632 (org-tags-view arg path))
9634 ((string= type "tree-match")
9637 ((string= type "file")
9639 (setq line (string-to-number (match-string 1 path))
9640 path (substring path 0 (match-beginning 0)))
9642 (setq search (match-string 1 path)
9643 path (substring path 0 (match-beginning 0)))))
9644 (if (string-match "[*?{]" (file-name-nondirectory path))
9645 (dired path)
9646 (org-open-file path arg line search)))
9648 ((string= type "shell")
9649 (let ((cmd path))
9650 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9651 (string-match org-confirm-shell-link-not-regexp cmd))
9652 (not org-confirm-shell-link-function)
9653 (funcall org-confirm-shell-link-function
9655 (org-add-props cmd nil
9656 'face 'org-warning))))
9657 (progn
9658 (message "Executing %s" cmd)
9659 (shell-command cmd))
9660 (error "Abort"))))
9662 ((string= type "elisp")
9663 (let ((cmd path))
9664 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9665 (string-match org-confirm-elisp-link-not-regexp cmd))
9666 (not org-confirm-elisp-link-function)
9667 (funcall org-confirm-elisp-link-function
9669 (org-add-props cmd nil
9670 'face 'org-warning))))
9671 (message "%s => %s" cmd
9672 (if (equal (string-to-char cmd) ?\()
9673 (eval (read cmd))
9674 (call-interactively (read cmd))))
9675 (error "Abort"))))
9677 ((and (string= type "thisfile")
9678 (run-hook-with-args-until-success
9679 'org-open-link-functions path)))
9681 ((string= type "thisfile")
9682 (if arg
9683 (switch-to-buffer-other-window
9684 (org-get-buffer-for-internal-link (current-buffer)))
9685 (org-mark-ring-push))
9686 (let ((cmd `(org-link-search
9687 ,path
9688 ,(cond ((equal arg '(4)) ''occur)
9689 ((equal arg '(16)) ''org-occur)
9690 (t nil))
9691 ,pos)))
9692 (condition-case nil (let ((org-link-search-inhibit-query t))
9693 (eval cmd))
9694 (error (progn (widen) (eval cmd))))))
9696 (t
9697 (browse-url-at-point)))))))
9698 (move-marker org-open-link-marker nil)
9699 (run-hook-with-args 'org-follow-link-hook)))
9701 (defun org-offer-links-in-entry (&optional nth zero)
9702 "Offer links in the current entry and follow the selected link.
9703 If there is only one link, follow it immediately as well.
9704 If NTH is an integer, immediately pick the NTH link found.
9705 If ZERO is a string, check also this string for a link, and if
9706 there is one, offer it as link number zero."
9710 (cnt ?0)
9711 (in-emacs (if (integerp nth) nil nth))
9712 have-zero end links link c)
9713 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9714 (push (match-string 0 zero) links)
9715 (setq cnt (1- cnt) have-zero t))
9716 (save-excursion
9717 (org-back-to-heading t)
9718 (setq end (save-excursion (outline-next-heading) (point)))
9719 (while (re-search-forward re end t)
9720 (push (match-string 0) links))
9721 (setq links (org-uniquify (reverse links))))
9723 (cond
9724 ((null links)
9725 (message "No links"))
9726 ((equal (length links) 1)
9727 (setq link (list (car links))))
9728 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9729 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9730 (t ; we have to select a link
9731 (save-excursion
9732 (save-window-excursion
9733 (delete-other-windows)
9734 (with-output-to-temp-buffer "*Select Link*"
9735 (mapc (lambda (l)
9736 (if (not (string-match org-bracket-link-regexp l))
9738 (org-remove-angle-brackets l)))
9739 (if (match-end 3)
9741 (match-string 3 l) (match-string 1 l)))
9743 (match-string 1 l))))))
9744 links))
9745 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9746 (message "Select link to open, RET to open all:")
9747 (setq c (read-char-exclusive))
9748 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9749 (when (equal c ?q) (error "Abort"))
9750 (if (equal c ?\C-m)
9751 (setq link links)
9752 (setq nth (- c ?0))
9753 (if have-zero (setq nth (1+ nth)))
9754 (unless (and (integerp nth) (>= (length links) nth))
9755 (error "Invalid link selection"))
9756 (setq link (list (nth (1- nth) links))))))
9757 (if link
9758 (let ((buf (current-buffer)))
9759 (dolist (l link)
9760 (org-open-link-from-string l in-emacs buf))
9761 t)
9762 nil)))
9764 ;; Add special file links that specify the way of opening
9766 (org-add-link-type "file+sys" 'org-open-file-with-system)
9767 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9768 (defun org-open-file-with-system (path)
9769 "Open file at PATH using the system way of opening it."
9770 (org-open-file path 'system))
9771 (defun org-open-file-with-emacs (path)
9772 "Open file at PATH in Emacs."
9773 (org-open-file path 'emacs))
9774 (defun org-remove-file-link-modifiers ()
9775 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9776 (goto-char (point-min))
9778 (org-if-unprotected
9779 (replace-match "file:" t t))))
9780 (eval-after-load "org-exp"
9781 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9782 'org-remove-file-link-modifiers))
9784 ;;;; Time estimates
9786 (defun org-get-effort (&optional pom)
9787 "Get the effort estimate for the current entry."
9788 (org-entry-get pom org-effort-property))
9790 ;;; File search
9792 (defvar org-create-file-search-functions nil
9793 "List of functions to construct the right search string for a file link.
9794 These functions are called in turn with point at the location to
9795 which the link should point.
9797 A function in the hook should first test if it would like to
9798 handle this file type, for example by checking the `major-mode'
9799 or the file extension. If it decides not to handle this file, it
9800 should just return nil to give other functions a chance. If it
9801 does handle the file, it must return the search string to be used
9802 when following the link. The search string will be part of the
9803 file link, given after a double colon, and `org-open-at-point'
9804 will automatically search for it. If special measures must be
9805 taken to make the search successful, another function should be
9806 added to the companion hook `org-execute-file-search-functions',
9807 which see.
9809 A function in this hook may also use `setq' to set the variable
9810 `description' to provide a suggestion for the descriptive text to
9811 be used for this link when it gets inserted into an Org-mode
9814 (defvar org-execute-file-search-functions nil
9815 "List of functions to execute a file search triggered by a link.
9817 Functions added to this hook must accept a single argument, the
9818 search string that was part of the file link, the part after the
9819 double colon. The function must first check if it would like to
9820 handle this search, for example by checking the `major-mode' or
9821 the file extension. If it decides not to handle this search, it
9822 should just return nil to give other functions a chance. If it
9823 does handle the search, it must return a non-nil value to keep
9824 other functions from trying.
9826 Each function can access the current prefix argument through the
9827 variable `current-prefix-argument'. Note that a single prefix is
9828 used to force opening a link in Emacs, so it may be good to only
9829 use a numeric or double prefix to guide the search function.
9831 In case this is needed, a function in this hook can also restore
9832 the window configuration before `org-open-at-point' was called using:
9834 (set-window-configuration org-window-config-before-follow-link)")
9836 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9837 (defun org-link-search (s &optional type avoid-pos stealth)
9838 "Search for a link search option.
9839 If S is surrounded by forward slashes, it is interpreted as a
9840 regular expression. In org-mode files, this will create an `org-occur'
9841 sparse tree. In ordinary files, `occur' will be used to list matches.
9842 If the current buffer is in `dired-mode', grep will be used to search
9843 in all files. If AVOID-POS is given, ignore matches near that position.
9845 When optional argument STEALTH is non-nil, do not modify
9846 visibility around point, thus ignoring
9847 `org-show-hierarchy-above', `org-show-following-heading' and
9848 `org-show-siblings' variables."
9849 (let ((case-fold-search t)
9853 org-emphasis-alist)
9855 (pos (point))
9856 (pre nil) (post nil)
9857 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9858 (cond
9859 ;; First check if there are any special search functions
9860 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9861 ;; Now try the builtin stuff
9862 ((and (equal (string-to-char s0) ?#)
9863 (> (length s0) 1)
9864 (save-excursion
9865 (goto-char (point-min))
9866 (and
9867 (re-search-forward
9869 (setq type 'dedicated
9870 pos (match-beginning 0))))
9871 ;; There is an exact target for this
9872 (goto-char pos)
9873 (org-back-to-heading t)))
9874 ((save-excursion
9875 (goto-char (point-min))
9876 (and
9877 (re-search-forward
9878 (concat "<<" (regexp-quote s0) ">>") nil t)
9879 (setq type 'dedicated
9880 pos (match-beginning 0))))
9881 ;; There is an exact target for this
9882 (goto-char pos))
9884 (save-excursion
9885 (goto-char (point-min))
9886 (and
9887 (re-search-forward
9888 (concat "[^[]" (regexp-quote
9889 (format org-coderef-label-format
9890 (match-string 1 s0))))
9891 nil t)
9892 (setq type 'dedicated
9893 pos (1+ (match-beginning 0))))))
9894 ;; There is a coderef target for this
9895 (goto-char pos))
9897 ;; A regular expression
9898 (cond
9899 ((eq major-mode 'org-mode)
9900 (org-occur (match-string 1 s)))
9901 ;;((eq major-mode 'dired-mode)
9902 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9903 (t (org-do-occur (match-string 1 s)))))
9904 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9905 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9906 (goto-char (point-min))
9907 (cond
9908 ((let (case-fold-search)
9909 (re-search-forward (format org-complex-heading-regexp-format
9910 (regexp-quote s))
9911 nil t))
9912 ;; OK, found a match
9913 (setq type 'dedicated)
9914 (goto-char (match-beginning 0)))
9915 ((and (not org-link-search-inhibit-query)
9916 (eq org-link-search-must-match-exact-headline 'query-to-create)
9917 (y-or-n-p "No match - create this as a new heading? "))
9918 (goto-char (point-max))
9919 (or (bolp) (newline))
9921 (beginning-of-line 0))
9922 (t
9923 (goto-char pos)
9924 (error "No match"))))
9925 (t
9926 ;; A normal search string
9927 (when (equal (string-to-char s) ?*)
9928 ;; Anchor on headlines, post may include tags.
9931 s (substring s 1)))
9932 (remove-text-properties
9933 0 (length s)
9934 '(face nil mouse-face nil keymap nil fontified nil) s)
9935 ;; Make a series of regular expressions to find a match
9944 re4 (concat "[^a-zA-Z_]" re4_)
9946 re1 (concat pre re2 post)
9947 re3 (concat pre (if pre re4_ re4) post)
9948 re5 (concat pre ".*" re4)
9949 re2 (concat pre re2)
9950 re2a (concat pre (if pre re2a_ re2a))
9951 re4 (concat pre (if pre re4_ re4))
9955 ))
9956 (cond
9957 ((eq type 'org-occur) (org-occur reall))
9958 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9959 (t (goto-char (point-min))
9960 (setq type 'fuzzy)
9961 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9962 (org-search-not-self 1 re1 nil t)
9963 (org-search-not-self 1 re2 nil t)
9964 (org-search-not-self 1 re2a nil t)
9965 (org-search-not-self 1 re3 nil t)
9966 (org-search-not-self 1 re4 nil t)
9967 (org-search-not-self 1 re5 nil t)
9968 )
9969 (goto-char (match-beginning 1))
9970 (goto-char pos)
9971 (error "No match"))))))
9972 (and (eq major-mode 'org-mode)
9973 (not stealth)
9974 (org-show-context 'link-search))
9975 type))
9977 (defun org-search-not-self (group &rest args)
9978 "Execute `re-search-forward', but only accept matches that do not
9979 enclose the position of `org-open-link-marker'."
9980 (let ((m org-open-link-marker))
9981 (catch 'exit
9982 (while (apply 're-search-forward args)
9983 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9984 (goto-char (match-end group))
9985 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9986 (> (match-beginning 0) (marker-position m))
9987 (< (match-end 0) (marker-position m)))
9988 (save-match-data
9989 (or (not (org-in-regexp
9990 org-bracket-link-analytic-regexp 1))
9991 (not (match-end 4)) ; no description
9992 (and (<= (match-beginning 4) (point))
9993 (>= (match-end 4) (point))))))
9994 (throw 'exit (point))))))))
9996 (defun org-get-buffer-for-internal-link (buffer)
9997 "Return a buffer to be used for displaying the link target of internal links."
9998 (cond
9999 ((not org-display-internal-link-with-indirect-buffer)
10000 buffer)
10001 ((string-match "(Clone)$" (buffer-name buffer))
10002 (message "Buffer is already a clone, not making another one")
10003 ;; we also do not modify visibility in this case
10004 buffer)
10005 (t ; make a new indirect buffer for displaying the link
10006 (let* ((bn (buffer-name buffer))
10007 (ibn (concat bn "(Clone)"))
10008 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10009 (with-current-buffer ib (org-overview))
10010 ib))))
10012 (defun org-do-occur (regexp &optional cleanup)
10013 "Call the Emacs command `occur'.
10014 If CLEANUP is non-nil, remove the printout of the regular expression
10015 in the *Occur* buffer. This is useful if the regex is long and not useful
10016 to read."
10017 (occur regexp)
10018 (when cleanup
10019 (let ((cwin (selected-window)) win beg end)
10020 (when (setq win (get-buffer-window "*Occur*"))
10021 (select-window win))
10022 (goto-char (point-min))
10023 (when (re-search-forward "match[a-z]+" nil t)
10024 (setq beg (match-end 0))
10026 (setq end (1- (match-beginning 0)))))
10027 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10028 (goto-char (point-min))
10029 (select-window cwin))))
10031 ;;; The mark ring for links jumps
10033 (defvar org-mark-ring nil
10034 "Mark ring for positions before jumps in Org-mode.")
10035 (defvar org-mark-ring-last-goto nil
10036 "Last position in the mark ring used to go back.")
10037 ;; Fill and close the ring
10038 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10039 (loop for i from 1 to org-mark-ring-length do
10040 (push (make-marker) org-mark-ring))
10041 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10042 org-mark-ring)
10044 (defun org-mark-ring-push (&optional pos buffer)
10045 "Put the current position or POS into the mark ring and rotate it."
10046 (interactive)
10047 (setq pos (or pos (point)))
10048 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10049 (move-marker (car org-mark-ring)
10050 (or pos (point))
10051 (or buffer (current-buffer)))
10052 (message "%s"
10053 (substitute-command-keys
10056 (defun org-mark-ring-goto (&optional n)
10057 "Jump to the previous position in the mark ring.
10058 With prefix arg N, jump back that many stored positions. When
10059 called several times in succession, walk through the entire ring.
10060 Org-mode commands jumping to a different position in the current file,
10061 or to another Org-mode file, automatically push the old position
10062 onto the ring."
10063 (interactive "p")
10064 (let (p m)
10065 (if (eq last-command this-command)
10066 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10067 (setq p org-mark-ring))
10068 (setq org-mark-ring-last-goto p)
10069 (setq m (car p))
10070 (org-pop-to-buffer-same-window (marker-buffer m))
10071 (goto-char m)
10072 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10074 (defun org-remove-angle-brackets (s)
10075 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10076 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10077 s)
10078 (defun org-add-angle-brackets (s)
10079 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10080 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10081 s)
10082 (defun org-remove-double-quotes (s)
10085 s)
10087 ;;; Following specific links
10089 (defun org-follow-timestamp-link ()
10090 (cond
10091 ((org-at-date-range-p t)
10092 (let ((org-agenda-start-on-weekday)
10093 (t1 (match-string 1))
10094 (t2 (match-string 2)))
10095 (setq t1 (time-to-days (org-time-string-to-time t1))
10096 t2 (time-to-days (org-time-string-to-time t2)))
10097 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10098 ((org-at-timestamp-p t)
10099 (org-agenda-list nil (time-to-days (org-time-string-to-time
10100 (substring (match-string 1) 0 10)))
10101 1))
10102 (t (error "This should not happen"))))
10105 ;;; Following file links
10106 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10107 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10108 (declare-function mailcap-mime-info
10109 "mailcap" (string &optional request no-decode))
10110 (defvar org-wait nil)
10111 (defun org-open-file (path &optional in-emacs line search)
10112 "Open the file at PATH.
10113 First, this expands any special file name abbreviations. Then the
10114 configuration variable `org-file-apps' is checked if it contains an
10115 entry for this file type, and if yes, the corresponding command is launched.
10117 If no application is found, Emacs simply visits the file.
10119 With optional prefix argument IN-EMACS, Emacs will visit the file.
10121 prefix arg, Org tries to avoid opening in Emacs
10122 and to use an external application to visit the file.
10124 Optional LINE specifies a line to go to, optional SEARCH a string
10125 to search for. If LINE or SEARCH is given, the file will be
10126 opened in Emacs, unless an entry from org-file-apps that makes
10127 use of groups in a regexp matches.
10129 If you want to change the way frames are used when following a
10130 link, please customize `org-link-frame-setup'.
10132 If the file does not exist, an error is thrown."
10133 (let* ((file (if (equal path "")
10134 buffer-file-name
10135 (substitute-in-file-name (expand-file-name path))))
10136 (file-apps (append org-file-apps (org-default-apps)))
10137 (apps (org-remove-if
10138 'org-file-apps-entry-match-against-dlink-p file-apps))
10139 (apps-dlink (org-remove-if-not
10140 'org-file-apps-entry-match-against-dlink-p file-apps))
10141 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10142 (dirp (if remp nil (file-directory-p file)))
10143 (file (if (and dirp org-open-directory-means-index-dot-org)
10144 (concat (file-name-as-directory file) "index.org")
10145 file))
10146 (a-m-a-p (assq 'auto-mode apps))
10147 (dfile (downcase file))
10148 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10149 (link (cond ((and (eq line nil)
10150 (eq search nil))
10151 file)
10152 (line
10153 (concat file "::" (number-to-string line)))
10154 (search
10155 (concat file "::" search))))
10156 (dlink (downcase link))
10157 (old-buffer (current-buffer))
10158 (old-pos (point))
10159 (old-mode major-mode)
10160 ext cmd link-match-data)
10162 (setq ext (match-string 1 dfile))
10164 (setq ext (match-string 1 dfile))))
10165 (cond
10166 ((member in-emacs '((16) system))
10167 (setq cmd (cdr (assoc 'system apps))))
10168 (in-emacs (setq cmd 'emacs))
10169 (t
10170 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10171 (and dirp (cdr (assoc 'directory apps)))
10172 ; first, try matching against apps-dlink
10173 ; if we get a match here, store the match data for later
10174 (let ((match (assoc-default dlink apps-dlink
10175 'string-match)))
10176 (if match
10177 (progn (setq link-match-data (match-data))
10178 match)
10179 (progn (setq in-emacs (or in-emacs line search))
10180 nil))) ; if we have no match in apps-dlink,
10181 ; always open the file in emacs if line or search
10182 ; is given (for backwards compatibility)
10183 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10184 'string-match)
10185 (cdr (assoc ext apps))
10186 (cdr (assoc t apps))))))
10187 (when (eq cmd 'system)
10188 (setq cmd (cdr (assoc 'system apps))))
10189 (when (eq cmd 'default)
10190 (setq cmd (cdr (assoc t apps))))
10191 (when (eq cmd 'mailcap)
10192 (require 'mailcap)
10193 (mailcap-parse-mailcaps)
10194 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10195 (command (mailcap-mime-info mime-type)))
10196 (if (stringp command)
10197 (setq cmd command)
10198 (setq cmd 'emacs))))
10199 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10200 (not (file-exists-p file))
10201 (not org-open-non-existing-files))
10202 (error "No such file: %s" file))
10203 (cond
10205 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10207 (setq cmd (replace-match "%s" t t cmd)))
10208 (while (string-match "%s" cmd)
10209 (setq cmd (replace-match
10210 (save-match-data
10211 (shell-quote-argument
10212 (convert-standard-filename file)))
10213 t t cmd)))
10215 ;; Replace "%1", "%2" etc. in command with group matches from regex
10216 (save-match-data
10217 (let ((match-index 1)
10218 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10219 (set-match-data link-match-data)
10220 (while (<= match-index number-of-groups)
10221 (let ((regex (concat "%" (number-to-string match-index)))
10222 (replace-with (match-string match-index dlink)))
10223 (while (string-match regex cmd)
10224 (setq cmd (replace-match replace-with t t cmd))))
10225 (setq match-index (+ match-index 1)))))
10227 (save-window-excursion
10228 (start-process-shell-command cmd nil cmd)
10229 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10230 ))
10231 ((or (stringp cmd)
10232 (eq cmd 'emacs))
10233 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10234 (widen)
10235 (if line (org-goto-line line)
10236 (if search (org-link-search search))))
10237 ((consp cmd)
10238 (let ((file (convert-standard-filename file)))
10239 (save-match-data
10240 (set-match-data link-match-data)
10241 (eval cmd))))
10242 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10243 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10244 (or (not (equal old-buffer (current-buffer)))
10245 (not (equal old-pos (point))))
10246 (org-mark-ring-push old-pos old-buffer))))
10248 (defun org-file-apps-entry-match-against-dlink-p (entry)
10249 "This function returns non-nil if `entry' uses a regular
10250 expression which should be matched against the whole link by
10251 org-open-file.
10253 It assumes that is the case when the entry uses a regular
10254 expression which has at least one grouping construct and the
10255 action is either a lisp form or a command string containing
10256 '%1', i.e. using at least one subexpression match as a
10257 parameter."
10258 (let ((selector (car entry))
10259 (action (cdr entry)))
10260 (if (stringp selector)
10261 (and (> (regexp-opt-depth selector) 0)
10262 (or (and (stringp action)
10263 (string-match "%[0-9]" action))
10264 (consp action)))
10265 nil)))
10267 (defun org-default-apps ()
10268 "Return the default applications for this operating system."
10269 (cond
10270 ((eq system-type 'darwin)
10271 org-file-apps-defaults-macosx)
10272 ((eq system-type 'windows-nt)
10273 org-file-apps-defaults-windowsnt)
10274 (t org-file-apps-defaults-gnu)))
10276 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10277 "Convert extensions to regular expressions in the cars of LIST.
10278 Also, weed out any non-string entries, because the return value is used
10279 only for regexp matching.
10280 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10281 point to the symbol `emacs', indicating that the file should
10282 be opened in Emacs."
10283 (append
10284 (delq nil
10285 (mapcar (lambda (x)
10286 (if (not (stringp (car x)))
10287 nil
10289 x
10291 list))
10292 (if add-auto-mode
10293 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10295 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10296 (defun org-file-remote-p (file)
10297 "Test whether FILE specifies a location on a remote system.
10298 Return non-nil if the location is indeed remote.
10302 (cond ((fboundp 'file-remote-p)
10303 (file-remote-p file))
10304 ((fboundp 'tramp-handle-file-remote-p)
10305 (tramp-handle-file-remote-p file))
10306 ((and (boundp 'ange-ftp-name-format)
10307 (string-match (car ange-ftp-name-format) file))
10308 t)
10309 (t nil)))
10312 ;;;; Refiling
10314 (defun org-get-org-file ()
10315 "Read a filename, with default directory `org-directory'."
10316 (let ((default (or org-default-notes-file remember-data-file)))
10317 (read-file-name (format "File name [%s]: " default)
10318 (file-name-as-directory org-directory)
10319 default)))
10321 (defun org-notes-order-reversed-p ()
10322 "Check if the current file should receive notes in reversed order."
10323 (cond
10324 ((not org-reverse-note-order) nil)
10325 ((eq t org-reverse-note-order) t)
10326 ((not (listp org-reverse-note-order)) nil)
10327 (t (catch 'exit
10328 (let ((all org-reverse-note-order)
10329 entry)
10330 (while (setq entry (pop all))
10331 (if (string-match (car entry) buffer-file-name)
10332 (throw 'exit (cdr entry))))
10333 nil)))))
10335 (defvar org-refile-target-table nil
10336 "The list of refile targets, created by `org-refile'.")
10338 (defvar org-agenda-new-buffers nil
10339 "Buffers created to visit agenda files.")
10341 (defvar org-refile-cache nil
10342 "Cache for refile targets.")
10344 (defvar org-refile-markers nil
10345 "All the markers used for caching refile locations.")
10347 (defun org-refile-marker (pos)
10348 "Get a new refile marker, but only if caching is in use."
10349 (if (not org-refile-use-cache)
10350 pos
10351 (let ((m (make-marker)))
10352 (move-marker m pos)
10353 (push m org-refile-markers)
10354 m)))
10356 (defun org-refile-cache-clear ()
10357 "Clear the refile cache and disable all the markers."
10358 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10359 (setq org-refile-markers nil)
10360 (setq org-refile-cache nil)
10361 (message "Refile cache has been cleared"))
10363 (defun org-refile-cache-check-set (set)
10364 "Check if all the markers in the cache still have live buffers."
10365 (let (marker)
10366 (catch 'exit
10367 (while (and set (setq marker (nth 3 (pop set))))
10368 ;; if org-refile-use-outline-path is 'file, marker may be nil
10369 (when (and marker (null (marker-buffer marker)))
10370 (message "not found") (sit-for 3)
10371 (throw 'exit nil)))
10372 t)))
10374 (defun org-refile-cache-put (set &rest identifiers)
10375 "Push the refile targets SET into the cache, under IDENTIFIERS."
10376 (let* ((key (sha1 (prin1-to-string identifiers)))
10377 (entry (assoc key org-refile-cache)))
10378 (if entry
10379 (setcdr entry set)
10380 (push (cons key set) org-refile-cache))))
10382 (defun org-refile-cache-get (&rest identifiers)
10383 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10384 (cond
10385 ((not org-refile-cache) nil)
10386 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10387 (t
10388 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10389 org-refile-cache))))
10390 (and set (org-refile-cache-check-set set) set)))))
10392 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10393 "Produce a table with refile targets."
10394 (let ((case-fold-search nil)
10395 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10396 (entries (or org-refile-targets '((nil . (:level . 1)))))
10397 targets tgs txt re files f desc descre fast-path-p level pos0)
10398 (message "Getting targets...")
10399 (with-current-buffer (or default-buffer (current-buffer))
10400 (while (setq entry (pop entries))
10401 (setq files (car entry) desc (cdr entry))
10402 (setq fast-path-p nil)
10403 (cond
10404 ((null files) (setq files (list (current-buffer))))
10405 ((eq files 'org-agenda-files)
10406 (setq files (org-agenda-files 'unrestricted)))
10407 ((and (symbolp files) (fboundp files))
10408 (setq files (funcall files)))
10409 ((and (symbolp files) (boundp files))
10410 (setq files (symbol-value files))))
10411 (if (stringp files) (setq files (list files)))
10412 (cond
10413 ((eq (car desc) :tag)
10415 ((eq (car desc) :todo)
10417 ((eq (car desc) :regexp)
10418 (setq descre (cdr desc)))
10419 ((eq (car desc) :level)
10421 (if org-odd-levels-only
10422 (1- (* 2 (cdr desc)))
10423 (cdr desc)))
10425 ((eq (car desc) :maxlevel)
10426 (setq fast-path-p t)
10428 (if org-odd-levels-only
10429 (1- (* 2 (cdr desc)))
10430 (cdr desc)))
10432 (t (error "Bad refiling target description %s" desc)))
10433 (while (setq f (pop files))
10434 (with-current-buffer
10435 (if (bufferp f) f (org-get-agenda-file-buffer f))
10436 (or
10437 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10438 (progn
10439 (if (bufferp f) (setq f (buffer-file-name
10440 (buffer-base-buffer f))))
10441 (setq f (and f (expand-file-name f)))
10442 (if (eq org-refile-use-outline-path 'file)
10443 (push (list (file-name-nondirectory f) f nil nil) tgs))
10444 (save-excursion
10445 (save-restriction
10446 (widen)
10447 (goto-char (point-min))
10448 (while (re-search-forward descre nil t)
10449 (goto-char (setq pos0 (point-at-bol)))
10450 (catch 'next
10451 (when org-refile-target-verify-function
10452 (save-match-data
10453 (or (funcall org-refile-target-verify-function)
10454 (throw 'next t))))
10455 (when (and (looking-at org-complex-heading-regexp)
10456 (not (member (match-string 4) excluded-entries))
10457 (match-string 4))
10458 (setq level (org-reduced-level
10459 (- (match-end 1) (match-beginning 1)))
10460 txt (org-link-display-format (match-string 4))
10462 re (format org-complex-heading-regexp-format
10463 (regexp-quote (match-string 4))))
10464 (when org-refile-use-outline-path
10465 (setq txt (mapconcat
10466 'org-protect-slash
10467 (append
10468 (if (eq org-refile-use-outline-path
10469 'file)
10470 (list (file-name-nondirectory
10471 (buffer-file-name
10472 (buffer-base-buffer))))
10473 (if (eq org-refile-use-outline-path
10474 'full-file-path)
10475 (list (buffer-file-name
10476 (buffer-base-buffer)))))
10477 (org-get-outline-path fast-path-p
10478 level txt)
10479 (list txt))
10480 "/")))
10481 (push (list txt f re (org-refile-marker (point)))
10482 tgs)))
10483 (when (= (point) pos0)
10484 ;; verification function has not moved point
10485 (goto-char (point-at-eol))))))))
10486 (when org-refile-use-cache
10487 (org-refile-cache-put tgs (buffer-file-name) descre))
10488 (setq targets (append tgs targets))
10489 ))))
10490 (message "Getting targets...done")
10491 (nreverse targets)))
10493 (defun org-protect-slash (s)
10494 (while (string-match "/" s)
10496 s)
10498 (defvar org-olpa (make-vector 20 nil))
10500 (defun org-get-outline-path (&optional fastp level heading)
10501 "Return the outline path to the current entry, as a list.
10503 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10504 routine which makes outline path derivations for an entire file,
10505 avoiding backtracing. Refile target collection makes use of that."
10506 (if fastp
10507 (progn
10508 (if (> level 19)
10509 (error "Outline path failure, more than 19 levels"))
10510 (loop for i from level upto 19 do
10511 (aset org-olpa i nil))
10512 (prog1
10513 (delq nil (append org-olpa nil))
10514 (aset org-olpa level heading)))
10515 (let (rtn case-fold-search)
10516 (save-excursion
10517 (save-restriction
10518 (widen)
10519 (while (org-up-heading-safe)
10520 (when (looking-at org-complex-heading-regexp)
10521 (push (org-match-string-no-properties 4) rtn)))
10522 rtn)))))
10524 (defun org-format-outline-path (path &optional width prefix)
10525 "Format the outline path PATH for display.
10526 Width is the maximum number of characters that is available.
10527 Prefix is a prefix to be included in the returned string,
10528 such as the file name."
10529 (setq width (or width 79))
10530 (if prefix (setq width (- width (length prefix))))
10531 (if (not path)
10532 (or prefix "")
10533 (let* ((nsteps (length path))
10534 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10535 (maxwidth (if (<= total-width width)
10536 10000 ;; everything fits
10537 ;; we need to shorten the level headings
10538 (/ (- width nsteps) nsteps)))
10539 (org-odd-levels-only nil)
10540 (n 0)
10541 (total (1+ (length prefix))))
10542 (setq maxwidth (max maxwidth 10))
10543 (concat prefix
10544 (mapconcat
10545 (lambda (h)
10546 (setq n (1+ n))
10547 (if (and (= n nsteps) (< maxwidth 10000))
10548 (setq maxwidth (- total-width total)))
10549 (if (< (length h) maxwidth)
10550 (progn (setq total (+ total (length h) 1)) h)
10551 (setq h (substring h 0 (- maxwidth 2))
10552 total (+ total maxwidth 1))
10554 (setq h (substring h 0 (match-beginning 0))))
10555 (setq h (concat h "..")))
10556 (org-add-props h nil 'face
10557 (nth (% (1- n) org-n-level-faces)
10558 org-level-faces))
10559 h)
10560 path "/")))))
10562 (defun org-display-outline-path (&optional file current)
10563 "Display the current outline path in the echo area."
10564 (interactive "P")
10565 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10566 (case-fold-search nil)
10567 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10568 (if current (setq path (append path
10569 (save-excursion
10570 (org-back-to-heading t)
10571 (if (looking-at org-complex-heading-regexp)
10572 (list (match-string 4)))))))
10573 (message "%s"
10574 (org-format-outline-path
10575 path
10576 (1- (frame-width))
10577 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10579 (defvar org-refile-history nil
10580 "History for refiling operations.")
10582 (defvar org-after-refile-insert-hook nil
10583 "Hook run after `org-refile' has inserted its stuff at the new location.
10584 Note that this is still *before* the stuff will be removed from
10585 the *old* location.")
10587 (defvar org-capture-last-stored-marker)
10588 (defun org-refile (&optional goto default-buffer rfloc)
10589 "Move the entry or entries at point to another heading.
10590 The list of target headings is compiled using the information in
10591 `org-refile-targets', which see.
10593 At the target location, the entry is filed as a subitem of the target
10594 heading. Depending on `org-reverse-note-order', the new subitem will
10595 either be the first or the last subitem.
10597 If there is an active region, all entries in that region will be moved.
10598 However, the region must fulfill the requirement that the first heading
10599 is the first one sets the top-level of the moved text - at most siblings
10600 below it are allowed.
10602 With prefix arg GOTO, the command will only visit the target location
10603 and not actually move anything.
10606 go to the location where the last refiling operation has put the subtree.
10607 With a prefix argument of `2', refile to the running clock.
10609 RFLOC can be a refile location obtained in a different way.
10611 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10613 If you are using target caching (see `org-refile-use-cache'),
10614 You have to clear the target cache in order to find new targets.
10615 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10616 prefix argument (`C-u C-u C-u C-c C-w')."
10618 (interactive "P")
10619 (if (member goto '(0 (64)))
10620 (org-refile-cache-clear)
10621 (let* ((cbuf (current-buffer))
10622 (regionp (org-region-active-p))
10623 (region-start (and regionp (region-beginning)))
10624 (region-end (and regionp (region-end)))
10625 (region-length (and regionp (- region-end region-start)))
10626 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10627 pos it nbuf file re level reversed)
10628 (setq last-command nil)
10629 (when regionp
10630 (goto-char region-start)
10631 (or (bolp) (goto-char (point-at-bol)))
10632 (setq region-start (point))
10633 (unless (or (org-kill-is-subtree-p
10634 (buffer-substring region-start region-end))
10635 (prog1 org-refile-active-region-within-subtree
10636 (org-toggle-heading)))
10637 (error "The region is not a (sequence of) subtree(s)")))
10638 (if (equal goto '(16))
10639 (org-refile-goto-last-stored)
10640 (when (or
10641 (and (equal goto 2)
10642 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10643 (prog1
10644 (setq it (list (or org-clock-heading "running clock")
10645 (buffer-file-name
10646 (marker-buffer org-clock-hd-marker))
10647 ""
10648 (marker-position org-clock-hd-marker)))
10649 (setq goto nil)))
10650 (setq it (or rfloc
10651 (let (heading-text)
10652 (save-excursion
10653 (unless goto
10654 (org-back-to-heading t)
10655 (setq heading-text
10656 (nth 4 (org-heading-components))))
10657 (org-refile-get-location
10658 (cond (goto "Goto")
10659 (regionp "Refile region to")
10662 default-buffer
10663 org-refile-allow-creating-parent-nodes
10664 goto))))))
10665 (setq file (nth 1 it)
10666 re (nth 2 it)
10667 pos (nth 3 it))
10668 (if (and (not goto)
10669 pos
10670 (equal (buffer-file-name) file)
10671 (if regionp
10672 (and (>= pos region-start)
10673 (<= pos region-end))
10674 (and (>= pos (point))
10675 (< pos (save-excursion
10676 (org-end-of-subtree t t))))))
10677 (error "Cannot refile to position inside the tree or region"))
10679 (setq nbuf (or (find-buffer-visiting file)
10680 (find-file-noselect file)))
10681 (if goto
10682 (progn
10683 (org-pop-to-buffer-same-window nbuf)
10684 (goto-char pos)
10685 (org-show-context 'org-goto))
10686 (if regionp
10687 (progn
10688 (org-kill-new (buffer-substring region-start region-end))
10689 (org-save-markers-in-region region-start region-end))
10690 (org-copy-subtree 1 nil t))
10691 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10692 (find-file-noselect file)))
10693 (setq reversed (org-notes-order-reversed-p))
10694 (save-excursion
10695 (save-restriction
10696 (widen)
10697 (if pos
10698 (progn
10699 (goto-char pos)
10700 (looking-at org-outline-regexp)
10701 (setq level (org-get-valid-level (funcall outline-level) 1))
10702 (goto-char
10703 (if reversed
10704 (or (outline-next-heading) (point-max))
10705 (or (save-excursion (org-get-next-sibling))
10706 (org-end-of-subtree t t)
10707 (point-max)))))
10708 (setq level 1)
10709 (if (not reversed)
10710 (goto-char (point-max))
10711 (goto-char (point-min))
10712 (or (outline-next-heading) (goto-char (point-max)))))
10713 (if (not (bolp)) (newline))
10714 (org-paste-subtree level)
10715 (when org-log-refile
10716 (org-add-log-setup 'refile nil nil 'findpos
10717 org-log-refile)
10718 (unless (eq org-log-refile 'note)
10719 (save-excursion (org-add-log-note))))
10720 (and org-auto-align-tags (org-set-tags nil t))
10721 (bookmark-set "org-refile-last-stored")
10722 ;; If we are refiling for capture, make sure that the
10723 ;; last-capture pointers point here
10724 (when (org-bound-and-true-p org-refile-for-capture)
10725 (bookmark-set "org-capture-last-stored-marker")
10726 (move-marker org-capture-last-stored-marker (point)))
10727 (if (fboundp 'deactivate-mark) (deactivate-mark))
10728 (run-hooks 'org-after-refile-insert-hook))))
10729 (if regionp
10730 (delete-region (point) (+ (point) region-length))
10731 (org-cut-subtree))
10732 (when (featurep 'org-inlinetask)
10733 (org-inlinetask-remove-END-maybe))
10734 (setq org-markers-to-move nil)
10737 (defun org-refile-goto-last-stored ()
10738 "Go to the location where the last refile was stored."
10739 (interactive)
10740 (bookmark-jump "org-refile-last-stored")
10741 (message "This is the location of the last refile"))
10743 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10744 no-exclude)
10745 "Prompt the user for a refile location, using PROMPT.
10746 PROMPT should not be suffixed with a colon and a space, because
10747 this function appends the default value from
10748 `org-refile-history' automatically, if that is not empty.
10749 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10750 this is used for the GOTO interface."
10751 (let ((org-refile-targets org-refile-targets)
10752 (org-refile-use-outline-path org-refile-use-outline-path)
10753 excluded-entries)
10754 (when (and (eq major-mode 'org-mode)
10755 (not org-refile-use-cache)
10756 (not no-exclude))
10757 (org-map-tree
10758 (lambda()
10759 (setq excluded-entries
10760 (append excluded-entries (list (org-get-heading t t)))))))
10761 (setq org-refile-target-table
10762 (org-refile-get-targets default-buffer excluded-entries)))
10763 (unless org-refile-target-table
10764 (error "No refile targets"))
10765 (let* ((prompt (concat prompt
10766 (and (car org-refile-history)
10767 (concat " (default " (car org-refile-history) ")"))
10768 ": "))
10769 (cbuf (current-buffer))
10770 (partial-completion-mode nil)
10771 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10772 (cfunc (if (and org-refile-use-outline-path
10773 org-outline-path-complete-in-steps)
10774 'org-olpath-completing-read
10775 'org-icompleting-read))
10776 (extra (if org-refile-use-outline-path "/" ""))
10777 (filename (and cfn (expand-file-name cfn)))
10778 (tbl (mapcar
10779 (lambda (x)
10780 (if (and (not (member org-refile-use-outline-path
10781 '(file full-file-path)))
10782 (not (equal filename (nth 1 x))))
10783 (cons (concat (car x) extra " ("
10784 (file-name-nondirectory (nth 1 x)) ")")
10785 (cdr x))
10786 (cons (concat (car x) extra) (cdr x))))
10787 org-refile-target-table))
10788 (completion-ignore-case t)
10789 pa answ parent-target child parent old-hist)
10790 (setq old-hist org-refile-history)
10791 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10792 nil 'org-refile-history (car org-refile-history)))
10793 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10794 (org-refile-check-position pa)
10795 (if pa
10796 (progn
10797 (when (or (not org-refile-history)
10798 (not (eq old-hist org-refile-history))
10799 (not (equal (car pa) (car org-refile-history))))
10800 (setq org-refile-history
10801 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10802 org-refile-history
10803 (cdr org-refile-history))))
10804 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10805 (pop org-refile-history)))
10806 pa)
10808 (progn
10809 (setq parent (match-string 1 answ)
10810 child (match-string 2 answ))
10811 (setq parent-target (or (assoc parent tbl)
10812 (assoc (concat parent "/") tbl)))
10813 (when (and parent-target
10814 (or (eq new-nodes t)
10815 (and (eq new-nodes 'confirm)
10817 child)))))
10818 (org-refile-new-child parent-target child)))
10819 (error "Invalid target location")))))
10821 (defun org-refile-check-position (refile-pointer)
10822 "Check if the refile pointer matches the readline to which it points."
10823 (let* ((file (nth 1 refile-pointer))
10824 (re (nth 2 refile-pointer))
10825 (pos (nth 3 refile-pointer))
10826 buffer)
10827 (when (org-string-nw-p re)
10828 (setq buffer (if (markerp pos)
10829 (marker-buffer pos)
10830 (or (find-buffer-visiting file)
10831 (find-file-noselect file))))
10832 (with-current-buffer buffer
10833 (save-excursion
10834 (save-restriction
10835 (widen)
10836 (goto-char pos)
10837 (beginning-of-line 1)
10838 (unless (org-looking-at-p re)
10839 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10841 (defun org-refile-new-child (parent-target child)
10842 "Use refile target PARENT-TARGET to add new CHILD below it."
10843 (unless parent-target
10844 (error "Cannot find parent for new node"))
10845 (let ((file (nth 1 parent-target))
10846 (pos (nth 3 parent-target))
10847 level)
10848 (with-current-buffer (or (find-buffer-visiting file)
10849 (find-file-noselect file))
10850 (save-excursion
10851 (save-restriction
10852 (widen)
10853 (if pos
10854 (goto-char pos)
10855 (goto-char (point-max))
10856 (if (not (bolp)) (newline)))
10857 (when (looking-at org-outline-regexp)
10858 (setq level (funcall outline-level))
10859 (org-end-of-subtree t t))
10860 (org-back-over-empty-lines)
10862 (if pos (org-get-valid-level level 1) 1) ?*)
10864 (beginning-of-line 0)
10865 (list (concat (car parent-target) "/" child) file "" (point)))))))
10867 (defun org-olpath-completing-read (prompt collection &rest args)
10868 "Read an outline path like a file name."
10869 (let ((thetable collection)
10870 (org-completion-use-ido nil) ; does not work with ido.
10871 (org-completion-use-iswitchb nil)) ; or iswitchb
10872 (apply
10873 'org-icompleting-read prompt
10874 (lambda (string predicate &optional flag)
10875 (let (rtn r f (l (length string)))
10876 (cond
10877 ((eq flag nil)
10878 ;; try completion
10879 (try-completion string thetable))
10880 ((eq flag t)
10881 ;; all-completions
10882 (setq rtn (all-completions string thetable predicate))
10883 (mapcar
10884 (lambda (x)
10885 (setq r (substring x l))
10886 (if (string-match " ([^)]*)$" x)
10887 (setq f (match-string 0 x))
10888 (setq f ""))
10889 (if (string-match "/" r)
10890 (concat string (substring r 0 (match-end 0)) f)
10891 x))
10892 rtn))
10893 ((eq flag 'lambda)
10894 ;; exact match?
10895 (assoc string thetable)))
10896 ))
10897 args)))
10899 ;;;; Dynamic blocks
10901 (defun org-find-dblock (name)
10902 "Find the first dynamic block with name NAME in the buffer.
10903 If not found, stay at current position and return nil."
10904 (let (pos)
10905 (save-excursion
10906 (goto-char (point-min))
10908 nil t)
10909 (match-beginning 0))))
10910 (if pos (goto-char pos))
10911 pos))
10913 (defconst org-dblock-start-re
10915 "Matches the start line of a dynamic block, with parameters.")
10918 "Matches the end of a dynamic block.")
10920 (defun org-create-dblock (plist)
10921 "Create a dynamic block section, with parameters taken from PLIST.
10922 PLIST must contain a :name entry which is used as name of the block."
10924 (end-of-line 1)
10925 (newline))
10926 (let ((col (current-column))
10927 (name (plist-get plist :name)))
10928 (insert "#+BEGIN: " name)
10929 (while plist
10930 (if (eq (car plist) :name)
10931 (setq plist (cddr plist))
10932 (insert " " (prin1-to-string (pop plist)))))
10934 (beginning-of-line -2)))
10936 (defun org-prepare-dblock ()
10937 "Prepare dynamic block for refresh.
10938 This empties the block, puts the cursor at the insert position and returns
10939 the property list including an extra property :name with the block name."
10940 (unless (looking-at org-dblock-start-re)
10941 (error "Not at a dynamic block"))
10942 (let* ((begdel (1+ (match-end 0)))
10943 (name (org-no-properties (match-string 1)))
10944 (params (append (list :name name)
10945 (read (concat "(" (match-string 3) ")")))))
10946 (save-excursion
10947 (beginning-of-line 1)
10949 (setq params (plist-put params :indentation-column (current-column))))
10950 (unless (re-search-forward org-dblock-end-re nil t)
10951 (error "Dynamic block not terminated"))
10952 (setq params
10953 (append params
10954 (list :content (buffer-substring
10955 begdel (match-beginning 0)))))
10956 (delete-region begdel (match-beginning 0))
10957 (goto-char begdel)
10958 (open-line 1)
10959 params))
10961 (defun org-map-dblocks (&optional command)
10962 "Apply COMMAND to all dynamic blocks in the current buffer.
10963 If COMMAND is not given, use `org-update-dblock'."
10964 (let ((cmd (or command 'org-update-dblock)))
10965 (save-excursion
10966 (goto-char (point-min))
10967 (while (re-search-forward org-dblock-start-re nil t)
10968 (goto-char (match-beginning 0))
10969 (save-excursion
10970 (condition-case nil
10971 (funcall cmd)
10972 (error (message "Error during update of dynamic block"))))
10973 (unless (re-search-forward org-dblock-end-re nil t)
10974 (error "Dynamic block not terminated"))))))
10976 (defun org-dblock-update (&optional arg)
10977 "User command for updating dynamic blocks.
10978 Update the dynamic block at point. With prefix ARG, update all dynamic
10979 blocks in the buffer."
10980 (interactive "P")
10981 (if arg
10982 (org-update-all-dblocks)
10983 (or (looking-at org-dblock-start-re)
10984 (org-beginning-of-dblock))
10985 (org-update-dblock)))
10987 (defun org-update-dblock ()
10988 "Update the dynamic block at point.
10989 This means to empty the block, parse for parameters and then call
10990 the correct writing function."
10991 (interactive)
10992 (save-window-excursion
10993 (let* ((pos (point))
10994 (line (org-current-line))
10995 (params (org-prepare-dblock))
10996 (name (plist-get params :name))
10997 (indent (plist-get params :indentation-column))
10998 (cmd (intern (concat "org-dblock-write:" name))))
10999 (message "Updating dynamic block `%s' at line %d..." name line)
11000 (funcall cmd params)
11001 (message "Updating dynamic block `%s' at line %d...done" name line)
11002 (goto-char pos)
11003 (when (and indent (> indent 0))
11004 (setq indent (make-string indent ?\ ))
11005 (save-excursion
11006 (org-beginning-of-dblock)
11007 (forward-line 1)
11008 (while (not (looking-at org-dblock-end-re))
11009 (insert indent)
11010 (beginning-of-line 2))
11011 (when (looking-at org-dblock-end-re)
11013 (replace-match ""))
11014 (insert indent)))))))
11016 (defun org-beginning-of-dblock ()
11017 "Find the beginning of the dynamic block at point.
11018 Error if there is no such block at point."
11019 (let ((pos (point))
11020 beg)
11021 (end-of-line 1)
11022 (if (and (re-search-backward org-dblock-start-re nil t)
11023 (setq beg (match-beginning 0))
11024 (re-search-forward org-dblock-end-re nil t)
11025 (> (match-end 0) pos))
11026 (goto-char beg)
11027 (goto-char pos)
11028 (error "Not in a dynamic block"))))
11030 (defun org-update-all-dblocks ()
11031 "Update all dynamic blocks in the buffer.
11032 This function can be used in a hook."
11033 (interactive)
11034 (when (eq major-mode 'org-mode)
11035 (org-map-dblocks 'org-update-dblock)))
11038 ;;;; Completion
11040 (defconst org-additional-option-like-keywords
11041 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11042 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11043 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11044 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11045 "BEGIN:" "END:"
11046 "ORGTBL" "TBLFM:" "TBLNAME:"
11047 "BEGIN_EXAMPLE" "END_EXAMPLE"
11048 "BEGIN_QUOTE" "END_QUOTE"
11049 "BEGIN_VERSE" "END_VERSE"
11050 "BEGIN_CENTER" "END_CENTER"
11051 "BEGIN_SRC" "END_SRC"
11052 "BEGIN_RESULT" "END_RESULT"
11053 "NAME:" "RESULTS:"
11054 "HEADER:" "HEADERS:"
11055 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11056 "CAPTION:" "LABEL:"
11057 "SETUPFILE:"
11058 "INCLUDE:"
11059 "BIND:"
11060 "MACRO:"))
11062 (defcustom org-structure-template-alist
11063 '(
11076 ("L" "#+LaTeX: "
11080 ("H" "#+HTML: "
11083 ("A" "#+ASCII: ")
11084 ("i" "#+INDEX: ?"
11085 "#+INDEX: ?")
11086 ("I" "#+INCLUDE %file ?"
11088 )
11089 "Structure completion elements.
11090 This is a list of abbreviation keys and values. The value gets inserted
11091 if you type `<' followed by the key and then press the completion key,
11092 usually `M-TAB'. %file will be replaced by a file name after prompting
11093 for the file using completion. The cursor will be placed at the position
11094 of the `?` in the template.
11095 There are two templates for each key, the first uses the original Org syntax,
11096 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11097 the default when the /org-mtags.el/ module has been loaded. See also the
11098 variable `org-mtags-prefer-muse-templates'."
11099 :group 'org-completion
11100 :type '(repeat
11101 (string :tag "Key")
11102 (string :tag "Template")
11103 (string :tag "Muse Template")))
11105 (defun org-try-structure-completion ()
11106 "Try to complete a structure template before point.
11108 expands them."
11109 (let ((l (buffer-substring (point-at-bol) (point)))
11110 a)
11113 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11114 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11115 (match-beginning 1)) a)
11116 t)))
11118 (defun org-complete-expand-structure-template (start cell)
11119 "Expand a structure template."
11120 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11121 (rpl (nth (if musep 2 1) cell))
11122 (ind ""))
11123 (delete-region start (point))
11125 (cond
11126 ((bolp))
11128 (setq ind (buffer-substring (point-at-bol) (point))))
11129 (t (newline))))
11130 (setq start (point))
11131 (if (string-match "%file" rpl)
11132 (setq rpl (replace-match
11133 (concat
11135 (save-match-data
11136 (abbreviate-file-name (read-file-name "Include file: ")))
11138 t t rpl)))
11141 (insert rpl)
11144 ;;;; TODO, DEADLINE, Comments
11146 (defun org-toggle-comment ()
11147 "Change the COMMENT state of an entry."
11148 (interactive)
11149 (save-excursion
11150 (org-back-to-heading)
11151 (let (case-fold-search)
11152 (cond
11153 ((looking-at (format org-heading-keyword-regexp-format
11154 org-comment-string))
11155 (goto-char (match-end 1))
11156 (looking-at (concat " +" org-comment-string))
11157 (replace-match "" t t)
11158 (when (eolp) (insert " ")))
11159 ((looking-at org-outline-regexp)
11160 (goto-char (match-end 0))
11161 (insert org-comment-string " "))))))
11163 (defvar org-last-todo-state-is-todo nil
11164 "This is non-nil when the last TODO state change led to a TODO state.
11165 If the last change removed the TODO tag or switched to DONE, then
11166 this is nil.")
11168 (defvar org-setting-tags nil) ; dynamically skipped
11170 (defvar org-todo-setup-filter-hook nil
11171 "Hook for functions that pre-filter todo specs.
11172 Each function takes a todo spec and returns either nil or the spec
11173 transformed into canonical form." )
11175 (defvar org-todo-get-default-hook nil
11176 "Hook for functions that get a default item for todo.
11177 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11178 nil or a string to be used for the todo mark." )
11180 (defvar org-agenda-headline-snapshot-before-repeat)
11182 (defun org-current-effective-time ()
11183 "Return current time adjusted for `org-extend-today-until' variable"
11184 (let* ((ct (org-current-time))
11185 (dct (decode-time ct))
11186 (ct1
11187 (if (and org-use-effective-time
11188 (< (nth 2 dct) org-extend-today-until))
11189 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11190 ct)))
11191 ct1))
11193 (defun org-todo-yesterday (&optional arg)
11194 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11195 (interactive "P")
11196 (if (eq major-mode 'org-agenda-mode)
11197 (apply 'org-agenda-todo-yesterday arg)
11198 (let* ((hour (third (decode-time
11199 (org-current-time))))
11200 (org-extend-today-until (1+ hour)))
11201 (org-todo arg))))
11203 (defun org-todo (&optional arg)
11204 "Change the TODO state of an item.
11205 The state of an item is given by a keyword at the start of the heading,
11206 like
11207 *** TODO Write paper
11208 *** DONE Call mom
11210 The different keywords are specified in the variable `org-todo-keywords'.
11212 So for this example: when the item starts with TODO, it is changed to DONE.
11213 When it starts with DONE, the DONE is removed. And when neither TODO nor
11214 DONE are present, add TODO at the beginning of the heading.
11217 state.
11218 With numeric prefix arg, switch to that state.
11220 keywords (nextset).
11222 With a numeric prefix arg of 0, inhibit note taking for the change.
11224 For calling through lisp, arg is also interpreted in the following way:
11225 'none -> empty state
11227 'done -> switch to DONE
11228 'nextset -> switch to the next set of keywords
11229 'previousset -> switch to the previous set of keywords
11231 really is a member of `org-todo-keywords'."
11232 (interactive "P")
11233 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11234 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11235 'region-start-level 'region))
11236 org-loop-over-headlines-in-active-region)
11237 (org-map-entries
11238 `(org-todo ,arg)
11239 org-loop-over-headlines-in-active-region
11240 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11241 (if (equal arg '(16)) (setq arg 'nextset))
11242 (let ((org-blocker-hook org-blocker-hook)
11243 (case-fold-search nil))
11244 (when (equal arg '(64))
11245 (setq arg nil org-blocker-hook nil))
11246 (when (and org-blocker-hook
11247 (or org-inhibit-blocking
11248 (org-entry-get nil "NOBLOCKING")))
11249 (setq org-blocker-hook nil))
11250 (save-excursion
11251 (catch 'exit
11252 (org-back-to-heading t)
11253 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11256 (let* ((match-data (match-data))
11257 (startpos (point-at-bol))
11258 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11259 (org-log-done org-log-done)
11260 (org-log-repeat org-log-repeat)
11261 (org-todo-log-states org-todo-log-states)
11262 (org-inhibit-logging
11263 (if (equal arg 0)
11264 (progn (setq arg nil) 'note) org-inhibit-logging))
11265 (this (match-string 1))
11266 (hl-pos (match-beginning 0))
11267 (head (org-get-todo-sequence-head this))
11268 (ass (assoc head org-todo-kwd-alist))
11269 (interpret (nth 1 ass))
11270 (done-word (nth 3 ass))
11271 (final-done-word (nth 4 ass))
11272 (last-state (or this ""))
11273 (completion-ignore-case t)
11274 (member (member this org-todo-keywords-1))
11275 (tail (cdr member))
11276 (state (cond
11277 ((and org-todo-key-trigger
11278 (or (and (equal arg '(4))
11279 (eq org-use-fast-todo-selection 'prefix))
11280 (and (not arg) org-use-fast-todo-selection
11281 (not (eq org-use-fast-todo-selection
11282 'prefix)))))
11283 ;; Use fast selection
11284 (org-fast-todo-selection))
11285 ((and (equal arg '(4))
11286 (or (not org-use-fast-todo-selection)
11287 (not org-todo-key-trigger)))
11288 ;; Read a state with completion
11289 (org-icompleting-read
11290 "State: " (mapcar (lambda(x) (list x))
11291 org-todo-keywords-1)
11292 nil t))
11293 ((eq arg 'right)
11294 (if this
11295 (if tail (car tail) nil)
11296 (car org-todo-keywords-1)))
11297 ((eq arg 'left)
11298 (if (equal member org-todo-keywords-1)
11299 nil
11300 (if this
11301 (nth (- (length org-todo-keywords-1)
11302 (length tail) 2)
11303 org-todo-keywords-1)
11304 (org-last org-todo-keywords-1))))
11305 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11306 (setq arg nil))) ; hack to fall back to cycling
11307 (arg
11308 ;; user or caller requests a specific state
11309 (cond
11310 ((equal arg "") nil)
11311 ((eq arg 'none) nil)
11312 ((eq arg 'done) (or done-word (car org-done-keywords)))
11313 ((eq arg 'nextset)
11314 (or (car (cdr (member head org-todo-heads)))
11315 (car org-todo-heads)))
11316 ((eq arg 'previousset)
11317 (let ((org-todo-heads (reverse org-todo-heads)))
11318 (or (car (cdr (member head org-todo-heads)))
11319 (car org-todo-heads))))
11320 ((car (member arg org-todo-keywords-1)))
11321 ((stringp arg)
11322 (error "State `%s' not valid in this file" arg))
11323 ((nth (1- (prefix-numeric-value arg))
11324 org-todo-keywords-1))))
11325 ((null member) (or head (car org-todo-keywords-1)))
11326 ((equal this final-done-word) nil) ;; -> make empty
11327 ((null tail) nil) ;; -> first entry
11328 ((memq interpret '(type priority))
11329 (if (eq this-command last-command)
11330 (car tail)
11331 (if (> (length tail) 0)
11332 (or done-word (car org-done-keywords))
11333 nil)))
11334 (t
11335 (car tail))))
11336 (state (or
11337 (run-hook-with-args-until-success
11338 'org-todo-get-default-hook state last-state)
11339 state))
11340 (next (if state (concat " " state " ") " "))
11341 (change-plist (list :type 'todo-state-change :from this :to state
11342 :position startpos))
11343 dolog now-done-p)
11344 (when org-blocker-hook
11345 (setq org-last-todo-state-is-todo
11346 (not (member this org-done-keywords)))
11347 (unless (save-excursion
11348 (save-match-data
11349 (org-with-wide-buffer
11350 (run-hook-with-args-until-failure
11351 'org-blocker-hook change-plist))))
11352 (if (org-called-interactively-p 'interactive)
11353 (error "TODO state change from %s to %s blocked" this state)
11354 ;; fail silently
11355 (message "TODO state change from %s to %s blocked" this state)
11356 (throw 'exit nil))))
11357 (store-match-data match-data)
11358 (replace-match next t t)
11359 (unless (pos-visible-in-window-p hl-pos)
11360 (message "TODO state changed to %s" (org-trim next)))
11361 (unless head
11362 (setq head (org-get-todo-sequence-head state)
11363 ass (assoc head org-todo-kwd-alist)
11364 interpret (nth 1 ass)
11365 done-word (nth 3 ass)
11366 final-done-word (nth 4 ass)))
11367 (when (memq arg '(nextset previousset))
11368 (message "Keyword-Set %d/%d: %s"
11369 (- (length org-todo-sets) -1
11370 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11371 (length org-todo-sets)
11372 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11373 (setq org-last-todo-state-is-todo
11374 (not (member state org-done-keywords)))
11375 (setq now-done-p (and (member state org-done-keywords)
11376 (not (member this org-done-keywords))))
11377 (and logging (org-local-logging logging))
11378 (when (and (or org-todo-log-states org-log-done)
11379 (not (eq org-inhibit-logging t))
11380 (not (memq arg '(nextset previousset))))
11381 ;; we need to look at recording a time and note
11382 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11383 (nth 2 (assoc this org-todo-log-states))))
11384 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11385 (setq dolog 'time))
11386 (when (and state
11387 (member state org-not-done-keywords)
11388 (not (member this org-not-done-keywords)))
11389 ;; This is now a todo state and was not one before
11390 ;; If there was a CLOSED time stamp, get rid of it.
11391 (org-add-planning-info nil nil 'closed))
11392 (when (and now-done-p org-log-done)
11393 ;; It is now done, and it was not done before
11394 (org-add-planning-info 'closed (org-current-effective-time))
11395 (if (and (not dolog) (eq 'note org-log-done))
11396 (org-add-log-setup 'done state this 'findpos 'note)))
11397 (when (and state dolog)
11398 ;; This is a non-nil state, and we need to log it
11399 (org-add-log-setup 'state state this 'findpos dolog)))
11400 ;; Fixup tag positioning
11401 (org-todo-trigger-tag-changes state)
11402 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11403 (when org-provide-todo-statistics
11404 (org-update-parent-todo-statistics))
11405 (run-hooks 'org-after-todo-state-change-hook)
11406 (if (and arg (not (member state org-done-keywords)))
11407 (setq head (org-get-todo-sequence-head state)))
11408 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11409 ;; Do we need to trigger a repeat?
11410 (when now-done-p
11411 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11412 ;; This is for the agenda, take a snapshot of the headline.
11413 (save-match-data
11414 (setq org-agenda-headline-snapshot-before-repeat
11415 (org-get-heading))))
11416 (org-auto-repeat-maybe state))
11417 ;; Fixup cursor location if close to the keyword
11418 (if (and (outline-on-heading-p)
11419 (not (bolp))
11420 (save-excursion (beginning-of-line 1)
11421 (looking-at org-todo-line-regexp))
11422 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11423 (progn
11424 (goto-char (or (match-end 2) (match-end 1)))
11425 (and (looking-at " ") (just-one-space))))
11426 (when org-trigger-hook
11427 (save-excursion
11428 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11430 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11431 "Block turning an entry into a TODO, using the hierarchy.
11432 This checks whether the current task should be blocked from state
11433 changes. Such blocking occurs when:
11435 1. The task has children which are not all in a completed state.
11437 2. A task has a parent with the property :ORDERED:, and there
11438 are siblings prior to the current task with incomplete
11439 status.
11441 3. The parent of the task is blocked because it has siblings that should
11442 be done first, or is child of a block grandparent TODO entry."
11444 (if (not org-enforce-todo-dependencies)
11445 t ; if locally turned off don't block
11446 (catch 'dont-block
11447 ;; If this is not a todo state change, or if this entry is already DONE,
11448 ;; do not block
11449 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11450 (member (plist-get change-plist :from)
11451 (cons 'done org-done-keywords))
11452 (member (plist-get change-plist :to)
11453 (cons 'todo org-not-done-keywords))
11454 (not (plist-get change-plist :to)))
11455 (throw 'dont-block t))
11456 ;; If this task has children, and any are undone, it's blocked
11457 (save-excursion
11458 (org-back-to-heading t)
11459 (let ((this-level (funcall outline-level)))
11460 (outline-next-heading)
11461 (let ((child-level (funcall outline-level)))
11462 (while (and (not (eobp))
11463 (> child-level this-level))
11464 ;; this todo has children, check whether they are all
11465 ;; completed
11466 (if (and (not (org-entry-is-done-p))
11467 (org-entry-is-todo-p))
11468 (throw 'dont-block nil))
11469 (outline-next-heading)
11470 (setq child-level (funcall outline-level))))))
11471 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11472 ;; any previous siblings are undone, it's blocked
11473 (save-excursion
11474 (org-back-to-heading t)
11475 (let* ((pos (point))
11476 (parent-pos (and (org-up-heading-safe) (point))))
11477 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11478 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11479 (forward-line 1)
11480 (re-search-forward org-not-done-heading-regexp pos t))
11481 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11482 ;; Search further up the hierarchy, to see if an ancestor is blocked
11483 (while t
11484 (goto-char parent-pos)
11485 (if (not (looking-at org-not-done-heading-regexp))
11486 (throw 'dont-block t)) ; do not block, parent is not a TODO
11487 (setq pos (point))
11488 (setq parent-pos (and (org-up-heading-safe) (point)))
11489 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11490 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11491 (forward-line 1)
11492 (re-search-forward org-not-done-heading-regexp pos t))
11493 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11495 (defcustom org-track-ordered-property-with-tag nil
11496 "Should the ORDERED property also be shown as a tag?
11497 The ORDERED property decides if an entry should require subtasks to be
11498 completed in sequence. Since a property is not very visible, setting
11499 this option means that toggling the ORDERED property with the command
11500 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11501 not relevant for the behavior, but it makes things more visible.
11503 Note that toggling the tag with tags commands will not change the property
11504 and therefore not influence behavior!
11506 This can be t, meaning the tag ORDERED should be used, It can also be a
11507 string to select a different tag for this task."
11508 :group 'org-todo
11509 :type '(choice
11510 (const :tag "No tracking" nil)
11511 (const :tag "Track with ORDERED tag" t)
11512 (string :tag "Use other tag")))
11514 (defun org-toggle-ordered-property ()
11515 "Toggle the ORDERED property of the current entry.
11516 For better visibility, you can track the value of this property with a tag.
11517 See variable `org-track-ordered-property-with-tag'."
11518 (interactive)
11519 (let* ((t1 org-track-ordered-property-with-tag)
11520 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11521 (save-excursion
11522 (org-back-to-heading)
11523 (if (org-entry-get nil "ORDERED")
11524 (progn
11525 (org-delete-property "ORDERED")
11526 (and tag (org-toggle-tag tag 'off))
11527 (message "Subtasks can be completed in arbitrary order"))
11528 (org-entry-put nil "ORDERED" "t")
11529 (and tag (org-toggle-tag tag 'on))
11530 (message "Subtasks must be completed in sequence")))))
11532 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11533 (defun org-block-todo-from-checkboxes (change-plist)
11534 "Block turning an entry into a TODO, using checkboxes.
11535 This checks whether the current task should be blocked from state
11536 changes because there are unchecked boxes in this entry."
11537 (if (not org-enforce-todo-checkbox-dependencies)
11538 t ; if locally turned off don't block
11539 (catch 'dont-block
11540 ;; If this is not a todo state change, or if this entry is already DONE,
11541 ;; do not block
11542 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11543 (member (plist-get change-plist :from)
11544 (cons 'done org-done-keywords))
11545 (member (plist-get change-plist :to)
11546 (cons 'todo org-not-done-keywords))
11547 (not (plist-get change-plist :to)))
11548 (throw 'dont-block t))
11549 ;; If this task has checkboxes that are not checked, it's blocked
11550 (save-excursion
11551 (org-back-to-heading t)
11552 (let ((beg (point)) end)
11553 (outline-next-heading)
11554 (setq end (point))
11555 (goto-char beg)
11556 (if (org-list-search-forward
11557 (concat (org-item-beginning-re)
11560 end t)
11561 (progn
11562 (if (boundp 'org-blocked-by-checkboxes)
11563 (setq org-blocked-by-checkboxes t))
11564 (throw 'dont-block nil)))))
11565 t))) ; do not block
11567 (defun org-entry-blocked-p ()
11568 "Is the current entry blocked?"
11569 (if (org-entry-get nil "NOBLOCKING")
11570 nil ;; Never block this entry
11571 (not
11572 (run-hook-with-args-until-failure
11573 'org-blocker-hook
11574 (list :type 'todo-state-change
11575 :position (point)
11576 :from 'todo
11577 :to 'done)))))
11579 (defun org-update-statistics-cookies (all)
11580 "Update the statistics cookie, either from TODO or from checkboxes.
11581 This should be called with the cursor in a line with a statistics cookie."
11582 (interactive "P")
11583 (if all
11584 (progn
11585 (org-update-checkbox-count 'all)
11586 (org-map-entries 'org-update-parent-todo-statistics))
11587 (if (not (org-at-heading-p))
11588 (org-update-checkbox-count)
11589 (let ((pos (move-marker (make-marker) (point)))
11590 end l1 l2)
11591 (ignore-errors (org-back-to-heading t))
11592 (if (not (org-at-heading-p))
11593 (org-update-checkbox-count)
11594 (setq l1 (org-outline-level))
11595 (setq end (save-excursion
11596 (outline-next-heading)
11597 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11598 (point)))
11599 (if (and (save-excursion
11600 (re-search-forward
11602 (not (save-excursion (re-search-forward
11604 (org-update-checkbox-count)
11605 (if (and l2 (> l2 l1))
11606 (progn
11607 (goto-char end)
11608 (org-update-parent-todo-statistics))
11609 (goto-char pos)
11610 (beginning-of-line 1)
11611 (while (re-search-forward
11613 (point-at-eol) t)
11614 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11615 (goto-char pos)
11616 (move-marker pos nil)))))
11618 (defvar org-entry-property-inherited-from) ;; defined below
11619 (defun org-update-parent-todo-statistics ()
11620 "Update any statistics cookie in the parent of the current headline.
11621 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11622 the entire subtree and this will travel up the hierarchy and update
11623 statistics everywhere."
11624 (let* ((prop (save-excursion (org-up-heading-safe)
11625 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11626 (recursive (or (not org-hierarchical-todo-statistics)
11628 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11629 0))
11630 (first t)
11632 level ltoggle l1 new ndel
11633 (cnt-all 0) (cnt-done 0) is-percent kwd
11634 checkbox-beg ov ovs ove cookie-present)
11635 (catch 'exit
11636 (save-excursion
11637 (beginning-of-line 1)
11638 (setq ltoggle (funcall outline-level))
11639 ;; Three situations are to consider:
11641 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11642 ;; to the top-level ancestor on the headline;
11644 ;; 2. If parent has "recursive" property, repeat up to the
11645 ;; headline setting that property, taking inheritance into
11646 ;; account;
11648 ;; 3. Else, move up to direct parent and proceed only once.
11649 (while (and (setq level (org-up-heading-safe))
11650 (or recursive first)
11651 (>= (point) lim))
11652 (setq first nil cookie-present nil)
11653 (unless (and level
11654 (not (string-match
11656 (downcase (or (org-entry-get nil "COOKIE_DATA")
11657 "")))))
11658 (throw 'exit nil))
11659 (while (re-search-forward box-re (point-at-eol) t)
11660 (setq cnt-all 0 cnt-done 0 cookie-present t)
11661 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11662 (save-match-data
11663 (unless (outline-next-heading) (throw 'exit nil))
11664 (while (and (looking-at org-complex-heading-regexp)
11665 (> (setq l1 (length (match-string 1))) level))
11666 (setq kwd (and (or recursive (= l1 ltoggle))
11667 (match-string 2)))
11668 (if (or (eq org-provide-todo-statistics 'all-headlines)
11669 (and (listp org-provide-todo-statistics)
11670 (or (member kwd org-provide-todo-statistics)
11671 (member kwd org-done-keywords))))
11672 (setq cnt-all (1+ cnt-all))
11673 (if (eq org-provide-todo-statistics t)
11674 (and kwd (setq cnt-all (1+ cnt-all)))))
11675 (and (member kwd org-done-keywords)
11676 (setq cnt-done (1+ cnt-done)))
11677 (outline-next-heading)))
11678 (setq new
11679 (if is-percent
11680 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11681 (format "[%d/%d]" cnt-done cnt-all))
11682 ndel (- (match-end 0) checkbox-beg))
11683 ;; handle overlays when updating cookie from column view
11684 (when (setq ov (car (overlays-at checkbox-beg)))
11685 (setq ovs (overlay-start ov) ove (overlay-end ov))
11686 (delete-overlay ov))
11687 (goto-char checkbox-beg)
11688 (insert new)
11689 (delete-region (point) (+ (point) ndel))
11690 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11691 (when ov (move-overlay ov ovs ove)))
11692 (when cookie-present
11693 (run-hook-with-args 'org-after-todo-statistics-hook
11694 cnt-done (- cnt-all cnt-done))))))
11695 (run-hooks 'org-todo-statistics-hook)))
11697 (defvar org-after-todo-statistics-hook nil
11698 "Hook that is called after a TODO statistics cookie has been updated.
11699 Each function is called with two arguments: the number of not-done entries
11700 and the number of done entries.
11702 For example, the following function, when added to this hook, will switch
11703 an entry to DONE when all children are done, and back to TODO when new
11704 entries are set to a TODO status. Note that this hook is only called
11705 when there is a statistics cookie in the headline!
11707 (defun org-summary-todo (n-done n-not-done)
11709 (let (org-log-done org-log-states) ; turn off logging
11711 ")
11713 (defvar org-todo-statistics-hook nil
11714 "Hook that is run whenever Org thinks TODO statistics should be updated.
11715 This hook runs even if there is no statistics cookie present, in which case
11716 `org-after-todo-statistics-hook' would not run.")
11718 (defun org-todo-trigger-tag-changes (state)
11719 "Apply the changes defined in `org-todo-state-tags-triggers'."
11720 (let ((l org-todo-state-tags-triggers)
11721 changes)
11722 (when (or (not state) (equal state ""))
11723 (setq changes (append changes (cdr (assoc "" l)))))
11724 (when (and (stringp state) (> (length state) 0))
11725 (setq changes (append changes (cdr (assoc state l)))))
11726 (when (member state org-not-done-keywords)
11727 (setq changes (append changes (cdr (assoc 'todo l)))))
11728 (when (member state org-done-keywords)
11729 (setq changes (append changes (cdr (assoc 'done l)))))
11730 (dolist (c changes)
11731 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11733 (defun org-local-logging (value)
11734 "Get logging settings from a property VALUE."
11735 (let* (words w a)
11736 ;; directly set the variables, they are already local.
11737 (setq org-log-done nil
11738 org-log-repeat nil
11739 org-todo-log-states nil)
11740 (setq words (org-split-string value))
11741 (while (setq w (pop words))
11742 (cond
11743 ((setq a (assoc w org-startup-options))
11744 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11745 (set (nth 1 a) (nth 2 a))))
11746 ((setq a (org-extract-log-state-settings w))
11747 (and (member (car a) org-todo-keywords-1)
11748 (push a org-todo-log-states)))))))
11750 (defun org-get-todo-sequence-head (kwd)
11751 "Return the head of the TODO sequence to which KWD belongs.
11752 If KWD is not set, check if there is a text property remembering the
11753 right sequence."
11754 (let (p)
11755 (cond
11756 ((not kwd)
11757 (or (get-text-property (point-at-bol) 'org-todo-head)
11758 (progn
11759 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11760 nil (point-at-eol)))
11761 (get-text-property p 'org-todo-head))))
11762 ((not (member kwd org-todo-keywords-1))
11763 (car org-todo-keywords-1))
11764 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11766 (defun org-fast-todo-selection ()
11767 "Fast TODO keyword selection with single keys.
11768 Returns the new TODO keyword, or nil if no state change should occur."
11769 (let* ((fulltable org-todo-key-alist)
11770 (done-keywords org-done-keywords) ;; needed for the faces.
11771 (maxlen (apply 'max (mapcar
11772 (lambda (x)
11773 (if (stringp (car x)) (string-width (car x)) 0))
11774 fulltable)))
11775 (expert nil)
11776 (fwidth (+ maxlen 3 1 3))
11777 (ncol (/ (- (window-width) 4) fwidth))
11778 tg cnt e c tbl
11779 groups ingroup)
11780 (save-excursion
11781 (save-window-excursion
11782 (if expert
11783 (set-buffer (get-buffer-create " *Org todo*"))
11784 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11785 (erase-buffer)
11786 (org-set-local 'org-done-keywords done-keywords)
11787 (setq tbl fulltable cnt 0)
11788 (while (setq e (pop tbl))
11789 (cond
11790 ((equal e '(:startgroup))
11791 (push '() groups) (setq ingroup t)
11792 (when (not (= cnt 0))
11793 (setq cnt 0)
11795 (insert "{ "))
11796 ((equal e '(:endgroup))
11797 (setq ingroup nil cnt 0)
11799 ((equal e '(:newline))
11800 (when (not (= cnt 0))
11801 (setq cnt 0)
11803 (setq e (car tbl))
11804 (while (equal (car tbl) '(:newline))
11806 (setq tbl (cdr tbl)))))
11807 (t
11808 (setq tg (car e) c (cdr e))
11809 (if ingroup (push tg (car groups)))
11810 (setq tg (org-add-props tg nil 'face
11811 (org-get-todo-face tg)))
11812 (if (and (= cnt 0) (not ingroup)) (insert " "))
11813 (insert "[" c "] " tg (make-string
11814 (- fwidth 4 (length tg)) ?\ ))
11815 (when (= (setq cnt (1+ cnt)) ncol)
11817 (if ingroup (insert " "))
11818 (setq cnt 0)))))
11820 (goto-char (point-min))
11821 (if (not expert) (org-fit-window-to-buffer))
11822 (message "[a-z..]:Set [SPC]:clear")
11823 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11824 (cond
11825 ((or (= c ?\C-g)
11826 (and (= c ?q) (not (rassoc c fulltable))))
11827 (setq quit-flag t))
11828 ((= c ?\ ) nil)
11829 ((setq e (rassoc c fulltable) tg (car e))
11830 tg)
11831 (t (setq quit-flag t)))))))
11833 (defun org-entry-is-todo-p ()
11834 (member (org-get-todo-state) org-not-done-keywords))
11836 (defun org-entry-is-done-p ()
11837 (member (org-get-todo-state) org-done-keywords))
11839 (defun org-get-todo-state ()
11840 (save-excursion
11841 (org-back-to-heading t)
11842 (and (looking-at org-todo-line-regexp)
11843 (match-end 2)
11844 (match-string 2))))
11846 (defun org-at-date-range-p (&optional inactive-ok)
11847 "Is the cursor inside a date range?"
11848 (interactive)
11849 (save-excursion
11850 (catch 'exit
11851 (let ((pos (point)))
11853 (skip-chars-backward "<[")
11854 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11855 (>= (match-end 0) pos)
11856 (throw 'exit t))
11858 (skip-chars-backward "<[")
11859 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11860 (>= (match-end 0) pos)
11861 (throw 'exit t)))
11862 nil)))
11864 (defun org-get-repeat (&optional tagline)
11865 "Check if there is a deadline/schedule with repeater in this entry."
11866 (save-match-data
11867 (save-excursion
11868 (org-back-to-heading t)
11869 (and (re-search-forward (if tagline
11871 org-repeat-re)
11872 (org-entry-end-position) t)
11873 (match-string-no-properties 1)))))
11875 (defvar org-last-changed-timestamp)
11876 (defvar org-last-inserted-timestamp)
11877 (defvar org-log-post-message)
11878 (defvar org-log-note-purpose)
11879 (defvar org-log-note-how)
11880 (defvar org-log-note-extra)
11881 (defun org-auto-repeat-maybe (done-word)
11882 "Check if the current headline contains a repeated deadline/schedule.
11883 If yes, set TODO state back to what it was and change the base date
11884 of repeating deadline/scheduled time stamps to new date.
11885 This function is run automatically after each state change to a DONE state."
11886 ;; last-state is dynamically scoped into this function
11887 (let* ((repeat (org-get-repeat))
11888 (aa (assoc last-state org-todo-kwd-alist))
11889 (interpret (nth 1 aa))
11890 (head (nth 2 aa))
11891 (whata '(("d" . day) ("m" . month) ("y" . year)))
11892 (msg "Entry repeats: ")
11893 (org-log-done nil)
11894 (org-todo-log-states nil)
11895 re type n what ts time to-state)
11896 (when repeat
11897 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11898 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11899 org-todo-repeat-to-state))
11900 (unless (and to-state (member to-state org-todo-keywords-1))
11901 (setq to-state (if (eq interpret 'type) last-state head)))
11902 (org-todo to-state)
11903 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11904 (org-entry-put nil "LAST_REPEAT" (format-time-string
11905 (org-time-stamp-format t t))))
11906 (when org-log-repeat
11907 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11908 (memq 'org-add-log-note post-command-hook))
11909 ;; OK, we are already setup for some record
11910 (if (eq org-log-repeat 'note)
11911 ;; make sure we take a note, not only a time stamp
11912 (setq org-log-note-how 'note))
11913 ;; Set up for taking a record
11914 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11915 last-state
11916 'findpos org-log-repeat)))
11917 (org-back-to-heading t)
11918 (org-add-planning-info nil nil 'closed)
11922 (while (re-search-forward
11923 re (save-excursion (outline-next-heading) (point)) t)
11924 (setq type (if (match-end 1) org-scheduled-string
11925 (if (match-end 3) org-deadline-string "Plain:"))
11926 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11928 (setq n (string-to-number (match-string 2 ts))
11929 what (match-string 3 ts))
11930 (if (equal what "w") (setq n (* n 7) what "d"))
11931 ;; Preparation, see if we need to modify the start date for the change
11932 (when (match-end 1)
11933 (setq time (save-match-data (org-time-string-to-time ts)))
11934 (cond
11935 ((equal (match-string 1 ts) ".")
11936 ;; Shift starting date to today
11937 (org-timestamp-change
11938 (- (org-today) (time-to-days time))
11939 'day))
11940 ((equal (match-string 1 ts) "+")
11941 (let ((nshiftmax 10) (nshift 0))
11942 (while (or (= nshift 0)
11943 (<= (time-to-days time)
11944 (time-to-days (current-time))))
11945 (when (= (incf nshift) nshiftmax)
11946 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11947 (error "Abort")))
11948 (org-timestamp-change n (cdr (assoc what whata)))
11949 (org-at-timestamp-p t)
11950 (setq ts (match-string 1))
11951 (setq time (save-match-data (org-time-string-to-time ts)))))
11952 (org-timestamp-change (- n) (cdr (assoc what whata)))
11953 ;; rematch, so that we have everything in place for the real shift
11954 (org-at-timestamp-p t)
11955 (setq ts (match-string 1))
11957 (org-timestamp-change n (cdr (assoc what whata)))
11958 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11959 (setq org-log-post-message msg)
11960 (message "%s" msg))))
11962 (defun org-show-todo-tree (arg)
11963 "Make a compact tree which shows all headlines marked with TODO.
11964 The tree will show the lines where the regexp matches, and all higher
11965 headlines above the match.
11967 With a numeric prefix N, construct a sparse tree for the Nth element
11968 of `org-todo-keywords-1'."
11969 (interactive "P")
11970 (let ((case-fold-search nil)
11971 (kwd-re
11972 (cond ((null arg) org-not-done-regexp)
11973 ((equal arg '(4))
11974 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11975 (mapcar 'list org-todo-keywords-1))))
11979 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11980 (regexp-quote (nth (1- (prefix-numeric-value arg))
11981 org-todo-keywords-1)))
11982 (t (error "Invalid prefix argument: %s" arg)))))
11983 (message "%d TODO entries found"
11984 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11986 (defun org-deadline (&optional remove time)
11988 With argument REMOVE, remove any deadline from the item.
11989 With argument TIME, set the deadline at the corresponding date. TIME
11991 (interactive "P")
11992 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11993 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11994 'region-start-level 'region))
11995 org-loop-over-headlines-in-active-region)
11996 (org-map-entries
11997 `(org-deadline ',remove ,time)
11998 org-loop-over-headlines-in-active-region
11999 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12000 (let* ((old-date (org-entry-get nil "DEADLINE"))
12001 (repeater (and old-date
12002 (string-match
12004 old-date)
12005 (match-string 1 old-date))))
12006 (if remove
12007 (progn
12008 (when (and old-date org-log-redeadline)
12009 (org-add-log-setup 'deldeadline nil old-date 'findpos
12010 org-log-redeadline))
12011 (org-remove-timestamp-with-keyword org-deadline-string)
12012 (message "Item no longer has a deadline."))
12013 (org-add-planning-info 'deadline time 'closed)
12014 (when (and old-date org-log-redeadline
12015 (not (equal old-date
12016 (substring org-last-inserted-timestamp 1 -1))))
12017 (org-add-log-setup 'redeadline nil old-date 'findpos
12018 org-log-redeadline))
12019 (when repeater
12020 (save-excursion
12021 (org-back-to-heading t)
12022 (when (re-search-forward (concat org-deadline-string " "
12023 org-last-inserted-timestamp)
12024 (save-excursion
12025 (outline-next-heading) (point)) t)
12026 (goto-char (1- (match-end 0)))
12027 (insert " " repeater)
12028 (setq org-last-inserted-timestamp
12029 (concat (substring org-last-inserted-timestamp 0 -1)
12030 " " repeater
12031 (substring org-last-inserted-timestamp -1))))))
12032 (message "Deadline on %s" org-last-inserted-timestamp)))))
12034 (defun org-schedule (&optional remove time)
12035 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12036 With argument REMOVE, remove any scheduling date from the item.
12037 With argument TIME, scheduled at the corresponding date. TIME can
12039 (interactive "P")
12040 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12041 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12042 'region-start-level 'region))
12043 org-loop-over-headlines-in-active-region)
12044 (org-map-entries
12045 `(org-schedule ',remove ,time)
12046 org-loop-over-headlines-in-active-region
12047 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12048 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12049 (repeater (and old-date
12050 (string-match
12052 old-date)
12053 (match-string 1 old-date))))
12054 (if remove
12055 (progn
12056 (when (and old-date org-log-reschedule)
12057 (org-add-log-setup 'delschedule nil old-date 'findpos
12058 org-log-reschedule))
12059 (org-remove-timestamp-with-keyword org-scheduled-string)
12060 (message "Item is no longer scheduled."))
12061 (org-add-planning-info 'scheduled time 'closed)
12062 (when (and old-date org-log-reschedule
12063 (not (equal old-date
12064 (substring org-last-inserted-timestamp 1 -1))))
12065 (org-add-log-setup 'reschedule nil old-date 'findpos
12066 org-log-reschedule))
12067 (when repeater
12068 (save-excursion
12069 (org-back-to-heading t)
12070 (when (re-search-forward (concat org-scheduled-string " "
12071 org-last-inserted-timestamp)
12072 (save-excursion
12073 (outline-next-heading) (point)) t)
12074 (goto-char (1- (match-end 0)))
12075 (insert " " repeater)
12076 (setq org-last-inserted-timestamp
12077 (concat (substring org-last-inserted-timestamp 0 -1)
12078 " " repeater
12079 (substring org-last-inserted-timestamp -1))))))
12080 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12082 (defun org-get-scheduled-time (pom &optional inherit)
12083 "Get the scheduled time as a time tuple, of a format suitable
12084 for calling org-schedule with, or if there is no scheduling,
12085 returns nil."
12086 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12087 (when time
12088 (apply 'encode-time (org-parse-time-string time)))))
12090 (defun org-get-deadline-time (pom &optional inherit)
12091 "Get the deadline as a time tuple, of a format suitable for
12092 calling org-deadline with, or if there is no scheduling, returns
12093 nil."
12094 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12095 (when time
12096 (apply 'encode-time (org-parse-time-string time)))))
12098 (defun org-remove-timestamp-with-keyword (keyword)
12099 "Remove all time stamps with KEYWORD in the current entry."
12101 beg)
12102 (save-excursion
12103 (org-back-to-heading t)
12104 (setq beg (point))
12105 (outline-next-heading)
12106 (while (re-search-backward re beg t)
12107 (replace-match "")
12109 (equal (char-before) ?\ ))
12110 (backward-delete-char 1)
12112 (point-at-bol) (point-at-eol)))
12113 (delete-region (point-at-bol)
12114 (min (point-max) (1+ (point-at-eol))))))))))
12116 (defun org-add-planning-info (what &optional time &rest remove)
12117 "Insert new timestamp with keyword in the line directly after the headline.
12118 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12119 If non is given, the user is prompted for a date.
12120 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12121 be removed."
12122 (interactive)
12123 (let (org-time-was-given org-end-time-was-given ts
12124 end default-time default-input)
12126 (catch 'exit
12127 (when (and (memq what '(scheduled deadline))
12128 (or (not time)
12129 (and (stringp time)
12130 (string-match "^[-+]+[0-9]" time))))
12131 ;; Try to get a default date/time from existing timestamp
12132 (save-excursion
12133 (org-back-to-heading t)
12134 (setq end (save-excursion (outline-next-heading) (point)))
12135 (when (re-search-forward (if (eq what 'scheduled)
12136 org-scheduled-time-regexp
12137 org-deadline-time-regexp)
12138 end t)
12139 (setq ts (match-string 1)
12140 default-time
12141 (apply 'encode-time (org-parse-time-string ts))
12142 default-input (and ts (org-get-compact-tod ts))))))
12143 (when what
12144 (setq time
12145 (if (stringp time)
12146 ;; This is a string (relative or absolute), set proper date
12147 (apply 'encode-time
12148 (org-read-date-analyze
12149 time default-time (decode-time default-time)))
12150 ;; If necessary, get the time from the user
12151 (or time (org-read-date nil 'to-time nil nil
12152 default-time default-input)))))
12154 (when (and org-insert-labeled-timestamps-at-point
12155 (member what '(scheduled deadline)))
12156 (insert
12157 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12158 (org-insert-time-stamp time org-time-was-given
12159 nil nil nil (list org-end-time-was-given))
12160 (setq what nil))
12161 (save-excursion
12162 (save-restriction
12163 (let (col list elt ts buffer-invisibility-spec)
12164 (org-back-to-heading t)
12166 (goto-char (match-end 1))
12167 (setq col (current-column))
12168 (goto-char (match-end 0))
12170 (when (and (not what)
12171 (not (looking-at
12173 org-keyword-time-not-clock-regexp))))
12174 ;; Nothing to add, nothing to remove...... :-)
12175 (throw 'exit nil))
12176 (if (and (not (looking-at org-outline-regexp))
12179 (not (equal (match-string 1) org-clock-string)))
12180 (narrow-to-region (match-beginning 0) (match-end 0))
12182 (backward-char 1)
12183 (narrow-to-region (point) (point))
12184 (and org-adapt-indentation (org-indent-to-column col)))
12185 ;; Check if we have to remove something.
12186 (setq list (cons what remove))
12187 (while list
12188 (setq elt (pop list))
12189 (when (or (and (eq elt 'scheduled)
12190 (re-search-forward org-scheduled-time-regexp nil t))
12191 (and (eq elt 'deadline)
12192 (re-search-forward org-deadline-time-regexp nil t))
12193 (and (eq elt 'closed)
12194 (re-search-forward org-closed-time-regexp nil t)))
12195 (replace-match "")
12196 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12198 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12199 (when what
12200 (insert
12201 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12202 (cond ((eq what 'scheduled) org-scheduled-string)
12203 ((eq what 'deadline) org-deadline-string)
12204 ((eq what 'closed) org-closed-string))
12205 " ")
12206 (setq ts (org-insert-time-stamp
12207 time
12208 (or org-time-was-given
12209 (and (eq what 'closed) org-log-done-with-time))
12210 (eq what 'closed)
12211 nil nil (list org-end-time-was-given)))
12212 (insert
12213 (if (not (or (bolp) (eq (char-before) ?\ )
12214 (memq (char-after) '(32 10))
12215 (eobp))) " " ""))
12216 (end-of-line 1))
12217 (goto-char (point-min))
12218 (widen)
12221 (delete-region (1- (point)) (point-at-eol)))
12222 ts))))))
12224 (defvar org-log-note-marker (make-marker))
12225 (defvar org-log-note-purpose nil)
12226 (defvar org-log-note-state nil)
12227 (defvar org-log-note-previous-state nil)
12228 (defvar org-log-note-how nil)
12229 (defvar org-log-note-extra nil)
12230 (defvar org-log-note-window-configuration nil)
12231 (defvar org-log-note-return-to (make-marker))
12232 (defvar org-log-note-effective-time nil
12233 "Remembered current time so that dynamically scoped
12234 `org-extend-today-until' affects tha timestamps in state change
12235 log")
12237 (defvar org-log-post-message nil
12238 "Message to be displayed after a log note has been stored.
12239 The auto-repeater uses this.")
12241 (defun org-add-note ()
12242 "Add a note to the current entry.
12243 This is done in the same way as adding a state change note."
12244 (interactive)
12245 (org-add-log-setup 'note nil nil 'findpos nil))
12247 (defvar org-property-end-re)
12248 (defun org-add-log-setup (&optional purpose state prev-state
12249 findpos how extra)
12250 "Set up the post command hook to take a note.
12251 If this is about to TODO state change, the new state is expected in STATE.
12252 When FINDPOS is non-nil, find the correct position for the note in
12253 the current entry. If not, assume that it can be inserted at point.
12254 HOW is an indicator what kind of note should be created.
12255 EXTRA is additional text that will be inserted into the notes buffer."
12256 (let* ((org-log-into-drawer (org-log-into-drawer))
12257 (drawer (cond ((stringp org-log-into-drawer)
12258 org-log-into-drawer)
12259 (org-log-into-drawer "LOGBOOK")
12260 (t nil))))
12261 (save-restriction
12262 (save-excursion
12263 (when findpos
12264 (org-back-to-heading t)
12265 (narrow-to-region (point) (save-excursion
12266 (outline-next-heading) (point)))
12270 (goto-char (match-end 0))
12271 (cond
12272 (drawer
12274 nil t)
12275 (progn
12276 (goto-char (match-end 0))
12277 (or org-log-states-order-reversed
12278 (and (re-search-forward org-property-end-re nil t)
12279 (goto-char (1- (match-beginning 0))))))
12281 (beginning-of-line 0)
12282 (org-indent-line-function)
12283 (beginning-of-line 2)
12284 (org-indent-line-function)
12285 (end-of-line 0)))
12286 ((and org-log-state-notes-insert-after-drawers
12287 (save-excursion
12288 (forward-line) (looking-at org-drawer-regexp)))
12289 (forward-line)
12290 (while (looking-at org-drawer-regexp)
12291 (goto-char (match-end 0))
12292 (re-search-forward org-property-end-re (point-max) t)
12293 (forward-line))
12294 (forward-line -1)))
12295 (unless org-log-states-order-reversed
12297 (org-skip-over-state-notes)
12299 (move-marker org-log-note-marker (point))
12300 (setq org-log-note-purpose purpose
12301 org-log-note-state state
12302 org-log-note-previous-state prev-state
12303 org-log-note-how how
12304 org-log-note-extra extra
12305 org-log-note-effective-time (org-current-effective-time))
12306 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12308 (defun org-skip-over-state-notes ()
12309 "Skip past the list of State notes in an entry."
12311 (when (ignore-errors (goto-char (org-in-item-p)))
12312 (let* ((struct (org-list-struct))
12313 (prevs (org-list-prevs-alist struct)))
12315 (goto-char (or (org-list-get-next-item (point) struct prevs)
12316 (org-list-get-item-end (point) struct)))))))
12318 (defun org-add-log-note (&optional purpose)
12319 "Pop up a window for taking a note, and add this note later at point."
12320 (remove-hook 'post-command-hook 'org-add-log-note)
12321 (setq org-log-note-window-configuration (current-window-configuration))
12322 (delete-other-windows)
12323 (move-marker org-log-note-return-to (point))
12324 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12325 (goto-char org-log-note-marker)
12326 (org-switch-to-buffer-other-window "*Org Note*")
12327 (erase-buffer)
12328 (if (memq org-log-note-how '(time state))
12329 (let (current-prefix-arg) (org-store-log-note))
12330 (let ((org-inhibit-startup t)) (org-mode))
12331 (insert (format "# Insert note for %s.
12333 (cond
12334 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12335 ((eq org-log-note-purpose 'done) "closed todo item")
12336 ((eq org-log-note-purpose 'state)
12338 (or org-log-note-previous-state "")
12339 (or org-log-note-state "")))
12340 ((eq org-log-note-purpose 'reschedule)
12341 "rescheduling")
12342 ((eq org-log-note-purpose 'delschedule)
12343 "no longer scheduled")
12344 ((eq org-log-note-purpose 'redeadline)
12345 "changing deadline")
12346 ((eq org-log-note-purpose 'deldeadline)
12347 "removing deadline")
12348 ((eq org-log-note-purpose 'refile)
12349 "refiling")
12350 ((eq org-log-note-purpose 'note)
12351 "this entry")
12352 (t (error "This should not happen")))))
12353 (if org-log-note-extra (insert org-log-note-extra))
12354 (org-set-local 'org-finish-function 'org-store-log-note)
12355 (run-hooks 'org-log-buffer-setup-hook)))
12357 (defvar org-note-abort nil) ; dynamically scoped
12358 (defun org-store-log-note ()
12359 "Finish taking a log note, and insert it to where it belongs."
12360 (let ((txt (buffer-string))
12361 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12362 lines ind bul)
12363 (kill-buffer (current-buffer))
12365 (setq txt (replace-match "" t t txt)))
12367 (setq txt (replace-match "" t t txt)))
12370 (setq note
12371 (org-replace-escapes
12372 note
12373 (list (cons "%u" (user-login-name))
12374 (cons "%U" user-full-name)
12375 (cons "%t" (format-time-string
12376 (org-time-stamp-format 'long 'inactive)
12377 org-log-note-effective-time))
12378 (cons "%T" (format-time-string
12379 (org-time-stamp-format 'long nil)
12380 org-log-note-effective-time))
12381 (cons "%d" (format-time-string
12382 (org-time-stamp-format nil 'inactive)
12383 org-log-note-effective-time))
12384 (cons "%D" (format-time-string
12385 (org-time-stamp-format nil nil)
12386 org-log-note-effective-time))
12387 (cons "%s" (if org-log-note-state
12389 ""))
12390 (cons "%S" (if org-log-note-previous-state
12394 (push note lines))
12395 (when (or current-prefix-arg org-note-abort)
12396 (when org-log-into-drawer
12397 (org-remove-empty-drawer-at
12398 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12399 org-log-note-marker))
12400 (setq lines nil))
12401 (when lines
12402 (with-current-buffer (marker-buffer org-log-note-marker)
12403 (save-excursion
12404 (goto-char org-log-note-marker)
12405 (move-marker org-log-note-marker nil)
12406 (end-of-line 1)
12408 (setq ind (save-excursion
12409 (if (ignore-errors (goto-char (org-in-item-p)))
12410 (let ((struct (org-list-struct)))
12411 (org-list-get-ind
12412 (org-list-get-top-point struct) struct))
12414 (cond
12415 ((and (org-at-heading-p)
12416 org-adapt-indentation)
12417 (1+ (org-current-level)))
12418 ((org-at-heading-p) 0)
12419 (t (org-get-indentation))))))
12420 (setq bul (org-list-bullet-string "-"))
12421 (org-indent-line-to ind)
12422 (insert bul (pop lines))
12423 (let ((ind-body (+ (length bul) ind)))
12424 (while lines
12426 (org-indent-line-to ind-body)
12427 (insert (pop lines))))
12428 (message "Note stored")
12429 (org-back-to-heading t)
12430 (org-cycle-hide-drawers 'children)))))
12431 (set-window-configuration org-log-note-window-configuration)
12432 (with-current-buffer (marker-buffer org-log-note-return-to)
12433 (goto-char org-log-note-return-to))
12434 (move-marker org-log-note-return-to nil)
12435 (and org-log-post-message (message "%s" org-log-post-message)))
12437 (defun org-remove-empty-drawer-at (drawer pos)
12438 "Remove an empty drawer DRAWER at position POS.
12439 POS may also be a marker."
12440 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12441 (save-excursion
12442 (save-restriction
12443 (widen)
12444 (goto-char pos)
12445 (if (org-in-regexp
12447 (replace-match ""))))))
12449 (defun org-sparse-tree (&optional arg)
12450 "Create a sparse tree, prompt for the details.
12451 This command can create sparse trees. You first need to select the type
12452 of match used to create the tree:
12454 t Show all TODO entries.
12455 T Show entries with a specific TODO keyword.
12456 m Show entries selected by a tags/property match.
12457 p Enter a property name and its value (both with completion on existing
12458 names/values) and show entries with that property.
12459 r Show entries matching a regular expression (`/' can be used as well)
12460 d Show deadlines due within `org-deadline-warning-days'.
12461 b Show deadlines and scheduled items before a date.
12462 a Show deadlines and scheduled items after a date."
12463 (interactive "P")
12464 (let (ans kwd value)
12465 (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")
12466 (setq ans (read-char-exclusive))
12467 (cond
12468 ((equal ans ?d)
12469 (call-interactively 'org-check-deadlines))
12470 ((equal ans ?b)
12471 (call-interactively 'org-check-before-date))
12472 ((equal ans ?a)
12473 (call-interactively 'org-check-after-date))
12474 ((equal ans ?D)
12475 (call-interactively 'org-check-dates-range))
12476 ((equal ans ?t)
12477 (org-show-todo-tree nil))
12478 ((equal ans ?T)
12479 (org-show-todo-tree '(4)))
12480 ((member ans '(?T ?m))
12481 (call-interactively 'org-match-sparse-tree))
12482 ((member ans '(?p ?P))
12483 (setq kwd (org-icompleting-read "Property: "
12484 (mapcar 'list (org-buffer-property-keys))))
12485 (setq value (org-icompleting-read "Value: "
12486 (mapcar 'list (org-property-values kwd))))
12489 (org-match-sparse-tree arg (concat kwd "=" value)))
12490 ((member ans '(?r ?R ?/))
12491 (call-interactively 'org-occur))
12494 (defvar org-occur-highlights nil
12495 "List of overlays used for occur matches.")
12496 (make-variable-buffer-local 'org-occur-highlights)
12497 (defvar org-occur-parameters nil
12498 "Parameters of the active org-occur calls.
12499 This is a list, each call to org-occur pushes as cons cell,
12500 containing the regular expression and the callback, onto the list.
12501 The list can contain several entries if `org-occur' has been called
12502 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12503 will only contain one set of parameters. When the highlights are
12504 removed (for example with `C-c C-c', or with the next edit (depending
12505 on `org-remove-highlights-with-change'), this variable is emptied
12506 as well.")
12507 (make-variable-buffer-local 'org-occur-parameters)
12509 (defun org-occur (regexp &optional keep-previous callback)
12510 "Make a compact tree which shows all matches of REGEXP.
12511 The tree will show the lines where the regexp matches, and all higher
12512 headlines above the match. It will also show the heading after the match,
12513 to make sure editing the matching entry is easy.
12514 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12515 call to `org-occur' will be kept, to allow stacking of calls to this
12516 command.
12517 If CALLBACK is non-nil, it is a function which is called to confirm
12518 that the match should indeed be shown."
12520 (when (equal regexp "")
12521 (error "Regexp cannot be empty"))
12522 (unless keep-previous
12523 (org-remove-occur-highlights nil nil t))
12524 (push (cons regexp callback) org-occur-parameters)
12525 (let ((cnt 0))
12526 (save-excursion
12527 (goto-char (point-min))
12528 (if (or (not keep-previous) ; do not want to keep
12529 (not org-occur-highlights)) ; no previous matches
12530 ;; hide everything
12531 (org-overview))
12532 (while (re-search-forward regexp nil t)
12533 (when (or (not callback)
12534 (save-match-data (funcall callback)))
12535 (setq cnt (1+ cnt))
12536 (when org-highlight-sparse-tree-matches
12537 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12538 (org-show-context 'occur-tree))))
12539 (when org-remove-highlights-with-change
12540 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12541 nil 'local))
12542 (unless org-sparse-tree-open-archived-trees
12543 (org-hide-archived-subtrees (point-min) (point-max)))
12544 (run-hooks 'org-occur-hook)
12545 (if (org-called-interactively-p 'interactive)
12546 (message "%d match(es) for regexp %s" cnt regexp))
12547 cnt))
12549 (defun org-occur-next-match (&optional n reset)
12550 "Function for `next-error-function' to find sparse tree matches.
12551 N is the number of matches to move, when negative move backwards.
12552 RESET is entirely ignored - this function always goes back to the
12553 starting point when no match is found."
12554 (let* ((limit (if (< n 0) (point-min) (point-max)))
12555 (search-func (if (< n 0)
12556 'previous-single-char-property-change
12557 'next-single-char-property-change))
12558 (n (abs n))
12559 (pos (point))
12560 p1)
12561 (catch 'exit
12562 (while (setq p1 (funcall search-func (point) 'org-type))
12563 (when (equal p1 limit)
12564 (goto-char pos)
12565 (error "No more matches"))
12566 (when (equal (get-char-property p1 'org-type) 'org-occur)
12567 (setq n (1- n))
12568 (when (= n 0)
12569 (goto-char p1)
12570 (throw 'exit (point))))
12571 (goto-char p1))
12572 (goto-char p1)
12573 (error "No more matches"))))
12575 (defun org-show-context (&optional key)
12576 "Make sure point and context are visible.
12577 How much context is shown depends upon the variables
12578 `org-show-hierarchy-above', `org-show-following-heading',
12579 `org-show-entry-below' and `org-show-siblings'."
12580 (let ((heading-p (org-at-heading-p t))
12581 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12582 (following-p (org-get-alist-option org-show-following-heading key))
12583 (entry-p (org-get-alist-option org-show-entry-below key))
12584 (siblings-p (org-get-alist-option org-show-siblings key)))
12585 (catch 'exit
12586 ;; Show heading or entry text
12587 (if (and heading-p (not entry-p))
12588 (org-flag-heading nil) ; only show the heading
12589 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12590 (org-show-hidden-entry))) ; show entire entry
12591 (when following-p
12592 ;; Show next sibling, or heading below text
12593 (save-excursion
12594 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12595 (org-flag-heading nil))))
12596 (when siblings-p (org-show-siblings))
12597 (when hierarchy-p
12598 ;; show all higher headings, possibly with siblings
12599 (save-excursion
12600 (while (and (condition-case nil
12601 (progn (org-up-heading-all 1) t)
12602 (error nil))
12603 (not (bobp)))
12604 (org-flag-heading nil)
12605 (when siblings-p (org-show-siblings))))))))
12607 (defvar org-reveal-start-hook nil
12608 "Hook run before revealing a location.")
12610 (defun org-reveal (&optional siblings)
12611 "Show current entry, hierarchy above it, and the following headline.
12612 This can be used to show a consistent set of context around locations
12613 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12614 not t for the search context.
12616 With optional argument SIBLINGS, on each level of the hierarchy all
12617 siblings are shown. This repairs the tree structure to what it would
12618 look like when opened with hierarchical calls to `org-cycle'.
12620 go to the parent and show the
12621 entire tree."
12622 (interactive "P")
12623 (run-hooks 'org-reveal-start-hook)
12624 (let ((org-show-hierarchy-above t)
12625 (org-show-following-heading t)
12626 (org-show-siblings (if siblings t org-show-siblings)))
12627 (org-show-context nil))
12628 (when (equal siblings '(16))
12629 (save-excursion
12630 (when (org-up-heading-safe)
12631 (org-show-subtree)
12632 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12634 (defun org-highlight-new-match (beg end)
12635 "Highlight from BEG to END and mark the highlight is an occur headline."
12636 (let ((ov (make-overlay beg end)))
12637 (overlay-put ov 'face 'secondary-selection)
12638 (overlay-put ov 'org-type 'org-occur)
12639 (push ov org-occur-highlights)))
12641 (defun org-remove-occur-highlights (&optional beg end noremove)
12642 "Remove the occur highlights from the buffer.
12643 BEG and END are ignored. If NOREMOVE is nil, remove this function
12644 from the `before-change-functions' in the current buffer."
12645 (interactive)
12646 (unless org-inhibit-highlight-removal
12647 (mapc 'delete-overlay org-occur-highlights)
12648 (setq org-occur-highlights nil)
12649 (setq org-occur-parameters nil)
12650 (unless noremove
12651 (remove-hook 'before-change-functions
12652 'org-remove-occur-highlights 'local))))
12654 ;;;; Priorities
12657 "Regular expression matching the priority indicator.")
12659 (defvar org-remove-priority-next-time nil)
12661 (defun org-priority-up ()
12662 "Increase the priority of the current item."
12663 (interactive)
12664 (org-priority 'up))
12666 (defun org-priority-down ()
12667 "Decrease the priority of the current item."
12668 (interactive)
12669 (org-priority 'down))
12671 (defun org-priority (&optional action)
12672 "Change the priority of an item by ARG.
12673 ACTION can be `set', `up', `down', or a character."
12674 (interactive)
12675 (unless org-enable-priority-commands
12676 (error "Priority commands are disabled"))
12677 (setq action (or action 'set))
12678 (let (current new news have remove)
12679 (save-excursion
12680 (org-back-to-heading t)
12681 (if (looking-at org-priority-regexp)
12682 (setq current (string-to-char (match-string 2))
12683 have t))
12684 (cond
12685 ((eq action 'remove)
12686 (setq remove t new ?\ ))
12687 ((or (eq action 'set)
12688 (if (featurep 'xemacs) (characterp action) (integerp action)))
12689 (if (not (eq action 'set))
12690 (setq new action)
12691 (message "Priority %c-%c, SPC to remove: "
12692 org-highest-priority org-lowest-priority)
12693 (save-match-data
12694 (setq new (read-char-exclusive))))
12695 (if (and (= (upcase org-highest-priority) org-highest-priority)
12696 (= (upcase org-lowest-priority) org-lowest-priority))
12697 (setq new (upcase new)))
12698 (cond ((equal new ?\ ) (setq remove t))
12699 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12700 (error "Priority must be between `%c' and `%c'"
12701 org-highest-priority org-lowest-priority))))
12702 ((eq action 'up)
12703 (setq new (if have
12704 (1- current) ; normal cycling
12705 ;; last priority was empty
12706 (if (eq last-command this-command)
12707 org-lowest-priority ; wrap around empty to lowest
12708 ;; default
12709 (if org-priority-start-cycle-with-default
12710 org-default-priority
12711 (1- org-default-priority))))))
12712 ((eq action 'down)
12713 (setq new (if have
12714 (1+ current) ; normal cycling
12715 ;; last priority was empty
12716 (if (eq last-command this-command)
12717 org-highest-priority ; wrap around empty to highest
12718 ;; default
12719 (if org-priority-start-cycle-with-default
12720 org-default-priority
12721 (1+ org-default-priority))))))
12722 (t (error "Invalid action")))
12723 (if (or (< (upcase new) org-highest-priority)
12724 (> (upcase new) org-lowest-priority))
12725 (if (and (memq action '(up down))
12726 (not have) (not (eq last-command this-command)))
12727 ;; `new' is from default priority
12728 (error
12729 "The default can not be set, see `org-default-priority' why")
12730 ;; normal cycling: `new' is beyond highest/lowest priority
12731 ;; and is wrapped around to the empty priority
12732 (setq remove t)))
12733 (setq news (format "%c" new))
12734 (if have
12735 (if remove
12736 (replace-match "" t t nil 1)
12737 (replace-match news t t nil 2))
12738 (if remove
12739 (error "No priority cookie found in line")
12740 (let ((case-fold-search nil))
12741 (looking-at org-todo-line-regexp))
12742 (if (match-end 2)
12743 (progn
12744 (goto-char (match-end 2))
12745 (insert " [#" news "]"))
12746 (goto-char (match-beginning 3))
12747 (insert "[#" news "] "))))
12748 (org-preserve-lc (org-set-tags nil 'align)))
12749 (if remove
12750 (message "Priority removed")
12751 (message "Priority of current item set to %s" news))))
12753 (defun org-get-priority (s)
12754 "Find priority cookie and return priority."
12755 (if (functionp org-get-priority-function)
12756 (funcall org-get-priority-function)
12757 (save-match-data
12758 (if (not (string-match org-priority-regexp s))
12759 (* 1000 (- org-lowest-priority org-default-priority))
12760 (* 1000 (- org-lowest-priority
12761 (string-to-char (match-string 2 s))))))))
12763 ;;;; Tags
12765 (defvar org-agenda-archives-mode)
12766 (defvar org-map-continue-from nil
12767 "Position from where mapping should continue.
12768 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12770 (defvar org-scanner-tags nil
12771 "The current tag list while the tags scanner is running.")
12772 (defvar org-trust-scanner-tags nil
12773 "Should `org-get-tags-at' use the tags for the scanner.
12774 This is for internal dynamical scoping only.
12775 When this is non-nil, the function `org-get-tags-at' will return the value
12776 of `org-scanner-tags' instead of building the list by itself. This
12777 can lead to large speed-ups when the tags scanner is used in a file with
12778 many entries, and when the list of tags is retrieved, for example to
12779 obtain a list of properties. Building the tags list for each entry in such
12780 a file becomes an N^2 operation - but with this variable set, it scales
12781 as N.")
12783 (defun org-scan-tags (action matcher &optional todo-only start-level)
12784 "Scan headline tags with inheritance and produce output ACTION.
12786 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12787 or `agenda' to produce an entry list for an agenda view. It can also be
12788 a Lisp form or a function that should be called at each matched headline, in
12789 this case the return value is a list of all return values from these calls.
12791 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12792 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12793 only lines with a TODO keyword are included in the output.
12795 START-LEVEL can be a string with asterisks, reducing the scope to
12796 headlines matching this string."
12797 (require 'org-agenda)
12798 (let* ((re (concat "^"
12799 (if start-level
12800 ;; Get the correct level to match
12802 org-outline-regexp)
12805 (org-re
12807 (props (list 'face 'default
12808 'done-face 'org-agenda-done
12809 'undone-face 'default
12810 'mouse-face 'highlight
12811 'org-not-done-regexp org-not-done-regexp
12812 'org-todo-regexp org-todo-regexp
12813 'org-complex-heading-regexp org-complex-heading-regexp
12814 'help-echo
12815 (format "mouse-2 or RET jump to org file %s"
12816 (abbreviate-file-name
12817 (or (buffer-file-name (buffer-base-buffer))
12818 (buffer-name (buffer-base-buffer)))))))
12819 (case-fold-search nil)
12820 (org-map-continue-from nil)
12821 lspos tags
12822 (tags-alist (list (cons 0 org-file-tags)))
12823 (llast 0) rtn rtn1 level category i txt
12824 todo marker entry priority)
12825 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12826 (setq action (list 'lambda nil action)))
12827 (save-excursion
12828 (goto-char (point-min))
12829 (when (eq action 'sparse-tree)
12830 (org-overview)
12831 (org-remove-occur-highlights))
12832 (while (re-search-forward re nil t)
12833 (setq org-map-continue-from nil)
12834 (catch :skip
12835 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12836 tags (if (match-end 4) (org-match-string-no-properties 4)))
12837 (goto-char (setq lspos (match-beginning 0)))
12838 (setq level (org-reduced-level (funcall outline-level))
12839 category (org-get-category))
12840 (setq i llast llast level)
12841 ;; remove tag lists from same and sublevels
12842 (while (>= i level)
12843 (when (setq entry (assoc i tags-alist))
12844 (setq tags-alist (delete entry tags-alist)))
12845 (setq i (1- i)))
12846 ;; add the next tags
12847 (when tags
12848 (setq tags (org-split-string tags ":")
12849 tags-alist
12850 (cons (cons level tags) tags-alist)))
12851 ;; compile tags for current headline
12852 (setq tags-list
12853 (if org-use-tag-inheritance
12854 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12855 tags)
12856 org-scanner-tags tags-list)
12857 (when org-use-tag-inheritance
12858 (setcdr (car tags-alist)
12859 (mapcar (lambda (x)
12860 (setq x (copy-sequence x))
12861 (org-add-prop-inherited x))
12862 (cdar tags-alist))))
12863 (when (and tags org-use-tag-inheritance
12864 (or (not (eq t org-use-tag-inheritance))
12865 org-tags-exclude-from-inheritance))
12866 ;; selective inheritance, remove uninherited ones
12867 (setcdr (car tags-alist)
12868 (org-remove-uninherited-tags (cdar tags-alist))))
12869 (when (and
12871 ;; eval matcher only when the todo condition is OK
12872 (and (or (not todo-only) (member todo org-not-done-keywords))
12873 (let ((case-fold-search t)) (eval matcher)))
12875 ;; Call the skipper, but return t if it does not skip,
12876 ;; so that the `and' form continues evaluating
12877 (progn
12878 (unless (eq action 'sparse-tree) (org-agenda-skip))
12879 t)
12881 ;; Check if timestamps are deselecting this entry
12882 (or (not todo-only)
12883 (and (member todo org-not-done-keywords)
12884 (or (not org-agenda-tags-todo-honor-ignore-options)
12885 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12887 ;; Extra check for the archive tag
12888 ;; FIXME: Does the skipper already do this????
12889 (or
12890 (not (member org-archive-tag tags-list))
12891 ;; we have an archive tag, should we use this anyway?
12892 (or (not org-agenda-skip-archived-trees)
12893 (and (eq action 'agenda) org-agenda-archives-mode))))
12895 ;; select this headline
12897 (cond
12898 ((eq action 'sparse-tree)
12899 (and org-highlight-sparse-tree-matches
12900 (org-get-heading) (match-end 0)
12901 (org-highlight-new-match
12902 (match-beginning 1) (match-end 1)))
12903 (org-show-context 'tags-tree))
12904 ((eq action 'agenda)
12905 (setq txt (org-agenda-format-item
12906 ""
12907 (concat
12908 (if (eq org-tags-match-list-sublevels 'indented)
12909 (make-string (1- level) ?.) "")
12910 (org-get-heading))
12911 category
12912 tags-list)
12913 priority (org-get-priority txt))
12914 (goto-char lspos)
12915 (setq marker (org-agenda-new-marker))
12916 (org-add-props txt props
12917 'org-marker marker 'org-hd-marker marker 'org-category category
12918 'todo-state todo
12919 'priority priority 'type "tagsmatch")
12920 (push txt rtn))
12921 ((functionp action)
12922 (setq org-map-continue-from nil)
12923 (save-excursion
12924 (setq rtn1 (funcall action))
12925 (push rtn1 rtn)))
12926 (t (error "Invalid action")))
12928 ;; if we are to skip sublevels, jump to end of subtree
12929 (unless org-tags-match-list-sublevels
12930 (org-end-of-subtree t)
12931 (backward-char 1))))
12932 ;; Get the correct position from where to continue
12933 (if org-map-continue-from
12934 (goto-char org-map-continue-from)
12935 (and (= (point) lspos) (end-of-line 1)))))
12936 (when (and (eq action 'sparse-tree)
12937 (not org-sparse-tree-open-archived-trees))
12938 (org-hide-archived-subtrees (point-min) (point-max)))
12939 (nreverse rtn)))
12941 (defun org-remove-uninherited-tags (tags)
12942 "Remove all tags that are not inherited from the list TAGS."
12943 (cond
12944 ((eq org-use-tag-inheritance t)
12945 (if org-tags-exclude-from-inheritance
12946 (org-delete-all org-tags-exclude-from-inheritance tags)
12947 tags))
12948 ((not org-use-tag-inheritance) nil)
12949 ((stringp org-use-tag-inheritance)
12950 (delq nil (mapcar
12951 (lambda (x)
12952 (if (and (string-match org-use-tag-inheritance x)
12953 (not (member x org-tags-exclude-from-inheritance)))
12954 x nil))
12955 tags)))
12956 ((listp org-use-tag-inheritance)
12957 (delq nil (mapcar
12958 (lambda (x)
12959 (if (member x org-use-tag-inheritance) x nil))
12960 tags)))))
12962 (defvar todo-only) ;; dynamically scoped
12964 (defun org-match-sparse-tree (&optional todo-only match)
12965 "Create a sparse tree according to tags string MATCH.
12966 MATCH can contain positive and negative selection of tags, like
12968 If optional argument TODO-ONLY is non-nil, only select lines that are
12969 also TODO lines."
12970 (interactive "P")
12971 (org-prepare-agenda-buffers (list (current-buffer)))
12972 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12974 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12976 (defvar org-cached-props nil)
12977 (defun org-cached-entry-get (pom property)
12978 (if (or (eq t org-use-property-inheritance)
12979 (and (stringp org-use-property-inheritance)
12980 (string-match org-use-property-inheritance property))
12981 (and (listp org-use-property-inheritance)
12982 (member property org-use-property-inheritance)))
12983 ;; Caching is not possible, check it directly
12984 (org-entry-get pom property 'inherit)
12985 ;; Get all properties, so that we can do complicated checks easily
12986 (cdr (assoc property (or org-cached-props
12987 (setq org-cached-props
12988 (org-entry-properties pom)))))))
12990 (defun org-global-tags-completion-table (&optional files)
12991 "Return the list of all tags in all agenda buffer/files.
12992 Optional FILES argument is a list of files to which can be used
12993 instead of the agenda files."
12994 (save-excursion
12995 (org-uniquify
12996 (delq nil
12997 (apply 'append
12998 (mapcar
12999 (lambda (file)
13000 (set-buffer (find-file-noselect file))
13001 (append (org-get-buffer-tags)
13002 (mapcar (lambda (x) (if (stringp (car-safe x))
13003 (list (car-safe x)) nil))
13004 org-tag-alist)))
13005 (if (and files (car files))
13006 files
13007 (org-agenda-files))))))))
13009 (defun org-make-tags-matcher (match)
13010 "Create the TAGS/TODO matcher form for the selection string MATCH."
13011 ;; todo-only is scoped dynamically into this function, and the function
13012 ;; may change it if the matcher asks for it.
13013 (unless match
13014 ;; Get a new match request, with completion
13015 (let ((org-last-tags-completion-table
13016 (org-global-tags-completion-table)))
13017 (setq match (org-completing-read-no-i
13018 "Match: " 'org-tags-completion-function nil nil nil
13019 'org-tags-history))))
13021 ;; Parse the string and create a lisp form
13022 (let ((match0 match)
13023 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13024 minus tag mm
13025 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13026 orterms term orlist re-p str-p level-p level-op time-p
13027 prop-p pn pv po gv rest)
13028 (if (string-match "/+" match)
13029 ;; match contains also a todo-matching request
13030 (progn
13031 (setq tagsmatch (substring match 0 (match-beginning 0))
13032 todomatch (substring match (match-end 0)))
13033 (if (string-match "^!" todomatch)
13034 (setq todo-only t todomatch (substring todomatch 1)))
13036 (setq todomatch nil)))
13037 ;; only matching tags
13038 (setq tagsmatch match todomatch nil))
13040 ;; Make the tags matcher
13042 (setq tagsmatcher t)
13043 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13044 (while (setq term (pop orterms))
13046 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13047 (while (string-match re term)
13048 (setq rest (substring term (match-end 0))
13049 minus (and (match-end 1)
13050 (equal (match-string 1 term) "-"))
13051 tag (save-match-data (replace-regexp-in-string
13053 (match-string 2 term)))
13054 re-p (equal (string-to-char tag) ?{)
13055 level-p (match-end 4)
13056 prop-p (match-end 5)
13057 mm (cond
13058 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13059 (level-p
13060 (setq level-op (org-op-to-function (match-string 3 term)))
13061 `(,level-op level ,(string-to-number
13062 (match-string 4 term))))
13063 (prop-p
13064 (setq pn (match-string 5 term)
13065 po (match-string 6 term)
13066 pv (match-string 7 term)
13067 re-p (equal (string-to-char pv) ?{)
13069 time-p (save-match-data
13071 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13072 (if time-p (setq pv (org-matcher-time pv)))
13073 (setq po (org-op-to-function po (if time-p 'time str-p)))
13074 (cond
13075 ((equal pn "CATEGORY")
13076 (setq gv '(get-text-property (point) 'org-category)))
13077 ((equal pn "TODO")
13078 (setq gv 'todo))
13079 (t
13080 (setq gv `(org-cached-entry-get nil ,pn))))
13081 (if re-p
13082 (if (eq po 'org<>)
13083 `(not (string-match ,pv (or ,gv "")))
13084 `(string-match ,pv (or ,gv "")))
13085 (if str-p
13086 `(,po (or ,gv "") ,pv)
13087 `(,po (string-to-number (or ,gv ""))
13088 ,(string-to-number pv) ))))
13089 (t `(member ,tag tags-list)))
13090 mm (if minus (list 'not mm) mm)
13091 term rest)
13092 (push mm tagsmatcher))
13093 (push (if (> (length tagsmatcher) 1)
13094 (cons 'and tagsmatcher)
13095 (car tagsmatcher))
13096 orlist)
13097 (setq tagsmatcher nil))
13098 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13099 (setq tagsmatcher
13100 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13101 ;; Make the todo matcher
13103 (setq todomatcher t)
13104 (setq orterms (org-split-string todomatch "|") orlist nil)
13105 (while (setq term (pop orterms))
13106 (while (string-match re term)
13107 (setq minus (and (match-end 1)
13108 (equal (match-string 1 term) "-"))
13109 kwd (match-string 2 term)
13110 re-p (equal (string-to-char kwd) ?{)
13111 term (substring term (match-end 0))
13112 mm (if re-p
13113 `(string-match ,(substring kwd 1 -1) todo)
13114 (list 'equal 'todo kwd))
13115 mm (if minus (list 'not mm) mm))
13116 (push mm todomatcher))
13117 (push (if (> (length todomatcher) 1)
13118 (cons 'and todomatcher)
13119 (car todomatcher))
13120 orlist)
13121 (setq todomatcher nil))
13122 (setq todomatcher (if (> (length orlist) 1)
13123 (cons 'or orlist) (car orlist))))
13125 ;; Return the string and lisp forms of the matcher
13126 (setq matcher (if todomatcher
13127 (list 'and tagsmatcher todomatcher)
13128 tagsmatcher))
13129 (cons match0 matcher)))
13131 (defun org-op-to-function (op &optional stringp)
13132 "Turn an operator into the appropriate function."
13133 (setq op
13134 (cond
13135 ((equal op "<" ) '(< string< org-time<))
13136 ((equal op ">" ) '(> org-string> org-time>))
13137 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13138 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13139 ((member op '("=" "==")) '(= string= org-time=))
13140 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13141 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13143 (defun org<> (a b) (not (= a b)))
13144 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13145 (defun org-string>= (a b) (not (string< a b)))
13146 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13147 (defun org-string<> (a b) (not (string= a b)))
13148 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13149 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13150 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13151 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13152 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13153 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13154 (defun org-2ft (s)
13155 "Convert S to a floating point time.
13156 If S is already a number, just return it. If it is a string, parse
13157 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13158 (cond
13159 ((numberp s) s)
13160 ((stringp s)
13161 (condition-case nil
13162 (float-time (apply 'encode-time (org-parse-time-string s)))
13163 (error 0.)))
13164 (t 0.)))
13166 (defun org-time-today ()
13167 "Time in seconds today at 0:00.
13168 Returns the float number of seconds since the beginning of the
13169 epoch to the beginning of today (00:00)."
13170 (float-time (apply 'encode-time
13171 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13173 (defun org-matcher-time (s)
13174 "Interpret a time comparison value."
13175 (save-match-data
13176 (cond
13177 ((string= s "<now>") (float-time))
13178 ((string= s "<today>") (org-time-today))
13179 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13180 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13182 (+ (org-time-today)
13183 (* (string-to-number (match-string 1 s))
13184 (cdr (assoc (match-string 2 s)
13185 '(("d" . 86400.0) ("w" . 604800.0)
13186 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13187 (t (org-2ft s)))))
13189 (defun org-match-any-p (re list)
13190 "Does re match any element of list?"
13191 (setq list (mapcar (lambda (x) (string-match re x)) list))
13192 (delq nil list))
13194 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13195 (defvar org-tags-overlay (make-overlay 1 1))
13196 (org-detach-overlay org-tags-overlay)
13198 (defun org-get-local-tags-at (&optional pos)
13199 "Get a list of tags defined in the current headline."
13200 (org-get-tags-at pos 'local))
13202 (defun org-get-local-tags ()
13203 "Get a list of tags defined in the current headline."
13204 (org-get-tags-at nil 'local))
13206 (defun org-get-tags-at (&optional pos local)
13207 "Get a list of all headline tags applicable at POS.
13208 POS defaults to point. If tags are inherited, the list contains
13209 the targets in the same sequence as the headlines appear, i.e.
13210 the tags of the current headline come last.
13211 When LOCAL is non-nil, only return tags from the current headline,
13212 ignore inherited ones."
13213 (interactive)
13214 (if (and org-trust-scanner-tags
13215 (or (not pos) (equal pos (point)))
13216 (not local))
13217 org-scanner-tags
13218 (let (tags ltags lastpos parent)
13219 (save-excursion
13220 (save-restriction
13221 (widen)
13222 (goto-char (or pos (point)))
13223 (save-match-data
13224 (catch 'done
13225 (condition-case nil
13226 (progn
13227 (org-back-to-heading t)
13228 (while (not (equal lastpos (point)))
13229 (setq lastpos (point))
13230 (when (looking-at
13232 (setq ltags (org-split-string
13233 (org-match-string-no-properties 1) ":"))
13234 (when parent
13235 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13236 (setq tags (append
13237 (if parent
13238 (org-remove-uninherited-tags ltags)
13239 ltags)
13240 tags)))
13241 (or org-use-tag-inheritance (throw 'done t))
13242 (if local (throw 'done t))
13243 (or (org-up-heading-safe) (error nil))
13244 (setq parent t)))
13245 (error nil)))))
13246 (if local
13247 tags
13248 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13250 (defun org-add-prop-inherited (s)
13251 (add-text-properties 0 (length s) '(inherited t) s)
13252 s)
13254 (defun org-toggle-tag (tag &optional onoff)
13255 "Toggle the tag TAG for the current line.
13256 If ONOFF is `on' or `off', don't toggle but set to this state."
13257 (let (res current)
13258 (save-excursion
13259 (org-back-to-heading t)
13261 (point-at-eol) t)
13262 (progn
13263 (setq current (match-string 1))
13264 (replace-match ""))
13265 (setq current ""))
13266 (setq current (nreverse (org-split-string current ":")))
13267 (cond
13268 ((eq onoff 'on)
13269 (setq res t)
13270 (or (member tag current) (push tag current)))
13271 ((eq onoff 'off)
13272 (or (not (member tag current)) (setq current (delete tag current))))
13273 (t (if (member tag current)
13274 (setq current (delete tag current))
13275 (setq res t)
13276 (push tag current))))
13277 (end-of-line 1)
13278 (if current
13279 (progn
13280 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13281 (org-set-tags nil t))
13282 (delete-horizontal-space))
13283 (run-hooks 'org-after-tags-change-hook))
13284 res))
13286 (defun org-align-tags-here (to-col)
13287 ;; Assumes that this is a headline
13288 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13289 (beginning-of-line 1)
13291 (< pos (match-beginning 2)))
13292 (progn
13293 (setq tags-l (- (match-end 2) (match-beginning 2)))
13294 (goto-char (match-beginning 1))
13295 (insert " ")
13296 (delete-region (point) (1+ (match-beginning 2)))
13297 (setq ncol (max (current-column)
13298 (1+ col)
13299 (if (> to-col 0)
13300 to-col
13301 (- (abs to-col) tags-l))))
13302 (setq p (point))
13303 (insert (make-string (- ncol (current-column)) ?\ ))
13304 (setq ncol (current-column))
13305 (when indent-tabs-mode (tabify p (point-at-eol)))
13306 (org-move-to-column (min ncol col) t))
13307 (goto-char pos))))
13309 (defun org-set-tags-command (&optional arg just-align)
13310 "Call the set-tags command for the current entry."
13311 (interactive "P")
13312 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13313 (org-set-tags arg just-align)
13314 (save-excursion
13315 (org-back-to-heading t)
13316 (org-set-tags arg just-align))))
13318 (defun org-set-tags-to (data)
13319 "Set the tags of the current entry to DATA, replacing the current tags.
13320 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13321 If DATA is nil or the empty string, any tags will be removed."
13322 (interactive "sTags: ")
13323 (setq data
13324 (cond
13325 ((eq data nil) "")
13326 ((equal data "") "")
13327 ((stringp data)
13328 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13329 ":"))
13330 ((listp data)
13331 (concat ":" (mapconcat 'identity data ":") ":"))
13332 (t nil)))
13333 (when data
13334 (save-excursion
13335 (org-back-to-heading t)
13336 (when (looking-at org-complex-heading-regexp)
13337 (if (match-end 5)
13338 (progn
13339 (goto-char (match-beginning 5))
13340 (insert data)
13341 (delete-region (point) (point-at-eol))
13342 (org-set-tags nil 'align))
13343 (goto-char (point-at-eol))
13344 (insert " " data)
13345 (org-set-tags nil 'align)))
13346 (beginning-of-line 1)
13348 (delete-region (match-beginning 1) (match-end 1))))))
13350 (defun org-align-all-tags ()
13351 "Align the tags i all headings."
13352 (interactive)
13353 (save-excursion
13354 (or (ignore-errors (org-back-to-heading t))
13355 (outline-next-heading))
13356 (if (org-at-heading-p)
13357 (org-set-tags t)
13358 (message "No headings"))))
13360 (defvar org-indent-indentation-per-level)
13361 (defun org-set-tags (&optional arg just-align)
13362 "Set the tags for the current headline.
13363 With prefix ARG, realign all tags in headings in the current buffer."
13364 (interactive "P")
13365 (let* ((re org-outline-regexp-bol)
13366 (current (unless arg (org-get-tags-string)))
13367 (col (current-column))
13368 (org-setting-tags t)
13369 table current-tags inherited-tags ; computed below when needed
13370 tags p0 c0 c1 rpl di tc level)
13371 (if arg
13372 (save-excursion
13373 (goto-char (point-min))
13374 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13375 (while (re-search-forward re nil t)
13376 (org-set-tags nil t)
13377 (end-of-line 1)))
13378 (message "All tags realigned to column %d" org-tags-column))
13379 (if just-align
13380 (setq tags current)
13381 ;; Get a new set of tags from the user
13382 (save-excursion
13383 (setq table (append org-tag-persistent-alist
13384 (or org-tag-alist (org-get-buffer-tags))
13385 (and
13386 org-complete-tags-always-offer-all-agenda-tags
13387 (org-global-tags-completion-table
13388 (org-agenda-files))))
13389 org-last-tags-completion-table table
13390 current-tags (org-split-string current ":")
13391 inherited-tags (nreverse
13392 (nthcdr (length current-tags)
13393 (nreverse (org-get-tags-at))))
13394 tags
13395 (if (or (eq t org-use-fast-tag-selection)
13396 (and org-use-fast-tag-selection
13397 (delq nil (mapcar 'cdr table))))
13398 (org-fast-tag-selection
13399 current-tags inherited-tags table
13400 (if org-fast-tag-selection-include-todo
13401 org-todo-key-alist))
13402 (let ((org-add-colon-after-tag-completion t))
13403 (org-trim
13404 (org-icompleting-read "Tags: "
13405 'org-tags-completion-function
13406 nil nil current 'org-tags-history))))))
13407 (while (string-match "[-+&]+" tags)
13408 ;; No boolean logic, just a list
13409 (setq tags (replace-match ":" t t tags))))
13411 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13413 (if org-tags-sort-function
13414 (setq tags (mapconcat 'identity
13415 (sort (org-split-string
13416 tags (org-re "[^[:alnum:]_@#%]+"))
13417 org-tags-sort-function) ":")))
13420 (setq tags "")
13421 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13422 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13424 ;; Insert new tags at the correct column
13425 (beginning-of-line 1)
13426 (setq level (or (and (looking-at org-outline-regexp)
13427 (- (match-end 0) (point) 1))
13428 1))
13429 (cond
13430 ((and (equal current "") (equal tags "")))
13431 ((re-search-forward
13433 (point-at-eol) t)
13434 (if (equal tags "")
13435 (setq rpl "")
13436 (goto-char (match-beginning 0))
13437 (setq c0 (current-column)
13438 ;; compute offset for the case of org-indent-mode active
13439 di (if org-indent-mode
13440 (* (1- org-indent-indentation-per-level) (1- level))
13441 0)
13442 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13443 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13444 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13445 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13446 (replace-match rpl t t)
13447 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13448 tags)
13449 (t (error "Tags alignment failed")))
13450 (org-move-to-column col)
13451 (unless just-align
13452 (run-hooks 'org-after-tags-change-hook)))))
13454 (defun org-change-tag-in-region (beg end tag off)
13455 "Add or remove TAG for each entry in the region.
13456 This works in the agenda, and also in an org-mode buffer."
13457 (interactive
13458 (list (region-beginning) (region-end)
13459 (let ((org-last-tags-completion-table
13460 (if (eq major-mode 'org-mode)
13461 (org-get-buffer-tags)
13462 (org-global-tags-completion-table))))
13463 (org-icompleting-read
13464 "Tag: " 'org-tags-completion-function nil nil nil
13465 'org-tags-history))
13466 (progn
13468 (equal (read-char-exclusive) ?r))))
13469 (if (fboundp 'deactivate-mark) (deactivate-mark))
13470 (let ((agendap (equal major-mode 'org-agenda-mode))
13471 l1 l2 m buf pos newhead (cnt 0))
13472 (goto-char end)
13473 (setq l2 (1- (org-current-line)))
13474 (goto-char beg)
13475 (setq l1 (org-current-line))
13476 (loop for l from l1 to l2 do
13477 (org-goto-line l)
13478 (setq m (get-text-property (point) 'org-hd-marker))
13479 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13480 (and agendap m))
13481 (setq buf (if agendap (marker-buffer m) (current-buffer))
13482 pos (if agendap m (point)))
13483 (with-current-buffer buf
13484 (save-excursion
13485 (save-restriction
13486 (goto-char pos)
13487 (setq cnt (1+ cnt))
13488 (org-toggle-tag tag (if off 'off 'on))
13489 (setq newhead (org-get-heading)))))
13490 (and agendap (org-agenda-change-all-lines newhead m))))
13491 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13493 (defun org-tags-completion-function (string predicate &optional flag)
13494 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13495 (confirm (lambda (x) (stringp (car x)))))
13497 (setq s1 (match-string 1 string)
13498 s2 (match-string 2 string))
13499 (setq s1 "" s2 string))
13500 (cond
13501 ((eq flag nil)
13502 ;; try completion
13503 (setq rtn (try-completion s2 ctable confirm))
13504 (if (stringp rtn)
13505 (setq rtn
13506 (concat s1 s2 (substring rtn (length s2))
13507 (if (and org-add-colon-after-tag-completion
13508 (assoc rtn ctable))
13509 ":" ""))))
13510 rtn)
13511 ((eq flag t)
13512 ;; all-completions
13513 (all-completions s2 ctable confirm)
13514 )
13515 ((eq flag 'lambda)
13516 ;; exact match?
13517 (assoc s2 ctable)))
13518 ))
13520 (defun org-fast-tag-insert (kwd tags face &optional end)
13521 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13522 (insert (format "%-12s" (concat kwd ":"))
13523 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13524 (or end "")))
13526 (defun org-fast-tag-show-exit (flag)
13527 (save-excursion
13528 (org-goto-line 3)
13530 (replace-match ""))
13531 (when flag
13532 (end-of-line 1)
13533 (org-move-to-column (- (window-width) 19) t)
13534 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13536 (defun org-set-current-tags-overlay (current prefix)
13537 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13538 (if (featurep 'xemacs)
13539 (org-overlay-display org-tags-overlay (concat prefix s)
13540 'secondary-selection)
13541 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13542 (org-overlay-display org-tags-overlay (concat prefix s)))))
13544 (defvar org-last-tag-selection-key nil)
13545 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13546 "Fast tag selection with single keys.
13547 CURRENT is the current list of tags in the headline, INHERITED is the
13548 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13549 possibly with grouping information. TODO-TABLE is a similar table with
13550 TODO keywords, should these have keys assigned to them.
13551 If the keys are nil, a-z are automatically assigned.
13552 Returns the new tags string, or nil to not change the current settings."
13553 (let* ((fulltable (append table todo-table))
13554 (maxlen (apply 'max (mapcar
13555 (lambda (x)
13556 (if (stringp (car x)) (string-width (car x)) 0))
13557 fulltable)))
13558 (buf (current-buffer))
13559 (expert (eq org-fast-tag-selection-single-key 'expert))
13560 (buffer-tags nil)
13561 (fwidth (+ maxlen 3 1 3))
13562 (ncol (/ (- (window-width) 4) fwidth))
13563 (i-face 'org-done)
13564 (c-face 'org-todo)
13565 tg cnt e c char c1 c2 ntable tbl rtn
13566 ov-start ov-end ov-prefix
13567 (exit-after-next org-fast-tag-selection-single-key)
13568 (done-keywords org-done-keywords)
13569 groups ingroup)
13570 (save-excursion
13571 (beginning-of-line 1)
13572 (if (looking-at
13574 (setq ov-start (match-beginning 1)
13575 ov-end (match-end 1)
13576 ov-prefix "")
13577 (setq ov-start (1- (point-at-eol))
13578 ov-end (1+ ov-start))
13580 (setq ov-prefix
13581 (concat
13582 (buffer-substring (1- (point)) (point))
13583 (if (> (current-column) org-tags-column)
13584 " "
13585 (make-string (- org-tags-column (current-column)) ?\ ))))))
13586 (move-overlay org-tags-overlay ov-start ov-end)
13587 (save-window-excursion
13588 (if expert
13589 (set-buffer (get-buffer-create " *Org tags*"))
13590 (delete-other-windows)
13591 (split-window-vertically)
13592 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13593 (erase-buffer)
13594 (org-set-local 'org-done-keywords done-keywords)
13597 (org-fast-tag-show-exit exit-after-next)
13598 (org-set-current-tags-overlay current ov-prefix)
13599 (setq tbl fulltable char ?a cnt 0)
13600 (while (setq e (pop tbl))
13601 (cond
13602 ((equal (car e) :startgroup)
13603 (push '() groups) (setq ingroup t)
13604 (when (not (= cnt 0))
13605 (setq cnt 0)
13607 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13608 ((equal (car e) :endgroup)
13609 (setq ingroup nil cnt 0)
13611 ((equal e '(:newline))
13612 (when (not (= cnt 0))
13613 (setq cnt 0)
13615 (setq e (car tbl))
13616 (while (equal (car tbl) '(:newline))
13618 (setq tbl (cdr tbl)))))
13619 (t
13620 (setq tg (copy-sequence (car e)) c2 nil)
13621 (if (cdr e)
13622 (setq c (cdr e))
13623 ;; automatically assign a character.
13624 (setq c1 (string-to-char
13625 (downcase (substring
13626 tg (if (= (string-to-char tg) ?@) 1 0)))))
13627 (if (or (rassoc c1 ntable) (rassoc c1 table))
13628 (while (or (rassoc char ntable) (rassoc char table))
13629 (setq char (1+ char)))
13630 (setq c2 c1))
13631 (setq c (or c2 char)))
13632 (if ingroup (push tg (car groups)))
13633 (setq tg (org-add-props tg nil 'face
13634 (cond
13635 ((not (assoc tg table))
13636 (org-get-todo-face tg))
13637 ((member tg current) c-face)
13638 ((member tg inherited) i-face)
13639 (t nil))))
13640 (if (and (= cnt 0) (not ingroup)) (insert " "))
13641 (insert "[" c "] " tg (make-string
13642 (- fwidth 4 (length tg)) ?\ ))
13643 (push (cons tg c) ntable)
13644 (when (= (setq cnt (1+ cnt)) ncol)
13646 (if ingroup (insert " "))
13647 (setq cnt 0)))))
13648 (setq ntable (nreverse ntable))
13650 (goto-char (point-min))
13651 (if (not expert) (org-fit-window-to-buffer))
13652 (setq rtn
13653 (catch 'exit
13654 (while t
13655 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13656 (if (not groups) "no " "")
13657 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13658 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13659 (setq org-last-tag-selection-key c)
13660 (cond
13662 ((= c ?!)
13663 (setq groups (not groups))
13664 (goto-char (point-min))
13665 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13666 ((= c ?\C-c)
13667 (if (not expert)
13668 (org-fast-tag-show-exit
13669 (setq exit-after-next (not exit-after-next)))
13670 (setq expert nil)
13671 (delete-other-windows)
13672 (set-window-buffer (split-window-vertically) " *Org tags*")
13673 (org-switch-to-buffer-other-window " *Org tags*")
13674 (org-fit-window-to-buffer)))
13675 ((or (= c ?\C-g)
13676 (and (= c ?q) (not (rassoc c ntable))))
13677 (org-detach-overlay org-tags-overlay)
13678 (setq quit-flag t))
13679 ((= c ?\ )
13680 (setq current nil)
13681 (if exit-after-next (setq exit-after-next 'now)))
13683 (condition-case nil
13684 (setq tg (org-icompleting-read
13685 "Tag: "
13686 (or buffer-tags
13687 (with-current-buffer buf
13688 (org-get-buffer-tags)))))
13689 (quit (setq tg "")))
13691 (add-to-list 'buffer-tags (list tg))
13692 (if (member tg current)
13693 (setq current (delete tg current))
13694 (push tg current)))
13695 (if exit-after-next (setq exit-after-next 'now)))
13696 ((setq e (rassoc c todo-table) tg (car e))
13697 (with-current-buffer buf
13698 (save-excursion (org-todo tg)))
13699 (if exit-after-next (setq exit-after-next 'now)))
13700 ((setq e (rassoc c ntable) tg (car e))
13701 (if (member tg current)
13702 (setq current (delete tg current))
13703 (loop for g in groups do
13704 (if (member tg g)
13705 (mapc (lambda (x)
13706 (setq current (delete x current)))
13707 g)))
13708 (push tg current))
13709 (if exit-after-next (setq exit-after-next 'now))))
13711 ;; Create a sorted list
13712 (setq current
13713 (sort current
13714 (lambda (a b)
13715 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13716 (if (eq exit-after-next 'now) (throw 'exit t))
13717 (goto-char (point-min))
13718 (beginning-of-line 2)
13719 (delete-region (point) (point-at-eol))
13720 (org-fast-tag-insert "Current" current c-face)
13721 (org-set-current-tags-overlay current ov-prefix)
13722 (while (re-search-forward
13724 (setq tg (match-string 1))
13725 (add-text-properties
13726 (match-beginning 1) (match-end 1)
13727 (list 'face
13728 (cond
13729 ((member tg current) c-face)
13730 ((member tg inherited) i-face)
13731 (t (get-text-property (match-beginning 1) 'face))))))
13732 (goto-char (point-min)))))
13733 (org-detach-overlay org-tags-overlay)
13734 (if rtn
13735 (mapconcat 'identity current ":")
13736 nil))))
13738 (defun org-get-tags-string ()
13739 "Get the TAGS string in the current headline."
13740 (unless (org-at-heading-p t)
13741 (error "Not on a heading"))
13742 (save-excursion
13743 (beginning-of-line 1)
13745 (org-match-string-no-properties 1)
13746 "")))
13748 (defun org-get-tags ()
13749 "Get the list of tags specified in the current headline."
13750 (org-split-string (org-get-tags-string) ":"))
13752 (defun org-get-buffer-tags ()
13753 "Get a table of all tags used in the buffer, for completion."
13754 (let (tags)
13755 (save-excursion
13756 (goto-char (point-min))
13757 (while (re-search-forward
13759 (when (equal (char-after (point-at-bol 0)) ?*)
13760 (mapc (lambda (x) (add-to-list 'tags x))
13761 (org-split-string (org-match-string-no-properties 1) ":")))))
13762 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13763 (mapcar 'list tags)))
13765 ;;;; The mapping API
13767 ;;;###autoload
13768 (defun org-map-entries (func &optional match scope &rest skip)
13769 "Call FUNC at each headline selected by MATCH in SCOPE.
13771 FUNC is a function or a lisp form. The function will be called without
13772 arguments, with the cursor positioned at the beginning of the headline.
13773 The return values of all calls to the function will be collected and
13774 returned as a list.
13776 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13777 does not need to preserve point. After evaluation, the cursor will be
13778 moved to the end of the line (presumably of the headline of the
13779 processed entry) and search continues from there. Under some
13780 circumstances, this may not produce the wanted results. For example,
13781 if you have removed (e.g. archived) the current (sub)tree it could
13782 mean that the next entry will be skipped entirely. In such cases, you
13783 can specify the position from where search should continue by making
13784 FUNC set the variable `org-map-continue-from' to the desired buffer
13785 position.
13787 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13788 Only headlines that are matched by this query will be considered during
13789 the iteration. When MATCH is nil or t, all headlines will be
13790 visited by the iteration.
13792 SCOPE determines the scope of this command. It can be any of:
13794 nil The current buffer, respecting the restriction if any
13795 tree The subtree started with the entry at point
13796 region The entries within the active region, if any
13797 region-start-level
13798 The entries within the active region, but only those at
13799 the same level than the first one.
13800 file The current buffer, without restriction
13801 file-with-archives
13802 The current buffer, and any archives associated with it
13803 agenda All agenda files
13804 agenda-with-archives
13805 All agenda files with any archive files associated with them
13806 \(file1 file2 ...)
13807 If this is a list, all files in the list will be scanned
13809 The remaining args are treated as settings for the skipping facilities of
13810 the scanner. The following items can be given here:
13812 archive skip trees with the archive tag.
13813 comment skip trees with the COMMENT keyword
13814 function or Emacs Lisp form:
13815 will be used as value for `org-agenda-skip-function', so whenever
13816 the function returns t, FUNC will not be called for that
13817 entry and search will continue from the point where the
13818 function leaves it.
13820 If your function needs to retrieve the tags including inherited tags
13821 at the *current* entry, you can use the value of the variable
13822 `org-scanner-tags' which will be much faster than getting the value
13823 with `org-get-tags-at'. If your function gets properties with
13824 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13825 to t around the call to `org-entry-properties' to get the same speedup.
13826 Note that if your function moves around to retrieve tags and properties at
13827 a *different* entry, you cannot use these techniques."
13828 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13829 (not (org-region-active-p)))
13830 (let* ((org-agenda-archives-mode nil) ; just to make sure
13831 (org-agenda-skip-archived-trees (memq 'archive skip))
13832 (org-agenda-skip-comment-trees (memq 'comment skip))
13833 (org-agenda-skip-function
13834 (car (org-delete-all '(comment archive) skip)))
13835 (org-tags-match-list-sublevels t)
13836 (start-level (eq scope 'region-start-level))
13837 matcher file res
13838 org-todo-keywords-for-agenda
13839 org-done-keywords-for-agenda
13840 org-todo-keyword-alist-for-agenda
13841 org-drawers-for-agenda
13842 org-tag-alist-for-agenda)
13844 (cond
13845 ((eq match t) (setq matcher t))
13846 ((eq match nil) (setq matcher t))
13847 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13849 (save-excursion
13850 (save-restriction
13851 (cond ((eq scope 'tree)
13852 (org-back-to-heading t)
13853 (org-narrow-to-subtree)
13854 (setq scope nil))
13855 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13856 (org-region-active-p))
13857 ;; If needed, set start-level to a string like "2"
13858 (when start-level
13859 (save-excursion
13860 (goto-char (region-beginning))
13861 (unless (org-at-heading-p) (outline-next-heading))
13862 (setq start-level (org-current-level))))
13863 (narrow-to-region (region-beginning)
13864 (save-excursion
13865 (goto-char (region-end))
13866 (unless (and (bolp) (org-at-heading-p))
13867 (outline-next-heading))
13868 (point)))
13869 (setq scope nil)))
13871 (if (not scope)
13872 (progn
13873 (org-prepare-agenda-buffers
13874 (list (buffer-file-name (current-buffer))))
13875 (setq res (org-scan-tags func matcher nil start-level)))
13876 ;; Get the right scope
13877 (cond
13878 ((and scope (listp scope) (symbolp (car scope)))
13879 (setq scope (eval scope)))
13880 ((eq scope 'agenda)
13881 (setq scope (org-agenda-files t)))
13882 ((eq scope 'agenda-with-archives)
13883 (setq scope (org-agenda-files t))
13884 (setq scope (org-add-archive-files scope)))
13885 ((eq scope 'file)
13886 (setq scope (list (buffer-file-name))))
13887 ((eq scope 'file-with-archives)
13888 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13889 (org-prepare-agenda-buffers scope)
13890 (while (setq file (pop scope))
13891 (with-current-buffer (org-find-base-buffer-visiting file)
13892 (save-excursion
13893 (save-restriction
13894 (widen)
13895 (goto-char (point-min))
13896 (setq res (append res (org-scan-tags func matcher))))))))))
13897 res)))
13899 ;;;; Properties
13901 ;;; Setting and retrieving properties
13903 (defconst org-special-properties
13904 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13905 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13906 "The special properties valid in Org-mode.
13908 These are properties that are not defined in the property drawer,
13909 but in some other way.")
13911 (defconst org-default-properties
13912 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13913 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13914 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13915 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13916 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13917 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13918 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13919 "Some properties that are used by Org-mode for various purposes.
13920 Being in this list makes sure that they are offered for completion.")
13923 "Regular expression matching the first line of a property drawer.")
13926 "Regular expression matching the last line of a property drawer.")
13929 "Regular expression matching the first line of a property drawer.")
13932 "Regular expression matching the first line of a property drawer.")
13934 (defconst org-property-drawer-re
13937 "Matches an entire property drawer.")
13939 (defconst org-clock-drawer-re
13942 "Matches an entire clock drawer.")
13944 (defsubst org-re-property (property)
13945 "Return a regexp matching PROPERTY.
13946 Match group 1 will be set to the value "
13949 (defun org-property-action ()
13950 "Do an action on properties."
13951 (interactive)
13952 (let (c)
13953 (org-at-property-p)
13954 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13955 (setq c (read-char-exclusive))
13956 (cond
13957 ((equal c ?s)
13958 (call-interactively 'org-set-property))
13959 ((equal c ?d)
13960 (call-interactively 'org-delete-property))
13961 ((equal c ?D)
13962 (call-interactively 'org-delete-property-globally))
13963 ((equal c ?c)
13964 (call-interactively 'org-compute-property-at-point))
13965 (t (error "No such property action %c" c)))))
13967 (defun org-set-effort (&optional value)
13968 "Set the effort property of the current entry.
13969 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13970 allowed value."
13971 (interactive "P")
13972 (if (equal value 0) (setq value 10))
13973 (let* ((completion-ignore-case t)
13974 (prop org-effort-property)
13975 (cur (org-entry-get nil prop))
13976 (allowed (org-property-get-allowed-values nil prop 'table))
13977 (existing (mapcar 'list (org-property-values prop)))
13978 rpl
13979 (val (cond
13980 ((stringp value) value)
13981 ((and allowed (integerp value))
13982 (or (car (nth (1- value) allowed))
13983 (car (org-last allowed))))
13984 (allowed
13985 (message "Select 1-9,0, [RET%s]: %s"
13986 (if cur (concat "=" cur) "")
13987 (mapconcat 'car allowed " "))
13988 (setq rpl (read-char-exclusive))
13990 cur
13991 (setq rpl (- rpl ?0))
13992 (if (equal rpl 0) (setq rpl 10))
13993 (if (and (> rpl 0) (<= rpl (length allowed)))
13994 (car (nth (1- rpl) allowed))
13995 (org-completing-read "Effort: " allowed nil))))
13996 (t
13997 (let (org-completion-use-ido org-completion-use-iswitchb)
13998 (org-completing-read
14000 (concat "[" cur "]") "")
14001 ": ")
14002 existing nil nil "" nil cur))))))
14003 (unless (equal (org-entry-get nil prop) val)
14004 (org-entry-put nil prop val))
14005 (message "%s is now %s" prop val)))
14007 (defun org-at-property-p ()
14008 "Is cursor inside a property drawer?"
14009 (save-excursion
14010 (beginning-of-line 1)
14012 (save-match-data ;; Used by calling procedures
14013 (let ((p (point))
14014 (range (unless (org-before-first-heading-p)
14015 (org-get-property-block))))
14016 (and range (<= (car range) p) (< p (cdr range))))))))
14018 (defun org-get-property-block (&optional beg end force)
14019 "Return the (beg . end) range of the body of the property drawer.
14020 BEG and END can be beginning and end of subtree, if not given
14021 they will be found.
14022 If the drawer does not exist and FORCE is non-nil, create the drawer."
14023 (catch 'exit
14024 (save-excursion
14025 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14026 (end (or end (progn (outline-next-heading) (point)))))
14027 (goto-char beg)
14028 (if (re-search-forward org-property-start-re end t)
14029 (setq beg (1+ (match-end 0)))
14030 (if force
14031 (save-excursion
14032 (org-insert-property-drawer)
14033 (setq end (progn (outline-next-heading) (point))))
14034 (throw 'exit nil))
14035 (goto-char beg)
14036 (if (re-search-forward org-property-start-re end t)
14037 (setq beg (1+ (match-end 0)))))
14038 (if (re-search-forward org-property-end-re end t)
14039 (setq end (match-beginning 0))
14040 (or force (throw 'exit nil))
14041 (goto-char beg)
14042 (setq end beg)
14043 (org-indent-line-function)
14045 (cons beg end)))))
14047 (defun org-entry-properties (&optional pom which specific)
14048 "Get all properties of the entry at point-or-marker POM.
14049 This includes the TODO keyword, the tags, time strings for deadline,
14050 scheduled, and clocking, and any additional properties defined in the
14051 entry. The return value is an alist, keys may occur multiple times
14052 if the property key was used several times.
14053 POM may also be nil, in which case the current entry is used.
14054 If WHICH is nil or `all', get all properties. If WHICH is
14055 `special' or `standard', only get that subclass. If WHICH
14056 is a string only get exactly this property. SPECIFIC can be a string, the
14057 specific property we are interested in. Specifying it can speed
14058 things up because then unnecessary parsing is avoided."
14059 (setq which (or which 'all))
14060 (org-with-point-at pom
14061 (let ((clockstr (substring org-clock-string 0 -1))
14062 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14063 (case-fold-search nil)
14064 beg end range props sum-props key key1 value string clocksum)
14065 (save-excursion
14066 (when (condition-case nil
14067 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14068 (error nil))
14069 (setq beg (point))
14070 (setq sum-props (get-text-property (point) 'org-summaries))
14071 (setq clocksum (get-text-property (point) :org-clock-minutes))
14072 (outline-next-heading)
14073 (setq end (point))
14074 (when (memq which '(all special))
14075 ;; Get the special properties, like TODO and tags
14076 (goto-char beg)
14077 (when (and (or (not specific) (string= specific "TODO"))
14078 (looking-at org-todo-line-regexp) (match-end 2))
14079 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14080 (when (and (or (not specific) (string= specific "PRIORITY"))
14081 (looking-at org-priority-regexp))
14082 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14083 (when (or (not specific) (string= specific "FILE"))
14084 (push (cons "FILE" buffer-file-name) props))
14085 (when (and (or (not specific) (string= specific "TAGS"))
14086 (setq value (org-get-tags-string))
14088 (push (cons "TAGS" value) props))
14089 (when (and (or (not specific) (string= specific "ALLTAGS"))
14090 (setq value (org-get-tags-at)))
14091 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14092 ":"))
14093 props))
14094 (when (or (not specific) (string= specific "BLOCKED"))
14095 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14096 (when (or (not specific)
14097 (member specific
14098 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14099 "TIMESTAMP" "TIMESTAMP_IA")))
14100 (catch 'match
14101 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14102 (setq key (if (match-end 1)
14103 (substring (org-match-string-no-properties 1)
14104 0 -1))
14105 string (if (equal key clockstr)
14106 (org-no-properties
14107 (org-trim
14108 (buffer-substring
14109 (match-beginning 3) (goto-char
14110 (point-at-eol)))))
14111 (substring (org-match-string-no-properties 3)
14112 1 -1)))
14113 ;; Get the correct property name from the key. This is
14114 ;; necessary if the user has configured time keywords.
14115 (setq key1 (concat key ":"))
14116 (cond
14117 ((not key)
14118 (setq key
14119 (if (= (char-after (match-beginning 3)) ?\[)
14120 "TIMESTAMP_IA" "TIMESTAMP")))
14121 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14122 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14123 ((equal key1 org-closed-string) (setq key "CLOSED"))
14124 ((equal key1 org-clock-string) (setq key "CLOCK")))
14125 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14126 (progn
14127 (push (cons key string) props)
14128 ;; no need to search further if match is found
14129 (throw 'match t))
14130 (when (or (equal key "CLOCK") (not (assoc key props)))
14131 (push (cons key string) props))))))
14132 )
14134 (when (memq which '(all standard))
14135 ;; Get the standard properties, like :PROP: ...
14136 (setq range (org-get-property-block beg end))
14137 (when range
14138 (goto-char (car range))
14139 (while (re-search-forward
14141 (cdr range) t)
14142 (setq key (org-match-string-no-properties 1)
14143 value (org-trim (or (org-match-string-no-properties 2) "")))
14144 (unless (member key excluded)
14145 (push (cons key (or value "")) props)))))
14146 (if clocksum
14147 (push (cons "CLOCKSUM"
14148 (org-columns-number-to-string (/ (float clocksum) 60.)
14149 'add_times))
14150 props))
14151 (unless (assoc "CATEGORY" props)
14152 (push (cons "CATEGORY" (org-get-category)) props))
14153 (append sum-props (nreverse props)))))))
14155 (defun org-entry-get (pom property &optional inherit literal-nil)
14156 "Get value of PROPERTY for entry at point-or-marker POM.
14157 If INHERIT is non-nil and the entry does not have the property,
14158 then also check higher levels of the hierarchy.
14159 If INHERIT is the symbol `selective', use inheritance only if the setting
14160 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14161 If the property is present but empty, the return value is the empty string.
14162 If the property is not present at all, nil is returned.
14165 do not interpret it as the list atom nil. This is used for inheritance
14167 (org-with-point-at pom
14168 (if (and inherit (if (eq inherit 'selective)
14169 (org-property-inherit-p property)
14170 t))
14171 (org-entry-get-with-inheritance property literal-nil)
14172 (if (member property org-special-properties)
14173 ;; We need a special property. Use `org-entry-properties' to
14174 ;; retrieve it, but specify the wanted property
14175 (cdr (assoc property (org-entry-properties nil 'special property)))
14176 (let ((range (unless (org-before-first-heading-p)
14177 (org-get-property-block))))
14178 (when (and range (goto-char (car range)))
14179 ((lambda (val) (when val (if literal-nil val (org-not-nil val))))
14180 (cond
14181 ((re-search-forward
14182 (org-re-property property) (cdr range) t)
14183 (if (match-end 1) (org-match-string-no-properties 1) ""))
14184 ((re-search-forward
14185 (org-re-property (concat property "+")) (cdr range) t)
14186 (cdr (assoc
14187 property
14188 (org-update-property-plist
14189 (concat property "+")
14190 (if (match-end 1) (org-match-string-no-properties 1) "")
14191 (list (or (assoc property org-file-properties)
14192 (assoc property org-global-properties)
14193 (assoc property org-global-properties-fixed)
14194 ))))))))))))))
14196 (defun org-property-or-variable-value (var &optional inherit)
14197 "Check if there is a property fixing the value of VAR.
14198 If yes, return this value. If not, return the current value of the variable."
14199 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14201 (read prop)
14202 (symbol-value var))))
14204 (defun org-entry-delete (pom property)
14205 "Delete the property PROPERTY from entry at point-or-marker POM."
14206 (org-with-point-at pom
14207 (if (member property org-special-properties)
14208 nil ; cannot delete these properties.
14209 (let ((range (org-get-property-block)))
14210 (if (and range
14211 (goto-char (car range))
14212 (re-search-forward
14213 (org-re-property property)
14214 (cdr range) t))
14215 (progn
14216 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14217 t)
14218 nil)))))
14220 ;; Multi-values properties are properties that contain multiple values
14221 ;; These values are assumed to be single words, separated by whitespace.
14222 (defun org-entry-add-to-multivalued-property (pom property value)
14223 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14224 (let* ((old (org-entry-get pom property))
14226 (setq value (org-entry-protect-space value))
14227 (unless (member value values)
14228 (setq values (cons value values))
14229 (org-entry-put pom property
14230 (mapconcat 'identity values " ")))))
14232 (defun org-entry-remove-from-multivalued-property (pom property value)
14233 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14234 (let* ((old (org-entry-get pom property))
14236 (setq value (org-entry-protect-space value))
14237 (when (member value values)
14238 (setq values (delete value values))
14239 (org-entry-put pom property
14240 (mapconcat 'identity values " ")))))
14242 (defun org-entry-member-in-multivalued-property (pom property value)
14243 "Is VALUE one of 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 (member value values)))
14249 (defun org-entry-get-multivalued-property (pom property)
14250 "Return a list of values in a multivalued property."
14251 (let* ((value (org-entry-get pom property))
14253 (mapcar 'org-entry-restore-space values)))
14255 (defun org-entry-put-multivalued-property (pom property &rest values)
14256 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14257 VALUES should be a list of strings. Spaces will be protected."
14258 (org-entry-put pom property
14259 (mapconcat 'org-entry-protect-space values " "))
14260 (let* ((value (org-entry-get pom property))
14262 (mapcar 'org-entry-restore-space values)))
14264 (defun org-entry-protect-space (s)
14265 "Protect spaces and newline in string S."
14266 (while (string-match " " s)
14267 (setq s (replace-match "%20" t t s)))
14269 (setq s (replace-match "%0A" t t s)))
14270 s)
14272 (defun org-entry-restore-space (s)
14273 "Restore spaces and newline in string S."
14274 (while (string-match "%20" s)
14275 (setq s (replace-match " " t t s)))
14276 (while (string-match "%0A" s)
14278 s)
14280 (defvar org-entry-property-inherited-from (make-marker)
14281 "Marker pointing to the entry from where a property was inherited.
14282 Each call to `org-entry-get-with-inheritance' will set this marker to the
14283 location of the entry where the inheritance search matched. If there was
14284 no match, the marker will point nowhere.
14285 Note that also `org-entry-get' calls this function, if the INHERIT flag
14286 is set.")
14288 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14289 "Get entry property, and search higher levels if not present.
14290 The search will stop at the first ancestor which has the property defined.
14292 should be considered as undefined (this is the meaning of nil here).
14294 (move-marker org-entry-property-inherited-from nil)
14295 (let (tmp)
14296 (unless (org-before-first-heading-p)
14297 (save-excursion
14298 (save-restriction
14299 (widen)
14300 (catch 'ex
14301 (while t
14302 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14303 (org-back-to-heading t)
14304 (move-marker org-entry-property-inherited-from (point))
14305 (throw 'ex tmp))
14306 (or (org-up-heading-safe) (throw 'ex nil)))))))
14307 (setq tmp (or tmp
14308 (cdr (assoc property org-file-properties))
14309 (cdr (assoc property org-global-properties))
14310 (cdr (assoc property org-global-properties-fixed))))
14311 (if literal-nil tmp (org-not-nil tmp))))
14313 (defvar org-property-changed-functions nil
14314 "Hook called when the value of a property has changed.
14315 Each hook function should accept two arguments, the name of the property
14316 and the new value.")
14318 (defun org-entry-put (pom property value)
14319 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14320 (org-with-point-at pom
14321 (org-back-to-heading t)
14322 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14323 range)
14324 (cond
14325 ((equal property "TODO")
14327 (not (member value org-todo-keywords-1)))
14329 (if (or (not value)
14331 (setq value 'none))
14332 (org-todo value)
14333 (org-set-tags nil 'align))
14334 ((equal property "PRIORITY")
14336 (string-to-char value) ?\ ))
14337 (org-set-tags nil 'align))
14338 ((equal property "SCHEDULED")
14339 (if (re-search-forward org-scheduled-time-regexp end t)
14340 (cond
14341 ((eq value 'earlier) (org-timestamp-change -1 'day))
14342 ((eq value 'later) (org-timestamp-change 1 'day))
14343 (t (call-interactively 'org-schedule)))
14344 (call-interactively 'org-schedule)))
14345 ((equal property "DEADLINE")
14346 (if (re-search-forward org-deadline-time-regexp end t)
14347 (cond
14348 ((eq value 'earlier) (org-timestamp-change -1 'day))
14349 ((eq value 'later) (org-timestamp-change 1 'day))
14350 (t (call-interactively 'org-deadline)))
14351 (call-interactively 'org-deadline)))
14352 ((member property org-special-properties)
14353 (error "The %s property can not yet be set with `org-entry-put'"
14354 property))
14355 (t ; a non-special property
14356 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14357 (setq range (org-get-property-block beg end 'force))
14358 (goto-char (car range))
14359 (if (re-search-forward
14360 (org-re-property property) (cdr range) t)
14361 (progn
14362 (delete-region (match-beginning 0) (match-end 0))
14363 (goto-char (match-beginning 0)))
14364 (goto-char (cdr range))
14366 (backward-char 1)
14367 (org-indent-line-function))
14368 (insert ":" property ":")
14369 (and value (insert " " value))
14370 (org-indent-line-function)))))
14371 (run-hook-with-args 'org-property-changed-functions property value)))
14373 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14374 "Get all property keys in the current buffer.
14375 With INCLUDE-SPECIALS, also list the special properties that reflect things
14376 like tags and TODO state.
14377 With INCLUDE-DEFAULTS, also include properties that has special meaning
14378 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14379 and others.
14380 With INCLUDE-COLUMNS, also include property names given in COLUMN
14381 formats in the current buffer."
14382 (let (rtn range cfmt s p)
14383 (save-excursion
14384 (save-restriction
14385 (widen)
14386 (goto-char (point-min))
14387 (while (re-search-forward org-property-start-re nil t)
14388 (setq range (org-get-property-block))
14389 (goto-char (car range))
14390 (while (re-search-forward
14392 (cdr range) t)
14393 (add-to-list 'rtn (org-match-string-no-properties 1)))
14394 (outline-next-heading))))
14396 (when include-specials
14397 (setq rtn (append org-special-properties rtn)))
14399 (when include-defaults
14400 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14401 (add-to-list 'rtn org-effort-property))
14403 (when include-columns
14404 (save-excursion
14405 (save-restriction
14406 (widen)
14407 (goto-char (point-min))
14408 (while (re-search-forward
14410 nil t)
14411 (setq cfmt (match-string 2) s 0)
14413 cfmt s)
14414 (setq s (match-end 0)
14415 p (match-string 1 cfmt))
14416 (unless (or (equal p "ITEM")
14417 (member p org-special-properties))
14418 (add-to-list 'rtn (match-string 1 cfmt))))))))
14420 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14422 (defun org-property-values (key)
14423 "Return a list of all values of property KEY in the current buffer."
14424 (save-excursion
14425 (save-restriction
14426 (widen)
14427 (goto-char (point-min))
14428 (let ((re (org-re-property key))
14429 values)
14430 (while (re-search-forward re nil t)
14431 (add-to-list 'values (org-trim (match-string 1))))
14432 (delete "" values)))))
14434 (defun org-insert-property-drawer ()
14435 "Insert a property drawer into the current entry."
14436 (org-back-to-heading t)
14437 (looking-at org-outline-regexp)
14438 (let ((indent (if org-adapt-indentation
14439 (- (match-end 0) (match-beginning 0))
14440 0))
14441 (beg (point))
14443 end hiddenp)
14444 (outline-next-heading)
14445 (setq end (point))
14446 (goto-char beg)
14447 (while (re-search-forward re end t))
14448 (setq hiddenp (outline-invisible-p))
14449 (end-of-line 1)
14452 (if (member (match-string 1) '("CLOCK:" ":END:"))
14453 ;; just skip this line
14454 (beginning-of-line 2)
14455 ;; Drawer start, find the end
14457 (beginning-of-line 1)))
14458 (org-skip-over-state-notes)
14460 (if (eq (char-before) ?*) (forward-char 1))
14462 (beginning-of-line 0)
14463 (org-indent-to-column indent)
14464 (beginning-of-line 2)
14465 (org-indent-to-column indent)
14466 (beginning-of-line 0)
14467 (if hiddenp
14468 (save-excursion
14469 (org-back-to-heading t)
14470 (hide-entry))
14471 (org-flag-drawer t))))
14473 (defun org-insert-drawer (&optional arg drawer)
14474 "Insert a drawer at point.
14476 Optional argument DRAWER, when non-nil, is a string representing
14477 drawer's name. Otherwise, the user is prompted for a name.
14479 If a region is active, insert the drawer around that region
14480 instead.
14482 Point is left between drawer's boundaries."
14483 (interactive "P")
14484 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14485 "LOGBOOK"))
14486 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14487 ;; internally by Org. They are meant to be inserted
14488 ;; automatically.
14489 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14490 ;; Remove system drawers from list. Note: For some reason,
14491 ;; `org-completing-read' ignores the predicate while
14492 ;; `completing-read' handles it fine.
14493 (drawer (if arg "PROPERTIES"
14494 (or drawer
14495 (completing-read
14496 "Drawer: " org-drawers
14497 (lambda (d) (not (member d system-drawers))))))))
14498 (cond
14499 ;; With C-u, fall back on `org-insert-property-drawer'
14500 (arg (org-insert-property-drawer))
14501 ;; With an active region, insert a drawer at point.
14502 ((not (org-region-active-p))
14503 (progn
14506 (forward-line -2)))
14507 ;; Otherwise, insert the drawer at point
14508 (t
14509 (let ((rbeg (region-beginning))
14510 (rend (copy-marker (region-end))))
14511 (unwind-protect
14512 (progn
14513 (goto-char rbeg)
14514 (beginning-of-line)
14515 (when (save-excursion
14516 (re-search-forward org-outline-regexp-bol rend t))
14517 (error "Drawers cannot contain headlines"))
14518 ;; Position point at the beginning of the first
14519 ;; non-blank line in region. Insert drawer's opening
14520 ;; there, then indent it.
14521 (org-skip-whitespace)
14522 (beginning-of-line)
14524 (forward-line -1)
14525 (indent-for-tab-command)
14526 ;; Move point to the beginning of the first blank line
14527 ;; after the last non-blank line in region. Insert
14528 ;; drawer's closing, then indent it.
14529 (goto-char rend)
14532 (indent-for-tab-command)
14534 ;; Clear marker, whatever the outcome of insertion is.
14535 (set-marker rend nil)))))))
14537 (defvar org-property-set-functions-alist nil
14538 "Property set function alist.
14539 Each entry should have the following format:
14541 (PROPERTY . READ-FUNCTION)
14543 The read function will be called with the same argument as
14544 `org-completing-read'.")
14546 (defun org-set-property-function (property)
14547 "Get the function that should be used to set PROPERTY.
14548 This is computed according to `org-property-set-functions-alist'."
14549 (or (cdr (assoc property org-property-set-functions-alist))
14550 'org-completing-read))
14552 (defun org-read-property-value (property)
14553 "Read PROPERTY value from user."
14554 (let* ((completion-ignore-case t)
14555 (allowed (org-property-get-allowed-values nil property 'table))
14556 (cur (org-entry-get nil property))
14557 (prompt (concat property " value"
14559 (concat " [" cur "]") "") ": "))
14560 (set-function (org-set-property-function property))
14561 (val (if allowed
14562 (funcall set-function prompt allowed nil
14563 (not (get-text-property 0 'org-unrestricted
14564 (caar allowed))))
14565 (let (org-completion-use-ido org-completion-use-iswitchb)
14566 (funcall set-function prompt
14567 (mapcar 'list (org-property-values property))
14568 nil nil "" nil cur)))))
14569 (if (equal val "")
14570 cur
14571 val)))
14573 (defvar org-last-set-property nil)
14574 (defun org-read-property-name ()
14575 "Read a property name."
14576 (let* ((completion-ignore-case t)
14577 (keys (org-buffer-property-keys nil t t))
14578 (default-prop (or (save-excursion
14579 (save-match-data
14580 (beginning-of-line)
14582 (null (string= (match-string 1) "END"))
14583 (match-string 1))))
14584 org-last-set-property))
14585 (property (org-icompleting-read
14586 (concat "Property"
14587 (if default-prop (concat " [" default-prop "]") "")
14588 ": ")
14589 (mapcar 'list keys)
14590 nil nil nil nil
14591 default-prop
14592 )))
14593 (if (member property keys)
14594 property
14595 (or (cdr (assoc (downcase property)
14596 (mapcar (lambda (x) (cons (downcase x) x))
14597 keys)))
14598 property))))
14600 (defun org-set-property (property value)
14601 "In the current entry, set PROPERTY to VALUE.
14602 When called interactively, this will prompt for a property name, offering
14603 completion on existing and default properties. And then it will prompt
14604 for a value, offering completion either on allowed values (via an inherited
14605 xxx_ALL property) or on existing values in other instances of this property
14606 in the current file."
14607 (interactive (list nil nil))
14608 (let* ((property (or property (org-read-property-name)))
14609 (value (or value (org-read-property-value property)))
14610 (fn (assoc property org-properties-postprocess-alist)))
14611 (setq org-last-set-property property)
14612 ;; Possibly postprocess the inserted value:
14613 (when fn (setq value (funcall (cadr fn) value)))
14614 (unless (equal (org-entry-get nil property) value)
14615 (org-entry-put nil property value))))
14617 (defun org-delete-property (property)
14618 "In the current entry, delete PROPERTY."
14619 (interactive
14620 (let* ((completion-ignore-case t)
14621 (prop (org-icompleting-read "Property: "
14622 (org-entry-properties nil 'standard))))
14623 (list prop)))
14624 (message "Property %s %s" property
14625 (if (org-entry-delete nil property)
14626 "deleted"
14627 "was not present in the entry")))
14629 (defun org-delete-property-globally (property)
14630 "Remove PROPERTY globally, from all entries."
14631 (interactive
14632 (let* ((completion-ignore-case t)
14633 (prop (org-icompleting-read
14634 "Globally remove property: "
14635 (mapcar 'list (org-buffer-property-keys)))))
14636 (list prop)))
14637 (save-excursion
14638 (save-restriction
14639 (widen)
14640 (goto-char (point-min))
14641 (let ((cnt 0))
14642 (while (re-search-forward
14643 (org-re-property property)
14644 nil t)
14645 (setq cnt (1+ cnt))
14646 (replace-match ""))
14649 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14651 (defun org-compute-property-at-point ()
14652 "Compute the property at point.
14653 This looks for an enclosing column format, extracts the operator and
14654 then applies it to the property in the column format's scope."
14655 (interactive)
14656 (unless (org-at-property-p)
14657 (error "Not at a property"))
14658 (let ((prop (org-match-string-no-properties 2)))
14659 (org-columns-get-format-and-top-level)
14660 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14661 (error "No operator defined for property %s" prop))
14662 (org-columns-compute prop)))
14664 (defvar org-property-allowed-value-functions nil
14665 "Hook for functions supplying allowed values for a specific property.
14666 The functions must take a single argument, the name of the property, and
14668 the values, this means that these values are intended as defaults for
14669 completion, but that other values should be allowed too.
14670 The functions must return nil if they are not responsible for this
14671 property.")
14673 (defun org-property-get-allowed-values (pom property &optional table)
14674 "Get allowed values for the property PROPERTY.
14675 When TABLE is non-nil, return an alist that can directly be used for
14676 completion."
14677 (let (vals)
14678 (cond
14679 ((equal property "TODO")
14680 (setq vals (org-with-point-at pom
14681 (append org-todo-keywords-1 '("")))))
14682 ((equal property "PRIORITY")
14683 (let ((n org-lowest-priority))
14684 (while (>= n org-highest-priority)
14685 (push (char-to-string n) vals)
14686 (setq n (1- n)))))
14687 ((member property org-special-properties))
14688 ((setq vals (run-hook-with-args-until-success
14689 'org-property-allowed-value-functions property)))
14690 (t
14691 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14693 (setq vals (car (read-from-string (concat "(" vals ")"))))
14694 (setq vals (mapcar (lambda (x)
14695 (cond ((stringp x) x)
14696 ((numberp x) (number-to-string x))
14697 ((symbolp x) (symbol-name x))
14698 (t "???")))
14699 vals)))))
14700 (when (member ":ETC" vals)
14701 (setq vals (remove ":ETC" vals))
14702 (org-add-props (car vals) '(org-unrestricted t)))
14703 (if table (mapcar 'list vals) vals)))
14705 (defun org-property-previous-allowed-value (&optional previous)
14706 "Switch to the next allowed value for this property."
14707 (interactive)
14708 (org-property-next-allowed-value t))
14710 (defun org-property-next-allowed-value (&optional previous)
14711 "Switch to the next allowed value for this property."
14712 (interactive)
14713 (unless (org-at-property-p)
14714 (error "Not at a property"))
14715 (let* ((key (match-string 2))
14716 (value (match-string 3))
14717 (allowed (or (org-property-get-allowed-values (point) key)
14718 (and (member value '("[ ]" "[-]" "[X]"))
14719 '("[ ]" "[X]"))))
14720 nval)
14721 (unless allowed
14722 (error "Allowed values for this property have not been defined"))
14723 (if previous (setq allowed (reverse allowed)))
14724 (if (member value allowed)
14725 (setq nval (car (cdr (member value allowed)))))
14726 (setq nval (or nval (car allowed)))
14727 (if (equal nval value)
14728 (error "Only one allowed value for this property"))
14729 (org-at-property-p)
14730 (replace-match (concat " :" key ": " nval) t t)
14731 (org-indent-line-function)
14732 (beginning-of-line 1)
14734 (run-hook-with-args 'org-property-changed-functions key nval)))
14736 (defun org-find-olp (path &optional this-buffer)
14737 "Return a marker pointing to the entry at outline path OLP.
14738 If anything goes wrong, throw an error.
14739 You can wrap this call to catch the error like this:
14741 (condition-case msg
14742 (org-mobile-locate-entry (match-string 4))
14743 (error (nth 1 msg)))
14745 The return value will then be either a string with the error message,
14746 or a marker if everything is OK.
14748 If THIS-BUFFER is set, the outline path does not contain a file,
14749 only headings."
14750 (let* ((file (if this-buffer buffer-file-name (pop path)))
14751 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14752 (level 1)
14753 (lmin 1)
14754 (lmax 1)
14755 limit re end found pos heading cnt flevel)
14756 (unless buffer (error "File not found :%s" file))
14757 (with-current-buffer buffer
14758 (save-excursion
14759 (save-restriction
14760 (widen)
14761 (setq limit (point-max))
14762 (goto-char (point-min))
14763 (while (setq heading (pop path))
14764 (setq re (format org-complex-heading-regexp-format
14765 (regexp-quote heading)))
14766 (setq cnt 0 pos (point))
14767 (while (re-search-forward re end t)
14768 (setq level (- (match-end 1) (match-beginning 1)))
14769 (if (and (>= level lmin) (<= level lmax))
14770 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14771 (when (= cnt 0) (error "Heading not found on level %d: %s"
14772 lmax heading))
14773 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14774 lmax heading))
14775 (goto-char found)
14776 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14777 (setq end (save-excursion (org-end-of-subtree t t))))
14778 (when (org-at-heading-p)
14779 (move-marker (make-marker) (point))))))))
14781 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14782 "Find node HEADING in BUFFER.
14783 Return a marker to the heading if it was found, or nil if not.
14784 If POS-ONLY is set, return just the position instead of a marker.
14786 The heading text must match exact, but it may have a TODO keyword,
14787 a priority cookie and tags in the standard locations."
14788 (with-current-buffer (or buffer (current-buffer))
14789 (save-excursion
14790 (save-restriction
14791 (widen)
14792 (goto-char (point-min))
14793 (let (case-fold-search)
14794 (if (re-search-forward
14795 (format org-complex-heading-regexp-format
14796 (regexp-quote heading)) nil t)
14797 (if pos-only
14798 (match-beginning 0)
14799 (move-marker (make-marker) (match-beginning 0)))))))))
14801 (defun org-find-exact-heading-in-directory (heading &optional dir)
14802 "Find Org node headline HEADING in all .org files in directory DIR.
14803 When the target headline is found, return a marker to this location."
14804 (let ((files (directory-files (or dir default-directory)
14806 file visiting m buffer)
14807 (catch 'found
14808 (while (setq file (pop files))
14809 (message "trying %s" file)
14810 (setq visiting (org-find-base-buffer-visiting file))
14811 (setq buffer (or visiting (find-file-noselect file)))
14812 (setq m (org-find-exact-headline-in-buffer
14813 heading buffer))
14814 (when (and (not m) (not visiting)) (kill-buffer buffer))
14815 (and m (throw 'found m))))))
14817 (defun org-find-entry-with-id (ident)
14818 "Locate the entry that contains the ID property with exact value IDENT.
14819 IDENT can be a string, a symbol or a number, this function will search for
14820 the string representation of it.
14821 Return the position where this entry starts, or nil if there is no such entry."
14822 (interactive "sID: ")
14823 (let ((id (cond
14824 ((stringp ident) ident)
14825 ((symbol-name ident) (symbol-name ident))
14826 ((numberp ident) (number-to-string ident))
14827 (t (error "IDENT %s must be a string, symbol or number" ident))))
14828 (case-fold-search nil))
14829 (save-excursion
14830 (save-restriction
14831 (widen)
14832 (goto-char (point-min))
14833 (when (re-search-forward
14835 nil t)
14836 (org-back-to-heading t)
14837 (point))))))
14839 ;;;; Timestamps
14841 (defvar org-last-changed-timestamp nil)
14842 (defvar org-last-inserted-timestamp nil
14843 "The last time stamp inserted with `org-insert-time-stamp'.")
14844 (defvar org-time-was-given) ; dynamically scoped parameter
14845 (defvar org-end-time-was-given) ; dynamically scoped parameter
14846 (defvar org-ts-what) ; dynamically scoped parameter
14848 (defun org-time-stamp (arg &optional inactive)
14849 "Prompt for a date/time and insert a time stamp.
14850 If the user specifies a time like HH:MM, or if this command is called
14851 with a prefix argument, the time stamp will contain date and time.
14852 Otherwise, only the date will be included. All parts of a date not
14853 specified by the user will be filled in from the current date/time.
14854 So if you press just return without typing anything, the time stamp
14855 will represent the current date/time. If there is already a timestamp
14856 at the cursor, it will be modified."
14857 (interactive "P")
14858 (let* ((ts nil)
14859 (default-time
14860 ;; Default time is either today, or, when entering a range,
14861 ;; the range start.
14862 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14863 (save-excursion
14864 (re-search-backward
14866 (- (point) 20) t)))
14867 (apply 'encode-time (org-parse-time-string (match-string 1)))
14868 (current-time)))
14869 (default-input (and ts (org-get-compact-tod ts)))
14870 (repeater (save-excursion
14871 (save-match-data
14872 (beginning-of-line)
14873 (when (re-search-forward
14875 (save-excursion (progn (end-of-line) (point))) t)
14876 (match-string 0)))))
14877 org-time-was-given org-end-time-was-given time)
14878 (cond
14879 ((and (org-at-timestamp-p t)
14880 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14881 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14882 (insert "--")
14883 (setq time (let ((this-command this-command))
14884 (org-read-date arg 'totime nil nil
14885 default-time default-input inactive)))
14886 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14887 ((org-at-timestamp-p t)
14888 (setq time (let ((this-command this-command))
14889 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14890 (when (org-at-timestamp-p t) ; just to get the match data
14891 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14892 (replace-match "")
14893 (setq org-last-changed-timestamp
14894 (org-insert-time-stamp
14895 time (or org-time-was-given arg)
14896 inactive nil nil (list org-end-time-was-given)))
14897 (when repeater (goto-char (1- (point))) (insert " " repeater)
14898 (setq org-last-changed-timestamp
14899 (concat (substring org-last-inserted-timestamp 0 -1)
14900 " " repeater ">"))))
14901 (message "Timestamp updated"))
14902 (t
14903 (setq time (let ((this-command this-command))
14904 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14905 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14906 nil nil (list org-end-time-was-given))))))
14908 ;; FIXME: can we use this for something else, like computing time differences?
14909 (defun org-get-compact-tod (s)
14910 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14911 (let* ((t1 (match-string 1 s))
14912 (h1 (string-to-number (match-string 2 s)))
14913 (m1 (string-to-number (match-string 3 s)))
14914 (t2 (and (match-end 4) (match-string 5 s)))
14915 (h2 (and t2 (string-to-number (match-string 6 s))))
14916 (m2 (and t2 (string-to-number (match-string 7 s))))
14917 dh dm)
14918 (if (not t2)
14919 t1
14920 (setq dh (- h2 h1) dm (- m2 m1))
14921 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14922 (concat t1 "+" (number-to-string dh)
14923 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14925 (defun org-time-stamp-inactive (&optional arg)
14926 "Insert an inactive time stamp.
14927 An inactive time stamp is enclosed in square brackets instead of angle
14928 brackets. It is inactive in the sense that it does not trigger agenda entries,
14929 does not link to the calendar and cannot be changed with the S-cursor keys.
14930 So these are more for recording a certain time/date."
14931 (interactive "P")
14932 (org-time-stamp arg 'inactive))
14934 (defvar org-date-ovl (make-overlay 1 1))
14935 (overlay-put org-date-ovl 'face 'org-warning)
14936 (org-detach-overlay org-date-ovl)
14938 (defvar org-ans1) ; dynamically scoped parameter
14939 (defvar org-ans2) ; dynamically scoped parameter
14941 (defvar org-plain-time-of-day-regexp) ; defined below
14943 (defvar org-overriding-default-time nil) ; dynamically scoped
14944 (defvar org-read-date-overlay nil)
14945 (defvar org-dcst nil) ; dynamically scoped
14946 (defvar org-read-date-history nil)
14947 (defvar org-read-date-final-answer nil)
14948 (defvar org-read-date-analyze-futurep nil)
14949 (defvar org-read-date-analyze-forced-year nil)
14951 (defun org-read-date (&optional with-time to-time from-string prompt
14952 default-time default-input inactive)
14953 "Read a date, possibly a time, and make things smooth for the user.
14954 The prompt will suggest to enter an ISO date, but you can also enter anything
14955 which will at least partially be understood by `parse-time-string'.
14956 Unrecognized parts of the date will default to the current day, month, year,
14957 hour and minute. If this command is called to replace a timestamp at point,
14958 or to enter the second timestamp of a range, the default time is taken
14959 from the existing stamp. Furthermore, the command prefers the future,
14960 so if you are giving a date where the year is not given, and the day-month
14961 combination is already past in the current year, it will assume you
14962 mean next year. For details, see the manual. A few examples:
14964 3-2-5 --> 2003-02-05
14965 feb 15 --> currentyear-02-15
14966 2/15 --> currentyear-02-15
14967 sep 12 9 --> 2009-09-12
14968 12:45 --> today 12:45
14969 22 sept 0:34 --> currentyear-09-22 0:34
14970 12 --> currentyear-currentmonth-12
14971 Fri --> nearest Friday (today or later)
14972 etc.
14974 Furthermore you can specify a relative date by giving, as the *first* thing
14975 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14976 change in days weeks, months, years.
14977 With a single plus or minus, the date is relative to today. With a double
14978 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14979 +4d --> four days from today
14980 +4 --> same as above
14981 +2w --> two weeks from today
14982 ++5 --> five days from default date
14984 The function understands only English month and weekday abbreviations,
14985 but this can be configured with the variables `parse-time-months' and
14986 `parse-time-weekdays'.
14988 While prompting, a calendar is popped up - you can also select the
14989 date with the mouse (button 1). The calendar shows a period of three
14990 months. To scroll it to other months, use the keys `>' and `<'.
14991 If you don't like the calendar, turn it off with
14992 \(setq org-read-date-popup-calendar nil)
14994 With optional argument TO-TIME, the date will immediately be converted
14995 to an internal time.
14996 With an optional argument WITH-TIME, the prompt will suggest to also
14997 insert a time. Note that when WITH-TIME is not set, you can still
14998 enter a time, and this function will inform the calling routine about
14999 this change. The calling routine may then choose to change the format
15000 used to insert the time stamp into the buffer to include the time.
15001 With optional argument FROM-STRING, read from this string instead from
15002 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15003 the time/date that is used for everything that is not specified by the
15004 user."
15005 (require 'parse-time)
15006 (let* ((org-time-stamp-rounding-minutes
15007 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15008 (org-dcst org-display-custom-times)
15009 (ct (org-current-time))
15010 (def (or org-overriding-default-time default-time ct))
15011 (defdecode (decode-time def))
15012 (dummy (progn
15013 (when (< (nth 2 defdecode) org-extend-today-until)
15014 (setcar (nthcdr 2 defdecode) -1)
15015 (setcar (nthcdr 1 defdecode) 59)
15016 (setq def (apply 'encode-time defdecode)
15017 defdecode (decode-time def)))))
15018 (calendar-frame-setup nil)
15019 (calendar-setup nil)
15020 (calendar-move-hook nil)
15021 (calendar-view-diary-initially-flag nil)
15022 (calendar-view-holidays-initially-flag nil)
15023 (timestr (format-time-string
15024 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
15025 (prompt (concat (if prompt (concat prompt " ") "")
15026 (format "Date+time [%s]: " timestr)))
15027 ans (org-ans0 "") org-ans1 org-ans2 final)
15029 (cond
15030 (from-string (setq ans from-string))
15031 (org-read-date-popup-calendar
15032 (save-excursion
15033 (save-window-excursion
15034 (calendar)
15035 (unwind-protect
15036 (progn
15037 (calendar-forward-day (- (time-to-days def)
15038 (calendar-absolute-from-gregorian
15039 (calendar-current-date))))
15040 (org-eval-in-calendar nil t)
15041 (let* ((old-map (current-local-map))
15042 (map (copy-keymap calendar-mode-map))
15043 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15044 (org-defkey map (kbd "RET") 'org-calendar-select)
15045 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15046 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15047 (org-defkey minibuffer-local-map [(meta shift left)]
15048 (lambda () (interactive)
15049 (org-eval-in-calendar '(calendar-backward-month 1))))
15050 (org-defkey minibuffer-local-map [(meta shift right)]
15051 (lambda () (interactive)
15052 (org-eval-in-calendar '(calendar-forward-month 1))))
15053 (org-defkey minibuffer-local-map [(meta shift up)]
15054 (lambda () (interactive)
15055 (org-eval-in-calendar '(calendar-backward-year 1))))
15056 (org-defkey minibuffer-local-map [(meta shift down)]
15057 (lambda () (interactive)
15058 (org-eval-in-calendar '(calendar-forward-year 1))))
15059 (org-defkey minibuffer-local-map [?\e (shift left)]
15060 (lambda () (interactive)
15061 (org-eval-in-calendar '(calendar-backward-month 1))))
15062 (org-defkey minibuffer-local-map [?\e (shift right)]
15063 (lambda () (interactive)
15064 (org-eval-in-calendar '(calendar-forward-month 1))))
15065 (org-defkey minibuffer-local-map [?\e (shift up)]
15066 (lambda () (interactive)
15067 (org-eval-in-calendar '(calendar-backward-year 1))))
15068 (org-defkey minibuffer-local-map [?\e (shift down)]
15069 (lambda () (interactive)
15070 (org-eval-in-calendar '(calendar-forward-year 1))))
15071 (org-defkey minibuffer-local-map [(shift up)]
15072 (lambda () (interactive)
15073 (org-eval-in-calendar '(calendar-backward-week 1))))
15074 (org-defkey minibuffer-local-map [(shift down)]
15075 (lambda () (interactive)
15076 (org-eval-in-calendar '(calendar-forward-week 1))))
15077 (org-defkey minibuffer-local-map [(shift left)]
15078 (lambda () (interactive)
15079 (org-eval-in-calendar '(calendar-backward-day 1))))
15080 (org-defkey minibuffer-local-map [(shift right)]
15081 (lambda () (interactive)
15082 (org-eval-in-calendar '(calendar-forward-day 1))))
15083 (org-defkey minibuffer-local-map ">"
15084 (lambda () (interactive)
15085 (org-eval-in-calendar '(scroll-calendar-left 1))))
15086 (org-defkey minibuffer-local-map "<"
15087 (lambda () (interactive)
15088 (org-eval-in-calendar '(scroll-calendar-right 1))))
15089 (org-defkey minibuffer-local-map "\C-v"
15090 (lambda () (interactive)
15091 (org-eval-in-calendar
15092 '(calendar-scroll-left-three-months 1))))
15093 (org-defkey minibuffer-local-map "\M-v"
15094 (lambda () (interactive)
15095 (org-eval-in-calendar
15096 '(calendar-scroll-right-three-months 1))))
15097 (run-hooks 'org-read-date-minibuffer-setup-hook)
15098 (unwind-protect
15099 (progn
15100 (use-local-map map)
15101 (setq org-read-date-inactive inactive)
15102 (add-hook 'post-command-hook 'org-read-date-display)
15103 (setq org-ans0 (read-string prompt default-input
15104 'org-read-date-history nil))
15105 ;; org-ans0: from prompt
15106 ;; org-ans1: from mouse click
15107 ;; org-ans2: from calendar motion
15108 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15109 (remove-hook 'post-command-hook 'org-read-date-display)
15110 (use-local-map old-map)
15111 (when org-read-date-overlay
15112 (delete-overlay org-read-date-overlay)
15113 (setq org-read-date-overlay nil)))))
15114 (bury-buffer "*Calendar*")))))
15116 (t ; Naked prompt only
15117 (unwind-protect
15118 (setq ans (read-string prompt default-input
15119 'org-read-date-history timestr))
15120 (when org-read-date-overlay
15121 (delete-overlay org-read-date-overlay)
15122 (setq org-read-date-overlay nil)))))
15124 (setq final (org-read-date-analyze ans def defdecode))
15126 (when org-read-date-analyze-forced-year
15127 (message "Year was forced into %s"
15128 (if org-read-date-force-compatible-dates
15129 "compatible range (1970-2037)"
15130 "range representable on this machine"))
15131 (ding))
15133 ;; One round trip to get rid of 34th of August and stuff like that....
15134 (setq final (decode-time (apply 'encode-time final)))
15136 (setq org-read-date-final-answer ans)
15138 (if to-time
15139 (apply 'encode-time final)
15140 (if (and (boundp 'org-time-was-given) org-time-was-given)
15141 (format "%04d-%02d-%02d %02d:%02d"
15142 (nth 5 final) (nth 4 final) (nth 3 final)
15143 (nth 2 final) (nth 1 final))
15144 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15146 (defvar def)
15147 (defvar defdecode)
15148 (defvar with-time)
15149 (defvar org-read-date-inactive)
15150 (defun org-read-date-display ()
15151 "Display the current date prompt interpretation in the minibuffer."
15152 (when org-read-date-display-live
15153 (when org-read-date-overlay
15154 (delete-overlay org-read-date-overlay))
15155 (let ((p (point)))
15156 (end-of-line 1)
15157 (while (not (equal (buffer-substring
15158 (max (point-min) (- (point) 4)) (point))
15159 " "))
15160 (insert " "))
15161 (goto-char p))
15162 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15163 " " (or org-ans1 org-ans2)))
15164 (org-end-time-was-given nil)
15165 (f (org-read-date-analyze ans def defdecode))
15166 (fmts (if org-dcst
15167 org-time-stamp-custom-formats
15168 org-time-stamp-formats))
15169 (fmt (if (or with-time
15170 (and (boundp 'org-time-was-given) org-time-was-given))
15171 (cdr fmts)
15172 (car fmts)))
15173 (txt (format-time-string fmt (apply 'encode-time f)))
15174 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15175 (txt (concat "=> " txt)))
15176 (when (and org-end-time-was-given
15177 (string-match org-plain-time-of-day-regexp txt))
15178 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15179 org-end-time-was-given
15180 (substring txt (match-end 0)))))
15181 (when org-read-date-analyze-futurep
15182 (setq txt (concat txt " (=>F)")))
15183 (setq org-read-date-overlay
15184 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15185 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15187 (defun org-read-date-analyze (ans def defdecode)
15188 "Analyze the combined answer of the date prompt."
15189 ;; FIXME: cleanup and comment
15190 (let ((nowdecode (decode-time (current-time)))
15191 delta deltan deltaw deltadef year month day
15192 hour minute second wday pm h2 m2 tl wday1
15193 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15194 (setq org-read-date-analyze-futurep nil
15195 org-read-date-analyze-forced-year nil)
15197 (setq ans "+0"))
15199 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15200 (setq ans (replace-match "" t t ans)
15201 deltan (car delta)
15202 deltaw (nth 1 delta)
15203 deltadef (nth 2 delta)))
15205 ;; Check if there is an iso week date in there
15206 ;; If yes, store the info and postpone interpreting it until the rest
15207 ;; of the parsing is done
15208 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15209 (setq iso-year (if (match-end 1)
15210 (org-small-year-to-year
15211 (string-to-number (match-string 1 ans))))
15212 iso-weekday (if (match-end 3)
15213 (string-to-number (match-string 3 ans)))
15214 iso-week (string-to-number (match-string 2 ans)))
15215 (setq ans (replace-match "" t t ans)))
15217 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15218 (when (string-match
15220 (setq year (if (match-end 2)
15221 (string-to-number (match-string 2 ans))
15222 (progn (setq kill-year t)
15223 (string-to-number (format-time-string "%Y"))))
15224 month (string-to-number (match-string 3 ans))
15225 day (string-to-number (match-string 4 ans)))
15226 (if (< year 100) (setq year (+ 2000 year)))
15228 t nil ans)))
15230 ;; Help matching dotted european dates
15231 (when (string-match
15232 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15233 (setq year (if (match-end 3)
15234 (string-to-number (match-string 3 ans))
15235 (progn (setq kill-year t)
15236 (string-to-number (format-time-string "%Y"))))
15237 day (string-to-number (match-string 1 ans))
15238 month (string-to-number (match-string 2 ans))
15240 t nil ans)))
15242 ;; Help matching american dates, like 5/30 or 5/30/7
15243 (when (string-match
15244 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15245 (setq year (if (match-end 4)
15246 (string-to-number (match-string 4 ans))
15247 (progn (setq kill-year t)
15248 (string-to-number (format-time-string "%Y"))))
15249 month (string-to-number (match-string 1 ans))
15250 day (string-to-number (match-string 2 ans)))
15251 (if (< year 100) (setq year (+ 2000 year)))
15253 t nil ans)))
15254 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15255 ;; If there is a time with am/pm, and *no* time without it, we convert
15256 ;; so that matching will be successful.
15257 (loop for i from 1 to 2 do ; twice, for end time as well
15260 (setq hour (string-to-number (match-string 1 ans))
15261 minute (if (match-end 3)
15262 (string-to-number (match-string 3 ans))
15263 0)
15264 pm (equal ?p
15265 (string-to-char (downcase (match-string 4 ans)))))
15266 (if (and (= hour 12) (not pm))
15267 (setq hour 0)
15268 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15269 (setq ans (replace-match (format "%02d:%02d" hour minute)
15270 t t ans))))
15272 ;; Check if a time range is given as a duration
15273 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15274 (setq hour (string-to-number (match-string 1 ans))
15275 h2 (+ hour (string-to-number (match-string 3 ans)))
15276 minute (string-to-number (match-string 2 ans))
15277 m2 (+ minute (if (match-end 5) (string-to-number
15278 (match-string 5 ans))0)))
15279 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15280 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15281 t t ans)))
15283 ;; Check if there is a time range
15284 (when (boundp 'org-end-time-was-given)
15285 (setq org-time-was-given nil)
15286 (when (and (string-match org-plain-time-of-day-regexp ans)
15287 (match-end 8))
15288 (setq org-end-time-was-given (match-string 8 ans))
15289 (setq ans (concat (substring ans 0 (match-beginning 7))
15290 (substring ans (match-end 7))))))
15292 (setq tl (parse-time-string ans)
15293 day (or (nth 3 tl) (nth 3 defdecode))
15294 month (or (nth 4 tl)
15295 (if (and org-read-date-prefer-future
15296 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15297 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15298 (nth 4 defdecode)))
15299 year (or (and (not kill-year) (nth 5 tl))
15300 (if (and org-read-date-prefer-future
15301 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15302 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15303 (nth 5 defdecode)))
15304 hour (or (nth 2 tl) (nth 2 defdecode))
15305 minute (or (nth 1 tl) (nth 1 defdecode))
15306 second (or (nth 0 tl) 0)
15307 wday (nth 6 tl))
15309 (when (and (eq org-read-date-prefer-future 'time)
15310 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15311 (equal day (nth 3 nowdecode))
15312 (equal month (nth 4 nowdecode))
15313 (equal year (nth 5 nowdecode))
15314 (nth 2 tl)
15315 (or (< (nth 2 tl) (nth 2 nowdecode))
15316 (and (= (nth 2 tl) (nth 2 nowdecode))
15317 (nth 1 tl)
15318 (< (nth 1 tl) (nth 1 nowdecode)))))
15319 (setq day (1+ day)
15320 futurep t))
15322 ;; Special date definitions below
15323 (cond
15324 (iso-week
15325 ;; There was an iso week
15326 (require 'cal-iso)
15327 (setq futurep nil)
15328 (setq year (or iso-year year)
15329 day (or iso-weekday wday 1)
15330 wday nil ; to make sure that the trigger below does not match
15331 iso-date (calendar-gregorian-from-absolute
15332 (calendar-absolute-from-iso
15333 (list iso-week day year))))
15334 ; FIXME: Should we also push ISO weeks into the future?
15335 ; (when (and org-read-date-prefer-future
15336 ; (not iso-year)
15337 ; (< (calendar-absolute-from-gregorian iso-date)
15338 ; (time-to-days (current-time))))
15339 ; (setq year (1+ year)
15340 ; iso-date (calendar-gregorian-from-absolute
15341 ; (calendar-absolute-from-iso
15342 ; (list iso-week day year)))))
15343 (setq month (car iso-date)
15344 year (nth 2 iso-date)
15345 day (nth 1 iso-date)))
15346 (deltan
15347 (setq futurep nil)
15348 (unless deltadef
15349 (let ((now (decode-time (current-time))))
15350 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15351 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15352 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15353 ((equal deltaw "m") (setq month (+ month deltan)))
15354 ((equal deltaw "y") (setq year (+ year deltan)))))
15355 ((and wday (not (nth 3 tl)))
15356 (setq futurep nil)
15357 ;; Weekday was given, but no day, so pick that day in the week
15358 ;; on or after the derived date.
15359 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15360 (unless (equal wday wday1)
15361 (setq day (+ day (% (- wday wday1 -7) 7))))))
15362 (if (and (boundp 'org-time-was-given)
15363 (nth 2 tl))
15364 (setq org-time-was-given t))
15365 (if (< year 100) (setq year (+ 2000 year)))
15366 ;; Check of the date is representable
15367 (if org-read-date-force-compatible-dates
15368 (progn
15369 (if (< year 1970)
15370 (setq year 1970 org-read-date-analyze-forced-year t))
15371 (if (> year 2037)
15372 (setq year 2037 org-read-date-analyze-forced-year t)))
15373 (condition-case nil
15374 (ignore (encode-time second minute hour day month year))
15375 (error
15376 (setq year (nth 5 defdecode))
15377 (setq org-read-date-analyze-forced-year t))))
15378 (setq org-read-date-analyze-futurep futurep)
15379 (list second minute hour day month year)))
15381 (defvar parse-time-weekdays)
15383 (defun org-read-date-get-relative (s today default)
15384 "Check string S for special relative date string.
15385 TODAY and DEFAULT are internal times, for today and for a default.
15386 Return shift list (N what def-flag)
15388 N is the number of WHATs to shift.
15389 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15390 the DEFAULT date rather than TODAY."
15391 (require 'parse-time)
15392 (when (and
15393 (string-match
15394 (concat
15399 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15400 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15401 (string-to-char (substring (match-string 1 s) -1))
15402 ?+))
15403 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15404 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15405 (what (if (match-end 3) (match-string 3 s) "d"))
15406 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15407 (date (if rel default today))
15408 (wday (nth 6 (decode-time date)))
15409 delta)
15410 (if wday1
15411 (progn
15412 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15413 (if (= dir ?-) (setq delta (- delta 7)))
15414 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15415 (list delta "d" rel))
15416 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15418 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15419 "Turn a user-specified date into the internal representation.
15420 The internal representation needed by the calendar is (month day year).
15421 This is a wrapper to handle the brain-dead convention in calendar that
15422 user function argument order change dependent on argument order."
15423 (if (boundp 'calendar-date-style)
15424 (cond
15425 ((eq calendar-date-style 'american)
15426 (list arg1 arg2 arg3))
15427 ((eq calendar-date-style 'european)
15428 (list arg2 arg1 arg3))
15429 ((eq calendar-date-style 'iso)
15430 (list arg2 arg3 arg1)))
15431 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15432 (if (org-bound-and-true-p european-calendar-style)
15433 (list arg2 arg1 arg3)
15434 (list arg1 arg2 arg3)))))
15436 (defun org-eval-in-calendar (form &optional keepdate)
15437 "Eval FORM in the calendar window and return to current window.
15438 Also, store the cursor date in variable org-ans2."
15439 (let ((sf (selected-frame))
15440 (sw (selected-window)))
15441 (select-window (get-buffer-window "*Calendar*" t))
15442 (eval form)
15443 (when (and (not keepdate) (calendar-cursor-to-date))
15444 (let* ((date (calendar-cursor-to-date))
15445 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15446 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15447 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15448 (select-window sw)
15449 (org-select-frame-set-input-focus sf)))
15451 (defun org-calendar-select ()
15452 "Return to `org-read-date' with the date currently selected.
15453 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15454 (interactive)
15455 (when (calendar-cursor-to-date)
15456 (let* ((date (calendar-cursor-to-date))
15457 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15458 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15459 (if (active-minibuffer-window) (exit-minibuffer))))
15461 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15462 "Insert a date stamp for the date given by the internal TIME.
15463 WITH-HM means use the stamp format that includes the time of the day.
15464 INACTIVE means use square brackets instead of angular ones, so that the
15465 stamp will not contribute to the agenda.
15466 PRE and POST are optional strings to be inserted before and after the
15467 stamp.
15468 The command returns the inserted time stamp."
15469 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15470 stamp)
15471 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15472 (insert-before-markers (or pre ""))
15473 (when (listp extra)
15474 (setq extra (car extra))
15475 (if (and (stringp extra)
15477 (setq extra (format "-%02d:%02d"
15478 (string-to-number (match-string 1 extra))
15479 (string-to-number (match-string 2 extra))))
15480 (setq extra nil)))
15481 (when extra
15482 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15483 (insert-before-markers (setq stamp (format-time-string fmt time)))
15484 (insert-before-markers (or post ""))
15485 (setq org-last-inserted-timestamp stamp)))
15487 (defun org-toggle-time-stamp-overlays ()
15488 "Toggle the use of custom time stamp formats."
15489 (interactive)
15490 (setq org-display-custom-times (not org-display-custom-times))
15491 (unless org-display-custom-times
15492 (let ((p (point-min)) (bmp (buffer-modified-p)))
15493 (while (setq p (next-single-property-change p 'display))
15494 (if (and (get-text-property p 'display)
15495 (eq (get-text-property p 'face) 'org-date))
15496 (remove-text-properties
15497 p (setq p (next-single-property-change p 'display))
15498 '(display t))))
15499 (set-buffer-modified-p bmp)))
15500 (if (featurep 'xemacs)
15501 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15502 (org-restart-font-lock)
15503 (setq org-table-may-need-update t)
15504 (if org-display-custom-times
15505 (message "Time stamps are overlaid with custom format")
15506 (message "Time stamp overlays removed")))
15508 (defun org-display-custom-time (beg end)
15509 "Overlay modified time stamp format over timestamp between BEG and END."
15510 (let* ((ts (buffer-substring beg end))
15511 t1 w1 with-hm tf time str w2 (off 0))
15512 (save-match-data
15513 (setq t1 (org-parse-time-string ts t))
15514 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15515 (setq off (- (match-end 0) (match-beginning 0)))))
15516 (setq end (- end off))
15517 (setq w1 (- end beg)
15518 with-hm (and (nth 1 t1) (nth 2 t1))
15519 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15520 time (org-fix-decoded-time t1)
15521 str (org-add-props
15522 (format-time-string
15523 (substring tf 1 -1) (apply 'encode-time time))
15524 nil 'mouse-face 'highlight)
15525 w2 (length str))
15526 (if (not (= w2 w1))
15527 (add-text-properties (1+ beg) (+ 2 beg)
15528 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15529 (if (featurep 'xemacs)
15530 (progn
15531 (put-text-property beg end 'invisible t)
15532 (put-text-property beg end 'end-glyph (make-glyph str)))
15533 (put-text-property beg end 'display str))))
15535 (defun org-translate-time (string)
15536 "Translate all timestamps in STRING to custom format.
15537 But do this only if the variable `org-display-custom-times' is set."
15538 (when org-display-custom-times
15539 (save-match-data
15540 (let* ((start 0)
15541 (re org-ts-regexp-both)
15542 t1 with-hm inactive tf time str beg end)
15543 (while (setq start (string-match re string start))
15544 (setq beg (match-beginning 0)
15545 end (match-end 0)
15546 t1 (save-match-data
15547 (org-parse-time-string (substring string beg end) t))
15548 with-hm (and (nth 1 t1) (nth 2 t1))
15549 inactive (equal (substring string beg (1+ beg)) "[")
15550 tf (funcall (if with-hm 'cdr 'car)
15551 org-time-stamp-custom-formats)
15552 time (org-fix-decoded-time t1)
15553 str (format-time-string
15554 (concat
15555 (if inactive "[" "<") (substring tf 1 -1)
15556 (if inactive "]" ">"))
15557 (apply 'encode-time time))
15558 string (replace-match str t t string)
15559 start (+ start (length str)))))))
15560 string)
15562 (defun org-fix-decoded-time (time)
15563 "Set 0 instead of nil for the first 6 elements of time.
15564 Don't touch the rest."
15565 (let ((n 0))
15566 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15568 (defun org-days-to-time (timestamp-string)
15569 "Difference between TIMESTAMP-STRING and now in days."
15570 (- (time-to-days (org-time-string-to-time timestamp-string))
15571 (time-to-days (current-time))))
15573 (defun org-deadline-close (timestamp-string &optional ndays)
15574 "Is the time in TIMESTAMP-STRING close to the current date?"
15575 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15576 (and (< (org-days-to-time timestamp-string) ndays)
15577 (not (org-entry-is-done-p))))
15579 (defun org-get-wdays (ts)
15580 "Get the deadline lead time appropriate for timestring TS."
15581 (cond
15582 ((<= org-deadline-warning-days 0)
15583 ;; 0 or negative, enforce this value no matter what
15584 (- org-deadline-warning-days))
15586 ;; lead time is specified.
15587 (floor (* (string-to-number (match-string 1 ts))
15588 (cdr (assoc (match-string 2 ts)
15589 '(("d" . 1) ("w" . 7)
15590 ("m" . 30.4) ("y" . 365.25)))))))
15591 ;; go for the default.
15592 (t org-deadline-warning-days)))
15594 (defun org-calendar-select-mouse (ev)
15595 "Return to `org-read-date' with the date currently selected.
15596 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15597 (interactive "e")
15598 (mouse-set-point ev)
15599 (when (calendar-cursor-to-date)
15600 (let* ((date (calendar-cursor-to-date))
15601 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15602 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15603 (if (active-minibuffer-window) (exit-minibuffer))))
15605 (defun org-check-deadlines (ndays)
15606 "Check if there are any deadlines due or past due.
15607 A deadline is considered due if it happens within `org-deadline-warning-days'
15608 days from today's date. If the deadline appears in an entry marked DONE,
15609 it is not shown. The prefix arg NDAYS can be used to test that many
15611 (interactive "P")
15612 (let* ((org-warn-days
15613 (cond
15614 ((equal ndays '(4)) 100000)
15615 (ndays (prefix-numeric-value ndays))
15616 (t (abs org-deadline-warning-days))))
15617 (case-fold-search nil)
15619 (callback
15620 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15622 (message "%d deadlines past-due or due within %d days"
15623 (org-occur regexp nil callback)
15624 org-warn-days)))
15626 (defun org-check-before-date (date)
15627 "Check if there are deadlines or scheduled entries before DATE."
15628 (interactive (list (org-read-date)))
15629 (let ((case-fold-search nil)
15633 (callback
15634 (lambda () (time-less-p
15635 (org-time-string-to-time (match-string 2))
15636 (org-time-string-to-time date)))))
15637 (message "%d entries before %s"
15638 (org-occur regexp nil callback) date)))
15640 (defun org-check-after-date (date)
15641 "Check if there are deadlines or scheduled entries after DATE."
15642 (interactive (list (org-read-date)))
15643 (let ((case-fold-search nil)
15647 (callback
15648 (lambda () (not
15649 (time-less-p
15650 (org-time-string-to-time (match-string 2))
15651 (org-time-string-to-time date))))))
15652 (message "%d entries after %s"
15653 (org-occur regexp nil callback) date)))
15655 (defun org-check-dates-range (start-date end-date)
15656 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15657 (interactive (list (org-read-date nil nil nil "Range starts")
15658 (org-read-date nil nil nil "Range end")))
15659 (let ((case-fold-search nil)
15663 (callback
15664 (lambda ()
15665 (let ((match (match-string 2)))
15666 (and
15667 (not (time-less-p
15668 (org-time-string-to-time match)
15669 (org-time-string-to-time start-date)))
15670 (time-less-p
15671 (org-time-string-to-time match)
15672 (org-time-string-to-time end-date)))))))
15673 (message "%d entries between %s and %s"
15674 (org-occur regexp nil callback) start-date end-date)))
15676 (defun org-evaluate-time-range (&optional to-buffer)
15677 "Evaluate a time range by computing the difference between start and end.
15678 Normally the result is just printed in the echo area, but with prefix arg
15679 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15680 If the time range is actually in a table, the result is inserted into the
15681 next column.
15682 For time difference computation, a year is assumed to be exactly 365
15683 days in order to avoid rounding problems."
15684 (interactive "P")
15685 (or
15686 (org-clock-update-time-maybe)
15687 (save-excursion
15688 (unless (org-at-date-range-p t)
15689 (goto-char (point-at-bol))
15690 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15691 (if (not (org-at-date-range-p t))
15692 (error "Not at a time-stamp range, and none found in current line")))
15693 (let* ((ts1 (match-string 1))
15694 (ts2 (match-string 2))
15695 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15696 (match-end (match-end 0))
15697 (time1 (org-time-string-to-time ts1))
15698 (time2 (org-time-string-to-time ts2))
15699 (t1 (org-float-time time1))
15700 (t2 (org-float-time time2))
15701 (diff (abs (- t2 t1)))
15702 (negative (< (- t2 t1) 0))
15703 ;; (ys (floor (* 365 24 60 60)))
15704 (ds (* 24 60 60))
15705 (hs (* 60 60))
15706 (fy "%dy %dd %02d:%02d")
15707 (fy1 "%dy %dd")
15708 (fd "%dd %02d:%02d")
15709 (fd1 "%dd")
15710 (fh "%02d:%02d")
15711 y d h m align)
15712 (if havetime
15713 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15714 y 0
15715 d (floor (/ diff ds)) diff (mod diff ds)
15716 h (floor (/ diff hs)) diff (mod diff hs)
15717 m (floor (/ diff 60)))
15718 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15719 y 0
15720 d (floor (+ (/ diff ds) 0.5))
15721 h 0 m 0))
15722 (if (not to-buffer)
15723 (message "%s" (org-make-tdiff-string y d h m))
15724 (if (org-at-table-p)
15725 (progn
15726 (goto-char match-end)
15727 (setq align t)
15728 (and (looking-at " *|") (goto-char (match-end 0))))
15729 (goto-char match-end))
15730 (if (looking-at
15732 (replace-match ""))
15733 (if negative (insert " -"))
15734 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15735 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15736 (insert " " (format fh h m))))
15737 (if align (org-table-align))
15738 (message "Time difference inserted")))))
15740 (defun org-make-tdiff-string (y d h m)
15741 (let ((fmt "")
15742 (l nil))
15743 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15744 l (push y l)))
15745 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15746 l (push d l)))
15747 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15748 l (push h l)))
15749 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15750 l (push m l)))
15751 (apply 'format fmt (nreverse l))))
15753 (defun org-time-string-to-time (s &optional buffer pos)
15754 (condition-case errdata
15755 (apply 'encode-time (org-parse-time-string s))
15757 s (if (not (and buffer pos))
15758 ""
15759 (format " at %d in buffer `%s'" pos buffer))
15760 (cdr errdata)))))
15762 (defun org-time-string-to-seconds (s)
15763 (org-float-time (org-time-string-to-time s)))
15765 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15766 "Convert a time stamp to an absolute day number.
15767 If there is a specifier for a cyclic time stamp, get the closest date to
15768 DAYNR.
15769 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15770 The variable date is bound by the calendar when this is called."
15771 (cond
15773 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15774 daynr
15775 (+ daynr 1000)))
15777 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15778 (time-to-days (current-time))) (match-string 0 s)
15779 prefer show-all))
15780 (t (time-to-days
15781 (condition-case errdata
15782 (apply 'encode-time (org-parse-time-string s))
15784 s (if (not (and buffer pos))
15785 ""
15786 (format " at %d in buffer `%s'" pos buffer))
15787 (cdr errdata))))))))
15789 (defun org-days-to-iso-week (days)
15790 "Return the iso week number."
15791 (require 'cal-iso)
15792 (car (calendar-iso-from-absolute days)))
15794 (defun org-small-year-to-year (year)
15795 "Convert 2-digit years into 4-digit years.
15796 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15797 The year 2000 cannot be abbreviated. Any year larger than 99
15798 is returned unchanged."
15799 (if (< year 38)
15800 (setq year (+ 2000 year))
15801 (if (< year 100)
15802 (setq year (+ 1900 year))))
15803 year)
15805 (defun org-time-from-absolute (d)
15806 "Return the time corresponding to date D.
15807 D may be an absolute day number, or a calendar-type list (month day year)."
15808 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15809 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15811 (defun org-calendar-holiday ()
15812 "List of holidays, for Diary display in Org-mode."
15813 (require 'holidays)
15814 (let ((hl (funcall
15815 (if (fboundp 'calendar-check-holidays)
15816 'calendar-check-holidays 'check-calendar-holidays) date)))
15817 (if hl (mapconcat 'identity hl "; "))))
15819 (defun org-diary-sexp-entry (sexp entry date)
15820 "Process a SEXP diary ENTRY for DATE."
15821 (require 'diary-lib)
15822 (let ((result (if calendar-debug-sexp
15823 (let ((stack-trace-on-error t))
15824 (eval (car (read-from-string sexp))))
15825 (condition-case nil
15826 (eval (car (read-from-string sexp)))
15827 (error
15828 (beep)
15829 (message "Bad sexp at line %d in %s: %s"
15830 (org-current-line)
15831 (buffer-file-name) sexp)
15832 (sleep-for 2))))))
15833 (cond ((stringp result) (split-string result "; "))
15834 ((and (consp result)
15835 (not (consp (cdr result)))
15836 (stringp (cdr result))) (cdr result))
15837 ((and (consp result)
15838 (stringp (car result))) result)
15839 (result entry)
15840 (t nil))))
15842 (defun org-diary-to-ical-string (frombuf)
15843 "Get iCalendar entries from diary entries in buffer FROMBUF.
15844 This uses the icalendar.el library."
15845 (let* ((tmpdir (if (featurep 'xemacs)
15846 (temp-directory)
15847 temporary-file-directory))
15848 (tmpfile (make-temp-name
15849 (expand-file-name "orgics" tmpdir)))
15850 buf rtn b e)
15851 (with-current-buffer frombuf
15852 (icalendar-export-region (point-min) (point-max) tmpfile)
15853 (setq buf (find-buffer-visiting tmpfile))
15854 (set-buffer buf)
15855 (goto-char (point-min))
15856 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15857 (setq b (match-beginning 0)))
15858 (goto-char (point-max))
15859 (if (re-search-backward "^END:VEVENT" nil t)
15860 (setq e (match-end 0)))
15862 (kill-buffer buf)
15863 (delete-file tmpfile)
15864 rtn))
15866 (defun org-closest-date (start current change prefer show-all)
15867 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15868 When PREFER is `past', return a date that is either CURRENT or past.
15869 When PREFER is `future', return a date that is either CURRENT or future.
15870 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15871 ;; Make the proper lists from the dates
15872 (catch 'exit
15873 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15874 dn dw sday cday n1 n2 n0
15875 d m y y1 y2 date1 date2 nmonths nm ny m2)
15877 (setq start (org-date-to-gregorian start)
15878 current (org-date-to-gregorian
15879 (if show-all
15880 current
15881 (time-to-days (current-time))))
15882 sday (calendar-absolute-from-gregorian start)
15883 cday (calendar-absolute-from-gregorian current))
15885 (if (<= cday sday) (throw 'exit sday))
15888 (setq dn (string-to-number (match-string 1 change))
15889 dw (cdr (assoc (match-string 2 change) a1)))
15890 (error "Invalid change specifier: %s" change))
15891 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15892 (cond
15893 ((eq dw 'day)
15894 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15895 n2 (+ n1 dn)))
15896 ((eq dw 'year)
15897 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15898 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15899 (setq date1 (list m d y1)
15900 n1 (calendar-absolute-from-gregorian date1)
15901 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15902 n2 (calendar-absolute-from-gregorian date2)))
15903 ((eq dw 'month)
15904 ;; approx number of month between the two dates
15905 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15906 ;; How often does dn fit in there?
15907 (setq d (nth 1 start) m (car start) y (nth 2 start)
15908 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15909 m (+ m nm)
15910 ny (floor (/ m 12))
15911 y (+ y ny)
15912 m (- m (* ny 12)))
15913 (while (> m 12) (setq m (- m 12) y (1+ y)))
15914 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15915 (setq m2 (+ m dn) y2 y)
15916 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15917 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15918 (while (<= n2 cday)
15919 (setq n1 n2 m m2 y y2)
15920 (setq m2 (+ m dn) y2 y)
15921 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15922 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15923 ;; Make sure n1 is the earlier date
15924 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15925 (if show-all
15926 (cond
15927 ((eq prefer 'past) (if (= cday n2) n2 n1))
15928 ((eq prefer 'future) (if (= cday n1) n1 n2))
15929 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15930 (cond
15931 ((eq prefer 'past) (if (= cday n2) n2 n1))
15932 ((eq prefer 'future) (if (= cday n1) n1 n2))
15933 (t (if (= cday n1) n1 n2)))))))
15935 (defun org-date-to-gregorian (date)
15936 "Turn any specification of DATE into a Gregorian date for the calendar."
15937 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15938 ((and (listp date) (= (length date) 3)) date)
15939 ((stringp date)
15940 (setq date (org-parse-time-string date))
15941 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15942 ((listp date)
15943 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15945 (defun org-parse-time-string (s &optional nodefault)
15946 "Parse the standard Org-mode time string.
15947 This should be a lot faster than the normal `parse-time-string'.
15948 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15949 hour and minute fields will be nil if not given."
15950 (if (string-match org-ts-regexp0 s)
15951 (list 0
15952 (if (or (match-beginning 8) (not nodefault))
15953 (string-to-number (or (match-string 8 s) "0")))
15954 (if (or (match-beginning 7) (not nodefault))
15955 (string-to-number (or (match-string 7 s) "0")))
15956 (string-to-number (match-string 4 s))
15957 (string-to-number (match-string 3 s))
15958 (string-to-number (match-string 2 s))
15959 nil nil nil)
15960 (error "Not a standard Org-mode time string: %s" s)))
15962 (defun org-timestamp-up (&optional arg)
15963 "Increase the date item at the cursor by one.
15964 If the cursor is on the year, change the year. If it is on the month,
15965 the day or the time, change that.
15966 With prefix ARG, change by that many units."
15967 (interactive "p")
15968 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15970 (defun org-timestamp-down (&optional arg)
15971 "Decrease the date item at the cursor by one.
15972 If the cursor is on the year, change the year. If it is on the month,
15973 the day or the time, change that.
15974 With prefix ARG, change by that many units."
15975 (interactive "p")
15976 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15978 (defun org-timestamp-up-day (&optional arg)
15979 "Increase the date in the time stamp by one day.
15980 With prefix ARG, change that many days."
15981 (interactive "p")
15982 (if (and (not (org-at-timestamp-p t))
15983 (org-at-heading-p))
15984 (org-todo 'up)
15985 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15987 (defun org-timestamp-down-day (&optional arg)
15988 "Decrease the date in the time stamp by one day.
15989 With prefix ARG, change that many days."
15990 (interactive "p")
15991 (if (and (not (org-at-timestamp-p t))
15992 (org-at-heading-p))
15993 (org-todo 'down)
15994 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15996 (defun org-at-timestamp-p (&optional inactive-ok)
15997 "Determine if the cursor is in or at a timestamp."
15998 (interactive)
15999 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16000 (pos (point))
16001 (ans (or (looking-at tsr)
16002 (save-excursion
16004 (if (> (point) (point-min)) (backward-char 1))
16005 (and (looking-at tsr)
16006 (> (- (match-end 0) pos) -1))))))
16007 (and ans
16008 (boundp 'org-ts-what)
16009 (setq org-ts-what
16010 (cond
16011 ((= pos (match-beginning 0)) 'bracket)
16012 ;; Point is considered to be "on the bracket" whether
16013 ;; it's really on it or right after it.
16014 ((or (= pos (1- (match-end 0)))
16015 (= pos (match-end 0))) 'bracket)
16016 ((org-pos-in-match-range pos 2) 'year)
16017 ((org-pos-in-match-range pos 3) 'month)
16018 ((org-pos-in-match-range pos 7) 'hour)
16019 ((org-pos-in-match-range pos 8) 'minute)
16020 ((or (org-pos-in-match-range pos 4)
16021 (org-pos-in-match-range pos 5)) 'day)
16022 ((and (> pos (or (match-end 8) (match-end 5)))
16023 (< pos (match-end 0)))
16024 (- pos (or (match-end 8) (match-end 5))))
16025 (t 'day))))
16026 ans))
16028 (defun org-toggle-timestamp-type ()
16029 "Toggle the type (<active> or [inactive]) of a time stamp."
16030 (interactive)
16031 (when (org-at-timestamp-p t)
16032 (let ((beg (match-beginning 0)) (end (match-end 0))
16033 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16034 (save-excursion
16035 (goto-char beg)
16036 (while (re-search-forward "[][<>]" end t)
16037 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16038 t t)))
16039 (message "Timestamp is now %sactive"
16040 (if (equal (char-after beg) ?<) "" "in")))))
16042 (defun org-timestamp-change (n &optional what updown)
16043 "Change the date in the time stamp at point.
16044 The date will be changed by N times WHAT. WHAT can be `day', `month',
16045 `year', `minute', `second'. If WHAT is not given, the cursor position
16046 in the timestamp determines what will be changed."
16047 (let ((origin (point)) origin-cat
16048 with-hm inactive
16049 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16050 org-ts-what
16051 extra rem
16052 ts time time0)
16053 (if (not (org-at-timestamp-p t))
16054 (error "Not at a timestamp"))
16055 (if (and (not what) (eq org-ts-what 'bracket))
16056 (org-toggle-timestamp-type)
16057 ;; Point isn't on brackets. Remember the part of the time-stamp
16058 ;; the point was in. Indeed, size of time-stamps may change,
16059 ;; but point must be kept in the same category nonetheless.
16060 (setq origin-cat org-ts-what)
16061 (if (and (not what) (not (eq org-ts-what 'day))
16062 org-display-custom-times
16063 (get-text-property (point) 'display)
16064 (not (get-text-property (1- (point)) 'display)))
16065 (setq org-ts-what 'day))
16066 (setq org-ts-what (or what org-ts-what)
16067 inactive (= (char-after (match-beginning 0)) ?\[)
16068 ts (match-string 0))
16069 (replace-match "")
16070 (if (string-match
16072 ts)
16073 (setq extra (match-string 1 ts)))
16075 (setq with-hm t))
16076 (setq time0 (org-parse-time-string ts))
16077 (when (and updown
16078 (eq org-ts-what 'minute)
16079 (not current-prefix-arg))
16080 ;; This looks like s-up and s-down. Change by one rounding step.
16081 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16082 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16083 (setcar (cdr time0) (+ (nth 1 time0)
16084 (if (> n 0) (- rem) (- dm rem))))))
16085 (setq time
16086 (encode-time (or (car time0) 0)
16087 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16088 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16089 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16090 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16091 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16092 (nthcdr 6 time0)))
16093 (when (and (member org-ts-what '(hour minute))
16094 extra
16096 (setq extra (org-modify-ts-extra
16097 extra
16098 (if (eq org-ts-what 'hour) 2 5)
16099 n dm)))
16100 (when (integerp org-ts-what)
16101 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16102 (if (eq what 'calendar)
16103 (let ((cal-date (org-get-date-from-calendar)))
16104 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16105 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16106 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16107 (setcar time0 (or (car time0) 0))
16108 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16109 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16110 (setq time (apply 'encode-time time0))))
16111 ;; Insert the new time-stamp, and ensure point stays in the same
16112 ;; category as before (i.e. not after the last position in that
16113 ;; category).
16114 (let ((pos (point)))
16115 ;; Stay before inserted string. `save-excursion' is of no use.
16116 (setq org-last-changed-timestamp
16117 (org-insert-time-stamp time with-hm inactive nil nil extra))
16118 (goto-char pos))
16119 (save-match-data
16120 (looking-at org-ts-regexp3)
16121 (goto-char (cond
16122 ;; `day' category ends before `hour' if any, or at
16123 ;; the end of the day name.
16124 ((eq origin-cat 'day)
16125 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16126 ((eq origin-cat 'hour) (min (match-end 7) origin))
16127 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16128 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16129 ;; `year' and `month' have both fixed size: point
16130 ;; couldn't have moved into another part.
16131 (t origin))))
16132 ;; Update clock if on a CLOCK line.
16133 (org-clock-update-time-maybe)
16134 ;; Try to recenter the calendar window, if any.
16135 (if (and org-calendar-follow-timestamp-change
16136 (get-buffer-window "*Calendar*" t)
16137 (memq org-ts-what '(day month year)))
16138 (org-recenter-calendar (time-to-days time))))))
16140 (defun org-modify-ts-extra (s pos n dm)
16141 "Change the different parts of the lead-time and repeat fields in timestamp."
16142 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16143 ng h m new rem)
16144 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16145 (cond
16146 ((or (org-pos-in-match-range pos 2)
16147 (org-pos-in-match-range pos 3))
16148 (setq m (string-to-number (match-string 3 s))
16149 h (string-to-number (match-string 2 s)))
16150 (if (org-pos-in-match-range pos 2)
16151 (setq h (+ h n))
16152 (setq n (* dm (org-no-warnings (signum n))))
16153 (when (not (= 0 (setq rem (% m dm))))
16154 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16155 (setq m (+ m n)))
16156 (if (< m 0) (setq m (+ m 60) h (1- h)))
16157 (if (> m 59) (setq m (- m 60) h (1+ h)))
16158 (setq h (min 24 (max 0 h)))
16159 (setq ng 1 new (format "-%02d:%02d" h m)))
16160 ((org-pos-in-match-range pos 6)
16161 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16162 ((org-pos-in-match-range pos 5)
16163 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16165 ((org-pos-in-match-range pos 9)
16166 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16167 ((org-pos-in-match-range pos 8)
16168 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16170 (when ng
16171 (setq s (concat
16172 (substring s 0 (match-beginning ng))
16173 new
16174 (substring s (match-end ng))))))
16175 s))
16177 (defun org-recenter-calendar (date)
16178 "If the calendar is visible, recenter it to DATE."
16179 (let* ((win (selected-window))
16180 (cwin (get-buffer-window "*Calendar*" t))
16181 (calendar-move-hook nil))
16182 (when cwin
16183 (select-window cwin)
16184 (calendar-goto-date (if (listp date) date
16185 (calendar-gregorian-from-absolute date)))
16186 (select-window win))))
16188 (defun org-goto-calendar (&optional arg)
16189 "Go to the Emacs calendar at the current date.
16190 If there is a time stamp in the current line, go to that date.
16191 A prefix ARG can be used to force the current date."
16192 (interactive "P")
16193 (let ((tsr org-ts-regexp) diff
16194 (calendar-move-hook nil)
16195 (calendar-view-holidays-initially-flag nil)
16196 (calendar-view-diary-initially-flag nil))
16197 (if (or (org-at-timestamp-p)
16198 (save-excursion
16199 (beginning-of-line 1)
16200 (looking-at (concat ".*" tsr))))
16201 (let ((d1 (time-to-days (current-time)))
16202 (d2 (time-to-days
16203 (org-time-string-to-time (match-string 1)))))
16204 (setq diff (- d2 d1))))
16205 (calendar)
16206 (calendar-goto-today)
16207 (if (and diff (not arg)) (calendar-forward-day diff))))
16209 (defun org-get-date-from-calendar ()
16210 "Return a list (month day year) of date at point in calendar."
16211 (with-current-buffer "*Calendar*"
16212 (save-match-data
16213 (calendar-cursor-to-date))))
16215 (defun org-date-from-calendar ()
16216 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16217 If there is already a time stamp at the cursor position, update it."
16218 (interactive)
16219 (if (org-at-timestamp-p t)
16220 (org-timestamp-change 0 'calendar)
16221 (let ((cal-date (org-get-date-from-calendar)))
16222 (org-insert-time-stamp
16223 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16225 (defun org-minutes-to-hh:mm-string (m)
16226 "Compute H:MM from a number of minutes."
16227 (let ((h (/ m 60)))
16228 (setq m (- m (* 60 h)))
16229 (format org-time-clocksum-format h m)))
16231 (defun org-hh:mm-string-to-minutes (s)
16232 "Convert a string H:MM to a number of minutes.
16233 If the string is just a number, interpret it as minutes.
16234 In fact, the first hh:mm or number in the string will be taken,
16235 there can be extra stuff in the string.
16236 If no number is found, the return value is 0."
16237 (cond
16238 ((integerp s) s)
16240 (+ (* (string-to-number (match-string 1 s)) 60)
16241 (string-to-number (match-string 2 s))))
16243 (string-to-number (match-string 1 s)))
16244 (t 0)))
16246 (defcustom org-effort-durations
16247 `(("h" . 60)
16248 ("d" . ,(* 60 8))
16249 ("w" . ,(* 60 8 5))
16250 ("m" . ,(* 60 8 5 4))
16251 ("y" . ,(* 60 8 5 40)))
16252 "Conversion factor to minutes for an effort modifier.
16254 Each entry has the form (MODIFIER . MINUTES).
16256 In an effort string, a number followed by MODIFIER is multiplied
16257 by the specified number of MINUTES to obtain an effort in
16258 minutes.
16262 :group 'org-agenda
16263 :version "24.1"
16264 :type '(alist :key-type (string :tag "Modifier")
16265 :value-type (number :tag "Minutes")))
16267 (defun org-duration-string-to-minutes (s)
16268 "Convert a duration string S to minutes.
16270 A bare number is interpreted as minutes, modifiers can be set by
16271 customizing `org-effort-durations' (which see).
16273 Entries containing a colon are interpreted as H:MM by
16274 `org-hh:mm-string-to-minutes'."
16275 (let ((result 0)
16277 (regexp-opt (mapcar 'car org-effort-durations))
16279 (while (string-match re s)
16280 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16281 (string-to-number (match-string 1 s))))
16282 (setq s (replace-match "" nil t s)))
16283 (incf result (org-hh:mm-string-to-minutes s))
16284 result))
16286 ;;;; Files
16288 (defun org-save-all-org-buffers ()
16289 "Save all Org-mode buffers without user confirmation."
16290 (interactive)
16291 (message "Saving all Org-mode buffers...")
16292 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16293 (when (featurep 'org-id) (org-id-locations-save))
16294 (message "Saving all Org-mode buffers... done"))
16296 (defun org-revert-all-org-buffers ()
16297 "Revert all Org-mode buffers.
16298 Prompt for confirmation when there are unsaved changes.
16299 Be sure you know what you are doing before letting this function
16300 overwrite your changes.
16302 This function is useful in a setup where one tracks org files
16303 with a version control system, to revert on one machine after pulling
16304 changes from another. I believe the procedure must be like this:
16306 1. M-x org-save-all-org-buffers
16307 2. Pull changes from the other machine, resolve conflicts
16308 3. M-x org-revert-all-org-buffers"
16309 (interactive)
16310 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16311 (error "Abort"))
16312 (save-excursion
16313 (save-window-excursion
16314 (mapc
16315 (lambda (b)
16316 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16317 (with-current-buffer b buffer-file-name))
16318 (org-pop-to-buffer-same-window b)
16319 (revert-buffer t 'no-confirm)))
16320 (buffer-list))
16321 (when (and (featurep 'org-id) org-id-track-globally)
16322 (org-id-locations-load)))))
16324 ;;;; Agenda files
16326 ;;;###autoload
16327 (defun org-switchb (&optional arg)
16328 "Switch between Org buffers.
16329 With one prefix argument, restrict available buffers to files.
16330 With two prefix arguments, restrict available buffers to agenda files.
16332 Defaults to `iswitchb' for buffer name completion.
16333 Set `org-completion-use-ido' to make it use ido instead."
16334 (interactive "P")
16335 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16336 ((equal arg '(16)) (org-buffer-list 'agenda))
16337 (t (org-buffer-list))))
16338 (org-completion-use-iswitchb org-completion-use-iswitchb)
16339 (org-completion-use-ido org-completion-use-ido))
16340 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16341 (setq org-completion-use-iswitchb t))
16342 (org-pop-to-buffer-same-window
16343 (org-icompleting-read "Org buffer: "
16344 (mapcar 'list (mapcar 'buffer-name blist))
16345 nil t))))
16347 ;;; Define some older names previously used for this functionality
16348 ;;;###autoload
16349 (defalias 'org-ido-switchb 'org-switchb)
16350 ;;;###autoload
16351 (defalias 'org-iswitchb 'org-switchb)
16353 (defun org-buffer-list (&optional predicate exclude-tmp)
16354 "Return a list of Org buffers.
16355 PREDICATE can be `export', `files' or `agenda'.
16357 export restrict the list to Export buffers.
16358 files restrict the list to buffers visiting Org files.
16359 agenda restrict the list to buffers visiting agenda files.
16361 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16362 (let* ((bfn nil)
16363 (agenda-files (and (eq predicate 'agenda)
16364 (mapcar 'file-truename (org-agenda-files t))))
16365 (filter
16366 (cond
16367 ((eq predicate 'files)
16368 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16369 ((eq predicate 'export)
16370 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16371 ((eq predicate 'agenda)
16372 (lambda (b)
16373 (with-current-buffer b
16374 (and (eq major-mode 'org-mode)
16375 (setq bfn (buffer-file-name b))
16376 (member (file-truename bfn) agenda-files)))))
16377 (t (lambda (b) (with-current-buffer b
16378 (or (eq major-mode 'org-mode)
16379 (string-match "\*Org .*Export"
16380 (buffer-name b)))))))))
16381 (delq nil
16382 (mapcar
16383 (lambda(b)
16384 (if (and (funcall filter b)
16385 (or (not exclude-tmp)
16386 (not (string-match "tmp" (buffer-name b)))))
16387 b
16388 nil))
16389 (buffer-list)))))
16391 (defun org-agenda-files (&optional unrestricted archives)
16392 "Get the list of agenda files.
16393 Optional UNRESTRICTED means return the full list even if a restriction
16394 is currently in place.
16395 When ARCHIVES is t, include all archive files that are really being
16396 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16397 `org-agenda-archives-mode' is t."
16398 (let ((files
16399 (cond
16400 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16401 ((stringp org-agenda-files) (org-read-agenda-file-list))
16402 ((listp org-agenda-files) org-agenda-files)
16403 (t (error "Invalid value of `org-agenda-files'")))))
16404 (setq files (apply 'append
16405 (mapcar (lambda (f)
16406 (if (file-directory-p f)
16407 (directory-files
16408 f t org-agenda-file-regexp)
16409 (list f)))
16410 files)))
16411 (when org-agenda-skip-unavailable-files
16412 (setq files (delq nil
16413 (mapcar (function
16414 (lambda (file)
16415 (and (file-readable-p file) file)))
16416 files))))
16417 (when (or (eq archives t)
16418 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16419 (setq files (org-add-archive-files files)))
16420 files))
16422 (defun org-agenda-file-p (&optional file)
16423 "Return non-nil, if FILE is an agenda file.
16424 If FILE is omitted, use the file associated with the current
16425 buffer."
16426 (member (or file (buffer-file-name))
16427 (org-agenda-files t)))
16429 (defun org-edit-agenda-file-list ()
16430 "Edit the list of agenda files.
16431 Depending on setup, this either uses customize to edit the variable
16432 `org-agenda-files', or it visits the file that is holding the list. In the
16433 latter case, the buffer is set up in a way that saving it automatically kills
16434 the buffer and restores the previous window configuration."
16435 (interactive)
16436 (if (stringp org-agenda-files)
16437 (let ((cw (current-window-configuration)))
16438 (find-file org-agenda-files)
16439 (org-set-local 'org-window-configuration cw)
16440 (org-add-hook 'after-save-hook
16441 (lambda ()
16442 (set-window-configuration
16443 (prog1 org-window-configuration
16444 (kill-buffer (current-buffer))))
16445 (org-install-agenda-files-menu)
16446 (message "New agenda file list installed"))
16447 nil 'local)
16448 (message "%s" (substitute-command-keys
16450 (customize-variable 'org-agenda-files)))
16452 (defun org-store-new-agenda-file-list (list)
16453 "Set new value for the agenda file list and save it correctly."
16454 (if (stringp org-agenda-files)
16455 (let ((fe (org-read-agenda-file-list t)) b u)
16456 (while (setq b (find-buffer-visiting org-agenda-files))
16457 (kill-buffer b))
16458 (with-temp-file org-agenda-files
16459 (insert
16460 (mapconcat
16461 (lambda (f) ;; Keep un-expanded entries.
16462 (if (setq u (assoc f fe))
16463 (cdr u)
16464 f))
16467 (let ((org-mode-hook nil) (org-inhibit-startup t)
16468 (org-insert-mode-line-in-empty-file nil))
16469 (setq org-agenda-files list)
16470 (customize-save-variable 'org-agenda-files org-agenda-files))))
16472 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16473 "Read the list of agenda files from a file.
16474 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16475 filenames, used by `org-store-new-agenda-file-list' to write back
16476 un-expanded file names."
16477 (when (file-directory-p org-agenda-files)
16478 (error "`org-agenda-files' cannot be a single directory"))
16479 (when (stringp org-agenda-files)
16480 (with-temp-buffer
16481 (insert-file-contents org-agenda-files)
16482 (mapcar
16483 (lambda (f)
16484 (let ((e (expand-file-name (substitute-in-file-name f)
16485 org-directory)))
16486 (if pair-with-expansion
16487 (cons e f)
16488 e)))
16491 ;;;###autoload
16492 (defun org-cycle-agenda-files ()
16493 "Cycle through the files in `org-agenda-files'.
16494 If the current buffer visits an agenda file, find the next one in the list.
16495 If the current buffer does not, find the first agenda file."
16496 (interactive)
16497 (let* ((fs (org-agenda-files t))
16498 (files (append fs (list (car fs))))
16499 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16500 file)
16501 (unless files (error "No agenda files"))
16502 (catch 'exit
16503 (while (setq file (pop files))
16504 (if (equal (file-truename file) tcf)
16505 (when (car files)
16506 (find-file (car files))
16507 (throw 'exit t))))
16508 (find-file (car fs)))
16509 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16511 (defun org-agenda-file-to-front (&optional to-end)
16512 "Move/add the current file to the top of the agenda file list.
16513 If the file is not present in the list, it is added to the front. If it is
16514 present, it is moved there. With optional argument TO-END, add/move to the
16515 end of the list."
16516 (interactive "P")
16517 (let ((org-agenda-skip-unavailable-files nil)
16518 (file-alist (mapcar (lambda (x)
16519 (cons (file-truename x) x))
16520 (org-agenda-files t)))
16521 (ctf (file-truename buffer-file-name))
16522 x had)
16523 (setq x (assoc ctf file-alist) had x)
16525 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16526 (if to-end
16527 (setq file-alist (append (delq x file-alist) (list x)))
16528 (setq file-alist (cons x (delq x file-alist))))
16529 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16530 (org-install-agenda-files-menu)
16531 (message "File %s to %s of agenda file list"
16532 (if had "moved" "added") (if to-end "end" "front"))))
16534 (defun org-remove-file (&optional file)
16535 "Remove current file from the list of files in variable `org-agenda-files'.
16536 These are the files which are being checked for agenda entries.
16537 Optional argument FILE means use this file instead of the current."
16538 (interactive)
16539 (let* ((org-agenda-skip-unavailable-files nil)
16540 (file (or file buffer-file-name))
16541 (true-file (file-truename file))
16542 (afile (abbreviate-file-name file))
16543 (files (delq nil (mapcar
16544 (lambda (x)
16545 (if (equal true-file
16546 (file-truename x))
16547 nil x))
16548 (org-agenda-files t)))))
16549 (if (not (= (length files) (length (org-agenda-files t))))
16550 (progn
16551 (org-store-new-agenda-file-list files)
16552 (org-install-agenda-files-menu)
16553 (message "Removed file: %s" afile))
16554 (message "File was not in list: %s (not removed)" afile))))
16556 (defun org-file-menu-entry (file)
16557 (vector file (list 'find-file file) t))
16559 (defun org-check-agenda-file (file)
16560 "Make sure FILE exists. If not, ask user what to do."
16561 (when (not (file-exists-p file))
16562 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16563 (abbreviate-file-name file))
16564 (let ((r (downcase (read-char-exclusive))))
16565 (cond
16566 ((equal r ?r)
16567 (org-remove-file file)
16568 (throw 'nextfile t))
16569 (t (error "Abort"))))))
16571 (defun org-get-agenda-file-buffer (file)
16572 "Get a buffer visiting FILE. If the buffer needs to be created, add
16573 it to the list of buffers which might be released later."
16574 (let ((buf (org-find-base-buffer-visiting file)))
16575 (if buf
16576 buf ; just return it
16577 ;; Make a new buffer and remember it
16578 (setq buf (find-file-noselect file))
16579 (if buf (push buf org-agenda-new-buffers))
16580 buf)))
16582 (defun org-release-buffers (blist)
16583 "Release all buffers in list, asking the user for confirmation when needed.
16584 When a buffer is unmodified, it is just killed. When modified, it is saved
16585 \(if the user agrees) and then killed."
16586 (let (buf file)
16587 (while (setq buf (pop blist))
16588 (setq file (buffer-file-name buf))
16589 (when (and (buffer-modified-p buf)
16590 file
16591 (y-or-n-p (format "Save file %s? " file)))
16592 (with-current-buffer buf (save-buffer)))
16593 (kill-buffer buf))))
16595 (defun org-prepare-agenda-buffers (files)
16596 "Create buffers for all agenda files, protect archived trees and comments."
16597 (interactive)
16598 (let ((pa '(:org-archived t))
16599 (pc '(:org-comment t))
16600 (pall '(:org-archived t :org-comment t))
16601 (inhibit-read-only t)
16602 (rea (concat ":" org-archive-tag ":"))
16603 bmp file re)
16604 (save-excursion
16605 (save-restriction
16606 (while (setq file (pop files))
16607 (catch 'nextfile
16608 (if (bufferp file)
16609 (set-buffer file)
16610 (org-check-agenda-file file)
16611 (set-buffer (org-get-agenda-file-buffer file)))
16612 (widen)
16613 (setq bmp (buffer-modified-p))
16614 (org-refresh-category-properties)
16615 (setq org-todo-keywords-for-agenda
16616 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16617 (setq org-done-keywords-for-agenda
16618 (append org-done-keywords-for-agenda org-done-keywords))
16619 (setq org-todo-keyword-alist-for-agenda
16620 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16621 (setq org-drawers-for-agenda
16622 (append org-drawers-for-agenda org-drawers))
16623 (setq org-tag-alist-for-agenda
16624 (append org-tag-alist-for-agenda org-tag-alist))
16626 (save-excursion
16627 (remove-text-properties (point-min) (point-max) pall)
16628 (when org-agenda-skip-archived-trees
16629 (goto-char (point-min))
16630 (while (re-search-forward rea nil t)
16631 (if (org-at-heading-p t)
16632 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16633 (goto-char (point-min))
16634 (setq re (format org-heading-keyword-regexp-format
16635 org-comment-string))
16636 (while (re-search-forward re nil t)
16637 (add-text-properties
16638 (match-beginning 0) (org-end-of-subtree t) pc)))
16639 (set-buffer-modified-p bmp)))))
16640 (setq org-todo-keywords-for-agenda
16641 (org-uniquify org-todo-keywords-for-agenda))
16642 (setq org-todo-keyword-alist-for-agenda
16643 (org-uniquify org-todo-keyword-alist-for-agenda)
16644 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16646 ;;;; Embedded LaTeX
16648 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16649 "Keymap for the minor `org-cdlatex-mode'.")
16651 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16652 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16653 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16654 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16655 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16657 (defvar org-cdlatex-texmathp-advice-is-done nil
16658 "Flag remembering if we have applied the advice to texmathp already.")
16660 (define-minor-mode org-cdlatex-mode
16661 "Toggle the minor `org-cdlatex-mode'.
16662 This mode supports entering LaTeX environment and math in LaTeX fragments
16663 in Org-mode.
16665 nil " OCDL" nil
16666 (when org-cdlatex-mode
16667 (require 'cdlatex)
16668 (run-hooks 'cdlatex-mode-hook)
16669 (cdlatex-compute-tables))
16670 (unless org-cdlatex-texmathp-advice-is-done
16671 (setq org-cdlatex-texmathp-advice-is-done t)
16672 (defadvice texmathp (around org-math-always-on activate)
16673 "Always return t in org-mode buffers.
16674 This is because we want to insert math symbols without dollars even outside
16675 the LaTeX math segments. If Orgmode thinks that point is actually inside
16676 an embedded LaTeX fragment, let texmathp do its job.
16678 (interactive)
16679 (let (p)
16680 (cond
16681 ((not (eq major-mode 'org-mode)) ad-do-it)
16682 ((eq this-command 'cdlatex-math-symbol)
16683 (setq ad-return-value t
16684 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16685 (t
16686 (let ((p (org-inside-LaTeX-fragment-p)))
16687 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16688 (setq ad-return-value t
16689 texmathp-why '("Org-mode embedded math" . 0))
16690 (if p ad-do-it)))))))))
16692 (defun turn-on-org-cdlatex ()
16693 "Unconditionally turn on `org-cdlatex-mode'."
16694 (org-cdlatex-mode 1))
16696 (defun org-inside-LaTeX-fragment-p ()
16697 "Test if point is inside a LaTeX fragment.
16699 sequence appearing also before point.
16700 Even though the matchers for math are configurable, this function assumes
16702 delimiters are skipped when they have been removed by customization.
16703 The return value is nil, or a cons cell with the delimiter and the
16704 position of this delimiter.
16706 This function does a reasonably good job, but can locally be fooled by
16707 for example currency specifications. For example it will assume being in
16709 fragments that are properly closed, but during editing, we have to live
16710 with the uncertainty caused by missing closing delimiters. This function
16711 looks only before point, not after."
16712 (catch 'exit
16713 (let ((pos (point))
16714 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16715 (lim (progn
16717 (point)))
16718 dd-on str (start 0) m re)
16719 (goto-char pos)
16720 (when dodollar
16722 re (nth 1 (assoc "$" org-latex-regexps)))
16723 (while (string-match re str start)
16724 (cond
16725 ((= (match-end 0) (length str))
16726 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16727 ((= (match-end 0) (- (length str) 5))
16728 (throw 'exit nil))
16729 (t (setq start (match-end 0))))))
16730 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16731 (goto-char pos)
16732 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16733 (and (match-beginning 2) (throw 'exit nil))
16734 ;; count $$
16736 (setq dd-on (not dd-on)))
16737 (goto-char pos)
16738 (if dd-on (cons "$$" m))))))
16740 (defun org-inside-latex-macro-p ()
16741 "Is point inside a LaTeX macro or its arguments?"
16742 (save-match-data
16743 (org-in-regexp
16746 (defun org-try-cdlatex-tab ()
16747 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16748 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16749 - inside a LaTeX fragment, or
16750 - after the first word in a line, where an abbreviation expansion could
16751 insert a LaTeX environment."
16752 (when org-cdlatex-mode
16753 (cond
16754 ;; Before any word on the line: No expansion possible.
16756 ;; Just after first word on the line: Expand it. Make sure it
16757 ;; cannot happen on headlines, though.
16758 ((save-excursion
16759 (skip-chars-backward "a-zA-Z0-9*")
16761 (and (bolp) (not (org-at-heading-p))))
16762 (cdlatex-tab) t)
16763 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16765 (defun org-cdlatex-underscore-caret (&optional arg)
16766 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16767 Revert to the normal definition outside of these fragments."
16768 (interactive "P")
16769 (if (org-inside-LaTeX-fragment-p)
16770 (call-interactively 'cdlatex-sub-superscript)
16771 (let (org-cdlatex-mode)
16772 (call-interactively (key-binding (vector last-input-event))))))
16774 (defun org-cdlatex-math-modify (&optional arg)
16775 "Execute `cdlatex-math-modify' in LaTeX fragments.
16776 Revert to the normal definition outside of these fragments."
16777 (interactive "P")
16778 (if (org-inside-LaTeX-fragment-p)
16779 (call-interactively 'cdlatex-math-modify)
16780 (let (org-cdlatex-mode)
16781 (call-interactively (key-binding (vector last-input-event))))))
16783 (defvar org-latex-fragment-image-overlays nil
16784 "List of overlays carrying the images of latex fragments.")
16785 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16787 (defun org-remove-latex-fragment-image-overlays ()
16788 "Remove all overlays with LaTeX fragment images in current buffer."
16789 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16790 (setq org-latex-fragment-image-overlays nil))
16792 (defun org-preview-latex-fragment (&optional subtree)
16793 "Preview the LaTeX fragment at point, or all locally or globally.
16794 If the cursor is in a LaTeX fragment, create the image and overlay
16795 it over the source code. If there is no fragment at point, display
16796 all fragments in the current text, from one headline to the next. With
16797 prefix SUBTREE, display all fragments in the current subtree. With a
16799 the cursor is before the first headline,
16800 display all fragments in the buffer.
16802 (interactive "P")
16803 (unless buffer-file-name
16804 (error "Can't preview LaTeX fragment in a non-file buffer"))
16805 (org-remove-latex-fragment-image-overlays)
16806 (save-excursion
16807 (save-restriction
16808 (let (beg end at msg)
16809 (cond
16810 ((or (equal subtree '(16))
16811 (not (save-excursion
16812 (re-search-backward org-outline-regexp-bol nil t))))
16813 (setq beg (point-min) end (point-max)
16814 msg "Creating images for buffer...%s"))
16815 ((equal subtree '(4))
16816 (org-back-to-heading)
16817 (setq beg (point) end (org-end-of-subtree t)
16818 msg "Creating images for subtree...%s"))
16819 (t
16820 (if (setq at (org-inside-LaTeX-fragment-p))
16821 (goto-char (max (point-min) (- (cdr at) 2)))
16822 (org-back-to-heading))
16823 (setq beg (point) end (progn (outline-next-heading) (point))
16824 msg (if at "Creating image...%s"
16825 "Creating images for entry...%s"))))
16826 (message msg "")
16827 (narrow-to-region beg end)
16828 (goto-char beg)
16829 (org-format-latex
16830 (concat "ltxpng/" (file-name-sans-extension
16831 (file-name-nondirectory
16832 buffer-file-name)))
16833 default-directory 'overlays msg at 'forbuffer 'dvipng)
16834 (message msg "done. Use `C-c C-c' to remove images.")))))
16836 (defvar org-latex-regexps
16838 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16841 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16845 "Regular expressions for matching embedded LaTeX.")
16847 (defvar org-export-have-math nil) ;; dynamic scoping
16848 (defun org-format-latex (prefix &optional dir overlays msg at
16849 forbuffer processing-type)
16850 "Replace LaTeX fragments with links to an image, and produce images.
16851 Some of the options can be changed using the variable
16852 `org-format-latex-options'."
16853 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16854 (let* ((prefixnodir (file-name-nondirectory prefix))
16855 (absprefix (expand-file-name prefix dir))
16856 (todir (file-name-directory absprefix))
16857 (opt org-format-latex-options)
16858 (matchers (plist-get opt :matchers))
16859 (re-list org-latex-regexps)
16860 (org-format-latex-header-extra
16861 (plist-get (org-infile-export-plist) :latex-header-extra))
16862 (cnt 0) txt hash link beg end re e checkdir
16863 executables-checked string
16864 m n block-type block linkfile movefile ov)
16865 ;; Check the different regular expressions
16866 (while (setq e (pop re-list))
16867 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16869 (when (member m matchers)
16870 (goto-char (point-min))
16871 (while (re-search-forward re nil t)
16872 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16873 (not (get-text-property (match-beginning n)
16874 'org-protected))
16875 (or (not overlays)
16876 (not (eq (get-char-property (match-beginning n)
16877 'org-overlay-type)
16878 'org-latex-overlay))))
16879 (setq org-export-have-math t)
16880 (cond
16881 ((eq processing-type 'verbatim)
16882 ;; Leave the text verbatim, just protect it
16883 (add-text-properties (match-beginning n) (match-end n)
16884 '(org-protected t)))
16885 ((eq processing-type 'mathjax)
16886 ;; Prepare for MathJax processing
16887 (setq string (match-string n))
16888 (if (member m '("$" "$1"))
16889 (save-excursion
16890 (delete-region (match-beginning n) (match-end n))
16891 (goto-char (match-beginning n))
16894 '(org-protected t))))
16895 (add-text-properties (match-beginning n) (match-end n)
16896 '(org-protected t))))
16897 ((eq processing-type 'dvipng)
16898 ;; Process to an image
16899 (setq txt (match-string n)
16900 beg (match-beginning n) end (match-end n)
16901 cnt (1+ cnt))
16902 (let (print-length print-level) ; make sure full list is printed
16903 (setq hash (sha1 (prin1-to-string
16904 (list org-format-latex-header
16905 org-format-latex-header-extra
16906 org-export-latex-default-packages-alist
16907 org-export-latex-packages-alist
16908 org-format-latex-options
16909 forbuffer txt)))
16910 linkfile (format "%s_%s.png" prefix hash)
16911 movefile (format "%s_%s.png" absprefix hash)))
16912 (setq link (concat block "[[file:" linkfile "]]" block))
16913 (if msg (message msg cnt))
16914 (goto-char beg)
16915 (unless checkdir ; make sure the directory exists
16916 (setq checkdir t)
16917 (or (file-directory-p todir) (make-directory todir t)))
16919 (unless executables-checked
16920 (org-check-external-command
16921 "latex" "needed to convert LaTeX fragments to images")
16922 (org-check-external-command
16923 "dvipng" "needed to convert LaTeX fragments to images")
16924 (setq executables-checked t))
16926 (unless (file-exists-p movefile)
16927 (org-create-formula-image
16928 txt movefile opt forbuffer))
16929 (if overlays
16930 (progn
16931 (mapc (lambda (o)
16932 (if (eq (overlay-get o 'org-overlay-type)
16933 'org-latex-overlay)
16934 (delete-overlay o)))
16935 (overlays-in beg end))
16936 (setq ov (make-overlay beg end))
16937 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16938 (if (featurep 'xemacs)
16939 (progn
16940 (overlay-put ov 'invisible t)
16941 (overlay-put
16942 ov 'end-glyph
16943 (make-glyph (vector 'png :file movefile))))
16944 (overlay-put
16945 ov 'display
16946 (list 'image :type 'png :file movefile :ascent 'center)))
16947 (push ov org-latex-fragment-image-overlays)
16948 (goto-char end))
16949 (delete-region beg end)
16950 (insert (org-add-props link
16951 (list 'org-latex-src
16952 (replace-regexp-in-string
16954 'org-latex-src-embed-type
16955 (if block-type 'paragraph 'character))))))
16956 ((eq processing-type 'mathml)
16957 ;; Process to MathML
16958 (unless executables-checked
16959 (unless (save-match-data (org-format-latex-mathml-available-p))
16960 (error "LaTeX to MathML converter not configured"))
16961 (setq executables-checked t))
16962 (setq txt (match-string n)
16963 beg (match-beginning n) end (match-end n)
16964 cnt (1+ cnt))
16965 (if msg (message msg cnt))
16966 (goto-char beg)
16967 (delete-region beg end)
16968 (insert (org-format-latex-as-mathml
16969 txt block-type prefix dir)))
16970 (t
16971 (error "Unknown conversion type %s for latex fragments"
16972 processing-type)))))))))
16974 (defun org-create-math-formula (latex-frag &optional mathml-file)
16975 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16976 Use `org-latex-to-mathml-convert-command'. If the conversion is
16978 elements otherwise return nil. When MATHML-FILE is specified,
16979 write the results in to that file. When invoked as an
16980 interactive command, prompt for LATEX-FRAG, with initial value
16981 set to the current active region and echo the results for user
16982 inspection."
16983 (interactive (list (let ((frag (when (region-active-p)
16984 (buffer-substring-no-properties
16985 (region-beginning) (region-end)))))
16986 (read-string "LaTeX Fragment: " frag nil frag))))
16987 (unless latex-frag (error "Invalid latex-frag"))
16988 (let* ((tmp-in-file (file-relative-name
16989 (make-temp-name (expand-file-name "ltxmathml-in"))))
16990 (ignore (write-region latex-frag nil tmp-in-file))
16991 (tmp-out-file (file-relative-name
16992 (make-temp-name (expand-file-name "ltxmathml-out"))))
16993 (cmd (format-spec
16994 org-latex-to-mathml-convert-command
16995 `((?j . ,(shell-quote-argument
16996 (expand-file-name org-latex-to-mathml-jar-file)))
16997 (?I . ,(shell-quote-argument tmp-in-file))
16998 (?o . ,(shell-quote-argument tmp-out-file)))))
16999 mathml shell-command-output)
17000 (when (org-called-interactively-p 'any)
17001 (unless (org-format-latex-mathml-available-p)
17002 (error "LaTeX to MathML converter not configured")))
17003 (message "Running %s" cmd)
17004 (setq shell-command-output (shell-command-to-string cmd))
17005 (setq mathml
17006 (when (file-readable-p tmp-out-file)
17007 (with-current-buffer (find-file-noselect tmp-out-file t)
17008 (goto-char (point-min))
17009 (when (re-search-forward
17010 (concat
17011 (regexp-quote
17014 (regexp-quote "</math>")) nil t)
17015 (prog1 (match-string 0) (kill-buffer))))))
17016 (cond
17017 (mathml
17018 (setq mathml
17020 (when mathml-file
17021 (write-region mathml nil mathml-file))
17022 (when (org-called-interactively-p 'any)
17023 (message mathml)))
17024 ((message "LaTeX to MathML conversion failed")
17025 (message shell-command-output)))
17026 (delete-file tmp-in-file)
17027 (when (file-exists-p tmp-out-file)
17028 (delete-file tmp-out-file))
17029 mathml))
17031 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17032 prefix &optional dir)
17033 "Use `org-create-math-formula' but check local cache first."
17034 (let* ((absprefix (expand-file-name prefix dir))
17035 (print-length nil) (print-level nil)
17036 (formula-id (concat
17037 "formula-"
17038 (sha1
17039 (prin1-to-string
17040 (list latex-frag
17041 org-latex-to-mathml-convert-command)))))
17042 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17043 (formula-cache-dir (file-name-directory formula-cache)))
17045 (unless (file-directory-p formula-cache-dir)
17046 (make-directory formula-cache-dir t))
17048 (unless (file-exists-p formula-cache)
17049 (org-create-math-formula latex-frag formula-cache))
17051 (if (file-exists-p formula-cache)
17052 ;; Successful conversion. Return the link to MathML file.
17053 (org-add-props
17054 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17056 'org-latex-src-embed-type (if latex-frag-type
17057 'paragraph 'character)))
17058 ;; Failed conversion. Return the LaTeX fragment verbatim
17059 (add-text-properties
17060 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17061 latex-frag)))
17063 ;; This function borrows from Ganesh Swami's latex2png.el
17064 (defun org-create-formula-image (string tofile options buffer)
17065 "This calls dvipng."
17066 (require 'org-latex)
17067 (let* ((tmpdir (if (featurep 'xemacs)
17068 (temp-directory)
17069 temporary-file-directory))
17070 (texfilebase (make-temp-name
17071 (expand-file-name "orgtex" tmpdir)))
17072 (texfile (concat texfilebase ".tex"))
17073 (dvifile (concat texfilebase ".dvi"))
17074 (pngfile (concat texfilebase ".png"))
17075 (fnh (if (featurep 'xemacs)
17076 (font-height (get-face-font 'default))
17077 (face-attribute 'default :height nil)))
17078 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17079 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17080 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17081 "Black"))
17082 (bg (or (plist-get options (if buffer :background :html-background))
17083 "Transparent")))
17084 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17085 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17086 (with-temp-file texfile
17087 (insert (org-splice-latex-header
17088 org-format-latex-header
17089 org-export-latex-default-packages-alist
17090 org-export-latex-packages-alist t
17091 org-format-latex-header-extra))
17093 (require 'org-latex)
17094 (org-export-latex-fix-inputenc))
17095 (let ((dir default-directory))
17096 (condition-case nil
17097 (progn
17098 (cd tmpdir)
17099 (call-process "latex" nil nil nil texfile))
17100 (error nil))
17101 (cd dir))
17102 (if (not (file-exists-p dvifile))
17103 (progn (message "Failed to create dvi file from %s" texfile) nil)
17104 (condition-case nil
17105 (call-process "dvipng" nil nil nil
17106 "-fg" fg "-bg" bg
17107 "-D" dpi
17108 ;;"-x" scale "-y" scale
17109 "-T" "tight"
17110 "-o" pngfile
17111 dvifile)
17112 (error nil))
17113 (if (not (file-exists-p pngfile))
17114 (if org-format-latex-signal-error
17115 (error "Failed to create png file from %s" texfile)
17116 (message "Failed to create png file from %s" texfile)
17117 nil)
17118 ;; Use the requested file name and clean up
17119 (copy-file pngfile tofile 'replace)
17120 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17121 (delete-file (concat texfilebase e)))
17122 pngfile))))
17124 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17125 "Fill a LaTeX header template TPL.
17126 In the template, the following place holders will be recognized:
17129 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17131 [NO-PACKAGES] do not include PKG
17132 [EXTRA] the string EXTRA
17133 [NO-EXTRA] do not include EXTRA
17135 For backward compatibility, if both the positive and the negative place
17137 assumed to be present at the end of the template.
17138 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17139 EXTRA is a string.
17140 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17141 (let (rpl (end ""))
17143 (setq rpl (if (or (match-end 1) (not def-pkg))
17144 "" (org-latex-packages-to-string def-pkg snippets-p t))
17145 tpl (replace-match rpl t t tpl))
17146 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17149 (setq rpl (if (or (match-end 1) (not pkg))
17150 "" (org-latex-packages-to-string pkg snippets-p t))
17151 tpl (replace-match rpl t t tpl))
17152 (if pkg (setq end
17154 (org-latex-packages-to-string pkg snippets-p)))))
17157 (setq rpl (if (or (match-end 1) (not extra))
17159 tpl (replace-match rpl t t tpl))
17165 tpl)))
17167 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17169 (setq pkg (mapconcat (lambda(p)
17170 (cond
17171 ((stringp p) p)
17172 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17173 (format "%% Package %s omitted" (cadr p)))
17174 ((equal "" (car p))
17176 (t
17178 (car p) (cadr p)))))
17179 pkg
17183 (defun org-dvipng-color (attr)
17184 "Return an rgb color specification for dvipng."
17185 (apply 'format "rgb %s %s %s"
17186 (mapcar 'org-normalize-color
17187 (color-values (face-attribute 'default attr nil)))))
17189 (defun org-normalize-color (value)
17190 "Return string to be used as color value for an RGB component."
17191 (format "%g" (/ value 65535.0)))
17193 ;; Image display
17196 (defvar org-inline-image-overlays nil)
17197 (make-variable-buffer-local 'org-inline-image-overlays)
17199 (defun org-toggle-inline-images (&optional include-linked)
17200 "Toggle the display of inline images.
17201 INCLUDE-LINKED is passed to `org-display-inline-images'."
17202 (interactive "P")
17203 (if org-inline-image-overlays
17204 (progn
17205 (org-remove-inline-images)
17206 (message "Inline image display turned off"))
17207 (org-display-inline-images include-linked)
17208 (if org-inline-image-overlays
17209 (message "%d images displayed inline"
17210 (length org-inline-image-overlays))
17211 (message "No images to display inline"))))
17213 (defun org-display-inline-images (&optional include-linked refresh beg end)
17214 "Display inline images.
17215 Normally only links without a description part are inlined, because this
17216 is how it will work for export. When INCLUDE-LINKED is set, also links
17217 with a description part will be inlined. This can be nice for a quick
17218 look at those images, but it does not reflect what exported files will look
17219 like.
17220 When REFRESH is set, refresh existing images between BEG and END.
17221 This will create new image displays only if necessary.
17222 BEG and END default to the buffer boundaries."
17223 (interactive "P")
17224 (unless refresh
17225 (org-remove-inline-images)
17226 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17227 (save-excursion
17228 (save-restriction
17229 (widen)
17230 (setq beg (or beg (point-min)) end (or end (point-max)))
17231 (goto-char (point-min))
17233 (substring (org-image-file-name-regexp) 0 -2)
17235 old file ov img)
17236 (while (re-search-forward re end t)
17237 (setq old (get-char-property-and-overlay (match-beginning 1)
17238 'org-image-overlay))
17239 (setq file (expand-file-name
17240 (concat (or (match-string 3) "") (match-string 4))))
17241 (when (file-exists-p file)
17242 (if (and (car-safe old) refresh)
17243 (image-refresh (overlay-get (cdr old) 'display))
17244 (setq img (save-match-data (create-image file)))
17245 (when img
17246 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17247 (overlay-put ov 'display img)
17248 (overlay-put ov 'face 'default)
17249 (overlay-put ov 'org-image-overlay t)
17250 (overlay-put ov 'modification-hooks
17251 (list 'org-display-inline-modification-hook))
17252 (push ov org-inline-image-overlays)))))))))
17254 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17255 "Remove inline-display overlay if a corresponding region is modified."
17256 (let ((inhibit-modification-hooks t))
17257 (when (and ov after)
17258 (delete ov org-inline-image-overlays)
17259 (delete-overlay ov))))
17261 (defun org-remove-inline-images ()
17262 "Remove inline display of images."
17263 (interactive)
17264 (mapc 'delete-overlay org-inline-image-overlays)
17265 (setq org-inline-image-overlays nil))
17267 ;;;; Key bindings
17269 ;; Outline functions from `outline-mode-prefix-map'
17270 ;; that can be remapped in Org:
17271 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17272 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17273 (define-key org-mode-map [remap outline-forward-same-level]
17274 'org-forward-same-level)
17275 (define-key org-mode-map [remap outline-backward-same-level]
17276 'org-backward-same-level)
17277 (define-key org-mode-map [remap show-branches]
17278 'org-kill-note-or-show-branches)
17279 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17280 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17281 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17283 ;; Outline functions from `outline-mode-prefix-map'
17284 ;; that can not be remapped in Org:
17285 ;; - the column "key binding" shows whether the Outline function is still
17286 ;; available in Org mode on the same key that it has been bound to in
17287 ;; Outline mode:
17288 ;; - "overridden": key used for a different functionality in Org mode
17289 ;; - else: key still bound to the same Outline function in Org mode
17290 ;; | Outline function | key binding | Org replacement |
17291 ;; |------------------------------------+-------------+-----------------------|
17292 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17293 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17294 ;; | `show-children' | `C-c C-i' | visibility cycling |
17295 ;; | `hide-subtree' | overridden | visibility cycling |
17296 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17297 ;; | `hide-body' | overridden | no replacement |
17298 ;; | `show-all' | overridden | no replacement |
17299 ;; | `hide-entry' | overridden | visibility cycling |
17300 ;; | `show-entry' | overridden | no replacement |
17301 ;; | `hide-leaves' | overridden | no replacement |
17302 ;; | `hide-sublevels' | overridden | no replacement |
17303 ;; | `hide-other' | overridden | no replacement |
17304 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17305 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17307 ;; Make `C-c C-x' a prefix key
17308 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17310 ;; TAB key with modifiers
17311 (org-defkey org-mode-map "\C-i" 'org-cycle)
17312 (org-defkey org-mode-map [(tab)] 'org-cycle)
17313 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17314 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17316 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17317 ;; The following line is necessary under Suse GNU/Linux
17318 (unless (featurep 'xemacs)
17319 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17320 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17321 (define-key org-mode-map [backtab] 'org-shifttab)
17323 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17324 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17325 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17327 ;; Cursor keys with modifiers
17328 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17329 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17330 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17331 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17333 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17334 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17335 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17336 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17338 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17339 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17340 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17341 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17343 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17344 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17345 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17346 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17348 ;; Babel keys
17349 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17350 (mapc (lambda (pair)
17351 (define-key org-babel-map (car pair) (cdr pair)))
17352 org-babel-key-bindings)
17354 ;;; Extra keys for tty access.
17355 ;; We only set them when really needed because otherwise the
17356 ;; menus don't show the simple keys
17358 (when (or org-use-extra-keys
17359 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17360 (not window-system))
17361 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17362 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17363 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17364 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17365 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17366 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17367 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17368 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17369 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17370 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17371 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17372 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17373 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17374 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17375 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17376 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17377 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17378 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17379 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17380 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17381 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17382 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17383 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17384 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17385 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17386 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17387 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17388 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17390 ;; All the other keys
17392 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17393 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17394 (if (boundp 'narrow-map)
17395 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17396 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17397 (if (boundp 'narrow-map)
17398 (org-defkey narrow-map "b" 'org-narrow-to-block)
17399 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17400 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17401 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17402 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17403 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17404 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17405 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17406 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17407 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17408 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17409 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17410 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17411 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17412 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17413 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17414 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17415 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17416 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17418 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17419 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17420 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17421 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17422 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17423 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17424 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17425 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17426 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17427 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17428 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17429 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17430 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17431 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17432 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17433 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17434 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17435 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17436 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17437 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17439 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17440 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17441 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17442 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17443 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17444 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17445 (org-defkey org-mode-map "\C-c^" 'org-sort)
17446 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17447 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17448 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17449 (org-defkey org-mode-map "\C-m" 'org-return)
17450 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17451 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17452 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17453 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17454 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17455 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17456 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17457 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17458 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17459 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17460 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17461 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17462 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17463 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17464 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17465 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17466 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17467 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17468 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17469 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17470 (org-defkey org-mode-map "\C-c\C-@" 'org-mark-list)
17471 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17472 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17474 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17475 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17476 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17477 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17479 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17480 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17481 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17482 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17483 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17484 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17485 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17486 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17487 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17488 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17490 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17491 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17492 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17493 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17494 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17495 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17496 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17498 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17499 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17500 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17501 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17502 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17504 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17506 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17508 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17509 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17511 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17514 (when (featurep 'xemacs)
17515 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17518 (defconst org-speed-commands-default
17519 '(
17520 ("Outline Navigation")
17521 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17522 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17523 ("f" . (org-speed-move-safe 'org-forward-same-level))
17524 ("b" . (org-speed-move-safe 'org-backward-same-level))
17525 ("u" . (org-speed-move-safe 'outline-up-heading))
17526 ("j" . org-goto)
17527 ("g" . (org-refile t))
17528 ("Outline Visibility")
17529 ("c" . org-cycle)
17530 ("C" . org-shifttab)
17531 (" " . org-display-outline-path)
17532 ("Outline Structure Editing")
17533 ("U" . org-shiftmetaup)
17534 ("D" . org-shiftmetadown)
17535 ("r" . org-metaright)
17536 ("l" . org-metaleft)
17537 ("R" . org-shiftmetaright)
17538 ("L" . org-shiftmetaleft)
17539 ("i" . (progn (forward-char 1) (call-interactively
17540 'org-insert-heading-respect-content)))
17541 ("^" . org-sort)
17542 ("w" . org-refile)
17543 ("a" . org-archive-subtree-default-with-confirmation)
17544 ("." . org-mark-subtree)
17545 ("Clock Commands")
17546 ("I" . org-clock-in)
17547 ("O" . org-clock-out)
17548 ("Meta Data Editing")
17549 ("t" . org-todo)
17550 ("0" . (org-priority ?\ ))
17551 ("1" . (org-priority ?A))
17552 ("2" . (org-priority ?B))
17553 ("3" . (org-priority ?C))
17554 (";" . org-set-tags-command)
17555 ("e" . org-set-effort)
17556 ("Agenda Views etc")
17557 ("v" . org-agenda)
17558 ("/" . org-sparse-tree)
17559 ("Misc")
17560 ("o" . org-open-at-point)
17561 ("?" . org-speed-command-help)
17562 ("<" . (org-agenda-set-restriction-lock 'subtree))
17563 (">" . (org-agenda-remove-restriction-lock))
17564 )
17565 "The default speed commands.")
17567 (defun org-print-speed-command (e)
17568 (if (> (length (car e)) 1)
17569 (progn
17571 (princ (car e))
17573 (princ (make-string (length (car e)) ?-))
17575 (princ (car e))
17576 (princ " ")
17577 (if (symbolp (cdr e))
17578 (princ (symbol-name (cdr e)))
17579 (prin1 (cdr e)))
17582 (defun org-speed-command-help ()
17583 "Show the available speed commands."
17584 (interactive)
17585 (if (not org-use-speed-commands)
17586 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17587 (with-output-to-temp-buffer "*Help*"
17589 (mapc 'org-print-speed-command org-speed-commands-user)
17592 (mapc 'org-print-speed-command org-speed-commands-default))
17593 (with-current-buffer "*Help*"
17594 (setq truncate-lines t))))
17596 (defun org-speed-move-safe (cmd)
17597 "Execute CMD, but make sure that the cursor always ends up in a headline.
17598 If not, return to the original position and throw an error."
17599 (interactive)
17600 (let ((pos (point)))
17601 (call-interactively cmd)
17602 (unless (and (bolp) (org-at-heading-p))
17603 (goto-char pos)
17604 (error "Boundary reached while executing %s" cmd))))
17606 (defvar org-self-insert-command-undo-counter 0)
17608 (defvar org-table-auto-blank-field) ; defined in org-table.el
17609 (defvar org-speed-command nil)
17611 (defun org-speed-command-default-hook (keys)
17612 "Hook for activating single-letter speed commands.
17613 `org-speed-commands-default' specifies a minimal command set.
17614 Use `org-speed-commands-user' for further customization."
17615 (when (or (and (bolp) (looking-at org-outline-regexp))
17616 (and (functionp org-use-speed-commands)
17617 (funcall org-use-speed-commands)))
17618 (cdr (assoc keys (append org-speed-commands-user
17619 org-speed-commands-default)))))
17621 (defun org-babel-speed-command-hook (keys)
17622 "Hook for activating single-letter code block commands."
17623 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17624 (cdr (assoc keys org-babel-key-bindings))))
17626 (defcustom org-speed-command-hook
17627 '(org-speed-command-default-hook org-babel-speed-command-hook)
17628 "Hook for activating speed commands at strategic locations.
17629 Hook functions are called in sequence until a valid handler is
17630 found.
17632 Each hook takes a single argument, a user-pressed command key
17633 which is also a `self-insert-command' from the global map.
17635 Within the hook, examine the cursor position and the command key
17636 and return nil or a valid handler as appropriate. Handler could
17637 be one of an interactive command, a function, or a form.
17639 Set `org-use-speed-commands' to non-nil value to enable this
17640 hook. The default setting is `org-speed-command-default-hook'."
17641 :group 'org-structure
17642 :version "24.1"
17643 :type 'hook)
17645 (defun org-self-insert-command (N)
17646 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17647 If the cursor is in a table looking at whitespace, the whitespace is
17648 overwritten, and the table is not marked as requiring realignment."
17649 (interactive "p")
17650 (org-check-before-invisible-edit 'insert)
17651 (cond
17652 ((and org-use-speed-commands
17653 (setq org-speed-command
17654 (run-hook-with-args-until-success
17655 'org-speed-command-hook (this-command-keys))))
17656 (cond
17657 ((commandp org-speed-command)
17658 (setq this-command org-speed-command)
17659 (call-interactively org-speed-command))
17660 ((functionp org-speed-command)
17661 (funcall org-speed-command))
17662 ((and org-speed-command (listp org-speed-command))
17663 (eval org-speed-command))
17664 (t (let (org-use-speed-commands)
17665 (call-interactively 'org-self-insert-command)))))
17666 ((and
17667 (org-table-p)
17668 (progn
17669 ;; check if we blank the field, and if that triggers align
17670 (and (featurep 'org-table) org-table-auto-blank-field
17671 (member last-command
17672 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17674 ;; got extra space, this field does not determine column width
17675 (let (org-table-may-need-update) (org-table-blank-field))
17676 ;; no extra space, this field may determine column width
17677 (org-table-blank-field)))
17678 t)
17679 (eq N 1)
17681 (let (org-table-may-need-update)
17682 (goto-char (1- (match-end 0)))
17683 (delete-char -1)
17684 (goto-char (match-beginning 0))
17685 (self-insert-command N)))
17686 (t
17687 (setq org-table-may-need-update t)
17688 (self-insert-command N)
17689 (org-fix-tags-on-the-fly)
17690 (if org-self-insert-cluster-for-undo
17691 (if (not (eq last-command 'org-self-insert-command))
17692 (setq org-self-insert-command-undo-counter 1)
17693 (if (>= org-self-insert-command-undo-counter 20)
17694 (setq org-self-insert-command-undo-counter 1)
17695 (and (> org-self-insert-command-undo-counter 0)
17696 buffer-undo-list (listp buffer-undo-list)
17697 (not (cadr buffer-undo-list)) ; remove nil entry
17698 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17699 (setq org-self-insert-command-undo-counter
17700 (1+ org-self-insert-command-undo-counter))))))))
17702 (defun org-check-before-invisible-edit (kind)
17703 "Check is editing if kind KIND would be dangerous with invisible text around.
17704 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17705 ;; First, try to get out of here as quickly as possible, to reduce overhead
17706 (if (and org-catch-invisible-edits
17707 (or (not (boundp 'visible-mode)) (not visible-mode))
17708 (or (get-char-property (point) 'invisible)
17709 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17710 ;; OK, we need to take a closer look
17711 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17712 (invisible-before-point (if (bobp) nil (get-char-property
17713 (1- (point)) 'invisible)))
17714 (border-and-ok-direction
17715 (or
17716 ;; Check if we are acting predictably before invisible text
17717 (and invisible-at-point (not invisible-before-point)
17718 (memq kind '(insert delete-backward)))
17719 ;; Check if we are acting predictably after invisible text
17720 ;; This works not well, and I have turned it off. It seems
17721 ;; better to always show and stop after invisible text.
17722 ;; (and (not invisible-at-point) invisible-before-point
17723 ;; (memq kind '(insert delete)))
17724 )))
17726 (when (or (memq invisible-at-point '(outline org-hide-block))
17727 (memq invisible-before-point '(outline org-hide-block)))
17728 (if (eq org-catch-invisible-edits 'error)
17729 (error "Editing in invisible areas is prohibited - make visible first"))
17730 ;; Make the area visible
17731 (save-excursion
17732 (if invisible-before-point
17733 (goto-char (previous-single-char-property-change
17734 (point) 'invisible)))
17735 (org-cycle))
17736 (cond
17737 ((eq org-catch-invisible-edits 'show)
17738 ;; That's it, we do the edit after showing
17739 (message
17740 "Unfolding invisible region around point before editing")
17741 (sit-for 1))
17742 ((and (eq org-catch-invisible-edits 'smart)
17743 border-and-ok-direction)
17744 (message "Unfolding invisible region around point before editing"))
17745 (t
17746 ;; Don't do the edit, make the user repeat it in full visibility
17747 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17749 (defun org-fix-tags-on-the-fly ()
17750 (when (and (equal (char-after (point-at-bol)) ?*)
17751 (org-at-heading-p))
17752 (org-align-tags-here org-tags-column)))
17754 (defun org-delete-backward-char (N)
17755 "Like `delete-backward-char', insert whitespace at field end in tables.
17756 When deleting backwards, in tables this function will insert whitespace in
17758 still be marked for re-alignment if the field did fill the entire column,
17759 because, in this case the deletion might narrow the column."
17760 (interactive "p")
17761 (org-check-before-invisible-edit 'delete-backward)
17762 (if (and (org-table-p)
17763 (eq N 1)
17764 (string-match "|" (buffer-substring (point-at-bol) (point)))
17765 (looking-at ".*?|"))
17766 (let ((pos (point))
17768 (c org-table-may-need-update))
17769 (backward-delete-char N)
17770 (if (not overwrite-mode)
17771 (progn
17772 (skip-chars-forward "^|")
17773 (insert " ")
17774 (goto-char (1- pos))))
17775 ;; noalign: if there were two spaces at the end, this field
17776 ;; does not determine the width of the column.
17777 (if noalign (setq org-table-may-need-update c)))
17778 (backward-delete-char N)
17779 (org-fix-tags-on-the-fly)))
17781 (defun org-delete-char (N)
17782 "Like `delete-char', but insert whitespace at field end in tables.
17783 When deleting characters, in tables this function will insert whitespace in
17785 still be marked for re-alignment if the field did fill the entire column,
17786 because, in this case the deletion might narrow the column."
17787 (interactive "p")
17788 (org-check-before-invisible-edit 'delete)
17789 (if (and (org-table-p)
17790 (not (bolp))
17791 (not (= (char-after) ?|))
17792 (eq N 1))
17793 (if (looking-at ".*?|")
17794 (let ((pos (point))
17796 (c org-table-may-need-update))
17797 (replace-match (concat
17798 (substring (match-string 0) 1 -1)
17799 " |"))
17800 (goto-char pos)
17801 ;; noalign: if there were two spaces at the end, this field
17802 ;; does not determine the width of the column.
17803 (if noalign (setq org-table-may-need-update c)))
17804 (delete-char N))
17805 (delete-char N)
17806 (org-fix-tags-on-the-fly)))
17808 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17809 (put 'org-self-insert-command 'delete-selection t)
17810 (put 'orgtbl-self-insert-command 'delete-selection t)
17811 (put 'org-delete-char 'delete-selection 'supersede)
17812 (put 'org-delete-backward-char 'delete-selection 'supersede)
17813 (put 'org-yank 'delete-selection 'yank)
17815 ;; Make `flyspell-mode' delay after some commands
17816 (put 'org-self-insert-command 'flyspell-delayed t)
17817 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17818 (put 'org-delete-char 'flyspell-delayed t)
17819 (put 'org-delete-backward-char 'flyspell-delayed t)
17821 ;; Make pabbrev-mode expand after org-mode commands
17822 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17823 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17825 ;; How to do this: Measure non-white length of current string
17826 ;; If equal to column width, we should realign.
17828 (defun org-remap (map &rest commands)
17829 "In MAP, remap the functions given in COMMANDS.
17830 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17831 (let (new old)
17832 (while commands
17833 (setq old (pop commands) new (pop commands))
17834 (if (fboundp 'command-remapping)
17835 (org-defkey map (vector 'remap old) new)
17836 (substitute-key-definition old new map global-map)))))
17838 (when (eq org-enable-table-editor 'optimized)
17839 ;; If the user wants maximum table support, we need to hijack
17840 ;; some standard editing functions
17841 (org-remap org-mode-map
17842 'self-insert-command 'org-self-insert-command
17843 'delete-char 'org-delete-char
17844 'delete-backward-char 'org-delete-backward-char)
17845 (org-defkey org-mode-map "|" 'org-force-self-insert))
17847 (defvar org-ctrl-c-ctrl-c-hook nil
17848 "Hook for functions attaching themselves to `C-c C-c'.
17850 This can be used to add additional functionality to the C-c C-c
17851 key which executes context-dependent commands. This hook is run
17852 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17853 run after the last test.
17855 Each function will be called with no arguments. The function
17856 must check if the context is appropriate for it to act. If yes,
17857 it should do its thing and then return a non-nil value. If the
17858 context is wrong, just do nothing and return nil.")
17860 (defvar org-ctrl-c-ctrl-c-final-hook nil
17861 "Hook for functions attaching themselves to `C-c C-c'.
17863 This can be used to add additional functionality to the C-c C-c
17864 key which executes context-dependent commands. This hook is run
17865 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17866 before the first test.
17868 Each function will be called with no arguments. The function
17869 must check if the context is appropriate for it to act. If yes,
17870 it should do its thing and then return a non-nil value. If the
17871 context is wrong, just do nothing and return nil.")
17873 (defvar org-tab-first-hook nil
17874 "Hook for functions to attach themselves to TAB.
17875 See `org-ctrl-c-ctrl-c-hook' for more information.
17876 This hook runs as the first action when TAB is pressed, even before
17877 `org-cycle' messes around with the `outline-regexp' to cater for
17878 inline tasks and plain list item folding.
17879 If any function in this hook returns t, any other actions that
17880 would have been caused by TAB (such as table field motion or visibility
17881 cycling) will not occur.")
17883 (defvar org-tab-after-check-for-table-hook nil
17884 "Hook for functions to attach themselves to TAB.
17885 See `org-ctrl-c-ctrl-c-hook' for more information.
17886 This hook runs after it has been established that the cursor is not in a
17887 table, but before checking if the cursor is in a headline or if global cycling
17888 should be done.
17889 If any function in this hook returns t, not other actions like visibility
17890 cycling will be done.")
17892 (defvar org-tab-after-check-for-cycling-hook nil
17893 "Hook for functions to attach themselves to TAB.
17894 See `org-ctrl-c-ctrl-c-hook' for more information.
17895 This hook runs after it has been established that not table field motion and
17896 not visibility should be done because of current context. This is probably
17897 the place where a package like yasnippets can hook in.")
17899 (defvar org-tab-before-tab-emulation-hook nil
17900 "Hook for functions to attach themselves to TAB.
17901 See `org-ctrl-c-ctrl-c-hook' for more information.
17902 This hook runs after every other options for TAB have been exhausted, but
17905 (defvar org-metaleft-hook nil
17906 "Hook for functions attaching themselves to `M-left'.
17907 See `org-ctrl-c-ctrl-c-hook' for more information.")
17908 (defvar org-metaright-hook nil
17909 "Hook for functions attaching themselves to `M-right'.
17910 See `org-ctrl-c-ctrl-c-hook' for more information.")
17911 (defvar org-metaup-hook nil
17912 "Hook for functions attaching themselves to `M-up'.
17913 See `org-ctrl-c-ctrl-c-hook' for more information.")
17914 (defvar org-metadown-hook nil
17915 "Hook for functions attaching themselves to `M-down'.
17916 See `org-ctrl-c-ctrl-c-hook' for more information.")
17917 (defvar org-shiftmetaleft-hook nil
17918 "Hook for functions attaching themselves to `M-S-left'.
17919 See `org-ctrl-c-ctrl-c-hook' for more information.")
17920 (defvar org-shiftmetaright-hook nil
17921 "Hook for functions attaching themselves to `M-S-right'.
17922 See `org-ctrl-c-ctrl-c-hook' for more information.")
17923 (defvar org-shiftmetaup-hook nil
17924 "Hook for functions attaching themselves to `M-S-up'.
17925 See `org-ctrl-c-ctrl-c-hook' for more information.")
17926 (defvar org-shiftmetadown-hook nil
17927 "Hook for functions attaching themselves to `M-S-down'.
17928 See `org-ctrl-c-ctrl-c-hook' for more information.")
17929 (defvar org-metareturn-hook nil
17930 "Hook for functions attaching themselves to `M-RET'.
17931 See `org-ctrl-c-ctrl-c-hook' for more information.")
17932 (defvar org-shiftup-hook nil
17933 "Hook for functions attaching themselves to `S-up'.
17934 See `org-ctrl-c-ctrl-c-hook' for more information.")
17935 (defvar org-shiftup-final-hook nil
17936 "Hook for functions attaching themselves to `S-up'.
17937 This one runs after all other options except shift-select have been excluded.
17938 See `org-ctrl-c-ctrl-c-hook' for more information.")
17939 (defvar org-shiftdown-hook nil
17940 "Hook for functions attaching themselves to `S-down'.
17941 See `org-ctrl-c-ctrl-c-hook' for more information.")
17942 (defvar org-shiftdown-final-hook nil
17943 "Hook for functions attaching themselves to `S-down'.
17944 This one runs after all other options except shift-select have been excluded.
17945 See `org-ctrl-c-ctrl-c-hook' for more information.")
17946 (defvar org-shiftleft-hook nil
17947 "Hook for functions attaching themselves to `S-left'.
17948 See `org-ctrl-c-ctrl-c-hook' for more information.")
17949 (defvar org-shiftleft-final-hook nil
17950 "Hook for functions attaching themselves to `S-left'.
17951 This one runs after all other options except shift-select have been excluded.
17952 See `org-ctrl-c-ctrl-c-hook' for more information.")
17953 (defvar org-shiftright-hook nil
17954 "Hook for functions attaching themselves to `S-right'.
17955 See `org-ctrl-c-ctrl-c-hook' for more information.")
17956 (defvar org-shiftright-final-hook nil
17957 "Hook for functions attaching themselves to `S-right'.
17958 This one runs after all other options except shift-select have been excluded.
17959 See `org-ctrl-c-ctrl-c-hook' for more information.")
17961 (defun org-modifier-cursor-error ()
17962 "Throw an error, a modified cursor command was applied in wrong context."
17963 (error "This command is active in special context like tables, headlines or items"))
17965 (defun org-shiftselect-error ()
17966 "Throw an error because Shift-Cursor command was applied in wrong context."
17967 (if (and (boundp 'shift-select-mode) shift-select-mode)
17968 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17969 (error "This command works only in special context like headlines or timestamps")))
17971 (defun org-call-for-shift-select (cmd)
17972 (let ((this-command-keys-shift-translated t))
17973 (call-interactively cmd)))
17975 (defun org-shifttab (&optional arg)
17976 "Global visibility cycling or move to previous table field.
17977 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17978 on context.
17979 See the individual commands for more information."
17980 (interactive "P")
17981 (cond
17982 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17983 ((integerp arg)
17984 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17985 (message "Content view to level: %d" arg)
17986 (org-content (prefix-numeric-value arg2))
17987 (setq org-cycle-global-status 'overview)))
17988 (t (call-interactively 'org-global-cycle))))
17990 (defun org-shiftmetaleft ()
17991 "Promote subtree or delete table column.
17992 Calls `org-promote-subtree', `org-outdent-item',
17993 or `org-table-delete-column', depending on context.
17994 See the individual commands for more information."
17995 (interactive)
17996 (cond
17997 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17998 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17999 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18000 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
18001 (t (org-modifier-cursor-error))))
18003 (defun org-shiftmetaright ()
18004 "Demote subtree or insert table column.
18005 Calls `org-demote-subtree', `org-indent-item',
18006 or `org-table-insert-column', depending on context.
18007 See the individual commands for more information."
18008 (interactive)
18009 (cond
18010 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18011 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18012 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18013 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
18014 (t (org-modifier-cursor-error))))
18016 (defun org-shiftmetaup (&optional arg)
18017 "Move subtree up or kill table row.
18018 Calls `org-move-subtree-up' or `org-table-kill-row' or
18019 `org-move-item-up' depending on context. See the individual commands
18020 for more information."
18021 (interactive "P")
18022 (cond
18023 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18024 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18025 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18026 ((org-at-item-p) (call-interactively 'org-move-item-up))
18027 (t (org-modifier-cursor-error))))
18029 (defun org-shiftmetadown (&optional arg)
18030 "Move subtree down or insert table row.
18031 Calls `org-move-subtree-down' or `org-table-insert-row' or
18032 `org-move-item-down', depending on context. See the individual
18033 commands for more information."
18034 (interactive "P")
18035 (cond
18036 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18037 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18038 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18039 ((org-at-item-p) (call-interactively 'org-move-item-down))
18040 (t (org-modifier-cursor-error))))
18042 (defsubst org-hidden-tree-error ()
18043 (error
18044 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18046 (defun org-metaleft (&optional arg)
18047 "Promote heading or move table column to left.
18048 Calls `org-do-promote' or `org-table-move-column', depending on context.
18049 With no specific context, calls the Emacs default `backward-word'.
18050 See the individual commands for more information."
18051 (interactive "P")
18052 (cond
18053 ((run-hook-with-args-until-success 'org-metaleft-hook))
18054 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18055 ((org-with-limited-levels
18056 (or (org-at-heading-p)
18057 (and (org-region-active-p)
18058 (save-excursion
18059 (goto-char (region-beginning))
18060 (org-at-heading-p)))))
18061 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18062 (call-interactively 'org-do-promote))
18063 ;; At an inline task.
18064 ((org-at-heading-p)
18065 (call-interactively 'org-inlinetask-promote))
18066 ((or (org-at-item-p)
18067 (and (org-region-active-p)
18068 (save-excursion
18069 (goto-char (region-beginning))
18070 (org-at-item-p))))
18071 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18072 (call-interactively 'org-outdent-item))
18073 (t (call-interactively 'backward-word))))
18075 (defun org-metaright (&optional arg)
18076 "Demote a subtree, a list item or move table column to right.
18077 In front of a drawer or a block keyword, indent it correctly.
18078 With no specific context, calls the Emacs default `forward-word'.
18079 See the individual commands for more information."
18080 (interactive "P")
18081 (cond
18082 ((run-hook-with-args-until-success 'org-metaright-hook))
18083 ((org-at-table-p) (call-interactively 'org-table-move-column))
18084 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18085 ((org-at-block-p) (call-interactively 'org-indent-block))
18086 ((org-with-limited-levels
18087 (or (org-at-heading-p)
18088 (and (org-region-active-p)
18089 (save-excursion
18090 (goto-char (region-beginning))
18091 (org-at-heading-p)))))
18092 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18093 (call-interactively 'org-do-demote))
18094 ;; At an inline task.
18095 ((org-at-heading-p)
18096 (call-interactively 'org-inlinetask-demote))
18097 ((or (org-at-item-p)
18098 (and (org-region-active-p)
18099 (save-excursion
18100 (goto-char (region-beginning))
18101 (org-at-item-p))))
18102 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18103 (call-interactively 'org-indent-item))
18104 (t (call-interactively 'forward-word))))
18106 (defun org-check-for-hidden (what)
18107 "Check if there are hidden headlines/items in the current visual line.
18108 WHAT can be either `headlines' or `items'. If the current line is
18109 an outline or item heading and it has a folded subtree below it,
18110 this function returns t, nil otherwise."
18111 (let ((re (cond
18112 ((eq what 'headlines) org-outline-regexp-bol)
18113 ((eq what 'items) (org-item-beginning-re))
18114 (t (error "This should not happen"))))
18115 beg end)
18116 (save-excursion
18117 (catch 'exit
18118 (unless (org-region-active-p)
18119 (setq beg (point-at-bol))
18120 (beginning-of-line 2)
18121 (while (and (not (eobp)) ;; this is like `next-line'
18122 (get-char-property (1- (point)) 'invisible))
18123 (beginning-of-line 2))
18124 (setq end (point))
18125 (goto-char beg)
18126 (goto-char (point-at-eol))
18127 (setq end (max end (point)))
18128 (while (re-search-forward re end t)
18129 (if (get-char-property (match-beginning 0) 'invisible)
18130 (throw 'exit t))))
18131 nil))))
18133 (defun org-metaup (&optional arg)
18134 "Move subtree up or move table row up.
18135 Calls `org-move-subtree-up' or `org-table-move-row' or
18136 `org-move-item-up', depending on context. See the individual commands
18137 for more information."
18138 (interactive "P")
18139 (cond
18140 ((run-hook-with-args-until-success 'org-metaup-hook))
18141 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18142 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18143 ((org-at-item-p) (call-interactively 'org-move-item-up))
18144 (t (transpose-lines 1) (beginning-of-line -1))))
18146 (defun org-metadown (&optional arg)
18147 "Move subtree down or move table row down.
18148 Calls `org-move-subtree-down' or `org-table-move-row' or
18149 `org-move-item-down', depending on context. See the individual
18150 commands for more information."
18151 (interactive "P")
18152 (cond
18153 ((run-hook-with-args-until-success 'org-metadown-hook))
18154 ((org-at-table-p) (call-interactively 'org-table-move-row))
18155 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18156 ((org-at-item-p) (call-interactively 'org-move-item-down))
18157 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18159 (defun org-shiftup (&optional arg)
18160 "Increase item in timestamp or increase priority of current headline.
18161 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18162 depending on context. See the individual commands for more information."
18163 (interactive "P")
18164 (cond
18165 ((run-hook-with-args-until-success 'org-shiftup-hook))
18166 ((and org-support-shift-select (org-region-active-p))
18167 (org-call-for-shift-select 'previous-line))
18168 ((org-at-timestamp-p t)
18169 (call-interactively (if org-edit-timestamp-down-means-later
18170 'org-timestamp-down 'org-timestamp-up)))
18171 ((and (not (eq org-support-shift-select 'always))
18172 org-enable-priority-commands
18173 (org-at-heading-p))
18174 (call-interactively 'org-priority-up))
18175 ((and (not org-support-shift-select) (org-at-item-p))
18176 (call-interactively 'org-previous-item))
18177 ((org-clocktable-try-shift 'up arg))
18178 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18179 (org-support-shift-select
18180 (org-call-for-shift-select 'previous-line))
18181 (t (org-shiftselect-error))))
18183 (defun org-shiftdown (&optional arg)
18184 "Decrease item in timestamp or decrease priority of current headline.
18185 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18186 depending on context. See the individual commands for more information."
18187 (interactive "P")
18188 (cond
18189 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18190 ((and org-support-shift-select (org-region-active-p))
18191 (org-call-for-shift-select 'next-line))
18192 ((org-at-timestamp-p t)
18193 (call-interactively (if org-edit-timestamp-down-means-later
18194 'org-timestamp-up 'org-timestamp-down)))
18195 ((and (not (eq org-support-shift-select 'always))
18196 org-enable-priority-commands
18197 (org-at-heading-p))
18198 (call-interactively 'org-priority-down))
18199 ((and (not org-support-shift-select) (org-at-item-p))
18200 (call-interactively 'org-next-item))
18201 ((org-clocktable-try-shift 'down arg))
18202 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18203 (org-support-shift-select
18204 (org-call-for-shift-select 'next-line))
18205 (t (org-shiftselect-error))))
18207 (defun org-shiftright (&optional arg)
18208 "Cycle the thing at point or in the current line, depending on context.
18209 Depending on context, this does one of the following:
18211 - switch a timestamp at point one day into the future
18212 - on a headline, switch to the next TODO keyword.
18213 - on an item, switch entire list to the next bullet type
18214 - on a property line, switch to the next allowed value
18215 - on a clocktable definition line, move time block into the future"
18216 (interactive "P")
18217 (cond
18218 ((run-hook-with-args-until-success 'org-shiftright-hook))
18219 ((and org-support-shift-select (org-region-active-p))
18220 (org-call-for-shift-select 'forward-char))
18221 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18222 ((and (not (eq org-support-shift-select 'always))
18223 (org-at-heading-p))
18224 (let ((org-inhibit-logging
18225 (not org-treat-S-cursor-todo-selection-as-state-change))
18226 (org-inhibit-blocking
18227 (not org-treat-S-cursor-todo-selection-as-state-change)))
18228 (org-call-with-arg 'org-todo 'right)))
18229 ((or (and org-support-shift-select
18230 (not (eq org-support-shift-select 'always))
18231 (org-at-item-bullet-p))
18232 (and (not org-support-shift-select) (org-at-item-p)))
18233 (org-call-with-arg 'org-cycle-list-bullet nil))
18234 ((and (not (eq org-support-shift-select 'always))
18235 (org-at-property-p))
18236 (call-interactively 'org-property-next-allowed-value))
18237 ((org-clocktable-try-shift 'right arg))
18238 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18239 (org-support-shift-select
18240 (org-call-for-shift-select 'forward-char))
18241 (t (org-shiftselect-error))))
18243 (defun org-shiftleft (&optional arg)
18244 "Cycle the thing at point or in the current line, depending on context.
18245 Depending on context, this does one of the following:
18247 - switch a timestamp at point one day into the past
18248 - on a headline, switch to the previous TODO keyword.
18249 - on an item, switch entire list to the previous bullet type
18250 - on a property line, switch to the previous allowed value
18251 - on a clocktable definition line, move time block into the past"
18252 (interactive "P")
18253 (cond
18254 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18255 ((and org-support-shift-select (org-region-active-p))
18256 (org-call-for-shift-select 'backward-char))
18257 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18258 ((and (not (eq org-support-shift-select 'always))
18259 (org-at-heading-p))
18260 (let ((org-inhibit-logging
18261 (not org-treat-S-cursor-todo-selection-as-state-change))
18262 (org-inhibit-blocking
18263 (not org-treat-S-cursor-todo-selection-as-state-change)))
18264 (org-call-with-arg 'org-todo 'left)))
18265 ((or (and org-support-shift-select
18266 (not (eq org-support-shift-select 'always))
18267 (org-at-item-bullet-p))
18268 (and (not org-support-shift-select) (org-at-item-p)))
18269 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18270 ((and (not (eq org-support-shift-select 'always))
18271 (org-at-property-p))
18272 (call-interactively 'org-property-previous-allowed-value))
18273 ((org-clocktable-try-shift 'left arg))
18274 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18275 (org-support-shift-select
18276 (org-call-for-shift-select 'backward-char))
18277 (t (org-shiftselect-error))))
18279 (defun org-shiftcontrolright ()
18280 "Switch to next TODO set."
18281 (interactive)
18282 (cond
18283 ((and org-support-shift-select (org-region-active-p))
18284 (org-call-for-shift-select 'forward-word))
18285 ((and (not (eq org-support-shift-select 'always))
18286 (org-at-heading-p))
18287 (org-call-with-arg 'org-todo 'nextset))
18288 (org-support-shift-select
18289 (org-call-for-shift-select 'forward-word))
18290 (t (org-shiftselect-error))))
18292 (defun org-shiftcontrolleft ()
18293 "Switch to previous TODO set."
18294 (interactive)
18295 (cond
18296 ((and org-support-shift-select (org-region-active-p))
18297 (org-call-for-shift-select 'backward-word))
18298 ((and (not (eq org-support-shift-select 'always))
18299 (org-at-heading-p))
18300 (org-call-with-arg 'org-todo 'previousset))
18301 (org-support-shift-select
18302 (org-call-for-shift-select 'backward-word))
18303 (t (org-shiftselect-error))))
18305 (defun org-shiftcontrolup ()
18306 "Change timestamps synchronously up in CLOCK log lines."
18307 (interactive)
18308 (cond ((and (not org-support-shift-select)
18309 (org-at-clock-log-p)
18310 (org-at-timestamp-p t))
18311 (org-clock-timestamps-up))
18312 (t (org-shiftselect-error))))
18314 (defun org-shiftcontroldown ()
18315 "Change timestamps synchronously down in CLOCK log lines."
18316 (interactive)
18317 (cond ((and (not org-support-shift-select)
18318 (org-at-clock-log-p)
18319 (org-at-timestamp-p t))
18320 (org-clock-timestamps-down))
18321 (t (org-shiftselect-error))))
18323 (defun org-ctrl-c-ret ()
18324 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18325 (interactive)
18326 (cond
18327 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18328 (t (call-interactively 'org-insert-heading))))
18330 (defun org-find-visible ()
18331 (let ((s (point)))
18332 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18333 (get-char-property s 'invisible)))
18334 s))
18335 (defun org-find-invisible ()
18336 (let ((s (point)))
18337 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18338 (not (get-char-property s 'invisible))))
18339 s))
18341 (defun org-copy-visible (beg end)
18342 "Copy the visible parts of the region."
18343 (interactive "r")
18344 (let (snippets s)
18345 (save-excursion
18346 (save-restriction
18347 (narrow-to-region beg end)
18348 (setq s (goto-char (point-min)))
18349 (while (not (= (point) (point-max)))
18350 (goto-char (org-find-invisible))
18351 (push (buffer-substring s (point)) snippets)
18352 (setq s (goto-char (org-find-visible))))))
18353 (kill-new (apply 'concat (nreverse snippets)))))
18355 (defun org-copy-special ()
18356 "Copy region in table or copy current subtree.
18357 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18358 See the individual commands for more information."
18359 (interactive)
18360 (call-interactively
18361 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18363 (defun org-cut-special ()
18364 "Cut region in table or cut current subtree.
18365 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18366 See the individual commands for more information."
18367 (interactive)
18368 (call-interactively
18369 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18371 (defun org-paste-special (arg)
18372 "Paste rectangular region into table, or past subtree relative to level.
18373 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18374 See the individual commands for more information."
18375 (interactive "P")
18376 (if (org-at-table-p)
18377 (org-table-paste-rectangle)
18378 (org-paste-subtree arg)))
18380 (defun org-edit-special (&optional arg)
18381 "Call a special editor for the stuff at point.
18382 When at a table, call the formula editor with `org-table-edit-formulas'.
18383 When at the first line of an src example, call `org-edit-src-code'.
18384 When in an #+include line, visit the include file. Otherwise call
18385 `ffap' to visit the file at point."
18386 (interactive)
18387 ;; possibly prep session before editing source
18388 (when arg
18389 (let* ((info (org-babel-get-src-block-info))
18390 (lang (nth 0 info))
18391 (params (nth 2 info))
18392 (session (cdr (assoc :session params))))
18393 (when (and info session) ;; we are in a source-code block with a session
18394 (funcall
18395 (intern (concat "org-babel-prep-session:" lang)) session params))))
18396 (cond ;; proceed with `org-edit-special'
18397 ((save-excursion
18398 (beginning-of-line 1)
18399 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18400 (find-file (org-trim (match-string 1))))
18401 ((org-edit-src-code))
18402 ((org-edit-fixed-width-region))
18403 ((org-at-table.el-p)
18404 (org-edit-src-code))
18405 ((or (org-at-table-p)
18406 (save-excursion
18407 (beginning-of-line 1)
18409 (call-interactively 'org-table-edit-formulas))
18410 (t (call-interactively 'ffap))))
18412 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18413 (defun org-ctrl-c-ctrl-c (&optional arg)
18414 "Set tags in headline, or update according to changed information at point.
18416 This command does many different things, depending on context:
18418 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18419 this is what we do.
18421 - If the cursor is on a statistics cookie, update it.
18423 - If the cursor is in a headline, prompt for tags and insert them
18424 into the current line, aligned to `org-tags-column'. When called
18425 with prefix arg, realign all tags in the current buffer.
18427 - If the cursor is in one of the special #+KEYWORD lines, this
18428 triggers scanning the buffer for these lines and updating the
18429 information.
18431 - If the cursor is inside a table, realign the table. This command
18432 works even if the automatic table editor has been turned off.
18434 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18435 the entire table.
18437 - If the cursor is at a footnote reference or definition, jump to
18438 the corresponding definition or references, respectively.
18440 - If the cursor is a the beginning of a dynamic block, update it.
18442 - If the current buffer is a capture buffer, close note and file it.
18444 - If the cursor is on a <<<target>>>, update radio targets and
18445 corresponding links in this buffer.
18447 - If the cursor is on a numbered item in a plain list, renumber the
18448 ordered list.
18450 - If the cursor is on a checkbox, toggle it.
18452 - If the cursor is on a code block, evaluate it. The variable
18453 `org-confirm-babel-evaluate' can be used to control prompting
18454 before code block evaluation, by default every code block
18455 evaluation requires confirmation. Code block evaluation can be
18456 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18457 (interactive "P")
18458 (let ((org-enable-table-editor t))
18459 (cond
18460 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18461 org-occur-highlights
18462 org-latex-fragment-image-overlays)
18463 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18464 (org-remove-occur-highlights)
18465 (org-remove-latex-fragment-image-overlays)
18466 (message "Temporary highlights/overlays removed from current buffer"))
18467 ((and (local-variable-p 'org-finish-function (current-buffer))
18468 (fboundp org-finish-function))
18469 (funcall org-finish-function))
18470 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18471 ((org-in-regexp org-ts-regexp-both)
18472 (org-timestamp-change 0 'day))
18473 ((or (looking-at org-property-start-re)
18474 (org-at-property-p))
18475 (call-interactively 'org-property-action))
18476 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18478 (or (org-at-heading-p) (org-at-item-p)))
18479 (call-interactively 'org-update-statistics-cookies))
18480 ((org-at-heading-p) (call-interactively 'org-set-tags))
18481 ((org-at-table.el-p)
18482 (message "Use C-c ' to edit table.el tables"))
18483 ((org-at-table-p)
18484 (org-table-maybe-eval-formula)
18485 (if arg
18486 (call-interactively 'org-table-recalculate)
18487 (org-table-maybe-recalculate-line))
18488 (call-interactively 'org-table-align)
18489 (orgtbl-send-table 'maybe))
18490 ((or (org-footnote-at-reference-p)
18491 (org-footnote-at-definition-p))
18492 (call-interactively 'org-footnote-action))
18493 ((org-at-item-checkbox-p)
18494 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18495 ;; list only if at top item.
18496 (let* ((cbox (match-string 1))
18497 (struct (org-list-struct))
18498 (old-struct (copy-tree struct))
18499 (parents (org-list-parents-alist struct))
18500 (orderedp (org-entry-get nil "ORDERED"))
18501 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18502 block-item)
18503 ;; Use a light version of `org-toggle-checkbox' to avoid
18504 ;; computing list structure twice.
18505 (let ((new-box (cond
18506 ((equal arg '(16)) "[-]")
18507 ((equal arg '(4)) nil)
18508 ((equal "[X]" cbox) "[ ]")
18509 (t "[X]"))))
18510 (if (and firstp arg)
18511 ;; If at first item of sub-list, remove check-box from
18512 ;; every item at the same level.
18513 (mapc
18514 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18515 (org-list-get-all-items
18516 (point-at-bol) struct (org-list-prevs-alist struct)))
18517 (org-list-set-checkbox (point-at-bol) struct new-box)))
18518 ;; Replicate `org-list-write-struct', while grabbing a return
18519 ;; value from `org-list-struct-fix-box'.
18520 (org-list-struct-fix-ind struct parents 2)
18521 (org-list-struct-fix-item-end struct)
18522 (let ((prevs (org-list-prevs-alist struct)))
18523 (org-list-struct-fix-bul struct prevs)
18524 (org-list-struct-fix-ind struct parents)
18525 (setq block-item
18526 (org-list-struct-fix-box struct parents prevs orderedp)))
18527 (org-list-struct-apply-struct struct old-struct)
18528 (org-update-checkbox-count-maybe)
18529 (when block-item
18530 (message
18531 "Checkboxes were removed due to unchecked box at line %d"
18532 (org-current-line block-item)))
18533 (when firstp (org-list-send-list 'maybe))))
18534 ((org-at-item-p)
18535 ;; Cursor at an item: repair list. Do checkbox related actions
18536 ;; only if function was called with an argument. Send list only
18537 ;; if at top item.
18538 (let* ((struct (org-list-struct))
18539 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18540 old-struct)
18541 (when arg
18542 (setq old-struct (copy-tree struct))
18543 (if firstp
18544 ;; If at first item of sub-list, add check-box to every
18545 ;; item at the same level.
18546 (mapc
18547 (lambda (pos)
18548 (unless (org-list-get-checkbox pos struct)
18549 (org-list-set-checkbox pos struct "[ ]")))
18550 (org-list-get-all-items
18551 (point-at-bol) struct (org-list-prevs-alist struct)))
18552 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18553 (org-list-write-struct
18554 struct (org-list-parents-alist struct) old-struct)
18555 (when arg (org-update-checkbox-count-maybe))
18556 (when firstp (org-list-send-list 'maybe))))
18557 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18558 ;; Dynamic block
18559 (beginning-of-line 1)
18560 (save-excursion (org-update-dblock)))
18561 ((save-excursion
18562 (beginning-of-line 1)
18564 (cond
18565 ((equal (match-string 1) "TBLFM")
18566 ;; Recalculate the table before this line
18567 (save-excursion
18568 (beginning-of-line 1)
18570 (if (org-at-table-p)
18571 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18572 (t
18573 (let ((org-inhibit-startup-visibility-stuff t)
18574 (org-startup-align-all-tables nil))
18575 (when (boundp 'org-table-coordinate-overlays)
18576 (mapc 'delete-overlay org-table-coordinate-overlays)
18577 (setq org-table-coordinate-overlays nil))
18578 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18579 (message "Local setup has been refreshed"))))
18580 ((org-clock-update-time-maybe))
18581 (t
18582 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18583 (error "C-c C-c can do nothing useful at this location"))))))
18585 (defun org-mode-restart ()
18586 "Restart Org-mode, to scan again for special lines.
18587 Also updates the keyword regular expressions."
18588 (interactive)
18589 (org-mode)
18590 (message "Org-mode restarted"))
18592 (defun org-kill-note-or-show-branches ()
18593 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18594 (interactive)
18595 (if (not org-finish-function)
18596 (progn
18597 (hide-subtree)
18598 (call-interactively 'show-branches))
18599 (let ((org-note-abort t))
18600 (funcall org-finish-function))))
18602 (defun org-return (&optional indent)
18603 "Goto next table row or insert a newline.
18604 Calls `org-table-next-row' or `newline', depending on context.
18605 See the individual commands for more information."
18606 (interactive)
18607 (cond
18608 ((or (bobp) (org-in-src-block-p))
18609 (if indent (newline-and-indent) (newline)))
18610 ((org-at-table-p)
18611 (org-table-justify-field-maybe)
18612 (call-interactively 'org-table-next-row))
18613 ;; when `newline-and-indent' is called within a list, make sure
18614 ;; text moved stays inside the item.
18615 ((and (org-in-item-p) indent)
18616 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18617 (progn
18618 (save-match-data (newline))
18619 (org-indent-line-to (length (match-string 0))))
18620 (let ((ind (org-get-indentation)))
18621 (newline)
18622 (if (org-looking-back org-list-end-re)
18623 (org-indent-line-function)
18624 (org-indent-line-to ind)))))
18625 ((and org-return-follows-link
18626 (let ((tprop (get-text-property (point) 'face)))
18627 (or (eq tprop 'org-link)
18628 (and (listp tprop) (memq 'org-link tprop)))))
18629 (call-interactively 'org-open-at-point))
18630 ((and (org-at-heading-p)
18631 (looking-at
18633 (org-show-entry)
18634 (end-of-line 1)
18635 (newline))
18636 (t (if indent (newline-and-indent) (newline)))))
18638 (defun org-return-indent ()
18639 "Goto next table row or insert a newline and indent.
18640 Calls `org-table-next-row' or `newline-and-indent', depending on
18641 context. See the individual commands for more information."
18642 (interactive)
18643 (org-return t))
18645 (defun org-ctrl-c-star ()
18646 "Compute table, or change heading status of lines.
18647 Calls `org-table-recalculate' or `org-toggle-heading',
18648 depending on context."
18649 (interactive)
18650 (cond
18651 ((org-at-table-p)
18652 (call-interactively 'org-table-recalculate))
18653 (t
18654 ;; Convert all lines in region to list items
18655 (call-interactively 'org-toggle-heading))))
18657 (defun org-ctrl-c-minus ()
18658 "Insert separator line in table or modify bullet status of line.
18659 Also turns a plain line or a region of lines into list items.
18660 Calls `org-table-insert-hline', `org-toggle-item', or
18661 `org-cycle-list-bullet', depending on context."
18662 (interactive)
18663 (cond
18664 ((org-at-table-p)
18665 (call-interactively 'org-table-insert-hline))
18666 ((org-region-active-p)
18667 (call-interactively 'org-toggle-item))
18668 ((org-in-item-p)
18669 (call-interactively 'org-cycle-list-bullet))
18670 (t
18671 (call-interactively 'org-toggle-item))))
18673 (defun org-toggle-item (arg)
18674 "Convert headings or normal lines to items, items to normal lines.
18675 If there is no active region, only the current line is considered.
18677 If the first non blank line in the region is an headline, convert
18678 all headlines to items, shifting text accordingly.
18680 If it is an item, convert all items to normal lines.
18682 If it is normal text, change region into an item. With a prefix
18683 argument ARG, change each line in region into an item."
18684 (interactive "P")
18685 (let ((shift-text
18686 (function
18687 ;; Shift text in current section to IND, from point to END.
18688 ;; The function leaves point to END line.
18689 (lambda (ind end)
18690 (let ((min-i 1000) (end (copy-marker end)))
18691 ;; First determine the minimum indentation (MIN-I) of
18692 ;; the text.
18693 (save-excursion
18694 (catch 'exit
18695 (while (< (point) end)
18696 (let ((i (org-get-indentation)))
18697 (cond
18698 ;; Skip blank lines and inline tasks.
18700 ((looking-at org-outline-regexp-bol))
18701 ;; We can't find less than 0 indentation.
18702 ((zerop i) (throw 'exit (setq min-i 0)))
18703 ((< i min-i) (setq min-i i))))
18704 (forward-line))))
18705 ;; Then indent each line so that a line indented to
18706 ;; MIN-I becomes indented to IND. Ignore blank lines
18707 ;; and inline tasks in the process.
18708 (let ((delta (- ind min-i)))
18709 (while (< (point) end)
18711 (looking-at org-outline-regexp-bol))
18712 (org-indent-line-to (+ (org-get-indentation) delta)))
18713 (forward-line)))))))
18714 (skip-blanks
18715 (function
18716 ;; Return beginning of first non-blank line, starting from
18717 ;; line at POS.
18718 (lambda (pos)
18719 (save-excursion
18720 (goto-char pos)
18722 (point-at-bol)))))
18723 beg end)
18724 ;; Determine boundaries of changes.
18725 (if (org-region-active-p)
18726 (setq beg (funcall skip-blanks (region-beginning))
18727 end (copy-marker (region-end)))
18728 (setq beg (funcall skip-blanks (point-at-bol))
18729 end (copy-marker (point-at-eol))))
18730 ;; Depending on the starting line, choose an action on the text
18731 ;; between BEG and END.
18732 (org-with-limited-levels
18733 (save-excursion
18734 (goto-char beg)
18735 (cond
18736 ;; Case 1. Start at an item: de-itemize. Note that it only
18737 ;; happens when a region is active: `org-ctrl-c-minus'
18738 ;; would call `org-cycle-list-bullet' otherwise.
18739 ((org-at-item-p)
18740 (while (< (point) end)
18741 (when (org-at-item-p)
18743 (delete-region (point) (match-end 0)))
18744 (forward-line)))
18745 ;; Case 2. Start at an heading: convert to items.
18746 ((org-at-heading-p)
18747 (let* ((bul (org-list-bullet-string "-"))
18748 (bul-len (length bul))
18749 ;; Indentation of the first heading. It should be
18750 ;; relative to the indentation of its parent, if any.
18751 (start-ind (save-excursion
18752 (cond
18753 ((not org-adapt-indentation) 0)
18754 ((not (outline-previous-heading)) 0)
18755 (t (length (match-string 0))))))
18756 ;; Level of first heading. Further headings will be
18757 ;; compared to it to determine hierarchy in the list.
18758 (ref-level (org-reduced-level (org-outline-level))))
18759 (while (< (point) end)
18760 (let* ((level (org-reduced-level (org-outline-level)))
18761 (delta (max 0 (- level ref-level))))
18762 ;; If current headline is less indented than the first
18763 ;; one, set it as reference, in order to preserve
18764 ;; subtrees.
18765 (when (< level ref-level) (setq ref-level level))
18766 (replace-match bul t t)
18767 (org-indent-line-to (+ start-ind (* delta bul-len)))
18768 ;; Ensure all text down to END (or SECTION-END) belongs
18769 ;; to the newly created item.
18770 (let ((section-end (save-excursion
18771 (or (outline-next-heading) (point)))))
18772 (forward-line)
18773 (funcall shift-text
18774 (+ start-ind (* (1+ delta) bul-len))
18775 (min end section-end)))))))
18776 ;; Case 3. Normal line with ARG: turn each non-item line into
18777 ;; an item.
18778 (arg
18779 (while (< (point) end)
18780 (unless (or (org-at-heading-p) (org-at-item-p))
18782 (replace-match
18784 (forward-line)))
18785 ;; Case 4. Normal line without ARG: make the first line of
18786 ;; region an item, and shift indentation of others
18787 ;; lines to set them as item's body.
18788 (t (let* ((bul (org-list-bullet-string "-"))
18789 (bul-len (length bul))
18790 (ref-ind (org-get-indentation)))
18792 (insert bul)
18793 (forward-line)
18794 (while (< (point) end)
18795 ;; Ensure that lines less indented than first one
18796 ;; still get included in item body.
18797 (funcall shift-text
18798 (+ ref-ind bul-len)
18799 (min end (save-excursion (or (outline-next-heading)
18800 (point)))))
18801 (forward-line)))))))))
18803 (defun org-toggle-heading (&optional nstars)
18804 "Convert headings to normal text, or items or text to headings.
18805 If there is no active region, only the current line is considered.
18807 If the first non blank line is an headline, remove the stars from
18808 all headlines in the region.
18810 If it is a plain list item, turn all plain list items into headings.
18812 If it is a normal line, turn each and every normal line (i.e. not
18813 an heading or an item) in the region into a heading.
18815 When converting a line into a heading, the number of stars is chosen
18816 such that the lines become children of the current entry. However,
18817 when a prefix argument is given, its value determines the number of
18818 stars to add."
18819 (interactive "P")
18820 (let ((skip-blanks
18821 (function
18822 ;; Return beginning of first non-blank line, starting from
18823 ;; line at POS.
18824 (lambda (pos)
18825 (save-excursion
18826 (goto-char pos)
18828 (point-at-bol)))))
18829 beg end)
18830 ;; Determine boundaries of changes. If region ends at a bol, do
18831 ;; not consider the last line to be in the region.
18832 (if (org-region-active-p)
18833 (setq beg (funcall skip-blanks (region-beginning))
18834 end (copy-marker (save-excursion
18835 (goto-char (region-end))
18836 (if (bolp) (point) (point-at-eol)))))
18837 (setq beg (funcall skip-blanks (point-at-bol))
18838 end (copy-marker (point-at-eol))))
18839 ;; Ensure inline tasks don't count as headings.
18840 (org-with-limited-levels
18841 (save-excursion
18842 (goto-char beg)
18843 (cond
18844 ;; Case 1. Started at an heading: de-star headings.
18845 ((org-at-heading-p)
18846 (while (< (point) end)
18847 (when (org-at-heading-p t)
18848 (looking-at org-outline-regexp) (replace-match ""))
18849 (forward-line)))
18850 ;; Case 2. Started at an item: change items into headlines.
18851 ;; One star will be added by `org-list-to-subtree'.
18852 ((org-at-item-p)
18853 (let* ((stars (make-string
18854 (if nstars
18855 ;; subtract the star that will be added again by
18856 ;; `org-list-to-subtree'
18857 (1- (prefix-numeric-value current-prefix-arg))
18858 (or (org-current-level) 0))
18859 ?*))
18860 (add-stars
18861 (cond (nstars "") ; stars from prefix only
18862 ((equal stars "") "") ; before first heading
18863 (org-odd-levels-only "*") ; inside heading, odd
18864 (t "")))) ; inside heading, oddeven
18865 (while (< (point) end)
18866 (when (org-at-item-p)
18867 ;; Pay attention to cases when region ends before list.
18868 (let* ((struct (org-list-struct))
18869 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18870 (save-restriction
18871 (narrow-to-region (point) list-end)
18872 (insert
18873 (org-list-to-subtree
18874 (org-list-parse-list t)
18875 '(:istart (concat stars add-stars (funcall get-stars depth))
18876 :icount (concat stars add-stars (funcall get-stars depth))))))))
18877 (forward-line))))
18878 ;; Case 3. Started at normal text: make every line an heading,
18879 ;; skipping headlines and items.
18880 (t (let* ((stars (make-string
18881 (if nstars
18882 (prefix-numeric-value current-prefix-arg)
18883 (or (org-current-level) 0))
18884 ?*))
18885 (add-stars
18886 (cond (nstars "") ; stars from prefix only
18887 ((equal stars "") "*") ; before first heading
18888 (org-odd-levels-only "**") ; inside heading, odd
18889 (t "*"))) ; inside heading, oddeven
18890 (rpl (concat stars add-stars " ")))
18891 (while (< (point) end)
18892 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18894 (replace-match (concat rpl (match-string 2))))
18895 (forward-line)))))))))
18897 (defun org-meta-return (&optional arg)
18898 "Insert a new heading or wrap a region in a table.
18899 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18900 See the individual commands for more information."
18901 (interactive "P")
18902 (cond
18903 ((run-hook-with-args-until-success 'org-metareturn-hook))
18904 ((or (org-at-drawer-p) (org-at-property-p))
18905 (newline-and-indent))
18906 ((org-at-table-p)
18907 (call-interactively 'org-table-wrap-region))
18908 (t (call-interactively 'org-insert-heading))))
18910 ;;; Menu entries
18912 ;; Define the Org-mode menus
18913 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18914 '("Tbl"
18915 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18916 ["Next Field" org-cycle (org-at-table-p)]
18917 ["Previous Field" org-shifttab (org-at-table-p)]
18918 ["Next Row" org-return (org-at-table-p)]
18919 "--"
18920 ["Blank Field" org-table-blank-field (org-at-table-p)]
18921 ["Edit Field" org-table-edit-field (org-at-table-p)]
18922 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18923 "--"
18924 ("Column"
18925 ["Move Column Left" org-metaleft (org-at-table-p)]
18926 ["Move Column Right" org-metaright (org-at-table-p)]
18927 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18928 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18929 ("Row"
18930 ["Move Row Up" org-metaup (org-at-table-p)]
18931 ["Move Row Down" org-metadown (org-at-table-p)]
18932 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18933 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18934 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18935 "--"
18936 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18937 ("Rectangle"
18938 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18939 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18940 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18941 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18942 "--"
18943 ("Calculate"
18944 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18945 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18946 ["Edit Formulas" org-edit-special (org-at-table-p)]
18947 "--"
18948 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18949 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18950 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18951 "--"
18952 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18953 "--"
18954 ["Sum Column/Rectangle" org-table-sum
18955 (or (org-at-table-p) (org-region-active-p))]
18956 ["Which Column?" org-table-current-column (org-at-table-p)])
18957 ["Debug Formulas"
18958 org-table-toggle-formula-debugger
18959 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18960 ["Show Col/Row Numbers"
18961 org-table-toggle-coordinate-overlays
18962 :style toggle
18963 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18964 "--"
18965 ["Create" org-table-create (and (not (org-at-table-p))
18966 org-enable-table-editor)]
18967 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18968 ["Import from File" org-table-import (not (org-at-table-p))]
18969 ["Export to File" org-table-export (org-at-table-p)]
18970 "--"
18971 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18973 (easy-menu-define org-org-menu org-mode-map "Org menu"
18974 '("Org"
18975 ("Show/Hide"
18976 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18977 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18978 ["Sparse Tree..." org-sparse-tree t]
18979 ["Reveal Context" org-reveal t]
18980 ["Show All" show-all t]
18981 "--"
18982 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18983 "--"
18984 ["New Heading" org-insert-heading t]
18985 ("Navigate Headings"
18986 ["Up" outline-up-heading t]
18987 ["Next" outline-next-visible-heading t]
18988 ["Previous" outline-previous-visible-heading t]
18989 ["Next Same Level" outline-forward-same-level t]
18990 ["Previous Same Level" outline-backward-same-level t]
18991 "--"
18992 ["Jump" org-goto t])
18993 ("Edit Structure"
18994 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18995 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18996 "--"
18997 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18998 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18999 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19000 "--"
19001 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19002 "--"
19003 ["Copy visible text" org-copy-visible t]
19004 "--"
19005 ["Promote Heading" org-metaleft (not (org-at-table-p))]
19006 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
19007 ["Demote Heading" org-metaright (not (org-at-table-p))]
19008 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
19009 "--"
19010 ["Sort Region/Children" org-sort (not (org-at-table-p))]
19011 "--"
19012 ["Convert to odd levels" org-convert-to-odd-levels t]
19013 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19014 ("Editing"
19015 ["Emphasis..." org-emphasize t]
19016 ["Edit Source Example" org-edit-special t]
19017 "--"
19018 ["Footnote new/jump" org-footnote-action t]
19019 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19020 ("Archive"
19021 ["Archive (default method)" org-archive-subtree-default t]
19022 "--"
19023 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
19024 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
19025 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
19026 )
19027 "--"
19028 ("Hyperlinks"
19029 ["Store Link (Global)" org-store-link t]
19030 ["Find existing link to here" org-occur-link-in-agenda-files t]
19031 ["Insert Link" org-insert-link t]
19032 ["Follow Link" org-open-at-point t]
19033 "--"
19034 ["Next link" org-next-link t]
19035 ["Previous link" org-previous-link t]
19036 "--"
19037 ["Descriptive Links"
19038 org-toggle-link-display
19039 :style radio
19040 :selected org-descriptive-links
19041 ]
19042 ["Literal Links"
19043 org-toggle-link-display
19044 :style radio
19045 :selected (not org-descriptive-links)])
19046 "--"
19047 ("TODO Lists"
19048 ["TODO/DONE/-" org-todo t]
19049 ("Select keyword"
19050 ["Next keyword" org-shiftright (org-at-heading-p)]
19051 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19052 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19053 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19054 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19055 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19056 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19057 "--"
19058 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19059 :selected org-enforce-todo-dependencies :style toggle :active t]
19060 "Settings for tree at point"
19061 ["Do Children sequentially" org-toggle-ordered-property :style radio
19062 :selected (org-entry-get nil "ORDERED")
19063 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19064 ["Do Children parallel" org-toggle-ordered-property :style radio
19065 :selected (not (org-entry-get nil "ORDERED"))
19066 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19067 "--"
19068 ["Set Priority" org-priority t]
19069 ["Priority Up" org-shiftup t]
19070 ["Priority Down" org-shiftdown t]
19071 "--"
19072 ["Get news from all feeds" org-feed-update-all t]
19073 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19074 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19075 ("TAGS and Properties"
19076 ["Set Tags" org-set-tags-command t]
19077 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19078 "--"
19079 ["Set property" org-set-property t]
19080 ["Column view of properties" org-columns t]
19081 ["Insert Column View DBlock" org-insert-columns-dblock t])
19082 ("Dates and Scheduling"
19083 ["Timestamp" org-time-stamp t]
19084 ["Timestamp (inactive)" org-time-stamp-inactive t]
19085 ("Change Date"
19086 ["1 Day Later" org-shiftright t]
19087 ["1 Day Earlier" org-shiftleft t]
19088 ["1 ... Later" org-shiftup t]
19089 ["1 ... Earlier" org-shiftdown t])
19090 ["Compute Time Range" org-evaluate-time-range t]
19091 ["Schedule Item" org-schedule t]
19092 ["Deadline" org-deadline t]
19093 "--"
19094 ["Custom time format" org-toggle-time-stamp-overlays
19095 :style radio :selected org-display-custom-times]
19096 "--"
19097 ["Goto Calendar" org-goto-calendar t]
19098 ["Date from Calendar" org-date-from-calendar t]
19099 "--"
19100 ["Start/Restart Timer" org-timer-start t]
19101 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19102 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19103 ["Insert Timer String" org-timer t]
19104 ["Insert Timer Item" org-timer-item t])
19105 ("Logging work"
19106 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19107 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19108 ["Clock out" org-clock-out t]
19109 ["Clock cancel" org-clock-cancel t]
19110 "--"
19111 ["Mark as default task" org-clock-mark-default-task t]
19112 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19113 ["Goto running clock" org-clock-goto t]
19114 "--"
19115 ["Display times" org-clock-display t]
19116 ["Create clock table" org-clock-report t]
19117 "--"
19118 ["Record DONE time"
19119 (progn (setq org-log-done (not org-log-done))
19120 (message "Switching to %s will %s record a timestamp"
19121 (car org-done-keywords)
19122 (if org-log-done "automatically" "not")))
19123 :style toggle :selected org-log-done])
19124 "--"
19125 ["Agenda Command..." org-agenda t]
19126 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19127 ("File List for Agenda")
19128 ("Special views current file"
19129 ["TODO Tree" org-show-todo-tree t]
19130 ["Check Deadlines" org-check-deadlines t]
19131 ["Timeline" org-timeline t]
19132 ["Tags/Property tree" org-match-sparse-tree t])
19133 "--"
19134 ["Export/Publish..." org-export t]
19135 ("LaTeX"
19136 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19137 :selected org-cdlatex-mode]
19138 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19139 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19140 ["Modify math symbol" org-cdlatex-math-modify
19141 (org-inside-LaTeX-fragment-p)]
19142 ["Insert citation" org-reftex-citation t]
19143 "--"
19144 ["Template for BEAMER" org-insert-beamer-options-template t])
19145 "--"
19146 ("MobileOrg"
19147 ["Push Files and Views" org-mobile-push t]
19148 ["Get Captured and Flagged" org-mobile-pull t]
19149 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19150 "--"
19151 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19152 "--"
19153 ("Documentation"
19154 ["Show Version" org-version t]
19155 ["Info Documentation" org-info t])
19156 ("Customize"
19157 ["Browse Org Group" org-customize t]
19158 "--"
19159 ["Expand This Menu" org-create-customize-menu
19160 (fboundp 'customize-menu-create)])
19161 ["Send bug report" org-submit-bug-report t]
19162 "--"
19163 ("Refresh/Reload"
19164 ["Refresh setup current buffer" org-mode-restart t]
19165 ["Reload Org (after update)" org-reload t]
19166 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19167 ))
19169 (defun org-info (&optional node)
19170 "Read documentation for Org-mode in the info system.
19171 With optional NODE, go directly to that node."
19172 (interactive)
19173 (info (format "(org)%s" (or node ""))))
19175 ;;;###autoload
19176 (defun org-submit-bug-report ()
19177 "Submit a bug report on Org-mode via mail.
19179 Don't hesitate to report any problems or inaccurate documentation.
19181 If you don't have setup sending mail from (X)Emacs, please copy the
19182 output buffer into your mail program, as it gives us important
19183 information about your Org-mode version and configuration."
19184 (interactive)
19185 (require 'reporter)
19186 (org-load-modules-maybe)
19187 (org-require-autoloaded-modules)
19188 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19189 (reporter-submit-bug-report
19190 "emacs-orgmode@gnu.org"
19191 (org-version)
19192 (let (list)
19193 (save-window-excursion
19194 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19195 (delete-other-windows)
19196 (erase-buffer)
19197 (insert "You are about to submit a bug report to the Org-mode mailing list.
19199 We would like to add your full Org-mode and Outline configuration to the
19200 bug report. This greatly simplifies the work of the maintainer and
19201 other experts on the mailing list.
19203 HOWEVER, some variables you have customized may contain private
19204 information. The names of customers, colleagues, or friends, might
19205 appear in the form of file names, tags, todo states, or search strings.
19206 If you answer yes to the prompt, you might want to check and remove
19207 such private information before sending the email.")
19208 (add-text-properties (point-min) (point-max) '(face org-warning))
19209 (when (yes-or-no-p "Include your Org-mode configuration ")
19210 (mapatoms
19211 (lambda (v)
19212 (and (boundp v)
19214 (or (and (symbol-value v)
19216 (and
19217 (get v 'custom-type) (get v 'standard-value)
19218 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19219 (push v list)))))
19220 (kill-buffer (get-buffer "*Warn about privacy*"))
19221 list))
19222 nil nil
19223 "Remember to cover the basics, that is, what you expected to happen and
19224 what in fact did happen. You don't know how to make a good report? See
19226 http://orgmode.org/manual/Feedback.html#Feedback
19228 Your bug report will be posted to the Org-mode mailing list.
19229 ------------------------------------------------------------------------")
19230 (save-excursion
19235 (defun org-install-agenda-files-menu ()
19236 (let ((bl (buffer-list)))
19237 (save-excursion
19238 (while bl
19239 (set-buffer (pop bl))
19240 (if (eq major-mode 'org-mode) (setq bl nil)))
19241 (when (eq major-mode 'org-mode)
19242 (easy-menu-change
19243 '("Org") "File List for Agenda"
19244 (append
19245 (list
19246 ["Edit File List" (org-edit-agenda-file-list) t]
19247 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19248 ["Remove Current File from List" org-remove-file t]
19249 ["Cycle through agenda files" org-cycle-agenda-files t]
19250 ["Occur in all agenda files" org-occur-in-agenda-files t]
19251 "--")
19252 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19254 ;;;; Documentation
19256 ;;;###autoload
19257 (defun org-require-autoloaded-modules ()
19258 (interactive)
19259 (mapc 'require
19260 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19261 org-docbook org-exp org-html org-icalendar
19262 org-id org-latex
19263 org-publish org-remember org-table
19264 org-timer org-xoxo)))
19266 ;;;###autoload
19267 (defun org-reload (&optional uncompiled)
19268 "Reload all org lisp files.
19269 With prefix arg UNCOMPILED, load the uncompiled versions."
19270 (interactive "P")
19271 (require 'find-func)
19273 (dir-org (file-name-directory (org-find-library-name "org")))
19274 (dir-org-contrib (ignore-errors
19275 (file-name-directory
19276 (org-find-library-name "org-contribdir"))))
19277 (babel-files
19278 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19279 (append (list nil "comint" "eval" "exp" "keys"
19280 "lob" "ref" "table" "tangle")
19281 (delq nil
19282 (mapcar
19283 (lambda (lang)
19284 (when (cdr lang) (symbol-name (car lang))))
19285 org-babel-load-languages)))))
19286 (files
19287 (append (directory-files dir-org t file-re)
19288 babel-files
19289 (and dir-org-contrib
19290 (directory-files dir-org-contrib t file-re))))
19291 (remove-re (concat (if (featurep 'xemacs)
19292 "org-colview" "org-colview-xemacs")
19294 (setq files (mapcar 'file-name-sans-extension files))
19295 (setq files (mapcar
19296 (lambda (x) (if (string-match remove-re x) nil x))
19297 files))
19298 (setq files (delq nil files))
19299 (mapc
19300 (lambda (f)
19301 (when (featurep (intern (file-name-nondirectory f)))
19302 (if (and (not uncompiled)
19303 (file-exists-p (concat f ".elc")))
19304 (load (concat f ".elc") nil nil t)
19305 (load (concat f ".el") nil nil t))))
19306 files))
19307 (org-version))
19309 ;;;###autoload
19310 (defun org-customize ()
19311 "Call the customize function with org as argument."
19312 (interactive)
19313 (org-load-modules-maybe)
19314 (org-require-autoloaded-modules)
19315 (customize-browse 'org))
19317 (defun org-create-customize-menu ()
19318 "Create a full customization menu for Org-mode, insert it into the menu."
19319 (interactive)
19320 (org-load-modules-maybe)
19321 (org-require-autoloaded-modules)
19322 (if (fboundp 'customize-menu-create)
19323 (progn
19324 (easy-menu-change
19325 '("Org") "Customize"
19326 `(["Browse Org group" org-customize t]
19327 "--"
19328 ,(customize-menu-create 'org)
19329 ["Set" Custom-set t]
19330 ["Save" Custom-save t]
19331 ["Reset to Current" Custom-reset-current t]
19332 ["Reset to Saved" Custom-reset-saved t]
19333 ["Reset to Standard Settings" Custom-reset-standard t]))
19335 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19337 ;;;; Miscellaneous stuff
19339 ;;; Generally useful functions
19341 (defun org-get-at-bol (property)
19342 "Get text property PROPERTY at beginning of line."
19343 (get-text-property (point-at-bol) property))
19345 (defun org-find-text-property-in-string (prop s)
19346 "Return the first non-nil value of property PROP in string S."
19347 (or (get-text-property 0 prop s)
19348 (get-text-property (or (next-single-property-change 0 prop s) 0)
19349 prop s)))
19351 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19352 "Display the given MESSAGE as a warning."
19353 (if (fboundp 'display-warning)
19354 (display-warning 'org message
19355 (if (featurep 'xemacs) 'warning :warning))
19356 (let ((buf (get-buffer-create "*Org warnings*")))
19357 (with-current-buffer buf
19358 (goto-char (point-max))
19359 (insert "Warning (Org): " message)
19360 (unless (bolp)
19361 (newline)))
19362 (display-buffer buf)
19363 (sit-for 0))))
19365 (defun org-eval (form)
19366 "Eval FORM and return result."
19367 (condition-case error
19368 (eval form)
19369 (error (format "%%![Error: %s]" error))))
19371 (defun org-in-clocktable-p ()
19372 "Check if the cursor is in a clocktable."
19373 (let ((pos (point)) start)
19374 (save-excursion
19375 (end-of-line 1)
19377 (setq start (match-beginning 0))
19379 (>= (match-end 0) pos)
19380 start))))
19382 (defun org-in-commented-line ()
19383 "Is point in a line starting with `#'?"
19384 (equal (char-after (point-at-bol)) ?#))
19386 (defun org-in-indented-comment-line ()
19387 "Is point in a line starting with `#' after some white space?"
19388 (save-excursion
19389 (save-match-data
19390 (goto-char (point-at-bol))
19393 (defun org-in-verbatim-emphasis ()
19394 (save-match-data
19395 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19397 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19398 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19399 (if (and marker (marker-buffer marker)
19400 (buffer-live-p (marker-buffer marker)))
19401 (progn
19402 (org-pop-to-buffer-same-window (marker-buffer marker))
19403 (if (or (> marker (point-max)) (< marker (point-min)))
19404 (widen))
19405 (goto-char marker)
19406 (org-show-context 'org-goto))
19407 (if bookmark
19408 (bookmark-jump bookmark)
19409 (error "Cannot find location"))))
19411 (defun org-quote-csv-field (s)
19412 "Quote field for inclusion in CSV material."
19415 s))
19417 (defun org-force-self-insert (N)
19418 "Needed to enforce self-insert under remapping."
19419 (interactive "p")
19420 (self-insert-command N))
19422 (defun org-string-width (s)
19423 "Compute width of string, ignoring invisible characters.
19424 This ignores character with invisibility property `org-link', and also
19425 characters with property `org-cwidth', because these will become invisible
19426 upon the next fontification round."
19427 (let (b l)
19428 (when (or (eq t buffer-invisibility-spec)
19429 (assq 'org-link buffer-invisibility-spec))
19430 (while (setq b (text-property-any 0 (length s)
19431 'invisible 'org-link s))
19432 (setq s (concat (substring s 0 b)
19433 (substring s (or (next-single-property-change
19434 b 'invisible s) (length s)))))))
19435 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19436 (setq s (concat (substring s 0 b)
19437 (substring s (or (next-single-property-change
19438 b 'org-cwidth s) (length s))))))
19439 (setq l (string-width s) b -1)
19440 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19441 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19442 l))
19444 (defun org-shorten-string (s maxlength)
19445 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19446 If the string is shorter or has length MAXLENGTH, just return the
19447 original string. If it is longer, the functions finds a space in the
19448 string, breaks this string off at that locations and adds three dots
19449 as ellipsis. Including the ellipsis, the string will not be longer
19450 than MAXLENGTH. If finding a good breaking point in the string does
19451 not work, the string is just chopped off in the middle of a word
19452 if necessary."
19453 (if (<= (length s) maxlength)
19454 s
19455 (let* ((n (max (- maxlength 4) 1))
19457 (if (string-match re s)
19458 (concat (match-string 1 s) "...")
19459 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19461 (defun org-get-indentation (&optional line)
19462 "Get the indentation of the current line, interpreting tabs.
19463 When LINE is given, assume it represents a line and compute its indentation."
19464 (if line
19465 (if (string-match "^ *" (org-remove-tabs line))
19466 (match-end 0))
19467 (save-excursion
19468 (beginning-of-line 1)
19470 (current-column))))
19472 (defun org-get-string-indentation (s)
19473 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19474 (let ((n -1) (i 0) (w tab-width) c)
19475 (catch 'exit
19476 (while (< (setq n (1+ n)) (length s))
19477 (setq c (aref s n))
19478 (cond ((= c ?\ ) (setq i (1+ i)))
19480 (t (throw 'exit t)))))
19481 i))
19483 (defun org-remove-tabs (s &optional width)
19484 "Replace tabulators in S with spaces.
19485 Assumes that s is a single line, starting in column 0."
19486 (setq width (or width tab-width))
19488 (setq s (replace-match
19489 (make-string
19490 (- (* width (/ (+ (match-beginning 0) width) width))
19491 (match-beginning 0)) ?\ )
19492 t t s)))
19493 s)
19495 (defun org-fix-indentation (line ind)
19496 "Fix indentation in LINE.
19497 IND is a cons cell with target and minimum indentation.
19498 If the current indentation in LINE is smaller than the minimum,
19499 leave it alone. If it is larger than ind, set it to the target."
19500 (let* ((l (org-remove-tabs line))
19501 (i (org-get-indentation l))
19502 (i1 (car ind)) (i2 (cdr ind)))
19503 (if (>= i i2) (setq l (substring line i2)))
19504 (if (> i1 0)
19505 (concat (make-string i1 ?\ ) l)
19506 l)))
19508 (defun org-remove-indentation (code &optional n)
19509 "Remove the maximum common indentation from the lines in CODE.
19510 N may optionally be the number of spaces to remove."
19511 (with-temp-buffer
19512 (insert code)
19513 (org-do-remove-indentation n)
19514 (buffer-string)))
19516 (defun org-do-remove-indentation (&optional n)
19517 "Remove the maximum common indentation from the buffer."
19518 (untabify (point-min) (point-max))
19519 (let ((min 10000) re)
19520 (if n
19521 (setq min n)
19522 (goto-char (point-min))
19524 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19525 (unless (or (= min 0) (= min 10000))
19527 (goto-char (point-min))
19528 (while (re-search-forward re nil t)
19529 (replace-match "")
19530 (end-of-line 1))
19531 min)))
19533 (defun org-fill-template (template alist)
19534 "Find each %key of ALIST in TEMPLATE and replace it."
19535 (let ((case-fold-search nil)
19536 entry key value)
19537 (setq alist (sort (copy-sequence alist)
19538 (lambda (a b) (< (length (car a)) (length (car b))))))
19539 (while (setq entry (pop alist))
19540 (setq template
19541 (replace-regexp-in-string
19542 (concat "%" (regexp-quote (car entry)))
19543 (cdr entry) template t t)))
19544 template))
19546 (defun org-base-buffer (buffer)
19547 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19548 (if (not buffer)
19549 buffer
19550 (or (buffer-base-buffer buffer)
19551 buffer)))
19553 (defun org-trim (s)
19554 "Remove whitespace at beginning and end of string."
19557 s)
19559 (defun org-wrap (string &optional width lines)
19560 "Wrap string to either a number of lines, or a width in characters.
19561 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19562 that costs. If there is a word longer than WIDTH, the text is actually
19563 wrapped to the length of that word.
19564 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19565 many lines, whatever width that takes.
19566 The return value is a list of lines, without newlines at the end."
19568 (maxword (apply 'max (mapcar 'org-string-width words)))
19569 w ll)
19570 (cond (width
19571 (org-do-wrap words (max maxword width)))
19572 (lines
19573 (setq w maxword)
19574 (setq ll (org-do-wrap words maxword))
19575 (if (<= (length ll) lines)
19576 ll
19577 (setq ll words)
19578 (while (> (length ll) lines)
19579 (setq w (1+ w))
19580 (setq ll (org-do-wrap words w)))
19581 ll))
19582 (t (error "Cannot wrap this")))))
19584 (defun org-do-wrap (words width)
19585 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19586 (let (lines line)
19587 (while words
19588 (setq line (pop words))
19589 (while (and words (< (+ (length line) (length (car words))) width))
19590 (setq line (concat line " " (pop words))))
19591 (setq lines (push line lines)))
19592 (nreverse lines)))
19594 (defun org-split-string (string &optional separators)
19595 "Splits STRING into substrings at SEPARATORS.
19596 No empty strings are returned if there are matches at the beginning
19597 and end of string."
19599 (start 0)
19600 notfirst
19601 (list nil))
19602 (while (and (string-match rexp string
19603 (if (and notfirst
19604 (= start (match-beginning 0))
19605 (< start (length string)))
19606 (1+ start) start))
19607 (< (match-beginning 0) (length string)))
19608 (setq notfirst t)
19609 (or (eq (match-beginning 0) 0)
19610 (and (eq (match-beginning 0) (match-end 0))
19611 (eq (match-beginning 0) start))
19612 (setq list
19613 (cons (substring string start (match-beginning 0))
19614 list)))
19615 (setq start (match-end 0)))
19616 (or (eq start (length string))
19617 (setq list
19618 (cons (substring string start)
19619 list)))
19620 (nreverse list)))
19622 (defun org-quote-vert (s)
19624 (while (string-match "|" s)
19626 s)
19628 (defun org-uuidgen-p (s)
19629 "Is S an ID created by UUIDGEN?"
19630 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19632 (defun org-in-src-block-p nil
19633 "Whether point is in a code source block."
19634 (let (ov)
19635 (when (setq ov (overlays-at (point)))
19636 (memq 'org-block-background
19637 (overlay-properties
19638 (car ov))))))
19640 (defun org-context ()
19641 "Return a list of contexts of the current cursor position.
19642 If several contexts apply, all are returned.
19643 Each context entry is a list with a symbol naming the context, and
19644 two positions indicating start and end of the context. Possible
19645 contexts are:
19647 :headline anywhere in a headline
19648 :headline-stars on the leading stars in a headline
19649 :todo-keyword on a TODO keyword (including DONE) in a headline
19650 :tags on the TAGS in a headline
19651 :priority on the priority cookie in a headline
19652 :item on the first line of a plain list item
19653 :item-bullet on the bullet/number of a plain list item
19654 :checkbox on the checkbox in a plain list item
19655 :table in an org-mode table
19656 :table-special on a special filed in a table
19657 :table-table in a table.el table
19658 :clocktable in a clocktable
19659 :src-block in a source block
19660 :link on a hyperlink
19661 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
19662 :target on a <<target>>
19663 :radio-target on a <<<radio-target>>>
19664 :latex-fragment on a LaTeX fragment
19665 :latex-preview on a LaTeX fragment with overlaid preview image
19667 This function expects the position to be visible because it uses font-lock
19668 faces as a help to recognize the following contexts: :table-special, :link,
19669 and :keyword."
19670 (let* ((f (get-text-property (point) 'face))
19671 (faces (if (listp f) f (list f)))
19672 (case-fold-search t)
19673 (p (point)) clist o)
19674 ;; First the large context
19675 (cond
19676 ((org-at-heading-p t)
19677 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19678 (when (progn
19679 (beginning-of-line 1)
19680 (looking-at org-todo-line-tags-regexp))
19681 (push (org-point-in-group p 1 :headline-stars) clist)
19682 (push (org-point-in-group p 2 :todo-keyword) clist)
19683 (push (org-point-in-group p 4 :tags) clist))
19684 (goto-char p)
19687 (push (org-point-in-group p 0 :priority) clist)))
19689 ((org-at-item-p)
19690 (push (org-point-in-group p 2 :item-bullet) clist)
19691 (push (list :item (point-at-bol)
19692 (save-excursion (org-end-of-item) (point)))
19693 clist)
19694 (and (org-at-item-checkbox-p)
19695 (push (org-point-in-group p 0 :checkbox) clist)))
19697 ((org-at-table-p)
19698 (push (list :table (org-table-begin) (org-table-end)) clist)
19699 (if (memq 'org-formula faces)
19700 (push (list :table-special
19701 (previous-single-property-change p 'face)
19702 (next-single-property-change p 'face)) clist)))
19703 ((org-at-table-p 'any)
19704 (push (list :table-table) clist)))
19705 (goto-char p)
19707 ;; New the "medium" contexts: clocktables, source blocks
19708 (cond ((org-in-clocktable-p)
19709 (push (list :clocktable
19711 (search-backward "#+BEGIN: clocktable" nil t))
19712 (match-beginning 0))
19714 (match-end 0))) clist))
19715 ((org-in-src-block-p)
19716 (push (list :src-block
19718 (search-backward "#+BEGIN_SRC" nil t))
19719 (match-beginning 0))
19720 (and (search-forward "#+END_SRC" nil t)
19721 (match-beginning 0))) clist)))
19722 (goto-char p)
19724 ;; Now the small context
19725 (cond
19726 ((org-at-timestamp-p)
19727 (push (org-point-in-group p 0 :timestamp) clist))
19728 ((memq 'org-link faces)
19729 (push (list :link
19730 (previous-single-property-change p 'face)
19731 (next-single-property-change p 'face)) clist))
19732 ((memq 'org-special-keyword faces)
19733 (push (list :keyword
19734 (previous-single-property-change p 'face)
19735 (next-single-property-change p 'face)) clist))
19736 ((org-at-target-p)
19737 (push (org-point-in-group p 0 :target) clist)
19738 (goto-char (1- (match-beginning 0)))
19739 (if (looking-at org-radio-target-regexp)
19740 (push (org-point-in-group p 0 :radio-target) clist))
19741 (goto-char p))
19742 ((setq o (car (delq nil
19743 (mapcar
19744 (lambda (x)
19745 (if (memq x org-latex-fragment-image-overlays) x))
19746 (overlays-at (point))))))
19747 (push (list :latex-fragment
19748 (overlay-start o) (overlay-end o)) clist)
19749 (push (list :latex-preview
19750 (overlay-start o) (overlay-end o)) clist))
19751 ((org-inside-LaTeX-fragment-p)
19752 ;; FIXME: positions wrong.
19753 (push (list :latex-fragment (point) (point)) clist)))
19755 (setq clist (nreverse (delq nil clist)))
19756 clist))
19758 ;; FIXME: Compare with at-regexp-p Do we need both?
19759 (defun org-in-regexp (re &optional nlines visually)
19760 "Check if point is inside a match of regexp.
19761 Normally only the current line is checked, but you can include NLINES extra
19762 lines both before and after point into the search.
19763 If VISUALLY is set, require that the cursor is not after the match but
19764 really on, so that the block visually is on the match."
19765 (catch 'exit
19766 (let ((pos (point))
19767 (eol (point-at-eol (+ 1 (or nlines 0))))
19768 (inc (if visually 1 0)))
19769 (save-excursion
19770 (beginning-of-line (- 1 (or nlines 0)))
19771 (while (re-search-forward re eol t)
19772 (if (and (<= (match-beginning 0) pos)
19773 (>= (+ inc (match-end 0)) pos))
19774 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19776 (defun org-at-regexp-p (regexp)
19777 "Is point inside a match of REGEXP in the current line?"
19778 (catch 'exit
19779 (save-excursion
19780 (let ((pos (point)) (end (point-at-eol)))
19781 (beginning-of-line 1)
19782 (while (re-search-forward regexp end t)
19783 (if (and (<= (match-beginning 0) pos)
19784 (>= (match-end 0) pos))
19785 (throw 'exit t)))
19786 nil))))
19788 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19789 "Non-nil when point is between matches of START-RE and END-RE.
19791 Also return a non-nil value when point is on one of the matches.
19793 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19794 buffer positions. Default values are the positions of headlines
19795 surrounding the point.
19797 The functions returns a cons cell whose car (resp. cdr) is the
19798 position before START-RE (resp. after END-RE)."
19799 (save-match-data
19800 (let ((pos (point))
19801 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19802 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19803 beg end)
19804 (save-excursion
19805 ;; Point is on a block when on START-RE or if START-RE can be
19806 ;; found before it...
19807 (and (or (org-at-regexp-p start-re)
19808 (re-search-backward start-re limit-up t))
19809 (setq beg (match-beginning 0))
19810 ;; ... and END-RE after it...
19811 (goto-char (match-end 0))
19812 (re-search-forward end-re limit-down t)
19813 (> (setq end (match-end 0)) pos)
19814 ;; ... without another START-RE in-between.
19815 (goto-char (match-beginning 0))
19816 (not (re-search-backward start-re (1+ beg) t))
19817 ;; Return value.
19818 (cons beg end))))))
19820 (defun org-in-block-p (names)
19821 "Non-nil when point belongs to a block whose name belongs to NAMES.
19823 NAMES is a list of strings containing names of blocks.
19825 Return first block name matched, or nil. Beware that in case of
19826 nested blocks, the returned name may not belong to the closest
19827 block from point."
19828 (save-match-data
19829 (catch 'exit
19830 (let ((case-fold-search t)
19831 (lim-up (save-excursion (outline-previous-heading)))
19832 (lim-down (save-excursion (outline-next-heading))))
19833 (mapc (lambda (name)
19834 (let ((n (regexp-quote name)))
19835 (when (org-between-regexps-p
19838 lim-up lim-down)
19839 (throw 'exit n))))
19840 names))
19841 nil)))
19843 (defun org-occur-in-agenda-files (regexp &optional nlines)
19844 "Call `multi-occur' with buffers for all agenda files."
19846 (let* ((files (org-agenda-files))
19847 (tnames (mapcar 'file-truename files))
19848 (extra org-agenda-text-search-extra-files)
19849 f)
19850 (when (eq (car extra) 'agenda-archives)
19851 (setq extra (cdr extra))
19852 (setq files (org-add-archive-files files)))
19853 (while (setq f (pop extra))
19854 (unless (member (file-truename f) tnames)
19855 (add-to-list 'files f 'append)
19856 (add-to-list 'tnames (file-truename f) 'append)))
19857 (multi-occur
19858 (mapcar (lambda (x)
19859 (with-current-buffer
19860 (or (get-file-buffer x) (find-file-noselect x))
19861 (widen)
19862 (current-buffer)))
19863 files)
19864 regexp)))
19866 (if (boundp 'occur-mode-find-occurrence-hook)
19867 ;; Emacs 23
19868 (add-hook 'occur-mode-find-occurrence-hook
19869 (lambda ()
19870 (when (eq major-mode 'org-mode)
19871 (org-reveal))))
19872 ;; Emacs 22
19873 (defadvice occur-mode-goto-occurrence
19874 (after org-occur-reveal activate)
19875 (and (eq major-mode 'org-mode) (org-reveal)))
19876 (defadvice occur-mode-goto-occurrence-other-window
19877 (after org-occur-reveal activate)
19878 (and (eq major-mode 'org-mode) (org-reveal)))
19879 (defadvice occur-mode-display-occurrence
19880 (after org-occur-reveal activate)
19881 (when (eq major-mode 'org-mode)
19882 (let ((pos (occur-mode-find-occurrence)))
19883 (with-current-buffer (marker-buffer pos)
19884 (save-excursion
19885 (goto-char pos)
19886 (org-reveal)))))))
19888 (defun org-occur-link-in-agenda-files ()
19889 "Create a link and search for it in the agendas.
19890 The link is not stored in `org-stored-links', it is just created
19891 for the search purpose."
19892 (interactive)
19893 (let ((link (condition-case nil
19894 (org-store-link nil)
19895 (error "Unable to create a link to here"))))
19896 (org-occur-in-agenda-files (regexp-quote link))))
19898 (defun org-uniquify (list)
19899 "Remove duplicate elements from LIST."
19900 (let (res)
19901 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19902 res))
19904 (defun org-delete-all (elts list)
19905 "Remove all elements in ELTS from LIST."
19906 (while elts
19907 (setq list (delete (pop elts) list)))
19908 list)
19910 (defun org-count (cl-item cl-seq)
19911 "Count the number of occurrences of ITEM in SEQ.
19912 Taken from `count' in cl-seq.el with all keyword arguments removed."
19913 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19914 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19915 (while (< cl-start cl-end)
19916 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19917 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19918 (setq cl-start (1+ cl-start)))
19919 cl-count))
19921 (defun org-remove-if (predicate seq)
19922 "Remove everything from SEQ that fulfills PREDICATE."
19923 (let (res e)
19924 (while seq
19925 (setq e (pop seq))
19926 (if (not (funcall predicate e)) (push e res)))
19927 (nreverse res)))
19929 (defun org-remove-if-not (predicate seq)
19930 "Remove everything from SEQ that does not fulfill PREDICATE."
19931 (let (res e)
19932 (while seq
19933 (setq e (pop seq))
19934 (if (funcall predicate e) (push e res)))
19935 (nreverse res)))
19937 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19938 "Reduce two-argument FUNCTION across SEQ.
19939 Taken from `reduce' in cl-seq.el with all keyword arguments but
19941 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19942 (cadr (memq :initial-value cl-keys)))
19943 (cl-seq (pop cl-seq))
19944 (t (funcall cl-func)))))
19945 (while cl-seq
19946 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19947 cl-accum))
19949 (defun org-back-over-empty-lines ()
19950 "Move backwards over whitespace, to the beginning of the first empty line.
19951 Returns the number of empty lines passed."
19952 (let ((pos (point)))
19953 (if (cdr (assoc 'heading org-blank-before-new-entry))
19955 (unless (eobp)
19956 (forward-line -1)))
19957 (beginning-of-line 2)
19958 (goto-char (min (point) pos))
19959 (count-lines (point) pos)))
19961 (defun org-skip-whitespace ()
19964 (defun org-point-in-group (point group &optional context)
19965 "Check if POINT is in match-group GROUP.
19966 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19967 match. If the match group does not exist or point is not inside it,
19968 return nil."
19969 (and (match-beginning group)
19970 (>= point (match-beginning group))
19971 (<= point (match-end group))
19972 (if context
19973 (list context (match-beginning group) (match-end group))
19974 t)))
19976 (defun org-switch-to-buffer-other-window (&rest args)
19977 "Switch to buffer in a second window on the current frame.
19978 In particular, do not allow pop-up frames.
19979 Returns the newly created buffer."
19980 (let (pop-up-frames special-display-buffer-names special-display-regexps
19981 special-display-function)
19982 (apply 'switch-to-buffer-other-window args)))
19984 (defun org-combine-plists (&rest plists)
19985 "Create a single property list from all plists in PLISTS.
19986 The process starts by copying the first list, and then setting properties
19987 from the other lists. Settings in the last list are the most significant
19988 ones and overrule settings in the other lists."
19989 (let ((rtn (copy-sequence (pop plists)))
19990 p v ls)
19991 (while plists
19992 (setq ls (pop plists))
19993 (while ls
19994 (setq p (pop ls) v (pop ls))
19995 (setq rtn (plist-put rtn p v))))
19996 rtn))
19998 (defun org-move-line-down (arg)
19999 "Move the current line down. With prefix argument, move it past ARG lines."
20000 (interactive "p")
20001 (let ((col (current-column))
20002 beg end pos)
20003 (beginning-of-line 1) (setq beg (point))
20004 (beginning-of-line 2) (setq end (point))
20005 (beginning-of-line (+ 1 arg))
20006 (setq pos (move-marker (make-marker) (point)))
20007 (insert (delete-and-extract-region beg end))
20008 (goto-char pos)
20009 (org-move-to-column col)))
20011 (defun org-move-line-up (arg)
20012 "Move the current line up. With prefix argument, move it past ARG lines."
20013 (interactive "p")
20014 (let ((col (current-column))
20015 beg end pos)
20016 (beginning-of-line 1) (setq beg (point))
20017 (beginning-of-line 2) (setq end (point))
20018 (beginning-of-line (- arg))
20019 (setq pos (move-marker (make-marker) (point)))
20020 (insert (delete-and-extract-region beg end))
20021 (goto-char pos)
20022 (org-move-to-column col)))
20024 (defun org-replace-escapes (string table)
20025 "Replace %-escapes in STRING with values in TABLE.
20027 The sequences in STRING may contain normal field width and padding information,
20029 so values can contain further %-escapes if they are define later in TABLE."
20030 (let ((tbl (copy-alist table))
20031 (case-fold-search nil)
20032 (pchg 0)
20033 e re rpl)
20034 (while (setq e (pop tbl))
20035 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20036 (when (and (cdr e) (string-match re (cdr e)))
20037 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20038 (safe "SREF"))
20039 (add-text-properties 0 3 (list 'sref sref) safe)
20040 (setcdr e (replace-match safe t t (cdr e)))))
20041 (while (string-match re string)
20042 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20043 (cdr e)))
20044 (setq string (replace-match rpl t t string))))
20045 (while (setq pchg (next-property-change pchg string))
20046 (let ((sref (get-text-property pchg 'sref string)))
20047 (when (and sref (string-match "SREF" string pchg))
20048 (setq string (replace-match sref t t string)))))
20049 string))
20051 (defun org-sublist (list start end)
20052 "Return a section of LIST, from START to END.
20053 Counting starts at 1."
20054 (let (rtn (c start))
20055 (setq list (nthcdr (1- start) list))
20056 (while (and list (<= c end))
20057 (push (pop list) rtn)
20058 (setq c (1+ c)))
20059 (nreverse rtn)))
20061 (defun org-find-base-buffer-visiting (file)
20062 "Like `find-buffer-visiting' but always return the base buffer and
20063 not an indirect buffer."
20064 (let ((buf (or (get-file-buffer file)
20065 (find-buffer-visiting file))))
20066 (if buf
20067 (or (buffer-base-buffer buf) buf)
20068 nil)))
20070 (defun org-image-file-name-regexp (&optional extensions)
20071 "Return regexp matching the file names of images.
20072 If EXTENSIONS is given, only match these."
20073 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20074 (image-file-name-regexp)
20075 (let ((image-file-name-extensions
20076 (or extensions
20077 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20078 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20080 (regexp-opt (nconc (mapcar 'upcase
20081 image-file-name-extensions)
20082 image-file-name-extensions)
20083 t)
20086 (defun org-file-image-p (file &optional extensions)
20087 "Return non-nil if FILE is an image."
20088 (save-match-data
20089 (string-match (org-image-file-name-regexp extensions) file)))
20091 (defun org-get-cursor-date ()
20092 "Return the date at cursor in as a time.
20093 This works in the calendar and in the agenda, anywhere else it just
20094 returns the current time."
20095 (let (date day defd)
20096 (cond
20097 ((eq major-mode 'calendar-mode)
20098 (setq date (calendar-cursor-to-date)
20099 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20100 ((eq major-mode 'org-agenda-mode)
20101 (setq day (get-text-property (point) 'day))
20102 (if day
20103 (setq date (calendar-gregorian-from-absolute day)
20104 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20105 (nth 2 date))))))
20106 (or defd (current-time))))
20108 (defvar org-agenda-action-marker (make-marker)
20109 "Marker pointing to the entry for the next agenda action.")
20111 (defun org-mark-entry-for-agenda-action ()
20112 "Mark the current entry as target of an agenda action.
20113 Agenda actions are actions executed from the agenda with the key `k',
20114 which make use of the date at the cursor."
20115 (interactive)
20116 (move-marker org-agenda-action-marker
20117 (save-excursion (org-back-to-heading t) (point))
20118 (current-buffer))
20119 (message
20120 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20122 (defun org-mark-subtree ()
20123 "Mark the current subtree.
20124 This puts point at the start of the current subtree, and mark at the end.
20126 If point is in an inline task, mark that task instead."
20127 (interactive)
20128 (let ((inline-task-p
20129 (and (featurep 'org-inlinetask)
20130 (org-inlinetask-in-task-p)))
20131 (beg))
20132 ;; Get beginning of subtree
20133 (cond
20134 (inline-task-p (org-inlinetask-goto-beginning))
20135 ((org-at-heading-p) (beginning-of-line))
20136 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20137 (setq beg (point))
20138 ;; Get end of it
20139 (if inline-task-p
20140 (org-inlinetask-goto-end)
20141 (org-end-of-subtree))
20142 ;; Mark zone
20143 (push-mark (point) nil t)
20144 (goto-char beg)))
20146 ;;; Paragraph filling stuff.
20147 ;; We want this to be just right, so use the full arsenal.
20149 (defun org-indent-line-function ()
20150 "Indent line depending on context."
20151 (interactive)
20152 (let* ((pos (point))
20153 (itemp (org-at-item-p))
20154 (case-fold-search t)
20156 (inline-task-p (and (featurep 'org-inlinetask)
20157 (org-inlinetask-in-task-p)))
20158 (inline-re (and inline-task-p
20159 (org-inlinetask-outline-regexp)))
20160 column)
20161 (beginning-of-line 1)
20162 (cond
20163 ;; Comments
20164 ((looking-at "# ") (setq column 0))
20165 ;; Headings
20166 ((looking-at org-outline-regexp) (setq column 0))
20167 ;; Included files
20169 ;; Footnote definition
20170 ((looking-at org-footnote-definition-re) (setq column 0))
20171 ;; Literal examples
20173 (setq column (org-get-indentation))) ; do nothing
20174 ;; Lists
20175 ((ignore-errors (goto-char (org-in-item-p)))
20176 (setq column (if itemp
20177 (org-get-indentation)
20178 (org-list-item-body-column (point))))
20179 (goto-char pos))
20180 ;; Drawers
20182 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20183 (save-excursion
20184 (goto-char (1- (match-beginning 1)))
20185 (setq column (current-column))))
20186 ;; Special blocks
20188 (save-excursion
20189 (re-search-backward
20191 (setq column (org-get-indentation (match-string 0))))
20194 (save-excursion
20196 (setq column
20197 (cond ((equal (downcase (match-string 1)) "src")
20198 ;; src blocks: let `org-edit-src-exit' handle them
20199 (org-get-indentation))
20200 ((equal (downcase (match-string 1)) "example")
20201 (max (org-get-indentation)
20202 (org-get-indentation (match-string 0))))
20203 (t
20204 (org-get-indentation (match-string 0))))))
20205 ;; This line has nothing special, look at the previous relevant
20206 ;; line to compute indentation
20207 (t
20208 (beginning-of-line 0)
20209 (while (and (not (bobp))
20210 (not (looking-at org-drawer-regexp))
20211 ;; When point started in an inline task, do not move
20212 ;; above task starting line.
20213 (not (and inline-task-p (looking-at inline-re)))
20214 ;; Skip drawers, blocks, empty lines, verbatim,
20215 ;; comments, tables, footnotes definitions, lists,
20216 ;; inline tasks.
20218 (re-search-backward org-drawer-regexp nil t))
20222 (looking-at org-footnote-definition-re)
20223 (and (ignore-errors (goto-char (org-in-item-p)))
20224 (goto-char
20225 (org-list-get-top-point (org-list-struct))))
20226 (and (not inline-task-p)
20227 (featurep 'org-inlinetask)
20228 (org-inlinetask-in-task-p)
20229 (or (org-inlinetask-goto-beginning) t))))
20230 (beginning-of-line 0))
20231 (cond
20232 ;; There was an heading above.
20234 (if (not org-adapt-indentation)
20235 (setq column 0)
20236 (goto-char (match-end 0))
20237 (setq column (current-column))))
20238 ;; A drawer had started and is unfinished
20239 ((looking-at org-drawer-regexp)
20240 (goto-char (1- (match-beginning 1)))
20241 (setq column (current-column)))
20242 ;; Else, nothing noticeable found: get indentation and go on.
20243 (t (setq column (org-get-indentation))))))
20244 ;; Now apply indentation and move cursor accordingly
20245 (goto-char pos)
20246 (if (<= (current-column) (current-indentation))
20247 (org-indent-line-to column)
20248 (save-excursion (org-indent-line-to column)))
20249 ;; Special polishing for properties, see `org-property-format'
20250 (setq column (current-column))
20251 (beginning-of-line 1)
20252 (if (looking-at
20254 (replace-match (concat (match-string 1)
20255 (format org-property-format
20256 (match-string 2) (match-string 3)))
20257 t t))
20258 (org-move-to-column column)))
20260 (defun org-indent-drawer ()
20261 "Indent the drawer at point."
20262 (interactive)
20263 (let ((p (point))
20264 (e (and (save-excursion (re-search-forward ":END:" nil t))
20265 (match-end 0)))
20266 (folded
20267 (save-excursion
20268 (end-of-line)
20269 (when (overlays-at (point))
20270 (member 'invisible (overlay-properties
20271 (car (overlays-at (point)))))))))
20272 (when folded (org-cycle))
20273 (indent-for-tab-command)
20274 (while (and (move-beginning-of-line 2) (< (point) e))
20275 (indent-for-tab-command))
20276 (goto-char p)
20277 (when folded (org-cycle)))
20278 (message "Drawer at point indented"))
20280 (defun org-indent-block ()
20281 "Indent the block at point."
20282 (interactive)
20283 (let ((p (point))
20284 (case-fold-search t)
20286 (match-end 0)))
20287 (folded
20288 (save-excursion
20289 (end-of-line)
20290 (when (overlays-at (point))
20291 (member 'invisible (overlay-properties
20292 (car (overlays-at (point)))))))))
20293 (when folded (org-cycle))
20294 (indent-for-tab-command)
20295 (while (and (move-beginning-of-line 2) (< (point) e))
20296 (indent-for-tab-command))
20297 (goto-char p)
20298 (when folded (org-cycle)))
20299 (message "Block at point indented"))
20301 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20302 "Variable to store copy of `adaptive-fill-regexp'.
20303 Since `adaptive-fill-regexp' is set to never match, we need to
20304 store a backup of its value before entering `org-mode' so that
20305 the functionality can be provided as a fall-back.")
20307 (defun org-set-autofill-regexps ()
20308 (interactive)
20309 ;; In the paragraph separator we include headlines, because filling
20310 ;; text in a line directly attached to a headline would otherwise
20311 ;; fill the headline as well.
20314 ;; The paragraph starter includes hand-formatted lists.
20315 (org-set-local
20316 'paragraph-start
20317 (concat
20326 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20327 ;; But only if the user has not turned off tables or fixed-width regions
20328 (org-set-local
20329 'auto-fill-inhibit-regexp
20330 (concat org-outline-regexp
20333 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20334 (concat
20336 (if org-enable-table-editor "|" "")
20337 (if org-enable-fixed-width-editor ":" "")
20338 "]"))))
20339 ;; We use our own fill-paragraph function, to make sure that tables
20340 ;; and fixed-width regions are not wrapped. That function will pass
20341 ;; through to `fill-paragraph' when appropriate.
20342 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20343 ;; Prevent auto-fill from inserting unwanted new items.
20344 (if (boundp 'fill-nobreak-predicate)
20345 (org-set-local
20346 'fill-nobreak-predicate
20347 (org-uniquify
20348 (append fill-nobreak-predicate
20349 '(org-fill-item-nobreak-p org-fill-line-break-nobreak-p)))))
20350 ;; Adaptive filling: To get full control, first make sure that
20351 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20352 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20353 (org-set-local 'org-adaptive-fill-regexp-backup
20354 adaptive-fill-regexp))
20356 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20357 (org-set-local 'adaptive-fill-function
20358 'org-adaptive-fill-function)
20359 (org-set-local
20360 'align-mode-rules-list
20361 '((org-in-buffer-settings
20363 (modes . '(org-mode))))))
20365 (defun org-fill-item-nobreak-p ()
20366 "Non-nil when a line break at point would insert a new item."
20367 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20369 (defun org-fill-line-break-nobreak-p ()
20370 "Non-nil when a line break at point would create an Org line break."
20371 (save-excursion
20376 (defun org-fill-paragraph (&optional justify)
20377 "Re-align a table, pass through to fill-paragraph if no table."
20378 (let ((table-p (org-at-table-p))
20379 (table.el-p (org-at-table.el-p))
20380 (itemp (org-in-item-p)))
20381 (cond ((and (equal (char-after (point-at-bol)) ?*)
20382 (save-excursion (goto-char (point-at-bol))
20383 (looking-at org-outline-regexp)))
20384 t) ; skip headlines
20385 (table.el-p t) ; skip table.el tables
20386 (table-p (org-table-align) t) ; align Org tables
20387 (itemp ; align text in items
20388 (let* ((struct (save-excursion (goto-char itemp)
20389 (org-list-struct)))
20390 (parents (org-list-parents-alist struct))
20391 (children (org-list-get-children itemp struct parents))
20392 beg end prev next prefix)
20393 ;; Determine in which part of item point is: before
20394 ;; first child, after last child, between two
20395 ;; sub-lists, or simply in item if there's no child.
20396 (cond
20397 ((not children)
20398 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20399 beg itemp
20400 end (org-list-get-item-end itemp struct)))
20401 ((< (point) (setq next (car children)))
20402 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20403 beg itemp
20404 end next))
20405 ((> (point) (setq prev (car (last children))))
20406 (setq beg (org-list-get-item-end prev struct)
20407 end (org-list-get-item-end itemp struct)
20408 prefix (save-excursion
20409 (goto-char beg)
20411 (make-string (current-column) ?\ ))))
20412 (t (catch 'exit
20413 (while (setq next (pop children))
20414 (if (> (point) next)
20415 (setq prev next)
20416 (setq beg (org-list-get-item-end prev struct)
20417 end next
20418 prefix (save-excursion
20419 (goto-char beg)
20421 (make-string (current-column) ?\ )))
20422 (throw 'exit nil))))))
20423 ;; Use `fill-paragraph' with buffer narrowed to item
20424 ;; without any child, and with our computed PREFIX.
20425 (flet ((fill-context-prefix (from to &optional flr) prefix))
20426 (save-restriction
20427 (narrow-to-region beg end)
20428 (save-excursion (fill-paragraph justify)))) t))
20429 ;; Special case where point is not in a list but is on
20430 ;; a paragraph adjacent to a list: make sure this paragraph
20431 ;; doesn't get merged with the end of the list by narrowing
20432 ;; buffer first.
20433 ((save-excursion (forward-paragraph -1)
20434 (setq itemp (org-in-item-p)))
20435 (let ((struct (save-excursion (goto-char itemp)
20436 (org-list-struct))))
20437 (save-restriction
20438 (narrow-to-region (org-list-get-bottom-point struct)
20439 (save-excursion (forward-paragraph 1)
20440 (point)))
20441 (fill-paragraph justify) t)))
20442 ;; Else simply call `fill-paragraph'.
20443 (t nil))))
20445 ;; For reference, this is the default value of adaptive-fill-regexp
20448 (defun org-adaptive-fill-function ()
20449 "Return a fill prefix for org-mode files."
20450 (let (itemp)
20451 (save-excursion
20452 (cond
20453 ;; Comment line
20455 (match-string-no-properties 0))
20456 ;; Plain list item
20457 ((org-at-item-p)
20458 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20459 ;; Point is in a list after `backward-paragraph': original
20460 ;; point wasn't in the list, or filling would have been taken
20461 ;; care of by `org-auto-fill-function', but the list and the
20462 ;; real paragraph are not separated by a blank line. Thus, move
20463 ;; point after the list to go back to real paragraph and
20464 ;; determine fill-prefix.
20465 ((setq itemp (org-in-item-p))
20466 (goto-char itemp)
20467 (let* ((struct (org-list-struct))
20468 (bottom (org-list-get-bottom-point struct)))
20469 (goto-char bottom)
20470 (make-string (org-get-indentation) ?\ )))
20471 ;; Other text
20472 ((looking-at org-adaptive-fill-regexp-backup)
20473 (match-string-no-properties 0))))))
20475 (defun org-auto-fill-function ()
20476 "Auto-fill function."
20477 (let (itemp prefix)
20478 ;; When in a list, compute an appropriate fill-prefix and make
20479 ;; sure it will be used by `do-auto-fill'.
20480 (if (setq itemp (org-in-item-p))
20481 (progn
20482 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20483 (flet ((fill-context-prefix (from to &optional flr) prefix))
20484 (do-auto-fill)))
20485 ;; Else just use `do-auto-fill'.
20486 (do-auto-fill))))
20488 ;;; Other stuff.
20490 (defun org-toggle-fixed-width-section (arg)
20491 "Toggle the fixed-width export.
20492 If there is no active region, the QUOTE keyword at the current headline is
20493 inserted or removed. When present, it causes the text between this headline
20494 and the next to be exported as fixed-width text, and unmodified.
20495 If there is an active region, this command adds or removes a colon as the
20496 first character of this line. If the first character of a line is a colon,
20497 this line is also exported in fixed-width font."
20498 (interactive "P")
20499 (let* ((cc 0)
20500 (regionp (org-region-active-p))
20501 (beg (if regionp (region-beginning) (point)))
20502 (end (if regionp (region-end)))
20503 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20504 (case-fold-search nil)
20506 off)
20507 (if regionp
20508 (save-excursion
20509 (goto-char beg)
20510 (setq cc (current-column))
20511 (beginning-of-line 1)
20512 (setq off (looking-at re))
20513 (while (> nlines 0)
20514 (setq nlines (1- nlines))
20515 (beginning-of-line 1)
20516 (cond
20517 (arg
20518 (org-move-to-column cc t)
20520 (forward-line -1))
20521 ((and off (looking-at re))
20522 (replace-match "" t t nil 1))
20523 ((not off) (org-move-to-column cc t) (insert ": ")))
20524 (forward-line 1)))
20525 (save-excursion
20526 (org-back-to-heading)
20527 (cond
20528 ((looking-at (format org-heading-keyword-regexp-format
20529 org-quote-string))
20530 (goto-char (match-end 1))
20531 (looking-at (concat " +" org-quote-string))
20532 (replace-match "" t t)
20533 (when (eolp) (insert " ")))
20534 ((looking-at org-outline-regexp)
20535 (goto-char (match-end 0))
20536 (insert org-quote-string " ")))))))
20538 (defun org-reftex-citation ()
20539 "Use reftex-citation to insert a citation into the buffer.
20540 This looks for a line like
20542 #+BIBLIOGRAPHY: foo plain option:-d
20544 and derives from it that foo.bib is the bibliography file relevant
20545 for this document. It then installs the necessary environment for RefTeX
20546 to work in this buffer and calls `reftex-citation' to insert a citation
20547 into the buffer.
20549 Export of such citations to both LaTeX and HTML is handled by the contributed
20550 package org-exp-bibtex by Taru Karttunen."
20551 (interactive)
20552 (let ((reftex-docstruct-symbol 'rds)
20554 rds bib)
20555 (save-excursion
20556 (save-restriction
20557 (widen)
20558 (let ((case-fold-search t)
20560 (if (not (save-excursion
20561 (or (re-search-forward re nil t)
20562 (re-search-backward re nil t))))
20563 (error "No bibliography defined in file")
20564 (setq bib (concat (match-string 1) ".bib")
20565 rds (list (list 'bib bib)))))))
20566 (call-interactively 'reftex-citation)))
20568 ;;;; Functions extending outline functionality
20570 (defun org-beginning-of-line (&optional arg)
20571 "Go to the beginning of the current line. If that is invisible, continue
20572 to a visible line beginning. This makes the function of C-a more intuitive.
20573 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20574 first attempt, and only move to after the tags when the cursor is already
20575 beyond the end of the headline."
20576 (interactive "P")
20577 (let ((pos (point))
20578 (special (if (consp org-special-ctrl-a/e)
20579 (car org-special-ctrl-a/e)
20580 org-special-ctrl-a/e))
20581 refpos)
20582 (if (org-bound-and-true-p line-move-visual)
20583 (beginning-of-visual-line 1)
20584 (beginning-of-line 1))
20585 (if (and arg (fboundp 'move-beginning-of-line))
20586 (call-interactively 'move-beginning-of-line)
20587 (if (bobp)
20588 nil
20589 (backward-char 1)
20590 (if (org-truely-invisible-p)
20591 (while (and (not (bobp)) (org-truely-invisible-p))
20592 (backward-char 1)
20593 (beginning-of-line 1))
20594 (forward-char 1))))
20595 (when special
20596 (cond
20597 ((and (looking-at org-complex-heading-regexp)
20598 (= (char-after (match-end 1)) ?\ ))
20599 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20600 (point-at-eol)))
20601 (goto-char
20602 (if (eq special t)
20603 (cond ((> pos refpos) refpos)
20604 ((= pos (point)) refpos)
20605 (t (point)))
20606 (cond ((> pos (point)) (point))
20607 ((not (eq last-command this-command)) (point))
20608 (t refpos)))))
20609 ((org-at-item-p)
20610 ;; Being at an item and not looking at an the item means point
20611 ;; was previously moved to beginning of a visual line, whiche
20612 ;; doesn't contain the item. Therefore, do nothing special,
20613 ;; just stay here.
20614 (when (looking-at org-list-full-item-re)
20615 ;; Set special position at first white space character after
20616 ;; bullet, and check-box, if any.
20617 (let ((after-bullet
20618 (let ((box (match-end 3)))
20619 (if (not box) (match-end 1)
20620 (let ((after (char-after box)))
20621 (if (and after (= after ? )) (1+ box) box))))))
20622 ;; Special case: Move point to special position when
20623 ;; currently after it or at beginning of line.
20624 (if (eq special t)
20625 (when (or (> pos after-bullet) (= (point) pos))
20626 (goto-char after-bullet))
20627 ;; Reversed case: Move point to special position when
20628 ;; point was already at beginning of line and command is
20629 ;; repeated.
20630 (when (and (= (point) pos) (eq last-command this-command))
20631 (goto-char after-bullet))))))))
20632 (org-no-warnings
20633 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20635 (defun org-end-of-line (&optional arg)
20636 "Go to the end of the line.
20637 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20638 first attempt, and only move to after the tags when the cursor is already
20639 beyond the end of the headline."
20640 (interactive "P")
20641 (let ((special (if (consp org-special-ctrl-a/e)
20642 (cdr org-special-ctrl-a/e)
20643 org-special-ctrl-a/e)))
20644 (cond
20645 ((or (not special) arg
20646 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20647 (call-interactively
20648 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20649 ((fboundp 'move-end-of-line) 'move-end-of-line)
20650 (t 'end-of-line))))
20651 ((org-at-heading-p)
20652 (let ((pos (point)))
20653 (beginning-of-line 1)
20655 (if (eq special t)
20656 (if (or (< pos (match-beginning 1))
20657 (= pos (match-end 0)))
20658 (goto-char (match-beginning 1))
20659 (goto-char (match-end 0)))
20660 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20661 (goto-char (match-end 0))
20662 (goto-char (match-beginning 1))))
20663 (call-interactively (if (fboundp 'move-end-of-line)
20664 'move-end-of-line
20665 'end-of-line)))))
20666 ((org-at-drawer-p)
20667 (move-end-of-line 1)
20668 (when (overlays-at (1- (point))) (backward-char 1)))
20669 ;; At an item: Move before any hidden text.
20670 (t (call-interactively
20671 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20672 ((fboundp 'move-end-of-line) 'move-end-of-line)
20673 (t 'end-of-line)))))
20674 (org-no-warnings
20675 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20677 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20678 (define-key org-mode-map "\C-e" 'org-end-of-line)
20680 (defun org-backward-sentence (&optional arg)
20681 "Go to beginning of sentence, or beginning of table field.
20682 This will call `backward-sentence' or `org-table-beginning-of-field',
20683 depending on context."
20684 (interactive "P")
20685 (cond
20686 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20687 (t (call-interactively 'backward-sentence))))
20689 (defun org-forward-sentence (&optional arg)
20690 "Go to end of sentence, or end of table field.
20691 This will call `forward-sentence' or `org-table-end-of-field',
20692 depending on context."
20693 (interactive "P")
20694 (cond
20695 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20696 (t (call-interactively 'forward-sentence))))
20698 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20699 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20701 (defun org-kill-line (&optional arg)
20702 "Kill line, to tags or end of line."
20703 (interactive "P")
20704 (cond
20705 ((or (not org-special-ctrl-k)
20706 (bolp)
20707 (not (org-at-heading-p)))
20708 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20709 org-ctrl-k-protect-subtree)
20710 (if (or (eq org-ctrl-k-protect-subtree 'error)
20711 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20712 (error "C-k aborted - would kill hidden subtree")))
20713 (call-interactively
20714 (if visual-line-mode 'kill-visual-line 'kill-line)))
20716 (kill-region (point) (match-beginning 1))
20717 (org-set-tags nil t))
20718 (t (kill-region (point) (point-at-eol)))))
20720 (define-key org-mode-map "\C-k" 'org-kill-line)
20722 (defun org-yank (&optional arg)
20723 "Yank. If the kill is a subtree, treat it specially.
20724 This command will look at the current kill and check if is a single
20725 subtree, or a series of subtrees[1]. If it passes the test, and if the
20726 cursor is at the beginning of a line or after the stars of a currently
20727 empty headline, then the yank is handled specially. How exactly depends
20728 on the value of the following variables, both set by default.
20730 org-yank-folded-subtrees
20731 When set, the subtree(s) will be folded after insertion, but only
20732 if doing so would now swallow text after the yanked text.
20734 org-yank-adjusted-subtrees
20735 When set, the subtree will be promoted or demoted in order to
20736 fit into the local outline tree structure, which means that the level
20737 will be adjusted so that it becomes the smaller one of the two
20738 *visible* surrounding headings.
20740 Any prefix to this command will cause `yank' to be called directly with
20742 will just
20743 plainly yank the text as it is.
20745 \[1] The test checks if the first non-white line is a heading
20746 and if there are no other headings with fewer stars."
20747 (interactive "P")
20748 (org-yank-generic 'yank arg))
20750 (defun org-yank-generic (command arg)
20751 "Perform some yank-like command.
20753 This function implements the behavior described in the `org-yank'
20754 documentation. However, it has been generalized to work for any
20755 interactive command with similar behavior."
20757 ;; pretend to be command COMMAND
20758 (setq this-command command)
20760 (if arg
20761 (call-interactively command)
20763 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20764 (and (org-kill-is-subtree-p)
20765 (or (bolp)
20767 (string-match
20769 (buffer-substring (point-at-bol) (point)))))))
20770 swallowp)
20771 (cond
20772 ((and subtreep org-yank-folded-subtrees)
20773 (let ((beg (point))
20774 end)
20775 (if (and subtreep org-yank-adjusted-subtrees)
20776 (org-paste-subtree nil nil 'for-yank)
20777 (call-interactively command))
20779 (setq end (point))
20780 (goto-char beg)
20781 (when (and (bolp) subtreep
20782 (not (setq swallowp
20783 (org-yank-folding-would-swallow-text beg end))))
20784 (org-with-limited-levels
20785 (or (looking-at org-outline-regexp)
20786 (re-search-forward org-outline-regexp-bol end t))
20787 (while (and (< (point) end) (looking-at org-outline-regexp))
20788 (hide-subtree)
20789 (org-cycle-show-empty-lines 'folded)
20790 (condition-case nil
20791 (outline-forward-same-level 1)
20792 (error (goto-char end))))))
20793 (when swallowp
20794 (message
20795 "Inserted text not folded because that would swallow text"))
20797 (goto-char end)
20799 (beginning-of-line 1)
20800 (push-mark beg 'nomsg)))
20801 ((and subtreep org-yank-adjusted-subtrees)
20802 (let ((beg (point-at-bol)))
20803 (org-paste-subtree nil nil 'for-yank)
20804 (push-mark beg 'nomsg)))
20805 (t
20806 (call-interactively command))))))
20808 (defun org-yank-folding-would-swallow-text (beg end)
20809 "Would hide-subtree at BEG swallow any text after END?"
20810 (let (level)
20811 (org-with-limited-levels
20812 (save-excursion
20813 (goto-char beg)
20814 (when (or (looking-at org-outline-regexp)
20815 (re-search-forward org-outline-regexp-bol end t))
20816 (setq level (org-outline-level)))
20817 (goto-char end)
20819 (if (or (eobp)
20820 (and (bolp) (looking-at org-outline-regexp)
20821 (<= (org-outline-level) level)))
20822 nil ; Nothing would be swallowed
20823 t))))) ; something would swallow
20825 (define-key org-mode-map "\C-y" 'org-yank)
20827 (defun org-truely-invisible-p ()
20828 "Check if point is at a character currently not visible.
20829 This version does not only check the character property, but also
20830 `visible-mode'."
20831 ;; Early versions of noutline don't have `outline-invisible-p'.
20832 (if (org-bound-and-true-p visible-mode)
20833 nil
20834 (outline-invisible-p)))
20836 (defun org-invisible-p2 ()
20837 "Check if point is at a character currently not visible."
20838 (save-excursion
20839 (if (and (eolp) (not (bobp))) (backward-char 1))
20840 ;; Early versions of noutline don't have `outline-invisible-p'.
20841 (outline-invisible-p)))
20843 (defun org-back-to-heading (&optional invisible-ok)
20844 "Call `outline-back-to-heading', but provide a better error message."
20845 (condition-case nil
20846 (outline-back-to-heading invisible-ok)
20847 (error (error "Before first headline at position %d in buffer %s"
20848 (point) (current-buffer)))))
20850 (defun org-beginning-of-defun ()
20851 "Go to the beginning of the subtree, i.e. back to the heading."
20852 (org-back-to-heading))
20853 (defun org-end-of-defun ()
20854 "Go to the end of the subtree."
20855 (org-end-of-subtree nil t))
20857 (defun org-before-first-heading-p ()
20858 "Before first heading?"
20859 (save-excursion
20860 (end-of-line)
20861 (null (re-search-backward org-outline-regexp-bol nil t))))
20863 (defun org-at-heading-p (&optional ignored)
20864 (outline-on-heading-p t))
20865 ;; Compatibility alias with Org versions < 7.8.03
20866 (defalias 'org-on-heading-p 'org-at-heading-p)
20868 (defun org-at-drawer-p nil
20869 "Is cursor at a drawer keyword?"
20870 (save-excursion
20871 (move-beginning-of-line 1)
20872 (looking-at org-drawer-regexp)))
20874 (defun org-at-block-p nil
20875 "Is cursor at a block keyword?"
20876 (save-excursion
20877 (move-beginning-of-line 1)
20878 (looking-at org-block-regexp)))
20880 (defun org-point-at-end-of-empty-headline ()
20881 "If point is at the end of an empty headline, return t, else nil.
20882 If the heading only contains a TODO keyword, it is still still considered
20883 empty."
20885 (save-excursion
20886 (beginning-of-line 1)
20887 (let ((case-fold-search nil))
20888 (looking-at org-todo-line-regexp)))
20889 (string= (match-string 3) "")))
20891 (defun org-at-heading-or-item-p ()
20892 (or (org-at-heading-p) (org-at-item-p)))
20894 (defun org-at-target-p ()
20895 (or (org-in-regexp org-radio-target-regexp)
20896 (org-in-regexp org-target-regexp)))
20897 ;; Compatibility alias with Org versions < 7.8.03
20898 (defalias 'org-on-target-p 'org-at-target-p)
20900 (defun org-up-heading-all (arg)
20901 "Move to the heading line of which the present line is a subheading.
20902 This function considers both visible and invisible heading lines.
20903 With argument, move up ARG levels."
20904 (if (fboundp 'outline-up-heading-all)
20905 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20906 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20908 (defun org-up-heading-safe ()
20909 "Move to the heading line of which the present line is a subheading.
20910 This version will not throw an error. It will return the level of the
20911 headline found, or nil if no higher level is found.
20913 Also, this function will be a lot faster than `outline-up-heading',
20914 because it relies on stars being the outline starters. This can really
20915 make a significant difference in outlines with very many siblings."
20916 (let (start-level re)
20917 (org-back-to-heading t)
20918 (setq start-level (funcall outline-level))
20919 (if (equal start-level 1)
20920 nil
20922 (if (re-search-backward re nil t)
20923 (funcall outline-level)))))
20925 (defun org-first-sibling-p ()
20926 "Is this heading the first child of its parents?"
20927 (interactive)
20928 (let ((re org-outline-regexp-bol)
20929 level l)
20930 (unless (org-at-heading-p t)
20931 (error "Not at a heading"))
20932 (setq level (funcall outline-level))
20933 (save-excursion
20934 (if (not (re-search-backward re nil t))
20935 t
20936 (setq l (funcall outline-level))
20937 (< l level)))))
20939 (defun org-goto-sibling (&optional previous)
20940 "Goto the next sibling, even if it is invisible.
20941 When PREVIOUS is set, go to the previous sibling instead. Returns t
20942 when a sibling was found. When none is found, return nil and don't
20943 move point."
20944 (let ((fun (if previous 're-search-backward 're-search-forward))
20945 (pos (point))
20946 (re org-outline-regexp-bol)
20947 level l)
20948 (when (condition-case nil (org-back-to-heading t) (error nil))
20949 (setq level (funcall outline-level))
20950 (catch 'exit
20951 (or previous (forward-char 1))
20952 (while (funcall fun re nil t)
20953 (setq l (funcall outline-level))
20954 (when (< l level) (goto-char pos) (throw 'exit nil))
20955 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20956 (goto-char pos)
20957 nil))))
20959 (defun org-show-siblings ()
20960 "Show all siblings of the current headline."
20961 (save-excursion
20962 (while (org-goto-sibling) (org-flag-heading nil)))
20963 (save-excursion
20964 (while (org-goto-sibling 'previous)
20965 (org-flag-heading nil))))
20967 (defun org-goto-first-child ()
20968 "Goto the first child, even if it is invisible.
20969 Return t when a child was found. Otherwise don't move point and
20970 return nil."
20971 (let (level (pos (point)) (re org-outline-regexp-bol))
20972 (when (condition-case nil (org-back-to-heading t) (error nil))
20973 (setq level (outline-level))
20974 (forward-char 1)
20975 (if (and (re-search-forward re nil t) (> (outline-level) level))
20976 (progn (goto-char (match-beginning 0)) t)
20977 (goto-char pos) nil))))
20979 (defun org-show-hidden-entry ()
20980 "Show an entry where even the heading is hidden."
20981 (save-excursion
20982 (org-show-entry)))
20984 (defun org-flag-heading (flag &optional entry)
20985 "Flag the current heading. FLAG non-nil means make invisible.
20986 When ENTRY is non-nil, show the entire entry."
20987 (save-excursion
20988 (org-back-to-heading t)
20989 ;; Check if we should show the entire entry
20990 (if entry
20991 (progn
20992 (org-show-entry)
20993 (save-excursion
20994 (and (outline-next-heading)
20995 (org-flag-heading nil))))
20996 (outline-flag-region (max (point-min) (1- (point)))
20997 (save-excursion (outline-end-of-heading) (point))
20998 flag))))
21000 (defun org-get-next-sibling ()
21001 "Move to next heading of the same level, and return point.
21002 If there is no such heading, return nil.
21003 This is like outline-next-sibling, but invisible headings are ok."
21004 (let ((level (funcall outline-level)))
21005 (outline-next-heading)
21006 (while (and (not (eobp)) (> (funcall outline-level) level))
21007 (outline-next-heading))
21008 (if (or (eobp) (< (funcall outline-level) level))
21009 nil
21010 (point))))
21012 (defun org-get-last-sibling ()
21013 "Move to previous heading of the same level, and return point.
21014 If there is no such heading, return nil."
21015 (let ((opoint (point))
21016 (level (funcall outline-level)))
21017 (outline-previous-heading)
21018 (when (and (/= (point) opoint) (outline-on-heading-p t))
21019 (while (and (> (funcall outline-level) level)
21020 (not (bobp)))
21021 (outline-previous-heading))
21022 (if (< (funcall outline-level) level)
21023 nil
21024 (point)))))
21026 (defun org-end-of-subtree (&optional invisible-OK to-heading)
21027 ;; This contains an exact copy of the original function, but it uses
21028 ;; `org-back-to-heading', to make it work also in invisible
21029 ;; trees. And is uses an invisible-OK argument.
21030 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21031 ;; Furthermore, when used inside Org, finding the end of a large subtree
21032 ;; with many children and grandchildren etc, this can be much faster
21033 ;; than the outline version.
21034 (org-back-to-heading invisible-OK)
21035 (let ((first t)
21036 (level (funcall outline-level)))
21037 (if (and (eq major-mode 'org-mode) (< level 1000))
21038 ;; A true heading (not a plain list item), in Org-mode
21039 ;; This means we can easily find the end by looking
21040 ;; only for the right number of stars. Using a regexp to do
21041 ;; this is so much faster than using a Lisp loop.
21043 (forward-char 1)
21044 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21045 ;; something else, do it the slow way
21046 (while (and (not (eobp))
21047 (or first (> (funcall outline-level) level)))
21048 (setq first nil)
21049 (outline-next-heading)))
21050 (unless to-heading
21052 (progn
21053 ;; Go to end of line before heading
21054 (forward-char -1)
21056 ;; leave blank line before heading
21057 (forward-char -1))))))
21058 (point))
21060 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21061 "Use Org version in org-mode, for dramatic speed-up."
21062 (if (eq major-mode 'org-mode)
21063 (progn
21064 (org-end-of-subtree nil t)
21065 (unless (eobp) (backward-char 1)))
21066 ad-do-it))
21068 (defun org-end-of-meta-data-and-drawers ()
21069 "Jump to the first text after meta data and drawers in the current entry.
21070 This will move over empty lines, lines with planning time stamps,
21071 clocking lines, and drawers."
21072 (org-back-to-heading t)
21073 (let ((end (save-excursion (outline-next-heading) (point)))
21076 (forward-line 1)
21077 (while (re-search-forward re end t)
21078 (if (not (match-end 1))
21079 ;; empty or planning line
21080 (forward-line 1)
21081 ;; a drawer, find the end
21083 (forward-line 1)))
21085 (point)))
21087 (defun org-forward-same-level (arg &optional invisible-ok)
21088 "Move forward to the arg'th subheading at same level as this one.
21089 Stop at the first and last subheadings of a superior heading.
21090 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
21091 it wil also look at invisible ones."
21092 (interactive "p")
21093 (org-back-to-heading invisible-ok)
21094 (org-at-heading-p)
21095 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21097 l)
21098 (forward-char 1)
21099 (while (> arg 0)
21100 (while (and (re-search-forward re nil 'move)
21101 (setq l (- (match-end 0) (match-beginning 0) 1))
21102 (= l level)
21103 (not invisible-ok)
21104 (progn (backward-char 1) (outline-invisible-p)))
21105 (if (< l level) (setq arg 1)))
21106 (setq arg (1- arg)))
21107 (beginning-of-line 1)))
21109 (defun org-backward-same-level (arg &optional invisible-ok)
21110 "Move backward to the arg'th subheading at same level as this one.
21111 Stop at the first and last subheadings of a superior heading."
21112 (interactive "p")
21113 (org-back-to-heading)
21114 (org-at-heading-p)
21115 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21117 l)
21118 (while (> arg 0)
21119 (while (and (re-search-backward re nil 'move)
21120 (setq l (- (match-end 0) (match-beginning 0) 1))
21121 (= l level)
21122 (not invisible-ok)
21123 (outline-invisible-p))
21124 (if (< l level) (setq arg 1)))
21125 (setq arg (1- arg)))))
21127 (defun org-show-subtree ()
21128 "Show everything after this heading at deeper levels."
21129 (outline-flag-region
21130 (point)
21131 (save-excursion
21132 (org-end-of-subtree t t))
21133 nil))
21135 (defun org-show-entry ()
21136 "Show the body directly following this heading.
21137 Show the heading too, if it is currently invisible."
21138 (interactive)
21139 (save-excursion
21140 (condition-case nil
21141 (progn
21142 (org-back-to-heading t)
21143 (outline-flag-region
21144 (max (point-min) (1- (point)))
21145 (save-excursion
21146 (if (re-search-forward
21148 (match-beginning 1)
21149 (point-max)))
21150 nil)
21151 (org-cycle-hide-drawers 'children))
21152 (error nil))))
21154 (defun org-make-options-regexp (kwds &optional extra)
21155 "Make a regular expression for keyword lines."
21156 (concat
21157 "^"
21164 ;; Make isearch reveal the necessary context
21165 (defun org-isearch-end ()
21166 "Reveal context after isearch exits."
21167 (when isearch-success ; only if search was successful
21168 (if (featurep 'xemacs)
21169 ;; Under XEmacs, the hook is run in the correct place,
21170 ;; we directly show the context.
21171 (org-show-context 'isearch)
21172 ;; In Emacs the hook runs *before* restoring the overlays.
21173 ;; So we have to use a one-time post-command-hook to do this.
21174 ;; (Emacs 22 has a special variable, see function `org-mode')
21175 (unless (and (boundp 'isearch-mode-end-hook-quit)
21176 isearch-mode-end-hook-quit)
21177 ;; Only when the isearch was not quitted.
21178 (org-add-hook 'post-command-hook 'org-isearch-post-command
21179 'append 'local)))))
21181 (defun org-isearch-post-command ()
21182 "Remove self from hook, and show context."
21183 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21184 (org-show-context 'isearch))
21187 ;;;; Integration with and fixes for other packages
21189 ;;; Imenu support
21191 (defvar org-imenu-markers nil
21192 "All markers currently used by Imenu.")
21193 (make-variable-buffer-local 'org-imenu-markers)
21195 (defun org-imenu-new-marker (&optional pos)
21196 "Return a new marker for use by Imenu, and remember the marker."
21197 (let ((m (make-marker)))
21198 (move-marker m (or pos (point)))
21199 (push m org-imenu-markers)
21200 m))
21202 (defun org-imenu-get-tree ()
21203 "Produce the index for Imenu."
21204 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21205 (setq org-imenu-markers nil)
21206 (let* ((n org-imenu-depth)
21207 (re (concat "^" (org-get-limited-outline-regexp)))
21208 (subs (make-vector (1+ n) nil))
21209 (last-level 0)
21210 m level head)
21211 (save-excursion
21212 (save-restriction
21213 (widen)
21214 (goto-char (point-max))
21215 (while (re-search-backward re nil t)
21216 (setq level (org-reduced-level (funcall outline-level)))
21217 (when (<= level n)
21218 (looking-at org-complex-heading-regexp)
21219 (setq head (org-link-display-format
21220 (org-match-string-no-properties 4))
21221 m (org-imenu-new-marker))
21222 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21223 (if (>= level last-level)
21224 (push (cons head m) (aref subs level))
21225 (push (cons head (aref subs (1+ level))) (aref subs level))
21226 (loop for i from (1+ level) to n do (aset subs i nil)))
21227 (setq last-level level)))))
21228 (aref subs 1)))
21230 (eval-after-load "imenu"
21231 '(progn
21232 (add-hook 'imenu-after-jump-hook
21233 (lambda ()
21234 (if (eq major-mode 'org-mode)
21235 (org-show-context 'org-goto))))))
21237 (defun org-link-display-format (link)
21238 "Replace a link with either the description, or the link target
21239 if no description is present"
21240 (save-match-data
21241 (if (string-match org-bracket-link-analytic-regexp link)
21242 (replace-match (if (match-end 5)
21243 (match-string 5 link)
21244 (concat (match-string 1 link)
21245 (match-string 3 link)))
21246 nil t link)
21247 link)))
21249 (defun org-toggle-link-display ()
21250 "Toggle the literal or descriptive display of links."
21251 (interactive)
21252 (if org-descriptive-links
21253 (progn (org-remove-from-invisibility-spec '(org-link))
21254 (org-restart-font-lock)
21255 (setq org-descriptive-links nil))
21256 (progn (add-to-invisibility-spec '(org-link))
21257 (org-restart-font-lock)
21258 (setq org-descriptive-links t))))
21260 ;; Speedbar support
21262 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21263 "Overlay marking the agenda restriction line in speedbar.")
21264 (overlay-put org-speedbar-restriction-lock-overlay
21265 'face 'org-agenda-restriction-lock)
21266 (overlay-put org-speedbar-restriction-lock-overlay
21267 'help-echo "Agendas are currently limited to this item.")
21268 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21270 (defun org-speedbar-set-agenda-restriction ()
21271 "Restrict future agenda commands to the location at point in speedbar.
21273 (interactive)
21274 (require 'org-agenda)
21275 (let (p m tp np dir txt)
21276 (cond
21277 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21278 'org-imenu t))
21279 (setq m (get-text-property p 'org-imenu-marker))
21280 (with-current-buffer (marker-buffer m)
21281 (goto-char m)
21282 (org-agenda-set-restriction-lock 'subtree)))
21283 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21284 'speedbar-function 'speedbar-find-file))
21285 (setq tp (previous-single-property-change
21286 (1+ p) 'speedbar-function)
21287 np (next-single-property-change
21288 tp 'speedbar-function)
21289 dir (speedbar-line-directory)
21290 txt (buffer-substring-no-properties (or tp (point-min))
21291 (or np (point-max))))
21292 (with-current-buffer (find-file-noselect
21293 (let ((default-directory dir))
21294 (expand-file-name txt)))
21295 (unless (eq major-mode 'org-mode)
21296 (error "Cannot restrict to non-Org-mode file"))
21297 (org-agenda-set-restriction-lock 'file)))
21298 (t (error "Don't know how to restrict Org-mode's agenda")))
21299 (move-overlay org-speedbar-restriction-lock-overlay
21300 (point-at-bol) (point-at-eol))
21301 (setq current-prefix-arg nil)
21302 (org-agenda-maybe-redo)))
21304 (eval-after-load "speedbar"
21305 '(progn
21306 (speedbar-add-supported-extension ".org")
21307 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21308 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21309 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21310 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21311 (add-hook 'speedbar-visiting-tag-hook
21312 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21314 ;;; Fixes and Hacks for problems with other packages
21316 ;; Make flyspell not check words in links, to not mess up our keymap
21317 (defun org-mode-flyspell-verify ()
21318 "Don't let flyspell put overlays at active buttons, or on
21319 {todo,all-time,additional-option-like}-keywords."
21320 (let ((pos (max (1- (point)) (point-min)))
21321 (word (thing-at-point 'word)))
21322 (and (not (get-text-property pos 'keymap))
21323 (not (get-text-property pos 'org-no-flyspell))
21324 (not (member word org-todo-keywords-1))
21325 (not (member word org-all-time-keywords))
21326 (not (member word org-additional-option-like-keywords)))))
21328 (defun org-remove-flyspell-overlays-in (beg end)
21329 "Remove flyspell overlays in region."
21330 (and (org-bound-and-true-p flyspell-mode)
21331 (fboundp 'flyspell-delete-region-overlays)
21332 (flyspell-delete-region-overlays beg end))
21333 (add-text-properties beg end '(org-no-flyspell t)))
21335 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21336 (eval-after-load "bookmark"
21337 '(if (boundp 'bookmark-after-jump-hook)
21338 ;; We can use the hook
21339 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21340 ;; Hook not available, use advice
21341 (defadvice bookmark-jump (after org-make-visible activate)
21342 "Make the position visible."
21343 (org-bookmark-jump-unhide))))
21345 ;; Make sure saveplace shows the location if it was hidden
21346 (eval-after-load "saveplace"
21347 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21348 "Make the position visible."
21349 (org-bookmark-jump-unhide)))
21351 ;; Make sure ecb shows the location if it was hidden
21352 (eval-after-load "ecb"
21353 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21354 "Make hierarchy visible when jumping into location from ECB tree buffer."
21355 (if (eq major-mode 'org-mode)
21356 (org-show-context))))
21358 (defun org-bookmark-jump-unhide ()
21359 "Unhide the current position, to show the bookmark location."
21360 (and (eq major-mode 'org-mode)
21361 (or (outline-invisible-p)
21362 (save-excursion (goto-char (max (point-min) (1- (point))))
21363 (outline-invisible-p)))
21364 (org-show-context 'bookmark-jump)))
21366 ;; Make session.el ignore our circular variable
21367 (eval-after-load "session"
21368 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21370 ;;;; Experimental code
21372 (defun org-closed-in-range ()
21373 "Sparse tree of items closed in a certain time range.
21374 Still experimental, may disappear in the future."
21375 (interactive)
21376 ;; Get the time interval from the user.
21377 (let* ((time1 (org-float-time
21378 (org-read-date nil 'to-time nil "Starting date: ")))
21379 (time2 (org-float-time
21380 (org-read-date nil 'to-time nil "End date:")))
21381 ;; callback function
21382 (callback (lambda ()
21383 (let ((time
21384 (org-float-time
21385 (apply 'encode-time
21386 (org-parse-time-string
21387 (match-string 1))))))
21388 ;; check if time in interval
21389 (and (>= time time1) (<= time time2))))))
21390 ;; make tree, check each match with the callback
21393 ;;;; Finish up
21395 (provide 'org)
21397 (run-hooks 'org-load-hook)
21399 ;;; org.el ends here