| blob | a81f7fcecec62c6fd1bc1a4bbeaf735d87e01867 |
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 "Strip protective commas between BEG and END in the current buffer."
5515 "Run through the buffer and add overlays to links."
5523 t)))
5526 "Run through the buffer and add overlays to footnotes."
5533 'keymap org-mouse-map
5534 'help-echo
5536 "Footnote definition"
5538 'font-lock-fontified t
5539 'font-lock-multiline t
5543 "Run through the buffer and add overlays to bracketed links."
5547 ;; FIXME: above we should remove the escapes.
5548 ;; but that requires another match, protecting match data,
5549 ;; a lot of overhead for font-lock.
5556 ;; We need to remove the invisible property here. Table narrowing
5557 ;; may have made some of this invisible.
5575 t)))
5578 "Run through the buffer and add overlays to dates."
5590 t)))
5599 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5603 "Run through the buffer and add overlays to target matches."
5611 'keymap org-mouse-map
5615 t)))))
5618 "Find all radio targets in this file and update the regular expression."
5633 t)))
5640 ;; This should be with the exporter code, but we also use if for font-locking
5650 "Compute regular expression for stuff treated specially by exporters."
5657 org-latex-regexps)))
5685 org-entities)))
5689 org-latex-entities)
5690 nil))
5692 ))
5693 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5696 org-export-html-special-string-regexps)))
5701 ))))
5703 'org-latex-and-specials-regexp
5708 "Run through the buffer and add overlays to links."
5712 limit t))
5726 rtn)))
5729 "Restart `font-lock-mode', to force refontification."
5735 "Return a list of all targets in this file.
5736 With optional argument RADIO, only find radio targets."
5738 rtn)
5743 rtn)))
5746 "Make regular expression matching all strings in TARGETS.
5747 The regular expression finds the targets also if there is a line break
5748 between words."
5757 x)
5758 targets
5770 t)))
5773 "Compute the outline level of the heading at point.
5774 This function assumes that the cursor is at the beginning of a line matched
5775 by `outline-regexp'. Otherwise it returns garbage.
5776 If this is called at a normal headline, the level is the number of stars.
5777 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5784 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5791 "Functions that can manipulate `org-font-lock-extra-keywords'.
5792 This is called after `org-font-lock-extra-keywords' is defined, but before
5793 it is installed to be used by font lock. This can be useful if something
5804 ;; Call the hook
5806 ;; Headlines
5813 ;; Table lines
5816 ;; Table internals
5821 ;; Drawers
5824 ;; Properties
5828 ;; Links
5838 ;; TODO keyword
5840 org-todo-regexp)
5842 ;; DONE
5850 nil)
5851 ;; Priorities
5853 ;; Tags
5855 ;; Special keywords
5860 ;; Emphasis
5865 ;; Checkboxes
5866 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5871 ;; Description list items
5874 ;; ARCHIVEd headings
5876 org-outline-regexp-bol
5879 ;; Specials
5883 ;; Code
5885 ;; COMMENT
5892 ;; Blocks and meta lines
5894 )))
5897 ;; Now set the full font-lock-keywords
5904 "Toggle the composition display of entities as UTF8 characters."
5916 "Find an entity to fontify."
5922 limit t)
5934 nil))))
5937 "Fontify string S like in Org-mode."
5949 "Get the right face for match N in font-lock matching of headlines."
5962 "Get the right face for a TODO keyword KWD.
5963 If KWD is a number, get the corresponding match group."
5971 "Create a face list that inherits INHERIT, but sets the foreground color.
5972 When FACE-OR-COLOR is not a string, just return it."
5976 face-or-color)
5977 face-or-color))
5980 "Add the special tag faces."
5989 "Add the special priority faces."
5996 org-priority-faces)))
6001 "Get the right face for a TODO keyword KWD.
6002 If KWD is a number, get the corresponding match group."
6009 "Remove fontification and activation overlays from links."
6014 deactivate-mark buffer-file-name buffer-file-truename)
6018 invisible t intangible t
6019 org-no-flyspell t org-emphasis t))
6029 "Remove specific display properties that have been added by font lock.
6030 The will remove the raise properties that are used to show superscripts
6031 and subscripts."
6041 "Add raise properties to sub/superscripts."
6045 org-match-substring-regexp
6046 org-match-substring-with-braces-regexp)
6047 limit t)
6057 ;; FIXME: Should we go back one character here, for a_b^c
6058 ;; (goto-char (1- pos)) ;????????????????????
6060 t
6062 'display
6078 t)))))
6080 ;;;; Visibility cycling, including org-goto and indirect buffer
6082 ;;; Cycling
6089 ;;;###autoload
6094 "TAB-action and visibility cycling for Org-mode.
6096 This is the command invoked in Org-mode by the TAB key. Its main purpose
6097 is outline visibility cycling, but it also invokes other actions
6098 in special contexts.
6100 - When this function is called with a prefix argument, rotate the entire
6101 buffer through 3 states (global cycling)
6102 1. OVERVIEW: Show only top-level headlines.
6103 2. CONTENTS: Show all headlines of all levels, but no body text.
6104 3. SHOW ALL: Show everything.
6105 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6106 determined by the variable `org-startup-folded', and by any VISIBILITY
6107 properties in the buffer.
6108 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6109 including any drawers.
6111 - When inside a table, re-align the table and move to the next field.
6113 - When point is at the beginning of a headline, rotate the subtree started
6114 by this line through 3 different states (local cycling)
6115 1. FOLDED: Only the main headline is shown.
6116 2. CHILDREN: The main headline and the direct children are shown.
6117 From this state, you can move to one of the children
6118 and zoom in further.
6119 3. SUBTREE: Show the entire subtree, including body text.
6120 If there is no subtree, switch directly from CHILDREN to FOLDED.
6122 - When point is at the beginning of an empty headline and the variable
6123 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6124 of the headline by demoting and promoting it to likely levels. This
6125 speeds up creation document structure by pressing TAB once or several
6126 times right after creating a new headline.
6128 - When there is a numeric prefix, go up to a heading with level ARG, do
6129 a `show-subtree' and return to the previous cursor position. If ARG
6130 is negative, go up that many levels.
6132 - When point is not at the beginning of a headline, execute the global
6133 binding for TAB, which is re-indenting the line. See the option
6134 `org-cycle-emulate-tab' for details.
6136 - Special case: if point is at the beginning of the buffer and there is
6137 no headline in line 1, this function will act as if called with prefix arg
6138 (C-u TAB, same as S-TAB) also when called without prefix arg.
6139 But only if also the variable `org-cycle-global-at-bob' is t."
6149 org-inlinetask-min-level
6154 limit-level)))
6157 outline-regexp
6165 org-cycle-hook))
6169 ;; special case: use global cycling
6183 ;; Table: enter it or move to the next field.
6194 ;; Global cycling: delegate to `org-cycle-internal-global'.
6197 ;; Drawers: delegate to `org-flag-drawer'.
6205 ;; Show-subtree, ARG levels up from here.
6213 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6221 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6228 ;; From there: TAB emulation and template completion.
6250 t
6259 "Do the global cycling action."
6260 ;; Hack to avoid display of messages for .org attachments in Gnus
6265 ;; We just created the overview - now do table of contents
6266 ;; This can be slow in very large buffers, so indicate action
6276 ;; We just showed the table of contents - now show everything
6284 ;; Default action: go to overview
6292 "Do the local cycling action."
6294 ;; First, determine end of headline (EOH), end of subtree or item
6295 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6319 ;; Determine end invisible part of buffer (EOL)
6321 ;; XEmacs doesn't have `next-single-char-property-change'
6331 ;; Find out what to do next and set `this-command'
6334 ;; Nothing is hidden behind this heading
6346 org-cycle-skip-children-state-if-no-children))))
6347 ;; Entire subtree is hidden in one line: children view
6355 ;; Fold every list in subtree to top-level items.
6377 ;; We just showed the children, or no children are there,
6378 ;; now show everything.
6385 ;; Default action: hide the subtree.
6392 ;;;###autoload
6394 "Cycle the global visibility. For details see `org-cycle'.
6396 With a numeric prefix, show all headlines up to that level."
6412 "Set the visibility required by startup options and properties."
6427 "Switch subtree visibilities according to :VISIBILITY: property."
6434 nil t)
6458 ;; This function uses outline-regexp instead of the more fundamental
6459 ;; org-outline-regexp so that org-cycle-global works outside of Org
6460 ;; buffers, where outline-regexp is needed.
6462 "Switch to overview mode, showing only top-level headlines.
6463 Really, this shows all headlines with level equal or greater than the level
6464 of the first headline in the buffer. This is important, because if the
6465 first headline is not level one, then (hide-sublevels 1) gives confusing
6466 results."
6477 "Show all headlines in the buffer, like a table of contents.
6478 With numerical argument N, show content up to level N."
6481 ;; Visit all headings and show their offspring
6488 t)
6497 "Adjust the window after a change in outline visibility.
6498 This function is the default value of the hook `org-cycle-hook'."
6508 "Remove outline overlays that do not contain non-white stuff."
6518 "Fix visibility issues after moving a subtree."
6519 ;; First, find a reasonable region to look at:
6520 ;; Start two siblings above, end three below
6538 ;; Properly fold already folded siblings
6549 "Show empty lines above all visible headlines.
6550 The region to be covered depends on STATE when called through
6551 `org-cycle-hook'. Lisp program can use t for STATE to get the
6552 entire buffer covered. Note that an empty line is only shown if there
6553 are at least `org-cycle-separator-lines' empty lines before the headline."
6563 beg end b e)
6587 ;; Never hide empty lines at the end of the file.
6597 "Move to the parent and re-show empty lines before visible headlines."
6603 "Return `org-agenda-files' list, plus all open org-mode files.
6604 This is useful for operations that need to scan all of a user's
6605 open and agenda-wise Org files."
6613 files))
6616 "Return the beginning position of the current entry."
6620 "Return the end position of the current entry."
6624 "Re-hide all drawers after a visibility state change."
6650 "Is the end of the current subtree visible?"
6655 "Move cursor to the first headline and recenter the headline.
6656 Optional argument N means put the headline into the Nth line of the window."
6662 ;;; Saving and restoring visibility
6665 "Return a list of the locations of all outline overlays.
6666 These are overlays with the `invisible' property value `outline'.
6667 The return value is a list of cons cells, with start and stop
6668 positions for each overlay.
6669 If USE-MARKERS is set, return the positions as markers."
6687 "Create visibility overlays for all positions in DATA.
6688 DATA should have been made by `org-outline-overlay-data'."
6696 data)))))
6698 ;;; Folding of blocks
6705 "Call FUNCTION at the head of all source blocks in the current buffer.
6706 Optional arguments START and END can be used to limit the range."
6718 "Toggle the visibility of all blocks in the current buffer."
6722 "Fold all blocks in the current buffer."
6728 "Unfold all blocks in the current buffer."
6734 "Toggle visibility of block at point."
6745 "Toggle the visibility of the current block."
6752 ov)
6768 ;; make the block accessible to isearch
6770 ov 'isearch-open-invisible
6781 ;; org-tab-after-check-for-cycling-hook
6783 ;; Remove overlays when changing major mode
6788 ;;; Org-goto
6794 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6810 nil)
6811 (org-defkey map "q" 'org-goto-quit)
6812 (org-defkey map "n" 'outline-next-visible-heading)
6813 (org-defkey map "p" 'outline-previous-visible-heading)
6814 (org-defkey map "f" 'outline-forward-same-level)
6815 (org-defkey map "b" 'outline-backward-same-level)
6816 (org-defkey map "u" 'outline-up-heading))
6817 (org-defkey map "/" 'org-occur)
6818 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6819 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6820 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6821 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6822 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6823 map))
6825 (defconst org-goto-help
6826 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6827 RET=jump to location [Q]uit and return to previous location
6828 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6830 (defvar org-goto-start-pos) ; dynamically scoped parameter
6832 ;; FIXME: Docstring does not mention both interfaces
6833 (defun org-goto (&optional alternative-interface)
6834 "Look up a different location in the current file, keeping current visibility.
6836 When you want look-up or go to a different location in a document, the
6837 fastest way is often to fold the entire buffer and then dive into the tree.
6838 This method has the disadvantage, that the previous location will be folded,
6839 which may not be what you want.
6841 This command works around this by showing a copy of the current buffer
6842 in an indirect buffer, in overview mode. You can dive into the tree in
6843 that copy, use org-occur and incremental search to find a location.
6844 When pressing RET or `Q', the command returns to the original buffer in
6845 which the visibility is still unchanged. After RET is will also jump to
6846 the location selected in the indirect buffer and expose the headline
6847 hierarchy above."
6848 (interactive "P")
6849 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6850 (org-refile-use-outline-path t)
6851 (org-refile-target-verify-function nil)
6852 (interface
6853 (if (not alternative-interface)
6854 org-goto-interface
6855 (if (eq org-goto-interface 'outline)
6856 'outline-path-completion
6857 'outline)))
6858 (org-goto-start-pos (point))
6859 (selected-point
6860 (if (eq interface 'outline)
6861 (car (org-get-location (current-buffer) org-goto-help))
6862 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6863 (org-refile-check-position pa)
6864 (nth 3 pa)))))
6865 (if selected-point
6866 (progn
6867 (org-mark-ring-push org-goto-start-pos)
6868 (goto-char selected-point)
6869 (if (or (outline-invisible-p) (org-invisible-p2))
6870 (org-show-context 'org-goto)))
6871 (message "Quit"))))
6873 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6874 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6875 (defvar org-goto-local-auto-isearch-map) ; defined below
6877 (defun org-get-location (buf help)
6878 "Let the user select a location in the Org-mode buffer BUF.
6879 This function uses a recursive edit. It returns the selected position
6880 or nil."
6881 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6882 (isearch-hide-immediately nil)
6883 (isearch-search-fun-function
6884 (lambda () 'org-goto-local-search-headings))
6885 (org-goto-selected-point org-goto-exit-command)
6886 (pop-up-frames nil)
6887 (special-display-buffer-names nil)
6888 (special-display-regexps nil)
6889 (special-display-function nil))
6890 (save-excursion
6891 (save-window-excursion
6892 (delete-other-windows)
6893 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6894 (org-pop-to-buffer-same-window
6895 (condition-case nil
6896 (make-indirect-buffer (current-buffer) "*org-goto*")
6897 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6898 (with-output-to-temp-buffer "*Help*"
6899 (princ help))
6900 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6901 (setq buffer-read-only nil)
6902 (let ((org-startup-truncated t)
6903 (org-startup-folded nil)
6904 (org-startup-align-all-tables nil))
6905 (org-mode)
6906 (org-overview))
6907 (setq buffer-read-only t)
6908 (if (and (boundp 'org-goto-start-pos)
6909 (integer-or-marker-p org-goto-start-pos))
6910 (let ((org-show-hierarchy-above t)
6911 (org-show-siblings t)
6912 (org-show-following-heading t))
6913 (goto-char org-goto-start-pos)
6914 (and (outline-invisible-p) (org-show-context)))
6915 (goto-char (point-min)))
6916 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6917 (message "Select location and press RET")
6918 (use-local-map org-goto-map)
6919 (recursive-edit)
6920 ))
6921 (kill-buffer "*org-goto*")
6922 (cons org-goto-selected-point org-goto-exit-command)))
6924 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6925 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6926 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6927 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6929 (defun org-goto-local-search-headings (string bound noerror)
6930 "Search and make sure that any matches are in headlines."
6931 (catch 'return
6932 (while (if isearch-forward
6933 (search-forward string bound noerror)
6934 (search-backward string bound noerror))
6935 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6936 (and (member :headline context)
6937 (not (member :tags context))))
6938 (throw 'return (point))))))
6940 (defun org-goto-local-auto-isearch ()
6941 "Start isearch."
6942 (interactive)
6943 (goto-char (point-min))
6944 (let ((keys (this-command-keys)))
6945 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6946 (isearch-mode t)
6947 (isearch-process-search-char (string-to-char keys)))))
6949 (defun org-goto-ret (&optional arg)
6950 "Finish `org-goto' by going to the new location."
6951 (interactive "P")
6952 (setq org-goto-selected-point (point)
6953 org-goto-exit-command 'return)
6954 (throw 'exit nil))
6956 (defun org-goto-left ()
6957 "Finish `org-goto' by going to the new location."
6958 (interactive)
6959 (if (org-at-heading-p)
6960 (progn
6961 (beginning-of-line 1)
6962 (setq org-goto-selected-point (point)
6963 org-goto-exit-command 'left)
6964 (throw 'exit nil))
6965 (error "Not on a heading")))
6967 (defun org-goto-right ()
6968 "Finish `org-goto' by going to the new location."
6969 (interactive)
6970 (if (org-at-heading-p)
6971 (progn
6972 (setq org-goto-selected-point (point)
6973 org-goto-exit-command 'right)
6974 (throw 'exit nil))
6975 (error "Not on a heading")))
6977 (defun org-goto-quit ()
6978 "Finish `org-goto' without cursor motion."
6979 (interactive)
6980 (setq org-goto-selected-point nil)
6981 (setq org-goto-exit-command 'quit)
6982 (throw 'exit nil))
6984 ;;; Indirect buffer display of subtrees
6986 (defvar org-indirect-dedicated-frame nil
6987 "This is the frame being used for indirect tree display.")
6988 (defvar org-last-indirect-buffer nil)
6990 (defun org-tree-to-indirect-buffer (&optional arg)
6991 "Create indirect buffer and narrow it to current subtree.
6992 With numerical prefix ARG, go up to this level and then take that tree.
6993 If ARG is negative, go up that many levels.
6994 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6995 indirect buffer previously made with this command, to avoid proliferation of
6996 indirect buffers. However, when you call the command with a \
6998 when `org-indirect-buffer-display' is `new-frame', the last buffer
6999 is kept so that you can work with several indirect buffers at the same time.
7000 If `org-indirect-buffer-display' is `dedicated-frame', the \
7002 requests that a new frame be made for the new buffer, so that the dedicated
7003 frame is not changed."
7004 (interactive "P")
7005 (let ((cbuf (current-buffer))
7006 (cwin (selected-window))
7007 (pos (point))
7008 beg end level heading ibuf)
7009 (save-excursion
7010 (org-back-to-heading t)
7011 (when (numberp arg)
7012 (setq level (org-outline-level))
7013 (if (< arg 0) (setq arg (+ level arg)))
7014 (while (> (setq level (org-outline-level)) arg)
7015 (outline-up-heading 1 t)))
7016 (setq beg (point)
7017 heading (org-get-heading))
7018 (org-end-of-subtree t t)
7019 (if (org-at-heading-p) (backward-char 1))
7020 (setq end (point)))
7021 (if (and (buffer-live-p org-last-indirect-buffer)
7022 (not (eq org-indirect-buffer-display 'new-frame))
7023 (not arg))
7024 (kill-buffer org-last-indirect-buffer))
7025 (setq ibuf (org-get-indirect-buffer cbuf)
7026 org-last-indirect-buffer ibuf)
7027 (cond
7028 ((or (eq org-indirect-buffer-display 'new-frame)
7029 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7030 (select-frame (make-frame))
7031 (delete-other-windows)
7032 (org-pop-to-buffer-same-window ibuf)
7033 (org-set-frame-title heading))
7034 ((eq org-indirect-buffer-display 'dedicated-frame)
7035 (raise-frame
7036 (select-frame (or (and org-indirect-dedicated-frame
7037 (frame-live-p org-indirect-dedicated-frame)
7038 org-indirect-dedicated-frame)
7039 (setq org-indirect-dedicated-frame (make-frame)))))
7040 (delete-other-windows)
7041 (org-pop-to-buffer-same-window ibuf)
7042 (org-set-frame-title (concat "Indirect: " heading)))
7043 ((eq org-indirect-buffer-display 'current-window)
7044 (org-pop-to-buffer-same-window ibuf))
7045 ((eq org-indirect-buffer-display 'other-window)
7046 (pop-to-buffer ibuf))
7047 (t (error "Invalid value")))
7048 (if (featurep 'xemacs)
7049 (save-excursion (org-mode) (turn-on-font-lock)))
7050 (narrow-to-region beg end)
7051 (show-all)
7052 (goto-char pos)
7053 (run-hook-with-args 'org-cycle-hook 'all)
7054 (and (window-live-p cwin) (select-window cwin))))
7056 (defun org-get-indirect-buffer (&optional buffer)
7057 (setq buffer (or buffer (current-buffer)))
7058 (let ((n 1) (base (buffer-name buffer)) bname)
7059 (while (buffer-live-p
7060 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7061 (setq n (1+ n)))
7062 (condition-case nil
7063 (make-indirect-buffer buffer bname 'clone)
7064 (error (make-indirect-buffer buffer bname)))))
7066 (defun org-set-frame-title (title)
7067 "Set the title of the current frame to the string TITLE."
7068 ;; FIXME: how to name a single frame in XEmacs???
7069 (unless (featurep 'xemacs)
7070 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7072 ;;;; Structure editing
7074 ;;; Inserting headlines
7076 (defun org-previous-line-empty-p ()
7077 (save-excursion
7078 (and (not (bobp))
7079 (or (beginning-of-line 0) t)
7080 (save-match-data
7083 (defun org-insert-heading (&optional force-heading invisible-ok)
7084 "Insert a new heading or item with same depth at point.
7085 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7086 If point is at the beginning of a headline, insert a sibling before the
7087 current headline. If point is not at the beginning, split the line,
7088 create the new headline with the text in the current line after point
7089 \(but see also the variable `org-M-RET-may-split-line').
7091 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7092 This is important for non-interactive uses of the command."
7093 (interactive "P")
7094 (if (or (= (buffer-size) 0)
7095 (and (not (save-excursion
7096 (and (ignore-errors (org-back-to-heading invisible-ok))
7097 (org-at-heading-p))))
7098 (or force-heading (not (org-in-item-p)))))
7099 (progn
7101 (run-hooks 'org-insert-heading-hook))
7102 (when (or force-heading (not (org-insert-item)))
7103 (let* ((empty-line-p nil)
7104 (level nil)
7105 (on-heading (org-at-heading-p))
7106 (head (save-excursion
7107 (condition-case nil
7108 (progn
7109 (org-back-to-heading invisible-ok)
7110 (when (and (not on-heading)
7111 (featurep 'org-inlinetask)
7112 (integerp org-inlinetask-min-level)
7113 (>= (length (match-string 0))
7114 org-inlinetask-min-level))
7115 ;; Find a heading level before the inline task
7116 (while (and (setq level (org-up-heading-safe))
7117 (>= level org-inlinetask-min-level)))
7118 (if (org-at-heading-p)
7119 (org-back-to-heading invisible-ok)
7120 (error "This should not happen")))
7121 (setq empty-line-p (org-previous-line-empty-p))
7122 (match-string 0))
7123 (error "*"))))
7124 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7125 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7126 pos hide-previous previous-pos)
7127 (cond
7128 ((and (org-at-heading-p) (bolp)
7129 (or (bobp)
7130 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7131 ;; insert before the current line
7132 (open-line (if blank 2 1)))
7133 ((and (bolp)
7134 (not org-insert-heading-respect-content)
7135 (or (bobp)
7136 (save-excursion
7137 (backward-char 1) (not (outline-invisible-p)))))
7138 ;; insert right here
7139 nil)
7140 (t
7141 ;; somewhere in the line
7142 (save-excursion
7143 (setq previous-pos (point-at-bol))
7144 (end-of-line)
7145 (setq hide-previous (outline-invisible-p)))
7146 (and org-insert-heading-respect-content (org-show-subtree))
7147 (let ((split
7148 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7149 (save-excursion
7150 (let ((p (point)))
7151 (goto-char (point-at-bol))
7152 (and (looking-at org-complex-heading-regexp)
7153 (match-beginning 4)
7154 (> p (match-beginning 4)))))))
7155 tags pos)
7156 (cond
7157 (org-insert-heading-respect-content
7158 (org-end-of-subtree nil t)
7159 (when (featurep 'org-inlinetask)
7160 (while (and (not (eobp))
7162 (>= (length (match-string 1))
7163 org-inlinetask-min-level))
7164 (org-end-of-subtree nil t)))
7165 (or (bolp) (newline))
7166 (or (org-previous-line-empty-p)
7167 (and blank (newline)))
7168 (open-line 1))
7169 ((org-at-heading-p)
7170 (when hide-previous
7171 (show-children)
7172 (org-show-entry))
7174 (setq tags (and (match-end 2) (match-string 2)))
7175 (and (match-end 1)
7176 (delete-region (match-beginning 1) (match-end 1)))
7177 (setq pos (point-at-bol))
7178 (or split (end-of-line 1))
7179 (delete-horizontal-space)
7181 (buffer-substring (point-at-bol) (point)))
7182 (insert " "))
7183 (newline (if blank 2 1))
7184 (when tags
7185 (save-excursion
7186 (goto-char pos)
7187 (end-of-line 1)
7188 (insert " " tags)
7189 (org-set-tags nil 'align))))
7190 (t
7191 (or split (end-of-line 1))
7192 (newline (if blank 2 1)))))))
7193 (insert head) (just-one-space)
7194 (setq pos (point))
7195 (end-of-line 1)
7196 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7197 (when (and org-insert-heading-respect-content hide-previous)
7198 (save-excursion
7199 (goto-char previous-pos)
7200 (hide-subtree)))
7201 (run-hooks 'org-insert-heading-hook)))))
7203 (defun org-get-heading (&optional no-tags no-todo)
7204 "Return the heading of the current entry, without the stars.
7205 When NO-TAGS is non-nil, don't include tags.
7206 When NO-TODO is non-nil, don't include TODO keywords."
7207 (save-excursion
7208 (org-back-to-heading t)
7209 (cond
7210 ((and no-tags no-todo)
7211 (looking-at org-complex-heading-regexp)
7212 (match-string 4))
7213 (no-tags
7214 (looking-at (concat org-outline-regexp
7217 (match-string 1))
7218 (no-todo
7219 (looking-at org-todo-line-regexp)
7220 (match-string 3))
7221 (t (looking-at org-heading-regexp)
7222 (match-string 2)))))
7224 (defun org-heading-components ()
7225 "Return the components of the current heading.
7226 This is a list with the following elements:
7227 - the level as an integer
7228 - the reduced level, different if `org-odd-levels-only' is set.
7229 - the TODO keyword, or nil
7230 - the priority character, like ?A, or nil if no priority is given
7231 - the headline text itself, or the tags string if no headline text
7232 - the tags string, or nil."
7233 (save-excursion
7234 (org-back-to-heading t)
7235 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7236 (list (length (match-string 1))
7237 (org-reduced-level (length (match-string 1)))
7238 (org-match-string-no-properties 2)
7239 (and (match-end 3) (aref (match-string 3) 2))
7240 (org-match-string-no-properties 4)
7241 (org-match-string-no-properties 5)))))
7243 (defun org-get-entry ()
7244 "Get the entry text, after heading, entire subtree."
7245 (save-excursion
7246 (org-back-to-heading t)
7247 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7249 (defun org-insert-heading-after-current ()
7250 "Insert a new heading with same level as current, after current subtree."
7251 (interactive)
7252 (org-back-to-heading)
7253 (org-insert-heading)
7254 (org-move-subtree-down)
7255 (end-of-line 1))
7257 (defun org-insert-heading-respect-content ()
7258 (interactive)
7259 (let ((org-insert-heading-respect-content t))
7260 (org-insert-heading t)))
7262 (defun org-insert-todo-heading-respect-content (&optional force-state)
7263 (interactive "P")
7264 (let ((org-insert-heading-respect-content t))
7265 (org-insert-todo-heading force-state t)))
7267 (defun org-insert-todo-heading (arg &optional force-heading)
7268 "Insert a new heading with the same level and TODO state as current heading.
7269 If the heading has no TODO state, or if the state is DONE, use the first
7270 state (TODO by default). Also with prefix arg, force first state."
7271 (interactive "P")
7272 (when (or force-heading (not (org-insert-item 'checkbox)))
7273 (org-insert-heading force-heading)
7274 (save-excursion
7275 (org-back-to-heading)
7276 (outline-previous-heading)
7277 (looking-at org-todo-line-regexp))
7278 (let*
7279 ((new-mark-x
7280 (if (or arg
7281 (not (match-beginning 2))
7282 (member (match-string 2) org-done-keywords))
7283 (car org-todo-keywords-1)
7284 (match-string 2)))
7285 (new-mark
7286 (or
7287 (run-hook-with-args-until-success
7288 'org-todo-get-default-hook new-mark-x nil)
7289 new-mark-x)))
7290 (beginning-of-line 1)
7291 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7292 (if org-treat-insert-todo-heading-as-state-change
7293 (org-todo new-mark)
7294 (insert new-mark " "))))
7295 (when org-provide-todo-statistics
7296 (org-update-parent-todo-statistics))))
7298 (defun org-insert-subheading (arg)
7299 "Insert a new subheading and demote it.
7300 Works for outline headings and for plain lists alike."
7301 (interactive "P")
7302 (org-insert-heading arg)
7303 (cond
7304 ((org-at-heading-p) (org-do-demote))
7305 ((org-at-item-p) (org-indent-item))))
7307 (defun org-insert-todo-subheading (arg)
7308 "Insert a new subheading with TODO keyword or checkbox and demote it.
7309 Works for outline headings and for plain lists alike."
7310 (interactive "P")
7311 (org-insert-todo-heading arg)
7312 (cond
7313 ((org-at-heading-p) (org-do-demote))
7314 ((org-at-item-p) (org-indent-item))))
7316 ;;; Promotion and Demotion
7318 (defvar org-after-demote-entry-hook nil
7319 "Hook run after an entry has been demoted.
7320 The cursor will be at the beginning of the entry.
7321 When a subtree is being demoted, the hook will be called for each node.")
7323 (defvar org-after-promote-entry-hook nil
7324 "Hook run after an entry has been promoted.
7325 The cursor will be at the beginning of the entry.
7326 When a subtree is being promoted, the hook will be called for each node.")
7328 (defun org-promote-subtree ()
7329 "Promote the entire subtree.
7330 See also `org-promote'."
7331 (interactive)
7332 (save-excursion
7333 (org-with-limited-levels (org-map-tree 'org-promote)))
7334 (org-fix-position-after-promote))
7336 (defun org-demote-subtree ()
7337 "Demote the entire subtree. See `org-demote'.
7338 See also `org-promote'."
7339 (interactive)
7340 (save-excursion
7341 (org-with-limited-levels (org-map-tree 'org-demote)))
7342 (org-fix-position-after-promote))
7345 (defun org-do-promote ()
7346 "Promote the current heading higher up the tree.
7347 If the region is active in `transient-mark-mode', promote all headings
7348 in the region."
7349 (interactive)
7350 (save-excursion
7351 (if (org-region-active-p)
7352 (org-map-region 'org-promote (region-beginning) (region-end))
7353 (org-promote)))
7354 (org-fix-position-after-promote))
7356 (defun org-do-demote ()
7357 "Demote the current heading lower down the tree.
7358 If the region is active in `transient-mark-mode', demote all headings
7359 in the region."
7360 (interactive)
7361 (save-excursion
7362 (if (org-region-active-p)
7363 (org-map-region 'org-demote (region-beginning) (region-end))
7364 (org-demote)))
7365 (org-fix-position-after-promote))
7367 (defun org-fix-position-after-promote ()
7368 "Make sure that after pro/demotion cursor position is right."
7369 (let ((pos (point)))
7370 (when (save-excursion
7371 (beginning-of-line 1)
7372 (looking-at org-todo-line-regexp)
7373 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7374 (cond ((eobp) (insert " "))
7375 ((eolp) (insert " "))
7376 ((equal (char-after) ?\ ) (forward-char 1))))))
7378 (defun org-current-level ()
7379 "Return the level of the current entry, or nil if before the first headline.
7380 The level is the number of stars at the beginning of the headline."
7381 (save-excursion
7382 (org-with-limited-levels
7383 (if (ignore-errors (org-back-to-heading t))
7384 (funcall outline-level)))))
7386 (defun org-get-previous-line-level ()
7387 "Return the outline depth of the last headline before the current line.
7388 Returns 0 for the first headline in the buffer, and nil if before the
7389 first headline."
7390 (let ((current-level (org-current-level))
7391 (prev-level (when (> (line-number-at-pos) 1)
7392 (save-excursion
7393 (beginning-of-line 0)
7394 (org-current-level)))))
7395 (cond ((null current-level) nil) ; Before first headline
7396 ((null prev-level) 0) ; At first headline
7397 (prev-level))))
7399 (defun org-reduced-level (l)
7400 "Compute the effective level of a heading.
7401 This takes into account the setting of `org-odd-levels-only'."
7402 (cond
7403 ((zerop l) 0)
7404 (org-odd-levels-only (1+ (floor (/ l 2))))
7405 (t l)))
7407 (defun org-level-increment ()
7408 "Return the number of stars that will be added or removed at a
7409 time to headlines when structure editing, based on the value of
7410 `org-odd-levels-only'."
7411 (if org-odd-levels-only 2 1))
7413 (defun org-get-valid-level (level &optional change)
7414 "Rectify a level change under the influence of `org-odd-levels-only'
7415 LEVEL is a current level, CHANGE is by how much the level should be
7416 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7417 even level numbers will become the next higher odd number."
7418 (if org-odd-levels-only
7419 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7420 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7421 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7422 (max 1 (+ level (or change 0)))))
7424 (if (boundp 'define-obsolete-function-alias)
7425 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7426 (define-obsolete-function-alias 'org-get-legal-level
7427 'org-get-valid-level)
7428 (define-obsolete-function-alias 'org-get-legal-level
7429 'org-get-valid-level "23.1")))
7431 (defun org-promote ()
7432 "Promote the current heading higher up the tree.
7433 If the region is active in `transient-mark-mode', promote all headings
7434 in the region."
7435 (org-back-to-heading t)
7436 (let* ((level (save-match-data (funcall outline-level)))
7437 (after-change-functions (remove 'flyspell-after-change-function
7438 after-change-functions))
7439 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7440 (diff (abs (- level (length up-head) -1))))
7441 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7442 (replace-match up-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-promote-entry-hook)))
7448 (defun org-demote ()
7449 "Demote the current heading lower down the tree.
7450 If the region is active in `transient-mark-mode', demote all headings
7451 in the region."
7452 (org-back-to-heading t)
7453 (let* ((level (save-match-data (funcall outline-level)))
7454 (after-change-functions (remove 'flyspell-after-change-function
7455 after-change-functions))
7456 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7457 (diff (abs (- level (length down-head) -1))))
7458 (replace-match down-head nil t)
7459 ;; Fixup tag positioning
7460 (and org-auto-align-tags (org-set-tags nil t))
7461 (if org-adapt-indentation (org-fixup-indentation diff))
7462 (run-hooks 'org-after-demote-entry-hook)))
7464 (defun org-cycle-level ()
7465 "Cycle the level of an empty headline through possible states.
7466 This goes first to child, then to parent, level, then up the hierarchy.
7467 After top level, it switches back to sibling level."
7468 (interactive)
7469 (let ((org-adapt-indentation nil))
7470 (when (org-point-at-end-of-empty-headline)
7471 (setq this-command 'org-cycle-level) ; Only needed for caching
7472 (let ((cur-level (org-current-level))
7473 (prev-level (org-get-previous-line-level)))
7474 (cond
7475 ;; If first headline in file, promote to top-level.
7476 ((= prev-level 0)
7477 (loop repeat (/ (- cur-level 1) (org-level-increment))
7478 do (org-do-promote)))
7479 ;; If same level as prev, demote one.
7480 ((= prev-level cur-level)
7481 (org-do-demote))
7482 ;; If parent is top-level, promote to top level if not already.
7483 ((= prev-level 1)
7484 (loop repeat (/ (- cur-level 1) (org-level-increment))
7485 do (org-do-promote)))
7486 ;; If top-level, return to prev-level.
7487 ((= cur-level 1)
7488 (loop repeat (/ (- prev-level 1) (org-level-increment))
7489 do (org-do-demote)))
7490 ;; If less than prev-level, promote one.
7491 ((< cur-level prev-level)
7492 (org-do-promote))
7493 ;; If deeper than prev-level, promote until higher than
7494 ;; prev-level.
7495 ((> cur-level prev-level)
7496 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7497 do (org-do-promote))))
7498 t))))
7500 (defun org-map-tree (fun)
7501 "Call FUN for every heading underneath the current one."
7502 (org-back-to-heading)
7503 (let ((level (funcall outline-level)))
7504 (save-excursion
7505 (funcall fun)
7506 (while (and (progn
7507 (outline-next-heading)
7508 (> (funcall outline-level) level))
7509 (not (eobp)))
7510 (funcall fun)))))
7512 (defun org-map-region (fun beg end)
7513 "Call FUN for every heading between BEG and END."
7514 (let ((org-ignore-region t))
7515 (save-excursion
7516 (setq end (copy-marker end))
7517 (goto-char beg)
7518 (if (and (re-search-forward org-outline-regexp-bol nil t)
7519 (< (point) end))
7520 (funcall fun))
7521 (while (and (progn
7522 (outline-next-heading)
7523 (< (point) end))
7524 (not (eobp)))
7525 (funcall fun)))))
7527 (defvar org-property-end-re) ; silence byte-compiler
7528 (defun org-fixup-indentation (diff)
7529 "Change the indentation in the current entry by DIFF.
7530 However, if any line in the current entry has no indentation, or if it
7531 would end up with no indentation after the change, nothing at all is done."
7532 (save-excursion
7533 (let ((end (save-excursion (outline-next-heading)
7534 (point-marker)))
7535 (prohibit (if (> diff 0)
7538 col)
7539 (unless (save-excursion (end-of-line 1)
7540 (re-search-forward prohibit end t))
7541 (while (and (< (point) end)
7543 (goto-char (match-end 0))
7544 (setq col (current-column))
7545 (if (< diff 0) (replace-match ""))
7546 (org-indent-to-column (+ diff col))))
7547 (move-marker end nil))))
7549 (defun org-convert-to-odd-levels ()
7550 "Convert an org-mode file with all levels allowed to one with odd levels.
7551 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7552 level 5 etc."
7553 (interactive)
7554 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7555 (let ((outline-level 'org-outline-level)
7556 (org-odd-levels-only nil) n)
7557 (save-excursion
7558 (goto-char (point-min))
7560 (setq n (- (length (match-string 0)) 2))
7561 (while (>= (setq n (1- n)) 0)
7562 (org-demote))
7563 (end-of-line 1))))))
7565 (defun org-convert-to-oddeven-levels ()
7566 "Convert an org-mode file with only odd levels to one with odd/even levels.
7567 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7568 file contains a section with an even level, conversion would
7569 destroy the structure of the file. An error is signaled in this
7570 case."
7571 (interactive)
7572 (goto-char (point-min))
7573 ;; First check if there are no even levels
7575 (org-show-context t)
7576 (error "Not all levels are odd in this file. Conversion not possible"))
7577 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7578 (let ((outline-regexp org-outline-regexp)
7579 (outline-level 'org-outline-level)
7580 (org-odd-levels-only nil) n)
7581 (save-excursion
7582 (goto-char (point-min))
7584 (setq n (/ (1- (length (match-string 0))) 2))
7585 (while (>= (setq n (1- n)) 0)
7586 (org-promote))
7587 (end-of-line 1))))))
7589 (defun org-tr-level (n)
7590 "Make N odd if required."
7591 (if org-odd-levels-only (1+ (/ n 2)) n))
7593 ;;; Vertical tree motion, cutting and pasting of subtrees
7595 (defun org-move-subtree-up (&optional arg)
7596 "Move the current subtree up past ARG headlines of the same level."
7597 (interactive "p")
7598 (org-move-subtree-down (- (prefix-numeric-value arg))))
7600 (defun org-move-subtree-down (&optional arg)
7601 "Move the current subtree down past ARG headlines of the same level."
7602 (interactive "p")
7603 (setq arg (prefix-numeric-value arg))
7604 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7605 'org-get-last-sibling))
7606 (ins-point (make-marker))
7607 (cnt (abs arg))
7608 (col (current-column))
7609 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7610 ;; Select the tree
7611 (org-back-to-heading)
7612 (setq beg0 (point))
7613 (save-excursion
7614 (setq ne-beg (org-back-over-empty-lines))
7615 (setq beg (point)))
7616 (save-match-data
7617 (save-excursion (outline-end-of-heading)
7618 (setq folded (outline-invisible-p)))
7619 (outline-end-of-subtree))
7620 (outline-next-heading)
7621 (setq ne-end (org-back-over-empty-lines))
7622 (setq end (point))
7623 (goto-char beg0)
7624 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7625 ;; include less whitespace
7626 (save-excursion
7627 (goto-char beg)
7628 (forward-line (- ne-beg ne-end))
7629 (setq beg (point))))
7630 ;; Find insertion point, with error handling
7631 (while (> cnt 0)
7632 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7633 (progn (goto-char beg0)
7634 (error "Cannot move past superior level or buffer limit")))
7635 (setq cnt (1- cnt)))
7636 (if (> arg 0)
7637 ;; Moving forward - still need to move over subtree
7638 (progn (org-end-of-subtree t t)
7639 (save-excursion
7640 (org-back-over-empty-lines)
7641 (or (bolp) (newline)))))
7642 (setq ne-ins (org-back-over-empty-lines))
7643 (move-marker ins-point (point))
7644 (setq txt (buffer-substring beg end))
7645 (org-save-markers-in-region beg end)
7646 (delete-region beg end)
7647 (org-remove-empty-overlays-at beg)
7648 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7649 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7651 (let ((bbb (point)))
7652 (insert-before-markers txt)
7653 (org-reinstall-markers-in-region bbb)
7654 (move-marker ins-point bbb))
7656 (setq ins-end (point))
7657 (goto-char ins-point)
7658 (org-skip-whitespace)
7659 (when (and (< arg 0)
7660 (org-first-sibling-p)
7661 (> ne-ins ne-beg))
7662 ;; Move whitespace back to beginning
7663 (save-excursion
7664 (goto-char ins-end)
7665 (let ((kill-whole-line t))
7666 (kill-line (- ne-ins ne-beg)) (point)))
7668 (move-marker ins-point nil)
7669 (if folded
7670 (hide-subtree)
7671 (org-show-entry)
7672 (show-children)
7673 (org-cycle-hide-drawers 'children))
7674 (org-clean-visibility-after-subtree-move)
7675 ;; move back to the initial column we were at
7676 (move-to-column col)))
7678 (defvar org-subtree-clip ""
7679 "Clipboard for cut and paste of subtrees.
7680 This is actually only a copy of the kill, because we use the normal kill
7681 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7683 (defvar org-subtree-clip-folded nil
7684 "Was the last copied subtree folded?
7685 This is used to fold the tree back after pasting.")
7687 (defun org-cut-subtree (&optional n)
7688 "Cut the current subtree into the clipboard.
7689 With prefix arg N, cut this many sequential subtrees.
7690 This is a short-hand for marking the subtree and then cutting it."
7691 (interactive "p")
7692 (org-copy-subtree n 'cut))
7694 (defun org-copy-subtree (&optional n cut force-store-markers)
7695 "Cut the current subtree into the clipboard.
7696 With prefix arg N, cut this many sequential subtrees.
7697 This is a short-hand for marking the subtree and then copying it.
7698 If CUT is non-nil, actually cut the subtree.
7699 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7700 of some markers in the region, even if CUT is non-nil. This is
7701 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7702 (interactive "p")
7703 (let (beg end folded (beg0 (point)))
7704 (if (org-called-interactively-p 'any)
7705 (org-back-to-heading nil) ; take what looks like a subtree
7706 (org-back-to-heading t)) ; take what is really there
7707 (org-back-over-empty-lines)
7708 (setq beg (point))
7710 (save-match-data
7711 (save-excursion (outline-end-of-heading)
7712 (setq folded (outline-invisible-p)))
7713 (condition-case nil
7714 (org-forward-same-level (1- n) t)
7715 (error nil))
7716 (org-end-of-subtree t t))
7717 (org-back-over-empty-lines)
7718 (setq end (point))
7719 (goto-char beg0)
7720 (when (> end beg)
7721 (setq org-subtree-clip-folded folded)
7722 (when (or cut force-store-markers)
7723 (org-save-markers-in-region beg end))
7724 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7725 (setq org-subtree-clip (current-kill 0))
7726 (message "%s: Subtree(s) with %d characters"
7727 (if cut "Cut" "Copied")
7728 (length org-subtree-clip)))))
7730 (defun org-paste-subtree (&optional level tree for-yank)
7731 "Paste the clipboard as a subtree, with modification of headline level.
7732 The entire subtree is promoted or demoted in order to match a new headline
7733 level.
7735 If the cursor is at the beginning of a headline, the same level as
7736 that headline is used to paste the tree
7738 If not, the new level is derived from the *visible* headings
7739 before and after the insertion point, and taken to be the inferior headline
7740 level of the two. So if the previous visible heading is level 3 and the
7741 next is level 4 (or vice versa), level 4 will be used for insertion.
7742 This makes sure that the subtree remains an independent subtree and does
7743 not swallow low level entries.
7745 You can also force a different level, either by using a numeric prefix
7746 argument, or by inserting the heading marker by hand. For example, if the
7749 If optional TREE is given, use this text instead of the kill ring.
7751 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7752 move back over whitespace before inserting, and move point to the end of
7753 the inserted text when done."
7754 (interactive "P")
7755 (setq tree (or tree (and kill-ring (current-kill 0))))
7756 (unless (org-kill-is-subtree-p tree)
7757 (error "%s"
7758 (substitute-command-keys
7760 (org-with-limited-levels
7761 (let* ((visp (not (outline-invisible-p)))
7762 (txt tree)
7764 (old-level (if (string-match org-outline-regexp-bol txt)
7765 (- (match-end 0) (match-beginning 0) 1)
7766 -1))
7767 (force-level (cond (level (prefix-numeric-value level))
7769 (string-match
7771 (point-at-bol) (point))))
7772 (- (match-end 1) (match-beginning 1)))
7773 ((and (bolp)
7774 (looking-at org-outline-regexp))
7775 (- (match-end 0) (point) 1))
7776 (t nil)))
7777 (previous-level (save-excursion
7778 (condition-case nil
7779 (progn
7780 (outline-previous-visible-heading 1)
7781 (if (looking-at ^re_)
7782 (- (match-end 0) (match-beginning 0) 1)
7783 1))
7784 (error 1))))
7785 (next-level (save-excursion
7786 (condition-case nil
7787 (progn
7788 (or (looking-at org-outline-regexp)
7789 (outline-next-visible-heading 1))
7790 (if (looking-at ^re_)
7791 (- (match-end 0) (match-beginning 0) 1)
7792 1))
7793 (error 1))))
7794 (new-level (or force-level (max previous-level next-level)))
7795 (shift (if (or (= old-level -1)
7796 (= new-level -1)
7797 (= old-level new-level))
7798 0
7799 (- new-level old-level)))
7800 (delta (if (> shift 0) -1 1))
7801 (func (if (> shift 0) 'org-demote 'org-promote))
7802 (org-odd-levels-only nil)
7803 beg end newend)
7804 ;; Remove the forced level indicator
7805 (if force-level
7806 (delete-region (point-at-bol) (point)))
7807 ;; Paste
7808 (beginning-of-line (if (bolp) 1 2))
7809 (unless for-yank (org-back-over-empty-lines))
7810 (setq beg (point))
7811 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7812 (insert-before-markers txt)
7814 (setq newend (point))
7815 (org-reinstall-markers-in-region beg)
7816 (setq end (point))
7817 (goto-char beg)
7819 (setq beg (point))
7820 (if (and (outline-invisible-p) visp)
7821 (save-excursion (outline-show-heading)))
7822 ;; Shift if necessary
7823 (unless (= shift 0)
7824 (save-restriction
7825 (narrow-to-region beg end)
7826 (while (not (= shift 0))
7827 (org-map-region func (point-min) (point-max))
7828 (setq shift (+ delta shift)))
7829 (goto-char (point-min))
7830 (setq newend (point-max))))
7831 (when (or (org-called-interactively-p 'interactive) for-yank)
7832 (message "Clipboard pasted as level %d subtree" new-level))
7833 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7834 kill-ring
7835 (eq org-subtree-clip (current-kill 0))
7836 org-subtree-clip-folded)
7837 ;; The tree was folded before it was killed/copied
7838 (hide-subtree))
7839 (and for-yank (goto-char newend)))))
7841 (defun org-kill-is-subtree-p (&optional txt)
7842 "Check if the current kill is an outline subtree, or a set of trees.
7843 Returns nil if kill does not start with a headline, or if the first
7844 headline level is not the largest headline level in the tree.
7845 So this will actually accept several entries of equal levels as well,
7846 which is OK for `org-paste-subtree'.
7847 If optional TXT is given, check this string instead of the current kill."
7848 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7849 (re (org-get-limited-outline-regexp))
7850 (^re (concat "^" re))
7851 (start-level (and kill
7852 (string-match
7854 kill)
7855 (- (match-end 2) (match-beginning 2) 1)))
7856 (start (1+ (or (match-beginning 2) -1))))
7857 (if (not start-level)
7858 (progn
7859 nil) ;; does not even start with a heading
7860 (catch 'exit
7861 (while (setq start (string-match ^re kill (1+ start)))
7862 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7863 (throw 'exit nil)))
7864 t))))
7866 (defvar org-markers-to-move nil
7867 "Markers that should be moved with a cut-and-paste operation.
7868 Those markers are stored together with their positions relative to
7869 the start of the region.")
7871 (defun org-save-markers-in-region (beg end)
7872 "Check markers in region.
7873 If these markers are between BEG and END, record their position relative
7874 to BEG, so that after moving the block of text, we can put the markers back
7875 into place.
7876 This function gets called just before an entry or tree gets cut from the
7877 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7878 called immediately, to move the markers with the entries."
7879 (setq org-markers-to-move nil)
7880 (when (featurep 'org-clock)
7881 (org-clock-save-markers-for-cut-and-paste beg end))
7882 (when (featurep 'org-agenda)
7883 (org-agenda-save-markers-for-cut-and-paste beg end)))
7885 (defun org-check-and-save-marker (marker beg end)
7886 "Check if MARKER is between BEG and END.
7887 If yes, remember the marker and the distance to BEG."
7888 (when (and (marker-buffer marker)
7889 (equal (marker-buffer marker) (current-buffer)))
7890 (if (and (>= marker beg) (< marker end))
7891 (push (cons marker (- marker beg)) org-markers-to-move))))
7893 (defun org-reinstall-markers-in-region (beg)
7894 "Move all remembered markers to their position relative to BEG."
7895 (mapc (lambda (x)
7896 (move-marker (car x) (+ beg (cdr x))))
7897 org-markers-to-move)
7898 (setq org-markers-to-move nil))
7900 (defun org-narrow-to-subtree ()
7901 "Narrow buffer to the current subtree."
7902 (interactive)
7903 (save-excursion
7904 (save-match-data
7905 (org-with-limited-levels
7906 (narrow-to-region
7907 (progn (org-back-to-heading t) (point))
7908 (progn (org-end-of-subtree t t)
7909 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7910 (point)))))))
7912 (defun org-narrow-to-block ()
7913 "Narrow buffer to the current block."
7914 (interactive)
7915 (let* ((case-fold-search t)
7918 (if blockp
7919 (narrow-to-region (car blockp) (cdr blockp))
7920 (error "Not in a block"))))
7922 (eval-when-compile
7923 (defvar org-property-drawer-re))
7925 (defvar org-property-start-re) ;; defined below
7926 (defun org-clone-subtree-with-time-shift (n &optional shift)
7927 "Clone the task (subtree) at point N times.
7928 The clones will be inserted as siblings.
7930 In interactive use, the user will be prompted for the number of
7931 clones to be produced, and for a time SHIFT, which may be a
7932 repeater as used in time stamps, for example `+3d'.
7934 When a valid repeater is given and the entry contains any time
7935 stamps, the clones will become a sequence in time, with time
7936 stamps in the subtree shifted for each clone produced. If SHIFT
7937 is nil or the empty string, time stamps will be left alone. The
7938 ID property of the original subtree is removed.
7940 If the original subtree did contain time stamps with a repeater,
7941 the following will happen:
7942 - the repeater will be removed in each clone
7943 - an additional clone will be produced, with the current, unshifted
7944 date(s) in the entry.
7945 - the original entry will be placed *after* all the clones, with
7946 repeater intact.
7947 - the start days in the repeater in the original entry will be shifted
7948 to past the last clone.
7949 I this way you can spell out a number of instances of a repeating task,
7950 and still retain the repeater to cover future instances of the task."
7951 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7952 (let (beg end template task idprop
7953 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7954 (drawer-re org-drawer-regexp))
7955 (if (not (and (integerp n) (> n 0)))
7956 (error "Invalid number of replications %s" n))
7959 shift)))
7960 (error "Invalid shift specification %s" shift))
7961 (when doshift
7962 (setq shift-n (string-to-number (match-string 1 shift))
7963 shift-what (cdr (assoc (match-string 2 shift)
7964 '(("d" . day) ("w" . week)
7965 ("m" . month) ("y" . year))))))
7966 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7967 (setq nmin 1 nmax n)
7968 (org-back-to-heading t)
7969 (setq beg (point))
7970 (setq idprop (org-entry-get nil "ID"))
7971 (org-end-of-subtree t t)
7973 (setq end (point))
7974 (setq template (buffer-substring beg end))
7975 (when (and doshift
7977 (delete-region beg end)
7978 (setq end beg)
7979 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7980 (goto-char end)
7981 (loop for n from nmin to nmax do
7982 ;; prepare clone
7983 (with-temp-buffer
7984 (insert template)
7985 (org-mode)
7986 (goto-char (point-min))
7987 (org-show-subtree)
7988 (and idprop (if org-clone-delete-id
7989 (org-entry-delete nil "ID")
7990 (org-id-get-create t)))
7991 (unless (= n 0)
7993 (kill-whole-line))
7994 (goto-char (point-min))
7995 (while (re-search-forward drawer-re nil t)
7996 (mapc (lambda (d)
7997 (org-remove-empty-drawer-at d (point))) org-drawers)))
7998 (goto-char (point-min))
7999 (when doshift
8000 (while (re-search-forward org-ts-regexp-both nil t)
8001 (org-timestamp-change (* n shift-n) shift-what))
8002 (unless (= n n-no-remove)
8003 (goto-char (point-min))
8004 (while (re-search-forward org-ts-regexp nil t)
8005 (save-excursion
8006 (goto-char (match-beginning 0))
8008 (delete-region (match-beginning 1) (match-end 1)))))))
8009 (setq task (buffer-string)))
8010 (insert task))
8011 (goto-char beg)))
8013 ;;; Outline Sorting
8015 (defun org-sort (with-case)
8016 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8017 Optional argument WITH-CASE means sort case-sensitively."
8018 (interactive "P")
8019 (cond
8020 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8021 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8022 (t
8023 (org-call-with-arg 'org-sort-entries with-case))))
8025 (defun org-sort-remove-invisible (s)
8026 (remove-text-properties 0 (length s) org-rm-props s)
8027 (while (string-match org-bracket-link-regexp s)
8028 (setq s (replace-match (if (match-end 2)
8029 (match-string 3 s)
8030 (match-string 1 s)) t t s)))
8031 s)
8033 (defvar org-priority-regexp) ; defined later in the file
8035 (defvar org-after-sorting-entries-or-items-hook nil
8036 "Hook that is run after a bunch of entries or items have been sorted.
8037 When children are sorted, the cursor is in the parent line when this
8038 hook gets called. When a region or a plain list is sorted, the cursor
8039 will be in the first entry of the sorted region/list.")
8041 (defun org-sort-entries
8042 (&optional with-case sorting-type getkey-func compare-func property)
8043 "Sort entries on a certain level of an outline tree.
8044 If there is an active region, the entries in the region are sorted.
8045 Else, if the cursor is before the first entry, sort the top-level items.
8046 Else, the children of the entry at point are sorted.
8048 Sorting can be alphabetically, numerically, by date/time as given by
8049 a time stamp, by a property or by priority.
8051 The command prompts for the sorting type unless it has been given to the
8052 function through the SORTING-TYPE argument, which needs to be a character,
8053 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8054 precise meaning of each character:
8056 n Numerically, by converting the beginning of the entry/item to a number.
8057 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8058 t By date/time, either the first active time stamp in the entry, or, if
8059 none exist, by the first inactive one.
8060 s By the scheduled date/time.
8061 d By deadline date/time.
8062 c By creation time, which is assumed to be the first inactive time stamp
8063 at the beginning of a line.
8064 p By priority according to the cookie.
8065 r By the value of a property.
8067 Capital letters will reverse the sort order.
8069 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8070 called with point at the beginning of the record. It must return either
8071 a string or a number that should serve as the sorting key for that record.
8073 Comparing entries ignores case by default. However, with an optional argument
8074 WITH-CASE, the sorting considers case as well."
8075 (interactive "P")
8076 (let ((case-func (if with-case 'identity 'downcase))
8077 start beg end stars re re2
8078 txt what tmp)
8079 ;; Find beginning and end of region to sort
8080 (cond
8081 ((org-region-active-p)
8082 ;; we will sort the region
8083 (setq end (region-end)
8084 what "region")
8085 (goto-char (region-beginning))
8086 (if (not (org-at-heading-p)) (outline-next-heading))
8087 (setq start (point)))
8088 ((or (org-at-heading-p)
8089 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8090 ;; we will sort the children of the current headline
8091 (org-back-to-heading)
8092 (setq start (point)
8093 end (progn (org-end-of-subtree t t)
8095 (org-back-over-empty-lines)
8096 (point))
8097 what "children")
8098 (goto-char start)
8099 (show-subtree)
8100 (outline-next-heading))
8101 (t
8102 ;; we will sort the top-level entries in this file
8103 (goto-char (point-min))
8104 (or (org-at-heading-p) (outline-next-heading))
8105 (setq start (point))
8106 (goto-char (point-max))
8107 (beginning-of-line 1)
8109 ;; File ends in a non-white line
8110 (end-of-line 1)
8112 (setq end (point-max))
8113 (setq what "top-level")
8114 (goto-char start)
8115 (show-all)))
8117 (setq beg (point))
8118 (if (>= beg end) (error "Nothing to sort"))
8121 (setq stars (match-string 1)
8122 re (concat "^" (regexp-quote stars) " +")
8124 txt (buffer-substring beg end))
8126 (if (and (not (equal stars "*")) (string-match re2 txt))
8127 (error "Region to sort contains a level above the first entry"))
8129 (unless sorting-type
8130 (message
8131 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8133 A/N/T/S/D/C/P/O/F means reversed:"
8134 what)
8135 (setq sorting-type (read-char-exclusive))
8137 (and (= (downcase sorting-type) ?f)
8138 (setq getkey-func
8139 (org-icompleting-read "Sort using function: "
8140 obarray 'fboundp t nil nil))
8141 (setq getkey-func (intern getkey-func)))
8143 (and (= (downcase sorting-type) ?r)
8144 (setq property
8145 (org-icompleting-read "Property: "
8146 (mapcar 'list (org-buffer-property-keys t))
8147 nil t))))
8149 (message "Sorting entries...")
8151 (save-restriction
8152 (narrow-to-region start end)
8153 (let ((dcst (downcase sorting-type))
8154 (case-fold-search nil)
8155 (now (current-time)))
8156 (sort-subr
8157 (/= dcst sorting-type)
8158 ;; This function moves to the beginning character of the "record" to
8159 ;; be sorted.
8160 (lambda nil
8161 (if (re-search-forward re nil t)
8162 (goto-char (match-beginning 0))
8163 (goto-char (point-max))))
8164 ;; This function moves to the last character of the "record" being
8165 ;; sorted.
8166 (lambda nil
8167 (save-match-data
8168 (condition-case nil
8169 (outline-forward-same-level 1)
8170 (error
8171 (goto-char (point-max))))))
8172 ;; This function returns the value that gets sorted against.
8173 (lambda nil
8174 (cond
8175 ((= dcst ?n)
8176 (if (looking-at org-complex-heading-regexp)
8177 (string-to-number (match-string 4))
8178 nil))
8179 ((= dcst ?a)
8180 (if (looking-at org-complex-heading-regexp)
8181 (funcall case-func (match-string 4))
8182 nil))
8183 ((= dcst ?t)
8184 (let ((end (save-excursion (outline-next-heading) (point))))
8185 (if (or (re-search-forward org-ts-regexp end t)
8186 (re-search-forward org-ts-regexp-both end t))
8187 (org-time-string-to-seconds (match-string 0))
8188 (org-float-time now))))
8189 ((= dcst ?c)
8190 (let ((end (save-excursion (outline-next-heading) (point))))
8191 (if (re-search-forward
8193 end t)
8194 (org-time-string-to-seconds (match-string 0))
8195 (org-float-time now))))
8196 ((= dcst ?s)
8197 (let ((end (save-excursion (outline-next-heading) (point))))
8198 (if (re-search-forward org-scheduled-time-regexp end t)
8199 (org-time-string-to-seconds (match-string 1))
8200 (org-float-time now))))
8201 ((= dcst ?d)
8202 (let ((end (save-excursion (outline-next-heading) (point))))
8203 (if (re-search-forward org-deadline-time-regexp end t)
8204 (org-time-string-to-seconds (match-string 1))
8205 (org-float-time now))))
8206 ((= dcst ?p)
8207 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8208 (string-to-char (match-string 2))
8209 org-default-priority))
8210 ((= dcst ?r)
8211 (or (org-entry-get nil property) ""))
8212 ((= dcst ?o)
8213 (if (looking-at org-complex-heading-regexp)
8214 (- 9999 (length (member (match-string 2)
8215 org-todo-keywords-1)))))
8216 ((= dcst ?f)
8217 (if getkey-func
8218 (progn
8219 (setq tmp (funcall getkey-func))
8220 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8221 tmp)
8222 (error "Invalid key function `%s'" getkey-func)))
8223 (t (error "Invalid sorting type `%c'" sorting-type))))
8224 nil
8225 (cond
8226 ((= dcst ?a) 'string<)
8227 ((= dcst ?f) compare-func)
8228 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8229 (t nil)))))
8230 (run-hooks 'org-after-sorting-entries-or-items-hook)
8231 (message "Sorting entries...done")))
8233 (defun org-do-sort (table what &optional with-case sorting-type)
8234 "Sort TABLE of WHAT according to SORTING-TYPE.
8235 The user will be prompted for the SORTING-TYPE if the call to this
8236 function does not specify it. WHAT is only for the prompt, to indicate
8237 what is being sorted. The sorting key will be extracted from
8238 the car of the elements of the table.
8239 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8240 (unless sorting-type
8241 (message
8242 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8243 what)
8244 (setq sorting-type (read-char-exclusive)))
8245 (let ((dcst (downcase sorting-type))
8246 extractfun comparefun)
8247 ;; Define the appropriate functions
8248 (cond
8249 ((= dcst ?n)
8250 (setq extractfun 'string-to-number
8251 comparefun (if (= dcst sorting-type) '< '>)))
8252 ((= dcst ?a)
8253 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8254 (lambda(x) (downcase (org-sort-remove-invisible x))))
8255 comparefun (if (= dcst sorting-type)
8256 'string<
8257 (lambda (a b) (and (not (string< a b))
8258 (not (string= a b)))))))
8259 ((= dcst ?t)
8260 (setq extractfun
8261 (lambda (x)
8262 (if (or (string-match org-ts-regexp x)
8263 (string-match org-ts-regexp-both x))
8264 (org-float-time
8265 (org-time-string-to-time (match-string 0 x)))
8266 0))
8267 comparefun (if (= dcst sorting-type) '< '>)))
8268 (t (error "Invalid sorting type `%c'" sorting-type)))
8270 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8271 table)
8272 (lambda (a b) (funcall comparefun (car a) (car b))))))
8275 ;;; The orgstruct minor mode
8277 ;; Define a minor mode which can be used in other modes in order to
8278 ;; integrate the org-mode structure editing commands.
8280 ;; This is really a hack, because the org-mode structure commands use
8281 ;; keys which normally belong to the major mode. Here is how it
8282 ;; works: The minor mode defines all the keys necessary to operate the
8283 ;; structure commands, but wraps the commands into a function which
8284 ;; tests if the cursor is currently at a headline or a plain list
8285 ;; item. If that is the case, the structure command is used,
8286 ;; temporarily setting many Org-mode variables like regular
8287 ;; expressions for filling etc. However, when any of those keys is
8288 ;; used at a different location, function uses `key-binding' to look
8289 ;; up if the key has an associated command in another currently active
8290 ;; keymap (minor modes, major mode, global), and executes that
8291 ;; command. There might be problems if any of the keys is otherwise
8292 ;; used as a prefix key.
8294 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8295 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8296 ;; addresses this by checking explicitly for both bindings.
8298 (defvar orgstruct-mode-map (make-sparse-keymap)
8299 "Keymap for the minor `orgstruct-mode'.")
8301 (defvar org-local-vars nil
8302 "List of local variables, for use by `orgstruct-mode'.")
8304 ;;;###autoload
8305 (define-minor-mode orgstruct-mode
8306 "Toggle the minor mode `orgstruct-mode'.
8307 This mode is for using Org-mode structure commands in other
8308 modes. The following keys behave as if Org-mode were active, if
8309 the cursor is on a headline, or on a plain list item (both as
8310 defined by Org-mode).
8312 M-up Move entry/item up
8313 M-down Move entry/item down
8314 M-left Promote
8315 M-right Demote
8316 M-S-up Move entry/item up
8317 M-S-down Move entry/item down
8318 M-S-left Promote subtree
8319 M-S-right Demote subtree
8320 M-q Fill paragraph and items like in Org-mode
8321 C-c ^ Sort entries
8322 C-c - Cycle list bullet
8323 TAB Cycle item visibility
8324 M-RET Insert new heading/item
8325 S-M-RET Insert new TODO heading / Checkbox item
8326 C-c C-c Set tags / toggle checkbox"
8327 nil " OrgStruct" nil
8328 (org-load-modules-maybe)
8329 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8331 ;;;###autoload
8332 (defun turn-on-orgstruct ()
8333 "Unconditionally turn on `orgstruct-mode'."
8334 (orgstruct-mode 1))
8336 (defun orgstruct++-mode (&optional arg)
8337 "Toggle `orgstruct-mode', the enhanced version of it.
8338 In addition to setting orgstruct-mode, this also exports all indentation
8339 and autofilling variables from org-mode into the buffer. It will also
8340 recognize item context in multiline items.
8341 Note that turning off orgstruct-mode will *not* remove the
8342 indentation/paragraph settings. This can only be done by refreshing the
8344 (interactive "P")
8345 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8346 (if (< arg 1)
8347 (orgstruct-mode -1)
8348 (orgstruct-mode 1)
8349 (let (var val)
8350 (mapc
8351 (lambda (x)
8352 (when (string-match
8354 (symbol-name (car x)))
8355 (setq var (car x) val (nth 1 x))
8356 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8357 org-local-vars)
8358 (org-set-local 'orgstruct-is-++ t))))
8360 (defvar orgstruct-is-++ nil
8361 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8362 (make-variable-buffer-local 'orgstruct-is-++)
8364 ;;;###autoload
8365 (defun turn-on-orgstruct++ ()
8366 "Unconditionally turn on `orgstruct++-mode'."
8367 (orgstruct++-mode 1))
8369 (defun orgstruct-error ()
8370 "Error when there is no default binding for a structure key."
8371 (interactive)
8372 (error "This key has no function outside structure elements"))
8374 (defun orgstruct-setup ()
8375 "Setup orgstruct keymaps."
8376 (let ((nfunc 0)
8377 (bindings
8378 (list
8379 '([(meta up)] org-metaup)
8380 '([(meta down)] org-metadown)
8381 '([(meta left)] org-metaleft)
8382 '([(meta right)] org-metaright)
8383 '([(meta shift up)] org-shiftmetaup)
8384 '([(meta shift down)] org-shiftmetadown)
8385 '([(meta shift left)] org-shiftmetaleft)
8386 '([(meta shift right)] org-shiftmetaright)
8387 '([?\e (up)] org-metaup)
8388 '([?\e (down)] org-metadown)
8389 '([?\e (left)] org-metaleft)
8390 '([?\e (right)] org-metaright)
8391 '([?\e (shift up)] org-shiftmetaup)
8392 '([?\e (shift down)] org-shiftmetadown)
8393 '([?\e (shift left)] org-shiftmetaleft)
8394 '([?\e (shift right)] org-shiftmetaright)
8395 '([(shift up)] org-shiftup)
8396 '([(shift down)] org-shiftdown)
8397 '([(shift left)] org-shiftleft)
8398 '([(shift right)] org-shiftright)
8399 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8400 '("\M-q" fill-paragraph)
8401 '("\C-c^" org-sort)
8402 '("\C-c-" org-cycle-list-bullet)))
8403 elt key fun cmd)
8404 (while (setq elt (pop bindings))
8405 (setq nfunc (1+ nfunc))
8406 (setq key (org-key (car elt))
8407 fun (nth 1 elt)
8408 cmd (orgstruct-make-binding fun nfunc key))
8409 (org-defkey orgstruct-mode-map key cmd))
8411 ;; Special treatment needed for TAB and RET
8412 (org-defkey orgstruct-mode-map [(tab)]
8413 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8414 (org-defkey orgstruct-mode-map "\C-i"
8415 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8417 (org-defkey orgstruct-mode-map "\M-\C-m"
8418 (orgstruct-make-binding 'org-insert-heading 105
8419 "\M-\C-m" [(meta return)]))
8420 (org-defkey orgstruct-mode-map [(meta return)]
8421 (orgstruct-make-binding 'org-insert-heading 106
8422 [(meta return)] "\M-\C-m"))
8424 (org-defkey orgstruct-mode-map [(shift meta return)]
8425 (orgstruct-make-binding 'org-insert-todo-heading 107
8426 [(meta return)] "\M-\C-m"))
8428 (org-defkey orgstruct-mode-map "\e\C-m"
8429 (orgstruct-make-binding 'org-insert-heading 108
8430 "\e\C-m" [?\e (return)]))
8431 (org-defkey orgstruct-mode-map [?\e (return)]
8432 (orgstruct-make-binding 'org-insert-heading 109
8433 [?\e (return)] "\e\C-m"))
8434 (org-defkey orgstruct-mode-map [?\e (shift return)]
8435 (orgstruct-make-binding 'org-insert-todo-heading 110
8436 [?\e (return)] "\e\C-m"))
8438 (unless org-local-vars
8439 (setq org-local-vars (org-get-local-variables)))
8441 t))
8443 (defun orgstruct-make-binding (fun n &rest keys)
8444 "Create a function for binding in the structure minor mode.
8445 FUN is the command to call inside a table. N is used to create a unique
8446 command name. KEYS are keys that should be checked in for a command
8447 to execute outside of tables."
8448 (eval
8449 (list 'defun
8450 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8451 '(arg)
8453 "Outside of structure, run the binding of `"
8454 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8455 "'.")
8456 '(interactive "p")
8457 (list 'if
8458 `(org-context-p 'headline 'item
8459 (and orgstruct-is-++
8460 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8461 'item-body))
8462 (list 'org-run-like-in-org-mode (list 'quote fun))
8463 (list 'let '(orgstruct-mode)
8464 (list 'call-interactively
8465 (append '(or)
8466 (mapcar (lambda (k)
8467 (list 'key-binding k))
8468 keys)
8469 '('orgstruct-error))))))))
8471 (defun org-context-p (&rest contexts)
8472 "Check if local context is any of CONTEXTS.
8473 Possible values in the list of contexts are `table', `headline', and `item'."
8474 (let ((pos (point)))
8475 (goto-char (point-at-bol))
8476 (prog1 (or (and (memq 'table contexts)
8478 (and (memq 'headline contexts)
8479 (looking-at org-outline-regexp))
8480 (and (memq 'item contexts)
8482 (and (memq 'item-body contexts)
8483 (org-in-item-p)))
8484 (goto-char pos))))
8486 (defun org-get-local-variables ()
8487 "Return a list of all local variables in an org-mode buffer."
8488 (let (varlist)
8489 (with-current-buffer (get-buffer-create "*Org tmp*")
8490 (erase-buffer)
8491 (org-mode)
8492 (setq varlist (buffer-local-variables)))
8493 (kill-buffer "*Org tmp*")
8494 (delq nil
8495 (mapcar
8496 (lambda (x)
8497 (setq x
8498 (if (symbolp x)
8499 (list x)
8500 (list (car x) (list 'quote (cdr x)))))
8501 (if (string-match
8502 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8503 (symbol-name (car x)))
8504 x nil))
8505 varlist))))
8507 (defun org-clone-local-variables (from-buffer &optional regexp)
8508 "Clone local variables from FROM-BUFFER.
8509 Optional argument REGEXP selects variables to clone."
8510 (mapc
8511 (lambda (pair)
8512 (and (symbolp (car pair))
8513 (or (null regexp)
8514 (string-match regexp (symbol-name (car pair))))
8515 (set (make-local-variable (car pair))
8516 (cdr pair))))
8517 (buffer-local-variables from-buffer)))
8519 ;;;###autoload
8520 (defun org-run-like-in-org-mode (cmd)
8521 "Run a command, pretending that the current buffer is in Org-mode.
8522 This will temporarily bind local variables that are typically bound in
8523 Org-mode to the values they have in Org-mode, and then interactively
8524 call CMD."
8525 (org-load-modules-maybe)
8526 (unless org-local-vars
8527 (setq org-local-vars (org-get-local-variables)))
8528 (eval (list 'let org-local-vars
8529 (list 'call-interactively (list 'quote cmd)))))
8531 ;;;; Archiving
8533 (defun org-get-category (&optional pos force-refresh)
8534 "Get the category applying to position POS."
8535 (if force-refresh (org-refresh-category-properties))
8536 (let ((pos (or pos (point))))
8537 (or (get-text-property pos 'org-category)
8538 (progn (org-refresh-category-properties)
8539 (get-text-property pos 'org-category)))))
8541 (defun org-refresh-category-properties ()
8542 "Refresh category text properties in the buffer."
8543 (let ((def-cat (cond
8544 ((null org-category)
8545 (if buffer-file-name
8546 (file-name-sans-extension
8547 (file-name-nondirectory buffer-file-name))
8548 "???"))
8549 ((symbolp org-category) (symbol-name org-category))
8550 (t org-category)))
8551 beg end cat pos optionp)
8552 (org-unmodified
8553 (save-excursion
8554 (save-restriction
8555 (widen)
8556 (goto-char (point-min))
8557 (put-text-property (point) (point-max) 'org-category def-cat)
8558 (while (re-search-forward
8560 (setq pos (match-end 0)
8561 optionp (equal (char-after (match-beginning 0)) ?#)
8562 cat (org-trim (match-string 2)))
8563 (if optionp
8564 (setq beg (point-at-bol) end (point-max))
8565 (org-back-to-heading t)
8566 (setq beg (point) end (org-end-of-subtree t t)))
8567 (put-text-property beg end 'org-category cat)
8568 (put-text-property beg end 'org-category-position beg)
8569 (goto-char pos)))))))
8572 ;;;; Link Stuff
8574 ;;; Link abbreviations
8576 (defun org-link-expand-abbrev (link)
8577 "Apply replacements as defined in `org-link-abbrev-alist."
8579 (let* ((key (match-string 1 link))
8580 (as (or (assoc key org-link-abbrev-alist-local)
8581 (assoc key org-link-abbrev-alist)))
8582 (tag (and (match-end 2) (match-string 3 link)))
8583 rpl)
8584 (if (not as)
8585 link
8586 (setq rpl (cdr as))
8587 (cond
8588 ((symbolp rpl) (funcall rpl tag))
8589 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8590 ((string-match "%h" rpl)
8591 (replace-match (url-hexify-string (or tag "")) t t rpl))
8592 (t (concat rpl tag)))))
8593 link))
8595 ;;; Storing and inserting links
8597 (defvar org-insert-link-history nil
8598 "Minibuffer history for links inserted with `org-insert-link'.")
8600 (defvar org-stored-links nil
8601 "Contains the links stored with `org-store-link'.")
8603 (defvar org-store-link-plist nil
8604 "Plist with info about the most recently link created with `org-store-link'.")
8606 (defvar org-link-protocols nil
8607 "Link protocols added to Org-mode using `org-add-link-type'.")
8609 (defvar org-store-link-functions nil
8610 "List of functions that are called to create and store a link.
8611 Each function will be called in turn until one returns a non-nil
8612 value. Each function should check if it is responsible for creating
8613 this link (for example by looking at the major mode).
8614 If not, it must exit and return nil.
8615 If yes, it should return a non-nil value after a calling
8616 `org-store-link-props' with a list of properties and values.
8617 Special properties are:
8621 This is obligatory as well.
8622 :description Optional default description for the second pair
8623 of brackets in an Org-mode link. The user can still change
8624 this when inserting this link into an Org-mode buffer.
8626 In addition to these, any additional properties can be specified
8627 and then used in remember templates.")
8629 (defun org-add-link-type (type &optional follow export)
8630 "Add TYPE to the list of `org-link-types'.
8631 Re-compute all regular expressions depending on `org-link-types'
8633 FOLLOW and EXPORT are two functions.
8635 FOLLOW should take the link path as the single argument and do whatever
8636 is necessary to follow the link, for example find a file or display
8637 a mail message.
8639 EXPORT should format the link path for export to one of the export formats.
8640 It should be a function accepting three arguments:
8643 desc the description of the link, if any, or a description added by
8644 org-export-normalize-links if there is none
8645 format the export format, a symbol like `html' or `latex' or `ascii'..
8647 The function may use the FORMAT information to return different values
8648 depending on the format. The return value will be put literally into
8649 the exported file. If the return value is nil, this means Org should
8650 do what it normally does with links which do not have EXPORT defined.
8652 Org-mode has a built-in default for exporting links. If you are happy with
8653 this default, there is no need to define an export function for the link
8654 type. For a simple example of an export function, see `org-bbdb.el'."
8655 (add-to-list 'org-link-types type t)
8656 (org-make-link-regexps)
8657 (if (assoc type org-link-protocols)
8658 (setcdr (assoc type org-link-protocols) (list follow export))
8659 (push (list type follow export) org-link-protocols)))
8661 (defvar org-agenda-buffer-name)
8663 ;;;###autoload
8664 (defun org-store-link (arg)
8666 This link is added to `org-stored-links' and can later be inserted
8669 For some link types, a prefix arg is interpreted:
8670 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8671 For file links, arg negates `org-context-in-file-links'."
8672 (interactive "P")
8673 (org-load-modules-maybe)
8674 (setq org-store-link-plist nil) ; reset
8675 (org-with-limited-levels
8676 (let (link cpltxt desc description search txt custom-id agenda-link)
8677 (cond
8679 ((run-hook-with-args-until-success 'org-store-link-functions)
8680 (setq link (plist-get org-store-link-plist :link)
8681 desc (or (plist-get org-store-link-plist :description) link)))
8683 ((equal (buffer-name) "*Org Edit Src Example*")
8684 (let (label gc)
8685 (while (or (not label)
8686 (save-excursion
8687 (save-restriction
8688 (widen)
8689 (goto-char (point-min))
8690 (re-search-forward
8691 (regexp-quote (format org-coderef-label-format label))
8692 nil t))))
8693 (when label (message "Label exists already") (sit-for 2))
8694 (setq label (read-string "Code line label: " label)))
8695 (end-of-line 1)
8696 (setq link (format org-coderef-label-format label))
8697 (setq gc (- 79 (length link)))
8698 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8699 (insert link)
8700 (setq link (concat "(" label ")") desc nil)))
8702 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8703 ;; We are in the agenda, link to referenced location
8704 (let ((m (or (get-text-property (point) 'org-hd-marker)
8705 (get-text-property (point) 'org-marker))))
8706 (when m
8707 (org-with-point-at m
8708 (setq agenda-link
8709 (if (org-called-interactively-p 'any)
8710 (call-interactively 'org-store-link)
8711 (org-store-link nil)))))))
8713 ((eq major-mode 'calendar-mode)
8714 (let ((cd (calendar-cursor-to-date)))
8715 (setq link
8716 (format-time-string
8717 (car org-time-stamp-formats)
8718 (apply 'encode-time
8719 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8720 nil nil nil))))
8721 (org-store-link-props :type "calendar" :date cd)))
8723 ((eq major-mode 'w3-mode)
8724 (setq cpltxt (if (and (buffer-name)
8725 (not (string-match "Untitled" (buffer-name))))
8726 (buffer-name)
8727 (url-view-url t))
8728 link (org-make-link (url-view-url t)))
8729 (org-store-link-props :type "w3" :url (url-view-url t)))
8731 ((eq major-mode 'w3m-mode)
8732 (setq cpltxt (or w3m-current-title w3m-current-url)
8733 link (org-make-link w3m-current-url))
8734 (org-store-link-props :type "w3m" :url (url-view-url t)))
8736 ((setq search (run-hook-with-args-until-success
8737 'org-create-file-search-functions))
8738 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8739 "::" search))
8740 (setq cpltxt (or description link)))
8742 ((eq major-mode 'image-mode)
8743 (setq cpltxt (concat "file:"
8744 (abbreviate-file-name buffer-file-name))
8745 link (org-make-link cpltxt))
8746 (org-store-link-props :type "image" :file buffer-file-name))
8748 ((eq major-mode 'dired-mode)
8749 ;; link to the file in the current line
8750 (let ((file (dired-get-filename nil t)))
8751 (setq file (if file
8752 (abbreviate-file-name
8753 (expand-file-name (dired-get-filename nil t)))
8754 ;; otherwise, no file so use current directory.
8755 default-directory))
8756 (setq cpltxt (concat "file:" file)
8757 link (org-make-link cpltxt))))
8759 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8760 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8761 (cond
8763 (setq cpltxt
8764 (concat "file:"
8765 (abbreviate-file-name
8766 (buffer-file-name (buffer-base-buffer)))
8767 "::" (match-string 1))
8768 link (org-make-link cpltxt)))
8769 ((and (featurep 'org-id)
8770 (or (eq org-link-to-org-use-id t)
8771 (and (eq org-link-to-org-use-id 'create-if-interactive)
8772 (org-called-interactively-p 'any))
8773 (and (eq org-link-to-org-use-id
8774 'create-if-interactive-and-no-custom-id)
8775 (org-called-interactively-p 'any)
8776 (not custom-id))
8777 (and org-link-to-org-use-id
8778 (org-entry-get nil "ID"))))
8779 ;; We can make a link using the ID.
8780 (setq link (condition-case nil
8781 (prog1 (org-id-store-link)
8782 (setq desc (plist-get org-store-link-plist
8783 :description)))
8784 (error
8785 ;; probably before first headline, link to file only
8786 (concat "file:"
8787 (abbreviate-file-name
8788 (buffer-file-name (buffer-base-buffer))))))))
8789 (t
8790 ;; Just link to current headline
8791 (setq cpltxt (concat "file:"
8792 (abbreviate-file-name
8793 (buffer-file-name (buffer-base-buffer)))))
8794 ;; Add a context search string
8795 (when (org-xor org-context-in-file-links arg)
8796 (setq txt (cond
8797 ((org-at-heading-p) nil)
8798 ((org-region-active-p)
8799 (buffer-substring (region-beginning) (region-end)))
8800 (t nil)))
8802 (setq cpltxt
8803 (concat cpltxt "::"
8804 (condition-case nil
8805 (org-make-org-heading-search-string txt)
8806 (error "")))
8807 desc (or (nth 4 (ignore-errors
8808 (org-heading-components))) "NONE"))))
8810 (setq cpltxt (substring cpltxt 0 -2)))
8811 (setq link (org-make-link cpltxt)))))
8813 ((buffer-file-name (buffer-base-buffer))
8814 ;; Just link to this file here.
8815 (setq cpltxt (concat "file:"
8816 (abbreviate-file-name
8817 (buffer-file-name (buffer-base-buffer)))))
8818 ;; Add a context string
8819 (when (org-xor org-context-in-file-links arg)
8820 (setq txt (if (org-region-active-p)
8821 (buffer-substring (region-beginning) (region-end))
8822 (buffer-substring (point-at-bol) (point-at-eol))))
8823 ;; Only use search option if there is some text.
8825 (setq cpltxt
8826 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8827 desc "NONE")))
8828 (setq link (org-make-link cpltxt)))
8830 ((org-called-interactively-p 'interactive)
8831 (error "Cannot link to a buffer which is not visiting a file"))
8833 (t (setq link nil)))
8835 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8836 (setq link (or link cpltxt)
8837 desc (or desc cpltxt))
8838 (if (equal desc "NONE") (setq desc nil))
8840 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8841 (progn
8842 (setq org-stored-links
8843 (cons (list link desc) org-stored-links))
8844 (message "Stored: %s" (or desc link))
8845 (when custom-id
8846 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8847 "::#" custom-id))
8848 (setq org-stored-links
8849 (cons (list link desc) org-stored-links))))
8850 (or agenda-link (and link (org-make-link-string link desc)))))))
8852 (defun org-store-link-props (&rest plist)
8853 "Store link properties, extract names and addresses."
8854 (let (x adr)
8855 (when (setq x (plist-get plist :from))
8856 (setq adr (mail-extract-address-components x))
8857 (setq plist (plist-put plist :fromname (car adr)))
8858 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8859 (when (setq x (plist-get plist :to))
8860 (setq adr (mail-extract-address-components x))
8861 (setq plist (plist-put plist :toname (car adr)))
8862 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8863 (let ((from (plist-get plist :from))
8864 (to (plist-get plist :to)))
8865 (when (and from to org-from-is-user-regexp)
8866 (setq plist
8867 (plist-put plist :fromto
8868 (if (string-match org-from-is-user-regexp from)
8869 (concat "to %t")
8870 (concat "from %f"))))))
8871 (setq org-store-link-plist plist))
8873 (defun org-add-link-props (&rest plist)
8874 "Add these properties to the link property list."
8875 (let (key value)
8876 (while plist
8877 (setq key (pop plist) value (pop plist))
8878 (setq org-store-link-plist
8879 (plist-put org-store-link-plist key value)))))
8881 (defun org-email-link-description (&optional fmt)
8882 "Return the description part of an email link.
8883 This takes information from `org-store-link-plist' and formats it
8884 according to FMT (default from `org-email-link-description-format')."
8885 (setq fmt (or fmt org-email-link-description-format))
8886 (let* ((p org-store-link-plist)
8887 (to (plist-get p :toaddress))
8888 (from (plist-get p :fromaddress))
8889 (table
8890 (list
8891 (cons "%c" (plist-get p :fromto))
8892 (cons "%F" (plist-get p :from))
8893 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8894 (cons "%T" (plist-get p :to))
8895 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8896 (cons "%s" (plist-get p :subject))
8897 (cons "%d" (plist-get p :date))
8898 (cons "%m" (plist-get p :message-id)))))
8899 (when (string-match "%c" fmt)
8900 ;; Check if the user wrote this message
8901 (if (and org-from-is-user-regexp from to
8902 (save-match-data (string-match org-from-is-user-regexp from)))
8903 (setq fmt (replace-match "to %t" t t fmt))
8904 (setq fmt (replace-match "from %f" t t fmt))))
8905 (org-replace-escapes fmt table)))
8907 (defun org-make-org-heading-search-string (&optional string heading)
8908 "Make search string for STRING or current headline."
8909 (interactive)
8910 (let ((s (or string (org-get-heading)))
8911 (lines org-context-in-file-links))
8912 (unless (and string (not heading))
8913 ;; We are using a headline, clean up garbage in there.
8914 (if (string-match org-todo-regexp s)
8915 (setq s (replace-match "" t t s)))
8917 (setq s (replace-match "" t t s)))
8918 (setq s (org-trim s))
8921 (setq s (replace-match "" t t s)))
8922 (while (string-match org-ts-regexp s)
8923 (setq s (replace-match "" t t s))))
8924 (or string (setq s (concat "*" s))) ; Add * for headlines
8925 (when (and string (integerp lines) (> lines 0))
8927 (when (< lines (length slines))
8928 (setq s (mapconcat
8929 'identity
8930 (reverse (nthcdr (- (length slines) lines)
8934 (defun org-make-link (&rest strings)
8935 "Concatenate STRINGS."
8936 (apply 'concat strings))
8938 (defun org-make-link-string (link &optional description)
8939 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8941 (error "Empty link"))
8942 (when (and description
8943 (stringp description)
8945 (setq description nil))
8946 (when (stringp description)
8947 ;; Remove brackets from the description, they are fatal.
8949 (setq description (replace-match "{" t t description)))
8951 (setq description (replace-match "}" t t description))))
8952 (when (equal link description)
8953 ;; No description needed, it is identical
8954 (setq description nil))
8955 (when (and (not description)
8956 (not (string-match (org-image-file-name-regexp) link))
8957 (not (equal link (org-link-escape link))))
8958 (setq description (org-extract-attributes link)))
8959 (setq link
8960 (cond ((string-match (org-image-file-name-regexp) link) link)
8961 ((string-match org-link-types-re link)
8962 (concat (match-string 1 link)
8963 (org-link-escape (substring link (match-end 1)))))
8964 (t (org-link-escape link))))
8965 (concat "[[" link "]"
8966 (if description (concat "[" description "]") "")
8967 "]"))
8969 (defconst org-link-escape-chars
8970 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8971 "List of characters that should be escaped in link.
8972 This is the list that is used for internal purposes.")
8974 (defvar org-url-encoding-use-url-hexify nil)
8976 (defconst org-link-escape-chars-browser
8977 '(?\ )
8978 "List of escapes for characters that are problematic in links.
8979 This is the list that is used before handing over to the browser.")
8981 (defun org-link-escape (text &optional table merge)
8982 "Return percent escaped representation of TEXT.
8983 TEXT is a string with the text to escape.
8984 Optional argument TABLE is a list with characters that should be
8985 escaped. When nil, `org-link-escape-chars' is used.
8986 If optional argument MERGE is set, merge TABLE into
8987 `org-link-escape-chars'."
8988 (if (and org-url-encoding-use-url-hexify (not table))
8989 (url-hexify-string text)
8990 (cond
8991 ((and table merge)
8992 (mapc (lambda (defchr)
8993 (unless (member defchr table)
8994 (setq table (cons defchr table)))) org-link-escape-chars))
8995 ((null table)
8996 (setq table org-link-escape-chars)))
8997 (mapconcat
8998 (lambda (char)
8999 (if (or (member char table)
9000 (< char 32) (= char 37) (> char 126))
9001 (mapconcat (lambda (sequence-element)
9002 (format "%%%.2X" sequence-element))
9003 (or (encode-coding-char char 'utf-8)
9004 (error "Unable to percent escape character: %s"
9005 (char-to-string char))) "")
9006 (char-to-string char))) text "")))
9008 (defun org-link-unescape (str)
9009 "Unhex hexified Unicode strings as returned from the JavaScript function
9010 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
9011 (unless (and (null str) (string= "" str))
9012 (let ((pos 0) (case-fold-search t) unhexed)
9014 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9015 (setq str (replace-match unhexed t t str))
9016 (setq pos (+ pos (length unhexed))))))
9017 str)
9019 (defun org-link-unescape-compound (hex)
9020 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
9021 Note: this function also decodes single byte encodings like
9023 (save-match-data
9024 (let* ((bytes (cdr (split-string hex "%")))
9025 (ret "")
9026 (eat 0)
9027 (sum 0))
9028 (while bytes
9029 (let* ((val (string-to-number (pop bytes) 16))
9030 (shift-xor
9031 (if (= 0 eat)
9032 (cond
9033 ((>= val 252) (cons 6 252))
9034 ((>= val 248) (cons 5 248))
9035 ((>= val 240) (cons 4 240))
9036 ((>= val 224) (cons 3 224))
9037 ((>= val 192) (cons 2 192))
9038 (t (cons 0 0)))
9039 (cons 6 128))))
9040 (if (>= val 192) (setq eat (car shift-xor)))
9041 (setq val (logxor val (cdr shift-xor)))
9042 (setq sum (+ (lsh sum (car shift-xor)) val))
9043 (if (> eat 0) (setq eat (- eat 1)))
9044 (cond
9045 ((= 0 eat) ;multi byte
9046 (setq ret (concat ret (org-char-to-string sum)))
9047 (setq sum 0))
9048 ((not bytes) ; single byte(s)
9049 (setq ret (org-link-unescape-single-byte-sequence hex))))
9050 )) ;; end (while bytes
9051 ret )))
9053 (defun org-link-unescape-single-byte-sequence (hex)
9054 "Unhexify hex-encoded single byte character sequences."
9055 (mapconcat (lambda (byte)
9056 (char-to-string (string-to-number byte 16)))
9057 (cdr (split-string hex "%")) ""))
9059 (defun org-xor (a b)
9060 "Exclusive or."
9061 (if a (not b) b))
9063 (defun org-fixup-message-id-for-http (s)
9064 "Replace special characters in a message id, so it can be used in an http query."
9065 (when (string-match "%" s)
9066 (setq s (mapconcat (lambda (c)
9067 (if (eq c ?%)
9068 "%25"
9069 (char-to-string c)))
9070 s "")))
9071 (while (string-match "<" s)
9072 (setq s (replace-match "%3C" t t s)))
9073 (while (string-match ">" s)
9074 (setq s (replace-match "%3E" t t s)))
9075 (while (string-match "@" s)
9076 (setq s (replace-match "%40" t t s)))
9077 s)
9079 ;;;###autoload
9080 (defun org-insert-link-global ()
9081 "Insert a link like Org-mode does.
9082 This command can be called in any mode to insert a link in Org-mode syntax."
9083 (interactive)
9084 (org-load-modules-maybe)
9085 (org-run-like-in-org-mode 'org-insert-link))
9087 (defun org-insert-link (&optional complete-file link-location default-description)
9088 "Insert a link. At the prompt, enter the link.
9090 Completion can be used to insert any of the link protocol prefixes like
9091 http or ftp in use.
9093 The history can be used to select a link previously stored with
9094 `org-store-link'. When the empty string is entered (i.e. if you just
9095 press RET at the prompt), the link defaults to the most recently
9096 stored link. As SPC triggers completion in the minibuffer, you need to
9097 use M-SPC or C-q SPC to force the insertion of a space character.
9099 You will also be prompted for a description, and if one is given, it will
9100 be displayed in the buffer instead of the link.
9102 If there is already a link at point, this command will allow you to edit link
9103 and description parts.
9106 be selected using completion. The path to the file will be relative to the
9107 current directory if the file is in the current directory or a subdirectory.
9108 Otherwise, the link will be the absolute path as completed in the minibuffer
9109 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9110 option `org-link-file-path-type'.
9113 the current directory or below.
9116 `org-keep-stored-link-after-insertion'.
9118 If `org-make-link-description-function' is non-nil, this function will be
9119 called with the link target, and the result will be the default
9120 link description.
9122 If the LINK-LOCATION parameter is non-nil, this value will be
9123 used as the link location instead of reading one interactively.
9125 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9126 be used as the default description."
9127 (interactive "P")
9128 (let* ((wcf (current-window-configuration))
9129 (region (if (org-region-active-p)
9130 (buffer-substring (region-beginning) (region-end))))
9131 (remove (and region (list (region-beginning) (region-end))))
9132 (desc region)
9133 tmphist ; byte-compile incorrectly complains about this
9134 (link link-location)
9135 entry file all-prefixes)
9136 (cond
9137 (link-location) ; specified by arg, just use it.
9138 ((org-in-regexp org-bracket-link-regexp 1)
9139 ;; We do have a link at point, and we are going to edit it.
9140 (setq remove (list (match-beginning 0) (match-end 0)))
9141 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9142 (setq link (read-string "Link: "
9143 (org-link-unescape
9144 (org-match-string-no-properties 1)))))
9145 ((or (org-in-regexp org-angle-link-re)
9146 (org-in-regexp org-plain-link-re))
9147 ;; Convert to bracket link
9148 (setq remove (list (match-beginning 0) (match-end 0))
9149 link (read-string "Link: "
9150 (org-remove-angle-brackets (match-string 0)))))
9151 ((member complete-file '((4) (16)))
9152 ;; Completing read for file names.
9153 (setq link (org-file-complete-link complete-file)))
9154 (t
9155 ;; Read link, with completion for stored links.
9156 (with-output-to-temp-buffer "*Org Links*"
9157 (princ "Insert a link.
9159 (when org-stored-links
9161 (princ (mapconcat
9162 (lambda (x)
9163 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9165 (let ((cw (selected-window)))
9166 (select-window (get-buffer-window "*Org Links*" 'visible))
9167 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9168 (unless (pos-visible-in-window-p (point-max))
9169 (org-fit-window-to-buffer))
9170 (and (window-live-p cw) (select-window cw)))
9171 ;; Fake a link history, containing the stored links.
9172 (setq tmphist (append (mapcar 'car org-stored-links)
9173 org-insert-link-history))
9174 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9175 (mapcar 'car org-link-abbrev-alist)
9176 org-link-types))
9177 (unwind-protect
9178 (progn
9179 (setq link
9180 (let ((org-completion-use-ido nil)
9181 (org-completion-use-iswitchb nil))
9182 (org-completing-read
9183 "Link: "
9184 (append
9185 (mapcar (lambda (x) (list (concat x ":")))
9186 all-prefixes)
9187 (mapcar 'car org-stored-links))
9188 nil nil nil
9189 'tmphist
9190 (car (car org-stored-links)))))
9192 (error "No link selected"))
9193 (if (or (member link all-prefixes)
9194 (and (equal ":" (substring link -1))
9195 (member (substring link 0 -1) all-prefixes)
9196 (setq link (substring link 0 -1))))
9197 (setq link (org-link-try-special-completion link))))
9198 (set-window-configuration wcf)
9199 (kill-buffer "*Org Links*"))
9200 (setq entry (assoc link org-stored-links))
9201 (or entry (push link org-insert-link-history))
9202 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9203 (not org-keep-stored-link-after-insertion))
9204 (setq org-stored-links (delq (assoc link org-stored-links)
9205 org-stored-links)))
9206 (setq desc (or desc (nth 1 entry)))))
9208 (if (string-match org-plain-link-re link)
9209 ;; URL-like link, normalize the use of angular brackets.
9210 (setq link (org-make-link (org-remove-angle-brackets link))))
9212 ;; Check if we are linking to the current file with a search option
9213 ;; If yes, simplify the link by using only the search option.
9214 (when (and buffer-file-name
9216 (let* ((path (match-string 1 link))
9217 (case-fold-search nil)
9218 (search (match-string 2 link)))
9219 (save-match-data
9220 (if (equal (file-truename buffer-file-name) (file-truename path))
9221 ;; We are linking to this same file, with a search option
9222 (setq link search)))))
9224 ;; Check if we can/should use a relative path. If yes, simplify the link
9226 (let* ((type (match-string 1 link))
9227 (path (match-string 2 link))
9228 (origpath path)
9229 (case-fold-search nil))
9230 (cond
9231 ((or (eq org-link-file-path-type 'absolute)
9232 (equal complete-file '(16)))
9233 (setq path (abbreviate-file-name (expand-file-name path))))
9234 ((eq org-link-file-path-type 'noabbrev)
9235 (setq path (expand-file-name path)))
9236 ((eq org-link-file-path-type 'relative)
9237 (setq path (file-relative-name path)))
9238 (t
9239 (save-match-data
9240 (if (string-match (concat "^" (regexp-quote
9241 (expand-file-name
9242 (file-name-as-directory
9243 default-directory))))
9244 (expand-file-name path))
9245 ;; We are linking a file with relative path name.
9246 (setq path (substring (expand-file-name path)
9247 (match-end 0)))
9248 (setq path (abbreviate-file-name (expand-file-name path)))))))
9249 (setq link (concat type path))
9250 (if (equal desc origpath)
9251 (setq desc path))))
9253 (if org-make-link-description-function
9254 (setq desc (funcall org-make-link-description-function link desc))
9255 (if default-description (setq desc default-description)))
9257 (setq desc (read-string "Description: " desc))
9259 (if remove (apply 'delete-region remove))
9260 (insert (org-make-link-string link desc))))
9262 (defun org-link-try-special-completion (type)
9263 "If there is completion support for link type TYPE, offer it."
9264 (let ((fun (intern (concat "org-" type "-complete-link"))))
9265 (if (functionp fun)
9266 (funcall fun)
9267 (read-string "Link (no completion support): " (concat type ":")))))
9269 (defun org-file-complete-link (&optional arg)
9270 "Create a file link using completion."
9271 (let (file link)
9272 (setq file (read-file-name "File: "))
9273 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9274 (pwd1 (file-name-as-directory (abbreviate-file-name
9275 (expand-file-name ".")))))
9276 (cond
9277 ((equal arg '(16))
9278 (setq link (org-make-link
9279 "file:"
9280 (abbreviate-file-name (expand-file-name file)))))
9282 (setq link (org-make-link "file:" (match-string 1 file))))
9284 (expand-file-name file))
9285 (setq link (org-make-link
9286 "file:" (match-string 1 (expand-file-name file)))))
9287 (t (setq link (org-make-link "file:" file)))))
9288 link))
9290 (defun org-completing-read (&rest args)
9291 "Completing-read with SPACE being a normal character."
9292 (let ((enable-recursive-minibuffers t)
9293 (minibuffer-local-completion-map
9294 (copy-keymap minibuffer-local-completion-map)))
9295 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9296 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9297 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9298 (apply 'org-icompleting-read args)))
9300 (defun org-completing-read-no-i (&rest args)
9301 (let (org-completion-use-ido org-completion-use-iswitchb)
9302 (apply 'org-completing-read args)))
9304 (defun org-iswitchb-completing-read (prompt choices &rest args)
9305 "Use iswitch as a completing-read replacement to choose from choices.
9306 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9307 from."
9308 (let* ((iswitchb-use-virtual-buffers nil)
9309 (iswitchb-make-buflist-hook
9310 (lambda ()
9311 (setq iswitchb-temp-buflist choices))))
9312 (iswitchb-read-buffer prompt)))
9314 (defun org-icompleting-read (&rest args)
9315 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9316 (org-without-partial-completion
9317 (if (and org-completion-use-ido
9318 (fboundp 'ido-completing-read)
9319 (boundp 'ido-mode) ido-mode
9320 (listp (second args)))
9321 (let ((ido-enter-matching-directory nil))
9322 (apply 'ido-completing-read (concat (car args))
9323 (if (consp (car (nth 1 args)))
9324 (mapcar 'car (nth 1 args))
9325 (nth 1 args))
9326 (cddr args)))
9327 (if (and org-completion-use-iswitchb
9328 (boundp 'iswitchb-mode) iswitchb-mode
9329 (listp (second args)))
9330 (apply 'org-iswitchb-completing-read (concat (car args))
9331 (if (consp (car (nth 1 args)))
9332 (mapcar 'car (nth 1 args))
9333 (nth 1 args))
9334 (cddr args))
9335 (apply 'completing-read args)))))
9337 (defun org-extract-attributes (s)
9338 "Extract the attributes cookie from a string and set as text property."
9339 (let (a attr (start 0) key value)
9340 (save-match-data
9342 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9344 (setq key (match-string 1 a) value (match-string 2 a)
9345 start (match-end 0)
9346 attr (plist-put attr (intern key) value))))
9347 (org-add-props s nil 'org-attr attr))
9348 s))
9350 (defun org-extract-attributes-from-string (tag)
9351 (let (key value attr)
9353 (setq key (match-string 1 tag) value (match-string 2 tag)
9354 tag (replace-match "" t t tag)
9355 attr (plist-put attr (intern key) value)))
9356 (cons tag attr)))
9358 (defun org-attributes-to-string (plist)
9359 "Format a property list into an HTML attribute list."
9360 (let ((s "") key value)
9361 (while plist
9362 (setq key (pop plist) value (pop plist))
9363 (and value
9365 s))
9367 ;;; Opening/following a link
9369 (defvar org-link-search-failed nil)
9371 (defvar org-open-link-functions nil
9372 "Hook for functions finding a plain text link.
9373 These functions must take a single argument, the link content.
9374 They will be called for links that look like [[link text][description]]
9378 These functions will be called *before* Org attempts to resolve the
9379 link by doing text searches in the current buffer - so if you want a
9381 handle this as a special case.
9383 When the function does handle the link, it must return a non-nil value.
9384 If it decides that it is not responsible for this link, it must return
9385 nil to indicate that that Org-mode can continue with other options
9386 like exact and fuzzy text search.")
9388 (defun org-next-link ()
9389 "Move forward to the next link.
9390 If the link is in hidden text, expose it."
9391 (interactive)
9392 (when (and org-link-search-failed (eq this-command last-command))
9393 (goto-char (point-min))
9394 (message "Link search wrapped back to beginning of buffer"))
9395 (setq org-link-search-failed nil)
9396 (let* ((pos (point))
9397 (ct (org-context))
9398 (a (assoc :link ct)))
9399 (if a (goto-char (nth 2 a)))
9400 (if (re-search-forward org-any-link-re nil t)
9401 (progn
9402 (goto-char (match-beginning 0))
9403 (if (outline-invisible-p) (org-show-context)))
9404 (goto-char pos)
9405 (setq org-link-search-failed t)
9406 (error "No further link found"))))
9408 (defun org-previous-link ()
9409 "Move backward to the previous link.
9410 If the link is in hidden text, expose it."
9411 (interactive)
9412 (when (and org-link-search-failed (eq this-command last-command))
9413 (goto-char (point-max))
9414 (message "Link search wrapped back to end of buffer"))
9415 (setq org-link-search-failed nil)
9416 (let* ((pos (point))
9417 (ct (org-context))
9418 (a (assoc :link ct)))
9419 (if a (goto-char (nth 1 a)))
9420 (if (re-search-backward org-any-link-re nil t)
9421 (progn
9422 (goto-char (match-beginning 0))
9423 (if (outline-invisible-p) (org-show-context)))
9424 (goto-char pos)
9425 (setq org-link-search-failed t)
9426 (error "No further link found"))))
9428 (defun org-translate-link (s)
9429 "Translate a link string if a translation function has been defined."
9430 (if (and org-link-translation-function
9431 (fboundp org-link-translation-function)
9433 (progn
9434 (setq s (funcall org-link-translation-function
9435 (match-string 1) (match-string 2)))
9436 (concat (car s) ":" (cdr s)))
9437 s))
9439 (defun org-translate-link-from-planner (type path)
9440 "Translate a link from Emacs Planner syntax so that Org can follow it.
9441 This is still an experimental function, your mileage may vary."
9442 (cond
9443 ((member type '("http" "https" "news" "ftp"))
9444 ;; standard Internet links are the same.
9445 nil)
9446 ((and (equal type "irc") (string-match "^//" path))
9447 ;; Planner has two / at the beginning of an irc link, we have 1.
9448 ;; We should have zero, actually....
9449 (setq path (substring path 1)))
9450 ((and (equal type "lisp") (string-match "^/" path))
9451 ;; Planner has a slash, we do not.
9452 (setq type "elisp" path (substring path 1)))
9454 ;; A typical message link. Planner has the id after the final slash,
9455 ;; we separate it with a hash mark
9456 (setq path (concat (match-string 1 path) "#"
9457 (org-remove-angle-brackets (match-string 2 path)))))
9458 )
9459 (cons type path))
9461 (defun org-find-file-at-mouse (ev)
9462 "Open file link or URL at mouse."
9463 (interactive "e")
9464 (mouse-set-point ev)
9465 (org-open-at-point 'in-emacs))
9467 (defun org-open-at-mouse (ev)
9468 "Open file link or URL at mouse.
9469 See the docstring of `org-open-file' for details."
9470 (interactive "e")
9471 (mouse-set-point ev)
9472 (if (eq major-mode 'org-agenda-mode)
9473 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9474 (org-open-at-point))
9476 (defvar org-window-config-before-follow-link nil
9477 "The window configuration before following a link.
9478 This is saved in case the need arises to restore it.")
9480 (defvar org-open-link-marker (make-marker)
9481 "Marker pointing to the location where `org-open-at-point; was called.")
9483 ;;;###autoload
9484 (defun org-open-at-point-global ()
9485 "Follow a link like Org-mode does.
9486 This command can be called in any mode to follow a link that has
9487 Org-mode syntax."
9488 (interactive)
9489 (org-run-like-in-org-mode 'org-open-at-point))
9491 ;;;###autoload
9492 (defun org-open-link-from-string (s &optional arg reference-buffer)
9493 "Open a link in the string S, as if it was in Org-mode."
9495 (let ((reference-buffer (or reference-buffer (current-buffer))))
9496 (with-temp-buffer
9497 (let ((org-inhibit-startup (not reference-buffer)))
9498 (org-mode)
9499 (insert s)
9500 (goto-char (point-min))
9501 (when reference-buffer
9502 (setq org-link-abbrev-alist-local
9503 (with-current-buffer reference-buffer
9504 org-link-abbrev-alist-local)))
9505 (org-open-at-point arg reference-buffer)))))
9507 (defvar org-open-at-point-functions nil
9508 "Hook that is run when following a link at point.
9510 Functions in this hook must return t if they identify and follow
9511 a link at point. If they don't find anything interesting at point,
9512 they must return nil.")
9514 (defun org-open-at-point (&optional arg reference-buffer)
9515 "Open link at or after point.
9516 If there is no link at point, this function will search forward up to
9517 the end of the current line.
9518 Normally, files will be opened by an appropriate application. If the
9519 optional prefix argument ARG is non-nil, Emacs will visit the file.
9520 With a double prefix argument, try to open outside of Emacs, in the
9521 application the system uses for this file type."
9522 (interactive "P")
9523 ;; if in a code block, then open the block's results
9524 (unless (call-interactively #'org-babel-open-src-block-result)
9525 (org-load-modules-maybe)
9526 (move-marker org-open-link-marker (point))
9527 (setq org-window-config-before-follow-link (current-window-configuration))
9528 (org-remove-occur-highlights nil nil t)
9529 (cond
9530 ((and (org-at-heading-p)
9531 (not (org-in-regexp
9536 (not (get-text-property (point) 'org-linked-text)))
9537 (or (org-offer-links-in-entry arg)
9538 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9539 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9540 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9541 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9542 (not (org-in-regexp org-bracket-link-regexp)))
9543 (org-footnote-action))
9544 (t
9545 (let (type path link line search (pos (point)))
9546 (catch 'match
9547 (save-excursion
9549 (when (org-in-regexp org-bracket-link-regexp 1)
9550 (setq link (org-extract-attributes
9551 (org-link-unescape (org-match-string-no-properties 1))))
9553 (setq link (replace-match " " t t link)))
9554 (setq link (org-link-expand-abbrev link))
9555 (cond
9556 ((or (file-name-absolute-p link)
9558 (setq type "file" path link))
9559 ((string-match org-link-re-with-space3 link)
9560 (setq type (match-string 1 link) path (match-string 2 link)))
9561 (t (setq type "thisfile" path link)))
9562 (throw 'match t)))
9564 (when (get-text-property (point) 'org-linked-text)
9565 (setq type "thisfile"
9566 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9567 (1+ (point)) (point))
9568 path (buffer-substring
9569 (or (previous-single-property-change pos 'org-linked-text)
9570 (point-min))
9571 (or (next-single-property-change pos 'org-linked-text)
9572 (point-max))))
9573 (throw 'match t))
9575 (save-excursion
9576 (when (or (org-in-regexp org-angle-link-re)
9577 (org-in-regexp org-plain-link-re))
9578 (setq type (match-string 1)
9579 path (org-link-unescape (match-string 2)))
9580 (throw 'match t)))
9581 (save-excursion
9583 (setq type "tags"
9584 path (match-string 1))
9585 (while (string-match ":" path)
9586 (setq path (replace-match "+" t t path)))
9587 (throw 'match t)))
9589 (setq type "tree-match"
9590 path (match-string 1))
9591 (throw 'match t)))
9592 (unless path
9593 (error "No link found"))
9595 ;; switch back to reference buffer
9596 ;; needed when if called in a temporary buffer through
9597 ;; org-open-link-from-string
9598 (with-current-buffer (or reference-buffer (current-buffer))
9600 ;; Remove any trailing spaces in path
9602 (setq path (replace-match "" t t path)))
9603 (if (and org-link-translation-function
9604 (fboundp org-link-translation-function))
9605 ;; Check if we need to translate the link
9606 (let ((tmp (funcall org-link-translation-function type path)))
9607 (setq type (car tmp) path (cdr tmp))))
9609 (cond
9611 ((assoc type org-link-protocols)
9612 (funcall (nth 1 (assoc type org-link-protocols)) path))
9614 ((equal type "mailto")
9615 (let ((cmd (car org-link-mailto-program))
9616 (args (cdr org-link-mailto-program)) args1
9617 (address path) (subject "") a)
9619 (setq address (match-string 1 path)
9620 subject (org-link-escape (match-string 2 path))))
9621 (while args
9622 (cond
9623 ((not (stringp (car args))) (push (pop args) args1))
9624 (t (setq a (pop args))
9625 (if (string-match "%a" a)
9626 (setq a (replace-match address t t a)))
9627 (if (string-match "%s" a)
9628 (setq a (replace-match subject t t a)))
9629 (push a args1))))
9630 (apply cmd (nreverse args1))))
9632 ((member type '("http" "https" "ftp" "news"))
9633 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9634 (org-link-escape
9635 path org-link-escape-chars-browser)
9636 path))))
9638 ((string= type "doi")
9639 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9640 (org-link-escape
9641 path org-link-escape-chars-browser)
9642 path))))
9644 ((member type '("message"))
9645 (browse-url (concat type ":" path)))
9647 ((string= type "tags")
9648 (org-tags-view arg path))
9650 ((string= type "tree-match")
9653 ((string= type "file")
9655 (setq line (string-to-number (match-string 1 path))
9656 path (substring path 0 (match-beginning 0)))
9658 (setq search (match-string 1 path)
9659 path (substring path 0 (match-beginning 0)))))
9660 (if (string-match "[*?{]" (file-name-nondirectory path))
9661 (dired path)
9662 (org-open-file path arg line search)))
9664 ((string= type "shell")
9665 (let ((cmd path))
9666 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9667 (string-match org-confirm-shell-link-not-regexp cmd))
9668 (not org-confirm-shell-link-function)
9669 (funcall org-confirm-shell-link-function
9671 (org-add-props cmd nil
9672 'face 'org-warning))))
9673 (progn
9674 (message "Executing %s" cmd)
9675 (shell-command cmd))
9676 (error "Abort"))))
9678 ((string= type "elisp")
9679 (let ((cmd path))
9680 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9681 (string-match org-confirm-elisp-link-not-regexp cmd))
9682 (not org-confirm-elisp-link-function)
9683 (funcall org-confirm-elisp-link-function
9685 (org-add-props cmd nil
9686 'face 'org-warning))))
9687 (message "%s => %s" cmd
9688 (if (equal (string-to-char cmd) ?\()
9689 (eval (read cmd))
9690 (call-interactively (read cmd))))
9691 (error "Abort"))))
9693 ((and (string= type "thisfile")
9694 (run-hook-with-args-until-success
9695 'org-open-link-functions path)))
9697 ((string= type "thisfile")
9698 (if arg
9699 (switch-to-buffer-other-window
9700 (org-get-buffer-for-internal-link (current-buffer)))
9701 (org-mark-ring-push))
9702 (let ((cmd `(org-link-search
9703 ,path
9704 ,(cond ((equal arg '(4)) ''occur)
9705 ((equal arg '(16)) ''org-occur)
9706 (t nil))
9707 ,pos)))
9708 (condition-case nil (let ((org-link-search-inhibit-query t))
9709 (eval cmd))
9710 (error (progn (widen) (eval cmd))))))
9712 (t
9713 (browse-url-at-point)))))))
9714 (move-marker org-open-link-marker nil)
9715 (run-hook-with-args 'org-follow-link-hook)))
9717 (defun org-offer-links-in-entry (&optional nth zero)
9718 "Offer links in the current entry and follow the selected link.
9719 If there is only one link, follow it immediately as well.
9720 If NTH is an integer, immediately pick the NTH link found.
9721 If ZERO is a string, check also this string for a link, and if
9722 there is one, offer it as link number zero."
9726 (cnt ?0)
9727 (in-emacs (if (integerp nth) nil nth))
9728 have-zero end links link c)
9729 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9730 (push (match-string 0 zero) links)
9731 (setq cnt (1- cnt) have-zero t))
9732 (save-excursion
9733 (org-back-to-heading t)
9734 (setq end (save-excursion (outline-next-heading) (point)))
9735 (while (re-search-forward re end t)
9736 (push (match-string 0) links))
9737 (setq links (org-uniquify (reverse links))))
9739 (cond
9740 ((null links)
9741 (message "No links"))
9742 ((equal (length links) 1)
9743 (setq link (list (car links))))
9744 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9745 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9746 (t ; we have to select a link
9747 (save-excursion
9748 (save-window-excursion
9749 (delete-other-windows)
9750 (with-output-to-temp-buffer "*Select Link*"
9751 (mapc (lambda (l)
9752 (if (not (string-match org-bracket-link-regexp l))
9754 (org-remove-angle-brackets l)))
9755 (if (match-end 3)
9757 (match-string 3 l) (match-string 1 l)))
9759 (match-string 1 l))))))
9760 links))
9761 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9762 (message "Select link to open, RET to open all:")
9763 (setq c (read-char-exclusive))
9764 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9765 (when (equal c ?q) (error "Abort"))
9766 (if (equal c ?\C-m)
9767 (setq link links)
9768 (setq nth (- c ?0))
9769 (if have-zero (setq nth (1+ nth)))
9770 (unless (and (integerp nth) (>= (length links) nth))
9771 (error "Invalid link selection"))
9772 (setq link (list (nth (1- nth) links))))))
9773 (if link
9774 (let ((buf (current-buffer)))
9775 (dolist (l link)
9776 (org-open-link-from-string l in-emacs buf))
9777 t)
9778 nil)))
9780 ;; Add special file links that specify the way of opening
9782 (org-add-link-type "file+sys" 'org-open-file-with-system)
9783 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9784 (defun org-open-file-with-system (path)
9785 "Open file at PATH using the system way of opening it."
9786 (org-open-file path 'system))
9787 (defun org-open-file-with-emacs (path)
9788 "Open file at PATH in Emacs."
9789 (org-open-file path 'emacs))
9790 (defun org-remove-file-link-modifiers ()
9791 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9792 (goto-char (point-min))
9794 (org-if-unprotected
9795 (replace-match "file:" t t))))
9796 (eval-after-load "org-exp"
9797 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9798 'org-remove-file-link-modifiers))
9800 ;;;; Time estimates
9802 (defun org-get-effort (&optional pom)
9803 "Get the effort estimate for the current entry."
9804 (org-entry-get pom org-effort-property))
9806 ;;; File search
9808 (defvar org-create-file-search-functions nil
9809 "List of functions to construct the right search string for a file link.
9810 These functions are called in turn with point at the location to
9811 which the link should point.
9813 A function in the hook should first test if it would like to
9814 handle this file type, for example by checking the `major-mode'
9815 or the file extension. If it decides not to handle this file, it
9816 should just return nil to give other functions a chance. If it
9817 does handle the file, it must return the search string to be used
9818 when following the link. The search string will be part of the
9819 file link, given after a double colon, and `org-open-at-point'
9820 will automatically search for it. If special measures must be
9821 taken to make the search successful, another function should be
9822 added to the companion hook `org-execute-file-search-functions',
9823 which see.
9825 A function in this hook may also use `setq' to set the variable
9826 `description' to provide a suggestion for the descriptive text to
9827 be used for this link when it gets inserted into an Org-mode
9830 (defvar org-execute-file-search-functions nil
9831 "List of functions to execute a file search triggered by a link.
9833 Functions added to this hook must accept a single argument, the
9834 search string that was part of the file link, the part after the
9835 double colon. The function must first check if it would like to
9836 handle this search, for example by checking the `major-mode' or
9837 the file extension. If it decides not to handle this search, it
9838 should just return nil to give other functions a chance. If it
9839 does handle the search, it must return a non-nil value to keep
9840 other functions from trying.
9842 Each function can access the current prefix argument through the
9843 variable `current-prefix-argument'. Note that a single prefix is
9844 used to force opening a link in Emacs, so it may be good to only
9845 use a numeric or double prefix to guide the search function.
9847 In case this is needed, a function in this hook can also restore
9848 the window configuration before `org-open-at-point' was called using:
9850 (set-window-configuration org-window-config-before-follow-link)")
9852 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9853 (defun org-link-search (s &optional type avoid-pos stealth)
9854 "Search for a link search option.
9855 If S is surrounded by forward slashes, it is interpreted as a
9856 regular expression. In org-mode files, this will create an `org-occur'
9857 sparse tree. In ordinary files, `occur' will be used to list matches.
9858 If the current buffer is in `dired-mode', grep will be used to search
9859 in all files. If AVOID-POS is given, ignore matches near that position.
9861 When optional argument STEALTH is non-nil, do not modify
9862 visibility around point, thus ignoring
9863 `org-show-hierarchy-above', `org-show-following-heading' and
9864 `org-show-siblings' variables."
9865 (let ((case-fold-search t)
9869 org-emphasis-alist)
9871 (pos (point))
9872 (pre nil) (post nil)
9873 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9874 (cond
9875 ;; First check if there are any special search functions
9876 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9877 ;; Now try the builtin stuff
9878 ((and (equal (string-to-char s0) ?#)
9879 (> (length s0) 1)
9880 (save-excursion
9881 (goto-char (point-min))
9882 (and
9883 (re-search-forward
9885 (setq type 'dedicated
9886 pos (match-beginning 0))))
9887 ;; There is an exact target for this
9888 (goto-char pos)
9889 (org-back-to-heading t)))
9890 ((save-excursion
9891 (goto-char (point-min))
9892 (and
9893 (re-search-forward
9894 (concat "<<" (regexp-quote s0) ">>") nil t)
9895 (setq type 'dedicated
9896 pos (match-beginning 0))))
9897 ;; There is an exact target for this
9898 (goto-char pos))
9900 (save-excursion
9901 (goto-char (point-min))
9902 (and
9903 (re-search-forward
9904 (concat "[^[]" (regexp-quote
9905 (format org-coderef-label-format
9906 (match-string 1 s0))))
9907 nil t)
9908 (setq type 'dedicated
9909 pos (1+ (match-beginning 0))))))
9910 ;; There is a coderef target for this
9911 (goto-char pos))
9913 ;; A regular expression
9914 (cond
9915 ((eq major-mode 'org-mode)
9916 (org-occur (match-string 1 s)))
9917 ;;((eq major-mode 'dired-mode)
9918 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9919 (t (org-do-occur (match-string 1 s)))))
9920 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9921 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9922 (goto-char (point-min))
9923 (cond
9924 ((let (case-fold-search)
9925 (re-search-forward (format org-complex-heading-regexp-format
9926 (regexp-quote s))
9927 nil t))
9928 ;; OK, found a match
9929 (setq type 'dedicated)
9930 (goto-char (match-beginning 0)))
9931 ((and (not org-link-search-inhibit-query)
9932 (eq org-link-search-must-match-exact-headline 'query-to-create)
9933 (y-or-n-p "No match - create this as a new heading? "))
9934 (goto-char (point-max))
9935 (or (bolp) (newline))
9937 (beginning-of-line 0))
9938 (t
9939 (goto-char pos)
9940 (error "No match"))))
9941 (t
9942 ;; A normal search string
9943 (when (equal (string-to-char s) ?*)
9944 ;; Anchor on headlines, post may include tags.
9947 s (substring s 1)))
9948 (remove-text-properties
9949 0 (length s)
9950 '(face nil mouse-face nil keymap nil fontified nil) s)
9951 ;; Make a series of regular expressions to find a match
9960 re4 (concat "[^a-zA-Z_]" re4_)
9962 re1 (concat pre re2 post)
9963 re3 (concat pre (if pre re4_ re4) post)
9964 re5 (concat pre ".*" re4)
9965 re2 (concat pre re2)
9966 re2a (concat pre (if pre re2a_ re2a))
9967 re4 (concat pre (if pre re4_ re4))
9971 ))
9972 (cond
9973 ((eq type 'org-occur) (org-occur reall))
9974 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9975 (t (goto-char (point-min))
9976 (setq type 'fuzzy)
9977 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9978 (org-search-not-self 1 re1 nil t)
9979 (org-search-not-self 1 re2 nil t)
9980 (org-search-not-self 1 re2a nil t)
9981 (org-search-not-self 1 re3 nil t)
9982 (org-search-not-self 1 re4 nil t)
9983 (org-search-not-self 1 re5 nil t)
9984 )
9985 (goto-char (match-beginning 1))
9986 (goto-char pos)
9987 (error "No match"))))))
9988 (and (eq major-mode 'org-mode)
9989 (not stealth)
9990 (org-show-context 'link-search))
9991 type))
9993 (defun org-search-not-self (group &rest args)
9994 "Execute `re-search-forward', but only accept matches that do not
9995 enclose the position of `org-open-link-marker'."
9996 (let ((m org-open-link-marker))
9997 (catch 'exit
9998 (while (apply 're-search-forward args)
9999 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10000 (goto-char (match-end group))
10001 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10002 (> (match-beginning 0) (marker-position m))
10003 (< (match-end 0) (marker-position m)))
10004 (save-match-data
10005 (or (not (org-in-regexp
10006 org-bracket-link-analytic-regexp 1))
10007 (not (match-end 4)) ; no description
10008 (and (<= (match-beginning 4) (point))
10009 (>= (match-end 4) (point))))))
10010 (throw 'exit (point))))))))
10012 (defun org-get-buffer-for-internal-link (buffer)
10013 "Return a buffer to be used for displaying the link target of internal links."
10014 (cond
10015 ((not org-display-internal-link-with-indirect-buffer)
10016 buffer)
10017 ((string-match "(Clone)$" (buffer-name buffer))
10018 (message "Buffer is already a clone, not making another one")
10019 ;; we also do not modify visibility in this case
10020 buffer)
10021 (t ; make a new indirect buffer for displaying the link
10022 (let* ((bn (buffer-name buffer))
10023 (ibn (concat bn "(Clone)"))
10024 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10025 (with-current-buffer ib (org-overview))
10026 ib))))
10028 (defun org-do-occur (regexp &optional cleanup)
10029 "Call the Emacs command `occur'.
10030 If CLEANUP is non-nil, remove the printout of the regular expression
10031 in the *Occur* buffer. This is useful if the regex is long and not useful
10032 to read."
10033 (occur regexp)
10034 (when cleanup
10035 (let ((cwin (selected-window)) win beg end)
10036 (when (setq win (get-buffer-window "*Occur*"))
10037 (select-window win))
10038 (goto-char (point-min))
10039 (when (re-search-forward "match[a-z]+" nil t)
10040 (setq beg (match-end 0))
10042 (setq end (1- (match-beginning 0)))))
10043 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10044 (goto-char (point-min))
10045 (select-window cwin))))
10047 ;;; The mark ring for links jumps
10049 (defvar org-mark-ring nil
10050 "Mark ring for positions before jumps in Org-mode.")
10051 (defvar org-mark-ring-last-goto nil
10052 "Last position in the mark ring used to go back.")
10053 ;; Fill and close the ring
10054 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10055 (loop for i from 1 to org-mark-ring-length do
10056 (push (make-marker) org-mark-ring))
10057 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10058 org-mark-ring)
10060 (defun org-mark-ring-push (&optional pos buffer)
10061 "Put the current position or POS into the mark ring and rotate it."
10062 (interactive)
10063 (setq pos (or pos (point)))
10064 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10065 (move-marker (car org-mark-ring)
10066 (or pos (point))
10067 (or buffer (current-buffer)))
10068 (message "%s"
10069 (substitute-command-keys
10072 (defun org-mark-ring-goto (&optional n)
10073 "Jump to the previous position in the mark ring.
10074 With prefix arg N, jump back that many stored positions. When
10075 called several times in succession, walk through the entire ring.
10076 Org-mode commands jumping to a different position in the current file,
10077 or to another Org-mode file, automatically push the old position
10078 onto the ring."
10079 (interactive "p")
10080 (let (p m)
10081 (if (eq last-command this-command)
10082 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10083 (setq p org-mark-ring))
10084 (setq org-mark-ring-last-goto p)
10085 (setq m (car p))
10086 (org-pop-to-buffer-same-window (marker-buffer m))
10087 (goto-char m)
10088 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10090 (defun org-remove-angle-brackets (s)
10091 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10092 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10093 s)
10094 (defun org-add-angle-brackets (s)
10095 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10096 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10097 s)
10098 (defun org-remove-double-quotes (s)
10101 s)
10103 ;;; Following specific links
10105 (defun org-follow-timestamp-link ()
10106 (cond
10107 ((org-at-date-range-p t)
10108 (let ((org-agenda-start-on-weekday)
10109 (t1 (match-string 1))
10110 (t2 (match-string 2)))
10111 (setq t1 (time-to-days (org-time-string-to-time t1))
10112 t2 (time-to-days (org-time-string-to-time t2)))
10113 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10114 ((org-at-timestamp-p t)
10115 (org-agenda-list nil (time-to-days (org-time-string-to-time
10116 (substring (match-string 1) 0 10)))
10117 1))
10118 (t (error "This should not happen"))))
10121 ;;; Following file links
10122 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10123 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10124 (declare-function mailcap-mime-info
10125 "mailcap" (string &optional request no-decode))
10126 (defvar org-wait nil)
10127 (defun org-open-file (path &optional in-emacs line search)
10128 "Open the file at PATH.
10129 First, this expands any special file name abbreviations. Then the
10130 configuration variable `org-file-apps' is checked if it contains an
10131 entry for this file type, and if yes, the corresponding command is launched.
10133 If no application is found, Emacs simply visits the file.
10135 With optional prefix argument IN-EMACS, Emacs will visit the file.
10137 prefix arg, Org tries to avoid opening in Emacs
10138 and to use an external application to visit the file.
10140 Optional LINE specifies a line to go to, optional SEARCH a string
10141 to search for. If LINE or SEARCH is given, the file will be
10142 opened in Emacs, unless an entry from org-file-apps that makes
10143 use of groups in a regexp matches.
10145 If you want to change the way frames are used when following a
10146 link, please customize `org-link-frame-setup'.
10148 If the file does not exist, an error is thrown."
10149 (let* ((file (if (equal path "")
10150 buffer-file-name
10151 (substitute-in-file-name (expand-file-name path))))
10152 (file-apps (append org-file-apps (org-default-apps)))
10153 (apps (org-remove-if
10154 'org-file-apps-entry-match-against-dlink-p file-apps))
10155 (apps-dlink (org-remove-if-not
10156 'org-file-apps-entry-match-against-dlink-p file-apps))
10157 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10158 (dirp (if remp nil (file-directory-p file)))
10159 (file (if (and dirp org-open-directory-means-index-dot-org)
10160 (concat (file-name-as-directory file) "index.org")
10161 file))
10162 (a-m-a-p (assq 'auto-mode apps))
10163 (dfile (downcase file))
10164 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10165 (link (cond ((and (eq line nil)
10166 (eq search nil))
10167 file)
10168 (line
10169 (concat file "::" (number-to-string line)))
10170 (search
10171 (concat file "::" search))))
10172 (dlink (downcase link))
10173 (old-buffer (current-buffer))
10174 (old-pos (point))
10175 (old-mode major-mode)
10176 ext cmd link-match-data)
10178 (setq ext (match-string 1 dfile))
10180 (setq ext (match-string 1 dfile))))
10181 (cond
10182 ((member in-emacs '((16) system))
10183 (setq cmd (cdr (assoc 'system apps))))
10184 (in-emacs (setq cmd 'emacs))
10185 (t
10186 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10187 (and dirp (cdr (assoc 'directory apps)))
10188 ; first, try matching against apps-dlink
10189 ; if we get a match here, store the match data for later
10190 (let ((match (assoc-default dlink apps-dlink
10191 'string-match)))
10192 (if match
10193 (progn (setq link-match-data (match-data))
10194 match)
10195 (progn (setq in-emacs (or in-emacs line search))
10196 nil))) ; if we have no match in apps-dlink,
10197 ; always open the file in emacs if line or search
10198 ; is given (for backwards compatibility)
10199 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10200 'string-match)
10201 (cdr (assoc ext apps))
10202 (cdr (assoc t apps))))))
10203 (when (eq cmd 'system)
10204 (setq cmd (cdr (assoc 'system apps))))
10205 (when (eq cmd 'default)
10206 (setq cmd (cdr (assoc t apps))))
10207 (when (eq cmd 'mailcap)
10208 (require 'mailcap)
10209 (mailcap-parse-mailcaps)
10210 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10211 (command (mailcap-mime-info mime-type)))
10212 (if (stringp command)
10213 (setq cmd command)
10214 (setq cmd 'emacs))))
10215 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10216 (not (file-exists-p file))
10217 (not org-open-non-existing-files))
10218 (error "No such file: %s" file))
10219 (cond
10221 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10223 (setq cmd (replace-match "%s" t t cmd)))
10224 (while (string-match "%s" cmd)
10225 (setq cmd (replace-match
10226 (save-match-data
10227 (shell-quote-argument
10228 (convert-standard-filename file)))
10229 t t cmd)))
10231 ;; Replace "%1", "%2" etc. in command with group matches from regex
10232 (save-match-data
10233 (let ((match-index 1)
10234 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10235 (set-match-data link-match-data)
10236 (while (<= match-index number-of-groups)
10237 (let ((regex (concat "%" (number-to-string match-index)))
10238 (replace-with (match-string match-index dlink)))
10239 (while (string-match regex cmd)
10240 (setq cmd (replace-match replace-with t t cmd))))
10241 (setq match-index (+ match-index 1)))))
10243 (save-window-excursion
10244 (start-process-shell-command cmd nil cmd)
10245 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10246 ))
10247 ((or (stringp cmd)
10248 (eq cmd 'emacs))
10249 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10250 (widen)
10251 (if line (org-goto-line line)
10252 (if search (org-link-search search))))
10253 ((consp cmd)
10254 (let ((file (convert-standard-filename file)))
10255 (save-match-data
10256 (set-match-data link-match-data)
10257 (eval cmd))))
10258 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10259 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10260 (or (not (equal old-buffer (current-buffer)))
10261 (not (equal old-pos (point))))
10262 (org-mark-ring-push old-pos old-buffer))))
10264 (defun org-file-apps-entry-match-against-dlink-p (entry)
10265 "This function returns non-nil if `entry' uses a regular
10266 expression which should be matched against the whole link by
10267 org-open-file.
10269 It assumes that is the case when the entry uses a regular
10270 expression which has at least one grouping construct and the
10271 action is either a lisp form or a command string containing
10272 '%1', i.e. using at least one subexpression match as a
10273 parameter."
10274 (let ((selector (car entry))
10275 (action (cdr entry)))
10276 (if (stringp selector)
10277 (and (> (regexp-opt-depth selector) 0)
10278 (or (and (stringp action)
10279 (string-match "%[0-9]" action))
10280 (consp action)))
10281 nil)))
10283 (defun org-default-apps ()
10284 "Return the default applications for this operating system."
10285 (cond
10286 ((eq system-type 'darwin)
10287 org-file-apps-defaults-macosx)
10288 ((eq system-type 'windows-nt)
10289 org-file-apps-defaults-windowsnt)
10290 (t org-file-apps-defaults-gnu)))
10292 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10293 "Convert extensions to regular expressions in the cars of LIST.
10294 Also, weed out any non-string entries, because the return value is used
10295 only for regexp matching.
10296 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10297 point to the symbol `emacs', indicating that the file should
10298 be opened in Emacs."
10299 (append
10300 (delq nil
10301 (mapcar (lambda (x)
10302 (if (not (stringp (car x)))
10303 nil
10305 x
10307 list))
10308 (if add-auto-mode
10309 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10311 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10312 (defun org-file-remote-p (file)
10313 "Test whether FILE specifies a location on a remote system.
10314 Return non-nil if the location is indeed remote.
10318 (cond ((fboundp 'file-remote-p)
10319 (file-remote-p file))
10320 ((fboundp 'tramp-handle-file-remote-p)
10321 (tramp-handle-file-remote-p file))
10322 ((and (boundp 'ange-ftp-name-format)
10323 (string-match (car ange-ftp-name-format) file))
10324 t)
10325 (t nil)))
10328 ;;;; Refiling
10330 (defun org-get-org-file ()
10331 "Read a filename, with default directory `org-directory'."
10332 (let ((default (or org-default-notes-file remember-data-file)))
10333 (read-file-name (format "File name [%s]: " default)
10334 (file-name-as-directory org-directory)
10335 default)))
10337 (defun org-notes-order-reversed-p ()
10338 "Check if the current file should receive notes in reversed order."
10339 (cond
10340 ((not org-reverse-note-order) nil)
10341 ((eq t org-reverse-note-order) t)
10342 ((not (listp org-reverse-note-order)) nil)
10343 (t (catch 'exit
10344 (let ((all org-reverse-note-order)
10345 entry)
10346 (while (setq entry (pop all))
10347 (if (string-match (car entry) buffer-file-name)
10348 (throw 'exit (cdr entry))))
10349 nil)))))
10351 (defvar org-refile-target-table nil
10352 "The list of refile targets, created by `org-refile'.")
10354 (defvar org-agenda-new-buffers nil
10355 "Buffers created to visit agenda files.")
10357 (defvar org-refile-cache nil
10358 "Cache for refile targets.")
10360 (defvar org-refile-markers nil
10361 "All the markers used for caching refile locations.")
10363 (defun org-refile-marker (pos)
10364 "Get a new refile marker, but only if caching is in use."
10365 (if (not org-refile-use-cache)
10366 pos
10367 (let ((m (make-marker)))
10368 (move-marker m pos)
10369 (push m org-refile-markers)
10370 m)))
10372 (defun org-refile-cache-clear ()
10373 "Clear the refile cache and disable all the markers."
10374 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10375 (setq org-refile-markers nil)
10376 (setq org-refile-cache nil)
10377 (message "Refile cache has been cleared"))
10379 (defun org-refile-cache-check-set (set)
10380 "Check if all the markers in the cache still have live buffers."
10381 (let (marker)
10382 (catch 'exit
10383 (while (and set (setq marker (nth 3 (pop set))))
10384 ;; if org-refile-use-outline-path is 'file, marker may be nil
10385 (when (and marker (null (marker-buffer marker)))
10386 (message "not found") (sit-for 3)
10387 (throw 'exit nil)))
10388 t)))
10390 (defun org-refile-cache-put (set &rest identifiers)
10391 "Push the refile targets SET into the cache, under IDENTIFIERS."
10392 (let* ((key (sha1 (prin1-to-string identifiers)))
10393 (entry (assoc key org-refile-cache)))
10394 (if entry
10395 (setcdr entry set)
10396 (push (cons key set) org-refile-cache))))
10398 (defun org-refile-cache-get (&rest identifiers)
10399 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10400 (cond
10401 ((not org-refile-cache) nil)
10402 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10403 (t
10404 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10405 org-refile-cache))))
10406 (and set (org-refile-cache-check-set set) set)))))
10408 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10409 "Produce a table with refile targets."
10410 (let ((case-fold-search nil)
10411 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10412 (entries (or org-refile-targets '((nil . (:level . 1)))))
10413 targets tgs txt re files f desc descre fast-path-p level pos0)
10414 (message "Getting targets...")
10415 (with-current-buffer (or default-buffer (current-buffer))
10416 (while (setq entry (pop entries))
10417 (setq files (car entry) desc (cdr entry))
10418 (setq fast-path-p nil)
10419 (cond
10420 ((null files) (setq files (list (current-buffer))))
10421 ((eq files 'org-agenda-files)
10422 (setq files (org-agenda-files 'unrestricted)))
10423 ((and (symbolp files) (fboundp files))
10424 (setq files (funcall files)))
10425 ((and (symbolp files) (boundp files))
10426 (setq files (symbol-value files))))
10427 (if (stringp files) (setq files (list files)))
10428 (cond
10429 ((eq (car desc) :tag)
10431 ((eq (car desc) :todo)
10433 ((eq (car desc) :regexp)
10434 (setq descre (cdr desc)))
10435 ((eq (car desc) :level)
10437 (if org-odd-levels-only
10438 (1- (* 2 (cdr desc)))
10439 (cdr desc)))
10441 ((eq (car desc) :maxlevel)
10442 (setq fast-path-p t)
10444 (if org-odd-levels-only
10445 (1- (* 2 (cdr desc)))
10446 (cdr desc)))
10448 (t (error "Bad refiling target description %s" desc)))
10449 (while (setq f (pop files))
10450 (with-current-buffer
10451 (if (bufferp f) f (org-get-agenda-file-buffer f))
10452 (or
10453 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10454 (progn
10455 (if (bufferp f) (setq f (buffer-file-name
10456 (buffer-base-buffer f))))
10457 (setq f (and f (expand-file-name f)))
10458 (if (eq org-refile-use-outline-path 'file)
10459 (push (list (file-name-nondirectory f) f nil nil) tgs))
10460 (save-excursion
10461 (save-restriction
10462 (widen)
10463 (goto-char (point-min))
10464 (while (re-search-forward descre nil t)
10465 (goto-char (setq pos0 (point-at-bol)))
10466 (catch 'next
10467 (when org-refile-target-verify-function
10468 (save-match-data
10469 (or (funcall org-refile-target-verify-function)
10470 (throw 'next t))))
10471 (when (and (looking-at org-complex-heading-regexp)
10472 (not (member (match-string 4) excluded-entries))
10473 (match-string 4))
10474 (setq level (org-reduced-level
10475 (- (match-end 1) (match-beginning 1)))
10476 txt (org-link-display-format (match-string 4))
10478 re (format org-complex-heading-regexp-format
10479 (regexp-quote (match-string 4))))
10480 (when org-refile-use-outline-path
10481 (setq txt (mapconcat
10482 'org-protect-slash
10483 (append
10484 (if (eq org-refile-use-outline-path
10485 'file)
10486 (list (file-name-nondirectory
10487 (buffer-file-name
10488 (buffer-base-buffer))))
10489 (if (eq org-refile-use-outline-path
10490 'full-file-path)
10491 (list (buffer-file-name
10492 (buffer-base-buffer)))))
10493 (org-get-outline-path fast-path-p
10494 level txt)
10495 (list txt))
10496 "/")))
10497 (push (list txt f re (org-refile-marker (point)))
10498 tgs)))
10499 (when (= (point) pos0)
10500 ;; verification function has not moved point
10501 (goto-char (point-at-eol))))))))
10502 (when org-refile-use-cache
10503 (org-refile-cache-put tgs (buffer-file-name) descre))
10504 (setq targets (append tgs targets))
10505 ))))
10506 (message "Getting targets...done")
10507 (nreverse targets)))
10509 (defun org-protect-slash (s)
10510 (while (string-match "/" s)
10512 s)
10514 (defvar org-olpa (make-vector 20 nil))
10516 (defun org-get-outline-path (&optional fastp level heading)
10517 "Return the outline path to the current entry, as a list.
10519 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10520 routine which makes outline path derivations for an entire file,
10521 avoiding backtracing. Refile target collection makes use of that."
10522 (if fastp
10523 (progn
10524 (if (> level 19)
10525 (error "Outline path failure, more than 19 levels"))
10526 (loop for i from level upto 19 do
10527 (aset org-olpa i nil))
10528 (prog1
10529 (delq nil (append org-olpa nil))
10530 (aset org-olpa level heading)))
10531 (let (rtn case-fold-search)
10532 (save-excursion
10533 (save-restriction
10534 (widen)
10535 (while (org-up-heading-safe)
10536 (when (looking-at org-complex-heading-regexp)
10537 (push (org-match-string-no-properties 4) rtn)))
10538 rtn)))))
10540 (defun org-format-outline-path (path &optional width prefix)
10541 "Format the outline path PATH for display.
10542 Width is the maximum number of characters that is available.
10543 Prefix is a prefix to be included in the returned string,
10544 such as the file name."
10545 (setq width (or width 79))
10546 (if prefix (setq width (- width (length prefix))))
10547 (if (not path)
10548 (or prefix "")
10549 (let* ((nsteps (length path))
10550 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10551 (maxwidth (if (<= total-width width)
10552 10000 ;; everything fits
10553 ;; we need to shorten the level headings
10554 (/ (- width nsteps) nsteps)))
10555 (org-odd-levels-only nil)
10556 (n 0)
10557 (total (1+ (length prefix))))
10558 (setq maxwidth (max maxwidth 10))
10559 (concat prefix
10560 (mapconcat
10561 (lambda (h)
10562 (setq n (1+ n))
10563 (if (and (= n nsteps) (< maxwidth 10000))
10564 (setq maxwidth (- total-width total)))
10565 (if (< (length h) maxwidth)
10566 (progn (setq total (+ total (length h) 1)) h)
10567 (setq h (substring h 0 (- maxwidth 2))
10568 total (+ total maxwidth 1))
10570 (setq h (substring h 0 (match-beginning 0))))
10571 (setq h (concat h "..")))
10572 (org-add-props h nil 'face
10573 (nth (% (1- n) org-n-level-faces)
10574 org-level-faces))
10575 h)
10576 path "/")))))
10578 (defun org-display-outline-path (&optional file current)
10579 "Display the current outline path in the echo area."
10580 (interactive "P")
10581 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10582 (case-fold-search nil)
10583 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10584 (if current (setq path (append path
10585 (save-excursion
10586 (org-back-to-heading t)
10587 (if (looking-at org-complex-heading-regexp)
10588 (list (match-string 4)))))))
10589 (message "%s"
10590 (org-format-outline-path
10591 path
10592 (1- (frame-width))
10593 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10595 (defvar org-refile-history nil
10596 "History for refiling operations.")
10598 (defvar org-after-refile-insert-hook nil
10599 "Hook run after `org-refile' has inserted its stuff at the new location.
10600 Note that this is still *before* the stuff will be removed from
10601 the *old* location.")
10603 (defvar org-capture-last-stored-marker)
10604 (defun org-refile (&optional goto default-buffer rfloc)
10605 "Move the entry or entries at point to another heading.
10606 The list of target headings is compiled using the information in
10607 `org-refile-targets', which see.
10609 At the target location, the entry is filed as a subitem of the target
10610 heading. Depending on `org-reverse-note-order', the new subitem will
10611 either be the first or the last subitem.
10613 If there is an active region, all entries in that region will be moved.
10614 However, the region must fulfill the requirement that the first heading
10615 is the first one sets the top-level of the moved text - at most siblings
10616 below it are allowed.
10618 With prefix arg GOTO, the command will only visit the target location
10619 and not actually move anything.
10622 go to the location where the last refiling operation has put the subtree.
10623 With a prefix argument of `2', refile to the running clock.
10625 RFLOC can be a refile location obtained in a different way.
10627 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10629 If you are using target caching (see `org-refile-use-cache'),
10630 You have to clear the target cache in order to find new targets.
10631 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10632 prefix argument (`C-u C-u C-u C-c C-w')."
10634 (interactive "P")
10635 (if (member goto '(0 (64)))
10636 (org-refile-cache-clear)
10637 (let* ((cbuf (current-buffer))
10638 (regionp (org-region-active-p))
10639 (region-start (and regionp (region-beginning)))
10640 (region-end (and regionp (region-end)))
10641 (region-length (and regionp (- region-end region-start)))
10642 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10643 pos it nbuf file re level reversed)
10644 (setq last-command nil)
10645 (when regionp
10646 (goto-char region-start)
10647 (or (bolp) (goto-char (point-at-bol)))
10648 (setq region-start (point))
10649 (unless (or (org-kill-is-subtree-p
10650 (buffer-substring region-start region-end))
10651 (prog1 org-refile-active-region-within-subtree
10652 (org-toggle-heading)))
10653 (error "The region is not a (sequence of) subtree(s)")))
10654 (if (equal goto '(16))
10655 (org-refile-goto-last-stored)
10656 (when (or
10657 (and (equal goto 2)
10658 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10659 (prog1
10660 (setq it (list (or org-clock-heading "running clock")
10661 (buffer-file-name
10662 (marker-buffer org-clock-hd-marker))
10663 ""
10664 (marker-position org-clock-hd-marker)))
10665 (setq goto nil)))
10666 (setq it (or rfloc
10667 (let (heading-text)
10668 (save-excursion
10669 (unless goto
10670 (org-back-to-heading t)
10671 (setq heading-text
10672 (nth 4 (org-heading-components))))
10673 (org-refile-get-location
10674 (cond (goto "Goto")
10675 (regionp "Refile region to")
10678 default-buffer
10679 org-refile-allow-creating-parent-nodes
10680 goto))))))
10681 (setq file (nth 1 it)
10682 re (nth 2 it)
10683 pos (nth 3 it))
10684 (if (and (not goto)
10685 pos
10686 (equal (buffer-file-name) file)
10687 (if regionp
10688 (and (>= pos region-start)
10689 (<= pos region-end))
10690 (and (>= pos (point))
10691 (< pos (save-excursion
10692 (org-end-of-subtree t t))))))
10693 (error "Cannot refile to position inside the tree or region"))
10695 (setq nbuf (or (find-buffer-visiting file)
10696 (find-file-noselect file)))
10697 (if goto
10698 (progn
10699 (org-pop-to-buffer-same-window nbuf)
10700 (goto-char pos)
10701 (org-show-context 'org-goto))
10702 (if regionp
10703 (progn
10704 (org-kill-new (buffer-substring region-start region-end))
10705 (org-save-markers-in-region region-start region-end))
10706 (org-copy-subtree 1 nil t))
10707 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10708 (find-file-noselect file)))
10709 (setq reversed (org-notes-order-reversed-p))
10710 (save-excursion
10711 (save-restriction
10712 (widen)
10713 (if pos
10714 (progn
10715 (goto-char pos)
10716 (looking-at org-outline-regexp)
10717 (setq level (org-get-valid-level (funcall outline-level) 1))
10718 (goto-char
10719 (if reversed
10720 (or (outline-next-heading) (point-max))
10721 (or (save-excursion (org-get-next-sibling))
10722 (org-end-of-subtree t t)
10723 (point-max)))))
10724 (setq level 1)
10725 (if (not reversed)
10726 (goto-char (point-max))
10727 (goto-char (point-min))
10728 (or (outline-next-heading) (goto-char (point-max)))))
10729 (if (not (bolp)) (newline))
10730 (org-paste-subtree level)
10731 (when org-log-refile
10732 (org-add-log-setup 'refile nil nil 'findpos
10733 org-log-refile)
10734 (unless (eq org-log-refile 'note)
10735 (save-excursion (org-add-log-note))))
10736 (and org-auto-align-tags (org-set-tags nil t))
10737 (bookmark-set "org-refile-last-stored")
10738 ;; If we are refiling for capture, make sure that the
10739 ;; last-capture pointers point here
10740 (when (org-bound-and-true-p org-refile-for-capture)
10741 (bookmark-set "org-capture-last-stored-marker")
10742 (move-marker org-capture-last-stored-marker (point)))
10743 (if (fboundp 'deactivate-mark) (deactivate-mark))
10744 (run-hooks 'org-after-refile-insert-hook))))
10745 (if regionp
10746 (delete-region (point) (+ (point) region-length))
10747 (org-cut-subtree))
10748 (when (featurep 'org-inlinetask)
10749 (org-inlinetask-remove-END-maybe))
10750 (setq org-markers-to-move nil)
10753 (defun org-refile-goto-last-stored ()
10754 "Go to the location where the last refile was stored."
10755 (interactive)
10756 (bookmark-jump "org-refile-last-stored")
10757 (message "This is the location of the last refile"))
10759 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10760 no-exclude)
10761 "Prompt the user for a refile location, using PROMPT.
10762 PROMPT should not be suffixed with a colon and a space, because
10763 this function appends the default value from
10764 `org-refile-history' automatically, if that is not empty.
10765 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10766 this is used for the GOTO interface."
10767 (let ((org-refile-targets org-refile-targets)
10768 (org-refile-use-outline-path org-refile-use-outline-path)
10769 excluded-entries)
10770 (when (and (eq major-mode 'org-mode)
10771 (not org-refile-use-cache)
10772 (not no-exclude))
10773 (org-map-tree
10774 (lambda()
10775 (setq excluded-entries
10776 (append excluded-entries (list (org-get-heading t t)))))))
10777 (setq org-refile-target-table
10778 (org-refile-get-targets default-buffer excluded-entries)))
10779 (unless org-refile-target-table
10780 (error "No refile targets"))
10781 (let* ((prompt (concat prompt
10782 (and (car org-refile-history)
10783 (concat " (default " (car org-refile-history) ")"))
10784 ": "))
10785 (cbuf (current-buffer))
10786 (partial-completion-mode nil)
10787 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10788 (cfunc (if (and org-refile-use-outline-path
10789 org-outline-path-complete-in-steps)
10790 'org-olpath-completing-read
10791 'org-icompleting-read))
10792 (extra (if org-refile-use-outline-path "/" ""))
10793 (filename (and cfn (expand-file-name cfn)))
10794 (tbl (mapcar
10795 (lambda (x)
10796 (if (and (not (member org-refile-use-outline-path
10797 '(file full-file-path)))
10798 (not (equal filename (nth 1 x))))
10799 (cons (concat (car x) extra " ("
10800 (file-name-nondirectory (nth 1 x)) ")")
10801 (cdr x))
10802 (cons (concat (car x) extra) (cdr x))))
10803 org-refile-target-table))
10804 (completion-ignore-case t)
10805 pa answ parent-target child parent old-hist)
10806 (setq old-hist org-refile-history)
10807 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10808 nil 'org-refile-history (car org-refile-history)))
10809 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10810 (org-refile-check-position pa)
10811 (if pa
10812 (progn
10813 (when (or (not org-refile-history)
10814 (not (eq old-hist org-refile-history))
10815 (not (equal (car pa) (car org-refile-history))))
10816 (setq org-refile-history
10817 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10818 org-refile-history
10819 (cdr org-refile-history))))
10820 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10821 (pop org-refile-history)))
10822 pa)
10824 (progn
10825 (setq parent (match-string 1 answ)
10826 child (match-string 2 answ))
10827 (setq parent-target (or (assoc parent tbl)
10828 (assoc (concat parent "/") tbl)))
10829 (when (and parent-target
10830 (or (eq new-nodes t)
10831 (and (eq new-nodes 'confirm)
10833 child)))))
10834 (org-refile-new-child parent-target child)))
10835 (error "Invalid target location")))))
10837 (defun org-refile-check-position (refile-pointer)
10838 "Check if the refile pointer matches the readline to which it points."
10839 (let* ((file (nth 1 refile-pointer))
10840 (re (nth 2 refile-pointer))
10841 (pos (nth 3 refile-pointer))
10842 buffer)
10843 (when (org-string-nw-p re)
10844 (setq buffer (if (markerp pos)
10845 (marker-buffer pos)
10846 (or (find-buffer-visiting file)
10847 (find-file-noselect file))))
10848 (with-current-buffer buffer
10849 (save-excursion
10850 (save-restriction
10851 (widen)
10852 (goto-char pos)
10853 (beginning-of-line 1)
10854 (unless (org-looking-at-p re)
10855 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10857 (defun org-refile-new-child (parent-target child)
10858 "Use refile target PARENT-TARGET to add new CHILD below it."
10859 (unless parent-target
10860 (error "Cannot find parent for new node"))
10861 (let ((file (nth 1 parent-target))
10862 (pos (nth 3 parent-target))
10863 level)
10864 (with-current-buffer (or (find-buffer-visiting file)
10865 (find-file-noselect file))
10866 (save-excursion
10867 (save-restriction
10868 (widen)
10869 (if pos
10870 (goto-char pos)
10871 (goto-char (point-max))
10872 (if (not (bolp)) (newline)))
10873 (when (looking-at org-outline-regexp)
10874 (setq level (funcall outline-level))
10875 (org-end-of-subtree t t))
10876 (org-back-over-empty-lines)
10878 (if pos (org-get-valid-level level 1) 1) ?*)
10880 (beginning-of-line 0)
10881 (list (concat (car parent-target) "/" child) file "" (point)))))))
10883 (defun org-olpath-completing-read (prompt collection &rest args)
10884 "Read an outline path like a file name."
10885 (let ((thetable collection)
10886 (org-completion-use-ido nil) ; does not work with ido.
10887 (org-completion-use-iswitchb nil)) ; or iswitchb
10888 (apply
10889 'org-icompleting-read prompt
10890 (lambda (string predicate &optional flag)
10891 (let (rtn r f (l (length string)))
10892 (cond
10893 ((eq flag nil)
10894 ;; try completion
10895 (try-completion string thetable))
10896 ((eq flag t)
10897 ;; all-completions
10898 (setq rtn (all-completions string thetable predicate))
10899 (mapcar
10900 (lambda (x)
10901 (setq r (substring x l))
10902 (if (string-match " ([^)]*)$" x)
10903 (setq f (match-string 0 x))
10904 (setq f ""))
10905 (if (string-match "/" r)
10906 (concat string (substring r 0 (match-end 0)) f)
10907 x))
10908 rtn))
10909 ((eq flag 'lambda)
10910 ;; exact match?
10911 (assoc string thetable)))
10912 ))
10913 args)))
10915 ;;;; Dynamic blocks
10917 (defun org-find-dblock (name)
10918 "Find the first dynamic block with name NAME in the buffer.
10919 If not found, stay at current position and return nil."
10920 (let (pos)
10921 (save-excursion
10922 (goto-char (point-min))
10924 nil t)
10925 (match-beginning 0))))
10926 (if pos (goto-char pos))
10927 pos))
10929 (defconst org-dblock-start-re
10931 "Matches the start line of a dynamic block, with parameters.")
10934 "Matches the end of a dynamic block.")
10936 (defun org-create-dblock (plist)
10937 "Create a dynamic block section, with parameters taken from PLIST.
10938 PLIST must contain a :name entry which is used as name of the block."
10940 (end-of-line 1)
10941 (newline))
10942 (let ((col (current-column))
10943 (name (plist-get plist :name)))
10944 (insert "#+BEGIN: " name)
10945 (while plist
10946 (if (eq (car plist) :name)
10947 (setq plist (cddr plist))
10948 (insert " " (prin1-to-string (pop plist)))))
10950 (beginning-of-line -2)))
10952 (defun org-prepare-dblock ()
10953 "Prepare dynamic block for refresh.
10954 This empties the block, puts the cursor at the insert position and returns
10955 the property list including an extra property :name with the block name."
10956 (unless (looking-at org-dblock-start-re)
10957 (error "Not at a dynamic block"))
10958 (let* ((begdel (1+ (match-end 0)))
10959 (name (org-no-properties (match-string 1)))
10960 (params (append (list :name name)
10961 (read (concat "(" (match-string 3) ")")))))
10962 (save-excursion
10963 (beginning-of-line 1)
10965 (setq params (plist-put params :indentation-column (current-column))))
10966 (unless (re-search-forward org-dblock-end-re nil t)
10967 (error "Dynamic block not terminated"))
10968 (setq params
10969 (append params
10970 (list :content (buffer-substring
10971 begdel (match-beginning 0)))))
10972 (delete-region begdel (match-beginning 0))
10973 (goto-char begdel)
10974 (open-line 1)
10975 params))
10977 (defun org-map-dblocks (&optional command)
10978 "Apply COMMAND to all dynamic blocks in the current buffer.
10979 If COMMAND is not given, use `org-update-dblock'."
10980 (let ((cmd (or command 'org-update-dblock)))
10981 (save-excursion
10982 (goto-char (point-min))
10983 (while (re-search-forward org-dblock-start-re nil t)
10984 (goto-char (match-beginning 0))
10985 (save-excursion
10986 (condition-case nil
10987 (funcall cmd)
10988 (error (message "Error during update of dynamic block"))))
10989 (unless (re-search-forward org-dblock-end-re nil t)
10990 (error "Dynamic block not terminated"))))))
10992 (defun org-dblock-update (&optional arg)
10993 "User command for updating dynamic blocks.
10994 Update the dynamic block at point. With prefix ARG, update all dynamic
10995 blocks in the buffer."
10996 (interactive "P")
10997 (if arg
10998 (org-update-all-dblocks)
10999 (or (looking-at org-dblock-start-re)
11000 (org-beginning-of-dblock))
11001 (org-update-dblock)))
11003 (defun org-update-dblock ()
11004 "Update the dynamic block at point.
11005 This means to empty the block, parse for parameters and then call
11006 the correct writing function."
11007 (interactive)
11008 (save-window-excursion
11009 (let* ((pos (point))
11010 (line (org-current-line))
11011 (params (org-prepare-dblock))
11012 (name (plist-get params :name))
11013 (indent (plist-get params :indentation-column))
11014 (cmd (intern (concat "org-dblock-write:" name))))
11015 (message "Updating dynamic block `%s' at line %d..." name line)
11016 (funcall cmd params)
11017 (message "Updating dynamic block `%s' at line %d...done" name line)
11018 (goto-char pos)
11019 (when (and indent (> indent 0))
11020 (setq indent (make-string indent ?\ ))
11021 (save-excursion
11022 (org-beginning-of-dblock)
11023 (forward-line 1)
11024 (while (not (looking-at org-dblock-end-re))
11025 (insert indent)
11026 (beginning-of-line 2))
11027 (when (looking-at org-dblock-end-re)
11029 (replace-match ""))
11030 (insert indent)))))))
11032 (defun org-beginning-of-dblock ()
11033 "Find the beginning of the dynamic block at point.
11034 Error if there is no such block at point."
11035 (let ((pos (point))
11036 beg)
11037 (end-of-line 1)
11038 (if (and (re-search-backward org-dblock-start-re nil t)
11039 (setq beg (match-beginning 0))
11040 (re-search-forward org-dblock-end-re nil t)
11041 (> (match-end 0) pos))
11042 (goto-char beg)
11043 (goto-char pos)
11044 (error "Not in a dynamic block"))))
11046 (defun org-update-all-dblocks ()
11047 "Update all dynamic blocks in the buffer.
11048 This function can be used in a hook."
11049 (interactive)
11050 (when (eq major-mode 'org-mode)
11051 (org-map-dblocks 'org-update-dblock)))
11054 ;;;; Completion
11056 (defconst org-additional-option-like-keywords
11057 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11058 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11059 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11060 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11061 "BEGIN:" "END:"
11062 "ORGTBL" "TBLFM:" "TBLNAME:"
11063 "BEGIN_EXAMPLE" "END_EXAMPLE"
11064 "BEGIN_QUOTE" "END_QUOTE"
11065 "BEGIN_VERSE" "END_VERSE"
11066 "BEGIN_CENTER" "END_CENTER"
11067 "BEGIN_SRC" "END_SRC"
11068 "BEGIN_RESULT" "END_RESULT"
11069 "NAME:" "RESULTS:"
11070 "HEADER:" "HEADERS:"
11071 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11072 "CAPTION:" "LABEL:"
11073 "SETUPFILE:"
11074 "INCLUDE:"
11075 "BIND:"
11076 "MACRO:"))
11078 (defcustom org-structure-template-alist
11079 '(
11092 ("L" "#+LaTeX: "
11096 ("H" "#+HTML: "
11099 ("A" "#+ASCII: ")
11100 ("i" "#+INDEX: ?"
11101 "#+INDEX: ?")
11102 ("I" "#+INCLUDE %file ?"
11104 )
11105 "Structure completion elements.
11106 This is a list of abbreviation keys and values. The value gets inserted
11107 if you type `<' followed by the key and then press the completion key,
11108 usually `M-TAB'. %file will be replaced by a file name after prompting
11109 for the file using completion. The cursor will be placed at the position
11110 of the `?` in the template.
11111 There are two templates for each key, the first uses the original Org syntax,
11112 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11113 the default when the /org-mtags.el/ module has been loaded. See also the
11114 variable `org-mtags-prefer-muse-templates'."
11115 :group 'org-completion
11116 :type '(repeat
11117 (string :tag "Key")
11118 (string :tag "Template")
11119 (string :tag "Muse Template")))
11121 (defun org-try-structure-completion ()
11122 "Try to complete a structure template before point.
11124 expands them."
11125 (let ((l (buffer-substring (point-at-bol) (point)))
11126 a)
11129 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11130 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11131 (match-beginning 1)) a)
11132 t)))
11134 (defun org-complete-expand-structure-template (start cell)
11135 "Expand a structure template."
11136 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11137 (rpl (nth (if musep 2 1) cell))
11138 (ind ""))
11139 (delete-region start (point))
11141 (cond
11142 ((bolp))
11144 (setq ind (buffer-substring (point-at-bol) (point))))
11145 (t (newline))))
11146 (setq start (point))
11147 (if (string-match "%file" rpl)
11148 (setq rpl (replace-match
11149 (concat
11151 (save-match-data
11152 (abbreviate-file-name (read-file-name "Include file: ")))
11154 t t rpl)))
11157 (insert rpl)
11160 ;;;; TODO, DEADLINE, Comments
11162 (defun org-toggle-comment ()
11163 "Change the COMMENT state of an entry."
11164 (interactive)
11165 (save-excursion
11166 (org-back-to-heading)
11167 (let (case-fold-search)
11168 (cond
11169 ((looking-at (format org-heading-keyword-regexp-format
11170 org-comment-string))
11171 (goto-char (match-end 1))
11172 (looking-at (concat " +" org-comment-string))
11173 (replace-match "" t t)
11174 (when (eolp) (insert " ")))
11175 ((looking-at org-outline-regexp)
11176 (goto-char (match-end 0))
11177 (insert org-comment-string " "))))))
11179 (defvar org-last-todo-state-is-todo nil
11180 "This is non-nil when the last TODO state change led to a TODO state.
11181 If the last change removed the TODO tag or switched to DONE, then
11182 this is nil.")
11184 (defvar org-setting-tags nil) ; dynamically skipped
11186 (defvar org-todo-setup-filter-hook nil
11187 "Hook for functions that pre-filter todo specs.
11188 Each function takes a todo spec and returns either nil or the spec
11189 transformed into canonical form." )
11191 (defvar org-todo-get-default-hook nil
11192 "Hook for functions that get a default item for todo.
11193 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11194 nil or a string to be used for the todo mark." )
11196 (defvar org-agenda-headline-snapshot-before-repeat)
11198 (defun org-current-effective-time ()
11199 "Return current time adjusted for `org-extend-today-until' variable"
11200 (let* ((ct (org-current-time))
11201 (dct (decode-time ct))
11202 (ct1
11203 (if (and org-use-effective-time
11204 (< (nth 2 dct) org-extend-today-until))
11205 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11206 ct)))
11207 ct1))
11209 (defun org-todo-yesterday (&optional arg)
11210 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11211 (interactive "P")
11212 (if (eq major-mode 'org-agenda-mode)
11213 (apply 'org-agenda-todo-yesterday arg)
11214 (let* ((hour (third (decode-time
11215 (org-current-time))))
11216 (org-extend-today-until (1+ hour)))
11217 (org-todo arg))))
11219 (defun org-todo (&optional arg)
11220 "Change the TODO state of an item.
11221 The state of an item is given by a keyword at the start of the heading,
11222 like
11223 *** TODO Write paper
11224 *** DONE Call mom
11226 The different keywords are specified in the variable `org-todo-keywords'.
11228 So for this example: when the item starts with TODO, it is changed to DONE.
11229 When it starts with DONE, the DONE is removed. And when neither TODO nor
11230 DONE are present, add TODO at the beginning of the heading.
11233 state.
11234 With numeric prefix arg, switch to that state.
11236 keywords (nextset).
11238 With a numeric prefix arg of 0, inhibit note taking for the change.
11240 For calling through lisp, arg is also interpreted in the following way:
11241 'none -> empty state
11243 'done -> switch to DONE
11244 'nextset -> switch to the next set of keywords
11245 'previousset -> switch to the previous set of keywords
11247 really is a member of `org-todo-keywords'."
11248 (interactive "P")
11249 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11250 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11251 'region-start-level 'region))
11252 org-loop-over-headlines-in-active-region)
11253 (org-map-entries
11254 `(org-todo ,arg)
11255 org-loop-over-headlines-in-active-region
11256 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11257 (if (equal arg '(16)) (setq arg 'nextset))
11258 (let ((org-blocker-hook org-blocker-hook)
11259 (case-fold-search nil))
11260 (when (equal arg '(64))
11261 (setq arg nil org-blocker-hook nil))
11262 (when (and org-blocker-hook
11263 (or org-inhibit-blocking
11264 (org-entry-get nil "NOBLOCKING")))
11265 (setq org-blocker-hook nil))
11266 (save-excursion
11267 (catch 'exit
11268 (org-back-to-heading t)
11269 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11272 (let* ((match-data (match-data))
11273 (startpos (point-at-bol))
11274 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11275 (org-log-done org-log-done)
11276 (org-log-repeat org-log-repeat)
11277 (org-todo-log-states org-todo-log-states)
11278 (org-inhibit-logging
11279 (if (equal arg 0)
11280 (progn (setq arg nil) 'note) org-inhibit-logging))
11281 (this (match-string 1))
11282 (hl-pos (match-beginning 0))
11283 (head (org-get-todo-sequence-head this))
11284 (ass (assoc head org-todo-kwd-alist))
11285 (interpret (nth 1 ass))
11286 (done-word (nth 3 ass))
11287 (final-done-word (nth 4 ass))
11288 (last-state (or this ""))
11289 (completion-ignore-case t)
11290 (member (member this org-todo-keywords-1))
11291 (tail (cdr member))
11292 (state (cond
11293 ((and org-todo-key-trigger
11294 (or (and (equal arg '(4))
11295 (eq org-use-fast-todo-selection 'prefix))
11296 (and (not arg) org-use-fast-todo-selection
11297 (not (eq org-use-fast-todo-selection
11298 'prefix)))))
11299 ;; Use fast selection
11300 (org-fast-todo-selection))
11301 ((and (equal arg '(4))
11302 (or (not org-use-fast-todo-selection)
11303 (not org-todo-key-trigger)))
11304 ;; Read a state with completion
11305 (org-icompleting-read
11306 "State: " (mapcar (lambda(x) (list x))
11307 org-todo-keywords-1)
11308 nil t))
11309 ((eq arg 'right)
11310 (if this
11311 (if tail (car tail) nil)
11312 (car org-todo-keywords-1)))
11313 ((eq arg 'left)
11314 (if (equal member org-todo-keywords-1)
11315 nil
11316 (if this
11317 (nth (- (length org-todo-keywords-1)
11318 (length tail) 2)
11319 org-todo-keywords-1)
11320 (org-last org-todo-keywords-1))))
11321 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11322 (setq arg nil))) ; hack to fall back to cycling
11323 (arg
11324 ;; user or caller requests a specific state
11325 (cond
11326 ((equal arg "") nil)
11327 ((eq arg 'none) nil)
11328 ((eq arg 'done) (or done-word (car org-done-keywords)))
11329 ((eq arg 'nextset)
11330 (or (car (cdr (member head org-todo-heads)))
11331 (car org-todo-heads)))
11332 ((eq arg 'previousset)
11333 (let ((org-todo-heads (reverse org-todo-heads)))
11334 (or (car (cdr (member head org-todo-heads)))
11335 (car org-todo-heads))))
11336 ((car (member arg org-todo-keywords-1)))
11337 ((stringp arg)
11338 (error "State `%s' not valid in this file" arg))
11339 ((nth (1- (prefix-numeric-value arg))
11340 org-todo-keywords-1))))
11341 ((null member) (or head (car org-todo-keywords-1)))
11342 ((equal this final-done-word) nil) ;; -> make empty
11343 ((null tail) nil) ;; -> first entry
11344 ((memq interpret '(type priority))
11345 (if (eq this-command last-command)
11346 (car tail)
11347 (if (> (length tail) 0)
11348 (or done-word (car org-done-keywords))
11349 nil)))
11350 (t
11351 (car tail))))
11352 (state (or
11353 (run-hook-with-args-until-success
11354 'org-todo-get-default-hook state last-state)
11355 state))
11356 (next (if state (concat " " state " ") " "))
11357 (change-plist (list :type 'todo-state-change :from this :to state
11358 :position startpos))
11359 dolog now-done-p)
11360 (when org-blocker-hook
11361 (setq org-last-todo-state-is-todo
11362 (not (member this org-done-keywords)))
11363 (unless (save-excursion
11364 (save-match-data
11365 (org-with-wide-buffer
11366 (run-hook-with-args-until-failure
11367 'org-blocker-hook change-plist))))
11368 (if (org-called-interactively-p 'interactive)
11369 (error "TODO state change from %s to %s blocked" this state)
11370 ;; fail silently
11371 (message "TODO state change from %s to %s blocked" this state)
11372 (throw 'exit nil))))
11373 (store-match-data match-data)
11374 (replace-match next t t)
11375 (unless (pos-visible-in-window-p hl-pos)
11376 (message "TODO state changed to %s" (org-trim next)))
11377 (unless head
11378 (setq head (org-get-todo-sequence-head state)
11379 ass (assoc head org-todo-kwd-alist)
11380 interpret (nth 1 ass)
11381 done-word (nth 3 ass)
11382 final-done-word (nth 4 ass)))
11383 (when (memq arg '(nextset previousset))
11384 (message "Keyword-Set %d/%d: %s"
11385 (- (length org-todo-sets) -1
11386 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11387 (length org-todo-sets)
11388 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11389 (setq org-last-todo-state-is-todo
11390 (not (member state org-done-keywords)))
11391 (setq now-done-p (and (member state org-done-keywords)
11392 (not (member this org-done-keywords))))
11393 (and logging (org-local-logging logging))
11394 (when (and (or org-todo-log-states org-log-done)
11395 (not (eq org-inhibit-logging t))
11396 (not (memq arg '(nextset previousset))))
11397 ;; we need to look at recording a time and note
11398 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11399 (nth 2 (assoc this org-todo-log-states))))
11400 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11401 (setq dolog 'time))
11402 (when (and state
11403 (member state org-not-done-keywords)
11404 (not (member this org-not-done-keywords)))
11405 ;; This is now a todo state and was not one before
11406 ;; If there was a CLOSED time stamp, get rid of it.
11407 (org-add-planning-info nil nil 'closed))
11408 (when (and now-done-p org-log-done)
11409 ;; It is now done, and it was not done before
11410 (org-add-planning-info 'closed (org-current-effective-time))
11411 (if (and (not dolog) (eq 'note org-log-done))
11412 (org-add-log-setup 'done state this 'findpos 'note)))
11413 (when (and state dolog)
11414 ;; This is a non-nil state, and we need to log it
11415 (org-add-log-setup 'state state this 'findpos dolog)))
11416 ;; Fixup tag positioning
11417 (org-todo-trigger-tag-changes state)
11418 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11419 (when org-provide-todo-statistics
11420 (org-update-parent-todo-statistics))
11421 (run-hooks 'org-after-todo-state-change-hook)
11422 (if (and arg (not (member state org-done-keywords)))
11423 (setq head (org-get-todo-sequence-head state)))
11424 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11425 ;; Do we need to trigger a repeat?
11426 (when now-done-p
11427 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11428 ;; This is for the agenda, take a snapshot of the headline.
11429 (save-match-data
11430 (setq org-agenda-headline-snapshot-before-repeat
11431 (org-get-heading))))
11432 (org-auto-repeat-maybe state))
11433 ;; Fixup cursor location if close to the keyword
11434 (if (and (outline-on-heading-p)
11435 (not (bolp))
11436 (save-excursion (beginning-of-line 1)
11437 (looking-at org-todo-line-regexp))
11438 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11439 (progn
11440 (goto-char (or (match-end 2) (match-end 1)))
11441 (and (looking-at " ") (just-one-space))))
11442 (when org-trigger-hook
11443 (save-excursion
11444 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11446 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11447 "Block turning an entry into a TODO, using the hierarchy.
11448 This checks whether the current task should be blocked from state
11449 changes. Such blocking occurs when:
11451 1. The task has children which are not all in a completed state.
11453 2. A task has a parent with the property :ORDERED:, and there
11454 are siblings prior to the current task with incomplete
11455 status.
11457 3. The parent of the task is blocked because it has siblings that should
11458 be done first, or is child of a block grandparent TODO entry."
11460 (if (not org-enforce-todo-dependencies)
11461 t ; if locally turned off don't block
11462 (catch 'dont-block
11463 ;; If this is not a todo state change, or if this entry is already DONE,
11464 ;; do not block
11465 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11466 (member (plist-get change-plist :from)
11467 (cons 'done org-done-keywords))
11468 (member (plist-get change-plist :to)
11469 (cons 'todo org-not-done-keywords))
11470 (not (plist-get change-plist :to)))
11471 (throw 'dont-block t))
11472 ;; If this task has children, and any are undone, it's blocked
11473 (save-excursion
11474 (org-back-to-heading t)
11475 (let ((this-level (funcall outline-level)))
11476 (outline-next-heading)
11477 (let ((child-level (funcall outline-level)))
11478 (while (and (not (eobp))
11479 (> child-level this-level))
11480 ;; this todo has children, check whether they are all
11481 ;; completed
11482 (if (and (not (org-entry-is-done-p))
11483 (org-entry-is-todo-p))
11484 (throw 'dont-block nil))
11485 (outline-next-heading)
11486 (setq child-level (funcall outline-level))))))
11487 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11488 ;; any previous siblings are undone, it's blocked
11489 (save-excursion
11490 (org-back-to-heading t)
11491 (let* ((pos (point))
11492 (parent-pos (and (org-up-heading-safe) (point))))
11493 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11494 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11495 (forward-line 1)
11496 (re-search-forward org-not-done-heading-regexp pos t))
11497 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11498 ;; Search further up the hierarchy, to see if an ancestor is blocked
11499 (while t
11500 (goto-char parent-pos)
11501 (if (not (looking-at org-not-done-heading-regexp))
11502 (throw 'dont-block t)) ; do not block, parent is not a TODO
11503 (setq pos (point))
11504 (setq parent-pos (and (org-up-heading-safe) (point)))
11505 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11506 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11507 (forward-line 1)
11508 (re-search-forward org-not-done-heading-regexp pos t))
11509 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11511 (defcustom org-track-ordered-property-with-tag nil
11512 "Should the ORDERED property also be shown as a tag?
11513 The ORDERED property decides if an entry should require subtasks to be
11514 completed in sequence. Since a property is not very visible, setting
11515 this option means that toggling the ORDERED property with the command
11516 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11517 not relevant for the behavior, but it makes things more visible.
11519 Note that toggling the tag with tags commands will not change the property
11520 and therefore not influence behavior!
11522 This can be t, meaning the tag ORDERED should be used, It can also be a
11523 string to select a different tag for this task."
11524 :group 'org-todo
11525 :type '(choice
11526 (const :tag "No tracking" nil)
11527 (const :tag "Track with ORDERED tag" t)
11528 (string :tag "Use other tag")))
11530 (defun org-toggle-ordered-property ()
11531 "Toggle the ORDERED property of the current entry.
11532 For better visibility, you can track the value of this property with a tag.
11533 See variable `org-track-ordered-property-with-tag'."
11534 (interactive)
11535 (let* ((t1 org-track-ordered-property-with-tag)
11536 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11537 (save-excursion
11538 (org-back-to-heading)
11539 (if (org-entry-get nil "ORDERED")
11540 (progn
11541 (org-delete-property "ORDERED")
11542 (and tag (org-toggle-tag tag 'off))
11543 (message "Subtasks can be completed in arbitrary order"))
11544 (org-entry-put nil "ORDERED" "t")
11545 (and tag (org-toggle-tag tag 'on))
11546 (message "Subtasks must be completed in sequence")))))
11548 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11549 (defun org-block-todo-from-checkboxes (change-plist)
11550 "Block turning an entry into a TODO, using checkboxes.
11551 This checks whether the current task should be blocked from state
11552 changes because there are unchecked boxes in this entry."
11553 (if (not org-enforce-todo-checkbox-dependencies)
11554 t ; if locally turned off don't block
11555 (catch 'dont-block
11556 ;; If this is not a todo state change, or if this entry is already DONE,
11557 ;; do not block
11558 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11559 (member (plist-get change-plist :from)
11560 (cons 'done org-done-keywords))
11561 (member (plist-get change-plist :to)
11562 (cons 'todo org-not-done-keywords))
11563 (not (plist-get change-plist :to)))
11564 (throw 'dont-block t))
11565 ;; If this task has checkboxes that are not checked, it's blocked
11566 (save-excursion
11567 (org-back-to-heading t)
11568 (let ((beg (point)) end)
11569 (outline-next-heading)
11570 (setq end (point))
11571 (goto-char beg)
11572 (if (org-list-search-forward
11573 (concat (org-item-beginning-re)
11576 end t)
11577 (progn
11578 (if (boundp 'org-blocked-by-checkboxes)
11579 (setq org-blocked-by-checkboxes t))
11580 (throw 'dont-block nil)))))
11581 t))) ; do not block
11583 (defun org-entry-blocked-p ()
11584 "Is the current entry blocked?"
11585 (if (org-entry-get nil "NOBLOCKING")
11586 nil ;; Never block this entry
11587 (not
11588 (run-hook-with-args-until-failure
11589 'org-blocker-hook
11590 (list :type 'todo-state-change
11591 :position (point)
11592 :from 'todo
11593 :to 'done)))))
11595 (defun org-update-statistics-cookies (all)
11596 "Update the statistics cookie, either from TODO or from checkboxes.
11597 This should be called with the cursor in a line with a statistics cookie."
11598 (interactive "P")
11599 (if all
11600 (progn
11601 (org-update-checkbox-count 'all)
11602 (org-map-entries 'org-update-parent-todo-statistics))
11603 (if (not (org-at-heading-p))
11604 (org-update-checkbox-count)
11605 (let ((pos (move-marker (make-marker) (point)))
11606 end l1 l2)
11607 (ignore-errors (org-back-to-heading t))
11608 (if (not (org-at-heading-p))
11609 (org-update-checkbox-count)
11610 (setq l1 (org-outline-level))
11611 (setq end (save-excursion
11612 (outline-next-heading)
11613 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11614 (point)))
11615 (if (and (save-excursion
11616 (re-search-forward
11618 (not (save-excursion (re-search-forward
11620 (org-update-checkbox-count)
11621 (if (and l2 (> l2 l1))
11622 (progn
11623 (goto-char end)
11624 (org-update-parent-todo-statistics))
11625 (goto-char pos)
11626 (beginning-of-line 1)
11627 (while (re-search-forward
11629 (point-at-eol) t)
11630 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11631 (goto-char pos)
11632 (move-marker pos nil)))))
11634 (defvar org-entry-property-inherited-from) ;; defined below
11635 (defun org-update-parent-todo-statistics ()
11636 "Update any statistics cookie in the parent of the current headline.
11637 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11638 the entire subtree and this will travel up the hierarchy and update
11639 statistics everywhere."
11640 (let* ((prop (save-excursion (org-up-heading-safe)
11641 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11642 (recursive (or (not org-hierarchical-todo-statistics)
11644 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11645 0))
11646 (first t)
11648 level ltoggle l1 new ndel
11649 (cnt-all 0) (cnt-done 0) is-percent kwd
11650 checkbox-beg ov ovs ove cookie-present)
11651 (catch 'exit
11652 (save-excursion
11653 (beginning-of-line 1)
11654 (setq ltoggle (funcall outline-level))
11655 ;; Three situations are to consider:
11657 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11658 ;; to the top-level ancestor on the headline;
11660 ;; 2. If parent has "recursive" property, repeat up to the
11661 ;; headline setting that property, taking inheritance into
11662 ;; account;
11664 ;; 3. Else, move up to direct parent and proceed only once.
11665 (while (and (setq level (org-up-heading-safe))
11666 (or recursive first)
11667 (>= (point) lim))
11668 (setq first nil cookie-present nil)
11669 (unless (and level
11670 (not (string-match
11672 (downcase (or (org-entry-get nil "COOKIE_DATA")
11673 "")))))
11674 (throw 'exit nil))
11675 (while (re-search-forward box-re (point-at-eol) t)
11676 (setq cnt-all 0 cnt-done 0 cookie-present t)
11677 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11678 (save-match-data
11679 (unless (outline-next-heading) (throw 'exit nil))
11680 (while (and (looking-at org-complex-heading-regexp)
11681 (> (setq l1 (length (match-string 1))) level))
11682 (setq kwd (and (or recursive (= l1 ltoggle))
11683 (match-string 2)))
11684 (if (or (eq org-provide-todo-statistics 'all-headlines)
11685 (and (listp org-provide-todo-statistics)
11686 (or (member kwd org-provide-todo-statistics)
11687 (member kwd org-done-keywords))))
11688 (setq cnt-all (1+ cnt-all))
11689 (if (eq org-provide-todo-statistics t)
11690 (and kwd (setq cnt-all (1+ cnt-all)))))
11691 (and (member kwd org-done-keywords)
11692 (setq cnt-done (1+ cnt-done)))
11693 (outline-next-heading)))
11694 (setq new
11695 (if is-percent
11696 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11697 (format "[%d/%d]" cnt-done cnt-all))
11698 ndel (- (match-end 0) checkbox-beg))
11699 ;; handle overlays when updating cookie from column view
11700 (when (setq ov (car (overlays-at checkbox-beg)))
11701 (setq ovs (overlay-start ov) ove (overlay-end ov))
11702 (delete-overlay ov))
11703 (goto-char checkbox-beg)
11704 (insert new)
11705 (delete-region (point) (+ (point) ndel))
11706 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11707 (when ov (move-overlay ov ovs ove)))
11708 (when cookie-present
11709 (run-hook-with-args 'org-after-todo-statistics-hook
11710 cnt-done (- cnt-all cnt-done))))))
11711 (run-hooks 'org-todo-statistics-hook)))
11713 (defvar org-after-todo-statistics-hook nil
11714 "Hook that is called after a TODO statistics cookie has been updated.
11715 Each function is called with two arguments: the number of not-done entries
11716 and the number of done entries.
11718 For example, the following function, when added to this hook, will switch
11719 an entry to DONE when all children are done, and back to TODO when new
11720 entries are set to a TODO status. Note that this hook is only called
11721 when there is a statistics cookie in the headline!
11723 (defun org-summary-todo (n-done n-not-done)
11725 (let (org-log-done org-log-states) ; turn off logging
11727 ")
11729 (defvar org-todo-statistics-hook nil
11730 "Hook that is run whenever Org thinks TODO statistics should be updated.
11731 This hook runs even if there is no statistics cookie present, in which case
11732 `org-after-todo-statistics-hook' would not run.")
11734 (defun org-todo-trigger-tag-changes (state)
11735 "Apply the changes defined in `org-todo-state-tags-triggers'."
11736 (let ((l org-todo-state-tags-triggers)
11737 changes)
11738 (when (or (not state) (equal state ""))
11739 (setq changes (append changes (cdr (assoc "" l)))))
11740 (when (and (stringp state) (> (length state) 0))
11741 (setq changes (append changes (cdr (assoc state l)))))
11742 (when (member state org-not-done-keywords)
11743 (setq changes (append changes (cdr (assoc 'todo l)))))
11744 (when (member state org-done-keywords)
11745 (setq changes (append changes (cdr (assoc 'done l)))))
11746 (dolist (c changes)
11747 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11749 (defun org-local-logging (value)
11750 "Get logging settings from a property VALUE."
11751 (let* (words w a)
11752 ;; directly set the variables, they are already local.
11753 (setq org-log-done nil
11754 org-log-repeat nil
11755 org-todo-log-states nil)
11756 (setq words (org-split-string value))
11757 (while (setq w (pop words))
11758 (cond
11759 ((setq a (assoc w org-startup-options))
11760 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11761 (set (nth 1 a) (nth 2 a))))
11762 ((setq a (org-extract-log-state-settings w))
11763 (and (member (car a) org-todo-keywords-1)
11764 (push a org-todo-log-states)))))))
11766 (defun org-get-todo-sequence-head (kwd)
11767 "Return the head of the TODO sequence to which KWD belongs.
11768 If KWD is not set, check if there is a text property remembering the
11769 right sequence."
11770 (let (p)
11771 (cond
11772 ((not kwd)
11773 (or (get-text-property (point-at-bol) 'org-todo-head)
11774 (progn
11775 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11776 nil (point-at-eol)))
11777 (get-text-property p 'org-todo-head))))
11778 ((not (member kwd org-todo-keywords-1))
11779 (car org-todo-keywords-1))
11780 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11782 (defun org-fast-todo-selection ()
11783 "Fast TODO keyword selection with single keys.
11784 Returns the new TODO keyword, or nil if no state change should occur."
11785 (let* ((fulltable org-todo-key-alist)
11786 (done-keywords org-done-keywords) ;; needed for the faces.
11787 (maxlen (apply 'max (mapcar
11788 (lambda (x)
11789 (if (stringp (car x)) (string-width (car x)) 0))
11790 fulltable)))
11791 (expert nil)
11792 (fwidth (+ maxlen 3 1 3))
11793 (ncol (/ (- (window-width) 4) fwidth))
11794 tg cnt e c tbl
11795 groups ingroup)
11796 (save-excursion
11797 (save-window-excursion
11798 (if expert
11799 (set-buffer (get-buffer-create " *Org todo*"))
11800 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11801 (erase-buffer)
11802 (org-set-local 'org-done-keywords done-keywords)
11803 (setq tbl fulltable cnt 0)
11804 (while (setq e (pop tbl))
11805 (cond
11806 ((equal e '(:startgroup))
11807 (push '() groups) (setq ingroup t)
11808 (when (not (= cnt 0))
11809 (setq cnt 0)
11811 (insert "{ "))
11812 ((equal e '(:endgroup))
11813 (setq ingroup nil cnt 0)
11815 ((equal e '(:newline))
11816 (when (not (= cnt 0))
11817 (setq cnt 0)
11819 (setq e (car tbl))
11820 (while (equal (car tbl) '(:newline))
11822 (setq tbl (cdr tbl)))))
11823 (t
11824 (setq tg (car e) c (cdr e))
11825 (if ingroup (push tg (car groups)))
11826 (setq tg (org-add-props tg nil 'face
11827 (org-get-todo-face tg)))
11828 (if (and (= cnt 0) (not ingroup)) (insert " "))
11829 (insert "[" c "] " tg (make-string
11830 (- fwidth 4 (length tg)) ?\ ))
11831 (when (= (setq cnt (1+ cnt)) ncol)
11833 (if ingroup (insert " "))
11834 (setq cnt 0)))))
11836 (goto-char (point-min))
11837 (if (not expert) (org-fit-window-to-buffer))
11838 (message "[a-z..]:Set [SPC]:clear")
11839 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11840 (cond
11841 ((or (= c ?\C-g)
11842 (and (= c ?q) (not (rassoc c fulltable))))
11843 (setq quit-flag t))
11844 ((= c ?\ ) nil)
11845 ((setq e (rassoc c fulltable) tg (car e))
11846 tg)
11847 (t (setq quit-flag t)))))))
11849 (defun org-entry-is-todo-p ()
11850 (member (org-get-todo-state) org-not-done-keywords))
11852 (defun org-entry-is-done-p ()
11853 (member (org-get-todo-state) org-done-keywords))
11855 (defun org-get-todo-state ()
11856 (save-excursion
11857 (org-back-to-heading t)
11858 (and (looking-at org-todo-line-regexp)
11859 (match-end 2)
11860 (match-string 2))))
11862 (defun org-at-date-range-p (&optional inactive-ok)
11863 "Is the cursor inside a date range?"
11864 (interactive)
11865 (save-excursion
11866 (catch 'exit
11867 (let ((pos (point)))
11869 (skip-chars-backward "<[")
11870 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11871 (>= (match-end 0) pos)
11872 (throw 'exit t))
11874 (skip-chars-backward "<[")
11875 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11876 (>= (match-end 0) pos)
11877 (throw 'exit t)))
11878 nil)))
11880 (defun org-get-repeat (&optional tagline)
11881 "Check if there is a deadline/schedule with repeater in this entry."
11882 (save-match-data
11883 (save-excursion
11884 (org-back-to-heading t)
11885 (and (re-search-forward (if tagline
11887 org-repeat-re)
11888 (org-entry-end-position) t)
11889 (match-string-no-properties 1)))))
11891 (defvar org-last-changed-timestamp)
11892 (defvar org-last-inserted-timestamp)
11893 (defvar org-log-post-message)
11894 (defvar org-log-note-purpose)
11895 (defvar org-log-note-how)
11896 (defvar org-log-note-extra)
11897 (defun org-auto-repeat-maybe (done-word)
11898 "Check if the current headline contains a repeated deadline/schedule.
11899 If yes, set TODO state back to what it was and change the base date
11900 of repeating deadline/scheduled time stamps to new date.
11901 This function is run automatically after each state change to a DONE state."
11902 ;; last-state is dynamically scoped into this function
11903 (let* ((repeat (org-get-repeat))
11904 (aa (assoc last-state org-todo-kwd-alist))
11905 (interpret (nth 1 aa))
11906 (head (nth 2 aa))
11907 (whata '(("d" . day) ("m" . month) ("y" . year)))
11908 (msg "Entry repeats: ")
11909 (org-log-done nil)
11910 (org-todo-log-states nil)
11911 re type n what ts time to-state)
11912 (when repeat
11913 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11914 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11915 org-todo-repeat-to-state))
11916 (unless (and to-state (member to-state org-todo-keywords-1))
11917 (setq to-state (if (eq interpret 'type) last-state head)))
11918 (org-todo to-state)
11919 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11920 (org-entry-put nil "LAST_REPEAT" (format-time-string
11921 (org-time-stamp-format t t))))
11922 (when org-log-repeat
11923 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11924 (memq 'org-add-log-note post-command-hook))
11925 ;; OK, we are already setup for some record
11926 (if (eq org-log-repeat 'note)
11927 ;; make sure we take a note, not only a time stamp
11928 (setq org-log-note-how 'note))
11929 ;; Set up for taking a record
11930 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11931 last-state
11932 'findpos org-log-repeat)))
11933 (org-back-to-heading t)
11934 (org-add-planning-info nil nil 'closed)
11938 (while (re-search-forward
11939 re (save-excursion (outline-next-heading) (point)) t)
11940 (setq type (if (match-end 1) org-scheduled-string
11941 (if (match-end 3) org-deadline-string "Plain:"))
11942 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11944 (setq n (string-to-number (match-string 2 ts))
11945 what (match-string 3 ts))
11946 (if (equal what "w") (setq n (* n 7) what "d"))
11947 ;; Preparation, see if we need to modify the start date for the change
11948 (when (match-end 1)
11949 (setq time (save-match-data (org-time-string-to-time ts)))
11950 (cond
11951 ((equal (match-string 1 ts) ".")
11952 ;; Shift starting date to today
11953 (org-timestamp-change
11954 (- (org-today) (time-to-days time))
11955 'day))
11956 ((equal (match-string 1 ts) "+")
11957 (let ((nshiftmax 10) (nshift 0))
11958 (while (or (= nshift 0)
11959 (<= (time-to-days time)
11960 (time-to-days (current-time))))
11961 (when (= (incf nshift) nshiftmax)
11962 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11963 (error "Abort")))
11964 (org-timestamp-change n (cdr (assoc what whata)))
11965 (org-at-timestamp-p t)
11966 (setq ts (match-string 1))
11967 (setq time (save-match-data (org-time-string-to-time ts)))))
11968 (org-timestamp-change (- n) (cdr (assoc what whata)))
11969 ;; rematch, so that we have everything in place for the real shift
11970 (org-at-timestamp-p t)
11971 (setq ts (match-string 1))
11973 (org-timestamp-change n (cdr (assoc what whata)))
11974 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11975 (setq org-log-post-message msg)
11976 (message "%s" msg))))
11978 (defun org-show-todo-tree (arg)
11979 "Make a compact tree which shows all headlines marked with TODO.
11980 The tree will show the lines where the regexp matches, and all higher
11981 headlines above the match.
11983 With a numeric prefix N, construct a sparse tree for the Nth element
11984 of `org-todo-keywords-1'."
11985 (interactive "P")
11986 (let ((case-fold-search nil)
11987 (kwd-re
11988 (cond ((null arg) org-not-done-regexp)
11989 ((equal arg '(4))
11990 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11991 (mapcar 'list org-todo-keywords-1))))
11995 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11996 (regexp-quote (nth (1- (prefix-numeric-value arg))
11997 org-todo-keywords-1)))
11998 (t (error "Invalid prefix argument: %s" arg)))))
11999 (message "%d TODO entries found"
12000 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12002 (defun org-deadline (&optional remove time)
12004 With argument REMOVE, remove any deadline from the item.
12005 With argument TIME, set the deadline at the corresponding date. TIME
12007 (interactive "P")
12008 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12009 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12010 'region-start-level 'region))
12011 org-loop-over-headlines-in-active-region)
12012 (org-map-entries
12013 `(org-deadline ',remove ,time)
12014 org-loop-over-headlines-in-active-region
12015 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12016 (let* ((old-date (org-entry-get nil "DEADLINE"))
12017 (repeater (and old-date
12018 (string-match
12020 old-date)
12021 (match-string 1 old-date))))
12022 (if remove
12023 (progn
12024 (when (and old-date org-log-redeadline)
12025 (org-add-log-setup 'deldeadline nil old-date 'findpos
12026 org-log-redeadline))
12027 (org-remove-timestamp-with-keyword org-deadline-string)
12028 (message "Item no longer has a deadline."))
12029 (org-add-planning-info 'deadline time 'closed)
12030 (when (and old-date org-log-redeadline
12031 (not (equal old-date
12032 (substring org-last-inserted-timestamp 1 -1))))
12033 (org-add-log-setup 'redeadline nil old-date 'findpos
12034 org-log-redeadline))
12035 (when repeater
12036 (save-excursion
12037 (org-back-to-heading t)
12038 (when (re-search-forward (concat org-deadline-string " "
12039 org-last-inserted-timestamp)
12040 (save-excursion
12041 (outline-next-heading) (point)) t)
12042 (goto-char (1- (match-end 0)))
12043 (insert " " repeater)
12044 (setq org-last-inserted-timestamp
12045 (concat (substring org-last-inserted-timestamp 0 -1)
12046 " " repeater
12047 (substring org-last-inserted-timestamp -1))))))
12048 (message "Deadline on %s" org-last-inserted-timestamp)))))
12050 (defun org-schedule (&optional remove time)
12051 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12052 With argument REMOVE, remove any scheduling date from the item.
12053 With argument TIME, scheduled at the corresponding date. TIME can
12055 (interactive "P")
12056 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12057 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12058 'region-start-level 'region))
12059 org-loop-over-headlines-in-active-region)
12060 (org-map-entries
12061 `(org-schedule ',remove ,time)
12062 org-loop-over-headlines-in-active-region
12063 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12064 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12065 (repeater (and old-date
12066 (string-match
12068 old-date)
12069 (match-string 1 old-date))))
12070 (if remove
12071 (progn
12072 (when (and old-date org-log-reschedule)
12073 (org-add-log-setup 'delschedule nil old-date 'findpos
12074 org-log-reschedule))
12075 (org-remove-timestamp-with-keyword org-scheduled-string)
12076 (message "Item is no longer scheduled."))
12077 (org-add-planning-info 'scheduled time 'closed)
12078 (when (and old-date org-log-reschedule
12079 (not (equal old-date
12080 (substring org-last-inserted-timestamp 1 -1))))
12081 (org-add-log-setup 'reschedule nil old-date 'findpos
12082 org-log-reschedule))
12083 (when repeater
12084 (save-excursion
12085 (org-back-to-heading t)
12086 (when (re-search-forward (concat org-scheduled-string " "
12087 org-last-inserted-timestamp)
12088 (save-excursion
12089 (outline-next-heading) (point)) t)
12090 (goto-char (1- (match-end 0)))
12091 (insert " " repeater)
12092 (setq org-last-inserted-timestamp
12093 (concat (substring org-last-inserted-timestamp 0 -1)
12094 " " repeater
12095 (substring org-last-inserted-timestamp -1))))))
12096 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12098 (defun org-get-scheduled-time (pom &optional inherit)
12099 "Get the scheduled time as a time tuple, of a format suitable
12100 for calling org-schedule with, or if there is no scheduling,
12101 returns nil."
12102 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12103 (when time
12104 (apply 'encode-time (org-parse-time-string time)))))
12106 (defun org-get-deadline-time (pom &optional inherit)
12107 "Get the deadline as a time tuple, of a format suitable for
12108 calling org-deadline with, or if there is no scheduling, returns
12109 nil."
12110 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12111 (when time
12112 (apply 'encode-time (org-parse-time-string time)))))
12114 (defun org-remove-timestamp-with-keyword (keyword)
12115 "Remove all time stamps with KEYWORD in the current entry."
12117 beg)
12118 (save-excursion
12119 (org-back-to-heading t)
12120 (setq beg (point))
12121 (outline-next-heading)
12122 (while (re-search-backward re beg t)
12123 (replace-match "")
12125 (equal (char-before) ?\ ))
12126 (backward-delete-char 1)
12128 (point-at-bol) (point-at-eol)))
12129 (delete-region (point-at-bol)
12130 (min (point-max) (1+ (point-at-eol))))))))))
12132 (defun org-add-planning-info (what &optional time &rest remove)
12133 "Insert new timestamp with keyword in the line directly after the headline.
12134 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12135 If non is given, the user is prompted for a date.
12136 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12137 be removed."
12138 (interactive)
12139 (let (org-time-was-given org-end-time-was-given ts
12140 end default-time default-input)
12142 (catch 'exit
12143 (when (and (memq what '(scheduled deadline))
12144 (or (not time)
12145 (and (stringp time)
12146 (string-match "^[-+]+[0-9]" time))))
12147 ;; Try to get a default date/time from existing timestamp
12148 (save-excursion
12149 (org-back-to-heading t)
12150 (setq end (save-excursion (outline-next-heading) (point)))
12151 (when (re-search-forward (if (eq what 'scheduled)
12152 org-scheduled-time-regexp
12153 org-deadline-time-regexp)
12154 end t)
12155 (setq ts (match-string 1)
12156 default-time
12157 (apply 'encode-time (org-parse-time-string ts))
12158 default-input (and ts (org-get-compact-tod ts))))))
12159 (when what
12160 (setq time
12161 (if (stringp time)
12162 ;; This is a string (relative or absolute), set proper date
12163 (apply 'encode-time
12164 (org-read-date-analyze
12165 time default-time (decode-time default-time)))
12166 ;; If necessary, get the time from the user
12167 (or time (org-read-date nil 'to-time nil nil
12168 default-time default-input)))))
12170 (when (and org-insert-labeled-timestamps-at-point
12171 (member what '(scheduled deadline)))
12172 (insert
12173 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12174 (org-insert-time-stamp time org-time-was-given
12175 nil nil nil (list org-end-time-was-given))
12176 (setq what nil))
12177 (save-excursion
12178 (save-restriction
12179 (let (col list elt ts buffer-invisibility-spec)
12180 (org-back-to-heading t)
12182 (goto-char (match-end 1))
12183 (setq col (current-column))
12184 (goto-char (match-end 0))
12186 (when (and (not what)
12187 (not (looking-at
12189 org-keyword-time-not-clock-regexp))))
12190 ;; Nothing to add, nothing to remove...... :-)
12191 (throw 'exit nil))
12192 (if (and (not (looking-at org-outline-regexp))
12195 (not (equal (match-string 1) org-clock-string)))
12196 (narrow-to-region (match-beginning 0) (match-end 0))
12198 (backward-char 1)
12199 (narrow-to-region (point) (point))
12200 (and org-adapt-indentation (org-indent-to-column col)))
12201 ;; Check if we have to remove something.
12202 (setq list (cons what remove))
12203 (while list
12204 (setq elt (pop list))
12205 (when (or (and (eq elt 'scheduled)
12206 (re-search-forward org-scheduled-time-regexp nil t))
12207 (and (eq elt 'deadline)
12208 (re-search-forward org-deadline-time-regexp nil t))
12209 (and (eq elt 'closed)
12210 (re-search-forward org-closed-time-regexp nil t)))
12211 (replace-match "")
12212 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12214 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12215 (when what
12216 (insert
12217 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12218 (cond ((eq what 'scheduled) org-scheduled-string)
12219 ((eq what 'deadline) org-deadline-string)
12220 ((eq what 'closed) org-closed-string))
12221 " ")
12222 (setq ts (org-insert-time-stamp
12223 time
12224 (or org-time-was-given
12225 (and (eq what 'closed) org-log-done-with-time))
12226 (eq what 'closed)
12227 nil nil (list org-end-time-was-given)))
12228 (insert
12229 (if (not (or (bolp) (eq (char-before) ?\ )
12230 (memq (char-after) '(32 10))
12231 (eobp))) " " ""))
12232 (end-of-line 1))
12233 (goto-char (point-min))
12234 (widen)
12237 (delete-region (1- (point)) (point-at-eol)))
12238 ts))))))
12240 (defvar org-log-note-marker (make-marker))
12241 (defvar org-log-note-purpose nil)
12242 (defvar org-log-note-state nil)
12243 (defvar org-log-note-previous-state nil)
12244 (defvar org-log-note-how nil)
12245 (defvar org-log-note-extra nil)
12246 (defvar org-log-note-window-configuration nil)
12247 (defvar org-log-note-return-to (make-marker))
12248 (defvar org-log-note-effective-time nil
12249 "Remembered current time so that dynamically scoped
12250 `org-extend-today-until' affects tha timestamps in state change
12251 log")
12253 (defvar org-log-post-message nil
12254 "Message to be displayed after a log note has been stored.
12255 The auto-repeater uses this.")
12257 (defun org-add-note ()
12258 "Add a note to the current entry.
12259 This is done in the same way as adding a state change note."
12260 (interactive)
12261 (org-add-log-setup 'note nil nil 'findpos nil))
12263 (defvar org-property-end-re)
12264 (defun org-add-log-setup (&optional purpose state prev-state
12265 findpos how extra)
12266 "Set up the post command hook to take a note.
12267 If this is about to TODO state change, the new state is expected in STATE.
12268 When FINDPOS is non-nil, find the correct position for the note in
12269 the current entry. If not, assume that it can be inserted at point.
12270 HOW is an indicator what kind of note should be created.
12271 EXTRA is additional text that will be inserted into the notes buffer."
12272 (let* ((org-log-into-drawer (org-log-into-drawer))
12273 (drawer (cond ((stringp org-log-into-drawer)
12274 org-log-into-drawer)
12275 (org-log-into-drawer "LOGBOOK")
12276 (t nil))))
12277 (save-restriction
12278 (save-excursion
12279 (when findpos
12280 (org-back-to-heading t)
12281 (narrow-to-region (point) (save-excursion
12282 (outline-next-heading) (point)))
12286 (goto-char (match-end 0))
12287 (cond
12288 (drawer
12290 nil t)
12291 (progn
12292 (goto-char (match-end 0))
12293 (or org-log-states-order-reversed
12294 (and (re-search-forward org-property-end-re nil t)
12295 (goto-char (1- (match-beginning 0))))))
12297 (beginning-of-line 0)
12298 (org-indent-line-function)
12299 (beginning-of-line 2)
12300 (org-indent-line-function)
12301 (end-of-line 0)))
12302 ((and org-log-state-notes-insert-after-drawers
12303 (save-excursion
12304 (forward-line) (looking-at org-drawer-regexp)))
12305 (forward-line)
12306 (while (looking-at org-drawer-regexp)
12307 (goto-char (match-end 0))
12308 (re-search-forward org-property-end-re (point-max) t)
12309 (forward-line))
12310 (forward-line -1)))
12311 (unless org-log-states-order-reversed
12313 (org-skip-over-state-notes)
12315 (move-marker org-log-note-marker (point))
12316 (setq org-log-note-purpose purpose
12317 org-log-note-state state
12318 org-log-note-previous-state prev-state
12319 org-log-note-how how
12320 org-log-note-extra extra
12321 org-log-note-effective-time (org-current-effective-time))
12322 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12324 (defun org-skip-over-state-notes ()
12325 "Skip past the list of State notes in an entry."
12327 (when (ignore-errors (goto-char (org-in-item-p)))
12328 (let* ((struct (org-list-struct))
12329 (prevs (org-list-prevs-alist struct)))
12331 (goto-char (or (org-list-get-next-item (point) struct prevs)
12332 (org-list-get-item-end (point) struct)))))))
12334 (defun org-add-log-note (&optional purpose)
12335 "Pop up a window for taking a note, and add this note later at point."
12336 (remove-hook 'post-command-hook 'org-add-log-note)
12337 (setq org-log-note-window-configuration (current-window-configuration))
12338 (delete-other-windows)
12339 (move-marker org-log-note-return-to (point))
12340 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12341 (goto-char org-log-note-marker)
12342 (org-switch-to-buffer-other-window "*Org Note*")
12343 (erase-buffer)
12344 (if (memq org-log-note-how '(time state))
12345 (let (current-prefix-arg) (org-store-log-note))
12346 (let ((org-inhibit-startup t)) (org-mode))
12347 (insert (format "# Insert note for %s.
12349 (cond
12350 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12351 ((eq org-log-note-purpose 'done) "closed todo item")
12352 ((eq org-log-note-purpose 'state)
12354 (or org-log-note-previous-state "")
12355 (or org-log-note-state "")))
12356 ((eq org-log-note-purpose 'reschedule)
12357 "rescheduling")
12358 ((eq org-log-note-purpose 'delschedule)
12359 "no longer scheduled")
12360 ((eq org-log-note-purpose 'redeadline)
12361 "changing deadline")
12362 ((eq org-log-note-purpose 'deldeadline)
12363 "removing deadline")
12364 ((eq org-log-note-purpose 'refile)
12365 "refiling")
12366 ((eq org-log-note-purpose 'note)
12367 "this entry")
12368 (t (error "This should not happen")))))
12369 (if org-log-note-extra (insert org-log-note-extra))
12370 (org-set-local 'org-finish-function 'org-store-log-note)
12371 (run-hooks 'org-log-buffer-setup-hook)))
12373 (defvar org-note-abort nil) ; dynamically scoped
12374 (defun org-store-log-note ()
12375 "Finish taking a log note, and insert it to where it belongs."
12376 (let ((txt (buffer-string))
12377 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12378 lines ind bul)
12379 (kill-buffer (current-buffer))
12381 (setq txt (replace-match "" t t txt)))
12383 (setq txt (replace-match "" t t txt)))
12386 (setq note
12387 (org-replace-escapes
12388 note
12389 (list (cons "%u" (user-login-name))
12390 (cons "%U" user-full-name)
12391 (cons "%t" (format-time-string
12392 (org-time-stamp-format 'long 'inactive)
12393 org-log-note-effective-time))
12394 (cons "%T" (format-time-string
12395 (org-time-stamp-format 'long nil)
12396 org-log-note-effective-time))
12397 (cons "%d" (format-time-string
12398 (org-time-stamp-format nil 'inactive)
12399 org-log-note-effective-time))
12400 (cons "%D" (format-time-string
12401 (org-time-stamp-format nil nil)
12402 org-log-note-effective-time))
12403 (cons "%s" (if org-log-note-state
12405 ""))
12406 (cons "%S" (if org-log-note-previous-state
12410 (push note lines))
12411 (when (or current-prefix-arg org-note-abort)
12412 (when org-log-into-drawer
12413 (org-remove-empty-drawer-at
12414 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12415 org-log-note-marker))
12416 (setq lines nil))
12417 (when lines
12418 (with-current-buffer (marker-buffer org-log-note-marker)
12419 (save-excursion
12420 (goto-char org-log-note-marker)
12421 (move-marker org-log-note-marker nil)
12422 (end-of-line 1)
12424 (setq ind (save-excursion
12425 (if (ignore-errors (goto-char (org-in-item-p)))
12426 (let ((struct (org-list-struct)))
12427 (org-list-get-ind
12428 (org-list-get-top-point struct) struct))
12430 (cond
12431 ((and (org-at-heading-p)
12432 org-adapt-indentation)
12433 (1+ (org-current-level)))
12434 ((org-at-heading-p) 0)
12435 (t (org-get-indentation))))))
12436 (setq bul (org-list-bullet-string "-"))
12437 (org-indent-line-to ind)
12438 (insert bul (pop lines))
12439 (let ((ind-body (+ (length bul) ind)))
12440 (while lines
12442 (org-indent-line-to ind-body)
12443 (insert (pop lines))))
12444 (message "Note stored")
12445 (org-back-to-heading t)
12446 (org-cycle-hide-drawers 'children)))))
12447 (set-window-configuration org-log-note-window-configuration)
12448 (with-current-buffer (marker-buffer org-log-note-return-to)
12449 (goto-char org-log-note-return-to))
12450 (move-marker org-log-note-return-to nil)
12451 (and org-log-post-message (message "%s" org-log-post-message)))
12453 (defun org-remove-empty-drawer-at (drawer pos)
12454 "Remove an empty drawer DRAWER at position POS.
12455 POS may also be a marker."
12456 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12457 (save-excursion
12458 (save-restriction
12459 (widen)
12460 (goto-char pos)
12461 (if (org-in-regexp
12463 (replace-match ""))))))
12465 (defun org-sparse-tree (&optional arg)
12466 "Create a sparse tree, prompt for the details.
12467 This command can create sparse trees. You first need to select the type
12468 of match used to create the tree:
12470 t Show all TODO entries.
12471 T Show entries with a specific TODO keyword.
12472 m Show entries selected by a tags/property match.
12473 p Enter a property name and its value (both with completion on existing
12474 names/values) and show entries with that property.
12475 r Show entries matching a regular expression (`/' can be used as well)
12476 d Show deadlines due within `org-deadline-warning-days'.
12477 b Show deadlines and scheduled items before a date.
12478 a Show deadlines and scheduled items after a date."
12479 (interactive "P")
12480 (let (ans kwd value)
12481 (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")
12482 (setq ans (read-char-exclusive))
12483 (cond
12484 ((equal ans ?d)
12485 (call-interactively 'org-check-deadlines))
12486 ((equal ans ?b)
12487 (call-interactively 'org-check-before-date))
12488 ((equal ans ?a)
12489 (call-interactively 'org-check-after-date))
12490 ((equal ans ?D)
12491 (call-interactively 'org-check-dates-range))
12492 ((equal ans ?t)
12493 (org-show-todo-tree nil))
12494 ((equal ans ?T)
12495 (org-show-todo-tree '(4)))
12496 ((member ans '(?T ?m))
12497 (call-interactively 'org-match-sparse-tree))
12498 ((member ans '(?p ?P))
12499 (setq kwd (org-icompleting-read "Property: "
12500 (mapcar 'list (org-buffer-property-keys))))
12501 (setq value (org-icompleting-read "Value: "
12502 (mapcar 'list (org-property-values kwd))))
12505 (org-match-sparse-tree arg (concat kwd "=" value)))
12506 ((member ans '(?r ?R ?/))
12507 (call-interactively 'org-occur))
12510 (defvar org-occur-highlights nil
12511 "List of overlays used for occur matches.")
12512 (make-variable-buffer-local 'org-occur-highlights)
12513 (defvar org-occur-parameters nil
12514 "Parameters of the active org-occur calls.
12515 This is a list, each call to org-occur pushes as cons cell,
12516 containing the regular expression and the callback, onto the list.
12517 The list can contain several entries if `org-occur' has been called
12518 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12519 will only contain one set of parameters. When the highlights are
12520 removed (for example with `C-c C-c', or with the next edit (depending
12521 on `org-remove-highlights-with-change'), this variable is emptied
12522 as well.")
12523 (make-variable-buffer-local 'org-occur-parameters)
12525 (defun org-occur (regexp &optional keep-previous callback)
12526 "Make a compact tree which shows all matches of REGEXP.
12527 The tree will show the lines where the regexp matches, and all higher
12528 headlines above the match. It will also show the heading after the match,
12529 to make sure editing the matching entry is easy.
12530 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12531 call to `org-occur' will be kept, to allow stacking of calls to this
12532 command.
12533 If CALLBACK is non-nil, it is a function which is called to confirm
12534 that the match should indeed be shown."
12536 (when (equal regexp "")
12537 (error "Regexp cannot be empty"))
12538 (unless keep-previous
12539 (org-remove-occur-highlights nil nil t))
12540 (push (cons regexp callback) org-occur-parameters)
12541 (let ((cnt 0))
12542 (save-excursion
12543 (goto-char (point-min))
12544 (if (or (not keep-previous) ; do not want to keep
12545 (not org-occur-highlights)) ; no previous matches
12546 ;; hide everything
12547 (org-overview))
12548 (while (re-search-forward regexp nil t)
12549 (when (or (not callback)
12550 (save-match-data (funcall callback)))
12551 (setq cnt (1+ cnt))
12552 (when org-highlight-sparse-tree-matches
12553 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12554 (org-show-context 'occur-tree))))
12555 (when org-remove-highlights-with-change
12556 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12557 nil 'local))
12558 (unless org-sparse-tree-open-archived-trees
12559 (org-hide-archived-subtrees (point-min) (point-max)))
12560 (run-hooks 'org-occur-hook)
12561 (if (org-called-interactively-p 'interactive)
12562 (message "%d match(es) for regexp %s" cnt regexp))
12563 cnt))
12565 (defun org-occur-next-match (&optional n reset)
12566 "Function for `next-error-function' to find sparse tree matches.
12567 N is the number of matches to move, when negative move backwards.
12568 RESET is entirely ignored - this function always goes back to the
12569 starting point when no match is found."
12570 (let* ((limit (if (< n 0) (point-min) (point-max)))
12571 (search-func (if (< n 0)
12572 'previous-single-char-property-change
12573 'next-single-char-property-change))
12574 (n (abs n))
12575 (pos (point))
12576 p1)
12577 (catch 'exit
12578 (while (setq p1 (funcall search-func (point) 'org-type))
12579 (when (equal p1 limit)
12580 (goto-char pos)
12581 (error "No more matches"))
12582 (when (equal (get-char-property p1 'org-type) 'org-occur)
12583 (setq n (1- n))
12584 (when (= n 0)
12585 (goto-char p1)
12586 (throw 'exit (point))))
12587 (goto-char p1))
12588 (goto-char p1)
12589 (error "No more matches"))))
12591 (defun org-show-context (&optional key)
12592 "Make sure point and context are visible.
12593 How much context is shown depends upon the variables
12594 `org-show-hierarchy-above', `org-show-following-heading',
12595 `org-show-entry-below' and `org-show-siblings'."
12596 (let ((heading-p (org-at-heading-p t))
12597 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12598 (following-p (org-get-alist-option org-show-following-heading key))
12599 (entry-p (org-get-alist-option org-show-entry-below key))
12600 (siblings-p (org-get-alist-option org-show-siblings key)))
12601 (catch 'exit
12602 ;; Show heading or entry text
12603 (if (and heading-p (not entry-p))
12604 (org-flag-heading nil) ; only show the heading
12605 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12606 (org-show-hidden-entry))) ; show entire entry
12607 (when following-p
12608 ;; Show next sibling, or heading below text
12609 (save-excursion
12610 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12611 (org-flag-heading nil))))
12612 (when siblings-p (org-show-siblings))
12613 (when hierarchy-p
12614 ;; show all higher headings, possibly with siblings
12615 (save-excursion
12616 (while (and (condition-case nil
12617 (progn (org-up-heading-all 1) t)
12618 (error nil))
12619 (not (bobp)))
12620 (org-flag-heading nil)
12621 (when siblings-p (org-show-siblings))))))))
12623 (defvar org-reveal-start-hook nil
12624 "Hook run before revealing a location.")
12626 (defun org-reveal (&optional siblings)
12627 "Show current entry, hierarchy above it, and the following headline.
12628 This can be used to show a consistent set of context around locations
12629 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12630 not t for the search context.
12632 With optional argument SIBLINGS, on each level of the hierarchy all
12633 siblings are shown. This repairs the tree structure to what it would
12634 look like when opened with hierarchical calls to `org-cycle'.
12636 go to the parent and show the
12637 entire tree."
12638 (interactive "P")
12639 (run-hooks 'org-reveal-start-hook)
12640 (let ((org-show-hierarchy-above t)
12641 (org-show-following-heading t)
12642 (org-show-siblings (if siblings t org-show-siblings)))
12643 (org-show-context nil))
12644 (when (equal siblings '(16))
12645 (save-excursion
12646 (when (org-up-heading-safe)
12647 (org-show-subtree)
12648 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12650 (defun org-highlight-new-match (beg end)
12651 "Highlight from BEG to END and mark the highlight is an occur headline."
12652 (let ((ov (make-overlay beg end)))
12653 (overlay-put ov 'face 'secondary-selection)
12654 (overlay-put ov 'org-type 'org-occur)
12655 (push ov org-occur-highlights)))
12657 (defun org-remove-occur-highlights (&optional beg end noremove)
12658 "Remove the occur highlights from the buffer.
12659 BEG and END are ignored. If NOREMOVE is nil, remove this function
12660 from the `before-change-functions' in the current buffer."
12661 (interactive)
12662 (unless org-inhibit-highlight-removal
12663 (mapc 'delete-overlay org-occur-highlights)
12664 (setq org-occur-highlights nil)
12665 (setq org-occur-parameters nil)
12666 (unless noremove
12667 (remove-hook 'before-change-functions
12668 'org-remove-occur-highlights 'local))))
12670 ;;;; Priorities
12673 "Regular expression matching the priority indicator.")
12675 (defvar org-remove-priority-next-time nil)
12677 (defun org-priority-up ()
12678 "Increase the priority of the current item."
12679 (interactive)
12680 (org-priority 'up))
12682 (defun org-priority-down ()
12683 "Decrease the priority of the current item."
12684 (interactive)
12685 (org-priority 'down))
12687 (defun org-priority (&optional action)
12688 "Change the priority of an item by ARG.
12689 ACTION can be `set', `up', `down', or a character."
12690 (interactive)
12691 (unless org-enable-priority-commands
12692 (error "Priority commands are disabled"))
12693 (setq action (or action 'set))
12694 (let (current new news have remove)
12695 (save-excursion
12696 (org-back-to-heading t)
12697 (if (looking-at org-priority-regexp)
12698 (setq current (string-to-char (match-string 2))
12699 have t))
12700 (cond
12701 ((eq action 'remove)
12702 (setq remove t new ?\ ))
12703 ((or (eq action 'set)
12704 (if (featurep 'xemacs) (characterp action) (integerp action)))
12705 (if (not (eq action 'set))
12706 (setq new action)
12707 (message "Priority %c-%c, SPC to remove: "
12708 org-highest-priority org-lowest-priority)
12709 (save-match-data
12710 (setq new (read-char-exclusive))))
12711 (if (and (= (upcase org-highest-priority) org-highest-priority)
12712 (= (upcase org-lowest-priority) org-lowest-priority))
12713 (setq new (upcase new)))
12714 (cond ((equal new ?\ ) (setq remove t))
12715 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12716 (error "Priority must be between `%c' and `%c'"
12717 org-highest-priority org-lowest-priority))))
12718 ((eq action 'up)
12719 (setq new (if have
12720 (1- current) ; normal cycling
12721 ;; last priority was empty
12722 (if (eq last-command this-command)
12723 org-lowest-priority ; wrap around empty to lowest
12724 ;; default
12725 (if org-priority-start-cycle-with-default
12726 org-default-priority
12727 (1- org-default-priority))))))
12728 ((eq action 'down)
12729 (setq new (if have
12730 (1+ current) ; normal cycling
12731 ;; last priority was empty
12732 (if (eq last-command this-command)
12733 org-highest-priority ; wrap around empty to highest
12734 ;; default
12735 (if org-priority-start-cycle-with-default
12736 org-default-priority
12737 (1+ org-default-priority))))))
12738 (t (error "Invalid action")))
12739 (if (or (< (upcase new) org-highest-priority)
12740 (> (upcase new) org-lowest-priority))
12741 (if (and (memq action '(up down))
12742 (not have) (not (eq last-command this-command)))
12743 ;; `new' is from default priority
12744 (error
12745 "The default can not be set, see `org-default-priority' why")
12746 ;; normal cycling: `new' is beyond highest/lowest priority
12747 ;; and is wrapped around to the empty priority
12748 (setq remove t)))
12749 (setq news (format "%c" new))
12750 (if have
12751 (if remove
12752 (replace-match "" t t nil 1)
12753 (replace-match news t t nil 2))
12754 (if remove
12755 (error "No priority cookie found in line")
12756 (let ((case-fold-search nil))
12757 (looking-at org-todo-line-regexp))
12758 (if (match-end 2)
12759 (progn
12760 (goto-char (match-end 2))
12761 (insert " [#" news "]"))
12762 (goto-char (match-beginning 3))
12763 (insert "[#" news "] "))))
12764 (org-preserve-lc (org-set-tags nil 'align)))
12765 (if remove
12766 (message "Priority removed")
12767 (message "Priority of current item set to %s" news))))
12769 (defun org-get-priority (s)
12770 "Find priority cookie and return priority."
12771 (if (functionp org-get-priority-function)
12772 (funcall org-get-priority-function)
12773 (save-match-data
12774 (if (not (string-match org-priority-regexp s))
12775 (* 1000 (- org-lowest-priority org-default-priority))
12776 (* 1000 (- org-lowest-priority
12777 (string-to-char (match-string 2 s))))))))
12779 ;;;; Tags
12781 (defvar org-agenda-archives-mode)
12782 (defvar org-map-continue-from nil
12783 "Position from where mapping should continue.
12784 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12786 (defvar org-scanner-tags nil
12787 "The current tag list while the tags scanner is running.")
12788 (defvar org-trust-scanner-tags nil
12789 "Should `org-get-tags-at' use the tags for the scanner.
12790 This is for internal dynamical scoping only.
12791 When this is non-nil, the function `org-get-tags-at' will return the value
12792 of `org-scanner-tags' instead of building the list by itself. This
12793 can lead to large speed-ups when the tags scanner is used in a file with
12794 many entries, and when the list of tags is retrieved, for example to
12795 obtain a list of properties. Building the tags list for each entry in such
12796 a file becomes an N^2 operation - but with this variable set, it scales
12797 as N.")
12799 (defun org-scan-tags (action matcher &optional todo-only start-level)
12800 "Scan headline tags with inheritance and produce output ACTION.
12802 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12803 or `agenda' to produce an entry list for an agenda view. It can also be
12804 a Lisp form or a function that should be called at each matched headline, in
12805 this case the return value is a list of all return values from these calls.
12807 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12808 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12809 only lines with a TODO keyword are included in the output.
12811 START-LEVEL can be a string with asterisks, reducing the scope to
12812 headlines matching this string."
12813 (require 'org-agenda)
12814 (let* ((re (concat "^"
12815 (if start-level
12816 ;; Get the correct level to match
12818 org-outline-regexp)
12821 (org-re
12823 (props (list 'face 'default
12824 'done-face 'org-agenda-done
12825 'undone-face 'default
12826 'mouse-face 'highlight
12827 'org-not-done-regexp org-not-done-regexp
12828 'org-todo-regexp org-todo-regexp
12829 'org-complex-heading-regexp org-complex-heading-regexp
12830 'help-echo
12831 (format "mouse-2 or RET jump to org file %s"
12832 (abbreviate-file-name
12833 (or (buffer-file-name (buffer-base-buffer))
12834 (buffer-name (buffer-base-buffer)))))))
12835 (case-fold-search nil)
12836 (org-map-continue-from nil)
12837 lspos tags
12838 (tags-alist (list (cons 0 org-file-tags)))
12839 (llast 0) rtn rtn1 level category i txt
12840 todo marker entry priority)
12841 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12842 (setq action (list 'lambda nil action)))
12843 (save-excursion
12844 (goto-char (point-min))
12845 (when (eq action 'sparse-tree)
12846 (org-overview)
12847 (org-remove-occur-highlights))
12848 (while (re-search-forward re nil t)
12849 (setq org-map-continue-from nil)
12850 (catch :skip
12851 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12852 tags (if (match-end 4) (org-match-string-no-properties 4)))
12853 (goto-char (setq lspos (match-beginning 0)))
12854 (setq level (org-reduced-level (funcall outline-level))
12855 category (org-get-category))
12856 (setq i llast llast level)
12857 ;; remove tag lists from same and sublevels
12858 (while (>= i level)
12859 (when (setq entry (assoc i tags-alist))
12860 (setq tags-alist (delete entry tags-alist)))
12861 (setq i (1- i)))
12862 ;; add the next tags
12863 (when tags
12864 (setq tags (org-split-string tags ":")
12865 tags-alist
12866 (cons (cons level tags) tags-alist)))
12867 ;; compile tags for current headline
12868 (setq tags-list
12869 (if org-use-tag-inheritance
12870 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12871 tags)
12872 org-scanner-tags tags-list)
12873 (when org-use-tag-inheritance
12874 (setcdr (car tags-alist)
12875 (mapcar (lambda (x)
12876 (setq x (copy-sequence x))
12877 (org-add-prop-inherited x))
12878 (cdar tags-alist))))
12879 (when (and tags org-use-tag-inheritance
12880 (or (not (eq t org-use-tag-inheritance))
12881 org-tags-exclude-from-inheritance))
12882 ;; selective inheritance, remove uninherited ones
12883 (setcdr (car tags-alist)
12884 (org-remove-uninherited-tags (cdar tags-alist))))
12885 (when (and
12887 ;; eval matcher only when the todo condition is OK
12888 (and (or (not todo-only) (member todo org-not-done-keywords))
12889 (let ((case-fold-search t)) (eval matcher)))
12891 ;; Call the skipper, but return t if it does not skip,
12892 ;; so that the `and' form continues evaluating
12893 (progn
12894 (unless (eq action 'sparse-tree) (org-agenda-skip))
12895 t)
12897 ;; Check if timestamps are deselecting this entry
12898 (or (not todo-only)
12899 (and (member todo org-not-done-keywords)
12900 (or (not org-agenda-tags-todo-honor-ignore-options)
12901 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12903 ;; Extra check for the archive tag
12904 ;; FIXME: Does the skipper already do this????
12905 (or
12906 (not (member org-archive-tag tags-list))
12907 ;; we have an archive tag, should we use this anyway?
12908 (or (not org-agenda-skip-archived-trees)
12909 (and (eq action 'agenda) org-agenda-archives-mode))))
12911 ;; select this headline
12913 (cond
12914 ((eq action 'sparse-tree)
12915 (and org-highlight-sparse-tree-matches
12916 (org-get-heading) (match-end 0)
12917 (org-highlight-new-match
12918 (match-beginning 1) (match-end 1)))
12919 (org-show-context 'tags-tree))
12920 ((eq action 'agenda)
12921 (setq txt (org-agenda-format-item
12922 ""
12923 (concat
12924 (if (eq org-tags-match-list-sublevels 'indented)
12925 (make-string (1- level) ?.) "")
12926 (org-get-heading))
12927 category
12928 tags-list)
12929 priority (org-get-priority txt))
12930 (goto-char lspos)
12931 (setq marker (org-agenda-new-marker))
12932 (org-add-props txt props
12933 'org-marker marker 'org-hd-marker marker 'org-category category
12934 'todo-state todo
12935 'priority priority 'type "tagsmatch")
12936 (push txt rtn))
12937 ((functionp action)
12938 (setq org-map-continue-from nil)
12939 (save-excursion
12940 (setq rtn1 (funcall action))
12941 (push rtn1 rtn)))
12942 (t (error "Invalid action")))
12944 ;; if we are to skip sublevels, jump to end of subtree
12945 (unless org-tags-match-list-sublevels
12946 (org-end-of-subtree t)
12947 (backward-char 1))))
12948 ;; Get the correct position from where to continue
12949 (if org-map-continue-from
12950 (goto-char org-map-continue-from)
12951 (and (= (point) lspos) (end-of-line 1)))))
12952 (when (and (eq action 'sparse-tree)
12953 (not org-sparse-tree-open-archived-trees))
12954 (org-hide-archived-subtrees (point-min) (point-max)))
12955 (nreverse rtn)))
12957 (defun org-remove-uninherited-tags (tags)
12958 "Remove all tags that are not inherited from the list TAGS."
12959 (cond
12960 ((eq org-use-tag-inheritance t)
12961 (if org-tags-exclude-from-inheritance
12962 (org-delete-all org-tags-exclude-from-inheritance tags)
12963 tags))
12964 ((not org-use-tag-inheritance) nil)
12965 ((stringp org-use-tag-inheritance)
12966 (delq nil (mapcar
12967 (lambda (x)
12968 (if (and (string-match org-use-tag-inheritance x)
12969 (not (member x org-tags-exclude-from-inheritance)))
12970 x nil))
12971 tags)))
12972 ((listp org-use-tag-inheritance)
12973 (delq nil (mapcar
12974 (lambda (x)
12975 (if (member x org-use-tag-inheritance) x nil))
12976 tags)))))
12978 (defvar todo-only) ;; dynamically scoped
12980 (defun org-match-sparse-tree (&optional todo-only match)
12981 "Create a sparse tree according to tags string MATCH.
12982 MATCH can contain positive and negative selection of tags, like
12984 If optional argument TODO-ONLY is non-nil, only select lines that are
12985 also TODO lines."
12986 (interactive "P")
12987 (org-prepare-agenda-buffers (list (current-buffer)))
12988 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12990 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12992 (defvar org-cached-props nil)
12993 (defun org-cached-entry-get (pom property)
12994 (if (or (eq t org-use-property-inheritance)
12995 (and (stringp org-use-property-inheritance)
12996 (string-match org-use-property-inheritance property))
12997 (and (listp org-use-property-inheritance)
12998 (member property org-use-property-inheritance)))
12999 ;; Caching is not possible, check it directly
13000 (org-entry-get pom property 'inherit)
13001 ;; Get all properties, so that we can do complicated checks easily
13002 (cdr (assoc property (or org-cached-props
13003 (setq org-cached-props
13004 (org-entry-properties pom)))))))
13006 (defun org-global-tags-completion-table (&optional files)
13007 "Return the list of all tags in all agenda buffer/files.
13008 Optional FILES argument is a list of files to which can be used
13009 instead of the agenda files."
13010 (save-excursion
13011 (org-uniquify
13012 (delq nil
13013 (apply 'append
13014 (mapcar
13015 (lambda (file)
13016 (set-buffer (find-file-noselect file))
13017 (append (org-get-buffer-tags)
13018 (mapcar (lambda (x) (if (stringp (car-safe x))
13019 (list (car-safe x)) nil))
13020 org-tag-alist)))
13021 (if (and files (car files))
13022 files
13023 (org-agenda-files))))))))
13025 (defun org-make-tags-matcher (match)
13026 "Create the TAGS/TODO matcher form for the selection string MATCH."
13027 ;; todo-only is scoped dynamically into this function, and the function
13028 ;; may change it if the matcher asks for it.
13029 (unless match
13030 ;; Get a new match request, with completion
13031 (let ((org-last-tags-completion-table
13032 (org-global-tags-completion-table)))
13033 (setq match (org-completing-read-no-i
13034 "Match: " 'org-tags-completion-function nil nil nil
13035 'org-tags-history))))
13037 ;; Parse the string and create a lisp form
13038 (let ((match0 match)
13039 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13040 minus tag mm
13041 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13042 orterms term orlist re-p str-p level-p level-op time-p
13043 prop-p pn pv po gv rest)
13044 (if (string-match "/+" match)
13045 ;; match contains also a todo-matching request
13046 (progn
13047 (setq tagsmatch (substring match 0 (match-beginning 0))
13048 todomatch (substring match (match-end 0)))
13049 (if (string-match "^!" todomatch)
13050 (setq todo-only t todomatch (substring todomatch 1)))
13052 (setq todomatch nil)))
13053 ;; only matching tags
13054 (setq tagsmatch match todomatch nil))
13056 ;; Make the tags matcher
13058 (setq tagsmatcher t)
13059 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13060 (while (setq term (pop orterms))
13062 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13063 (while (string-match re term)
13064 (setq rest (substring term (match-end 0))
13065 minus (and (match-end 1)
13066 (equal (match-string 1 term) "-"))
13067 tag (save-match-data (replace-regexp-in-string
13069 (match-string 2 term)))
13070 re-p (equal (string-to-char tag) ?{)
13071 level-p (match-end 4)
13072 prop-p (match-end 5)
13073 mm (cond
13074 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13075 (level-p
13076 (setq level-op (org-op-to-function (match-string 3 term)))
13077 `(,level-op level ,(string-to-number
13078 (match-string 4 term))))
13079 (prop-p
13080 (setq pn (match-string 5 term)
13081 po (match-string 6 term)
13082 pv (match-string 7 term)
13083 re-p (equal (string-to-char pv) ?{)
13085 time-p (save-match-data
13087 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13088 (if time-p (setq pv (org-matcher-time pv)))
13089 (setq po (org-op-to-function po (if time-p 'time str-p)))
13090 (cond
13091 ((equal pn "CATEGORY")
13092 (setq gv '(get-text-property (point) 'org-category)))
13093 ((equal pn "TODO")
13094 (setq gv 'todo))
13095 (t
13096 (setq gv `(org-cached-entry-get nil ,pn))))
13097 (if re-p
13098 (if (eq po 'org<>)
13099 `(not (string-match ,pv (or ,gv "")))
13100 `(string-match ,pv (or ,gv "")))
13101 (if str-p
13102 `(,po (or ,gv "") ,pv)
13103 `(,po (string-to-number (or ,gv ""))
13104 ,(string-to-number pv) ))))
13105 (t `(member ,tag tags-list)))
13106 mm (if minus (list 'not mm) mm)
13107 term rest)
13108 (push mm tagsmatcher))
13109 (push (if (> (length tagsmatcher) 1)
13110 (cons 'and tagsmatcher)
13111 (car tagsmatcher))
13112 orlist)
13113 (setq tagsmatcher nil))
13114 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13115 (setq tagsmatcher
13116 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13117 ;; Make the todo matcher
13119 (setq todomatcher t)
13120 (setq orterms (org-split-string todomatch "|") orlist nil)
13121 (while (setq term (pop orterms))
13122 (while (string-match re term)
13123 (setq minus (and (match-end 1)
13124 (equal (match-string 1 term) "-"))
13125 kwd (match-string 2 term)
13126 re-p (equal (string-to-char kwd) ?{)
13127 term (substring term (match-end 0))
13128 mm (if re-p
13129 `(string-match ,(substring kwd 1 -1) todo)
13130 (list 'equal 'todo kwd))
13131 mm (if minus (list 'not mm) mm))
13132 (push mm todomatcher))
13133 (push (if (> (length todomatcher) 1)
13134 (cons 'and todomatcher)
13135 (car todomatcher))
13136 orlist)
13137 (setq todomatcher nil))
13138 (setq todomatcher (if (> (length orlist) 1)
13139 (cons 'or orlist) (car orlist))))
13141 ;; Return the string and lisp forms of the matcher
13142 (setq matcher (if todomatcher
13143 (list 'and tagsmatcher todomatcher)
13144 tagsmatcher))
13145 (cons match0 matcher)))
13147 (defun org-op-to-function (op &optional stringp)
13148 "Turn an operator into the appropriate function."
13149 (setq op
13150 (cond
13151 ((equal op "<" ) '(< string< org-time<))
13152 ((equal op ">" ) '(> org-string> org-time>))
13153 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13154 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13155 ((member op '("=" "==")) '(= string= org-time=))
13156 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13157 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13159 (defun org<> (a b) (not (= a b)))
13160 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13161 (defun org-string>= (a b) (not (string< a b)))
13162 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13163 (defun org-string<> (a b) (not (string= a b)))
13164 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13165 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13166 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13167 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13168 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13169 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13170 (defun org-2ft (s)
13171 "Convert S to a floating point time.
13172 If S is already a number, just return it. If it is a string, parse
13173 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13174 (cond
13175 ((numberp s) s)
13176 ((stringp s)
13177 (condition-case nil
13178 (float-time (apply 'encode-time (org-parse-time-string s)))
13179 (error 0.)))
13180 (t 0.)))
13182 (defun org-time-today ()
13183 "Time in seconds today at 0:00.
13184 Returns the float number of seconds since the beginning of the
13185 epoch to the beginning of today (00:00)."
13186 (float-time (apply 'encode-time
13187 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13189 (defun org-matcher-time (s)
13190 "Interpret a time comparison value."
13191 (save-match-data
13192 (cond
13193 ((string= s "<now>") (float-time))
13194 ((string= s "<today>") (org-time-today))
13195 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13196 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13198 (+ (org-time-today)
13199 (* (string-to-number (match-string 1 s))
13200 (cdr (assoc (match-string 2 s)
13201 '(("d" . 86400.0) ("w" . 604800.0)
13202 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13203 (t (org-2ft s)))))
13205 (defun org-match-any-p (re list)
13206 "Does re match any element of list?"
13207 (setq list (mapcar (lambda (x) (string-match re x)) list))
13208 (delq nil list))
13210 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13211 (defvar org-tags-overlay (make-overlay 1 1))
13212 (org-detach-overlay org-tags-overlay)
13214 (defun org-get-local-tags-at (&optional pos)
13215 "Get a list of tags defined in the current headline."
13216 (org-get-tags-at pos 'local))
13218 (defun org-get-local-tags ()
13219 "Get a list of tags defined in the current headline."
13220 (org-get-tags-at nil 'local))
13222 (defun org-get-tags-at (&optional pos local)
13223 "Get a list of all headline tags applicable at POS.
13224 POS defaults to point. If tags are inherited, the list contains
13225 the targets in the same sequence as the headlines appear, i.e.
13226 the tags of the current headline come last.
13227 When LOCAL is non-nil, only return tags from the current headline,
13228 ignore inherited ones."
13229 (interactive)
13230 (if (and org-trust-scanner-tags
13231 (or (not pos) (equal pos (point)))
13232 (not local))
13233 org-scanner-tags
13234 (let (tags ltags lastpos parent)
13235 (save-excursion
13236 (save-restriction
13237 (widen)
13238 (goto-char (or pos (point)))
13239 (save-match-data
13240 (catch 'done
13241 (condition-case nil
13242 (progn
13243 (org-back-to-heading t)
13244 (while (not (equal lastpos (point)))
13245 (setq lastpos (point))
13246 (when (looking-at
13248 (setq ltags (org-split-string
13249 (org-match-string-no-properties 1) ":"))
13250 (when parent
13251 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13252 (setq tags (append
13253 (if parent
13254 (org-remove-uninherited-tags ltags)
13255 ltags)
13256 tags)))
13257 (or org-use-tag-inheritance (throw 'done t))
13258 (if local (throw 'done t))
13259 (or (org-up-heading-safe) (error nil))
13260 (setq parent t)))
13261 (error nil)))))
13262 (if local
13263 tags
13264 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13266 (defun org-add-prop-inherited (s)
13267 (add-text-properties 0 (length s) '(inherited t) s)
13268 s)
13270 (defun org-toggle-tag (tag &optional onoff)
13271 "Toggle the tag TAG for the current line.
13272 If ONOFF is `on' or `off', don't toggle but set to this state."
13273 (let (res current)
13274 (save-excursion
13275 (org-back-to-heading t)
13277 (point-at-eol) t)
13278 (progn
13279 (setq current (match-string 1))
13280 (replace-match ""))
13281 (setq current ""))
13282 (setq current (nreverse (org-split-string current ":")))
13283 (cond
13284 ((eq onoff 'on)
13285 (setq res t)
13286 (or (member tag current) (push tag current)))
13287 ((eq onoff 'off)
13288 (or (not (member tag current)) (setq current (delete tag current))))
13289 (t (if (member tag current)
13290 (setq current (delete tag current))
13291 (setq res t)
13292 (push tag current))))
13293 (end-of-line 1)
13294 (if current
13295 (progn
13296 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13297 (org-set-tags nil t))
13298 (delete-horizontal-space))
13299 (run-hooks 'org-after-tags-change-hook))
13300 res))
13302 (defun org-align-tags-here (to-col)
13303 ;; Assumes that this is a headline
13304 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13305 (beginning-of-line 1)
13307 (< pos (match-beginning 2)))
13308 (progn
13309 (setq tags-l (- (match-end 2) (match-beginning 2)))
13310 (goto-char (match-beginning 1))
13311 (insert " ")
13312 (delete-region (point) (1+ (match-beginning 2)))
13313 (setq ncol (max (current-column)
13314 (1+ col)
13315 (if (> to-col 0)
13316 to-col
13317 (- (abs to-col) tags-l))))
13318 (setq p (point))
13319 (insert (make-string (- ncol (current-column)) ?\ ))
13320 (setq ncol (current-column))
13321 (when indent-tabs-mode (tabify p (point-at-eol)))
13322 (org-move-to-column (min ncol col) t))
13323 (goto-char pos))))
13325 (defun org-set-tags-command (&optional arg just-align)
13326 "Call the set-tags command for the current entry."
13327 (interactive "P")
13328 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13329 (org-set-tags arg just-align)
13330 (save-excursion
13331 (org-back-to-heading t)
13332 (org-set-tags arg just-align))))
13334 (defun org-set-tags-to (data)
13335 "Set the tags of the current entry to DATA, replacing the current tags.
13336 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13337 If DATA is nil or the empty string, any tags will be removed."
13338 (interactive "sTags: ")
13339 (setq data
13340 (cond
13341 ((eq data nil) "")
13342 ((equal data "") "")
13343 ((stringp data)
13344 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13345 ":"))
13346 ((listp data)
13347 (concat ":" (mapconcat 'identity data ":") ":"))
13348 (t nil)))
13349 (when data
13350 (save-excursion
13351 (org-back-to-heading t)
13352 (when (looking-at org-complex-heading-regexp)
13353 (if (match-end 5)
13354 (progn
13355 (goto-char (match-beginning 5))
13356 (insert data)
13357 (delete-region (point) (point-at-eol))
13358 (org-set-tags nil 'align))
13359 (goto-char (point-at-eol))
13360 (insert " " data)
13361 (org-set-tags nil 'align)))
13362 (beginning-of-line 1)
13364 (delete-region (match-beginning 1) (match-end 1))))))
13366 (defun org-align-all-tags ()
13367 "Align the tags i all headings."
13368 (interactive)
13369 (save-excursion
13370 (or (ignore-errors (org-back-to-heading t))
13371 (outline-next-heading))
13372 (if (org-at-heading-p)
13373 (org-set-tags t)
13374 (message "No headings"))))
13376 (defvar org-indent-indentation-per-level)
13377 (defun org-set-tags (&optional arg just-align)
13378 "Set the tags for the current headline.
13379 With prefix ARG, realign all tags in headings in the current buffer."
13380 (interactive "P")
13381 (let* ((re org-outline-regexp-bol)
13382 (current (unless arg (org-get-tags-string)))
13383 (col (current-column))
13384 (org-setting-tags t)
13385 table current-tags inherited-tags ; computed below when needed
13386 tags p0 c0 c1 rpl di tc level)
13387 (if arg
13388 (save-excursion
13389 (goto-char (point-min))
13390 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13391 (while (re-search-forward re nil t)
13392 (org-set-tags nil t)
13393 (end-of-line 1)))
13394 (message "All tags realigned to column %d" org-tags-column))
13395 (if just-align
13396 (setq tags current)
13397 ;; Get a new set of tags from the user
13398 (save-excursion
13399 (setq table (append org-tag-persistent-alist
13400 (or org-tag-alist (org-get-buffer-tags))
13401 (and
13402 org-complete-tags-always-offer-all-agenda-tags
13403 (org-global-tags-completion-table
13404 (org-agenda-files))))
13405 org-last-tags-completion-table table
13406 current-tags (org-split-string current ":")
13407 inherited-tags (nreverse
13408 (nthcdr (length current-tags)
13409 (nreverse (org-get-tags-at))))
13410 tags
13411 (if (or (eq t org-use-fast-tag-selection)
13412 (and org-use-fast-tag-selection
13413 (delq nil (mapcar 'cdr table))))
13414 (org-fast-tag-selection
13415 current-tags inherited-tags table
13416 (if org-fast-tag-selection-include-todo
13417 org-todo-key-alist))
13418 (let ((org-add-colon-after-tag-completion t))
13419 (org-trim
13420 (org-icompleting-read "Tags: "
13421 'org-tags-completion-function
13422 nil nil current 'org-tags-history))))))
13423 (while (string-match "[-+&]+" tags)
13424 ;; No boolean logic, just a list
13425 (setq tags (replace-match ":" t t tags))))
13427 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13429 (if org-tags-sort-function
13430 (setq tags (mapconcat 'identity
13431 (sort (org-split-string
13432 tags (org-re "[^[:alnum:]_@#%]+"))
13433 org-tags-sort-function) ":")))
13436 (setq tags "")
13437 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13438 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13440 ;; Insert new tags at the correct column
13441 (beginning-of-line 1)
13442 (setq level (or (and (looking-at org-outline-regexp)
13443 (- (match-end 0) (point) 1))
13444 1))
13445 (cond
13446 ((and (equal current "") (equal tags "")))
13447 ((re-search-forward
13449 (point-at-eol) t)
13450 (if (equal tags "")
13451 (setq rpl "")
13452 (goto-char (match-beginning 0))
13453 (setq c0 (current-column)
13454 ;; compute offset for the case of org-indent-mode active
13455 di (if org-indent-mode
13456 (* (1- org-indent-indentation-per-level) (1- level))
13457 0)
13458 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13459 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13460 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13461 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13462 (replace-match rpl t t)
13463 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13464 tags)
13465 (t (error "Tags alignment failed")))
13466 (org-move-to-column col)
13467 (unless just-align
13468 (run-hooks 'org-after-tags-change-hook)))))
13470 (defun org-change-tag-in-region (beg end tag off)
13471 "Add or remove TAG for each entry in the region.
13472 This works in the agenda, and also in an org-mode buffer."
13473 (interactive
13474 (list (region-beginning) (region-end)
13475 (let ((org-last-tags-completion-table
13476 (if (eq major-mode 'org-mode)
13477 (org-get-buffer-tags)
13478 (org-global-tags-completion-table))))
13479 (org-icompleting-read
13480 "Tag: " 'org-tags-completion-function nil nil nil
13481 'org-tags-history))
13482 (progn
13484 (equal (read-char-exclusive) ?r))))
13485 (if (fboundp 'deactivate-mark) (deactivate-mark))
13486 (let ((agendap (equal major-mode 'org-agenda-mode))
13487 l1 l2 m buf pos newhead (cnt 0))
13488 (goto-char end)
13489 (setq l2 (1- (org-current-line)))
13490 (goto-char beg)
13491 (setq l1 (org-current-line))
13492 (loop for l from l1 to l2 do
13493 (org-goto-line l)
13494 (setq m (get-text-property (point) 'org-hd-marker))
13495 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13496 (and agendap m))
13497 (setq buf (if agendap (marker-buffer m) (current-buffer))
13498 pos (if agendap m (point)))
13499 (with-current-buffer buf
13500 (save-excursion
13501 (save-restriction
13502 (goto-char pos)
13503 (setq cnt (1+ cnt))
13504 (org-toggle-tag tag (if off 'off 'on))
13505 (setq newhead (org-get-heading)))))
13506 (and agendap (org-agenda-change-all-lines newhead m))))
13507 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13509 (defun org-tags-completion-function (string predicate &optional flag)
13510 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13511 (confirm (lambda (x) (stringp (car x)))))
13513 (setq s1 (match-string 1 string)
13514 s2 (match-string 2 string))
13515 (setq s1 "" s2 string))
13516 (cond
13517 ((eq flag nil)
13518 ;; try completion
13519 (setq rtn (try-completion s2 ctable confirm))
13520 (if (stringp rtn)
13521 (setq rtn
13522 (concat s1 s2 (substring rtn (length s2))
13523 (if (and org-add-colon-after-tag-completion
13524 (assoc rtn ctable))
13525 ":" ""))))
13526 rtn)
13527 ((eq flag t)
13528 ;; all-completions
13529 (all-completions s2 ctable confirm)
13530 )
13531 ((eq flag 'lambda)
13532 ;; exact match?
13533 (assoc s2 ctable)))
13534 ))
13536 (defun org-fast-tag-insert (kwd tags face &optional end)
13537 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13538 (insert (format "%-12s" (concat kwd ":"))
13539 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13540 (or end "")))
13542 (defun org-fast-tag-show-exit (flag)
13543 (save-excursion
13544 (org-goto-line 3)
13546 (replace-match ""))
13547 (when flag
13548 (end-of-line 1)
13549 (org-move-to-column (- (window-width) 19) t)
13550 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13552 (defun org-set-current-tags-overlay (current prefix)
13553 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13554 (if (featurep 'xemacs)
13555 (org-overlay-display org-tags-overlay (concat prefix s)
13556 'secondary-selection)
13557 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13558 (org-overlay-display org-tags-overlay (concat prefix s)))))
13560 (defvar org-last-tag-selection-key nil)
13561 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13562 "Fast tag selection with single keys.
13563 CURRENT is the current list of tags in the headline, INHERITED is the
13564 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13565 possibly with grouping information. TODO-TABLE is a similar table with
13566 TODO keywords, should these have keys assigned to them.
13567 If the keys are nil, a-z are automatically assigned.
13568 Returns the new tags string, or nil to not change the current settings."
13569 (let* ((fulltable (append table todo-table))
13570 (maxlen (apply 'max (mapcar
13571 (lambda (x)
13572 (if (stringp (car x)) (string-width (car x)) 0))
13573 fulltable)))
13574 (buf (current-buffer))
13575 (expert (eq org-fast-tag-selection-single-key 'expert))
13576 (buffer-tags nil)
13577 (fwidth (+ maxlen 3 1 3))
13578 (ncol (/ (- (window-width) 4) fwidth))
13579 (i-face 'org-done)
13580 (c-face 'org-todo)
13581 tg cnt e c char c1 c2 ntable tbl rtn
13582 ov-start ov-end ov-prefix
13583 (exit-after-next org-fast-tag-selection-single-key)
13584 (done-keywords org-done-keywords)
13585 groups ingroup)
13586 (save-excursion
13587 (beginning-of-line 1)
13588 (if (looking-at
13590 (setq ov-start (match-beginning 1)
13591 ov-end (match-end 1)
13592 ov-prefix "")
13593 (setq ov-start (1- (point-at-eol))
13594 ov-end (1+ ov-start))
13596 (setq ov-prefix
13597 (concat
13598 (buffer-substring (1- (point)) (point))
13599 (if (> (current-column) org-tags-column)
13600 " "
13601 (make-string (- org-tags-column (current-column)) ?\ ))))))
13602 (move-overlay org-tags-overlay ov-start ov-end)
13603 (save-window-excursion
13604 (if expert
13605 (set-buffer (get-buffer-create " *Org tags*"))
13606 (delete-other-windows)
13607 (split-window-vertically)
13608 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13609 (erase-buffer)
13610 (org-set-local 'org-done-keywords done-keywords)
13613 (org-fast-tag-show-exit exit-after-next)
13614 (org-set-current-tags-overlay current ov-prefix)
13615 (setq tbl fulltable char ?a cnt 0)
13616 (while (setq e (pop tbl))
13617 (cond
13618 ((equal (car e) :startgroup)
13619 (push '() groups) (setq ingroup t)
13620 (when (not (= cnt 0))
13621 (setq cnt 0)
13623 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13624 ((equal (car e) :endgroup)
13625 (setq ingroup nil cnt 0)
13627 ((equal e '(:newline))
13628 (when (not (= cnt 0))
13629 (setq cnt 0)
13631 (setq e (car tbl))
13632 (while (equal (car tbl) '(:newline))
13634 (setq tbl (cdr tbl)))))
13635 (t
13636 (setq tg (copy-sequence (car e)) c2 nil)
13637 (if (cdr e)
13638 (setq c (cdr e))
13639 ;; automatically assign a character.
13640 (setq c1 (string-to-char
13641 (downcase (substring
13642 tg (if (= (string-to-char tg) ?@) 1 0)))))
13643 (if (or (rassoc c1 ntable) (rassoc c1 table))
13644 (while (or (rassoc char ntable) (rassoc char table))
13645 (setq char (1+ char)))
13646 (setq c2 c1))
13647 (setq c (or c2 char)))
13648 (if ingroup (push tg (car groups)))
13649 (setq tg (org-add-props tg nil 'face
13650 (cond
13651 ((not (assoc tg table))
13652 (org-get-todo-face tg))
13653 ((member tg current) c-face)
13654 ((member tg inherited) i-face)
13655 (t nil))))
13656 (if (and (= cnt 0) (not ingroup)) (insert " "))
13657 (insert "[" c "] " tg (make-string
13658 (- fwidth 4 (length tg)) ?\ ))
13659 (push (cons tg c) ntable)
13660 (when (= (setq cnt (1+ cnt)) ncol)
13662 (if ingroup (insert " "))
13663 (setq cnt 0)))))
13664 (setq ntable (nreverse ntable))
13666 (goto-char (point-min))
13667 (if (not expert) (org-fit-window-to-buffer))
13668 (setq rtn
13669 (catch 'exit
13670 (while t
13671 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13672 (if (not groups) "no " "")
13673 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13674 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13675 (setq org-last-tag-selection-key c)
13676 (cond
13678 ((= c ?!)
13679 (setq groups (not groups))
13680 (goto-char (point-min))
13681 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13682 ((= c ?\C-c)
13683 (if (not expert)
13684 (org-fast-tag-show-exit
13685 (setq exit-after-next (not exit-after-next)))
13686 (setq expert nil)
13687 (delete-other-windows)
13688 (set-window-buffer (split-window-vertically) " *Org tags*")
13689 (org-switch-to-buffer-other-window " *Org tags*")
13690 (org-fit-window-to-buffer)))
13691 ((or (= c ?\C-g)
13692 (and (= c ?q) (not (rassoc c ntable))))
13693 (org-detach-overlay org-tags-overlay)
13694 (setq quit-flag t))
13695 ((= c ?\ )
13696 (setq current nil)
13697 (if exit-after-next (setq exit-after-next 'now)))
13699 (condition-case nil
13700 (setq tg (org-icompleting-read
13701 "Tag: "
13702 (or buffer-tags
13703 (with-current-buffer buf
13704 (org-get-buffer-tags)))))
13705 (quit (setq tg "")))
13707 (add-to-list 'buffer-tags (list tg))
13708 (if (member tg current)
13709 (setq current (delete tg current))
13710 (push tg current)))
13711 (if exit-after-next (setq exit-after-next 'now)))
13712 ((setq e (rassoc c todo-table) tg (car e))
13713 (with-current-buffer buf
13714 (save-excursion (org-todo tg)))
13715 (if exit-after-next (setq exit-after-next 'now)))
13716 ((setq e (rassoc c ntable) tg (car e))
13717 (if (member tg current)
13718 (setq current (delete tg current))
13719 (loop for g in groups do
13720 (if (member tg g)
13721 (mapc (lambda (x)
13722 (setq current (delete x current)))
13723 g)))
13724 (push tg current))
13725 (if exit-after-next (setq exit-after-next 'now))))
13727 ;; Create a sorted list
13728 (setq current
13729 (sort current
13730 (lambda (a b)
13731 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13732 (if (eq exit-after-next 'now) (throw 'exit t))
13733 (goto-char (point-min))
13734 (beginning-of-line 2)
13735 (delete-region (point) (point-at-eol))
13736 (org-fast-tag-insert "Current" current c-face)
13737 (org-set-current-tags-overlay current ov-prefix)
13738 (while (re-search-forward
13740 (setq tg (match-string 1))
13741 (add-text-properties
13742 (match-beginning 1) (match-end 1)
13743 (list 'face
13744 (cond
13745 ((member tg current) c-face)
13746 ((member tg inherited) i-face)
13747 (t (get-text-property (match-beginning 1) 'face))))))
13748 (goto-char (point-min)))))
13749 (org-detach-overlay org-tags-overlay)
13750 (if rtn
13751 (mapconcat 'identity current ":")
13752 nil))))
13754 (defun org-get-tags-string ()
13755 "Get the TAGS string in the current headline."
13756 (unless (org-at-heading-p t)
13757 (error "Not on a heading"))
13758 (save-excursion
13759 (beginning-of-line 1)
13761 (org-match-string-no-properties 1)
13762 "")))
13764 (defun org-get-tags ()
13765 "Get the list of tags specified in the current headline."
13766 (org-split-string (org-get-tags-string) ":"))
13768 (defun org-get-buffer-tags ()
13769 "Get a table of all tags used in the buffer, for completion."
13770 (let (tags)
13771 (save-excursion
13772 (goto-char (point-min))
13773 (while (re-search-forward
13775 (when (equal (char-after (point-at-bol 0)) ?*)
13776 (mapc (lambda (x) (add-to-list 'tags x))
13777 (org-split-string (org-match-string-no-properties 1) ":")))))
13778 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13779 (mapcar 'list tags)))
13781 ;;;; The mapping API
13783 ;;;###autoload
13784 (defun org-map-entries (func &optional match scope &rest skip)
13785 "Call FUNC at each headline selected by MATCH in SCOPE.
13787 FUNC is a function or a lisp form. The function will be called without
13788 arguments, with the cursor positioned at the beginning of the headline.
13789 The return values of all calls to the function will be collected and
13790 returned as a list.
13792 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13793 does not need to preserve point. After evaluation, the cursor will be
13794 moved to the end of the line (presumably of the headline of the
13795 processed entry) and search continues from there. Under some
13796 circumstances, this may not produce the wanted results. For example,
13797 if you have removed (e.g. archived) the current (sub)tree it could
13798 mean that the next entry will be skipped entirely. In such cases, you
13799 can specify the position from where search should continue by making
13800 FUNC set the variable `org-map-continue-from' to the desired buffer
13801 position.
13803 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13804 Only headlines that are matched by this query will be considered during
13805 the iteration. When MATCH is nil or t, all headlines will be
13806 visited by the iteration.
13808 SCOPE determines the scope of this command. It can be any of:
13810 nil The current buffer, respecting the restriction if any
13811 tree The subtree started with the entry at point
13812 region The entries within the active region, if any
13813 region-start-level
13814 The entries within the active region, but only those at
13815 the same level than the first one.
13816 file The current buffer, without restriction
13817 file-with-archives
13818 The current buffer, and any archives associated with it
13819 agenda All agenda files
13820 agenda-with-archives
13821 All agenda files with any archive files associated with them
13822 \(file1 file2 ...)
13823 If this is a list, all files in the list will be scanned
13825 The remaining args are treated as settings for the skipping facilities of
13826 the scanner. The following items can be given here:
13828 archive skip trees with the archive tag.
13829 comment skip trees with the COMMENT keyword
13830 function or Emacs Lisp form:
13831 will be used as value for `org-agenda-skip-function', so whenever
13832 the function returns t, FUNC will not be called for that
13833 entry and search will continue from the point where the
13834 function leaves it.
13836 If your function needs to retrieve the tags including inherited tags
13837 at the *current* entry, you can use the value of the variable
13838 `org-scanner-tags' which will be much faster than getting the value
13839 with `org-get-tags-at'. If your function gets properties with
13840 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13841 to t around the call to `org-entry-properties' to get the same speedup.
13842 Note that if your function moves around to retrieve tags and properties at
13843 a *different* entry, you cannot use these techniques."
13844 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13845 (not (org-region-active-p)))
13846 (let* ((org-agenda-archives-mode nil) ; just to make sure
13847 (org-agenda-skip-archived-trees (memq 'archive skip))
13848 (org-agenda-skip-comment-trees (memq 'comment skip))
13849 (org-agenda-skip-function
13850 (car (org-delete-all '(comment archive) skip)))
13851 (org-tags-match-list-sublevels t)
13852 (start-level (eq scope 'region-start-level))
13853 matcher file res
13854 org-todo-keywords-for-agenda
13855 org-done-keywords-for-agenda
13856 org-todo-keyword-alist-for-agenda
13857 org-drawers-for-agenda
13858 org-tag-alist-for-agenda)
13860 (cond
13861 ((eq match t) (setq matcher t))
13862 ((eq match nil) (setq matcher t))
13863 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13865 (save-excursion
13866 (save-restriction
13867 (cond ((eq scope 'tree)
13868 (org-back-to-heading t)
13869 (org-narrow-to-subtree)
13870 (setq scope nil))
13871 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13872 (org-region-active-p))
13873 ;; If needed, set start-level to a string like "2"
13874 (when start-level
13875 (save-excursion
13876 (goto-char (region-beginning))
13877 (unless (org-at-heading-p) (outline-next-heading))
13878 (setq start-level (org-current-level))))
13879 (narrow-to-region (region-beginning)
13880 (save-excursion
13881 (goto-char (region-end))
13882 (unless (and (bolp) (org-at-heading-p))
13883 (outline-next-heading))
13884 (point)))
13885 (setq scope nil)))
13887 (if (not scope)
13888 (progn
13889 (org-prepare-agenda-buffers
13890 (list (buffer-file-name (current-buffer))))
13891 (setq res (org-scan-tags func matcher nil start-level)))
13892 ;; Get the right scope
13893 (cond
13894 ((and scope (listp scope) (symbolp (car scope)))
13895 (setq scope (eval scope)))
13896 ((eq scope 'agenda)
13897 (setq scope (org-agenda-files t)))
13898 ((eq scope 'agenda-with-archives)
13899 (setq scope (org-agenda-files t))
13900 (setq scope (org-add-archive-files scope)))
13901 ((eq scope 'file)
13902 (setq scope (list (buffer-file-name))))
13903 ((eq scope 'file-with-archives)
13904 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13905 (org-prepare-agenda-buffers scope)
13906 (while (setq file (pop scope))
13907 (with-current-buffer (org-find-base-buffer-visiting file)
13908 (save-excursion
13909 (save-restriction
13910 (widen)
13911 (goto-char (point-min))
13912 (setq res (append res (org-scan-tags func matcher))))))))))
13913 res)))
13915 ;;;; Properties
13917 ;;; Setting and retrieving properties
13919 (defconst org-special-properties
13920 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13921 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13922 "The special properties valid in Org-mode.
13924 These are properties that are not defined in the property drawer,
13925 but in some other way.")
13927 (defconst org-default-properties
13928 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13929 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13930 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13931 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13932 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13933 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13934 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13935 "Some properties that are used by Org-mode for various purposes.
13936 Being in this list makes sure that they are offered for completion.")
13939 "Regular expression matching the first line of a property drawer.")
13942 "Regular expression matching the last line of a property drawer.")
13945 "Regular expression matching the first line of a property drawer.")
13948 "Regular expression matching the first line of a property drawer.")
13950 (defconst org-property-drawer-re
13953 "Matches an entire property drawer.")
13955 (defconst org-clock-drawer-re
13958 "Matches an entire clock drawer.")
13960 (defsubst org-re-property (property)
13961 "Return a regexp matching PROPERTY.
13962 Match group 1 will be set to the value "
13965 (defun org-property-action ()
13966 "Do an action on properties."
13967 (interactive)
13968 (let (c)
13969 (org-at-property-p)
13970 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13971 (setq c (read-char-exclusive))
13972 (cond
13973 ((equal c ?s)
13974 (call-interactively 'org-set-property))
13975 ((equal c ?d)
13976 (call-interactively 'org-delete-property))
13977 ((equal c ?D)
13978 (call-interactively 'org-delete-property-globally))
13979 ((equal c ?c)
13980 (call-interactively 'org-compute-property-at-point))
13981 (t (error "No such property action %c" c)))))
13983 (defun org-set-effort (&optional value)
13984 "Set the effort property of the current entry.
13985 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13986 allowed value."
13987 (interactive "P")
13988 (if (equal value 0) (setq value 10))
13989 (let* ((completion-ignore-case t)
13990 (prop org-effort-property)
13991 (cur (org-entry-get nil prop))
13992 (allowed (org-property-get-allowed-values nil prop 'table))
13993 (existing (mapcar 'list (org-property-values prop)))
13994 rpl
13995 (val (cond
13996 ((stringp value) value)
13997 ((and allowed (integerp value))
13998 (or (car (nth (1- value) allowed))
13999 (car (org-last allowed))))
14000 (allowed
14001 (message "Select 1-9,0, [RET%s]: %s"
14002 (if cur (concat "=" cur) "")
14003 (mapconcat 'car allowed " "))
14004 (setq rpl (read-char-exclusive))
14006 cur
14007 (setq rpl (- rpl ?0))
14008 (if (equal rpl 0) (setq rpl 10))
14009 (if (and (> rpl 0) (<= rpl (length allowed)))
14010 (car (nth (1- rpl) allowed))
14011 (org-completing-read "Effort: " allowed nil))))
14012 (t
14013 (let (org-completion-use-ido org-completion-use-iswitchb)
14014 (org-completing-read
14016 (concat "[" cur "]") "")
14017 ": ")
14018 existing nil nil "" nil cur))))))
14019 (unless (equal (org-entry-get nil prop) val)
14020 (org-entry-put nil prop val))
14021 (message "%s is now %s" prop val)))
14023 (defun org-at-property-p ()
14024 "Is cursor inside a property drawer?"
14025 (save-excursion
14026 (beginning-of-line 1)
14028 (save-match-data ;; Used by calling procedures
14029 (let ((p (point))
14030 (range (unless (org-before-first-heading-p)
14031 (org-get-property-block))))
14032 (and range (<= (car range) p) (< p (cdr range))))))))
14034 (defun org-get-property-block (&optional beg end force)
14035 "Return the (beg . end) range of the body of the property drawer.
14036 BEG and END can be beginning and end of subtree, if not given
14037 they will be found.
14038 If the drawer does not exist and FORCE is non-nil, create the drawer."
14039 (catch 'exit
14040 (save-excursion
14041 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14042 (end (or end (progn (outline-next-heading) (point)))))
14043 (goto-char beg)
14044 (if (re-search-forward org-property-start-re end t)
14045 (setq beg (1+ (match-end 0)))
14046 (if force
14047 (save-excursion
14048 (org-insert-property-drawer)
14049 (setq end (progn (outline-next-heading) (point))))
14050 (throw 'exit nil))
14051 (goto-char beg)
14052 (if (re-search-forward org-property-start-re end t)
14053 (setq beg (1+ (match-end 0)))))
14054 (if (re-search-forward org-property-end-re end t)
14055 (setq end (match-beginning 0))
14056 (or force (throw 'exit nil))
14057 (goto-char beg)
14058 (setq end beg)
14059 (org-indent-line-function)
14061 (cons beg end)))))
14063 (defun org-entry-properties (&optional pom which specific)
14064 "Get all properties of the entry at point-or-marker POM.
14065 This includes the TODO keyword, the tags, time strings for deadline,
14066 scheduled, and clocking, and any additional properties defined in the
14067 entry. The return value is an alist, keys may occur multiple times
14068 if the property key was used several times.
14069 POM may also be nil, in which case the current entry is used.
14070 If WHICH is nil or `all', get all properties. If WHICH is
14071 `special' or `standard', only get that subclass. If WHICH
14072 is a string only get exactly this property. SPECIFIC can be a string, the
14073 specific property we are interested in. Specifying it can speed
14074 things up because then unnecessary parsing is avoided."
14075 (setq which (or which 'all))
14076 (org-with-point-at pom
14077 (let ((clockstr (substring org-clock-string 0 -1))
14078 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14079 (case-fold-search nil)
14080 beg end range props sum-props key key1 value string clocksum)
14081 (save-excursion
14082 (when (condition-case nil
14083 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14084 (error nil))
14085 (setq beg (point))
14086 (setq sum-props (get-text-property (point) 'org-summaries))
14087 (setq clocksum (get-text-property (point) :org-clock-minutes))
14088 (outline-next-heading)
14089 (setq end (point))
14090 (when (memq which '(all special))
14091 ;; Get the special properties, like TODO and tags
14092 (goto-char beg)
14093 (when (and (or (not specific) (string= specific "TODO"))
14094 (looking-at org-todo-line-regexp) (match-end 2))
14095 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14096 (when (and (or (not specific) (string= specific "PRIORITY"))
14097 (looking-at org-priority-regexp))
14098 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14099 (when (or (not specific) (string= specific "FILE"))
14100 (push (cons "FILE" buffer-file-name) props))
14101 (when (and (or (not specific) (string= specific "TAGS"))
14102 (setq value (org-get-tags-string))
14104 (push (cons "TAGS" value) props))
14105 (when (and (or (not specific) (string= specific "ALLTAGS"))
14106 (setq value (org-get-tags-at)))
14107 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14108 ":"))
14109 props))
14110 (when (or (not specific) (string= specific "BLOCKED"))
14111 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14112 (when (or (not specific)
14113 (member specific
14114 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14115 "TIMESTAMP" "TIMESTAMP_IA")))
14116 (catch 'match
14117 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14118 (setq key (if (match-end 1)
14119 (substring (org-match-string-no-properties 1)
14120 0 -1))
14121 string (if (equal key clockstr)
14122 (org-no-properties
14123 (org-trim
14124 (buffer-substring
14125 (match-beginning 3) (goto-char
14126 (point-at-eol)))))
14127 (substring (org-match-string-no-properties 3)
14128 1 -1)))
14129 ;; Get the correct property name from the key. This is
14130 ;; necessary if the user has configured time keywords.
14131 (setq key1 (concat key ":"))
14132 (cond
14133 ((not key)
14134 (setq key
14135 (if (= (char-after (match-beginning 3)) ?\[)
14136 "TIMESTAMP_IA" "TIMESTAMP")))
14137 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14138 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14139 ((equal key1 org-closed-string) (setq key "CLOSED"))
14140 ((equal key1 org-clock-string) (setq key "CLOCK")))
14141 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14142 (progn
14143 (push (cons key string) props)
14144 ;; no need to search further if match is found
14145 (throw 'match t))
14146 (when (or (equal key "CLOCK") (not (assoc key props)))
14147 (push (cons key string) props))))))
14148 )
14150 (when (memq which '(all standard))
14151 ;; Get the standard properties, like :PROP: ...
14152 (setq range (org-get-property-block beg end))
14153 (when range
14154 (goto-char (car range))
14155 (while (re-search-forward
14157 (cdr range) t)
14158 (setq key (org-match-string-no-properties 1)
14159 value (org-trim (or (org-match-string-no-properties 2) "")))
14160 (unless (member key excluded)
14161 (push (cons key (or value "")) props)))))
14162 (if clocksum
14163 (push (cons "CLOCKSUM"
14164 (org-columns-number-to-string (/ (float clocksum) 60.)
14165 'add_times))
14166 props))
14167 (unless (assoc "CATEGORY" props)
14168 (push (cons "CATEGORY" (org-get-category)) props))
14169 (append sum-props (nreverse props)))))))
14171 (defun org-entry-get (pom property &optional inherit literal-nil)
14172 "Get value of PROPERTY for entry at point-or-marker POM.
14173 If INHERIT is non-nil and the entry does not have the property,
14174 then also check higher levels of the hierarchy.
14175 If INHERIT is the symbol `selective', use inheritance only if the setting
14176 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14177 If the property is present but empty, the return value is the empty string.
14178 If the property is not present at all, nil is returned.
14181 do not interpret it as the list atom nil. This is used for inheritance
14183 (org-with-point-at pom
14184 (if (and inherit (if (eq inherit 'selective)
14185 (org-property-inherit-p property)
14186 t))
14187 (org-entry-get-with-inheritance property literal-nil)
14188 (if (member property org-special-properties)
14189 ;; We need a special property. Use `org-entry-properties' to
14190 ;; retrieve it, but specify the wanted property
14191 (cdr (assoc property (org-entry-properties nil 'special property)))
14192 (let ((range (unless (org-before-first-heading-p)
14193 (org-get-property-block)))
14194 (props (list (or (assoc property org-file-properties)
14195 (assoc property org-global-properties)
14196 (assoc property org-global-properties-fixed))))
14197 val)
14198 (flet ((ap (key)
14199 (when (re-search-forward
14200 (org-re-property key) (cdr range) t)
14201 (setq props
14202 (org-update-property-plist
14203 key
14204 (if (match-end 1)
14205 (org-match-string-no-properties 1) "")
14206 props)))))
14207 (when (and range (goto-char (car range)))
14208 (ap property)
14209 (goto-char (car range))
14210 (while (ap (concat property "+")))
14211 (setq val (cdr (assoc property props)))
14212 (when val (if literal-nil val (org-not-nil val))))))))))
14214 (defun org-property-or-variable-value (var &optional inherit)
14215 "Check if there is a property fixing the value of VAR.
14216 If yes, return this value. If not, return the current value of the variable."
14217 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14219 (read prop)
14220 (symbol-value var))))
14222 (defun org-entry-delete (pom property)
14223 "Delete the property PROPERTY from entry at point-or-marker POM."
14224 (org-with-point-at pom
14225 (if (member property org-special-properties)
14226 nil ; cannot delete these properties.
14227 (let ((range (org-get-property-block)))
14228 (if (and range
14229 (goto-char (car range))
14230 (re-search-forward
14231 (org-re-property property)
14232 (cdr range) t))
14233 (progn
14234 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14235 t)
14236 nil)))))
14238 ;; Multi-values properties are properties that contain multiple values
14239 ;; These values are assumed to be single words, separated by whitespace.
14240 (defun org-entry-add-to-multivalued-property (pom property value)
14241 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14242 (let* ((old (org-entry-get pom property))
14244 (setq value (org-entry-protect-space value))
14245 (unless (member value values)
14246 (setq values (cons value values))
14247 (org-entry-put pom property
14248 (mapconcat 'identity values " ")))))
14250 (defun org-entry-remove-from-multivalued-property (pom property value)
14251 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14252 (let* ((old (org-entry-get pom property))
14254 (setq value (org-entry-protect-space value))
14255 (when (member value values)
14256 (setq values (delete value values))
14257 (org-entry-put pom property
14258 (mapconcat 'identity values " ")))))
14260 (defun org-entry-member-in-multivalued-property (pom property value)
14261 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14262 (let* ((old (org-entry-get pom property))
14264 (setq value (org-entry-protect-space value))
14265 (member value values)))
14267 (defun org-entry-get-multivalued-property (pom property)
14268 "Return a list of values in a multivalued property."
14269 (let* ((value (org-entry-get pom property))
14271 (mapcar 'org-entry-restore-space values)))
14273 (defun org-entry-put-multivalued-property (pom property &rest values)
14274 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14275 VALUES should be a list of strings. Spaces will be protected."
14276 (org-entry-put pom property
14277 (mapconcat 'org-entry-protect-space values " "))
14278 (let* ((value (org-entry-get pom property))
14280 (mapcar 'org-entry-restore-space values)))
14282 (defun org-entry-protect-space (s)
14283 "Protect spaces and newline in string S."
14284 (while (string-match " " s)
14285 (setq s (replace-match "%20" t t s)))
14287 (setq s (replace-match "%0A" t t s)))
14288 s)
14290 (defun org-entry-restore-space (s)
14291 "Restore spaces and newline in string S."
14292 (while (string-match "%20" s)
14293 (setq s (replace-match " " t t s)))
14294 (while (string-match "%0A" s)
14296 s)
14298 (defvar org-entry-property-inherited-from (make-marker)
14299 "Marker pointing to the entry from where a property was inherited.
14300 Each call to `org-entry-get-with-inheritance' will set this marker to the
14301 location of the entry where the inheritance search matched. If there was
14302 no match, the marker will point nowhere.
14303 Note that also `org-entry-get' calls this function, if the INHERIT flag
14304 is set.")
14306 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14307 "Get entry property, and search higher levels if not present.
14308 The search will stop at the first ancestor which has the property defined.
14310 should be considered as undefined (this is the meaning of nil here).
14312 (move-marker org-entry-property-inherited-from nil)
14313 (let (tmp)
14314 (unless (org-before-first-heading-p)
14315 (save-excursion
14316 (save-restriction
14317 (widen)
14318 (catch 'ex
14319 (while t
14320 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14321 (org-back-to-heading t)
14322 (move-marker org-entry-property-inherited-from (point))
14323 (throw 'ex tmp))
14324 (or (org-up-heading-safe) (throw 'ex nil)))))))
14325 (setq tmp (or tmp
14326 (cdr (assoc property org-file-properties))
14327 (cdr (assoc property org-global-properties))
14328 (cdr (assoc property org-global-properties-fixed))))
14329 (if literal-nil tmp (org-not-nil tmp))))
14331 (defvar org-property-changed-functions nil
14332 "Hook called when the value of a property has changed.
14333 Each hook function should accept two arguments, the name of the property
14334 and the new value.")
14336 (defun org-entry-put (pom property value)
14337 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14338 (org-with-point-at pom
14339 (org-back-to-heading t)
14340 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14341 range)
14342 (cond
14343 ((equal property "TODO")
14345 (not (member value org-todo-keywords-1)))
14347 (if (or (not value)
14349 (setq value 'none))
14350 (org-todo value)
14351 (org-set-tags nil 'align))
14352 ((equal property "PRIORITY")
14354 (string-to-char value) ?\ ))
14355 (org-set-tags nil 'align))
14356 ((equal property "SCHEDULED")
14357 (if (re-search-forward org-scheduled-time-regexp end t)
14358 (cond
14359 ((eq value 'earlier) (org-timestamp-change -1 'day))
14360 ((eq value 'later) (org-timestamp-change 1 'day))
14361 (t (call-interactively 'org-schedule)))
14362 (call-interactively 'org-schedule)))
14363 ((equal property "DEADLINE")
14364 (if (re-search-forward org-deadline-time-regexp end t)
14365 (cond
14366 ((eq value 'earlier) (org-timestamp-change -1 'day))
14367 ((eq value 'later) (org-timestamp-change 1 'day))
14368 (t (call-interactively 'org-deadline)))
14369 (call-interactively 'org-deadline)))
14370 ((member property org-special-properties)
14371 (error "The %s property can not yet be set with `org-entry-put'"
14372 property))
14373 (t ; a non-special property
14374 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14375 (setq range (org-get-property-block beg end 'force))
14376 (goto-char (car range))
14377 (if (re-search-forward
14378 (org-re-property property) (cdr range) t)
14379 (progn
14380 (delete-region (match-beginning 0) (match-end 0))
14381 (goto-char (match-beginning 0)))
14382 (goto-char (cdr range))
14384 (backward-char 1)
14385 (org-indent-line-function))
14386 (insert ":" property ":")
14387 (and value (insert " " value))
14388 (org-indent-line-function)))))
14389 (run-hook-with-args 'org-property-changed-functions property value)))
14391 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14392 "Get all property keys in the current buffer.
14393 With INCLUDE-SPECIALS, also list the special properties that reflect things
14394 like tags and TODO state.
14395 With INCLUDE-DEFAULTS, also include properties that has special meaning
14396 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14397 and others.
14398 With INCLUDE-COLUMNS, also include property names given in COLUMN
14399 formats in the current buffer."
14400 (let (rtn range cfmt s p)
14401 (save-excursion
14402 (save-restriction
14403 (widen)
14404 (goto-char (point-min))
14405 (while (re-search-forward org-property-start-re nil t)
14406 (setq range (org-get-property-block))
14407 (goto-char (car range))
14408 (while (re-search-forward
14410 (cdr range) t)
14411 (add-to-list 'rtn (org-match-string-no-properties 1)))
14412 (outline-next-heading))))
14414 (when include-specials
14415 (setq rtn (append org-special-properties rtn)))
14417 (when include-defaults
14418 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14419 (add-to-list 'rtn org-effort-property))
14421 (when include-columns
14422 (save-excursion
14423 (save-restriction
14424 (widen)
14425 (goto-char (point-min))
14426 (while (re-search-forward
14428 nil t)
14429 (setq cfmt (match-string 2) s 0)
14431 cfmt s)
14432 (setq s (match-end 0)
14433 p (match-string 1 cfmt))
14434 (unless (or (equal p "ITEM")
14435 (member p org-special-properties))
14436 (add-to-list 'rtn (match-string 1 cfmt))))))))
14438 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14440 (defun org-property-values (key)
14441 "Return a list of all values of property KEY in the current buffer."
14442 (save-excursion
14443 (save-restriction
14444 (widen)
14445 (goto-char (point-min))
14446 (let ((re (org-re-property key))
14447 values)
14448 (while (re-search-forward re nil t)
14449 (add-to-list 'values (org-trim (match-string 1))))
14450 (delete "" values)))))
14452 (defun org-insert-property-drawer ()
14453 "Insert a property drawer into the current entry."
14454 (org-back-to-heading t)
14455 (looking-at org-outline-regexp)
14456 (let ((indent (if org-adapt-indentation
14457 (- (match-end 0) (match-beginning 0))
14458 0))
14459 (beg (point))
14461 end hiddenp)
14462 (outline-next-heading)
14463 (setq end (point))
14464 (goto-char beg)
14465 (while (re-search-forward re end t))
14466 (setq hiddenp (outline-invisible-p))
14467 (end-of-line 1)
14470 (if (member (match-string 1) '("CLOCK:" ":END:"))
14471 ;; just skip this line
14472 (beginning-of-line 2)
14473 ;; Drawer start, find the end
14475 (beginning-of-line 1)))
14476 (org-skip-over-state-notes)
14478 (if (eq (char-before) ?*) (forward-char 1))
14480 (beginning-of-line 0)
14481 (org-indent-to-column indent)
14482 (beginning-of-line 2)
14483 (org-indent-to-column indent)
14484 (beginning-of-line 0)
14485 (if hiddenp
14486 (save-excursion
14487 (org-back-to-heading t)
14488 (hide-entry))
14489 (org-flag-drawer t))))
14491 (defun org-insert-drawer (&optional arg drawer)
14492 "Insert a drawer at point.
14494 Optional argument DRAWER, when non-nil, is a string representing
14495 drawer's name. Otherwise, the user is prompted for a name.
14497 If a region is active, insert the drawer around that region
14498 instead.
14500 Point is left between drawer's boundaries."
14501 (interactive "P")
14502 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14503 "LOGBOOK"))
14504 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14505 ;; internally by Org. They are meant to be inserted
14506 ;; automatically.
14507 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14508 ;; Remove system drawers from list. Note: For some reason,
14509 ;; `org-completing-read' ignores the predicate while
14510 ;; `completing-read' handles it fine.
14511 (drawer (if arg "PROPERTIES"
14512 (or drawer
14513 (completing-read
14514 "Drawer: " org-drawers
14515 (lambda (d) (not (member d system-drawers))))))))
14516 (cond
14517 ;; With C-u, fall back on `org-insert-property-drawer'
14518 (arg (org-insert-property-drawer))
14519 ;; With an active region, insert a drawer at point.
14520 ((not (org-region-active-p))
14521 (progn
14524 (forward-line -2)))
14525 ;; Otherwise, insert the drawer at point
14526 (t
14527 (let ((rbeg (region-beginning))
14528 (rend (copy-marker (region-end))))
14529 (unwind-protect
14530 (progn
14531 (goto-char rbeg)
14532 (beginning-of-line)
14533 (when (save-excursion
14534 (re-search-forward org-outline-regexp-bol rend t))
14535 (error "Drawers cannot contain headlines"))
14536 ;; Position point at the beginning of the first
14537 ;; non-blank line in region. Insert drawer's opening
14538 ;; there, then indent it.
14539 (org-skip-whitespace)
14540 (beginning-of-line)
14542 (forward-line -1)
14543 (indent-for-tab-command)
14544 ;; Move point to the beginning of the first blank line
14545 ;; after the last non-blank line in region. Insert
14546 ;; drawer's closing, then indent it.
14547 (goto-char rend)
14550 (indent-for-tab-command)
14552 ;; Clear marker, whatever the outcome of insertion is.
14553 (set-marker rend nil)))))))
14555 (defvar org-property-set-functions-alist nil
14556 "Property set function alist.
14557 Each entry should have the following format:
14559 (PROPERTY . READ-FUNCTION)
14561 The read function will be called with the same argument as
14562 `org-completing-read'.")
14564 (defun org-set-property-function (property)
14565 "Get the function that should be used to set PROPERTY.
14566 This is computed according to `org-property-set-functions-alist'."
14567 (or (cdr (assoc property org-property-set-functions-alist))
14568 'org-completing-read))
14570 (defun org-read-property-value (property)
14571 "Read PROPERTY value from user."
14572 (let* ((completion-ignore-case t)
14573 (allowed (org-property-get-allowed-values nil property 'table))
14574 (cur (org-entry-get nil property))
14575 (prompt (concat property " value"
14577 (concat " [" cur "]") "") ": "))
14578 (set-function (org-set-property-function property))
14579 (val (if allowed
14580 (funcall set-function prompt allowed nil
14581 (not (get-text-property 0 'org-unrestricted
14582 (caar allowed))))
14583 (let (org-completion-use-ido org-completion-use-iswitchb)
14584 (funcall set-function prompt
14585 (mapcar 'list (org-property-values property))
14586 nil nil "" nil cur)))))
14587 (if (equal val "")
14588 cur
14589 val)))
14591 (defvar org-last-set-property nil)
14592 (defun org-read-property-name ()
14593 "Read a property name."
14594 (let* ((completion-ignore-case t)
14595 (keys (org-buffer-property-keys nil t t))
14596 (default-prop (or (save-excursion
14597 (save-match-data
14598 (beginning-of-line)
14600 (null (string= (match-string 1) "END"))
14601 (match-string 1))))
14602 org-last-set-property))
14603 (property (org-icompleting-read
14604 (concat "Property"
14605 (if default-prop (concat " [" default-prop "]") "")
14606 ": ")
14607 (mapcar 'list keys)
14608 nil nil nil nil
14609 default-prop
14610 )))
14611 (if (member property keys)
14612 property
14613 (or (cdr (assoc (downcase property)
14614 (mapcar (lambda (x) (cons (downcase x) x))
14615 keys)))
14616 property))))
14618 (defun org-set-property (property value)
14619 "In the current entry, set PROPERTY to VALUE.
14620 When called interactively, this will prompt for a property name, offering
14621 completion on existing and default properties. And then it will prompt
14622 for a value, offering completion either on allowed values (via an inherited
14623 xxx_ALL property) or on existing values in other instances of this property
14624 in the current file."
14625 (interactive (list nil nil))
14626 (let* ((property (or property (org-read-property-name)))
14627 (value (or value (org-read-property-value property)))
14628 (fn (assoc property org-properties-postprocess-alist)))
14629 (setq org-last-set-property property)
14630 ;; Possibly postprocess the inserted value:
14631 (when fn (setq value (funcall (cadr fn) value)))
14632 (unless (equal (org-entry-get nil property) value)
14633 (org-entry-put nil property value))))
14635 (defun org-delete-property (property)
14636 "In the current entry, delete PROPERTY."
14637 (interactive
14638 (let* ((completion-ignore-case t)
14639 (prop (org-icompleting-read "Property: "
14640 (org-entry-properties nil 'standard))))
14641 (list prop)))
14642 (message "Property %s %s" property
14643 (if (org-entry-delete nil property)
14644 "deleted"
14645 "was not present in the entry")))
14647 (defun org-delete-property-globally (property)
14648 "Remove PROPERTY globally, from all entries."
14649 (interactive
14650 (let* ((completion-ignore-case t)
14651 (prop (org-icompleting-read
14652 "Globally remove property: "
14653 (mapcar 'list (org-buffer-property-keys)))))
14654 (list prop)))
14655 (save-excursion
14656 (save-restriction
14657 (widen)
14658 (goto-char (point-min))
14659 (let ((cnt 0))
14660 (while (re-search-forward
14661 (org-re-property property)
14662 nil t)
14663 (setq cnt (1+ cnt))
14664 (replace-match ""))
14667 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14669 (defun org-compute-property-at-point ()
14670 "Compute the property at point.
14671 This looks for an enclosing column format, extracts the operator and
14672 then applies it to the property in the column format's scope."
14673 (interactive)
14674 (unless (org-at-property-p)
14675 (error "Not at a property"))
14676 (let ((prop (org-match-string-no-properties 2)))
14677 (org-columns-get-format-and-top-level)
14678 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14679 (error "No operator defined for property %s" prop))
14680 (org-columns-compute prop)))
14682 (defvar org-property-allowed-value-functions nil
14683 "Hook for functions supplying allowed values for a specific property.
14684 The functions must take a single argument, the name of the property, and
14686 the values, this means that these values are intended as defaults for
14687 completion, but that other values should be allowed too.
14688 The functions must return nil if they are not responsible for this
14689 property.")
14691 (defun org-property-get-allowed-values (pom property &optional table)
14692 "Get allowed values for the property PROPERTY.
14693 When TABLE is non-nil, return an alist that can directly be used for
14694 completion."
14695 (let (vals)
14696 (cond
14697 ((equal property "TODO")
14698 (setq vals (org-with-point-at pom
14699 (append org-todo-keywords-1 '("")))))
14700 ((equal property "PRIORITY")
14701 (let ((n org-lowest-priority))
14702 (while (>= n org-highest-priority)
14703 (push (char-to-string n) vals)
14704 (setq n (1- n)))))
14705 ((member property org-special-properties))
14706 ((setq vals (run-hook-with-args-until-success
14707 'org-property-allowed-value-functions property)))
14708 (t
14709 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14711 (setq vals (car (read-from-string (concat "(" vals ")"))))
14712 (setq vals (mapcar (lambda (x)
14713 (cond ((stringp x) x)
14714 ((numberp x) (number-to-string x))
14715 ((symbolp x) (symbol-name x))
14716 (t "???")))
14717 vals)))))
14718 (when (member ":ETC" vals)
14719 (setq vals (remove ":ETC" vals))
14720 (org-add-props (car vals) '(org-unrestricted t)))
14721 (if table (mapcar 'list vals) vals)))
14723 (defun org-property-previous-allowed-value (&optional previous)
14724 "Switch to the next allowed value for this property."
14725 (interactive)
14726 (org-property-next-allowed-value t))
14728 (defun org-property-next-allowed-value (&optional previous)
14729 "Switch to the next allowed value for this property."
14730 (interactive)
14731 (unless (org-at-property-p)
14732 (error "Not at a property"))
14733 (let* ((key (match-string 2))
14734 (value (match-string 3))
14735 (allowed (or (org-property-get-allowed-values (point) key)
14736 (and (member value '("[ ]" "[-]" "[X]"))
14737 '("[ ]" "[X]"))))
14738 nval)
14739 (unless allowed
14740 (error "Allowed values for this property have not been defined"))
14741 (if previous (setq allowed (reverse allowed)))
14742 (if (member value allowed)
14743 (setq nval (car (cdr (member value allowed)))))
14744 (setq nval (or nval (car allowed)))
14745 (if (equal nval value)
14746 (error "Only one allowed value for this property"))
14747 (org-at-property-p)
14748 (replace-match (concat " :" key ": " nval) t t)
14749 (org-indent-line-function)
14750 (beginning-of-line 1)
14752 (run-hook-with-args 'org-property-changed-functions key nval)))
14754 (defun org-find-olp (path &optional this-buffer)
14755 "Return a marker pointing to the entry at outline path OLP.
14756 If anything goes wrong, throw an error.
14757 You can wrap this call to catch the error like this:
14759 (condition-case msg
14760 (org-mobile-locate-entry (match-string 4))
14761 (error (nth 1 msg)))
14763 The return value will then be either a string with the error message,
14764 or a marker if everything is OK.
14766 If THIS-BUFFER is set, the outline path does not contain a file,
14767 only headings."
14768 (let* ((file (if this-buffer buffer-file-name (pop path)))
14769 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14770 (level 1)
14771 (lmin 1)
14772 (lmax 1)
14773 limit re end found pos heading cnt flevel)
14774 (unless buffer (error "File not found :%s" file))
14775 (with-current-buffer buffer
14776 (save-excursion
14777 (save-restriction
14778 (widen)
14779 (setq limit (point-max))
14780 (goto-char (point-min))
14781 (while (setq heading (pop path))
14782 (setq re (format org-complex-heading-regexp-format
14783 (regexp-quote heading)))
14784 (setq cnt 0 pos (point))
14785 (while (re-search-forward re end t)
14786 (setq level (- (match-end 1) (match-beginning 1)))
14787 (if (and (>= level lmin) (<= level lmax))
14788 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14789 (when (= cnt 0) (error "Heading not found on level %d: %s"
14790 lmax heading))
14791 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14792 lmax heading))
14793 (goto-char found)
14794 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14795 (setq end (save-excursion (org-end-of-subtree t t))))
14796 (when (org-at-heading-p)
14797 (move-marker (make-marker) (point))))))))
14799 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14800 "Find node HEADING in BUFFER.
14801 Return a marker to the heading if it was found, or nil if not.
14802 If POS-ONLY is set, return just the position instead of a marker.
14804 The heading text must match exact, but it may have a TODO keyword,
14805 a priority cookie and tags in the standard locations."
14806 (with-current-buffer (or buffer (current-buffer))
14807 (save-excursion
14808 (save-restriction
14809 (widen)
14810 (goto-char (point-min))
14811 (let (case-fold-search)
14812 (if (re-search-forward
14813 (format org-complex-heading-regexp-format
14814 (regexp-quote heading)) nil t)
14815 (if pos-only
14816 (match-beginning 0)
14817 (move-marker (make-marker) (match-beginning 0)))))))))
14819 (defun org-find-exact-heading-in-directory (heading &optional dir)
14820 "Find Org node headline HEADING in all .org files in directory DIR.
14821 When the target headline is found, return a marker to this location."
14822 (let ((files (directory-files (or dir default-directory)
14824 file visiting m buffer)
14825 (catch 'found
14826 (while (setq file (pop files))
14827 (message "trying %s" file)
14828 (setq visiting (org-find-base-buffer-visiting file))
14829 (setq buffer (or visiting (find-file-noselect file)))
14830 (setq m (org-find-exact-headline-in-buffer
14831 heading buffer))
14832 (when (and (not m) (not visiting)) (kill-buffer buffer))
14833 (and m (throw 'found m))))))
14835 (defun org-find-entry-with-id (ident)
14836 "Locate the entry that contains the ID property with exact value IDENT.
14837 IDENT can be a string, a symbol or a number, this function will search for
14838 the string representation of it.
14839 Return the position where this entry starts, or nil if there is no such entry."
14840 (interactive "sID: ")
14841 (let ((id (cond
14842 ((stringp ident) ident)
14843 ((symbol-name ident) (symbol-name ident))
14844 ((numberp ident) (number-to-string ident))
14845 (t (error "IDENT %s must be a string, symbol or number" ident))))
14846 (case-fold-search nil))
14847 (save-excursion
14848 (save-restriction
14849 (widen)
14850 (goto-char (point-min))
14851 (when (re-search-forward
14853 nil t)
14854 (org-back-to-heading t)
14855 (point))))))
14857 ;;;; Timestamps
14859 (defvar org-last-changed-timestamp nil)
14860 (defvar org-last-inserted-timestamp nil
14861 "The last time stamp inserted with `org-insert-time-stamp'.")
14862 (defvar org-time-was-given) ; dynamically scoped parameter
14863 (defvar org-end-time-was-given) ; dynamically scoped parameter
14864 (defvar org-ts-what) ; dynamically scoped parameter
14866 (defun org-time-stamp (arg &optional inactive)
14867 "Prompt for a date/time and insert a time stamp.
14868 If the user specifies a time like HH:MM, or if this command is called
14869 with a prefix argument, the time stamp will contain date and time.
14870 Otherwise, only the date will be included. All parts of a date not
14871 specified by the user will be filled in from the current date/time.
14872 So if you press just return without typing anything, the time stamp
14873 will represent the current date/time. If there is already a timestamp
14874 at the cursor, it will be modified."
14875 (interactive "P")
14876 (let* ((ts nil)
14877 (default-time
14878 ;; Default time is either today, or, when entering a range,
14879 ;; the range start.
14880 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14881 (save-excursion
14882 (re-search-backward
14884 (- (point) 20) t)))
14885 (apply 'encode-time (org-parse-time-string (match-string 1)))
14886 (current-time)))
14887 (default-input (and ts (org-get-compact-tod ts)))
14888 (repeater (save-excursion
14889 (save-match-data
14890 (beginning-of-line)
14891 (when (re-search-forward
14893 (save-excursion (progn (end-of-line) (point))) t)
14894 (match-string 0)))))
14895 org-time-was-given org-end-time-was-given time)
14896 (cond
14897 ((and (org-at-timestamp-p t)
14898 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14899 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14900 (insert "--")
14901 (setq time (let ((this-command this-command))
14902 (org-read-date arg 'totime nil nil
14903 default-time default-input inactive)))
14904 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14905 ((org-at-timestamp-p t)
14906 (setq time (let ((this-command this-command))
14907 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14908 (when (org-at-timestamp-p t) ; just to get the match data
14909 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14910 (replace-match "")
14911 (setq org-last-changed-timestamp
14912 (org-insert-time-stamp
14913 time (or org-time-was-given arg)
14914 inactive nil nil (list org-end-time-was-given)))
14915 (when repeater (goto-char (1- (point))) (insert " " repeater)
14916 (setq org-last-changed-timestamp
14917 (concat (substring org-last-inserted-timestamp 0 -1)
14918 " " repeater ">"))))
14919 (message "Timestamp updated"))
14920 (t
14921 (setq time (let ((this-command this-command))
14922 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14923 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14924 nil nil (list org-end-time-was-given))))))
14926 ;; FIXME: can we use this for something else, like computing time differences?
14927 (defun org-get-compact-tod (s)
14928 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14929 (let* ((t1 (match-string 1 s))
14930 (h1 (string-to-number (match-string 2 s)))
14931 (m1 (string-to-number (match-string 3 s)))
14932 (t2 (and (match-end 4) (match-string 5 s)))
14933 (h2 (and t2 (string-to-number (match-string 6 s))))
14934 (m2 (and t2 (string-to-number (match-string 7 s))))
14935 dh dm)
14936 (if (not t2)
14937 t1
14938 (setq dh (- h2 h1) dm (- m2 m1))
14939 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14940 (concat t1 "+" (number-to-string dh)
14941 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14943 (defun org-time-stamp-inactive (&optional arg)
14944 "Insert an inactive time stamp.
14945 An inactive time stamp is enclosed in square brackets instead of angle
14946 brackets. It is inactive in the sense that it does not trigger agenda entries,
14947 does not link to the calendar and cannot be changed with the S-cursor keys.
14948 So these are more for recording a certain time/date."
14949 (interactive "P")
14950 (org-time-stamp arg 'inactive))
14952 (defvar org-date-ovl (make-overlay 1 1))
14953 (overlay-put org-date-ovl 'face 'org-warning)
14954 (org-detach-overlay org-date-ovl)
14956 (defvar org-ans1) ; dynamically scoped parameter
14957 (defvar org-ans2) ; dynamically scoped parameter
14959 (defvar org-plain-time-of-day-regexp) ; defined below
14961 (defvar org-overriding-default-time nil) ; dynamically scoped
14962 (defvar org-read-date-overlay nil)
14963 (defvar org-dcst nil) ; dynamically scoped
14964 (defvar org-read-date-history nil)
14965 (defvar org-read-date-final-answer nil)
14966 (defvar org-read-date-analyze-futurep nil)
14967 (defvar org-read-date-analyze-forced-year nil)
14969 (defun org-read-date (&optional with-time to-time from-string prompt
14970 default-time default-input inactive)
14971 "Read a date, possibly a time, and make things smooth for the user.
14972 The prompt will suggest to enter an ISO date, but you can also enter anything
14973 which will at least partially be understood by `parse-time-string'.
14974 Unrecognized parts of the date will default to the current day, month, year,
14975 hour and minute. If this command is called to replace a timestamp at point,
14976 or to enter the second timestamp of a range, the default time is taken
14977 from the existing stamp. Furthermore, the command prefers the future,
14978 so if you are giving a date where the year is not given, and the day-month
14979 combination is already past in the current year, it will assume you
14980 mean next year. For details, see the manual. A few examples:
14982 3-2-5 --> 2003-02-05
14983 feb 15 --> currentyear-02-15
14984 2/15 --> currentyear-02-15
14985 sep 12 9 --> 2009-09-12
14986 12:45 --> today 12:45
14987 22 sept 0:34 --> currentyear-09-22 0:34
14988 12 --> currentyear-currentmonth-12
14989 Fri --> nearest Friday (today or later)
14990 etc.
14992 Furthermore you can specify a relative date by giving, as the *first* thing
14993 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14994 change in days weeks, months, years.
14995 With a single plus or minus, the date is relative to today. With a double
14996 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14997 +4d --> four days from today
14998 +4 --> same as above
14999 +2w --> two weeks from today
15000 ++5 --> five days from default date
15002 The function understands only English month and weekday abbreviations,
15003 but this can be configured with the variables `parse-time-months' and
15004 `parse-time-weekdays'.
15006 While prompting, a calendar is popped up - you can also select the
15007 date with the mouse (button 1). The calendar shows a period of three
15008 months. To scroll it to other months, use the keys `>' and `<'.
15009 If you don't like the calendar, turn it off with
15010 \(setq org-read-date-popup-calendar nil)
15012 With optional argument TO-TIME, the date will immediately be converted
15013 to an internal time.
15014 With an optional argument WITH-TIME, the prompt will suggest to also
15015 insert a time. Note that when WITH-TIME is not set, you can still
15016 enter a time, and this function will inform the calling routine about
15017 this change. The calling routine may then choose to change the format
15018 used to insert the time stamp into the buffer to include the time.
15019 With optional argument FROM-STRING, read from this string instead from
15020 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15021 the time/date that is used for everything that is not specified by the
15022 user."
15023 (require 'parse-time)
15024 (let* ((org-time-stamp-rounding-minutes
15025 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15026 (org-dcst org-display-custom-times)
15027 (ct (org-current-time))
15028 (def (or org-overriding-default-time default-time ct))
15029 (defdecode (decode-time def))
15030 (dummy (progn
15031 (when (< (nth 2 defdecode) org-extend-today-until)
15032 (setcar (nthcdr 2 defdecode) -1)
15033 (setcar (nthcdr 1 defdecode) 59)
15034 (setq def (apply 'encode-time defdecode)
15035 defdecode (decode-time def)))))
15036 (calendar-frame-setup nil)
15037 (calendar-setup nil)
15038 (calendar-move-hook nil)
15039 (calendar-view-diary-initially-flag nil)
15040 (calendar-view-holidays-initially-flag nil)
15041 (timestr (format-time-string
15042 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
15043 (prompt (concat (if prompt (concat prompt " ") "")
15044 (format "Date+time [%s]: " timestr)))
15045 ans (org-ans0 "") org-ans1 org-ans2 final)
15047 (cond
15048 (from-string (setq ans from-string))
15049 (org-read-date-popup-calendar
15050 (save-excursion
15051 (save-window-excursion
15052 (calendar)
15053 (unwind-protect
15054 (progn
15055 (calendar-forward-day (- (time-to-days def)
15056 (calendar-absolute-from-gregorian
15057 (calendar-current-date))))
15058 (org-eval-in-calendar nil t)
15059 (let* ((old-map (current-local-map))
15060 (map (copy-keymap calendar-mode-map))
15061 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15062 (org-defkey map (kbd "RET") 'org-calendar-select)
15063 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15064 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15065 (org-defkey minibuffer-local-map [(meta shift left)]
15066 (lambda () (interactive)
15067 (org-eval-in-calendar '(calendar-backward-month 1))))
15068 (org-defkey minibuffer-local-map [(meta shift right)]
15069 (lambda () (interactive)
15070 (org-eval-in-calendar '(calendar-forward-month 1))))
15071 (org-defkey minibuffer-local-map [(meta shift up)]
15072 (lambda () (interactive)
15073 (org-eval-in-calendar '(calendar-backward-year 1))))
15074 (org-defkey minibuffer-local-map [(meta shift down)]
15075 (lambda () (interactive)
15076 (org-eval-in-calendar '(calendar-forward-year 1))))
15077 (org-defkey minibuffer-local-map [?\e (shift left)]
15078 (lambda () (interactive)
15079 (org-eval-in-calendar '(calendar-backward-month 1))))
15080 (org-defkey minibuffer-local-map [?\e (shift right)]
15081 (lambda () (interactive)
15082 (org-eval-in-calendar '(calendar-forward-month 1))))
15083 (org-defkey minibuffer-local-map [?\e (shift up)]
15084 (lambda () (interactive)
15085 (org-eval-in-calendar '(calendar-backward-year 1))))
15086 (org-defkey minibuffer-local-map [?\e (shift down)]
15087 (lambda () (interactive)
15088 (org-eval-in-calendar '(calendar-forward-year 1))))
15089 (org-defkey minibuffer-local-map [(shift up)]
15090 (lambda () (interactive)
15091 (org-eval-in-calendar '(calendar-backward-week 1))))
15092 (org-defkey minibuffer-local-map [(shift down)]
15093 (lambda () (interactive)
15094 (org-eval-in-calendar '(calendar-forward-week 1))))
15095 (org-defkey minibuffer-local-map [(shift left)]
15096 (lambda () (interactive)
15097 (org-eval-in-calendar '(calendar-backward-day 1))))
15098 (org-defkey minibuffer-local-map [(shift right)]
15099 (lambda () (interactive)
15100 (org-eval-in-calendar '(calendar-forward-day 1))))
15101 (org-defkey minibuffer-local-map ">"
15102 (lambda () (interactive)
15103 (org-eval-in-calendar '(scroll-calendar-left 1))))
15104 (org-defkey minibuffer-local-map "<"
15105 (lambda () (interactive)
15106 (org-eval-in-calendar '(scroll-calendar-right 1))))
15107 (org-defkey minibuffer-local-map "\C-v"
15108 (lambda () (interactive)
15109 (org-eval-in-calendar
15110 '(calendar-scroll-left-three-months 1))))
15111 (org-defkey minibuffer-local-map "\M-v"
15112 (lambda () (interactive)
15113 (org-eval-in-calendar
15114 '(calendar-scroll-right-three-months 1))))
15115 (run-hooks 'org-read-date-minibuffer-setup-hook)
15116 (unwind-protect
15117 (progn
15118 (use-local-map map)
15119 (setq org-read-date-inactive inactive)
15120 (add-hook 'post-command-hook 'org-read-date-display)
15121 (setq org-ans0 (read-string prompt default-input
15122 'org-read-date-history nil))
15123 ;; org-ans0: from prompt
15124 ;; org-ans1: from mouse click
15125 ;; org-ans2: from calendar motion
15126 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15127 (remove-hook 'post-command-hook 'org-read-date-display)
15128 (use-local-map old-map)
15129 (when org-read-date-overlay
15130 (delete-overlay org-read-date-overlay)
15131 (setq org-read-date-overlay nil)))))
15132 (bury-buffer "*Calendar*")))))
15134 (t ; Naked prompt only
15135 (unwind-protect
15136 (setq ans (read-string prompt default-input
15137 'org-read-date-history timestr))
15138 (when org-read-date-overlay
15139 (delete-overlay org-read-date-overlay)
15140 (setq org-read-date-overlay nil)))))
15142 (setq final (org-read-date-analyze ans def defdecode))
15144 (when org-read-date-analyze-forced-year
15145 (message "Year was forced into %s"
15146 (if org-read-date-force-compatible-dates
15147 "compatible range (1970-2037)"
15148 "range representable on this machine"))
15149 (ding))
15151 ;; One round trip to get rid of 34th of August and stuff like that....
15152 (setq final (decode-time (apply 'encode-time final)))
15154 (setq org-read-date-final-answer ans)
15156 (if to-time
15157 (apply 'encode-time final)
15158 (if (and (boundp 'org-time-was-given) org-time-was-given)
15159 (format "%04d-%02d-%02d %02d:%02d"
15160 (nth 5 final) (nth 4 final) (nth 3 final)
15161 (nth 2 final) (nth 1 final))
15162 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15164 (defvar def)
15165 (defvar defdecode)
15166 (defvar with-time)
15167 (defvar org-read-date-inactive)
15168 (defun org-read-date-display ()
15169 "Display the current date prompt interpretation in the minibuffer."
15170 (when org-read-date-display-live
15171 (when org-read-date-overlay
15172 (delete-overlay org-read-date-overlay))
15173 (let ((p (point)))
15174 (end-of-line 1)
15175 (while (not (equal (buffer-substring
15176 (max (point-min) (- (point) 4)) (point))
15177 " "))
15178 (insert " "))
15179 (goto-char p))
15180 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15181 " " (or org-ans1 org-ans2)))
15182 (org-end-time-was-given nil)
15183 (f (org-read-date-analyze ans def defdecode))
15184 (fmts (if org-dcst
15185 org-time-stamp-custom-formats
15186 org-time-stamp-formats))
15187 (fmt (if (or with-time
15188 (and (boundp 'org-time-was-given) org-time-was-given))
15189 (cdr fmts)
15190 (car fmts)))
15191 (txt (format-time-string fmt (apply 'encode-time f)))
15192 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15193 (txt (concat "=> " txt)))
15194 (when (and org-end-time-was-given
15195 (string-match org-plain-time-of-day-regexp txt))
15196 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15197 org-end-time-was-given
15198 (substring txt (match-end 0)))))
15199 (when org-read-date-analyze-futurep
15200 (setq txt (concat txt " (=>F)")))
15201 (setq org-read-date-overlay
15202 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15203 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15205 (defun org-read-date-analyze (ans def defdecode)
15206 "Analyze the combined answer of the date prompt."
15207 ;; FIXME: cleanup and comment
15208 (let ((nowdecode (decode-time (current-time)))
15209 delta deltan deltaw deltadef year month day
15210 hour minute second wday pm h2 m2 tl wday1
15211 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15212 (setq org-read-date-analyze-futurep nil
15213 org-read-date-analyze-forced-year nil)
15215 (setq ans "+0"))
15217 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15218 (setq ans (replace-match "" t t ans)
15219 deltan (car delta)
15220 deltaw (nth 1 delta)
15221 deltadef (nth 2 delta)))
15223 ;; Check if there is an iso week date in there
15224 ;; If yes, store the info and postpone interpreting it until the rest
15225 ;; of the parsing is done
15226 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15227 (setq iso-year (if (match-end 1)
15228 (org-small-year-to-year
15229 (string-to-number (match-string 1 ans))))
15230 iso-weekday (if (match-end 3)
15231 (string-to-number (match-string 3 ans)))
15232 iso-week (string-to-number (match-string 2 ans)))
15233 (setq ans (replace-match "" t t ans)))
15235 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15236 (when (string-match
15238 (setq year (if (match-end 2)
15239 (string-to-number (match-string 2 ans))
15240 (progn (setq kill-year t)
15241 (string-to-number (format-time-string "%Y"))))
15242 month (string-to-number (match-string 3 ans))
15243 day (string-to-number (match-string 4 ans)))
15244 (if (< year 100) (setq year (+ 2000 year)))
15246 t nil ans)))
15248 ;; Help matching dotted european dates
15249 (when (string-match
15250 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15251 (setq year (if (match-end 3)
15252 (string-to-number (match-string 3 ans))
15253 (progn (setq kill-year t)
15254 (string-to-number (format-time-string "%Y"))))
15255 day (string-to-number (match-string 1 ans))
15256 month (string-to-number (match-string 2 ans))
15258 t nil ans)))
15260 ;; Help matching american dates, like 5/30 or 5/30/7
15261 (when (string-match
15262 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15263 (setq year (if (match-end 4)
15264 (string-to-number (match-string 4 ans))
15265 (progn (setq kill-year t)
15266 (string-to-number (format-time-string "%Y"))))
15267 month (string-to-number (match-string 1 ans))
15268 day (string-to-number (match-string 2 ans)))
15269 (if (< year 100) (setq year (+ 2000 year)))
15271 t nil ans)))
15272 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15273 ;; If there is a time with am/pm, and *no* time without it, we convert
15274 ;; so that matching will be successful.
15275 (loop for i from 1 to 2 do ; twice, for end time as well
15278 (setq hour (string-to-number (match-string 1 ans))
15279 minute (if (match-end 3)
15280 (string-to-number (match-string 3 ans))
15281 0)
15282 pm (equal ?p
15283 (string-to-char (downcase (match-string 4 ans)))))
15284 (if (and (= hour 12) (not pm))
15285 (setq hour 0)
15286 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15287 (setq ans (replace-match (format "%02d:%02d" hour minute)
15288 t t ans))))
15290 ;; Check if a time range is given as a duration
15291 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15292 (setq hour (string-to-number (match-string 1 ans))
15293 h2 (+ hour (string-to-number (match-string 3 ans)))
15294 minute (string-to-number (match-string 2 ans))
15295 m2 (+ minute (if (match-end 5) (string-to-number
15296 (match-string 5 ans))0)))
15297 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15298 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15299 t t ans)))
15301 ;; Check if there is a time range
15302 (when (boundp 'org-end-time-was-given)
15303 (setq org-time-was-given nil)
15304 (when (and (string-match org-plain-time-of-day-regexp ans)
15305 (match-end 8))
15306 (setq org-end-time-was-given (match-string 8 ans))
15307 (setq ans (concat (substring ans 0 (match-beginning 7))
15308 (substring ans (match-end 7))))))
15310 (setq tl (parse-time-string ans)
15311 day (or (nth 3 tl) (nth 3 defdecode))
15312 month (or (nth 4 tl)
15313 (if (and org-read-date-prefer-future
15314 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15315 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15316 (nth 4 defdecode)))
15317 year (or (and (not kill-year) (nth 5 tl))
15318 (if (and org-read-date-prefer-future
15319 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15320 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15321 (nth 5 defdecode)))
15322 hour (or (nth 2 tl) (nth 2 defdecode))
15323 minute (or (nth 1 tl) (nth 1 defdecode))
15324 second (or (nth 0 tl) 0)
15325 wday (nth 6 tl))
15327 (when (and (eq org-read-date-prefer-future 'time)
15328 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15329 (equal day (nth 3 nowdecode))
15330 (equal month (nth 4 nowdecode))
15331 (equal year (nth 5 nowdecode))
15332 (nth 2 tl)
15333 (or (< (nth 2 tl) (nth 2 nowdecode))
15334 (and (= (nth 2 tl) (nth 2 nowdecode))
15335 (nth 1 tl)
15336 (< (nth 1 tl) (nth 1 nowdecode)))))
15337 (setq day (1+ day)
15338 futurep t))
15340 ;; Special date definitions below
15341 (cond
15342 (iso-week
15343 ;; There was an iso week
15344 (require 'cal-iso)
15345 (setq futurep nil)
15346 (setq year (or iso-year year)
15347 day (or iso-weekday wday 1)
15348 wday nil ; to make sure that the trigger below does not match
15349 iso-date (calendar-gregorian-from-absolute
15350 (calendar-absolute-from-iso
15351 (list iso-week day year))))
15352 ; FIXME: Should we also push ISO weeks into the future?
15353 ; (when (and org-read-date-prefer-future
15354 ; (not iso-year)
15355 ; (< (calendar-absolute-from-gregorian iso-date)
15356 ; (time-to-days (current-time))))
15357 ; (setq year (1+ year)
15358 ; iso-date (calendar-gregorian-from-absolute
15359 ; (calendar-absolute-from-iso
15360 ; (list iso-week day year)))))
15361 (setq month (car iso-date)
15362 year (nth 2 iso-date)
15363 day (nth 1 iso-date)))
15364 (deltan
15365 (setq futurep nil)
15366 (unless deltadef
15367 (let ((now (decode-time (current-time))))
15368 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15369 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15370 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15371 ((equal deltaw "m") (setq month (+ month deltan)))
15372 ((equal deltaw "y") (setq year (+ year deltan)))))
15373 ((and wday (not (nth 3 tl)))
15374 (setq futurep nil)
15375 ;; Weekday was given, but no day, so pick that day in the week
15376 ;; on or after the derived date.
15377 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15378 (unless (equal wday wday1)
15379 (setq day (+ day (% (- wday wday1 -7) 7))))))
15380 (if (and (boundp 'org-time-was-given)
15381 (nth 2 tl))
15382 (setq org-time-was-given t))
15383 (if (< year 100) (setq year (+ 2000 year)))
15384 ;; Check of the date is representable
15385 (if org-read-date-force-compatible-dates
15386 (progn
15387 (if (< year 1970)
15388 (setq year 1970 org-read-date-analyze-forced-year t))
15389 (if (> year 2037)
15390 (setq year 2037 org-read-date-analyze-forced-year t)))
15391 (condition-case nil
15392 (ignore (encode-time second minute hour day month year))
15393 (error
15394 (setq year (nth 5 defdecode))
15395 (setq org-read-date-analyze-forced-year t))))
15396 (setq org-read-date-analyze-futurep futurep)
15397 (list second minute hour day month year)))
15399 (defvar parse-time-weekdays)
15401 (defun org-read-date-get-relative (s today default)
15402 "Check string S for special relative date string.
15403 TODAY and DEFAULT are internal times, for today and for a default.
15404 Return shift list (N what def-flag)
15406 N is the number of WHATs to shift.
15407 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15408 the DEFAULT date rather than TODAY."
15409 (require 'parse-time)
15410 (when (and
15411 (string-match
15412 (concat
15417 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15418 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15419 (string-to-char (substring (match-string 1 s) -1))
15420 ?+))
15421 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15422 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15423 (what (if (match-end 3) (match-string 3 s) "d"))
15424 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15425 (date (if rel default today))
15426 (wday (nth 6 (decode-time date)))
15427 delta)
15428 (if wday1
15429 (progn
15430 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15431 (if (= dir ?-) (setq delta (- delta 7)))
15432 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15433 (list delta "d" rel))
15434 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15436 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15437 "Turn a user-specified date into the internal representation.
15438 The internal representation needed by the calendar is (month day year).
15439 This is a wrapper to handle the brain-dead convention in calendar that
15440 user function argument order change dependent on argument order."
15441 (if (boundp 'calendar-date-style)
15442 (cond
15443 ((eq calendar-date-style 'american)
15444 (list arg1 arg2 arg3))
15445 ((eq calendar-date-style 'european)
15446 (list arg2 arg1 arg3))
15447 ((eq calendar-date-style 'iso)
15448 (list arg2 arg3 arg1)))
15449 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15450 (if (org-bound-and-true-p european-calendar-style)
15451 (list arg2 arg1 arg3)
15452 (list arg1 arg2 arg3)))))
15454 (defun org-eval-in-calendar (form &optional keepdate)
15455 "Eval FORM in the calendar window and return to current window.
15456 Also, store the cursor date in variable org-ans2."
15457 (let ((sf (selected-frame))
15458 (sw (selected-window)))
15459 (select-window (get-buffer-window "*Calendar*" t))
15460 (eval form)
15461 (when (and (not keepdate) (calendar-cursor-to-date))
15462 (let* ((date (calendar-cursor-to-date))
15463 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15464 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15465 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15466 (select-window sw)
15467 (org-select-frame-set-input-focus sf)))
15469 (defun org-calendar-select ()
15470 "Return to `org-read-date' with the date currently selected.
15471 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15472 (interactive)
15473 (when (calendar-cursor-to-date)
15474 (let* ((date (calendar-cursor-to-date))
15475 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15476 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15477 (if (active-minibuffer-window) (exit-minibuffer))))
15479 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15480 "Insert a date stamp for the date given by the internal TIME.
15481 WITH-HM means use the stamp format that includes the time of the day.
15482 INACTIVE means use square brackets instead of angular ones, so that the
15483 stamp will not contribute to the agenda.
15484 PRE and POST are optional strings to be inserted before and after the
15485 stamp.
15486 The command returns the inserted time stamp."
15487 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15488 stamp)
15489 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15490 (insert-before-markers (or pre ""))
15491 (when (listp extra)
15492 (setq extra (car extra))
15493 (if (and (stringp extra)
15495 (setq extra (format "-%02d:%02d"
15496 (string-to-number (match-string 1 extra))
15497 (string-to-number (match-string 2 extra))))
15498 (setq extra nil)))
15499 (when extra
15500 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15501 (insert-before-markers (setq stamp (format-time-string fmt time)))
15502 (insert-before-markers (or post ""))
15503 (setq org-last-inserted-timestamp stamp)))
15505 (defun org-toggle-time-stamp-overlays ()
15506 "Toggle the use of custom time stamp formats."
15507 (interactive)
15508 (setq org-display-custom-times (not org-display-custom-times))
15509 (unless org-display-custom-times
15510 (let ((p (point-min)) (bmp (buffer-modified-p)))
15511 (while (setq p (next-single-property-change p 'display))
15512 (if (and (get-text-property p 'display)
15513 (eq (get-text-property p 'face) 'org-date))
15514 (remove-text-properties
15515 p (setq p (next-single-property-change p 'display))
15516 '(display t))))
15517 (set-buffer-modified-p bmp)))
15518 (if (featurep 'xemacs)
15519 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15520 (org-restart-font-lock)
15521 (setq org-table-may-need-update t)
15522 (if org-display-custom-times
15523 (message "Time stamps are overlaid with custom format")
15524 (message "Time stamp overlays removed")))
15526 (defun org-display-custom-time (beg end)
15527 "Overlay modified time stamp format over timestamp between BEG and END."
15528 (let* ((ts (buffer-substring beg end))
15529 t1 w1 with-hm tf time str w2 (off 0))
15530 (save-match-data
15531 (setq t1 (org-parse-time-string ts t))
15532 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15533 (setq off (- (match-end 0) (match-beginning 0)))))
15534 (setq end (- end off))
15535 (setq w1 (- end beg)
15536 with-hm (and (nth 1 t1) (nth 2 t1))
15537 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15538 time (org-fix-decoded-time t1)
15539 str (org-add-props
15540 (format-time-string
15541 (substring tf 1 -1) (apply 'encode-time time))
15542 nil 'mouse-face 'highlight)
15543 w2 (length str))
15544 (if (not (= w2 w1))
15545 (add-text-properties (1+ beg) (+ 2 beg)
15546 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15547 (if (featurep 'xemacs)
15548 (progn
15549 (put-text-property beg end 'invisible t)
15550 (put-text-property beg end 'end-glyph (make-glyph str)))
15551 (put-text-property beg end 'display str))))
15553 (defun org-translate-time (string)
15554 "Translate all timestamps in STRING to custom format.
15555 But do this only if the variable `org-display-custom-times' is set."
15556 (when org-display-custom-times
15557 (save-match-data
15558 (let* ((start 0)
15559 (re org-ts-regexp-both)
15560 t1 with-hm inactive tf time str beg end)
15561 (while (setq start (string-match re string start))
15562 (setq beg (match-beginning 0)
15563 end (match-end 0)
15564 t1 (save-match-data
15565 (org-parse-time-string (substring string beg end) t))
15566 with-hm (and (nth 1 t1) (nth 2 t1))
15567 inactive (equal (substring string beg (1+ beg)) "[")
15568 tf (funcall (if with-hm 'cdr 'car)
15569 org-time-stamp-custom-formats)
15570 time (org-fix-decoded-time t1)
15571 str (format-time-string
15572 (concat
15573 (if inactive "[" "<") (substring tf 1 -1)
15574 (if inactive "]" ">"))
15575 (apply 'encode-time time))
15576 string (replace-match str t t string)
15577 start (+ start (length str)))))))
15578 string)
15580 (defun org-fix-decoded-time (time)
15581 "Set 0 instead of nil for the first 6 elements of time.
15582 Don't touch the rest."
15583 (let ((n 0))
15584 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15586 (defun org-days-to-time (timestamp-string)
15587 "Difference between TIMESTAMP-STRING and now in days."
15588 (- (time-to-days (org-time-string-to-time timestamp-string))
15589 (time-to-days (current-time))))
15591 (defun org-deadline-close (timestamp-string &optional ndays)
15592 "Is the time in TIMESTAMP-STRING close to the current date?"
15593 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15594 (and (< (org-days-to-time timestamp-string) ndays)
15595 (not (org-entry-is-done-p))))
15597 (defun org-get-wdays (ts)
15598 "Get the deadline lead time appropriate for timestring TS."
15599 (cond
15600 ((<= org-deadline-warning-days 0)
15601 ;; 0 or negative, enforce this value no matter what
15602 (- org-deadline-warning-days))
15604 ;; lead time is specified.
15605 (floor (* (string-to-number (match-string 1 ts))
15606 (cdr (assoc (match-string 2 ts)
15607 '(("d" . 1) ("w" . 7)
15608 ("m" . 30.4) ("y" . 365.25)))))))
15609 ;; go for the default.
15610 (t org-deadline-warning-days)))
15612 (defun org-calendar-select-mouse (ev)
15613 "Return to `org-read-date' with the date currently selected.
15614 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15615 (interactive "e")
15616 (mouse-set-point ev)
15617 (when (calendar-cursor-to-date)
15618 (let* ((date (calendar-cursor-to-date))
15619 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15620 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15621 (if (active-minibuffer-window) (exit-minibuffer))))
15623 (defun org-check-deadlines (ndays)
15624 "Check if there are any deadlines due or past due.
15625 A deadline is considered due if it happens within `org-deadline-warning-days'
15626 days from today's date. If the deadline appears in an entry marked DONE,
15627 it is not shown. The prefix arg NDAYS can be used to test that many
15629 (interactive "P")
15630 (let* ((org-warn-days
15631 (cond
15632 ((equal ndays '(4)) 100000)
15633 (ndays (prefix-numeric-value ndays))
15634 (t (abs org-deadline-warning-days))))
15635 (case-fold-search nil)
15637 (callback
15638 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15640 (message "%d deadlines past-due or due within %d days"
15641 (org-occur regexp nil callback)
15642 org-warn-days)))
15644 (defun org-check-before-date (date)
15645 "Check if there are deadlines or scheduled entries before DATE."
15646 (interactive (list (org-read-date)))
15647 (let ((case-fold-search nil)
15651 (callback
15652 (lambda () (time-less-p
15653 (org-time-string-to-time (match-string 2))
15654 (org-time-string-to-time date)))))
15655 (message "%d entries before %s"
15656 (org-occur regexp nil callback) date)))
15658 (defun org-check-after-date (date)
15659 "Check if there are deadlines or scheduled entries after DATE."
15660 (interactive (list (org-read-date)))
15661 (let ((case-fold-search nil)
15665 (callback
15666 (lambda () (not
15667 (time-less-p
15668 (org-time-string-to-time (match-string 2))
15669 (org-time-string-to-time date))))))
15670 (message "%d entries after %s"
15671 (org-occur regexp nil callback) date)))
15673 (defun org-check-dates-range (start-date end-date)
15674 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15675 (interactive (list (org-read-date nil nil nil "Range starts")
15676 (org-read-date nil nil nil "Range end")))
15677 (let ((case-fold-search nil)
15681 (callback
15682 (lambda ()
15683 (let ((match (match-string 2)))
15684 (and
15685 (not (time-less-p
15686 (org-time-string-to-time match)
15687 (org-time-string-to-time start-date)))
15688 (time-less-p
15689 (org-time-string-to-time match)
15690 (org-time-string-to-time end-date)))))))
15691 (message "%d entries between %s and %s"
15692 (org-occur regexp nil callback) start-date end-date)))
15694 (defun org-evaluate-time-range (&optional to-buffer)
15695 "Evaluate a time range by computing the difference between start and end.
15696 Normally the result is just printed in the echo area, but with prefix arg
15697 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15698 If the time range is actually in a table, the result is inserted into the
15699 next column.
15700 For time difference computation, a year is assumed to be exactly 365
15701 days in order to avoid rounding problems."
15702 (interactive "P")
15703 (or
15704 (org-clock-update-time-maybe)
15705 (save-excursion
15706 (unless (org-at-date-range-p t)
15707 (goto-char (point-at-bol))
15708 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15709 (if (not (org-at-date-range-p t))
15710 (error "Not at a time-stamp range, and none found in current line")))
15711 (let* ((ts1 (match-string 1))
15712 (ts2 (match-string 2))
15713 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15714 (match-end (match-end 0))
15715 (time1 (org-time-string-to-time ts1))
15716 (time2 (org-time-string-to-time ts2))
15717 (t1 (org-float-time time1))
15718 (t2 (org-float-time time2))
15719 (diff (abs (- t2 t1)))
15720 (negative (< (- t2 t1) 0))
15721 ;; (ys (floor (* 365 24 60 60)))
15722 (ds (* 24 60 60))
15723 (hs (* 60 60))
15724 (fy "%dy %dd %02d:%02d")
15725 (fy1 "%dy %dd")
15726 (fd "%dd %02d:%02d")
15727 (fd1 "%dd")
15728 (fh "%02d:%02d")
15729 y d h m align)
15730 (if havetime
15731 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15732 y 0
15733 d (floor (/ diff ds)) diff (mod diff ds)
15734 h (floor (/ diff hs)) diff (mod diff hs)
15735 m (floor (/ diff 60)))
15736 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15737 y 0
15738 d (floor (+ (/ diff ds) 0.5))
15739 h 0 m 0))
15740 (if (not to-buffer)
15741 (message "%s" (org-make-tdiff-string y d h m))
15742 (if (org-at-table-p)
15743 (progn
15744 (goto-char match-end)
15745 (setq align t)
15746 (and (looking-at " *|") (goto-char (match-end 0))))
15747 (goto-char match-end))
15748 (if (looking-at
15750 (replace-match ""))
15751 (if negative (insert " -"))
15752 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15753 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15754 (insert " " (format fh h m))))
15755 (if align (org-table-align))
15756 (message "Time difference inserted")))))
15758 (defun org-make-tdiff-string (y d h m)
15759 (let ((fmt "")
15760 (l nil))
15761 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15762 l (push y l)))
15763 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15764 l (push d l)))
15765 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15766 l (push h l)))
15767 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15768 l (push m l)))
15769 (apply 'format fmt (nreverse l))))
15771 (defun org-time-string-to-time (s &optional buffer pos)
15772 (condition-case errdata
15773 (apply 'encode-time (org-parse-time-string s))
15775 s (if (not (and buffer pos))
15776 ""
15777 (format " at %d in buffer `%s'" pos buffer))
15778 (cdr errdata)))))
15780 (defun org-time-string-to-seconds (s)
15781 (org-float-time (org-time-string-to-time s)))
15783 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15784 "Convert a time stamp to an absolute day number.
15785 If there is a specifier for a cyclic time stamp, get the closest date to
15786 DAYNR.
15787 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15788 The variable date is bound by the calendar when this is called."
15789 (cond
15791 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15792 daynr
15793 (+ daynr 1000)))
15795 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15796 (time-to-days (current-time))) (match-string 0 s)
15797 prefer show-all))
15798 (t (time-to-days
15799 (condition-case errdata
15800 (apply 'encode-time (org-parse-time-string s))
15802 s (if (not (and buffer pos))
15803 ""
15804 (format " at %d in buffer `%s'" pos buffer))
15805 (cdr errdata))))))))
15807 (defun org-days-to-iso-week (days)
15808 "Return the iso week number."
15809 (require 'cal-iso)
15810 (car (calendar-iso-from-absolute days)))
15812 (defun org-small-year-to-year (year)
15813 "Convert 2-digit years into 4-digit years.
15814 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15815 The year 2000 cannot be abbreviated. Any year larger than 99
15816 is returned unchanged."
15817 (if (< year 38)
15818 (setq year (+ 2000 year))
15819 (if (< year 100)
15820 (setq year (+ 1900 year))))
15821 year)
15823 (defun org-time-from-absolute (d)
15824 "Return the time corresponding to date D.
15825 D may be an absolute day number, or a calendar-type list (month day year)."
15826 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15827 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15829 (defun org-calendar-holiday ()
15830 "List of holidays, for Diary display in Org-mode."
15831 (require 'holidays)
15832 (let ((hl (funcall
15833 (if (fboundp 'calendar-check-holidays)
15834 'calendar-check-holidays 'check-calendar-holidays) date)))
15835 (if hl (mapconcat 'identity hl "; "))))
15837 (defun org-diary-sexp-entry (sexp entry date)
15838 "Process a SEXP diary ENTRY for DATE."
15839 (require 'diary-lib)
15840 (let ((result (if calendar-debug-sexp
15841 (let ((stack-trace-on-error t))
15842 (eval (car (read-from-string sexp))))
15843 (condition-case nil
15844 (eval (car (read-from-string sexp)))
15845 (error
15846 (beep)
15847 (message "Bad sexp at line %d in %s: %s"
15848 (org-current-line)
15849 (buffer-file-name) sexp)
15850 (sleep-for 2))))))
15851 (cond ((stringp result) (split-string result "; "))
15852 ((and (consp result)
15853 (not (consp (cdr result)))
15854 (stringp (cdr result))) (cdr result))
15855 ((and (consp result)
15856 (stringp (car result))) result)
15857 (result entry)
15858 (t nil))))
15860 (defun org-diary-to-ical-string (frombuf)
15861 "Get iCalendar entries from diary entries in buffer FROMBUF.
15862 This uses the icalendar.el library."
15863 (let* ((tmpdir (if (featurep 'xemacs)
15864 (temp-directory)
15865 temporary-file-directory))
15866 (tmpfile (make-temp-name
15867 (expand-file-name "orgics" tmpdir)))
15868 buf rtn b e)
15869 (with-current-buffer frombuf
15870 (icalendar-export-region (point-min) (point-max) tmpfile)
15871 (setq buf (find-buffer-visiting tmpfile))
15872 (set-buffer buf)
15873 (goto-char (point-min))
15874 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15875 (setq b (match-beginning 0)))
15876 (goto-char (point-max))
15877 (if (re-search-backward "^END:VEVENT" nil t)
15878 (setq e (match-end 0)))
15880 (kill-buffer buf)
15881 (delete-file tmpfile)
15882 rtn))
15884 (defun org-closest-date (start current change prefer show-all)
15885 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15886 When PREFER is `past', return a date that is either CURRENT or past.
15887 When PREFER is `future', return a date that is either CURRENT or future.
15888 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15889 ;; Make the proper lists from the dates
15890 (catch 'exit
15891 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15892 dn dw sday cday n1 n2 n0
15893 d m y y1 y2 date1 date2 nmonths nm ny m2)
15895 (setq start (org-date-to-gregorian start)
15896 current (org-date-to-gregorian
15897 (if show-all
15898 current
15899 (time-to-days (current-time))))
15900 sday (calendar-absolute-from-gregorian start)
15901 cday (calendar-absolute-from-gregorian current))
15903 (if (<= cday sday) (throw 'exit sday))
15906 (setq dn (string-to-number (match-string 1 change))
15907 dw (cdr (assoc (match-string 2 change) a1)))
15908 (error "Invalid change specifier: %s" change))
15909 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15910 (cond
15911 ((eq dw 'day)
15912 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15913 n2 (+ n1 dn)))
15914 ((eq dw 'year)
15915 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15916 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15917 (setq date1 (list m d y1)
15918 n1 (calendar-absolute-from-gregorian date1)
15919 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15920 n2 (calendar-absolute-from-gregorian date2)))
15921 ((eq dw 'month)
15922 ;; approx number of month between the two dates
15923 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15924 ;; How often does dn fit in there?
15925 (setq d (nth 1 start) m (car start) y (nth 2 start)
15926 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15927 m (+ m nm)
15928 ny (floor (/ m 12))
15929 y (+ y ny)
15930 m (- m (* ny 12)))
15931 (while (> m 12) (setq m (- m 12) y (1+ y)))
15932 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15933 (setq m2 (+ m dn) y2 y)
15934 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15935 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15936 (while (<= n2 cday)
15937 (setq n1 n2 m m2 y y2)
15938 (setq m2 (+ m dn) y2 y)
15939 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15940 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15941 ;; Make sure n1 is the earlier date
15942 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15943 (if show-all
15944 (cond
15945 ((eq prefer 'past) (if (= cday n2) n2 n1))
15946 ((eq prefer 'future) (if (= cday n1) n1 n2))
15947 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15948 (cond
15949 ((eq prefer 'past) (if (= cday n2) n2 n1))
15950 ((eq prefer 'future) (if (= cday n1) n1 n2))
15951 (t (if (= cday n1) n1 n2)))))))
15953 (defun org-date-to-gregorian (date)
15954 "Turn any specification of DATE into a Gregorian date for the calendar."
15955 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15956 ((and (listp date) (= (length date) 3)) date)
15957 ((stringp date)
15958 (setq date (org-parse-time-string date))
15959 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15960 ((listp date)
15961 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15963 (defun org-parse-time-string (s &optional nodefault)
15964 "Parse the standard Org-mode time string.
15965 This should be a lot faster than the normal `parse-time-string'.
15966 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15967 hour and minute fields will be nil if not given."
15968 (if (string-match org-ts-regexp0 s)
15969 (list 0
15970 (if (or (match-beginning 8) (not nodefault))
15971 (string-to-number (or (match-string 8 s) "0")))
15972 (if (or (match-beginning 7) (not nodefault))
15973 (string-to-number (or (match-string 7 s) "0")))
15974 (string-to-number (match-string 4 s))
15975 (string-to-number (match-string 3 s))
15976 (string-to-number (match-string 2 s))
15977 nil nil nil)
15978 (error "Not a standard Org-mode time string: %s" s)))
15980 (defun org-timestamp-up (&optional arg)
15981 "Increase the date item at the cursor by one.
15982 If the cursor is on the year, change the year. If it is on the month,
15983 the day or the time, change that.
15984 With prefix ARG, change by that many units."
15985 (interactive "p")
15986 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15988 (defun org-timestamp-down (&optional arg)
15989 "Decrease the date item at the cursor by one.
15990 If the cursor is on the year, change the year. If it is on the month,
15991 the day or the time, change that.
15992 With prefix ARG, change by that many units."
15993 (interactive "p")
15994 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15996 (defun org-timestamp-up-day (&optional arg)
15997 "Increase the date in the time stamp by one day.
15998 With prefix ARG, change that many days."
15999 (interactive "p")
16000 (if (and (not (org-at-timestamp-p t))
16001 (org-at-heading-p))
16002 (org-todo 'up)
16003 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16005 (defun org-timestamp-down-day (&optional arg)
16006 "Decrease the date in the time stamp by one day.
16007 With prefix ARG, change that many days."
16008 (interactive "p")
16009 (if (and (not (org-at-timestamp-p t))
16010 (org-at-heading-p))
16011 (org-todo 'down)
16012 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16014 (defun org-at-timestamp-p (&optional inactive-ok)
16015 "Determine if the cursor is in or at a timestamp."
16016 (interactive)
16017 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16018 (pos (point))
16019 (ans (or (looking-at tsr)
16020 (save-excursion
16022 (if (> (point) (point-min)) (backward-char 1))
16023 (and (looking-at tsr)
16024 (> (- (match-end 0) pos) -1))))))
16025 (and ans
16026 (boundp 'org-ts-what)
16027 (setq org-ts-what
16028 (cond
16029 ((= pos (match-beginning 0)) 'bracket)
16030 ;; Point is considered to be "on the bracket" whether
16031 ;; it's really on it or right after it.
16032 ((or (= pos (1- (match-end 0)))
16033 (= pos (match-end 0))) 'bracket)
16034 ((org-pos-in-match-range pos 2) 'year)
16035 ((org-pos-in-match-range pos 3) 'month)
16036 ((org-pos-in-match-range pos 7) 'hour)
16037 ((org-pos-in-match-range pos 8) 'minute)
16038 ((or (org-pos-in-match-range pos 4)
16039 (org-pos-in-match-range pos 5)) 'day)
16040 ((and (> pos (or (match-end 8) (match-end 5)))
16041 (< pos (match-end 0)))
16042 (- pos (or (match-end 8) (match-end 5))))
16043 (t 'day))))
16044 ans))
16046 (defun org-toggle-timestamp-type ()
16047 "Toggle the type (<active> or [inactive]) of a time stamp."
16048 (interactive)
16049 (when (org-at-timestamp-p t)
16050 (let ((beg (match-beginning 0)) (end (match-end 0))
16051 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16052 (save-excursion
16053 (goto-char beg)
16054 (while (re-search-forward "[][<>]" end t)
16055 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16056 t t)))
16057 (message "Timestamp is now %sactive"
16058 (if (equal (char-after beg) ?<) "" "in")))))
16060 (defun org-timestamp-change (n &optional what updown)
16061 "Change the date in the time stamp at point.
16062 The date will be changed by N times WHAT. WHAT can be `day', `month',
16063 `year', `minute', `second'. If WHAT is not given, the cursor position
16064 in the timestamp determines what will be changed."
16065 (let ((origin (point)) origin-cat
16066 with-hm inactive
16067 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16068 org-ts-what
16069 extra rem
16070 ts time time0)
16071 (if (not (org-at-timestamp-p t))
16072 (error "Not at a timestamp"))
16073 (if (and (not what) (eq org-ts-what 'bracket))
16074 (org-toggle-timestamp-type)
16075 ;; Point isn't on brackets. Remember the part of the time-stamp
16076 ;; the point was in. Indeed, size of time-stamps may change,
16077 ;; but point must be kept in the same category nonetheless.
16078 (setq origin-cat org-ts-what)
16079 (if (and (not what) (not (eq org-ts-what 'day))
16080 org-display-custom-times
16081 (get-text-property (point) 'display)
16082 (not (get-text-property (1- (point)) 'display)))
16083 (setq org-ts-what 'day))
16084 (setq org-ts-what (or what org-ts-what)
16085 inactive (= (char-after (match-beginning 0)) ?\[)
16086 ts (match-string 0))
16087 (replace-match "")
16088 (if (string-match
16090 ts)
16091 (setq extra (match-string 1 ts)))
16093 (setq with-hm t))
16094 (setq time0 (org-parse-time-string ts))
16095 (when (and updown
16096 (eq org-ts-what 'minute)
16097 (not current-prefix-arg))
16098 ;; This looks like s-up and s-down. Change by one rounding step.
16099 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16100 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16101 (setcar (cdr time0) (+ (nth 1 time0)
16102 (if (> n 0) (- rem) (- dm rem))))))
16103 (setq time
16104 (encode-time (or (car time0) 0)
16105 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16106 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16107 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16108 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16109 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16110 (nthcdr 6 time0)))
16111 (when (and (member org-ts-what '(hour minute))
16112 extra
16114 (setq extra (org-modify-ts-extra
16115 extra
16116 (if (eq org-ts-what 'hour) 2 5)
16117 n dm)))
16118 (when (integerp org-ts-what)
16119 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16120 (if (eq what 'calendar)
16121 (let ((cal-date (org-get-date-from-calendar)))
16122 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16123 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16124 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16125 (setcar time0 (or (car time0) 0))
16126 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16127 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16128 (setq time (apply 'encode-time time0))))
16129 ;; Insert the new time-stamp, and ensure point stays in the same
16130 ;; category as before (i.e. not after the last position in that
16131 ;; category).
16132 (let ((pos (point)))
16133 ;; Stay before inserted string. `save-excursion' is of no use.
16134 (setq org-last-changed-timestamp
16135 (org-insert-time-stamp time with-hm inactive nil nil extra))
16136 (goto-char pos))
16137 (save-match-data
16138 (looking-at org-ts-regexp3)
16139 (goto-char (cond
16140 ;; `day' category ends before `hour' if any, or at
16141 ;; the end of the day name.
16142 ((eq origin-cat 'day)
16143 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16144 ((eq origin-cat 'hour) (min (match-end 7) origin))
16145 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16146 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16147 ;; `year' and `month' have both fixed size: point
16148 ;; couldn't have moved into another part.
16149 (t origin))))
16150 ;; Update clock if on a CLOCK line.
16151 (org-clock-update-time-maybe)
16152 ;; Try to recenter the calendar window, if any.
16153 (if (and org-calendar-follow-timestamp-change
16154 (get-buffer-window "*Calendar*" t)
16155 (memq org-ts-what '(day month year)))
16156 (org-recenter-calendar (time-to-days time))))))
16158 (defun org-modify-ts-extra (s pos n dm)
16159 "Change the different parts of the lead-time and repeat fields in timestamp."
16160 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16161 ng h m new rem)
16162 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16163 (cond
16164 ((or (org-pos-in-match-range pos 2)
16165 (org-pos-in-match-range pos 3))
16166 (setq m (string-to-number (match-string 3 s))
16167 h (string-to-number (match-string 2 s)))
16168 (if (org-pos-in-match-range pos 2)
16169 (setq h (+ h n))
16170 (setq n (* dm (org-no-warnings (signum n))))
16171 (when (not (= 0 (setq rem (% m dm))))
16172 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16173 (setq m (+ m n)))
16174 (if (< m 0) (setq m (+ m 60) h (1- h)))
16175 (if (> m 59) (setq m (- m 60) h (1+ h)))
16176 (setq h (min 24 (max 0 h)))
16177 (setq ng 1 new (format "-%02d:%02d" h m)))
16178 ((org-pos-in-match-range pos 6)
16179 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16180 ((org-pos-in-match-range pos 5)
16181 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16183 ((org-pos-in-match-range pos 9)
16184 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16185 ((org-pos-in-match-range pos 8)
16186 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16188 (when ng
16189 (setq s (concat
16190 (substring s 0 (match-beginning ng))
16191 new
16192 (substring s (match-end ng))))))
16193 s))
16195 (defun org-recenter-calendar (date)
16196 "If the calendar is visible, recenter it to DATE."
16197 (let ((cwin (get-buffer-window "*Calendar*" t)))
16198 (when cwin
16199 (let ((calendar-move-hook nil))
16200 (with-selected-window cwin
16201 (calendar-goto-date (if (listp date) date
16202 (calendar-gregorian-from-absolute date))))))))
16204 (defun org-goto-calendar (&optional arg)
16205 "Go to the Emacs calendar at the current date.
16206 If there is a time stamp in the current line, go to that date.
16207 A prefix ARG can be used to force the current date."
16208 (interactive "P")
16209 (let ((tsr org-ts-regexp) diff
16210 (calendar-move-hook nil)
16211 (calendar-view-holidays-initially-flag nil)
16212 (calendar-view-diary-initially-flag nil))
16213 (if (or (org-at-timestamp-p)
16214 (save-excursion
16215 (beginning-of-line 1)
16216 (looking-at (concat ".*" tsr))))
16217 (let ((d1 (time-to-days (current-time)))
16218 (d2 (time-to-days
16219 (org-time-string-to-time (match-string 1)))))
16220 (setq diff (- d2 d1))))
16221 (calendar)
16222 (calendar-goto-today)
16223 (if (and diff (not arg)) (calendar-forward-day diff))))
16225 (defun org-get-date-from-calendar ()
16226 "Return a list (month day year) of date at point in calendar."
16227 (with-current-buffer "*Calendar*"
16228 (save-match-data
16229 (calendar-cursor-to-date))))
16231 (defun org-date-from-calendar ()
16232 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16233 If there is already a time stamp at the cursor position, update it."
16234 (interactive)
16235 (if (org-at-timestamp-p t)
16236 (org-timestamp-change 0 'calendar)
16237 (let ((cal-date (org-get-date-from-calendar)))
16238 (org-insert-time-stamp
16239 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16241 (defun org-minutes-to-hh:mm-string (m)
16242 "Compute H:MM from a number of minutes."
16243 (let ((h (/ m 60)))
16244 (setq m (- m (* 60 h)))
16245 (format org-time-clocksum-format h m)))
16247 (defun org-hh:mm-string-to-minutes (s)
16248 "Convert a string H:MM to a number of minutes.
16249 If the string is just a number, interpret it as minutes.
16250 In fact, the first hh:mm or number in the string will be taken,
16251 there can be extra stuff in the string.
16252 If no number is found, the return value is 0."
16253 (cond
16254 ((integerp s) s)
16256 (+ (* (string-to-number (match-string 1 s)) 60)
16257 (string-to-number (match-string 2 s))))
16259 (string-to-number (match-string 1 s)))
16260 (t 0)))
16262 (defcustom org-effort-durations
16263 `(("h" . 60)
16264 ("d" . ,(* 60 8))
16265 ("w" . ,(* 60 8 5))
16266 ("m" . ,(* 60 8 5 4))
16267 ("y" . ,(* 60 8 5 40)))
16268 "Conversion factor to minutes for an effort modifier.
16270 Each entry has the form (MODIFIER . MINUTES).
16272 In an effort string, a number followed by MODIFIER is multiplied
16273 by the specified number of MINUTES to obtain an effort in
16274 minutes.
16278 :group 'org-agenda
16279 :version "24.1"
16280 :type '(alist :key-type (string :tag "Modifier")
16281 :value-type (number :tag "Minutes")))
16283 (defun org-duration-string-to-minutes (s)
16284 "Convert a duration string S to minutes.
16286 A bare number is interpreted as minutes, modifiers can be set by
16287 customizing `org-effort-durations' (which see).
16289 Entries containing a colon are interpreted as H:MM by
16290 `org-hh:mm-string-to-minutes'."
16291 (let ((result 0)
16293 (regexp-opt (mapcar 'car org-effort-durations))
16295 (while (string-match re s)
16296 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16297 (string-to-number (match-string 1 s))))
16298 (setq s (replace-match "" nil t s)))
16299 (incf result (org-hh:mm-string-to-minutes s))
16300 result))
16302 ;;;; Files
16304 (defun org-save-all-org-buffers ()
16305 "Save all Org-mode buffers without user confirmation."
16306 (interactive)
16307 (message "Saving all Org-mode buffers...")
16308 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16309 (when (featurep 'org-id) (org-id-locations-save))
16310 (message "Saving all Org-mode buffers... done"))
16312 (defun org-revert-all-org-buffers ()
16313 "Revert all Org-mode buffers.
16314 Prompt for confirmation when there are unsaved changes.
16315 Be sure you know what you are doing before letting this function
16316 overwrite your changes.
16318 This function is useful in a setup where one tracks org files
16319 with a version control system, to revert on one machine after pulling
16320 changes from another. I believe the procedure must be like this:
16322 1. M-x org-save-all-org-buffers
16323 2. Pull changes from the other machine, resolve conflicts
16324 3. M-x org-revert-all-org-buffers"
16325 (interactive)
16326 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16327 (error "Abort"))
16328 (save-excursion
16329 (save-window-excursion
16330 (mapc
16331 (lambda (b)
16332 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16333 (with-current-buffer b buffer-file-name))
16334 (org-pop-to-buffer-same-window b)
16335 (revert-buffer t 'no-confirm)))
16336 (buffer-list))
16337 (when (and (featurep 'org-id) org-id-track-globally)
16338 (org-id-locations-load)))))
16340 ;;;; Agenda files
16342 ;;;###autoload
16343 (defun org-switchb (&optional arg)
16344 "Switch between Org buffers.
16345 With one prefix argument, restrict available buffers to files.
16346 With two prefix arguments, restrict available buffers to agenda files.
16348 Defaults to `iswitchb' for buffer name completion.
16349 Set `org-completion-use-ido' to make it use ido instead."
16350 (interactive "P")
16351 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16352 ((equal arg '(16)) (org-buffer-list 'agenda))
16353 (t (org-buffer-list))))
16354 (org-completion-use-iswitchb org-completion-use-iswitchb)
16355 (org-completion-use-ido org-completion-use-ido))
16356 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16357 (setq org-completion-use-iswitchb t))
16358 (org-pop-to-buffer-same-window
16359 (org-icompleting-read "Org buffer: "
16360 (mapcar 'list (mapcar 'buffer-name blist))
16361 nil t))))
16363 ;;; Define some older names previously used for this functionality
16364 ;;;###autoload
16365 (defalias 'org-ido-switchb 'org-switchb)
16366 ;;;###autoload
16367 (defalias 'org-iswitchb 'org-switchb)
16369 (defun org-buffer-list (&optional predicate exclude-tmp)
16370 "Return a list of Org buffers.
16371 PREDICATE can be `export', `files' or `agenda'.
16373 export restrict the list to Export buffers.
16374 files restrict the list to buffers visiting Org files.
16375 agenda restrict the list to buffers visiting agenda files.
16377 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16378 (let* ((bfn nil)
16379 (agenda-files (and (eq predicate 'agenda)
16380 (mapcar 'file-truename (org-agenda-files t))))
16381 (filter
16382 (cond
16383 ((eq predicate 'files)
16384 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16385 ((eq predicate 'export)
16386 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16387 ((eq predicate 'agenda)
16388 (lambda (b)
16389 (with-current-buffer b
16390 (and (eq major-mode 'org-mode)
16391 (setq bfn (buffer-file-name b))
16392 (member (file-truename bfn) agenda-files)))))
16393 (t (lambda (b) (with-current-buffer b
16394 (or (eq major-mode 'org-mode)
16395 (string-match "\*Org .*Export"
16396 (buffer-name b)))))))))
16397 (delq nil
16398 (mapcar
16399 (lambda(b)
16400 (if (and (funcall filter b)
16401 (or (not exclude-tmp)
16402 (not (string-match "tmp" (buffer-name b)))))
16403 b
16404 nil))
16405 (buffer-list)))))
16407 (defun org-agenda-files (&optional unrestricted archives)
16408 "Get the list of agenda files.
16409 Optional UNRESTRICTED means return the full list even if a restriction
16410 is currently in place.
16411 When ARCHIVES is t, include all archive files that are really being
16412 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16413 `org-agenda-archives-mode' is t."
16414 (let ((files
16415 (cond
16416 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16417 ((stringp org-agenda-files) (org-read-agenda-file-list))
16418 ((listp org-agenda-files) org-agenda-files)
16419 (t (error "Invalid value of `org-agenda-files'")))))
16420 (setq files (apply 'append
16421 (mapcar (lambda (f)
16422 (if (file-directory-p f)
16423 (directory-files
16424 f t org-agenda-file-regexp)
16425 (list f)))
16426 files)))
16427 (when org-agenda-skip-unavailable-files
16428 (setq files (delq nil
16429 (mapcar (function
16430 (lambda (file)
16431 (and (file-readable-p file) file)))
16432 files))))
16433 (when (or (eq archives t)
16434 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16435 (setq files (org-add-archive-files files)))
16436 files))
16438 (defun org-agenda-file-p (&optional file)
16439 "Return non-nil, if FILE is an agenda file.
16440 If FILE is omitted, use the file associated with the current
16441 buffer."
16442 (member (or file (buffer-file-name))
16443 (org-agenda-files t)))
16445 (defun org-edit-agenda-file-list ()
16446 "Edit the list of agenda files.
16447 Depending on setup, this either uses customize to edit the variable
16448 `org-agenda-files', or it visits the file that is holding the list. In the
16449 latter case, the buffer is set up in a way that saving it automatically kills
16450 the buffer and restores the previous window configuration."
16451 (interactive)
16452 (if (stringp org-agenda-files)
16453 (let ((cw (current-window-configuration)))
16454 (find-file org-agenda-files)
16455 (org-set-local 'org-window-configuration cw)
16456 (org-add-hook 'after-save-hook
16457 (lambda ()
16458 (set-window-configuration
16459 (prog1 org-window-configuration
16460 (kill-buffer (current-buffer))))
16461 (org-install-agenda-files-menu)
16462 (message "New agenda file list installed"))
16463 nil 'local)
16464 (message "%s" (substitute-command-keys
16466 (customize-variable 'org-agenda-files)))
16468 (defun org-store-new-agenda-file-list (list)
16469 "Set new value for the agenda file list and save it correctly."
16470 (if (stringp org-agenda-files)
16471 (let ((fe (org-read-agenda-file-list t)) b u)
16472 (while (setq b (find-buffer-visiting org-agenda-files))
16473 (kill-buffer b))
16474 (with-temp-file org-agenda-files
16475 (insert
16476 (mapconcat
16477 (lambda (f) ;; Keep un-expanded entries.
16478 (if (setq u (assoc f fe))
16479 (cdr u)
16480 f))
16483 (let ((org-mode-hook nil) (org-inhibit-startup t)
16484 (org-insert-mode-line-in-empty-file nil))
16485 (setq org-agenda-files list)
16486 (customize-save-variable 'org-agenda-files org-agenda-files))))
16488 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16489 "Read the list of agenda files from a file.
16490 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16491 filenames, used by `org-store-new-agenda-file-list' to write back
16492 un-expanded file names."
16493 (when (file-directory-p org-agenda-files)
16494 (error "`org-agenda-files' cannot be a single directory"))
16495 (when (stringp org-agenda-files)
16496 (with-temp-buffer
16497 (insert-file-contents org-agenda-files)
16498 (mapcar
16499 (lambda (f)
16500 (let ((e (expand-file-name (substitute-in-file-name f)
16501 org-directory)))
16502 (if pair-with-expansion
16503 (cons e f)
16504 e)))
16507 ;;;###autoload
16508 (defun org-cycle-agenda-files ()
16509 "Cycle through the files in `org-agenda-files'.
16510 If the current buffer visits an agenda file, find the next one in the list.
16511 If the current buffer does not, find the first agenda file."
16512 (interactive)
16513 (let* ((fs (org-agenda-files t))
16514 (files (append fs (list (car fs))))
16515 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16516 file)
16517 (unless files (error "No agenda files"))
16518 (catch 'exit
16519 (while (setq file (pop files))
16520 (if (equal (file-truename file) tcf)
16521 (when (car files)
16522 (find-file (car files))
16523 (throw 'exit t))))
16524 (find-file (car fs)))
16525 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16527 (defun org-agenda-file-to-front (&optional to-end)
16528 "Move/add the current file to the top of the agenda file list.
16529 If the file is not present in the list, it is added to the front. If it is
16530 present, it is moved there. With optional argument TO-END, add/move to the
16531 end of the list."
16532 (interactive "P")
16533 (let ((org-agenda-skip-unavailable-files nil)
16534 (file-alist (mapcar (lambda (x)
16535 (cons (file-truename x) x))
16536 (org-agenda-files t)))
16537 (ctf (file-truename buffer-file-name))
16538 x had)
16539 (setq x (assoc ctf file-alist) had x)
16541 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16542 (if to-end
16543 (setq file-alist (append (delq x file-alist) (list x)))
16544 (setq file-alist (cons x (delq x file-alist))))
16545 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16546 (org-install-agenda-files-menu)
16547 (message "File %s to %s of agenda file list"
16548 (if had "moved" "added") (if to-end "end" "front"))))
16550 (defun org-remove-file (&optional file)
16551 "Remove current file from the list of files in variable `org-agenda-files'.
16552 These are the files which are being checked for agenda entries.
16553 Optional argument FILE means use this file instead of the current."
16554 (interactive)
16555 (let* ((org-agenda-skip-unavailable-files nil)
16556 (file (or file buffer-file-name))
16557 (true-file (file-truename file))
16558 (afile (abbreviate-file-name file))
16559 (files (delq nil (mapcar
16560 (lambda (x)
16561 (if (equal true-file
16562 (file-truename x))
16563 nil x))
16564 (org-agenda-files t)))))
16565 (if (not (= (length files) (length (org-agenda-files t))))
16566 (progn
16567 (org-store-new-agenda-file-list files)
16568 (org-install-agenda-files-menu)
16569 (message "Removed file: %s" afile))
16570 (message "File was not in list: %s (not removed)" afile))))
16572 (defun org-file-menu-entry (file)
16573 (vector file (list 'find-file file) t))
16575 (defun org-check-agenda-file (file)
16576 "Make sure FILE exists. If not, ask user what to do."
16577 (when (not (file-exists-p file))
16578 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16579 (abbreviate-file-name file))
16580 (let ((r (downcase (read-char-exclusive))))
16581 (cond
16582 ((equal r ?r)
16583 (org-remove-file file)
16584 (throw 'nextfile t))
16585 (t (error "Abort"))))))
16587 (defun org-get-agenda-file-buffer (file)
16588 "Get a buffer visiting FILE. If the buffer needs to be created, add
16589 it to the list of buffers which might be released later."
16590 (let ((buf (org-find-base-buffer-visiting file)))
16591 (if buf
16592 buf ; just return it
16593 ;; Make a new buffer and remember it
16594 (setq buf (find-file-noselect file))
16595 (if buf (push buf org-agenda-new-buffers))
16596 buf)))
16598 (defun org-release-buffers (blist)
16599 "Release all buffers in list, asking the user for confirmation when needed.
16600 When a buffer is unmodified, it is just killed. When modified, it is saved
16601 \(if the user agrees) and then killed."
16602 (let (buf file)
16603 (while (setq buf (pop blist))
16604 (setq file (buffer-file-name buf))
16605 (when (and (buffer-modified-p buf)
16606 file
16607 (y-or-n-p (format "Save file %s? " file)))
16608 (with-current-buffer buf (save-buffer)))
16609 (kill-buffer buf))))
16611 (defun org-prepare-agenda-buffers (files)
16612 "Create buffers for all agenda files, protect archived trees and comments."
16613 (interactive)
16614 (let ((pa '(:org-archived t))
16615 (pc '(:org-comment t))
16616 (pall '(:org-archived t :org-comment t))
16617 (inhibit-read-only t)
16618 (rea (concat ":" org-archive-tag ":"))
16619 bmp file re)
16620 (save-excursion
16621 (save-restriction
16622 (while (setq file (pop files))
16623 (catch 'nextfile
16624 (if (bufferp file)
16625 (set-buffer file)
16626 (org-check-agenda-file file)
16627 (set-buffer (org-get-agenda-file-buffer file)))
16628 (widen)
16629 (setq bmp (buffer-modified-p))
16630 (org-refresh-category-properties)
16631 (setq org-todo-keywords-for-agenda
16632 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16633 (setq org-done-keywords-for-agenda
16634 (append org-done-keywords-for-agenda org-done-keywords))
16635 (setq org-todo-keyword-alist-for-agenda
16636 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16637 (setq org-drawers-for-agenda
16638 (append org-drawers-for-agenda org-drawers))
16639 (setq org-tag-alist-for-agenda
16640 (append org-tag-alist-for-agenda org-tag-alist))
16642 (save-excursion
16643 (remove-text-properties (point-min) (point-max) pall)
16644 (when org-agenda-skip-archived-trees
16645 (goto-char (point-min))
16646 (while (re-search-forward rea nil t)
16647 (if (org-at-heading-p t)
16648 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16649 (goto-char (point-min))
16650 (setq re (format org-heading-keyword-regexp-format
16651 org-comment-string))
16652 (while (re-search-forward re nil t)
16653 (add-text-properties
16654 (match-beginning 0) (org-end-of-subtree t) pc)))
16655 (set-buffer-modified-p bmp)))))
16656 (setq org-todo-keywords-for-agenda
16657 (org-uniquify org-todo-keywords-for-agenda))
16658 (setq org-todo-keyword-alist-for-agenda
16659 (org-uniquify org-todo-keyword-alist-for-agenda)
16660 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16662 ;;;; Embedded LaTeX
16664 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16665 "Keymap for the minor `org-cdlatex-mode'.")
16667 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16668 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16669 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16670 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16671 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16673 (defvar org-cdlatex-texmathp-advice-is-done nil
16674 "Flag remembering if we have applied the advice to texmathp already.")
16676 (define-minor-mode org-cdlatex-mode
16677 "Toggle the minor `org-cdlatex-mode'.
16678 This mode supports entering LaTeX environment and math in LaTeX fragments
16679 in Org-mode.
16681 nil " OCDL" nil
16682 (when org-cdlatex-mode
16683 (require 'cdlatex)
16684 (run-hooks 'cdlatex-mode-hook)
16685 (cdlatex-compute-tables))
16686 (unless org-cdlatex-texmathp-advice-is-done
16687 (setq org-cdlatex-texmathp-advice-is-done t)
16688 (defadvice texmathp (around org-math-always-on activate)
16689 "Always return t in org-mode buffers.
16690 This is because we want to insert math symbols without dollars even outside
16691 the LaTeX math segments. If Orgmode thinks that point is actually inside
16692 an embedded LaTeX fragment, let texmathp do its job.
16694 (interactive)
16695 (let (p)
16696 (cond
16697 ((not (eq major-mode 'org-mode)) ad-do-it)
16698 ((eq this-command 'cdlatex-math-symbol)
16699 (setq ad-return-value t
16700 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16701 (t
16702 (let ((p (org-inside-LaTeX-fragment-p)))
16703 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16704 (setq ad-return-value t
16705 texmathp-why '("Org-mode embedded math" . 0))
16706 (if p ad-do-it)))))))))
16708 (defun turn-on-org-cdlatex ()
16709 "Unconditionally turn on `org-cdlatex-mode'."
16710 (org-cdlatex-mode 1))
16712 (defun org-inside-LaTeX-fragment-p ()
16713 "Test if point is inside a LaTeX fragment.
16715 sequence appearing also before point.
16716 Even though the matchers for math are configurable, this function assumes
16718 delimiters are skipped when they have been removed by customization.
16719 The return value is nil, or a cons cell with the delimiter and the
16720 position of this delimiter.
16722 This function does a reasonably good job, but can locally be fooled by
16723 for example currency specifications. For example it will assume being in
16725 fragments that are properly closed, but during editing, we have to live
16726 with the uncertainty caused by missing closing delimiters. This function
16727 looks only before point, not after."
16728 (catch 'exit
16729 (let ((pos (point))
16730 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16731 (lim (progn
16733 (point)))
16734 dd-on str (start 0) m re)
16735 (goto-char pos)
16736 (when dodollar
16738 re (nth 1 (assoc "$" org-latex-regexps)))
16739 (while (string-match re str start)
16740 (cond
16741 ((= (match-end 0) (length str))
16742 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16743 ((= (match-end 0) (- (length str) 5))
16744 (throw 'exit nil))
16745 (t (setq start (match-end 0))))))
16746 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16747 (goto-char pos)
16748 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16749 (and (match-beginning 2) (throw 'exit nil))
16750 ;; count $$
16752 (setq dd-on (not dd-on)))
16753 (goto-char pos)
16754 (if dd-on (cons "$$" m))))))
16756 (defun org-inside-latex-macro-p ()
16757 "Is point inside a LaTeX macro or its arguments?"
16758 (save-match-data
16759 (org-in-regexp
16762 (defun org-try-cdlatex-tab ()
16763 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16764 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16765 - inside a LaTeX fragment, or
16766 - after the first word in a line, where an abbreviation expansion could
16767 insert a LaTeX environment."
16768 (when org-cdlatex-mode
16769 (cond
16770 ;; Before any word on the line: No expansion possible.
16772 ;; Just after first word on the line: Expand it. Make sure it
16773 ;; cannot happen on headlines, though.
16774 ((save-excursion
16775 (skip-chars-backward "a-zA-Z0-9*")
16777 (and (bolp) (not (org-at-heading-p))))
16778 (cdlatex-tab) t)
16779 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16781 (defun org-cdlatex-underscore-caret (&optional arg)
16782 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16783 Revert to the normal definition outside of these fragments."
16784 (interactive "P")
16785 (if (org-inside-LaTeX-fragment-p)
16786 (call-interactively 'cdlatex-sub-superscript)
16787 (let (org-cdlatex-mode)
16788 (call-interactively (key-binding (vector last-input-event))))))
16790 (defun org-cdlatex-math-modify (&optional arg)
16791 "Execute `cdlatex-math-modify' in LaTeX fragments.
16792 Revert to the normal definition outside of these fragments."
16793 (interactive "P")
16794 (if (org-inside-LaTeX-fragment-p)
16795 (call-interactively 'cdlatex-math-modify)
16796 (let (org-cdlatex-mode)
16797 (call-interactively (key-binding (vector last-input-event))))))
16799 (defvar org-latex-fragment-image-overlays nil
16800 "List of overlays carrying the images of latex fragments.")
16801 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16803 (defun org-remove-latex-fragment-image-overlays ()
16804 "Remove all overlays with LaTeX fragment images in current buffer."
16805 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16806 (setq org-latex-fragment-image-overlays nil))
16808 (defun org-preview-latex-fragment (&optional subtree)
16809 "Preview the LaTeX fragment at point, or all locally or globally.
16810 If the cursor is in a LaTeX fragment, create the image and overlay
16811 it over the source code. If there is no fragment at point, display
16812 all fragments in the current text, from one headline to the next. With
16813 prefix SUBTREE, display all fragments in the current subtree. With a
16815 the cursor is before the first headline,
16816 display all fragments in the buffer.
16818 (interactive "P")
16819 (unless buffer-file-name
16820 (error "Can't preview LaTeX fragment in a non-file buffer"))
16821 (org-remove-latex-fragment-image-overlays)
16822 (save-excursion
16823 (save-restriction
16824 (let (beg end at msg)
16825 (cond
16826 ((or (equal subtree '(16))
16827 (not (save-excursion
16828 (re-search-backward org-outline-regexp-bol nil t))))
16829 (setq beg (point-min) end (point-max)
16830 msg "Creating images for buffer...%s"))
16831 ((equal subtree '(4))
16832 (org-back-to-heading)
16833 (setq beg (point) end (org-end-of-subtree t)
16834 msg "Creating images for subtree...%s"))
16835 (t
16836 (if (setq at (org-inside-LaTeX-fragment-p))
16837 (goto-char (max (point-min) (- (cdr at) 2)))
16838 (org-back-to-heading))
16839 (setq beg (point) end (progn (outline-next-heading) (point))
16840 msg (if at "Creating image...%s"
16841 "Creating images for entry...%s"))))
16842 (message msg "")
16843 (narrow-to-region beg end)
16844 (goto-char beg)
16845 (org-format-latex
16846 (concat "ltxpng/" (file-name-sans-extension
16847 (file-name-nondirectory
16848 buffer-file-name)))
16849 default-directory 'overlays msg at 'forbuffer 'dvipng)
16850 (message msg "done. Use `C-c C-c' to remove images.")))))
16852 (defvar org-latex-regexps
16854 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16857 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16861 "Regular expressions for matching embedded LaTeX.")
16863 (defvar org-export-have-math nil) ;; dynamic scoping
16864 (defun org-format-latex (prefix &optional dir overlays msg at
16865 forbuffer processing-type)
16866 "Replace LaTeX fragments with links to an image, and produce images.
16867 Some of the options can be changed using the variable
16868 `org-format-latex-options'."
16869 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16870 (let* ((prefixnodir (file-name-nondirectory prefix))
16871 (absprefix (expand-file-name prefix dir))
16872 (todir (file-name-directory absprefix))
16873 (opt org-format-latex-options)
16874 (matchers (plist-get opt :matchers))
16875 (re-list org-latex-regexps)
16876 (org-format-latex-header-extra
16877 (plist-get (org-infile-export-plist) :latex-header-extra))
16878 (cnt 0) txt hash link beg end re e checkdir
16879 executables-checked string
16880 m n block-type block linkfile movefile ov)
16881 ;; Check the different regular expressions
16882 (while (setq e (pop re-list))
16883 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16885 (when (member m matchers)
16886 (goto-char (point-min))
16887 (while (re-search-forward re nil t)
16888 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16889 (not (get-text-property (match-beginning n)
16890 'org-protected))
16891 (or (not overlays)
16892 (not (eq (get-char-property (match-beginning n)
16893 'org-overlay-type)
16894 'org-latex-overlay))))
16895 (setq org-export-have-math t)
16896 (cond
16897 ((eq processing-type 'verbatim)
16898 ;; Leave the text verbatim, just protect it
16899 (add-text-properties (match-beginning n) (match-end n)
16900 '(org-protected t)))
16901 ((eq processing-type 'mathjax)
16902 ;; Prepare for MathJax processing
16903 (setq string (match-string n))
16904 (if (member m '("$" "$1"))
16905 (save-excursion
16906 (delete-region (match-beginning n) (match-end n))
16907 (goto-char (match-beginning n))
16910 '(org-protected t))))
16911 (add-text-properties (match-beginning n) (match-end n)
16912 '(org-protected t))))
16913 ((eq processing-type 'dvipng)
16914 ;; Process to an image
16915 (setq txt (match-string n)
16916 beg (match-beginning n) end (match-end n)
16917 cnt (1+ cnt))
16918 (let (print-length print-level) ; make sure full list is printed
16919 (setq hash (sha1 (prin1-to-string
16920 (list org-format-latex-header
16921 org-format-latex-header-extra
16922 org-export-latex-default-packages-alist
16923 org-export-latex-packages-alist
16924 org-format-latex-options
16925 forbuffer txt)))
16926 linkfile (format "%s_%s.png" prefix hash)
16927 movefile (format "%s_%s.png" absprefix hash)))
16928 (setq link (concat block "[[file:" linkfile "]]" block))
16929 (if msg (message msg cnt))
16930 (goto-char beg)
16931 (unless checkdir ; make sure the directory exists
16932 (setq checkdir t)
16933 (or (file-directory-p todir) (make-directory todir t)))
16935 (unless executables-checked
16936 (org-check-external-command
16937 "latex" "needed to convert LaTeX fragments to images")
16938 (org-check-external-command
16939 "dvipng" "needed to convert LaTeX fragments to images")
16940 (setq executables-checked t))
16942 (unless (file-exists-p movefile)
16943 (org-create-formula-image
16944 txt movefile opt forbuffer))
16945 (if overlays
16946 (progn
16947 (mapc (lambda (o)
16948 (if (eq (overlay-get o 'org-overlay-type)
16949 'org-latex-overlay)
16950 (delete-overlay o)))
16951 (overlays-in beg end))
16952 (setq ov (make-overlay beg end))
16953 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16954 (if (featurep 'xemacs)
16955 (progn
16956 (overlay-put ov 'invisible t)
16957 (overlay-put
16958 ov 'end-glyph
16959 (make-glyph (vector 'png :file movefile))))
16960 (overlay-put
16961 ov 'display
16962 (list 'image :type 'png :file movefile :ascent 'center)))
16963 (push ov org-latex-fragment-image-overlays)
16964 (goto-char end))
16965 (delete-region beg end)
16966 (insert (org-add-props link
16967 (list 'org-latex-src
16968 (replace-regexp-in-string
16970 'org-latex-src-embed-type
16971 (if block-type 'paragraph 'character))))))
16972 ((eq processing-type 'mathml)
16973 ;; Process to MathML
16974 (unless executables-checked
16975 (unless (save-match-data (org-format-latex-mathml-available-p))
16976 (error "LaTeX to MathML converter not configured"))
16977 (setq executables-checked t))
16978 (setq txt (match-string n)
16979 beg (match-beginning n) end (match-end n)
16980 cnt (1+ cnt))
16981 (if msg (message msg cnt))
16982 (goto-char beg)
16983 (delete-region beg end)
16984 (insert (org-format-latex-as-mathml
16985 txt block-type prefix dir)))
16986 (t
16987 (error "Unknown conversion type %s for latex fragments"
16988 processing-type)))))))))
16990 (defun org-create-math-formula (latex-frag &optional mathml-file)
16991 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16992 Use `org-latex-to-mathml-convert-command'. If the conversion is
16994 elements otherwise return nil. When MATHML-FILE is specified,
16995 write the results in to that file. When invoked as an
16996 interactive command, prompt for LATEX-FRAG, with initial value
16997 set to the current active region and echo the results for user
16998 inspection."
16999 (interactive (list (let ((frag (when (region-active-p)
17000 (buffer-substring-no-properties
17001 (region-beginning) (region-end)))))
17002 (read-string "LaTeX Fragment: " frag nil frag))))
17003 (unless latex-frag (error "Invalid latex-frag"))
17004 (let* ((tmp-in-file (file-relative-name
17005 (make-temp-name (expand-file-name "ltxmathml-in"))))
17006 (ignore (write-region latex-frag nil tmp-in-file))
17007 (tmp-out-file (file-relative-name
17008 (make-temp-name (expand-file-name "ltxmathml-out"))))
17009 (cmd (format-spec
17010 org-latex-to-mathml-convert-command
17011 `((?j . ,(shell-quote-argument
17012 (expand-file-name org-latex-to-mathml-jar-file)))
17013 (?I . ,(shell-quote-argument tmp-in-file))
17014 (?o . ,(shell-quote-argument tmp-out-file)))))
17015 mathml shell-command-output)
17016 (when (org-called-interactively-p 'any)
17017 (unless (org-format-latex-mathml-available-p)
17018 (error "LaTeX to MathML converter not configured")))
17019 (message "Running %s" cmd)
17020 (setq shell-command-output (shell-command-to-string cmd))
17021 (setq mathml
17022 (when (file-readable-p tmp-out-file)
17023 (with-current-buffer (find-file-noselect tmp-out-file t)
17024 (goto-char (point-min))
17025 (when (re-search-forward
17026 (concat
17027 (regexp-quote
17030 (regexp-quote "</math>")) nil t)
17031 (prog1 (match-string 0) (kill-buffer))))))
17032 (cond
17033 (mathml
17034 (setq mathml
17036 (when mathml-file
17037 (write-region mathml nil mathml-file))
17038 (when (org-called-interactively-p 'any)
17039 (message mathml)))
17040 ((message "LaTeX to MathML conversion failed")
17041 (message shell-command-output)))
17042 (delete-file tmp-in-file)
17043 (when (file-exists-p tmp-out-file)
17044 (delete-file tmp-out-file))
17045 mathml))
17047 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17048 prefix &optional dir)
17049 "Use `org-create-math-formula' but check local cache first."
17050 (let* ((absprefix (expand-file-name prefix dir))
17051 (print-length nil) (print-level nil)
17052 (formula-id (concat
17053 "formula-"
17054 (sha1
17055 (prin1-to-string
17056 (list latex-frag
17057 org-latex-to-mathml-convert-command)))))
17058 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17059 (formula-cache-dir (file-name-directory formula-cache)))
17061 (unless (file-directory-p formula-cache-dir)
17062 (make-directory formula-cache-dir t))
17064 (unless (file-exists-p formula-cache)
17065 (org-create-math-formula latex-frag formula-cache))
17067 (if (file-exists-p formula-cache)
17068 ;; Successful conversion. Return the link to MathML file.
17069 (org-add-props
17070 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17072 'org-latex-src-embed-type (if latex-frag-type
17073 'paragraph 'character)))
17074 ;; Failed conversion. Return the LaTeX fragment verbatim
17075 (add-text-properties
17076 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17077 latex-frag)))
17079 ;; This function borrows from Ganesh Swami's latex2png.el
17080 (defun org-create-formula-image (string tofile options buffer)
17081 "This calls dvipng."
17082 (require 'org-latex)
17083 (let* ((tmpdir (if (featurep 'xemacs)
17084 (temp-directory)
17085 temporary-file-directory))
17086 (texfilebase (make-temp-name
17087 (expand-file-name "orgtex" tmpdir)))
17088 (texfile (concat texfilebase ".tex"))
17089 (dvifile (concat texfilebase ".dvi"))
17090 (pngfile (concat texfilebase ".png"))
17091 (fnh (if (featurep 'xemacs)
17092 (font-height (get-face-font 'default))
17093 (face-attribute 'default :height nil)))
17094 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17095 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17096 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17097 "Black"))
17098 (bg (or (plist-get options (if buffer :background :html-background))
17099 "Transparent")))
17100 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17101 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17102 (with-temp-file texfile
17103 (insert (org-splice-latex-header
17104 org-format-latex-header
17105 org-export-latex-default-packages-alist
17106 org-export-latex-packages-alist t
17107 org-format-latex-header-extra))
17109 (require 'org-latex)
17110 (org-export-latex-fix-inputenc))
17111 (let ((dir default-directory))
17112 (condition-case nil
17113 (progn
17114 (cd tmpdir)
17115 (call-process "latex" nil nil nil texfile))
17116 (error nil))
17117 (cd dir))
17118 (if (not (file-exists-p dvifile))
17119 (progn (message "Failed to create dvi file from %s" texfile) nil)
17120 (condition-case nil
17121 (call-process "dvipng" nil nil nil
17122 "-fg" fg "-bg" bg
17123 "-D" dpi
17124 ;;"-x" scale "-y" scale
17125 "-T" "tight"
17126 "-o" pngfile
17127 dvifile)
17128 (error nil))
17129 (if (not (file-exists-p pngfile))
17130 (if org-format-latex-signal-error
17131 (error "Failed to create png file from %s" texfile)
17132 (message "Failed to create png file from %s" texfile)
17133 nil)
17134 ;; Use the requested file name and clean up
17135 (copy-file pngfile tofile 'replace)
17136 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17137 (delete-file (concat texfilebase e)))
17138 pngfile))))
17140 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17141 "Fill a LaTeX header template TPL.
17142 In the template, the following place holders will be recognized:
17145 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17147 [NO-PACKAGES] do not include PKG
17148 [EXTRA] the string EXTRA
17149 [NO-EXTRA] do not include EXTRA
17151 For backward compatibility, if both the positive and the negative place
17153 assumed to be present at the end of the template.
17154 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17155 EXTRA is a string.
17156 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17157 (let (rpl (end ""))
17159 (setq rpl (if (or (match-end 1) (not def-pkg))
17160 "" (org-latex-packages-to-string def-pkg snippets-p t))
17161 tpl (replace-match rpl t t tpl))
17162 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17165 (setq rpl (if (or (match-end 1) (not pkg))
17166 "" (org-latex-packages-to-string pkg snippets-p t))
17167 tpl (replace-match rpl t t tpl))
17168 (if pkg (setq end
17170 (org-latex-packages-to-string pkg snippets-p)))))
17173 (setq rpl (if (or (match-end 1) (not extra))
17175 tpl (replace-match rpl t t tpl))
17181 tpl)))
17183 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17185 (setq pkg (mapconcat (lambda(p)
17186 (cond
17187 ((stringp p) p)
17188 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17189 (format "%% Package %s omitted" (cadr p)))
17190 ((equal "" (car p))
17192 (t
17194 (car p) (cadr p)))))
17195 pkg
17199 (defun org-dvipng-color (attr)
17200 "Return an rgb color specification for dvipng."
17201 (apply 'format "rgb %s %s %s"
17202 (mapcar 'org-normalize-color
17203 (color-values (face-attribute 'default attr nil)))))
17205 (defun org-normalize-color (value)
17206 "Return string to be used as color value for an RGB component."
17207 (format "%g" (/ value 65535.0)))
17209 ;; Image display
17212 (defvar org-inline-image-overlays nil)
17213 (make-variable-buffer-local 'org-inline-image-overlays)
17215 (defun org-toggle-inline-images (&optional include-linked)
17216 "Toggle the display of inline images.
17217 INCLUDE-LINKED is passed to `org-display-inline-images'."
17218 (interactive "P")
17219 (if org-inline-image-overlays
17220 (progn
17221 (org-remove-inline-images)
17222 (message "Inline image display turned off"))
17223 (org-display-inline-images include-linked)
17224 (if org-inline-image-overlays
17225 (message "%d images displayed inline"
17226 (length org-inline-image-overlays))
17227 (message "No images to display inline"))))
17229 (defun org-display-inline-images (&optional include-linked refresh beg end)
17230 "Display inline images.
17231 Normally only links without a description part are inlined, because this
17232 is how it will work for export. When INCLUDE-LINKED is set, also links
17233 with a description part will be inlined. This can be nice for a quick
17234 look at those images, but it does not reflect what exported files will look
17235 like.
17236 When REFRESH is set, refresh existing images between BEG and END.
17237 This will create new image displays only if necessary.
17238 BEG and END default to the buffer boundaries."
17239 (interactive "P")
17240 (unless refresh
17241 (org-remove-inline-images)
17242 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17243 (save-excursion
17244 (save-restriction
17245 (widen)
17246 (setq beg (or beg (point-min)) end (or end (point-max)))
17247 (goto-char (point-min))
17249 (substring (org-image-file-name-regexp) 0 -2)
17251 old file ov img)
17252 (while (re-search-forward re end t)
17253 (setq old (get-char-property-and-overlay (match-beginning 1)
17254 'org-image-overlay))
17255 (setq file (expand-file-name
17256 (concat (or (match-string 3) "") (match-string 4))))
17257 (when (file-exists-p file)
17258 (if (and (car-safe old) refresh)
17259 (image-refresh (overlay-get (cdr old) 'display))
17260 (setq img (save-match-data (create-image file)))
17261 (when img
17262 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17263 (overlay-put ov 'display img)
17264 (overlay-put ov 'face 'default)
17265 (overlay-put ov 'org-image-overlay t)
17266 (overlay-put ov 'modification-hooks
17267 (list 'org-display-inline-modification-hook))
17268 (push ov org-inline-image-overlays)))))))))
17270 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17271 "Remove inline-display overlay if a corresponding region is modified."
17272 (let ((inhibit-modification-hooks t))
17273 (when (and ov after)
17274 (delete ov org-inline-image-overlays)
17275 (delete-overlay ov))))
17277 (defun org-remove-inline-images ()
17278 "Remove inline display of images."
17279 (interactive)
17280 (mapc 'delete-overlay org-inline-image-overlays)
17281 (setq org-inline-image-overlays nil))
17283 ;;;; Key bindings
17285 ;; Outline functions from `outline-mode-prefix-map'
17286 ;; that can be remapped in Org:
17287 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17288 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17289 (define-key org-mode-map [remap outline-forward-same-level]
17290 'org-forward-same-level)
17291 (define-key org-mode-map [remap outline-backward-same-level]
17292 'org-backward-same-level)
17293 (define-key org-mode-map [remap show-branches]
17294 'org-kill-note-or-show-branches)
17295 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17296 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17297 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17299 ;; Outline functions from `outline-mode-prefix-map'
17300 ;; that can not be remapped in Org:
17301 ;; - the column "key binding" shows whether the Outline function is still
17302 ;; available in Org mode on the same key that it has been bound to in
17303 ;; Outline mode:
17304 ;; - "overridden": key used for a different functionality in Org mode
17305 ;; - else: key still bound to the same Outline function in Org mode
17306 ;; | Outline function | key binding | Org replacement |
17307 ;; |------------------------------------+-------------+-----------------------|
17308 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17309 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17310 ;; | `show-children' | `C-c C-i' | visibility cycling |
17311 ;; | `hide-subtree' | overridden | visibility cycling |
17312 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17313 ;; | `hide-body' | overridden | no replacement |
17314 ;; | `show-all' | overridden | no replacement |
17315 ;; | `hide-entry' | overridden | visibility cycling |
17316 ;; | `show-entry' | overridden | no replacement |
17317 ;; | `hide-leaves' | overridden | no replacement |
17318 ;; | `hide-sublevels' | overridden | no replacement |
17319 ;; | `hide-other' | overridden | no replacement |
17320 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17321 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17323 ;; Make `C-c C-x' a prefix key
17324 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17326 ;; TAB key with modifiers
17327 (org-defkey org-mode-map "\C-i" 'org-cycle)
17328 (org-defkey org-mode-map [(tab)] 'org-cycle)
17329 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17330 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17332 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17333 ;; The following line is necessary under Suse GNU/Linux
17334 (unless (featurep 'xemacs)
17335 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17336 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17337 (define-key org-mode-map [backtab] 'org-shifttab)
17339 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17340 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17341 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17343 ;; Cursor keys with modifiers
17344 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17345 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17346 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17347 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17349 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17350 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17351 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17352 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17354 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17355 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17356 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17357 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17359 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17360 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17361 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17362 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17364 ;; Babel keys
17365 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17366 (mapc (lambda (pair)
17367 (define-key org-babel-map (car pair) (cdr pair)))
17368 org-babel-key-bindings)
17370 ;;; Extra keys for tty access.
17371 ;; We only set them when really needed because otherwise the
17372 ;; menus don't show the simple keys
17374 (when (or org-use-extra-keys
17375 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17376 (not window-system))
17377 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17378 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17379 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17380 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17381 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17382 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17383 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17384 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17385 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17386 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17387 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17388 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17389 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17390 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17391 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17392 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17393 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17394 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17395 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17396 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17397 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17398 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17399 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17400 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17401 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17402 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17403 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17404 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17406 ;; All the other keys
17408 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17409 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17410 (if (boundp 'narrow-map)
17411 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17412 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17413 (if (boundp 'narrow-map)
17414 (org-defkey narrow-map "b" 'org-narrow-to-block)
17415 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17416 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17417 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17418 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17419 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17420 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17421 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17422 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17423 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17424 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17425 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17426 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17427 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17428 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17429 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17430 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17431 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17432 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17434 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17435 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17436 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17437 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17438 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17439 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17440 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17441 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17442 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17443 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17444 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17445 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17446 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17447 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17448 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17449 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17450 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17451 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17452 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17453 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17455 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17456 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17457 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17458 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17459 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17460 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17461 (org-defkey org-mode-map "\C-c^" 'org-sort)
17462 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17463 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17464 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17465 (org-defkey org-mode-map "\C-m" 'org-return)
17466 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17467 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17468 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17469 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17470 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17471 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17472 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17473 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17474 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17475 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17476 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17477 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17478 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17479 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17480 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17481 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17482 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17483 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17484 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17485 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17486 (org-defkey org-mode-map "\C-c\C-@" 'org-mark-list)
17487 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17488 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17490 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17491 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17492 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17493 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17495 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17496 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17497 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17498 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17499 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17500 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17501 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17502 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17503 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17504 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17506 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17507 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17508 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17509 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17510 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17511 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17512 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17514 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17515 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17516 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17517 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17518 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17520 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17522 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17524 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17525 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17527 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17530 (when (featurep 'xemacs)
17531 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17534 (defconst org-speed-commands-default
17535 '(
17536 ("Outline Navigation")
17537 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17538 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17539 ("f" . (org-speed-move-safe 'org-forward-same-level))
17540 ("b" . (org-speed-move-safe 'org-backward-same-level))
17541 ("u" . (org-speed-move-safe 'outline-up-heading))
17542 ("j" . org-goto)
17543 ("g" . (org-refile t))
17544 ("Outline Visibility")
17545 ("c" . org-cycle)
17546 ("C" . org-shifttab)
17547 (" " . org-display-outline-path)
17548 ("Outline Structure Editing")
17549 ("U" . org-shiftmetaup)
17550 ("D" . org-shiftmetadown)
17551 ("r" . org-metaright)
17552 ("l" . org-metaleft)
17553 ("R" . org-shiftmetaright)
17554 ("L" . org-shiftmetaleft)
17555 ("i" . (progn (forward-char 1) (call-interactively
17556 'org-insert-heading-respect-content)))
17557 ("^" . org-sort)
17558 ("w" . org-refile)
17559 ("a" . org-archive-subtree-default-with-confirmation)
17560 ("." . org-mark-subtree)
17561 ("Clock Commands")
17562 ("I" . org-clock-in)
17563 ("O" . org-clock-out)
17564 ("Meta Data Editing")
17565 ("t" . org-todo)
17566 ("0" . (org-priority ?\ ))
17567 ("1" . (org-priority ?A))
17568 ("2" . (org-priority ?B))
17569 ("3" . (org-priority ?C))
17570 (";" . org-set-tags-command)
17571 ("e" . org-set-effort)
17572 ("Agenda Views etc")
17573 ("v" . org-agenda)
17574 ("/" . org-sparse-tree)
17575 ("Misc")
17576 ("o" . org-open-at-point)
17577 ("?" . org-speed-command-help)
17578 ("<" . (org-agenda-set-restriction-lock 'subtree))
17579 (">" . (org-agenda-remove-restriction-lock))
17580 )
17581 "The default speed commands.")
17583 (defun org-print-speed-command (e)
17584 (if (> (length (car e)) 1)
17585 (progn
17587 (princ (car e))
17589 (princ (make-string (length (car e)) ?-))
17591 (princ (car e))
17592 (princ " ")
17593 (if (symbolp (cdr e))
17594 (princ (symbol-name (cdr e)))
17595 (prin1 (cdr e)))
17598 (defun org-speed-command-help ()
17599 "Show the available speed commands."
17600 (interactive)
17601 (if (not org-use-speed-commands)
17602 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17603 (with-output-to-temp-buffer "*Help*"
17605 (mapc 'org-print-speed-command org-speed-commands-user)
17608 (mapc 'org-print-speed-command org-speed-commands-default))
17609 (with-current-buffer "*Help*"
17610 (setq truncate-lines t))))
17612 (defun org-speed-move-safe (cmd)
17613 "Execute CMD, but make sure that the cursor always ends up in a headline.
17614 If not, return to the original position and throw an error."
17615 (interactive)
17616 (let ((pos (point)))
17617 (call-interactively cmd)
17618 (unless (and (bolp) (org-at-heading-p))
17619 (goto-char pos)
17620 (error "Boundary reached while executing %s" cmd))))
17622 (defvar org-self-insert-command-undo-counter 0)
17624 (defvar org-table-auto-blank-field) ; defined in org-table.el
17625 (defvar org-speed-command nil)
17627 (defun org-speed-command-default-hook (keys)
17628 "Hook for activating single-letter speed commands.
17629 `org-speed-commands-default' specifies a minimal command set.
17630 Use `org-speed-commands-user' for further customization."
17631 (when (or (and (bolp) (looking-at org-outline-regexp))
17632 (and (functionp org-use-speed-commands)
17633 (funcall org-use-speed-commands)))
17634 (cdr (assoc keys (append org-speed-commands-user
17635 org-speed-commands-default)))))
17637 (defun org-babel-speed-command-hook (keys)
17638 "Hook for activating single-letter code block commands."
17639 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17640 (cdr (assoc keys org-babel-key-bindings))))
17642 (defcustom org-speed-command-hook
17643 '(org-speed-command-default-hook org-babel-speed-command-hook)
17644 "Hook for activating speed commands at strategic locations.
17645 Hook functions are called in sequence until a valid handler is
17646 found.
17648 Each hook takes a single argument, a user-pressed command key
17649 which is also a `self-insert-command' from the global map.
17651 Within the hook, examine the cursor position and the command key
17652 and return nil or a valid handler as appropriate. Handler could
17653 be one of an interactive command, a function, or a form.
17655 Set `org-use-speed-commands' to non-nil value to enable this
17656 hook. The default setting is `org-speed-command-default-hook'."
17657 :group 'org-structure
17658 :version "24.1"
17659 :type 'hook)
17661 (defun org-self-insert-command (N)
17662 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17663 If the cursor is in a table looking at whitespace, the whitespace is
17664 overwritten, and the table is not marked as requiring realignment."
17665 (interactive "p")
17666 (org-check-before-invisible-edit 'insert)
17667 (cond
17668 ((and org-use-speed-commands
17669 (setq org-speed-command
17670 (run-hook-with-args-until-success
17671 'org-speed-command-hook (this-command-keys))))
17672 (cond
17673 ((commandp org-speed-command)
17674 (setq this-command org-speed-command)
17675 (call-interactively org-speed-command))
17676 ((functionp org-speed-command)
17677 (funcall org-speed-command))
17678 ((and org-speed-command (listp org-speed-command))
17679 (eval org-speed-command))
17680 (t (let (org-use-speed-commands)
17681 (call-interactively 'org-self-insert-command)))))
17682 ((and
17683 (org-table-p)
17684 (progn
17685 ;; check if we blank the field, and if that triggers align
17686 (and (featurep 'org-table) org-table-auto-blank-field
17687 (member last-command
17688 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17690 ;; got extra space, this field does not determine column width
17691 (let (org-table-may-need-update) (org-table-blank-field))
17692 ;; no extra space, this field may determine column width
17693 (org-table-blank-field)))
17694 t)
17695 (eq N 1)
17697 (let (org-table-may-need-update)
17698 (goto-char (1- (match-end 0)))
17699 (delete-char -1)
17700 (goto-char (match-beginning 0))
17701 (self-insert-command N)))
17702 (t
17703 (setq org-table-may-need-update t)
17704 (self-insert-command N)
17705 (org-fix-tags-on-the-fly)
17706 (if org-self-insert-cluster-for-undo
17707 (if (not (eq last-command 'org-self-insert-command))
17708 (setq org-self-insert-command-undo-counter 1)
17709 (if (>= org-self-insert-command-undo-counter 20)
17710 (setq org-self-insert-command-undo-counter 1)
17711 (and (> org-self-insert-command-undo-counter 0)
17712 buffer-undo-list (listp buffer-undo-list)
17713 (not (cadr buffer-undo-list)) ; remove nil entry
17714 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17715 (setq org-self-insert-command-undo-counter
17716 (1+ org-self-insert-command-undo-counter))))))))
17718 (defun org-check-before-invisible-edit (kind)
17719 "Check is editing if kind KIND would be dangerous with invisible text around.
17720 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17721 ;; First, try to get out of here as quickly as possible, to reduce overhead
17722 (if (and org-catch-invisible-edits
17723 (or (not (boundp 'visible-mode)) (not visible-mode))
17724 (or (get-char-property (point) 'invisible)
17725 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17726 ;; OK, we need to take a closer look
17727 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17728 (invisible-before-point (if (bobp) nil (get-char-property
17729 (1- (point)) 'invisible)))
17730 (border-and-ok-direction
17731 (or
17732 ;; Check if we are acting predictably before invisible text
17733 (and invisible-at-point (not invisible-before-point)
17734 (memq kind '(insert delete-backward)))
17735 ;; Check if we are acting predictably after invisible text
17736 ;; This works not well, and I have turned it off. It seems
17737 ;; better to always show and stop after invisible text.
17738 ;; (and (not invisible-at-point) invisible-before-point
17739 ;; (memq kind '(insert delete)))
17740 )))
17742 (when (or (memq invisible-at-point '(outline org-hide-block))
17743 (memq invisible-before-point '(outline org-hide-block)))
17744 (if (eq org-catch-invisible-edits 'error)
17745 (error "Editing in invisible areas is prohibited - make visible first"))
17746 ;; Make the area visible
17747 (save-excursion
17748 (if invisible-before-point
17749 (goto-char (previous-single-char-property-change
17750 (point) 'invisible)))
17751 (org-cycle))
17752 (cond
17753 ((eq org-catch-invisible-edits 'show)
17754 ;; That's it, we do the edit after showing
17755 (message
17756 "Unfolding invisible region around point before editing")
17757 (sit-for 1))
17758 ((and (eq org-catch-invisible-edits 'smart)
17759 border-and-ok-direction)
17760 (message "Unfolding invisible region around point before editing"))
17761 (t
17762 ;; Don't do the edit, make the user repeat it in full visibility
17763 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17765 (defun org-fix-tags-on-the-fly ()
17766 (when (and (equal (char-after (point-at-bol)) ?*)
17767 (org-at-heading-p))
17768 (org-align-tags-here org-tags-column)))
17770 (defun org-delete-backward-char (N)
17771 "Like `delete-backward-char', insert whitespace at field end in tables.
17772 When deleting backwards, in tables this function will insert whitespace in
17774 still be marked for re-alignment if the field did fill the entire column,
17775 because, in this case the deletion might narrow the column."
17776 (interactive "p")
17777 (org-check-before-invisible-edit 'delete-backward)
17778 (if (and (org-table-p)
17779 (eq N 1)
17780 (string-match "|" (buffer-substring (point-at-bol) (point)))
17781 (looking-at ".*?|"))
17782 (let ((pos (point))
17784 (c org-table-may-need-update))
17785 (backward-delete-char N)
17786 (if (not overwrite-mode)
17787 (progn
17788 (skip-chars-forward "^|")
17789 (insert " ")
17790 (goto-char (1- pos))))
17791 ;; noalign: if there were two spaces at the end, this field
17792 ;; does not determine the width of the column.
17793 (if noalign (setq org-table-may-need-update c)))
17794 (backward-delete-char N)
17795 (org-fix-tags-on-the-fly)))
17797 (defun org-delete-char (N)
17798 "Like `delete-char', but insert whitespace at field end in tables.
17799 When deleting characters, in tables this function will insert whitespace in
17801 still be marked for re-alignment if the field did fill the entire column,
17802 because, in this case the deletion might narrow the column."
17803 (interactive "p")
17804 (org-check-before-invisible-edit 'delete)
17805 (if (and (org-table-p)
17806 (not (bolp))
17807 (not (= (char-after) ?|))
17808 (eq N 1))
17809 (if (looking-at ".*?|")
17810 (let ((pos (point))
17812 (c org-table-may-need-update))
17813 (replace-match (concat
17814 (substring (match-string 0) 1 -1)
17815 " |"))
17816 (goto-char pos)
17817 ;; noalign: if there were two spaces at the end, this field
17818 ;; does not determine the width of the column.
17819 (if noalign (setq org-table-may-need-update c)))
17820 (delete-char N))
17821 (delete-char N)
17822 (org-fix-tags-on-the-fly)))
17824 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17825 (put 'org-self-insert-command 'delete-selection t)
17826 (put 'orgtbl-self-insert-command 'delete-selection t)
17827 (put 'org-delete-char 'delete-selection 'supersede)
17828 (put 'org-delete-backward-char 'delete-selection 'supersede)
17829 (put 'org-yank 'delete-selection 'yank)
17831 ;; Make `flyspell-mode' delay after some commands
17832 (put 'org-self-insert-command 'flyspell-delayed t)
17833 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17834 (put 'org-delete-char 'flyspell-delayed t)
17835 (put 'org-delete-backward-char 'flyspell-delayed t)
17837 ;; Make pabbrev-mode expand after org-mode commands
17838 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17839 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17841 ;; How to do this: Measure non-white length of current string
17842 ;; If equal to column width, we should realign.
17844 (defun org-remap (map &rest commands)
17845 "In MAP, remap the functions given in COMMANDS.
17846 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17847 (let (new old)
17848 (while commands
17849 (setq old (pop commands) new (pop commands))
17850 (if (fboundp 'command-remapping)
17851 (org-defkey map (vector 'remap old) new)
17852 (substitute-key-definition old new map global-map)))))
17854 (when (eq org-enable-table-editor 'optimized)
17855 ;; If the user wants maximum table support, we need to hijack
17856 ;; some standard editing functions
17857 (org-remap org-mode-map
17858 'self-insert-command 'org-self-insert-command
17859 'delete-char 'org-delete-char
17860 'delete-backward-char 'org-delete-backward-char)
17861 (org-defkey org-mode-map "|" 'org-force-self-insert))
17863 (defvar org-ctrl-c-ctrl-c-hook nil
17864 "Hook for functions attaching themselves to `C-c C-c'.
17866 This can be used to add additional functionality to the C-c C-c
17867 key which executes context-dependent commands. This hook is run
17868 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17869 run after the last test.
17871 Each function will be called with no arguments. The function
17872 must check if the context is appropriate for it to act. If yes,
17873 it should do its thing and then return a non-nil value. If the
17874 context is wrong, just do nothing and return nil.")
17876 (defvar org-ctrl-c-ctrl-c-final-hook nil
17877 "Hook for functions attaching themselves to `C-c C-c'.
17879 This can be used to add additional functionality to the C-c C-c
17880 key which executes context-dependent commands. This hook is run
17881 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17882 before the first test.
17884 Each function will be called with no arguments. The function
17885 must check if the context is appropriate for it to act. If yes,
17886 it should do its thing and then return a non-nil value. If the
17887 context is wrong, just do nothing and return nil.")
17889 (defvar org-tab-first-hook nil
17890 "Hook for functions to attach themselves to TAB.
17891 See `org-ctrl-c-ctrl-c-hook' for more information.
17892 This hook runs as the first action when TAB is pressed, even before
17893 `org-cycle' messes around with the `outline-regexp' to cater for
17894 inline tasks and plain list item folding.
17895 If any function in this hook returns t, any other actions that
17896 would have been caused by TAB (such as table field motion or visibility
17897 cycling) will not occur.")
17899 (defvar org-tab-after-check-for-table-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 it has been established that the cursor is not in a
17903 table, but before checking if the cursor is in a headline or if global cycling
17904 should be done.
17905 If any function in this hook returns t, not other actions like visibility
17906 cycling will be done.")
17908 (defvar org-tab-after-check-for-cycling-hook nil
17909 "Hook for functions to attach themselves to TAB.
17910 See `org-ctrl-c-ctrl-c-hook' for more information.
17911 This hook runs after it has been established that not table field motion and
17912 not visibility should be done because of current context. This is probably
17913 the place where a package like yasnippets can hook in.")
17915 (defvar org-tab-before-tab-emulation-hook nil
17916 "Hook for functions to attach themselves to TAB.
17917 See `org-ctrl-c-ctrl-c-hook' for more information.
17918 This hook runs after every other options for TAB have been exhausted, but
17921 (defvar org-metaleft-hook nil
17922 "Hook for functions attaching themselves to `M-left'.
17923 See `org-ctrl-c-ctrl-c-hook' for more information.")
17924 (defvar org-metaright-hook nil
17925 "Hook for functions attaching themselves to `M-right'.
17926 See `org-ctrl-c-ctrl-c-hook' for more information.")
17927 (defvar org-metaup-hook nil
17928 "Hook for functions attaching themselves to `M-up'.
17929 See `org-ctrl-c-ctrl-c-hook' for more information.")
17930 (defvar org-metadown-hook nil
17931 "Hook for functions attaching themselves to `M-down'.
17932 See `org-ctrl-c-ctrl-c-hook' for more information.")
17933 (defvar org-shiftmetaleft-hook nil
17934 "Hook for functions attaching themselves to `M-S-left'.
17935 See `org-ctrl-c-ctrl-c-hook' for more information.")
17936 (defvar org-shiftmetaright-hook nil
17937 "Hook for functions attaching themselves to `M-S-right'.
17938 See `org-ctrl-c-ctrl-c-hook' for more information.")
17939 (defvar org-shiftmetaup-hook nil
17940 "Hook for functions attaching themselves to `M-S-up'.
17941 See `org-ctrl-c-ctrl-c-hook' for more information.")
17942 (defvar org-shiftmetadown-hook nil
17943 "Hook for functions attaching themselves to `M-S-down'.
17944 See `org-ctrl-c-ctrl-c-hook' for more information.")
17945 (defvar org-metareturn-hook nil
17946 "Hook for functions attaching themselves to `M-RET'.
17947 See `org-ctrl-c-ctrl-c-hook' for more information.")
17948 (defvar org-shiftup-hook nil
17949 "Hook for functions attaching themselves to `S-up'.
17950 See `org-ctrl-c-ctrl-c-hook' for more information.")
17951 (defvar org-shiftup-final-hook nil
17952 "Hook for functions attaching themselves to `S-up'.
17953 This one runs after all other options except shift-select have been excluded.
17954 See `org-ctrl-c-ctrl-c-hook' for more information.")
17955 (defvar org-shiftdown-hook nil
17956 "Hook for functions attaching themselves to `S-down'.
17957 See `org-ctrl-c-ctrl-c-hook' for more information.")
17958 (defvar org-shiftdown-final-hook nil
17959 "Hook for functions attaching themselves to `S-down'.
17960 This one runs after all other options except shift-select have been excluded.
17961 See `org-ctrl-c-ctrl-c-hook' for more information.")
17962 (defvar org-shiftleft-hook nil
17963 "Hook for functions attaching themselves to `S-left'.
17964 See `org-ctrl-c-ctrl-c-hook' for more information.")
17965 (defvar org-shiftleft-final-hook nil
17966 "Hook for functions attaching themselves to `S-left'.
17967 This one runs after all other options except shift-select have been excluded.
17968 See `org-ctrl-c-ctrl-c-hook' for more information.")
17969 (defvar org-shiftright-hook nil
17970 "Hook for functions attaching themselves to `S-right'.
17971 See `org-ctrl-c-ctrl-c-hook' for more information.")
17972 (defvar org-shiftright-final-hook nil
17973 "Hook for functions attaching themselves to `S-right'.
17974 This one runs after all other options except shift-select have been excluded.
17975 See `org-ctrl-c-ctrl-c-hook' for more information.")
17977 (defun org-modifier-cursor-error ()
17978 "Throw an error, a modified cursor command was applied in wrong context."
17979 (error "This command is active in special context like tables, headlines or items"))
17981 (defun org-shiftselect-error ()
17982 "Throw an error because Shift-Cursor command was applied in wrong context."
17983 (if (and (boundp 'shift-select-mode) shift-select-mode)
17984 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17985 (error "This command works only in special context like headlines or timestamps")))
17987 (defun org-call-for-shift-select (cmd)
17988 (let ((this-command-keys-shift-translated t))
17989 (call-interactively cmd)))
17991 (defun org-shifttab (&optional arg)
17992 "Global visibility cycling or move to previous table field.
17993 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17994 on context.
17995 See the individual commands for more information."
17996 (interactive "P")
17997 (cond
17998 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17999 ((integerp arg)
18000 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18001 (message "Content view to level: %d" arg)
18002 (org-content (prefix-numeric-value arg2))
18003 (setq org-cycle-global-status 'overview)))
18004 (t (call-interactively 'org-global-cycle))))
18006 (defun org-shiftmetaleft ()
18007 "Promote subtree or delete table column.
18008 Calls `org-promote-subtree', `org-outdent-item',
18009 or `org-table-delete-column', depending on context.
18010 See the individual commands for more information."
18011 (interactive)
18012 (cond
18013 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18014 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18015 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18016 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
18017 (t (org-modifier-cursor-error))))
18019 (defun org-shiftmetaright ()
18020 "Demote subtree or insert table column.
18021 Calls `org-demote-subtree', `org-indent-item',
18022 or `org-table-insert-column', depending on context.
18023 See the individual commands for more information."
18024 (interactive)
18025 (cond
18026 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18027 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18028 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18029 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
18030 (t (org-modifier-cursor-error))))
18032 (defun org-shiftmetaup (&optional arg)
18033 "Move subtree up or kill table row.
18034 Calls `org-move-subtree-up' or `org-table-kill-row' or
18035 `org-move-item-up' depending on context. See the individual commands
18036 for more information."
18037 (interactive "P")
18038 (cond
18039 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18040 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18041 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18042 ((org-at-item-p) (call-interactively 'org-move-item-up))
18043 (t (org-modifier-cursor-error))))
18045 (defun org-shiftmetadown (&optional arg)
18046 "Move subtree down or insert table row.
18047 Calls `org-move-subtree-down' or `org-table-insert-row' or
18048 `org-move-item-down', depending on context. See the individual
18049 commands for more information."
18050 (interactive "P")
18051 (cond
18052 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18053 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18054 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18055 ((org-at-item-p) (call-interactively 'org-move-item-down))
18056 (t (org-modifier-cursor-error))))
18058 (defsubst org-hidden-tree-error ()
18059 (error
18060 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18062 (defun org-metaleft (&optional arg)
18063 "Promote heading or move table column to left.
18064 Calls `org-do-promote' or `org-table-move-column', depending on context.
18065 With no specific context, calls the Emacs default `backward-word'.
18066 See the individual commands for more information."
18067 (interactive "P")
18068 (cond
18069 ((run-hook-with-args-until-success 'org-metaleft-hook))
18070 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18071 ((org-with-limited-levels
18072 (or (org-at-heading-p)
18073 (and (org-region-active-p)
18074 (save-excursion
18075 (goto-char (region-beginning))
18076 (org-at-heading-p)))))
18077 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18078 (call-interactively 'org-do-promote))
18079 ;; At an inline task.
18080 ((org-at-heading-p)
18081 (call-interactively 'org-inlinetask-promote))
18082 ((or (org-at-item-p)
18083 (and (org-region-active-p)
18084 (save-excursion
18085 (goto-char (region-beginning))
18086 (org-at-item-p))))
18087 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18088 (call-interactively 'org-outdent-item))
18089 (t (call-interactively 'backward-word))))
18091 (defun org-metaright (&optional arg)
18092 "Demote a subtree, a list item or move table column to right.
18093 In front of a drawer or a block keyword, indent it correctly.
18094 With no specific context, calls the Emacs default `forward-word'.
18095 See the individual commands for more information."
18096 (interactive "P")
18097 (cond
18098 ((run-hook-with-args-until-success 'org-metaright-hook))
18099 ((org-at-table-p) (call-interactively 'org-table-move-column))
18100 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18101 ((org-at-block-p) (call-interactively 'org-indent-block))
18102 ((org-with-limited-levels
18103 (or (org-at-heading-p)
18104 (and (org-region-active-p)
18105 (save-excursion
18106 (goto-char (region-beginning))
18107 (org-at-heading-p)))))
18108 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18109 (call-interactively 'org-do-demote))
18110 ;; At an inline task.
18111 ((org-at-heading-p)
18112 (call-interactively 'org-inlinetask-demote))
18113 ((or (org-at-item-p)
18114 (and (org-region-active-p)
18115 (save-excursion
18116 (goto-char (region-beginning))
18117 (org-at-item-p))))
18118 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18119 (call-interactively 'org-indent-item))
18120 (t (call-interactively 'forward-word))))
18122 (defun org-check-for-hidden (what)
18123 "Check if there are hidden headlines/items in the current visual line.
18124 WHAT can be either `headlines' or `items'. If the current line is
18125 an outline or item heading and it has a folded subtree below it,
18126 this function returns t, nil otherwise."
18127 (let ((re (cond
18128 ((eq what 'headlines) org-outline-regexp-bol)
18129 ((eq what 'items) (org-item-beginning-re))
18130 (t (error "This should not happen"))))
18131 beg end)
18132 (save-excursion
18133 (catch 'exit
18134 (unless (org-region-active-p)
18135 (setq beg (point-at-bol))
18136 (beginning-of-line 2)
18137 (while (and (not (eobp)) ;; this is like `next-line'
18138 (get-char-property (1- (point)) 'invisible))
18139 (beginning-of-line 2))
18140 (setq end (point))
18141 (goto-char beg)
18142 (goto-char (point-at-eol))
18143 (setq end (max end (point)))
18144 (while (re-search-forward re end t)
18145 (if (get-char-property (match-beginning 0) 'invisible)
18146 (throw 'exit t))))
18147 nil))))
18149 (defun org-metaup (&optional arg)
18150 "Move subtree up or move table row up.
18151 Calls `org-move-subtree-up' or `org-table-move-row' or
18152 `org-move-item-up', depending on context. See the individual commands
18153 for more information."
18154 (interactive "P")
18155 (cond
18156 ((run-hook-with-args-until-success 'org-metaup-hook))
18157 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18158 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18159 ((org-at-item-p) (call-interactively 'org-move-item-up))
18160 (t (transpose-lines 1) (beginning-of-line -1))))
18162 (defun org-metadown (&optional arg)
18163 "Move subtree down or move table row down.
18164 Calls `org-move-subtree-down' or `org-table-move-row' or
18165 `org-move-item-down', depending on context. See the individual
18166 commands for more information."
18167 (interactive "P")
18168 (cond
18169 ((run-hook-with-args-until-success 'org-metadown-hook))
18170 ((org-at-table-p) (call-interactively 'org-table-move-row))
18171 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18172 ((org-at-item-p) (call-interactively 'org-move-item-down))
18173 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18175 (defun org-shiftup (&optional arg)
18176 "Increase item in timestamp or increase priority of current headline.
18177 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18178 depending on context. See the individual commands for more information."
18179 (interactive "P")
18180 (cond
18181 ((run-hook-with-args-until-success 'org-shiftup-hook))
18182 ((and org-support-shift-select (org-region-active-p))
18183 (org-call-for-shift-select 'previous-line))
18184 ((org-at-timestamp-p t)
18185 (call-interactively (if org-edit-timestamp-down-means-later
18186 'org-timestamp-down 'org-timestamp-up)))
18187 ((and (not (eq org-support-shift-select 'always))
18188 org-enable-priority-commands
18189 (org-at-heading-p))
18190 (call-interactively 'org-priority-up))
18191 ((and (not org-support-shift-select) (org-at-item-p))
18192 (call-interactively 'org-previous-item))
18193 ((org-clocktable-try-shift 'up arg))
18194 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18195 (org-support-shift-select
18196 (org-call-for-shift-select 'previous-line))
18197 (t (org-shiftselect-error))))
18199 (defun org-shiftdown (&optional arg)
18200 "Decrease item in timestamp or decrease priority of current headline.
18201 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18202 depending on context. See the individual commands for more information."
18203 (interactive "P")
18204 (cond
18205 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18206 ((and org-support-shift-select (org-region-active-p))
18207 (org-call-for-shift-select 'next-line))
18208 ((org-at-timestamp-p t)
18209 (call-interactively (if org-edit-timestamp-down-means-later
18210 'org-timestamp-up 'org-timestamp-down)))
18211 ((and (not (eq org-support-shift-select 'always))
18212 org-enable-priority-commands
18213 (org-at-heading-p))
18214 (call-interactively 'org-priority-down))
18215 ((and (not org-support-shift-select) (org-at-item-p))
18216 (call-interactively 'org-next-item))
18217 ((org-clocktable-try-shift 'down arg))
18218 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18219 (org-support-shift-select
18220 (org-call-for-shift-select 'next-line))
18221 (t (org-shiftselect-error))))
18223 (defun org-shiftright (&optional arg)
18224 "Cycle the thing at point or in the current line, depending on context.
18225 Depending on context, this does one of the following:
18227 - switch a timestamp at point one day into the future
18228 - on a headline, switch to the next TODO keyword.
18229 - on an item, switch entire list to the next bullet type
18230 - on a property line, switch to the next allowed value
18231 - on a clocktable definition line, move time block into the future"
18232 (interactive "P")
18233 (cond
18234 ((run-hook-with-args-until-success 'org-shiftright-hook))
18235 ((and org-support-shift-select (org-region-active-p))
18236 (org-call-for-shift-select 'forward-char))
18237 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18238 ((and (not (eq org-support-shift-select 'always))
18239 (org-at-heading-p))
18240 (let ((org-inhibit-logging
18241 (not org-treat-S-cursor-todo-selection-as-state-change))
18242 (org-inhibit-blocking
18243 (not org-treat-S-cursor-todo-selection-as-state-change)))
18244 (org-call-with-arg 'org-todo 'right)))
18245 ((or (and org-support-shift-select
18246 (not (eq org-support-shift-select 'always))
18247 (org-at-item-bullet-p))
18248 (and (not org-support-shift-select) (org-at-item-p)))
18249 (org-call-with-arg 'org-cycle-list-bullet nil))
18250 ((and (not (eq org-support-shift-select 'always))
18251 (org-at-property-p))
18252 (call-interactively 'org-property-next-allowed-value))
18253 ((org-clocktable-try-shift 'right arg))
18254 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18255 (org-support-shift-select
18256 (org-call-for-shift-select 'forward-char))
18257 (t (org-shiftselect-error))))
18259 (defun org-shiftleft (&optional arg)
18260 "Cycle the thing at point or in the current line, depending on context.
18261 Depending on context, this does one of the following:
18263 - switch a timestamp at point one day into the past
18264 - on a headline, switch to the previous TODO keyword.
18265 - on an item, switch entire list to the previous bullet type
18266 - on a property line, switch to the previous allowed value
18267 - on a clocktable definition line, move time block into the past"
18268 (interactive "P")
18269 (cond
18270 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18271 ((and org-support-shift-select (org-region-active-p))
18272 (org-call-for-shift-select 'backward-char))
18273 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18274 ((and (not (eq org-support-shift-select 'always))
18275 (org-at-heading-p))
18276 (let ((org-inhibit-logging
18277 (not org-treat-S-cursor-todo-selection-as-state-change))
18278 (org-inhibit-blocking
18279 (not org-treat-S-cursor-todo-selection-as-state-change)))
18280 (org-call-with-arg 'org-todo 'left)))
18281 ((or (and org-support-shift-select
18282 (not (eq org-support-shift-select 'always))
18283 (org-at-item-bullet-p))
18284 (and (not org-support-shift-select) (org-at-item-p)))
18285 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18286 ((and (not (eq org-support-shift-select 'always))
18287 (org-at-property-p))
18288 (call-interactively 'org-property-previous-allowed-value))
18289 ((org-clocktable-try-shift 'left arg))
18290 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18291 (org-support-shift-select
18292 (org-call-for-shift-select 'backward-char))
18293 (t (org-shiftselect-error))))
18295 (defun org-shiftcontrolright ()
18296 "Switch to next TODO set."
18297 (interactive)
18298 (cond
18299 ((and org-support-shift-select (org-region-active-p))
18300 (org-call-for-shift-select 'forward-word))
18301 ((and (not (eq org-support-shift-select 'always))
18302 (org-at-heading-p))
18303 (org-call-with-arg 'org-todo 'nextset))
18304 (org-support-shift-select
18305 (org-call-for-shift-select 'forward-word))
18306 (t (org-shiftselect-error))))
18308 (defun org-shiftcontrolleft ()
18309 "Switch to previous TODO set."
18310 (interactive)
18311 (cond
18312 ((and org-support-shift-select (org-region-active-p))
18313 (org-call-for-shift-select 'backward-word))
18314 ((and (not (eq org-support-shift-select 'always))
18315 (org-at-heading-p))
18316 (org-call-with-arg 'org-todo 'previousset))
18317 (org-support-shift-select
18318 (org-call-for-shift-select 'backward-word))
18319 (t (org-shiftselect-error))))
18321 (defun org-shiftcontrolup ()
18322 "Change timestamps synchronously up in CLOCK log lines."
18323 (interactive)
18324 (cond ((and (not org-support-shift-select)
18325 (org-at-clock-log-p)
18326 (org-at-timestamp-p t))
18327 (org-clock-timestamps-up))
18328 (t (org-shiftselect-error))))
18330 (defun org-shiftcontroldown ()
18331 "Change timestamps synchronously down in CLOCK log lines."
18332 (interactive)
18333 (cond ((and (not org-support-shift-select)
18334 (org-at-clock-log-p)
18335 (org-at-timestamp-p t))
18336 (org-clock-timestamps-down))
18337 (t (org-shiftselect-error))))
18339 (defun org-ctrl-c-ret ()
18340 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18341 (interactive)
18342 (cond
18343 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18344 (t (call-interactively 'org-insert-heading))))
18346 (defun org-find-visible ()
18347 (let ((s (point)))
18348 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18349 (get-char-property s 'invisible)))
18350 s))
18351 (defun org-find-invisible ()
18352 (let ((s (point)))
18353 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18354 (not (get-char-property s 'invisible))))
18355 s))
18357 (defun org-copy-visible (beg end)
18358 "Copy the visible parts of the region."
18359 (interactive "r")
18360 (let (snippets s)
18361 (save-excursion
18362 (save-restriction
18363 (narrow-to-region beg end)
18364 (setq s (goto-char (point-min)))
18365 (while (not (= (point) (point-max)))
18366 (goto-char (org-find-invisible))
18367 (push (buffer-substring s (point)) snippets)
18368 (setq s (goto-char (org-find-visible))))))
18369 (kill-new (apply 'concat (nreverse snippets)))))
18371 (defun org-copy-special ()
18372 "Copy region in table or copy current subtree.
18373 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18374 See the individual commands for more information."
18375 (interactive)
18376 (call-interactively
18377 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18379 (defun org-cut-special ()
18380 "Cut region in table or cut current subtree.
18381 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18382 See the individual commands for more information."
18383 (interactive)
18384 (call-interactively
18385 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18387 (defun org-paste-special (arg)
18388 "Paste rectangular region into table, or past subtree relative to level.
18389 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18390 See the individual commands for more information."
18391 (interactive "P")
18392 (if (org-at-table-p)
18393 (org-table-paste-rectangle)
18394 (org-paste-subtree arg)))
18396 (defun org-edit-special (&optional arg)
18397 "Call a special editor for the stuff at point.
18398 When at a table, call the formula editor with `org-table-edit-formulas'.
18399 When at the first line of an src example, call `org-edit-src-code'.
18400 When in an #+include line, visit the include file. Otherwise call
18401 `ffap' to visit the file at point."
18402 (interactive)
18403 ;; possibly prep session before editing source
18404 (when arg
18405 (let* ((info (org-babel-get-src-block-info))
18406 (lang (nth 0 info))
18407 (params (nth 2 info))
18408 (session (cdr (assoc :session params))))
18409 (when (and info session) ;; we are in a source-code block with a session
18410 (funcall
18411 (intern (concat "org-babel-prep-session:" lang)) session params))))
18412 (cond ;; proceed with `org-edit-special'
18413 ((save-excursion
18414 (beginning-of-line 1)
18415 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18416 (find-file (org-trim (match-string 1))))
18417 ((org-edit-src-code))
18418 ((org-edit-fixed-width-region))
18419 ((org-at-table.el-p)
18420 (org-edit-src-code))
18421 ((or (org-at-table-p)
18422 (save-excursion
18423 (beginning-of-line 1)
18425 (call-interactively 'org-table-edit-formulas))
18426 (t (call-interactively 'ffap))))
18428 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18429 (defun org-ctrl-c-ctrl-c (&optional arg)
18430 "Set tags in headline, or update according to changed information at point.
18432 This command does many different things, depending on context:
18434 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18435 this is what we do.
18437 - If the cursor is on a statistics cookie, update it.
18439 - If the cursor is in a headline, prompt for tags and insert them
18440 into the current line, aligned to `org-tags-column'. When called
18441 with prefix arg, realign all tags in the current buffer.
18443 - If the cursor is in one of the special #+KEYWORD lines, this
18444 triggers scanning the buffer for these lines and updating the
18445 information.
18447 - If the cursor is inside a table, realign the table. This command
18448 works even if the automatic table editor has been turned off.
18450 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18451 the entire table.
18453 - If the cursor is at a footnote reference or definition, jump to
18454 the corresponding definition or references, respectively.
18456 - If the cursor is a the beginning of a dynamic block, update it.
18458 - If the current buffer is a capture buffer, close note and file it.
18460 - If the cursor is on a <<<target>>>, update radio targets and
18461 corresponding links in this buffer.
18463 - If the cursor is on a numbered item in a plain list, renumber the
18464 ordered list.
18466 - If the cursor is on a checkbox, toggle it.
18468 - If the cursor is on a code block, evaluate it. The variable
18469 `org-confirm-babel-evaluate' can be used to control prompting
18470 before code block evaluation, by default every code block
18471 evaluation requires confirmation. Code block evaluation can be
18472 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18473 (interactive "P")
18474 (let ((org-enable-table-editor t))
18475 (cond
18476 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18477 org-occur-highlights
18478 org-latex-fragment-image-overlays)
18479 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18480 (org-remove-occur-highlights)
18481 (org-remove-latex-fragment-image-overlays)
18482 (message "Temporary highlights/overlays removed from current buffer"))
18483 ((and (local-variable-p 'org-finish-function (current-buffer))
18484 (fboundp org-finish-function))
18485 (funcall org-finish-function))
18486 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18487 ((org-in-regexp org-ts-regexp-both)
18488 (org-timestamp-change 0 'day))
18489 ((or (looking-at org-property-start-re)
18490 (org-at-property-p))
18491 (call-interactively 'org-property-action))
18492 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18494 (or (org-at-heading-p) (org-at-item-p)))
18495 (call-interactively 'org-update-statistics-cookies))
18496 ((org-at-heading-p) (call-interactively 'org-set-tags))
18497 ((org-at-table.el-p)
18498 (message "Use C-c ' to edit table.el tables"))
18499 ((org-at-table-p)
18500 (org-table-maybe-eval-formula)
18501 (if arg
18502 (call-interactively 'org-table-recalculate)
18503 (org-table-maybe-recalculate-line))
18504 (call-interactively 'org-table-align)
18505 (orgtbl-send-table 'maybe))
18506 ((or (org-footnote-at-reference-p)
18507 (org-footnote-at-definition-p))
18508 (call-interactively 'org-footnote-action))
18509 ((org-at-item-checkbox-p)
18510 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18511 ;; list only if at top item.
18512 (let* ((cbox (match-string 1))
18513 (struct (org-list-struct))
18514 (old-struct (copy-tree struct))
18515 (parents (org-list-parents-alist struct))
18516 (orderedp (org-entry-get nil "ORDERED"))
18517 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18518 block-item)
18519 ;; Use a light version of `org-toggle-checkbox' to avoid
18520 ;; computing list structure twice.
18521 (let ((new-box (cond
18522 ((equal arg '(16)) "[-]")
18523 ((equal arg '(4)) nil)
18524 ((equal "[X]" cbox) "[ ]")
18525 (t "[X]"))))
18526 (if (and firstp arg)
18527 ;; If at first item of sub-list, remove check-box from
18528 ;; every item at the same level.
18529 (mapc
18530 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18531 (org-list-get-all-items
18532 (point-at-bol) struct (org-list-prevs-alist struct)))
18533 (org-list-set-checkbox (point-at-bol) struct new-box)))
18534 ;; Replicate `org-list-write-struct', while grabbing a return
18535 ;; value from `org-list-struct-fix-box'.
18536 (org-list-struct-fix-ind struct parents 2)
18537 (org-list-struct-fix-item-end struct)
18538 (let ((prevs (org-list-prevs-alist struct)))
18539 (org-list-struct-fix-bul struct prevs)
18540 (org-list-struct-fix-ind struct parents)
18541 (setq block-item
18542 (org-list-struct-fix-box struct parents prevs orderedp)))
18543 (org-list-struct-apply-struct struct old-struct)
18544 (org-update-checkbox-count-maybe)
18545 (when block-item
18546 (message
18547 "Checkboxes were removed due to unchecked box at line %d"
18548 (org-current-line block-item)))
18549 (when firstp (org-list-send-list 'maybe))))
18550 ((org-at-item-p)
18551 ;; Cursor at an item: repair list. Do checkbox related actions
18552 ;; only if function was called with an argument. Send list only
18553 ;; if at top item.
18554 (let* ((struct (org-list-struct))
18555 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18556 old-struct)
18557 (when arg
18558 (setq old-struct (copy-tree struct))
18559 (if firstp
18560 ;; If at first item of sub-list, add check-box to every
18561 ;; item at the same level.
18562 (mapc
18563 (lambda (pos)
18564 (unless (org-list-get-checkbox pos struct)
18565 (org-list-set-checkbox pos struct "[ ]")))
18566 (org-list-get-all-items
18567 (point-at-bol) struct (org-list-prevs-alist struct)))
18568 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18569 (org-list-write-struct
18570 struct (org-list-parents-alist struct) old-struct)
18571 (when arg (org-update-checkbox-count-maybe))
18572 (when firstp (org-list-send-list 'maybe))))
18573 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18574 ;; Dynamic block
18575 (beginning-of-line 1)
18576 (save-excursion (org-update-dblock)))
18577 ((save-excursion
18578 (beginning-of-line 1)
18580 (cond
18581 ((equal (match-string 1) "TBLFM")
18582 ;; Recalculate the table before this line
18583 (save-excursion
18584 (beginning-of-line 1)
18586 (if (org-at-table-p)
18587 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18588 (t
18589 (let ((org-inhibit-startup-visibility-stuff t)
18590 (org-startup-align-all-tables nil))
18591 (when (boundp 'org-table-coordinate-overlays)
18592 (mapc 'delete-overlay org-table-coordinate-overlays)
18593 (setq org-table-coordinate-overlays nil))
18594 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18595 (message "Local setup has been refreshed"))))
18596 ((org-clock-update-time-maybe))
18597 (t
18598 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18599 (error "C-c C-c can do nothing useful at this location"))))))
18601 (defun org-mode-restart ()
18602 "Restart Org-mode, to scan again for special lines.
18603 Also updates the keyword regular expressions."
18604 (interactive)
18605 (org-mode)
18606 (message "Org-mode restarted"))
18608 (defun org-kill-note-or-show-branches ()
18609 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18610 (interactive)
18611 (if (not org-finish-function)
18612 (progn
18613 (hide-subtree)
18614 (call-interactively 'show-branches))
18615 (let ((org-note-abort t))
18616 (funcall org-finish-function))))
18618 (defun org-return (&optional indent)
18619 "Goto next table row or insert a newline.
18620 Calls `org-table-next-row' or `newline', depending on context.
18621 See the individual commands for more information."
18622 (interactive)
18623 (cond
18624 ((or (bobp) (org-in-src-block-p))
18625 (if indent (newline-and-indent) (newline)))
18626 ((org-at-table-p)
18627 (org-table-justify-field-maybe)
18628 (call-interactively 'org-table-next-row))
18629 ;; when `newline-and-indent' is called within a list, make sure
18630 ;; text moved stays inside the item.
18631 ((and (org-in-item-p) indent)
18632 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18633 (progn
18634 (save-match-data (newline))
18635 (org-indent-line-to (length (match-string 0))))
18636 (let ((ind (org-get-indentation)))
18637 (newline)
18638 (if (org-looking-back org-list-end-re)
18639 (org-indent-line-function)
18640 (org-indent-line-to ind)))))
18641 ((and org-return-follows-link
18642 (let ((tprop (get-text-property (point) 'face)))
18643 (or (eq tprop 'org-link)
18644 (and (listp tprop) (memq 'org-link tprop)))))
18645 (call-interactively 'org-open-at-point))
18646 ((and (org-at-heading-p)
18647 (looking-at
18649 (org-show-entry)
18650 (end-of-line 1)
18651 (newline))
18652 (t (if indent (newline-and-indent) (newline)))))
18654 (defun org-return-indent ()
18655 "Goto next table row or insert a newline and indent.
18656 Calls `org-table-next-row' or `newline-and-indent', depending on
18657 context. See the individual commands for more information."
18658 (interactive)
18659 (org-return t))
18661 (defun org-ctrl-c-star ()
18662 "Compute table, or change heading status of lines.
18663 Calls `org-table-recalculate' or `org-toggle-heading',
18664 depending on context."
18665 (interactive)
18666 (cond
18667 ((org-at-table-p)
18668 (call-interactively 'org-table-recalculate))
18669 (t
18670 ;; Convert all lines in region to list items
18671 (call-interactively 'org-toggle-heading))))
18673 (defun org-ctrl-c-minus ()
18674 "Insert separator line in table or modify bullet status of line.
18675 Also turns a plain line or a region of lines into list items.
18676 Calls `org-table-insert-hline', `org-toggle-item', or
18677 `org-cycle-list-bullet', depending on context."
18678 (interactive)
18679 (cond
18680 ((org-at-table-p)
18681 (call-interactively 'org-table-insert-hline))
18682 ((org-region-active-p)
18683 (call-interactively 'org-toggle-item))
18684 ((org-in-item-p)
18685 (call-interactively 'org-cycle-list-bullet))
18686 (t
18687 (call-interactively 'org-toggle-item))))
18689 (defun org-toggle-item (arg)
18690 "Convert headings or normal lines to items, items to normal lines.
18691 If there is no active region, only the current line is considered.
18693 If the first non blank line in the region is an headline, convert
18694 all headlines to items, shifting text accordingly.
18696 If it is an item, convert all items to normal lines.
18698 If it is normal text, change region into an item. With a prefix
18699 argument ARG, change each line in region into an item."
18700 (interactive "P")
18701 (let ((shift-text
18702 (function
18703 ;; Shift text in current section to IND, from point to END.
18704 ;; The function leaves point to END line.
18705 (lambda (ind end)
18706 (let ((min-i 1000) (end (copy-marker end)))
18707 ;; First determine the minimum indentation (MIN-I) of
18708 ;; the text.
18709 (save-excursion
18710 (catch 'exit
18711 (while (< (point) end)
18712 (let ((i (org-get-indentation)))
18713 (cond
18714 ;; Skip blank lines and inline tasks.
18716 ((looking-at org-outline-regexp-bol))
18717 ;; We can't find less than 0 indentation.
18718 ((zerop i) (throw 'exit (setq min-i 0)))
18719 ((< i min-i) (setq min-i i))))
18720 (forward-line))))
18721 ;; Then indent each line so that a line indented to
18722 ;; MIN-I becomes indented to IND. Ignore blank lines
18723 ;; and inline tasks in the process.
18724 (let ((delta (- ind min-i)))
18725 (while (< (point) end)
18727 (looking-at org-outline-regexp-bol))
18728 (org-indent-line-to (+ (org-get-indentation) delta)))
18729 (forward-line)))))))
18730 (skip-blanks
18731 (function
18732 ;; Return beginning of first non-blank line, starting from
18733 ;; line at POS.
18734 (lambda (pos)
18735 (save-excursion
18736 (goto-char pos)
18738 (point-at-bol)))))
18739 beg end)
18740 ;; Determine boundaries of changes.
18741 (if (org-region-active-p)
18742 (setq beg (funcall skip-blanks (region-beginning))
18743 end (copy-marker (region-end)))
18744 (setq beg (funcall skip-blanks (point-at-bol))
18745 end (copy-marker (point-at-eol))))
18746 ;; Depending on the starting line, choose an action on the text
18747 ;; between BEG and END.
18748 (org-with-limited-levels
18749 (save-excursion
18750 (goto-char beg)
18751 (cond
18752 ;; Case 1. Start at an item: de-itemize. Note that it only
18753 ;; happens when a region is active: `org-ctrl-c-minus'
18754 ;; would call `org-cycle-list-bullet' otherwise.
18755 ((org-at-item-p)
18756 (while (< (point) end)
18757 (when (org-at-item-p)
18759 (delete-region (point) (match-end 0)))
18760 (forward-line)))
18761 ;; Case 2. Start at an heading: convert to items.
18762 ((org-at-heading-p)
18763 (let* ((bul (org-list-bullet-string "-"))
18764 (bul-len (length bul))
18765 ;; Indentation of the first heading. It should be
18766 ;; relative to the indentation of its parent, if any.
18767 (start-ind (save-excursion
18768 (cond
18769 ((not org-adapt-indentation) 0)
18770 ((not (outline-previous-heading)) 0)
18771 (t (length (match-string 0))))))
18772 ;; Level of first heading. Further headings will be
18773 ;; compared to it to determine hierarchy in the list.
18774 (ref-level (org-reduced-level (org-outline-level))))
18775 (while (< (point) end)
18776 (let* ((level (org-reduced-level (org-outline-level)))
18777 (delta (max 0 (- level ref-level))))
18778 ;; If current headline is less indented than the first
18779 ;; one, set it as reference, in order to preserve
18780 ;; subtrees.
18781 (when (< level ref-level) (setq ref-level level))
18782 (replace-match bul t t)
18783 (org-indent-line-to (+ start-ind (* delta bul-len)))
18784 ;; Ensure all text down to END (or SECTION-END) belongs
18785 ;; to the newly created item.
18786 (let ((section-end (save-excursion
18787 (or (outline-next-heading) (point)))))
18788 (forward-line)
18789 (funcall shift-text
18790 (+ start-ind (* (1+ delta) bul-len))
18791 (min end section-end)))))))
18792 ;; Case 3. Normal line with ARG: turn each non-item line into
18793 ;; an item.
18794 (arg
18795 (while (< (point) end)
18796 (unless (or (org-at-heading-p) (org-at-item-p))
18798 (replace-match
18800 (forward-line)))
18801 ;; Case 4. Normal line without ARG: make the first line of
18802 ;; region an item, and shift indentation of others
18803 ;; lines to set them as item's body.
18804 (t (let* ((bul (org-list-bullet-string "-"))
18805 (bul-len (length bul))
18806 (ref-ind (org-get-indentation)))
18808 (insert bul)
18809 (forward-line)
18810 (while (< (point) end)
18811 ;; Ensure that lines less indented than first one
18812 ;; still get included in item body.
18813 (funcall shift-text
18814 (+ ref-ind bul-len)
18815 (min end (save-excursion (or (outline-next-heading)
18816 (point)))))
18817 (forward-line)))))))))
18819 (defun org-toggle-heading (&optional nstars)
18820 "Convert headings to normal text, or items or text to headings.
18821 If there is no active region, only the current line is considered.
18823 If the first non blank line is an headline, remove the stars from
18824 all headlines in the region.
18826 If it is a plain list item, turn all plain list items into headings.
18828 If it is a normal line, turn each and every normal line (i.e. not
18829 an heading or an item) in the region into a heading.
18831 When converting a line into a heading, the number of stars is chosen
18832 such that the lines become children of the current entry. However,
18833 when a prefix argument is given, its value determines the number of
18834 stars to add."
18835 (interactive "P")
18836 (let ((skip-blanks
18837 (function
18838 ;; Return beginning of first non-blank line, starting from
18839 ;; line at POS.
18840 (lambda (pos)
18841 (save-excursion
18842 (goto-char pos)
18844 (point-at-bol)))))
18845 beg end)
18846 ;; Determine boundaries of changes. If region ends at a bol, do
18847 ;; not consider the last line to be in the region.
18848 (if (org-region-active-p)
18849 (setq beg (funcall skip-blanks (region-beginning))
18850 end (copy-marker (save-excursion
18851 (goto-char (region-end))
18852 (if (bolp) (point) (point-at-eol)))))
18853 (setq beg (funcall skip-blanks (point-at-bol))
18854 end (copy-marker (point-at-eol))))
18855 ;; Ensure inline tasks don't count as headings.
18856 (org-with-limited-levels
18857 (save-excursion
18858 (goto-char beg)
18859 (cond
18860 ;; Case 1. Started at an heading: de-star headings.
18861 ((org-at-heading-p)
18862 (while (< (point) end)
18863 (when (org-at-heading-p t)
18864 (looking-at org-outline-regexp) (replace-match ""))
18865 (forward-line)))
18866 ;; Case 2. Started at an item: change items into headlines.
18867 ;; One star will be added by `org-list-to-subtree'.
18868 ((org-at-item-p)
18869 (let* ((stars (make-string
18870 (if nstars
18871 ;; subtract the star that will be added again by
18872 ;; `org-list-to-subtree'
18873 (1- (prefix-numeric-value current-prefix-arg))
18874 (or (org-current-level) 0))
18875 ?*))
18876 (add-stars
18877 (cond (nstars "") ; stars from prefix only
18878 ((equal stars "") "") ; before first heading
18879 (org-odd-levels-only "*") ; inside heading, odd
18880 (t "")))) ; inside heading, oddeven
18881 (while (< (point) end)
18882 (when (org-at-item-p)
18883 ;; Pay attention to cases when region ends before list.
18884 (let* ((struct (org-list-struct))
18885 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18886 (save-restriction
18887 (narrow-to-region (point) list-end)
18888 (insert
18889 (org-list-to-subtree
18890 (org-list-parse-list t)
18891 '(:istart (concat stars add-stars (funcall get-stars depth))
18892 :icount (concat stars add-stars (funcall get-stars depth))))))))
18893 (forward-line))))
18894 ;; Case 3. Started at normal text: make every line an heading,
18895 ;; skipping headlines and items.
18896 (t (let* ((stars (make-string
18897 (if nstars
18898 (prefix-numeric-value current-prefix-arg)
18899 (or (org-current-level) 0))
18900 ?*))
18901 (add-stars
18902 (cond (nstars "") ; stars from prefix only
18903 ((equal stars "") "*") ; before first heading
18904 (org-odd-levels-only "**") ; inside heading, odd
18905 (t "*"))) ; inside heading, oddeven
18906 (rpl (concat stars add-stars " ")))
18907 (while (< (point) end)
18908 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18910 (replace-match (concat rpl (match-string 2))))
18911 (forward-line)))))))))
18913 (defun org-meta-return (&optional arg)
18914 "Insert a new heading or wrap a region in a table.
18915 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18916 See the individual commands for more information."
18917 (interactive "P")
18918 (cond
18919 ((run-hook-with-args-until-success 'org-metareturn-hook))
18920 ((or (org-at-drawer-p) (org-at-property-p))
18921 (newline-and-indent))
18922 ((org-at-table-p)
18923 (call-interactively 'org-table-wrap-region))
18924 (t (call-interactively 'org-insert-heading))))
18926 ;;; Menu entries
18928 ;; Define the Org-mode menus
18929 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18930 '("Tbl"
18931 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18932 ["Next Field" org-cycle (org-at-table-p)]
18933 ["Previous Field" org-shifttab (org-at-table-p)]
18934 ["Next Row" org-return (org-at-table-p)]
18935 "--"
18936 ["Blank Field" org-table-blank-field (org-at-table-p)]
18937 ["Edit Field" org-table-edit-field (org-at-table-p)]
18938 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18939 "--"
18940 ("Column"
18941 ["Move Column Left" org-metaleft (org-at-table-p)]
18942 ["Move Column Right" org-metaright (org-at-table-p)]
18943 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18944 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18945 ("Row"
18946 ["Move Row Up" org-metaup (org-at-table-p)]
18947 ["Move Row Down" org-metadown (org-at-table-p)]
18948 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18949 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18950 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18951 "--"
18952 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18953 ("Rectangle"
18954 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18955 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18956 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18957 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18958 "--"
18959 ("Calculate"
18960 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18961 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18962 ["Edit Formulas" org-edit-special (org-at-table-p)]
18963 "--"
18964 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18965 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18966 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18967 "--"
18968 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18969 "--"
18970 ["Sum Column/Rectangle" org-table-sum
18971 (or (org-at-table-p) (org-region-active-p))]
18972 ["Which Column?" org-table-current-column (org-at-table-p)])
18973 ["Debug Formulas"
18974 org-table-toggle-formula-debugger
18975 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18976 ["Show Col/Row Numbers"
18977 org-table-toggle-coordinate-overlays
18978 :style toggle
18979 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18980 "--"
18981 ["Create" org-table-create (and (not (org-at-table-p))
18982 org-enable-table-editor)]
18983 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18984 ["Import from File" org-table-import (not (org-at-table-p))]
18985 ["Export to File" org-table-export (org-at-table-p)]
18986 "--"
18987 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18989 (easy-menu-define org-org-menu org-mode-map "Org menu"
18990 '("Org"
18991 ("Show/Hide"
18992 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18993 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18994 ["Sparse Tree..." org-sparse-tree t]
18995 ["Reveal Context" org-reveal t]
18996 ["Show All" show-all t]
18997 "--"
18998 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18999 "--"
19000 ["New Heading" org-insert-heading t]
19001 ("Navigate Headings"
19002 ["Up" outline-up-heading t]
19003 ["Next" outline-next-visible-heading t]
19004 ["Previous" outline-previous-visible-heading t]
19005 ["Next Same Level" outline-forward-same-level t]
19006 ["Previous Same Level" outline-backward-same-level t]
19007 "--"
19008 ["Jump" org-goto t])
19009 ("Edit Structure"
19010 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
19011 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
19012 "--"
19013 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
19014 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
19015 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19016 "--"
19017 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19018 "--"
19019 ["Copy visible text" org-copy-visible t]
19020 "--"
19021 ["Promote Heading" org-metaleft (not (org-at-table-p))]
19022 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
19023 ["Demote Heading" org-metaright (not (org-at-table-p))]
19024 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
19025 "--"
19026 ["Sort Region/Children" org-sort (not (org-at-table-p))]
19027 "--"
19028 ["Convert to odd levels" org-convert-to-odd-levels t]
19029 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19030 ("Editing"
19031 ["Emphasis..." org-emphasize t]
19032 ["Edit Source Example" org-edit-special t]
19033 "--"
19034 ["Footnote new/jump" org-footnote-action t]
19035 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19036 ("Archive"
19037 ["Archive (default method)" org-archive-subtree-default t]
19038 "--"
19039 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
19040 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
19041 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
19042 )
19043 "--"
19044 ("Hyperlinks"
19045 ["Store Link (Global)" org-store-link t]
19046 ["Find existing link to here" org-occur-link-in-agenda-files t]
19047 ["Insert Link" org-insert-link t]
19048 ["Follow Link" org-open-at-point t]
19049 "--"
19050 ["Next link" org-next-link t]
19051 ["Previous link" org-previous-link t]
19052 "--"
19053 ["Descriptive Links"
19054 org-toggle-link-display
19055 :style radio
19056 :selected org-descriptive-links
19057 ]
19058 ["Literal Links"
19059 org-toggle-link-display
19060 :style radio
19061 :selected (not org-descriptive-links)])
19062 "--"
19063 ("TODO Lists"
19064 ["TODO/DONE/-" org-todo t]
19065 ("Select keyword"
19066 ["Next keyword" org-shiftright (org-at-heading-p)]
19067 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19068 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19069 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19070 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19071 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19072 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19073 "--"
19074 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19075 :selected org-enforce-todo-dependencies :style toggle :active t]
19076 "Settings for tree at point"
19077 ["Do Children sequentially" org-toggle-ordered-property :style radio
19078 :selected (org-entry-get nil "ORDERED")
19079 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19080 ["Do Children parallel" org-toggle-ordered-property :style radio
19081 :selected (not (org-entry-get nil "ORDERED"))
19082 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19083 "--"
19084 ["Set Priority" org-priority t]
19085 ["Priority Up" org-shiftup t]
19086 ["Priority Down" org-shiftdown t]
19087 "--"
19088 ["Get news from all feeds" org-feed-update-all t]
19089 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19090 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19091 ("TAGS and Properties"
19092 ["Set Tags" org-set-tags-command t]
19093 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19094 "--"
19095 ["Set property" org-set-property t]
19096 ["Column view of properties" org-columns t]
19097 ["Insert Column View DBlock" org-insert-columns-dblock t])
19098 ("Dates and Scheduling"
19099 ["Timestamp" org-time-stamp t]
19100 ["Timestamp (inactive)" org-time-stamp-inactive t]
19101 ("Change Date"
19102 ["1 Day Later" org-shiftright t]
19103 ["1 Day Earlier" org-shiftleft t]
19104 ["1 ... Later" org-shiftup t]
19105 ["1 ... Earlier" org-shiftdown t])
19106 ["Compute Time Range" org-evaluate-time-range t]
19107 ["Schedule Item" org-schedule t]
19108 ["Deadline" org-deadline t]
19109 "--"
19110 ["Custom time format" org-toggle-time-stamp-overlays
19111 :style radio :selected org-display-custom-times]
19112 "--"
19113 ["Goto Calendar" org-goto-calendar t]
19114 ["Date from Calendar" org-date-from-calendar t]
19115 "--"
19116 ["Start/Restart Timer" org-timer-start t]
19117 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19118 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19119 ["Insert Timer String" org-timer t]
19120 ["Insert Timer Item" org-timer-item t])
19121 ("Logging work"
19122 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19123 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19124 ["Clock out" org-clock-out t]
19125 ["Clock cancel" org-clock-cancel t]
19126 "--"
19127 ["Mark as default task" org-clock-mark-default-task t]
19128 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19129 ["Goto running clock" org-clock-goto t]
19130 "--"
19131 ["Display times" org-clock-display t]
19132 ["Create clock table" org-clock-report t]
19133 "--"
19134 ["Record DONE time"
19135 (progn (setq org-log-done (not org-log-done))
19136 (message "Switching to %s will %s record a timestamp"
19137 (car org-done-keywords)
19138 (if org-log-done "automatically" "not")))
19139 :style toggle :selected org-log-done])
19140 "--"
19141 ["Agenda Command..." org-agenda t]
19142 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19143 ("File List for Agenda")
19144 ("Special views current file"
19145 ["TODO Tree" org-show-todo-tree t]
19146 ["Check Deadlines" org-check-deadlines t]
19147 ["Timeline" org-timeline t]
19148 ["Tags/Property tree" org-match-sparse-tree t])
19149 "--"
19150 ["Export/Publish..." org-export t]
19151 ("LaTeX"
19152 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19153 :selected org-cdlatex-mode]
19154 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19155 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19156 ["Modify math symbol" org-cdlatex-math-modify
19157 (org-inside-LaTeX-fragment-p)]
19158 ["Insert citation" org-reftex-citation t]
19159 "--"
19160 ["Template for BEAMER" org-insert-beamer-options-template t])
19161 "--"
19162 ("MobileOrg"
19163 ["Push Files and Views" org-mobile-push t]
19164 ["Get Captured and Flagged" org-mobile-pull t]
19165 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19166 "--"
19167 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19168 "--"
19169 ("Documentation"
19170 ["Show Version" org-version t]
19171 ["Info Documentation" org-info t])
19172 ("Customize"
19173 ["Browse Org Group" org-customize t]
19174 "--"
19175 ["Expand This Menu" org-create-customize-menu
19176 (fboundp 'customize-menu-create)])
19177 ["Send bug report" org-submit-bug-report t]
19178 "--"
19179 ("Refresh/Reload"
19180 ["Refresh setup current buffer" org-mode-restart t]
19181 ["Reload Org (after update)" org-reload t]
19182 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19183 ))
19185 (defun org-info (&optional node)
19186 "Read documentation for Org-mode in the info system.
19187 With optional NODE, go directly to that node."
19188 (interactive)
19189 (info (format "(org)%s" (or node ""))))
19191 ;;;###autoload
19192 (defun org-submit-bug-report ()
19193 "Submit a bug report on Org-mode via mail.
19195 Don't hesitate to report any problems or inaccurate documentation.
19197 If you don't have setup sending mail from (X)Emacs, please copy the
19198 output buffer into your mail program, as it gives us important
19199 information about your Org-mode version and configuration."
19200 (interactive)
19201 (require 'reporter)
19202 (org-load-modules-maybe)
19203 (org-require-autoloaded-modules)
19204 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19205 (reporter-submit-bug-report
19206 "emacs-orgmode@gnu.org"
19207 (org-version)
19208 (let (list)
19209 (save-window-excursion
19210 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19211 (delete-other-windows)
19212 (erase-buffer)
19213 (insert "You are about to submit a bug report to the Org-mode mailing list.
19215 We would like to add your full Org-mode and Outline configuration to the
19216 bug report. This greatly simplifies the work of the maintainer and
19217 other experts on the mailing list.
19219 HOWEVER, some variables you have customized may contain private
19220 information. The names of customers, colleagues, or friends, might
19221 appear in the form of file names, tags, todo states, or search strings.
19222 If you answer yes to the prompt, you might want to check and remove
19223 such private information before sending the email.")
19224 (add-text-properties (point-min) (point-max) '(face org-warning))
19225 (when (yes-or-no-p "Include your Org-mode configuration ")
19226 (mapatoms
19227 (lambda (v)
19228 (and (boundp v)
19230 (or (and (symbol-value v)
19232 (and
19233 (get v 'custom-type) (get v 'standard-value)
19234 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19235 (push v list)))))
19236 (kill-buffer (get-buffer "*Warn about privacy*"))
19237 list))
19238 nil nil
19239 "Remember to cover the basics, that is, what you expected to happen and
19240 what in fact did happen. You don't know how to make a good report? See
19242 http://orgmode.org/manual/Feedback.html#Feedback
19244 Your bug report will be posted to the Org-mode mailing list.
19245 ------------------------------------------------------------------------")
19246 (save-excursion
19251 (defun org-install-agenda-files-menu ()
19252 (let ((bl (buffer-list)))
19253 (save-excursion
19254 (while bl
19255 (set-buffer (pop bl))
19256 (if (eq major-mode 'org-mode) (setq bl nil)))
19257 (when (eq major-mode 'org-mode)
19258 (easy-menu-change
19259 '("Org") "File List for Agenda"
19260 (append
19261 (list
19262 ["Edit File List" (org-edit-agenda-file-list) t]
19263 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19264 ["Remove Current File from List" org-remove-file t]
19265 ["Cycle through agenda files" org-cycle-agenda-files t]
19266 ["Occur in all agenda files" org-occur-in-agenda-files t]
19267 "--")
19268 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19270 ;;;; Documentation
19272 ;;;###autoload
19273 (defun org-require-autoloaded-modules ()
19274 (interactive)
19275 (mapc 'require
19276 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19277 org-docbook org-exp org-html org-icalendar
19278 org-id org-latex
19279 org-publish org-remember org-table
19280 org-timer org-xoxo)))
19282 ;;;###autoload
19283 (defun org-reload (&optional uncompiled)
19284 "Reload all org lisp files.
19285 With prefix arg UNCOMPILED, load the uncompiled versions."
19286 (interactive "P")
19287 (require 'find-func)
19289 (dir-org (file-name-directory (org-find-library-name "org")))
19290 (dir-org-contrib (ignore-errors
19291 (file-name-directory
19292 (org-find-library-name "org-contribdir"))))
19293 (babel-files
19294 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19295 (append (list nil "comint" "eval" "exp" "keys"
19296 "lob" "ref" "table" "tangle")
19297 (delq nil
19298 (mapcar
19299 (lambda (lang)
19300 (when (cdr lang) (symbol-name (car lang))))
19301 org-babel-load-languages)))))
19302 (files
19303 (append (directory-files dir-org t file-re)
19304 babel-files
19305 (and dir-org-contrib
19306 (directory-files dir-org-contrib t file-re))))
19307 (remove-re (concat (if (featurep 'xemacs)
19308 "org-colview" "org-colview-xemacs")
19310 (setq files (mapcar 'file-name-sans-extension files))
19311 (setq files (mapcar
19312 (lambda (x) (if (string-match remove-re x) nil x))
19313 files))
19314 (setq files (delq nil files))
19315 (mapc
19316 (lambda (f)
19317 (when (featurep (intern (file-name-nondirectory f)))
19318 (if (and (not uncompiled)
19319 (file-exists-p (concat f ".elc")))
19320 (load (concat f ".elc") nil nil t)
19321 (load (concat f ".el") nil nil t))))
19322 files))
19323 (org-version))
19325 ;;;###autoload
19326 (defun org-customize ()
19327 "Call the customize function with org as argument."
19328 (interactive)
19329 (org-load-modules-maybe)
19330 (org-require-autoloaded-modules)
19331 (customize-browse 'org))
19333 (defun org-create-customize-menu ()
19334 "Create a full customization menu for Org-mode, insert it into the menu."
19335 (interactive)
19336 (org-load-modules-maybe)
19337 (org-require-autoloaded-modules)
19338 (if (fboundp 'customize-menu-create)
19339 (progn
19340 (easy-menu-change
19341 '("Org") "Customize"
19342 `(["Browse Org group" org-customize t]
19343 "--"
19344 ,(customize-menu-create 'org)
19345 ["Set" Custom-set t]
19346 ["Save" Custom-save t]
19347 ["Reset to Current" Custom-reset-current t]
19348 ["Reset to Saved" Custom-reset-saved t]
19349 ["Reset to Standard Settings" Custom-reset-standard t]))
19351 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19353 ;;;; Miscellaneous stuff
19355 ;;; Generally useful functions
19357 (defun org-get-at-bol (property)
19358 "Get text property PROPERTY at beginning of line."
19359 (get-text-property (point-at-bol) property))
19361 (defun org-find-text-property-in-string (prop s)
19362 "Return the first non-nil value of property PROP in string S."
19363 (or (get-text-property 0 prop s)
19364 (get-text-property (or (next-single-property-change 0 prop s) 0)
19365 prop s)))
19367 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19368 "Display the given MESSAGE as a warning."
19369 (if (fboundp 'display-warning)
19370 (display-warning 'org message
19371 (if (featurep 'xemacs) 'warning :warning))
19372 (let ((buf (get-buffer-create "*Org warnings*")))
19373 (with-current-buffer buf
19374 (goto-char (point-max))
19375 (insert "Warning (Org): " message)
19376 (unless (bolp)
19377 (newline)))
19378 (display-buffer buf)
19379 (sit-for 0))))
19381 (defun org-eval (form)
19382 "Eval FORM and return result."
19383 (condition-case error
19384 (eval form)
19385 (error (format "%%![Error: %s]" error))))
19387 (defun org-in-clocktable-p ()
19388 "Check if the cursor is in a clocktable."
19389 (let ((pos (point)) start)
19390 (save-excursion
19391 (end-of-line 1)
19393 (setq start (match-beginning 0))
19395 (>= (match-end 0) pos)
19396 start))))
19398 (defun org-in-commented-line ()
19399 "Is point in a line starting with `#'?"
19400 (equal (char-after (point-at-bol)) ?#))
19402 (defun org-in-indented-comment-line ()
19403 "Is point in a line starting with `#' after some white space?"
19404 (save-excursion
19405 (save-match-data
19406 (goto-char (point-at-bol))
19409 (defun org-in-verbatim-emphasis ()
19410 (save-match-data
19411 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19413 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19414 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19415 (if (and marker (marker-buffer marker)
19416 (buffer-live-p (marker-buffer marker)))
19417 (progn
19418 (org-pop-to-buffer-same-window (marker-buffer marker))
19419 (if (or (> marker (point-max)) (< marker (point-min)))
19420 (widen))
19421 (goto-char marker)
19422 (org-show-context 'org-goto))
19423 (if bookmark
19424 (bookmark-jump bookmark)
19425 (error "Cannot find location"))))
19427 (defun org-quote-csv-field (s)
19428 "Quote field for inclusion in CSV material."
19431 s))
19433 (defun org-force-self-insert (N)
19434 "Needed to enforce self-insert under remapping."
19435 (interactive "p")
19436 (self-insert-command N))
19438 (defun org-string-width (s)
19439 "Compute width of string, ignoring invisible characters.
19440 This ignores character with invisibility property `org-link', and also
19441 characters with property `org-cwidth', because these will become invisible
19442 upon the next fontification round."
19443 (let (b l)
19444 (when (or (eq t buffer-invisibility-spec)
19445 (assq 'org-link buffer-invisibility-spec))
19446 (while (setq b (text-property-any 0 (length s)
19447 'invisible 'org-link s))
19448 (setq s (concat (substring s 0 b)
19449 (substring s (or (next-single-property-change
19450 b 'invisible s) (length s)))))))
19451 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19452 (setq s (concat (substring s 0 b)
19453 (substring s (or (next-single-property-change
19454 b 'org-cwidth s) (length s))))))
19455 (setq l (string-width s) b -1)
19456 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19457 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19458 l))
19460 (defun org-shorten-string (s maxlength)
19461 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19462 If the string is shorter or has length MAXLENGTH, just return the
19463 original string. If it is longer, the functions finds a space in the
19464 string, breaks this string off at that locations and adds three dots
19465 as ellipsis. Including the ellipsis, the string will not be longer
19466 than MAXLENGTH. If finding a good breaking point in the string does
19467 not work, the string is just chopped off in the middle of a word
19468 if necessary."
19469 (if (<= (length s) maxlength)
19470 s
19471 (let* ((n (max (- maxlength 4) 1))
19473 (if (string-match re s)
19474 (concat (match-string 1 s) "...")
19475 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19477 (defun org-get-indentation (&optional line)
19478 "Get the indentation of the current line, interpreting tabs.
19479 When LINE is given, assume it represents a line and compute its indentation."
19480 (if line
19481 (if (string-match "^ *" (org-remove-tabs line))
19482 (match-end 0))
19483 (save-excursion
19484 (beginning-of-line 1)
19486 (current-column))))
19488 (defun org-get-string-indentation (s)
19489 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19490 (let ((n -1) (i 0) (w tab-width) c)
19491 (catch 'exit
19492 (while (< (setq n (1+ n)) (length s))
19493 (setq c (aref s n))
19494 (cond ((= c ?\ ) (setq i (1+ i)))
19496 (t (throw 'exit t)))))
19497 i))
19499 (defun org-remove-tabs (s &optional width)
19500 "Replace tabulators in S with spaces.
19501 Assumes that s is a single line, starting in column 0."
19502 (setq width (or width tab-width))
19504 (setq s (replace-match
19505 (make-string
19506 (- (* width (/ (+ (match-beginning 0) width) width))
19507 (match-beginning 0)) ?\ )
19508 t t s)))
19509 s)
19511 (defun org-fix-indentation (line ind)
19512 "Fix indentation in LINE.
19513 IND is a cons cell with target and minimum indentation.
19514 If the current indentation in LINE is smaller than the minimum,
19515 leave it alone. If it is larger than ind, set it to the target."
19516 (let* ((l (org-remove-tabs line))
19517 (i (org-get-indentation l))
19518 (i1 (car ind)) (i2 (cdr ind)))
19519 (if (>= i i2) (setq l (substring line i2)))
19520 (if (> i1 0)
19521 (concat (make-string i1 ?\ ) l)
19522 l)))
19524 (defun org-remove-indentation (code &optional n)
19525 "Remove the maximum common indentation from the lines in CODE.
19526 N may optionally be the number of spaces to remove."
19527 (with-temp-buffer
19528 (insert code)
19529 (org-do-remove-indentation n)
19530 (buffer-string)))
19532 (defun org-do-remove-indentation (&optional n)
19533 "Remove the maximum common indentation from the buffer."
19534 (untabify (point-min) (point-max))
19535 (let ((min 10000) re)
19536 (if n
19537 (setq min n)
19538 (goto-char (point-min))
19540 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19541 (unless (or (= min 0) (= min 10000))
19543 (goto-char (point-min))
19544 (while (re-search-forward re nil t)
19545 (replace-match "")
19546 (end-of-line 1))
19547 min)))
19549 (defun org-fill-template (template alist)
19550 "Find each %key of ALIST in TEMPLATE and replace it."
19551 (let ((case-fold-search nil)
19552 entry key value)
19553 (setq alist (sort (copy-sequence alist)
19554 (lambda (a b) (< (length (car a)) (length (car b))))))
19555 (while (setq entry (pop alist))
19556 (setq template
19557 (replace-regexp-in-string
19558 (concat "%" (regexp-quote (car entry)))
19559 (cdr entry) template t t)))
19560 template))
19562 (defun org-base-buffer (buffer)
19563 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19564 (if (not buffer)
19565 buffer
19566 (or (buffer-base-buffer buffer)
19567 buffer)))
19569 (defun org-trim (s)
19570 "Remove whitespace at beginning and end of string."
19573 s)
19575 (defun org-wrap (string &optional width lines)
19576 "Wrap string to either a number of lines, or a width in characters.
19577 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19578 that costs. If there is a word longer than WIDTH, the text is actually
19579 wrapped to the length of that word.
19580 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19581 many lines, whatever width that takes.
19582 The return value is a list of lines, without newlines at the end."
19584 (maxword (apply 'max (mapcar 'org-string-width words)))
19585 w ll)
19586 (cond (width
19587 (org-do-wrap words (max maxword width)))
19588 (lines
19589 (setq w maxword)
19590 (setq ll (org-do-wrap words maxword))
19591 (if (<= (length ll) lines)
19592 ll
19593 (setq ll words)
19594 (while (> (length ll) lines)
19595 (setq w (1+ w))
19596 (setq ll (org-do-wrap words w)))
19597 ll))
19598 (t (error "Cannot wrap this")))))
19600 (defun org-do-wrap (words width)
19601 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19602 (let (lines line)
19603 (while words
19604 (setq line (pop words))
19605 (while (and words (< (+ (length line) (length (car words))) width))
19606 (setq line (concat line " " (pop words))))
19607 (setq lines (push line lines)))
19608 (nreverse lines)))
19610 (defun org-split-string (string &optional separators)
19611 "Splits STRING into substrings at SEPARATORS.
19612 No empty strings are returned if there are matches at the beginning
19613 and end of string."
19615 (start 0)
19616 notfirst
19617 (list nil))
19618 (while (and (string-match rexp string
19619 (if (and notfirst
19620 (= start (match-beginning 0))
19621 (< start (length string)))
19622 (1+ start) start))
19623 (< (match-beginning 0) (length string)))
19624 (setq notfirst t)
19625 (or (eq (match-beginning 0) 0)
19626 (and (eq (match-beginning 0) (match-end 0))
19627 (eq (match-beginning 0) start))
19628 (setq list
19629 (cons (substring string start (match-beginning 0))
19630 list)))
19631 (setq start (match-end 0)))
19632 (or (eq start (length string))
19633 (setq list
19634 (cons (substring string start)
19635 list)))
19636 (nreverse list)))
19638 (defun org-quote-vert (s)
19640 (while (string-match "|" s)
19642 s)
19644 (defun org-uuidgen-p (s)
19645 "Is S an ID created by UUIDGEN?"
19646 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19648 (defun org-in-src-block-p nil
19649 "Whether point is in a code source block."
19650 (let (ov)
19651 (when (setq ov (overlays-at (point)))
19652 (memq 'org-block-background
19653 (overlay-properties
19654 (car ov))))))
19656 (defun org-context ()
19657 "Return a list of contexts of the current cursor position.
19658 If several contexts apply, all are returned.
19659 Each context entry is a list with a symbol naming the context, and
19660 two positions indicating start and end of the context. Possible
19661 contexts are:
19663 :headline anywhere in a headline
19664 :headline-stars on the leading stars in a headline
19665 :todo-keyword on a TODO keyword (including DONE) in a headline
19666 :tags on the TAGS in a headline
19667 :priority on the priority cookie in a headline
19668 :item on the first line of a plain list item
19669 :item-bullet on the bullet/number of a plain list item
19670 :checkbox on the checkbox in a plain list item
19671 :table in an org-mode table
19672 :table-special on a special filed in a table
19673 :table-table in a table.el table
19674 :clocktable in a clocktable
19675 :src-block in a source block
19676 :link on a hyperlink
19677 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
19678 :target on a <<target>>
19679 :radio-target on a <<<radio-target>>>
19680 :latex-fragment on a LaTeX fragment
19681 :latex-preview on a LaTeX fragment with overlaid preview image
19683 This function expects the position to be visible because it uses font-lock
19684 faces as a help to recognize the following contexts: :table-special, :link,
19685 and :keyword."
19686 (let* ((f (get-text-property (point) 'face))
19687 (faces (if (listp f) f (list f)))
19688 (case-fold-search t)
19689 (p (point)) clist o)
19690 ;; First the large context
19691 (cond
19692 ((org-at-heading-p t)
19693 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19694 (when (progn
19695 (beginning-of-line 1)
19696 (looking-at org-todo-line-tags-regexp))
19697 (push (org-point-in-group p 1 :headline-stars) clist)
19698 (push (org-point-in-group p 2 :todo-keyword) clist)
19699 (push (org-point-in-group p 4 :tags) clist))
19700 (goto-char p)
19703 (push (org-point-in-group p 0 :priority) clist)))
19705 ((org-at-item-p)
19706 (push (org-point-in-group p 2 :item-bullet) clist)
19707 (push (list :item (point-at-bol)
19708 (save-excursion (org-end-of-item) (point)))
19709 clist)
19710 (and (org-at-item-checkbox-p)
19711 (push (org-point-in-group p 0 :checkbox) clist)))
19713 ((org-at-table-p)
19714 (push (list :table (org-table-begin) (org-table-end)) clist)
19715 (if (memq 'org-formula faces)
19716 (push (list :table-special
19717 (previous-single-property-change p 'face)
19718 (next-single-property-change p 'face)) clist)))
19719 ((org-at-table-p 'any)
19720 (push (list :table-table) clist)))
19721 (goto-char p)
19723 ;; New the "medium" contexts: clocktables, source blocks
19724 (cond ((org-in-clocktable-p)
19725 (push (list :clocktable
19727 (search-backward "#+BEGIN: clocktable" nil t))
19728 (match-beginning 0))
19730 (match-end 0))) clist))
19731 ((org-in-src-block-p)
19732 (push (list :src-block
19734 (search-backward "#+BEGIN_SRC" nil t))
19735 (match-beginning 0))
19736 (and (search-forward "#+END_SRC" nil t)
19737 (match-beginning 0))) clist)))
19738 (goto-char p)
19740 ;; Now the small context
19741 (cond
19742 ((org-at-timestamp-p)
19743 (push (org-point-in-group p 0 :timestamp) clist))
19744 ((memq 'org-link faces)
19745 (push (list :link
19746 (previous-single-property-change p 'face)
19747 (next-single-property-change p 'face)) clist))
19748 ((memq 'org-special-keyword faces)
19749 (push (list :keyword
19750 (previous-single-property-change p 'face)
19751 (next-single-property-change p 'face)) clist))
19752 ((org-at-target-p)
19753 (push (org-point-in-group p 0 :target) clist)
19754 (goto-char (1- (match-beginning 0)))
19755 (if (looking-at org-radio-target-regexp)
19756 (push (org-point-in-group p 0 :radio-target) clist))
19757 (goto-char p))
19758 ((setq o (car (delq nil
19759 (mapcar
19760 (lambda (x)
19761 (if (memq x org-latex-fragment-image-overlays) x))
19762 (overlays-at (point))))))
19763 (push (list :latex-fragment
19764 (overlay-start o) (overlay-end o)) clist)
19765 (push (list :latex-preview
19766 (overlay-start o) (overlay-end o)) clist))
19767 ((org-inside-LaTeX-fragment-p)
19768 ;; FIXME: positions wrong.
19769 (push (list :latex-fragment (point) (point)) clist)))
19771 (setq clist (nreverse (delq nil clist)))
19772 clist))
19774 ;; FIXME: Compare with at-regexp-p Do we need both?
19775 (defun org-in-regexp (re &optional nlines visually)
19776 "Check if point is inside a match of regexp.
19777 Normally only the current line is checked, but you can include NLINES extra
19778 lines both before and after point into the search.
19779 If VISUALLY is set, require that the cursor is not after the match but
19780 really on, so that the block visually is on the match."
19781 (catch 'exit
19782 (let ((pos (point))
19783 (eol (point-at-eol (+ 1 (or nlines 0))))
19784 (inc (if visually 1 0)))
19785 (save-excursion
19786 (beginning-of-line (- 1 (or nlines 0)))
19787 (while (re-search-forward re eol t)
19788 (if (and (<= (match-beginning 0) pos)
19789 (>= (+ inc (match-end 0)) pos))
19790 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19792 (defun org-at-regexp-p (regexp)
19793 "Is point inside a match of REGEXP in the current line?"
19794 (catch 'exit
19795 (save-excursion
19796 (let ((pos (point)) (end (point-at-eol)))
19797 (beginning-of-line 1)
19798 (while (re-search-forward regexp end t)
19799 (if (and (<= (match-beginning 0) pos)
19800 (>= (match-end 0) pos))
19801 (throw 'exit t)))
19802 nil))))
19804 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19805 "Non-nil when point is between matches of START-RE and END-RE.
19807 Also return a non-nil value when point is on one of the matches.
19809 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19810 buffer positions. Default values are the positions of headlines
19811 surrounding the point.
19813 The functions returns a cons cell whose car (resp. cdr) is the
19814 position before START-RE (resp. after END-RE)."
19815 (save-match-data
19816 (let ((pos (point))
19817 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19818 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19819 beg end)
19820 (save-excursion
19821 ;; Point is on a block when on START-RE or if START-RE can be
19822 ;; found before it...
19823 (and (or (org-at-regexp-p start-re)
19824 (re-search-backward start-re limit-up t))
19825 (setq beg (match-beginning 0))
19826 ;; ... and END-RE after it...
19827 (goto-char (match-end 0))
19828 (re-search-forward end-re limit-down t)
19829 (> (setq end (match-end 0)) pos)
19830 ;; ... without another START-RE in-between.
19831 (goto-char (match-beginning 0))
19832 (not (re-search-backward start-re (1+ beg) t))
19833 ;; Return value.
19834 (cons beg end))))))
19836 (defun org-in-block-p (names)
19837 "Non-nil when point belongs to a block whose name belongs to NAMES.
19839 NAMES is a list of strings containing names of blocks.
19841 Return first block name matched, or nil. Beware that in case of
19842 nested blocks, the returned name may not belong to the closest
19843 block from point."
19844 (save-match-data
19845 (catch 'exit
19846 (let ((case-fold-search t)
19847 (lim-up (save-excursion (outline-previous-heading)))
19848 (lim-down (save-excursion (outline-next-heading))))
19849 (mapc (lambda (name)
19850 (let ((n (regexp-quote name)))
19851 (when (org-between-regexps-p
19854 lim-up lim-down)
19855 (throw 'exit n))))
19856 names))
19857 nil)))
19859 (defun org-occur-in-agenda-files (regexp &optional nlines)
19860 "Call `multi-occur' with buffers for all agenda files."
19862 (let* ((files (org-agenda-files))
19863 (tnames (mapcar 'file-truename files))
19864 (extra org-agenda-text-search-extra-files)
19865 f)
19866 (when (eq (car extra) 'agenda-archives)
19867 (setq extra (cdr extra))
19868 (setq files (org-add-archive-files files)))
19869 (while (setq f (pop extra))
19870 (unless (member (file-truename f) tnames)
19871 (add-to-list 'files f 'append)
19872 (add-to-list 'tnames (file-truename f) 'append)))
19873 (multi-occur
19874 (mapcar (lambda (x)
19875 (with-current-buffer
19876 (or (get-file-buffer x) (find-file-noselect x))
19877 (widen)
19878 (current-buffer)))
19879 files)
19880 regexp)))
19882 (if (boundp 'occur-mode-find-occurrence-hook)
19883 ;; Emacs 23
19884 (add-hook 'occur-mode-find-occurrence-hook
19885 (lambda ()
19886 (when (eq major-mode 'org-mode)
19887 (org-reveal))))
19888 ;; Emacs 22
19889 (defadvice occur-mode-goto-occurrence
19890 (after org-occur-reveal activate)
19891 (and (eq major-mode 'org-mode) (org-reveal)))
19892 (defadvice occur-mode-goto-occurrence-other-window
19893 (after org-occur-reveal activate)
19894 (and (eq major-mode 'org-mode) (org-reveal)))
19895 (defadvice occur-mode-display-occurrence
19896 (after org-occur-reveal activate)
19897 (when (eq major-mode 'org-mode)
19898 (let ((pos (occur-mode-find-occurrence)))
19899 (with-current-buffer (marker-buffer pos)
19900 (save-excursion
19901 (goto-char pos)
19902 (org-reveal)))))))
19904 (defun org-occur-link-in-agenda-files ()
19905 "Create a link and search for it in the agendas.
19906 The link is not stored in `org-stored-links', it is just created
19907 for the search purpose."
19908 (interactive)
19909 (let ((link (condition-case nil
19910 (org-store-link nil)
19911 (error "Unable to create a link to here"))))
19912 (org-occur-in-agenda-files (regexp-quote link))))
19914 (defun org-uniquify (list)
19915 "Remove duplicate elements from LIST."
19916 (let (res)
19917 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19918 res))
19920 (defun org-delete-all (elts list)
19921 "Remove all elements in ELTS from LIST."
19922 (while elts
19923 (setq list (delete (pop elts) list)))
19924 list)
19926 (defun org-count (cl-item cl-seq)
19927 "Count the number of occurrences of ITEM in SEQ.
19928 Taken from `count' in cl-seq.el with all keyword arguments removed."
19929 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19930 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19931 (while (< cl-start cl-end)
19932 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19933 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19934 (setq cl-start (1+ cl-start)))
19935 cl-count))
19937 (defun org-remove-if (predicate seq)
19938 "Remove everything from SEQ that fulfills PREDICATE."
19939 (let (res e)
19940 (while seq
19941 (setq e (pop seq))
19942 (if (not (funcall predicate e)) (push e res)))
19943 (nreverse res)))
19945 (defun org-remove-if-not (predicate seq)
19946 "Remove everything from SEQ that does not fulfill PREDICATE."
19947 (let (res e)
19948 (while seq
19949 (setq e (pop seq))
19950 (if (funcall predicate e) (push e res)))
19951 (nreverse res)))
19953 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19954 "Reduce two-argument FUNCTION across SEQ.
19955 Taken from `reduce' in cl-seq.el with all keyword arguments but
19957 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19958 (cadr (memq :initial-value cl-keys)))
19959 (cl-seq (pop cl-seq))
19960 (t (funcall cl-func)))))
19961 (while cl-seq
19962 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19963 cl-accum))
19965 (defun org-back-over-empty-lines ()
19966 "Move backwards over whitespace, to the beginning of the first empty line.
19967 Returns the number of empty lines passed."
19968 (let ((pos (point)))
19969 (if (cdr (assoc 'heading org-blank-before-new-entry))
19971 (unless (eobp)
19972 (forward-line -1)))
19973 (beginning-of-line 2)
19974 (goto-char (min (point) pos))
19975 (count-lines (point) pos)))
19977 (defun org-skip-whitespace ()
19980 (defun org-point-in-group (point group &optional context)
19981 "Check if POINT is in match-group GROUP.
19982 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19983 match. If the match group does not exist or point is not inside it,
19984 return nil."
19985 (and (match-beginning group)
19986 (>= point (match-beginning group))
19987 (<= point (match-end group))
19988 (if context
19989 (list context (match-beginning group) (match-end group))
19990 t)))
19992 (defun org-switch-to-buffer-other-window (&rest args)
19993 "Switch to buffer in a second window on the current frame.
19994 In particular, do not allow pop-up frames.
19995 Returns the newly created buffer."
19996 (let (pop-up-frames special-display-buffer-names special-display-regexps
19997 special-display-function)
19998 (apply 'switch-to-buffer-other-window args)))
20000 (defun org-combine-plists (&rest plists)
20001 "Create a single property list from all plists in PLISTS.
20002 The process starts by copying the first list, and then setting properties
20003 from the other lists. Settings in the last list are the most significant
20004 ones and overrule settings in the other lists."
20005 (let ((rtn (copy-sequence (pop plists)))
20006 p v ls)
20007 (while plists
20008 (setq ls (pop plists))
20009 (while ls
20010 (setq p (pop ls) v (pop ls))
20011 (setq rtn (plist-put rtn p v))))
20012 rtn))
20014 (defun org-move-line-down (arg)
20015 "Move the current line down. With prefix argument, move it past ARG lines."
20016 (interactive "p")
20017 (let ((col (current-column))
20018 beg end pos)
20019 (beginning-of-line 1) (setq beg (point))
20020 (beginning-of-line 2) (setq end (point))
20021 (beginning-of-line (+ 1 arg))
20022 (setq pos (move-marker (make-marker) (point)))
20023 (insert (delete-and-extract-region beg end))
20024 (goto-char pos)
20025 (org-move-to-column col)))
20027 (defun org-move-line-up (arg)
20028 "Move the current line up. With prefix argument, move it past ARG lines."
20029 (interactive "p")
20030 (let ((col (current-column))
20031 beg end pos)
20032 (beginning-of-line 1) (setq beg (point))
20033 (beginning-of-line 2) (setq end (point))
20034 (beginning-of-line (- arg))
20035 (setq pos (move-marker (make-marker) (point)))
20036 (insert (delete-and-extract-region beg end))
20037 (goto-char pos)
20038 (org-move-to-column col)))
20040 (defun org-replace-escapes (string table)
20041 "Replace %-escapes in STRING with values in TABLE.
20043 The sequences in STRING may contain normal field width and padding information,
20045 so values can contain further %-escapes if they are define later in TABLE."
20046 (let ((tbl (copy-alist table))
20047 (case-fold-search nil)
20048 (pchg 0)
20049 e re rpl)
20050 (while (setq e (pop tbl))
20051 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20052 (when (and (cdr e) (string-match re (cdr e)))
20053 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20054 (safe "SREF"))
20055 (add-text-properties 0 3 (list 'sref sref) safe)
20056 (setcdr e (replace-match safe t t (cdr e)))))
20057 (while (string-match re string)
20058 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20059 (cdr e)))
20060 (setq string (replace-match rpl t t string))))
20061 (while (setq pchg (next-property-change pchg string))
20062 (let ((sref (get-text-property pchg 'sref string)))
20063 (when (and sref (string-match "SREF" string pchg))
20064 (setq string (replace-match sref t t string)))))
20065 string))
20067 (defun org-sublist (list start end)
20068 "Return a section of LIST, from START to END.
20069 Counting starts at 1."
20070 (let (rtn (c start))
20071 (setq list (nthcdr (1- start) list))
20072 (while (and list (<= c end))
20073 (push (pop list) rtn)
20074 (setq c (1+ c)))
20075 (nreverse rtn)))
20077 (defun org-find-base-buffer-visiting (file)
20078 "Like `find-buffer-visiting' but always return the base buffer and
20079 not an indirect buffer."
20080 (let ((buf (or (get-file-buffer file)
20081 (find-buffer-visiting file))))
20082 (if buf
20083 (or (buffer-base-buffer buf) buf)
20084 nil)))
20086 (defun org-image-file-name-regexp (&optional extensions)
20087 "Return regexp matching the file names of images.
20088 If EXTENSIONS is given, only match these."
20089 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20090 (image-file-name-regexp)
20091 (let ((image-file-name-extensions
20092 (or extensions
20093 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20094 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20096 (regexp-opt (nconc (mapcar 'upcase
20097 image-file-name-extensions)
20098 image-file-name-extensions)
20099 t)
20102 (defun org-file-image-p (file &optional extensions)
20103 "Return non-nil if FILE is an image."
20104 (save-match-data
20105 (string-match (org-image-file-name-regexp extensions) file)))
20107 (defun org-get-cursor-date ()
20108 "Return the date at cursor in as a time.
20109 This works in the calendar and in the agenda, anywhere else it just
20110 returns the current time."
20111 (let (date day defd)
20112 (cond
20113 ((eq major-mode 'calendar-mode)
20114 (setq date (calendar-cursor-to-date)
20115 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20116 ((eq major-mode 'org-agenda-mode)
20117 (setq day (get-text-property (point) 'day))
20118 (if day
20119 (setq date (calendar-gregorian-from-absolute day)
20120 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20121 (nth 2 date))))))
20122 (or defd (current-time))))
20124 (defvar org-agenda-action-marker (make-marker)
20125 "Marker pointing to the entry for the next agenda action.")
20127 (defun org-mark-entry-for-agenda-action ()
20128 "Mark the current entry as target of an agenda action.
20129 Agenda actions are actions executed from the agenda with the key `k',
20130 which make use of the date at the cursor."
20131 (interactive)
20132 (move-marker org-agenda-action-marker
20133 (save-excursion (org-back-to-heading t) (point))
20134 (current-buffer))
20135 (message
20136 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20138 (defun org-mark-subtree ()
20139 "Mark the current subtree.
20140 This puts point at the start of the current subtree, and mark at the end.
20142 If point is in an inline task, mark that task instead."
20143 (interactive)
20144 (let ((inline-task-p
20145 (and (featurep 'org-inlinetask)
20146 (org-inlinetask-in-task-p)))
20147 (beg))
20148 ;; Get beginning of subtree
20149 (cond
20150 (inline-task-p (org-inlinetask-goto-beginning))
20151 ((org-at-heading-p) (beginning-of-line))
20152 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20153 (setq beg (point))
20154 ;; Get end of it
20155 (if inline-task-p
20156 (org-inlinetask-goto-end)
20157 (org-end-of-subtree))
20158 ;; Mark zone
20159 (push-mark (point) nil t)
20160 (goto-char beg)))
20162 ;;; Paragraph filling stuff.
20163 ;; We want this to be just right, so use the full arsenal.
20165 (defun org-indent-line-function ()
20166 "Indent line depending on context."
20167 (interactive)
20168 (let* ((pos (point))
20169 (itemp (org-at-item-p))
20170 (case-fold-search t)
20172 (inline-task-p (and (featurep 'org-inlinetask)
20173 (org-inlinetask-in-task-p)))
20174 (inline-re (and inline-task-p
20175 (org-inlinetask-outline-regexp)))
20176 column)
20177 (beginning-of-line 1)
20178 (cond
20179 ;; Comments
20180 ((looking-at "# ") (setq column 0))
20181 ;; Headings
20182 ((looking-at org-outline-regexp) (setq column 0))
20183 ;; Included files
20185 ;; Footnote definition
20186 ((looking-at org-footnote-definition-re) (setq column 0))
20187 ;; Literal examples
20189 (setq column (org-get-indentation))) ; do nothing
20190 ;; Lists
20191 ((ignore-errors (goto-char (org-in-item-p)))
20192 (setq column (if itemp
20193 (org-get-indentation)
20194 (org-list-item-body-column (point))))
20195 (goto-char pos))
20196 ;; Drawers
20198 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20199 (save-excursion
20200 (goto-char (1- (match-beginning 1)))
20201 (setq column (current-column))))
20202 ;; Special blocks
20204 (save-excursion
20205 (re-search-backward
20207 (setq column (org-get-indentation (match-string 0))))
20210 (save-excursion
20212 (setq column
20213 (cond ((equal (downcase (match-string 1)) "src")
20214 ;; src blocks: let `org-edit-src-exit' handle them
20215 (org-get-indentation))
20216 ((equal (downcase (match-string 1)) "example")
20217 (max (org-get-indentation)
20218 (org-get-indentation (match-string 0))))
20219 (t
20220 (org-get-indentation (match-string 0))))))
20221 ;; This line has nothing special, look at the previous relevant
20222 ;; line to compute indentation
20223 (t
20224 (beginning-of-line 0)
20225 (while (and (not (bobp))
20226 (not (looking-at org-drawer-regexp))
20227 ;; When point started in an inline task, do not move
20228 ;; above task starting line.
20229 (not (and inline-task-p (looking-at inline-re)))
20230 ;; Skip drawers, blocks, empty lines, verbatim,
20231 ;; comments, tables, footnotes definitions, lists,
20232 ;; inline tasks.
20234 (re-search-backward org-drawer-regexp nil t))
20238 (looking-at org-footnote-definition-re)
20239 (and (ignore-errors (goto-char (org-in-item-p)))
20240 (goto-char
20241 (org-list-get-top-point (org-list-struct))))
20242 (and (not inline-task-p)
20243 (featurep 'org-inlinetask)
20244 (org-inlinetask-in-task-p)
20245 (or (org-inlinetask-goto-beginning) t))))
20246 (beginning-of-line 0))
20247 (cond
20248 ;; There was an heading above.
20250 (if (not org-adapt-indentation)
20251 (setq column 0)
20252 (goto-char (match-end 0))
20253 (setq column (current-column))))
20254 ;; A drawer had started and is unfinished
20255 ((looking-at org-drawer-regexp)
20256 (goto-char (1- (match-beginning 1)))
20257 (setq column (current-column)))
20258 ;; Else, nothing noticeable found: get indentation and go on.
20259 (t (setq column (org-get-indentation))))))
20260 ;; Now apply indentation and move cursor accordingly
20261 (goto-char pos)
20262 (if (<= (current-column) (current-indentation))
20263 (org-indent-line-to column)
20264 (save-excursion (org-indent-line-to column)))
20265 ;; Special polishing for properties, see `org-property-format'
20266 (setq column (current-column))
20267 (beginning-of-line 1)
20268 (if (looking-at
20270 (replace-match (concat (match-string 1)
20271 (format org-property-format
20272 (match-string 2) (match-string 3)))
20273 t t))
20274 (org-move-to-column column)))
20276 (defun org-indent-drawer ()
20277 "Indent the drawer at point."
20278 (interactive)
20279 (let ((p (point))
20280 (e (and (save-excursion (re-search-forward ":END:" nil t))
20281 (match-end 0)))
20282 (folded
20283 (save-excursion
20284 (end-of-line)
20285 (when (overlays-at (point))
20286 (member 'invisible (overlay-properties
20287 (car (overlays-at (point)))))))))
20288 (when folded (org-cycle))
20289 (indent-for-tab-command)
20290 (while (and (move-beginning-of-line 2) (< (point) e))
20291 (indent-for-tab-command))
20292 (goto-char p)
20293 (when folded (org-cycle)))
20294 (message "Drawer at point indented"))
20296 (defun org-indent-block ()
20297 "Indent the block at point."
20298 (interactive)
20299 (let ((p (point))
20300 (case-fold-search t)
20302 (match-end 0)))
20303 (folded
20304 (save-excursion
20305 (end-of-line)
20306 (when (overlays-at (point))
20307 (member 'invisible (overlay-properties
20308 (car (overlays-at (point)))))))))
20309 (when folded (org-cycle))
20310 (indent-for-tab-command)
20311 (while (and (move-beginning-of-line 2) (< (point) e))
20312 (indent-for-tab-command))
20313 (goto-char p)
20314 (when folded (org-cycle)))
20315 (message "Block at point indented"))
20317 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20318 "Variable to store copy of `adaptive-fill-regexp'.
20319 Since `adaptive-fill-regexp' is set to never match, we need to
20320 store a backup of its value before entering `org-mode' so that
20321 the functionality can be provided as a fall-back.")
20323 (defun org-set-autofill-regexps ()
20324 (interactive)
20325 ;; In the paragraph separator we include headlines, because filling
20326 ;; text in a line directly attached to a headline would otherwise
20327 ;; fill the headline as well.
20330 ;; The paragraph starter includes hand-formatted lists.
20331 (org-set-local
20332 'paragraph-start
20333 (concat
20342 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20343 ;; But only if the user has not turned off tables or fixed-width regions
20344 (org-set-local
20345 'auto-fill-inhibit-regexp
20346 (concat org-outline-regexp
20349 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20350 (concat
20352 (if org-enable-table-editor "|" "")
20353 (if org-enable-fixed-width-editor ":" "")
20354 "]"))))
20355 ;; We use our own fill-paragraph function, to make sure that tables
20356 ;; and fixed-width regions are not wrapped. That function will pass
20357 ;; through to `fill-paragraph' when appropriate.
20358 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20359 ;; Prevent auto-fill from inserting unwanted new items.
20360 (if (boundp 'fill-nobreak-predicate)
20361 (org-set-local
20362 'fill-nobreak-predicate
20363 (org-uniquify
20364 (append fill-nobreak-predicate
20365 '(org-fill-item-nobreak-p org-fill-line-break-nobreak-p)))))
20366 ;; Adaptive filling: To get full control, first make sure that
20367 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20368 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20369 (org-set-local 'org-adaptive-fill-regexp-backup
20370 adaptive-fill-regexp))
20372 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20373 (org-set-local 'adaptive-fill-function
20374 'org-adaptive-fill-function)
20375 (org-set-local
20376 'align-mode-rules-list
20377 '((org-in-buffer-settings
20379 (modes . '(org-mode))))))
20381 (defun org-fill-item-nobreak-p ()
20382 "Non-nil when a line break at point would insert a new item."
20383 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20385 (defun org-fill-line-break-nobreak-p ()
20386 "Non-nil when a line break at point would create an Org line break."
20387 (save-excursion
20392 (defun org-fill-paragraph (&optional justify)
20393 "Re-align a table, pass through to fill-paragraph if no table."
20394 (let ((table-p (org-at-table-p))
20395 (table.el-p (org-at-table.el-p))
20396 (itemp (org-in-item-p)))
20397 (cond ((and (equal (char-after (point-at-bol)) ?*)
20398 (save-excursion (goto-char (point-at-bol))
20399 (looking-at org-outline-regexp)))
20400 t) ; skip headlines
20401 (table.el-p t) ; skip table.el tables
20402 (table-p (org-table-align) t) ; align Org tables
20403 (itemp ; align text in items
20404 (let* ((struct (save-excursion (goto-char itemp)
20405 (org-list-struct)))
20406 (parents (org-list-parents-alist struct))
20407 (children (org-list-get-children itemp struct parents))
20408 beg end prev next prefix)
20409 ;; Determine in which part of item point is: before
20410 ;; first child, after last child, between two
20411 ;; sub-lists, or simply in item if there's no child.
20412 (cond
20413 ((not children)
20414 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20415 beg itemp
20416 end (org-list-get-item-end itemp struct)))
20417 ((< (point) (setq next (car children)))
20418 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20419 beg itemp
20420 end next))
20421 ((> (point) (setq prev (car (last children))))
20422 (setq beg (org-list-get-item-end prev struct)
20423 end (org-list-get-item-end itemp struct)
20424 prefix (save-excursion
20425 (goto-char beg)
20427 (make-string (current-column) ?\ ))))
20428 (t (catch 'exit
20429 (while (setq next (pop children))
20430 (if (> (point) next)
20431 (setq prev next)
20432 (setq beg (org-list-get-item-end prev struct)
20433 end next
20434 prefix (save-excursion
20435 (goto-char beg)
20437 (make-string (current-column) ?\ )))
20438 (throw 'exit nil))))))
20439 ;; Use `fill-paragraph' with buffer narrowed to item
20440 ;; without any child, and with our computed PREFIX.
20441 (flet ((fill-context-prefix (from to &optional flr) prefix))
20442 (save-restriction
20443 (narrow-to-region beg end)
20444 (save-excursion (fill-paragraph justify)))) t))
20445 ;; Special case where point is not in a list but is on
20446 ;; a paragraph adjacent to a list: make sure this paragraph
20447 ;; doesn't get merged with the end of the list by narrowing
20448 ;; buffer first.
20449 ((save-excursion (forward-paragraph -1)
20450 (setq itemp (org-in-item-p)))
20451 (let ((struct (save-excursion (goto-char itemp)
20452 (org-list-struct))))
20453 (save-restriction
20454 (narrow-to-region (org-list-get-bottom-point struct)
20455 (save-excursion (forward-paragraph 1)
20456 (point)))
20457 (fill-paragraph justify) t)))
20458 ;; Else simply call `fill-paragraph'.
20459 (t nil))))
20461 ;; For reference, this is the default value of adaptive-fill-regexp
20464 (defun org-adaptive-fill-function ()
20465 "Return a fill prefix for org-mode files."
20466 (let (itemp)
20467 (save-excursion
20468 (cond
20469 ;; Comment line
20471 (match-string-no-properties 0))
20472 ;; Plain list item
20473 ((org-at-item-p)
20474 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20475 ;; Point is in a list after `backward-paragraph': original
20476 ;; point wasn't in the list, or filling would have been taken
20477 ;; care of by `org-auto-fill-function', but the list and the
20478 ;; real paragraph are not separated by a blank line. Thus, move
20479 ;; point after the list to go back to real paragraph and
20480 ;; determine fill-prefix.
20481 ((setq itemp (org-in-item-p))
20482 (goto-char itemp)
20483 (let* ((struct (org-list-struct))
20484 (bottom (org-list-get-bottom-point struct)))
20485 (goto-char bottom)
20486 (make-string (org-get-indentation) ?\ )))
20487 ;; Other text
20488 ((looking-at org-adaptive-fill-regexp-backup)
20489 (match-string-no-properties 0))))))
20491 (defun org-auto-fill-function ()
20492 "Auto-fill function."
20493 (let (itemp prefix)
20494 ;; When in a list, compute an appropriate fill-prefix and make
20495 ;; sure it will be used by `do-auto-fill'.
20496 (if (setq itemp (org-in-item-p))
20497 (progn
20498 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20499 (flet ((fill-context-prefix (from to &optional flr) prefix))
20500 (do-auto-fill)))
20501 ;; Else just use `do-auto-fill'.
20502 (do-auto-fill))))
20504 ;;; Other stuff.
20506 (defun org-toggle-fixed-width-section (arg)
20507 "Toggle the fixed-width export.
20508 If there is no active region, the QUOTE keyword at the current headline is
20509 inserted or removed. When present, it causes the text between this headline
20510 and the next to be exported as fixed-width text, and unmodified.
20511 If there is an active region, this command adds or removes a colon as the
20512 first character of this line. If the first character of a line is a colon,
20513 this line is also exported in fixed-width font."
20514 (interactive "P")
20515 (let* ((cc 0)
20516 (regionp (org-region-active-p))
20517 (beg (if regionp (region-beginning) (point)))
20518 (end (if regionp (region-end)))
20519 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20520 (case-fold-search nil)
20522 off)
20523 (if regionp
20524 (save-excursion
20525 (goto-char beg)
20526 (setq cc (current-column))
20527 (beginning-of-line 1)
20528 (setq off (looking-at re))
20529 (while (> nlines 0)
20530 (setq nlines (1- nlines))
20531 (beginning-of-line 1)
20532 (cond
20533 (arg
20534 (org-move-to-column cc t)
20536 (forward-line -1))
20537 ((and off (looking-at re))
20538 (replace-match "" t t nil 1))
20539 ((not off) (org-move-to-column cc t) (insert ": ")))
20540 (forward-line 1)))
20541 (save-excursion
20542 (org-back-to-heading)
20543 (cond
20544 ((looking-at (format org-heading-keyword-regexp-format
20545 org-quote-string))
20546 (goto-char (match-end 1))
20547 (looking-at (concat " +" org-quote-string))
20548 (replace-match "" t t)
20549 (when (eolp) (insert " ")))
20550 ((looking-at org-outline-regexp)
20551 (goto-char (match-end 0))
20552 (insert org-quote-string " ")))))))
20554 (defun org-reftex-citation ()
20555 "Use reftex-citation to insert a citation into the buffer.
20556 This looks for a line like
20558 #+BIBLIOGRAPHY: foo plain option:-d
20560 and derives from it that foo.bib is the bibliography file relevant
20561 for this document. It then installs the necessary environment for RefTeX
20562 to work in this buffer and calls `reftex-citation' to insert a citation
20563 into the buffer.
20565 Export of such citations to both LaTeX and HTML is handled by the contributed
20566 package org-exp-bibtex by Taru Karttunen."
20567 (interactive)
20568 (let ((reftex-docstruct-symbol 'rds)
20570 rds bib)
20571 (save-excursion
20572 (save-restriction
20573 (widen)
20574 (let ((case-fold-search t)
20576 (if (not (save-excursion
20577 (or (re-search-forward re nil t)
20578 (re-search-backward re nil t))))
20579 (error "No bibliography defined in file")
20580 (setq bib (concat (match-string 1) ".bib")
20581 rds (list (list 'bib bib)))))))
20582 (call-interactively 'reftex-citation)))
20584 ;;;; Functions extending outline functionality
20586 (defun org-beginning-of-line (&optional arg)
20587 "Go to the beginning of the current line. If that is invisible, continue
20588 to a visible line beginning. This makes the function of C-a more intuitive.
20589 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20590 first attempt, and only move to after the tags when the cursor is already
20591 beyond the end of the headline."
20592 (interactive "P")
20593 (let ((pos (point))
20594 (special (if (consp org-special-ctrl-a/e)
20595 (car org-special-ctrl-a/e)
20596 org-special-ctrl-a/e))
20597 refpos)
20598 (if (org-bound-and-true-p line-move-visual)
20599 (beginning-of-visual-line 1)
20600 (beginning-of-line 1))
20601 (if (and arg (fboundp 'move-beginning-of-line))
20602 (call-interactively 'move-beginning-of-line)
20603 (if (bobp)
20604 nil
20605 (backward-char 1)
20606 (if (org-truely-invisible-p)
20607 (while (and (not (bobp)) (org-truely-invisible-p))
20608 (backward-char 1)
20609 (beginning-of-line 1))
20610 (forward-char 1))))
20611 (when special
20612 (cond
20613 ((and (looking-at org-complex-heading-regexp)
20614 (= (char-after (match-end 1)) ?\ ))
20615 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20616 (point-at-eol)))
20617 (goto-char
20618 (if (eq special t)
20619 (cond ((> pos refpos) refpos)
20620 ((= pos (point)) refpos)
20621 (t (point)))
20622 (cond ((> pos (point)) (point))
20623 ((not (eq last-command this-command)) (point))
20624 (t refpos)))))
20625 ((org-at-item-p)
20626 ;; Being at an item and not looking at an the item means point
20627 ;; was previously moved to beginning of a visual line, whiche
20628 ;; doesn't contain the item. Therefore, do nothing special,
20629 ;; just stay here.
20630 (when (looking-at org-list-full-item-re)
20631 ;; Set special position at first white space character after
20632 ;; bullet, and check-box, if any.
20633 (let ((after-bullet
20634 (let ((box (match-end 3)))
20635 (if (not box) (match-end 1)
20636 (let ((after (char-after box)))
20637 (if (and after (= after ? )) (1+ box) box))))))
20638 ;; Special case: Move point to special position when
20639 ;; currently after it or at beginning of line.
20640 (if (eq special t)
20641 (when (or (> pos after-bullet) (= (point) pos))
20642 (goto-char after-bullet))
20643 ;; Reversed case: Move point to special position when
20644 ;; point was already at beginning of line and command is
20645 ;; repeated.
20646 (when (and (= (point) pos) (eq last-command this-command))
20647 (goto-char after-bullet))))))))
20648 (org-no-warnings
20649 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20651 (defun org-end-of-line (&optional arg)
20652 "Go to the end of the line.
20653 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20654 first attempt, and only move to after the tags when the cursor is already
20655 beyond the end of the headline."
20656 (interactive "P")
20657 (let ((special (if (consp org-special-ctrl-a/e)
20658 (cdr org-special-ctrl-a/e)
20659 org-special-ctrl-a/e)))
20660 (cond
20661 ((or (not special) arg
20662 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20663 (call-interactively
20664 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20665 ((fboundp 'move-end-of-line) 'move-end-of-line)
20666 (t 'end-of-line))))
20667 ((org-at-heading-p)
20668 (let ((pos (point)))
20669 (beginning-of-line 1)
20671 (if (eq special t)
20672 (if (or (< pos (match-beginning 1))
20673 (= pos (match-end 0)))
20674 (goto-char (match-beginning 1))
20675 (goto-char (match-end 0)))
20676 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20677 (goto-char (match-end 0))
20678 (goto-char (match-beginning 1))))
20679 (call-interactively (if (fboundp 'move-end-of-line)
20680 'move-end-of-line
20681 'end-of-line)))))
20682 ((org-at-drawer-p)
20683 (move-end-of-line 1)
20684 (when (overlays-at (1- (point))) (backward-char 1)))
20685 ;; At an item: Move before any hidden text.
20686 (t (call-interactively
20687 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20688 ((fboundp 'move-end-of-line) 'move-end-of-line)
20689 (t 'end-of-line)))))
20690 (org-no-warnings
20691 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20693 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20694 (define-key org-mode-map "\C-e" 'org-end-of-line)
20696 (defun org-backward-sentence (&optional arg)
20697 "Go to beginning of sentence, or beginning of table field.
20698 This will call `backward-sentence' or `org-table-beginning-of-field',
20699 depending on context."
20700 (interactive "P")
20701 (cond
20702 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20703 (t (call-interactively 'backward-sentence))))
20705 (defun org-forward-sentence (&optional arg)
20706 "Go to end of sentence, or end of table field.
20707 This will call `forward-sentence' or `org-table-end-of-field',
20708 depending on context."
20709 (interactive "P")
20710 (cond
20711 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20712 (t (call-interactively 'forward-sentence))))
20714 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20715 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20717 (defun org-kill-line (&optional arg)
20718 "Kill line, to tags or end of line."
20719 (interactive "P")
20720 (cond
20721 ((or (not org-special-ctrl-k)
20722 (bolp)
20723 (not (org-at-heading-p)))
20724 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20725 org-ctrl-k-protect-subtree)
20726 (if (or (eq org-ctrl-k-protect-subtree 'error)
20727 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20728 (error "C-k aborted - would kill hidden subtree")))
20729 (call-interactively
20730 (if visual-line-mode 'kill-visual-line 'kill-line)))
20732 (kill-region (point) (match-beginning 1))
20733 (org-set-tags nil t))
20734 (t (kill-region (point) (point-at-eol)))))
20736 (define-key org-mode-map "\C-k" 'org-kill-line)
20738 (defun org-yank (&optional arg)
20739 "Yank. If the kill is a subtree, treat it specially.
20740 This command will look at the current kill and check if is a single
20741 subtree, or a series of subtrees[1]. If it passes the test, and if the
20742 cursor is at the beginning of a line or after the stars of a currently
20743 empty headline, then the yank is handled specially. How exactly depends
20744 on the value of the following variables, both set by default.
20746 org-yank-folded-subtrees
20747 When set, the subtree(s) will be folded after insertion, but only
20748 if doing so would now swallow text after the yanked text.
20750 org-yank-adjusted-subtrees
20751 When set, the subtree will be promoted or demoted in order to
20752 fit into the local outline tree structure, which means that the level
20753 will be adjusted so that it becomes the smaller one of the two
20754 *visible* surrounding headings.
20756 Any prefix to this command will cause `yank' to be called directly with
20758 will just
20759 plainly yank the text as it is.
20761 \[1] The test checks if the first non-white line is a heading
20762 and if there are no other headings with fewer stars."
20763 (interactive "P")
20764 (org-yank-generic 'yank arg))
20766 (defun org-yank-generic (command arg)
20767 "Perform some yank-like command.
20769 This function implements the behavior described in the `org-yank'
20770 documentation. However, it has been generalized to work for any
20771 interactive command with similar behavior."
20773 ;; pretend to be command COMMAND
20774 (setq this-command command)
20776 (if arg
20777 (call-interactively command)
20779 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20780 (and (org-kill-is-subtree-p)
20781 (or (bolp)
20783 (string-match
20785 (buffer-substring (point-at-bol) (point)))))))
20786 swallowp)
20787 (cond
20788 ((and subtreep org-yank-folded-subtrees)
20789 (let ((beg (point))
20790 end)
20791 (if (and subtreep org-yank-adjusted-subtrees)
20792 (org-paste-subtree nil nil 'for-yank)
20793 (call-interactively command))
20795 (setq end (point))
20796 (goto-char beg)
20797 (when (and (bolp) subtreep
20798 (not (setq swallowp
20799 (org-yank-folding-would-swallow-text beg end))))
20800 (org-with-limited-levels
20801 (or (looking-at org-outline-regexp)
20802 (re-search-forward org-outline-regexp-bol end t))
20803 (while (and (< (point) end) (looking-at org-outline-regexp))
20804 (hide-subtree)
20805 (org-cycle-show-empty-lines 'folded)
20806 (condition-case nil
20807 (outline-forward-same-level 1)
20808 (error (goto-char end))))))
20809 (when swallowp
20810 (message
20811 "Inserted text not folded because that would swallow text"))
20813 (goto-char end)
20815 (beginning-of-line 1)
20816 (push-mark beg 'nomsg)))
20817 ((and subtreep org-yank-adjusted-subtrees)
20818 (let ((beg (point-at-bol)))
20819 (org-paste-subtree nil nil 'for-yank)
20820 (push-mark beg 'nomsg)))
20821 (t
20822 (call-interactively command))))))
20824 (defun org-yank-folding-would-swallow-text (beg end)
20825 "Would hide-subtree at BEG swallow any text after END?"
20826 (let (level)
20827 (org-with-limited-levels
20828 (save-excursion
20829 (goto-char beg)
20830 (when (or (looking-at org-outline-regexp)
20831 (re-search-forward org-outline-regexp-bol end t))
20832 (setq level (org-outline-level)))
20833 (goto-char end)
20835 (if (or (eobp)
20836 (and (bolp) (looking-at org-outline-regexp)
20837 (<= (org-outline-level) level)))
20838 nil ; Nothing would be swallowed
20839 t))))) ; something would swallow
20841 (define-key org-mode-map "\C-y" 'org-yank)
20843 (defun org-truely-invisible-p ()
20844 "Check if point is at a character currently not visible.
20845 This version does not only check the character property, but also
20846 `visible-mode'."
20847 ;; Early versions of noutline don't have `outline-invisible-p'.
20848 (if (org-bound-and-true-p visible-mode)
20849 nil
20850 (outline-invisible-p)))
20852 (defun org-invisible-p2 ()
20853 "Check if point is at a character currently not visible."
20854 (save-excursion
20855 (if (and (eolp) (not (bobp))) (backward-char 1))
20856 ;; Early versions of noutline don't have `outline-invisible-p'.
20857 (outline-invisible-p)))
20859 (defun org-back-to-heading (&optional invisible-ok)
20860 "Call `outline-back-to-heading', but provide a better error message."
20861 (condition-case nil
20862 (outline-back-to-heading invisible-ok)
20863 (error (error "Before first headline at position %d in buffer %s"
20864 (point) (current-buffer)))))
20866 (defun org-beginning-of-defun ()
20867 "Go to the beginning of the subtree, i.e. back to the heading."
20868 (org-back-to-heading))
20869 (defun org-end-of-defun ()
20870 "Go to the end of the subtree."
20871 (org-end-of-subtree nil t))
20873 (defun org-before-first-heading-p ()
20874 "Before first heading?"
20875 (save-excursion
20876 (end-of-line)
20877 (null (re-search-backward org-outline-regexp-bol nil t))))
20879 (defun org-at-heading-p (&optional ignored)
20880 (outline-on-heading-p t))
20881 ;; Compatibility alias with Org versions < 7.8.03
20882 (defalias 'org-on-heading-p 'org-at-heading-p)
20884 (defun org-at-drawer-p nil
20885 "Is cursor at a drawer keyword?"
20886 (save-excursion
20887 (move-beginning-of-line 1)
20888 (looking-at org-drawer-regexp)))
20890 (defun org-at-block-p nil
20891 "Is cursor at a block keyword?"
20892 (save-excursion
20893 (move-beginning-of-line 1)
20894 (looking-at org-block-regexp)))
20896 (defun org-point-at-end-of-empty-headline ()
20897 "If point is at the end of an empty headline, return t, else nil.
20898 If the heading only contains a TODO keyword, it is still still considered
20899 empty."
20901 (save-excursion
20902 (beginning-of-line 1)
20903 (let ((case-fold-search nil))
20904 (looking-at org-todo-line-regexp)))
20905 (string= (match-string 3) "")))
20907 (defun org-at-heading-or-item-p ()
20908 (or (org-at-heading-p) (org-at-item-p)))
20910 (defun org-at-target-p ()
20911 (or (org-in-regexp org-radio-target-regexp)
20912 (org-in-regexp org-target-regexp)))
20913 ;; Compatibility alias with Org versions < 7.8.03
20914 (defalias 'org-on-target-p 'org-at-target-p)
20916 (defun org-up-heading-all (arg)
20917 "Move to the heading line of which the present line is a subheading.
20918 This function considers both visible and invisible heading lines.
20919 With argument, move up ARG levels."
20920 (if (fboundp 'outline-up-heading-all)
20921 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20922 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20924 (defun org-up-heading-safe ()
20925 "Move to the heading line of which the present line is a subheading.
20926 This version will not throw an error. It will return the level of the
20927 headline found, or nil if no higher level is found.
20929 Also, this function will be a lot faster than `outline-up-heading',
20930 because it relies on stars being the outline starters. This can really
20931 make a significant difference in outlines with very many siblings."
20932 (let (start-level re)
20933 (org-back-to-heading t)
20934 (setq start-level (funcall outline-level))
20935 (if (equal start-level 1)
20936 nil
20938 (if (re-search-backward re nil t)
20939 (funcall outline-level)))))
20941 (defun org-first-sibling-p ()
20942 "Is this heading the first child of its parents?"
20943 (interactive)
20944 (let ((re org-outline-regexp-bol)
20945 level l)
20946 (unless (org-at-heading-p t)
20947 (error "Not at a heading"))
20948 (setq level (funcall outline-level))
20949 (save-excursion
20950 (if (not (re-search-backward re nil t))
20951 t
20952 (setq l (funcall outline-level))
20953 (< l level)))))
20955 (defun org-goto-sibling (&optional previous)
20956 "Goto the next sibling, even if it is invisible.
20957 When PREVIOUS is set, go to the previous sibling instead. Returns t
20958 when a sibling was found. When none is found, return nil and don't
20959 move point."
20960 (let ((fun (if previous 're-search-backward 're-search-forward))
20961 (pos (point))
20962 (re org-outline-regexp-bol)
20963 level l)
20964 (when (condition-case nil (org-back-to-heading t) (error nil))
20965 (setq level (funcall outline-level))
20966 (catch 'exit
20967 (or previous (forward-char 1))
20968 (while (funcall fun re nil t)
20969 (setq l (funcall outline-level))
20970 (when (< l level) (goto-char pos) (throw 'exit nil))
20971 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20972 (goto-char pos)
20973 nil))))
20975 (defun org-show-siblings ()
20976 "Show all siblings of the current headline."
20977 (save-excursion
20978 (while (org-goto-sibling) (org-flag-heading nil)))
20979 (save-excursion
20980 (while (org-goto-sibling 'previous)
20981 (org-flag-heading nil))))
20983 (defun org-goto-first-child ()
20984 "Goto the first child, even if it is invisible.
20985 Return t when a child was found. Otherwise don't move point and
20986 return nil."
20987 (let (level (pos (point)) (re org-outline-regexp-bol))
20988 (when (condition-case nil (org-back-to-heading t) (error nil))
20989 (setq level (outline-level))
20990 (forward-char 1)
20991 (if (and (re-search-forward re nil t) (> (outline-level) level))
20992 (progn (goto-char (match-beginning 0)) t)
20993 (goto-char pos) nil))))
20995 (defun org-show-hidden-entry ()
20996 "Show an entry where even the heading is hidden."
20997 (save-excursion
20998 (org-show-entry)))
21000 (defun org-flag-heading (flag &optional entry)
21001 "Flag the current heading. FLAG non-nil means make invisible.
21002 When ENTRY is non-nil, show the entire entry."
21003 (save-excursion
21004 (org-back-to-heading t)
21005 ;; Check if we should show the entire entry
21006 (if entry
21007 (progn
21008 (org-show-entry)
21009 (save-excursion
21010 (and (outline-next-heading)
21011 (org-flag-heading nil))))
21012 (outline-flag-region (max (point-min) (1- (point)))
21013 (save-excursion (outline-end-of-heading) (point))
21014 flag))))
21016 (defun org-get-next-sibling ()
21017 "Move to next heading of the same level, and return point.
21018 If there is no such heading, return nil.
21019 This is like outline-next-sibling, but invisible headings are ok."
21020 (let ((level (funcall outline-level)))
21021 (outline-next-heading)
21022 (while (and (not (eobp)) (> (funcall outline-level) level))
21023 (outline-next-heading))
21024 (if (or (eobp) (< (funcall outline-level) level))
21025 nil
21026 (point))))
21028 (defun org-get-last-sibling ()
21029 "Move to previous heading of the same level, and return point.
21030 If there is no such heading, return nil."
21031 (let ((opoint (point))
21032 (level (funcall outline-level)))
21033 (outline-previous-heading)
21034 (when (and (/= (point) opoint) (outline-on-heading-p t))
21035 (while (and (> (funcall outline-level) level)
21036 (not (bobp)))
21037 (outline-previous-heading))
21038 (if (< (funcall outline-level) level)
21039 nil
21040 (point)))))
21042 (defun org-end-of-subtree (&optional invisible-OK to-heading)
21043 ;; This contains an exact copy of the original function, but it uses
21044 ;; `org-back-to-heading', to make it work also in invisible
21045 ;; trees. And is uses an invisible-OK argument.
21046 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21047 ;; Furthermore, when used inside Org, finding the end of a large subtree
21048 ;; with many children and grandchildren etc, this can be much faster
21049 ;; than the outline version.
21050 (org-back-to-heading invisible-OK)
21051 (let ((first t)
21052 (level (funcall outline-level)))
21053 (if (and (eq major-mode 'org-mode) (< level 1000))
21054 ;; A true heading (not a plain list item), in Org-mode
21055 ;; This means we can easily find the end by looking
21056 ;; only for the right number of stars. Using a regexp to do
21057 ;; this is so much faster than using a Lisp loop.
21059 (forward-char 1)
21060 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21061 ;; something else, do it the slow way
21062 (while (and (not (eobp))
21063 (or first (> (funcall outline-level) level)))
21064 (setq first nil)
21065 (outline-next-heading)))
21066 (unless to-heading
21068 (progn
21069 ;; Go to end of line before heading
21070 (forward-char -1)
21072 ;; leave blank line before heading
21073 (forward-char -1))))))
21074 (point))
21076 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21077 "Use Org version in org-mode, for dramatic speed-up."
21078 (if (eq major-mode 'org-mode)
21079 (progn
21080 (org-end-of-subtree nil t)
21081 (unless (eobp) (backward-char 1)))
21082 ad-do-it))
21084 (defun org-end-of-meta-data-and-drawers ()
21085 "Jump to the first text after meta data and drawers in the current entry.
21086 This will move over empty lines, lines with planning time stamps,
21087 clocking lines, and drawers."
21088 (org-back-to-heading t)
21089 (let ((end (save-excursion (outline-next-heading) (point)))
21092 (forward-line 1)
21093 (while (re-search-forward re end t)
21094 (if (not (match-end 1))
21095 ;; empty or planning line
21096 (forward-line 1)
21097 ;; a drawer, find the end
21099 (forward-line 1)))
21101 (point)))
21103 (defun org-forward-same-level (arg &optional invisible-ok)
21104 "Move forward to the arg'th subheading at same level as this one.
21105 Stop at the first and last subheadings of a superior heading.
21106 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
21107 it wil also look at invisible ones."
21108 (interactive "p")
21109 (org-back-to-heading invisible-ok)
21110 (org-at-heading-p)
21111 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21113 l)
21114 (forward-char 1)
21115 (while (> arg 0)
21116 (while (and (re-search-forward re nil 'move)
21117 (setq l (- (match-end 0) (match-beginning 0) 1))
21118 (= l level)
21119 (not invisible-ok)
21120 (progn (backward-char 1) (outline-invisible-p)))
21121 (if (< l level) (setq arg 1)))
21122 (setq arg (1- arg)))
21123 (beginning-of-line 1)))
21125 (defun org-backward-same-level (arg &optional invisible-ok)
21126 "Move backward to the arg'th subheading at same level as this one.
21127 Stop at the first and last subheadings of a superior heading."
21128 (interactive "p")
21129 (org-back-to-heading)
21130 (org-at-heading-p)
21131 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21133 l)
21134 (while (> arg 0)
21135 (while (and (re-search-backward re nil 'move)
21136 (setq l (- (match-end 0) (match-beginning 0) 1))
21137 (= l level)
21138 (not invisible-ok)
21139 (outline-invisible-p))
21140 (if (< l level) (setq arg 1)))
21141 (setq arg (1- arg)))))
21143 (defun org-show-subtree ()
21144 "Show everything after this heading at deeper levels."
21145 (outline-flag-region
21146 (point)
21147 (save-excursion
21148 (org-end-of-subtree t t))
21149 nil))
21151 (defun org-show-entry ()
21152 "Show the body directly following this heading.
21153 Show the heading too, if it is currently invisible."
21154 (interactive)
21155 (save-excursion
21156 (condition-case nil
21157 (progn
21158 (org-back-to-heading t)
21159 (outline-flag-region
21160 (max (point-min) (1- (point)))
21161 (save-excursion
21162 (if (re-search-forward
21164 (match-beginning 1)
21165 (point-max)))
21166 nil)
21167 (org-cycle-hide-drawers 'children))
21168 (error nil))))
21170 (defun org-make-options-regexp (kwds &optional extra)
21171 "Make a regular expression for keyword lines."
21172 (concat
21173 "^"
21180 ;; Make isearch reveal the necessary context
21181 (defun org-isearch-end ()
21182 "Reveal context after isearch exits."
21183 (when isearch-success ; only if search was successful
21184 (if (featurep 'xemacs)
21185 ;; Under XEmacs, the hook is run in the correct place,
21186 ;; we directly show the context.
21187 (org-show-context 'isearch)
21188 ;; In Emacs the hook runs *before* restoring the overlays.
21189 ;; So we have to use a one-time post-command-hook to do this.
21190 ;; (Emacs 22 has a special variable, see function `org-mode')
21191 (unless (and (boundp 'isearch-mode-end-hook-quit)
21192 isearch-mode-end-hook-quit)
21193 ;; Only when the isearch was not quitted.
21194 (org-add-hook 'post-command-hook 'org-isearch-post-command
21195 'append 'local)))))
21197 (defun org-isearch-post-command ()
21198 "Remove self from hook, and show context."
21199 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21200 (org-show-context 'isearch))
21203 ;;;; Integration with and fixes for other packages
21205 ;;; Imenu support
21207 (defvar org-imenu-markers nil
21208 "All markers currently used by Imenu.")
21209 (make-variable-buffer-local 'org-imenu-markers)
21211 (defun org-imenu-new-marker (&optional pos)
21212 "Return a new marker for use by Imenu, and remember the marker."
21213 (let ((m (make-marker)))
21214 (move-marker m (or pos (point)))
21215 (push m org-imenu-markers)
21216 m))
21218 (defun org-imenu-get-tree ()
21219 "Produce the index for Imenu."
21220 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21221 (setq org-imenu-markers nil)
21222 (let* ((n org-imenu-depth)
21223 (re (concat "^" (org-get-limited-outline-regexp)))
21224 (subs (make-vector (1+ n) nil))
21225 (last-level 0)
21226 m level head)
21227 (save-excursion
21228 (save-restriction
21229 (widen)
21230 (goto-char (point-max))
21231 (while (re-search-backward re nil t)
21232 (setq level (org-reduced-level (funcall outline-level)))
21233 (when (<= level n)
21234 (looking-at org-complex-heading-regexp)
21235 (setq head (org-link-display-format
21236 (org-match-string-no-properties 4))
21237 m (org-imenu-new-marker))
21238 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21239 (if (>= level last-level)
21240 (push (cons head m) (aref subs level))
21241 (push (cons head (aref subs (1+ level))) (aref subs level))
21242 (loop for i from (1+ level) to n do (aset subs i nil)))
21243 (setq last-level level)))))
21244 (aref subs 1)))
21246 (eval-after-load "imenu"
21247 '(progn
21248 (add-hook 'imenu-after-jump-hook
21249 (lambda ()
21250 (if (eq major-mode 'org-mode)
21251 (org-show-context 'org-goto))))))
21253 (defun org-link-display-format (link)
21254 "Replace a link with either the description, or the link target
21255 if no description is present"
21256 (save-match-data
21257 (if (string-match org-bracket-link-analytic-regexp link)
21258 (replace-match (if (match-end 5)
21259 (match-string 5 link)
21260 (concat (match-string 1 link)
21261 (match-string 3 link)))
21262 nil t link)
21263 link)))
21265 (defun org-toggle-link-display ()
21266 "Toggle the literal or descriptive display of links."
21267 (interactive)
21268 (if org-descriptive-links
21269 (progn (org-remove-from-invisibility-spec '(org-link))
21270 (org-restart-font-lock)
21271 (setq org-descriptive-links nil))
21272 (progn (add-to-invisibility-spec '(org-link))
21273 (org-restart-font-lock)
21274 (setq org-descriptive-links t))))
21276 ;; Speedbar support
21278 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21279 "Overlay marking the agenda restriction line in speedbar.")
21280 (overlay-put org-speedbar-restriction-lock-overlay
21281 'face 'org-agenda-restriction-lock)
21282 (overlay-put org-speedbar-restriction-lock-overlay
21283 'help-echo "Agendas are currently limited to this item.")
21284 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21286 (defun org-speedbar-set-agenda-restriction ()
21287 "Restrict future agenda commands to the location at point in speedbar.
21289 (interactive)
21290 (require 'org-agenda)
21291 (let (p m tp np dir txt)
21292 (cond
21293 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21294 'org-imenu t))
21295 (setq m (get-text-property p 'org-imenu-marker))
21296 (with-current-buffer (marker-buffer m)
21297 (goto-char m)
21298 (org-agenda-set-restriction-lock 'subtree)))
21299 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21300 'speedbar-function 'speedbar-find-file))
21301 (setq tp (previous-single-property-change
21302 (1+ p) 'speedbar-function)
21303 np (next-single-property-change
21304 tp 'speedbar-function)
21305 dir (speedbar-line-directory)
21306 txt (buffer-substring-no-properties (or tp (point-min))
21307 (or np (point-max))))
21308 (with-current-buffer (find-file-noselect
21309 (let ((default-directory dir))
21310 (expand-file-name txt)))
21311 (unless (eq major-mode 'org-mode)
21312 (error "Cannot restrict to non-Org-mode file"))
21313 (org-agenda-set-restriction-lock 'file)))
21314 (t (error "Don't know how to restrict Org-mode's agenda")))
21315 (move-overlay org-speedbar-restriction-lock-overlay
21316 (point-at-bol) (point-at-eol))
21317 (setq current-prefix-arg nil)
21318 (org-agenda-maybe-redo)))
21320 (eval-after-load "speedbar"
21321 '(progn
21322 (speedbar-add-supported-extension ".org")
21323 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21324 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21325 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21326 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21327 (add-hook 'speedbar-visiting-tag-hook
21328 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21330 ;;; Fixes and Hacks for problems with other packages
21332 ;; Make flyspell not check words in links, to not mess up our keymap
21333 (defun org-mode-flyspell-verify ()
21334 "Don't let flyspell put overlays at active buttons, or on
21335 {todo,all-time,additional-option-like}-keywords."
21336 (let ((pos (max (1- (point)) (point-min)))
21337 (word (thing-at-point 'word)))
21338 (and (not (get-text-property pos 'keymap))
21339 (not (get-text-property pos 'org-no-flyspell))
21340 (not (member word org-todo-keywords-1))
21341 (not (member word org-all-time-keywords))
21342 (not (member word org-additional-option-like-keywords)))))
21344 (defun org-remove-flyspell-overlays-in (beg end)
21345 "Remove flyspell overlays in region."
21346 (and (org-bound-and-true-p flyspell-mode)
21347 (fboundp 'flyspell-delete-region-overlays)
21348 (flyspell-delete-region-overlays beg end))
21349 (add-text-properties beg end '(org-no-flyspell t)))
21351 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21352 (eval-after-load "bookmark"
21353 '(if (boundp 'bookmark-after-jump-hook)
21354 ;; We can use the hook
21355 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21356 ;; Hook not available, use advice
21357 (defadvice bookmark-jump (after org-make-visible activate)
21358 "Make the position visible."
21359 (org-bookmark-jump-unhide))))
21361 ;; Make sure saveplace shows the location if it was hidden
21362 (eval-after-load "saveplace"
21363 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21364 "Make the position visible."
21365 (org-bookmark-jump-unhide)))
21367 ;; Make sure ecb shows the location if it was hidden
21368 (eval-after-load "ecb"
21369 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21370 "Make hierarchy visible when jumping into location from ECB tree buffer."
21371 (if (eq major-mode 'org-mode)
21372 (org-show-context))))
21374 (defun org-bookmark-jump-unhide ()
21375 "Unhide the current position, to show the bookmark location."
21376 (and (eq major-mode 'org-mode)
21377 (or (outline-invisible-p)
21378 (save-excursion (goto-char (max (point-min) (1- (point))))
21379 (outline-invisible-p)))
21380 (org-show-context 'bookmark-jump)))
21382 ;; Make session.el ignore our circular variable
21383 (eval-after-load "session"
21384 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21386 ;;;; Experimental code
21388 (defun org-closed-in-range ()
21389 "Sparse tree of items closed in a certain time range.
21390 Still experimental, may disappear in the future."
21391 (interactive)
21392 ;; Get the time interval from the user.
21393 (let* ((time1 (org-float-time
21394 (org-read-date nil 'to-time nil "Starting date: ")))
21395 (time2 (org-float-time
21396 (org-read-date nil 'to-time nil "End date:")))
21397 ;; callback function
21398 (callback (lambda ()
21399 (let ((time
21400 (org-float-time
21401 (apply 'encode-time
21402 (org-parse-time-string
21403 (match-string 1))))))
21404 ;; check if time in interval
21405 (and (>= time time1) (<= time time2))))))
21406 ;; make tree, check each match with the callback
21409 ;;;; Finish up
21411 (provide 'org)
21413 (run-hooks 'org-load-hook)
21415 ;;; org.el ends here